![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to texinfo.tex CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Apple XNU] / GNUtools / libg++ / texinfo|
Return to texinfo.tex CVS log | Up to [Apple XNU] / GNUtools / libg++ / texinfo |
1.1 root 1: %% TeX macros to handle texinfo files
2:
3: % Copyright (C) 1985, 86, 88, 90, 91, 92, 1993 Free Software Foundation, Inc.
4:
5: %This texinfo.tex file is free software; you can redistribute it and/or
6: %modify it under the terms of the GNU General Public License as
7: %published by the Free Software Foundation; either version 2, or (at
8: %your option) any later version.
9:
10: %This texinfo.tex file is distributed in the hope that it will be
11: %useful, but WITHOUT ANY WARRANTY; without even the implied warranty
12: %of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: %General Public License for more details.
14:
15: %You should have received a copy of the GNU General Public License
16: %along with this texinfo.tex file; see the file COPYING. If not, write
17: %to the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
18: %USA.
19:
20:
21: %In other words, you are welcome to use, share and improve this program.
22: %You are forbidden to forbid anyone else to use, share and improve
23: %what you give them. Help stamp out software-hoarding!
24:
25: \def\texinfoversion{2.116}
26: \message{Loading texinfo package [Version \texinfoversion]:}
27:
28: % Print the version number if in a .fmt file.
29: \everyjob{\message{[Texinfo version \texinfoversion]}\message{}}
30:
31: % Save some parts of plain tex whose names we will redefine.
32:
33: \let\ptexlbrace=\{
34: \let\ptexrbrace=\}
35: \let\ptexdots=\dots
36: \let\ptexdot=\.
37: \let\ptexstar=\*
38: \let\ptexend=\end
39: \let\ptexbullet=\bullet
40: \let\ptexb=\b
41: \let\ptexc=\c
42: \let\ptexi=\i
43: \let\ptext=\t
44: \let\ptexl=\l
45: \let\ptexL=\L
46:
47: \def\tie{\penalty 10000\ } % Save plain tex definition of ~.
48:
49: \message{Basics,}
50: \chardef\other=12
51:
52: % If this character appears in an error message or help string, it
53: % starts a new line in the output.
54: \newlinechar = `^^J
55:
56: % Ignore a token.
57: %
58: \def\gobble#1{}
59:
60: \hyphenation{ap-pen-dix}
61: \hyphenation{mini-buf-fer mini-buf-fers}
62: \hyphenation{eshell}
63:
64: % Margin to add to right of even pages, to left of odd pages.
65: \newdimen \bindingoffset \bindingoffset=0pt
66: \newdimen \normaloffset \normaloffset=\hoffset
67: \newdimen\pagewidth \newdimen\pageheight
68: \pagewidth=\hsize \pageheight=\vsize
69:
70: % Sometimes it is convenient to have everything in the transcript file
71: % and nothing on the terminal. We don't just call \tracingall here,
72: % since that produces some useless output on the terminal.
73: %
74: \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
75: \def\loggingall{\tracingcommands2 \tracingstats2
76: \tracingpages1 \tracingoutput1 \tracinglostchars1
77: \tracingmacros2 \tracingparagraphs1 \tracingrestores1
78: \showboxbreadth\maxdimen\showboxdepth\maxdimen
79: }%
80:
81: %---------------------Begin change-----------------------
82: %
83: %%%% For @cropmarks command.
84: % Dimensions to add cropmarks at corners Added by P. A. MacKay, 12 Nov. 1986
85: %
86: \newdimen\cornerlong \newdimen\cornerthick
87: \newdimen \topandbottommargin
88: \newdimen \outerhsize \newdimen \outervsize
89: \cornerlong=1pc\cornerthick=.3pt % These set size of cropmarks
90: \outerhsize=7in
91: %\outervsize=9.5in
92: % Alternative @smallbook page size is 9.25in
93: \outervsize=9.25in
94: \topandbottommargin=.75in
95: %
96: %---------------------End change-----------------------
97:
98: % \onepageout takes a vbox as an argument. Note that \pagecontents
99: % does insertions itself, but you have to call it yourself.
100: \chardef\PAGE=255 \output={\onepageout{\pagecontents\PAGE}}
101: \def\onepageout#1{\hoffset=\normaloffset
102: \ifodd\pageno \advance\hoffset by \bindingoffset
103: \else \advance\hoffset by -\bindingoffset\fi
104: {\escapechar=`\\\relax % makes sure backslash is used in output files.
105: \shipout\vbox{{\let\hsize=\pagewidth \makeheadline} \pagebody{#1}%
106: {\let\hsize=\pagewidth \makefootline}}}%
107: \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
108:
109: %%%% For @cropmarks command %%%%
110:
111: % Here is a modification of the main output routine for Near East Publications
112: % This provides right-angle cropmarks at all four corners.
113: % The contents of the page are centerlined into the cropmarks,
114: % and any desired binding offset is added as an \hskip on either
115: % site of the centerlined box. (P. A. MacKay, 12 November, 1986)
116: %
117: \def\croppageout#1{\hoffset=0pt % make sure this doesn't mess things up
118: {\escapechar=`\\\relax % makes sure backslash is used in output files.
119: \shipout
120: \vbox to \outervsize{\hsize=\outerhsize
121: \vbox{\line{\ewtop\hfill\ewtop}}
122: \nointerlineskip
123: \line{\vbox{\moveleft\cornerthick\nstop}
124: \hfill
125: \vbox{\moveright\cornerthick\nstop}}
126: \vskip \topandbottommargin
127: \centerline{\ifodd\pageno\hskip\bindingoffset\fi
128: \vbox{
129: {\let\hsize=\pagewidth \makeheadline}
130: \pagebody{#1}
131: {\let\hsize=\pagewidth \makefootline}}
132: \ifodd\pageno\else\hskip\bindingoffset\fi}
133: \vskip \topandbottommargin plus1fill minus1fill
134: \boxmaxdepth\cornerthick
135: \line{\vbox{\moveleft\cornerthick\nsbot}
136: \hfill
137: \vbox{\moveright\cornerthick\nsbot}}
138: \nointerlineskip
139: \vbox{\line{\ewbot\hfill\ewbot}}
140: }}
141: \advancepageno
142: \ifnum\outputpenalty>-20000 \else\dosupereject\fi}
143: %
144: % Do @cropmarks to get crop marks
145: \def\cropmarks{\let\onepageout=\croppageout }
146:
147: \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
148: {\catcode`\@ =11
149: \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
150: \dimen@=\dp#1 \unvbox#1
151: \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
152: \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
153: }
154:
155: %
156: % Here are the rules for the cropmarks. Note that they are
157: % offset so that the space between them is truly \outerhsize or \outervsize
158: % (P. A. MacKay, 12 November, 1986)
159: %
160: \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
161: \def\nstop{\vbox
162: {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
163: \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
164: \def\nsbot{\vbox
165: {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
166:
167: % Parse an argument, then pass it to #1. The argument is the rest of
168: % the input line (except we remove a trailing comment). #1 should be a
169: % macro which expects an ordinary undelimited TeX argument.
170: %
171: \def\parsearg#1{%
172: \let\next = #1%
173: \begingroup
174: \obeylines
175: \futurelet\temp\parseargx
176: }
177:
178: % If the next token is an obeyed space (from an @example environment or
179: % the like), remove it and recurse. Otherwise, we're done.
180: \def\parseargx{%
181: % \obeyedspace is defined far below, after the definition of \sepspaces.
182: \ifx\obeyedspace\temp
183: \expandafter\parseargdiscardspace
184: \else
185: \expandafter\parseargline
186: \fi
187: }
188:
189: % Remove a single space (as the delimiter token to the macro call).
190: {\obeyspaces %
191: \gdef\parseargdiscardspace {\futurelet\temp\parseargx}}
192:
193: {\obeylines %
194: \gdef\parseargline#1^^M{%
195: \endgroup % End of the group started in \parsearg.
196: %
197: % First remove any @c comment, then any @comment.
198: % Result of each macro is put in \toks0.
199: \argremovec #1\c\relax %
200: \expandafter\argremovecomment \the\toks0 \comment\relax %
201: %
202: % Call the caller's macro, saved as \next in \parsearg.
203: \expandafter\next\expandafter{\the\toks0}%
204: }%
205: }
206:
207: % Since all \c{,omment} does is throw away the argument, we can let TeX
208: % do that for us. The \relax here is matched by the \relax in the call
209: % in \parseargline; it could be more or less anything, its purpose is
210: % just to delimit the argument to the \c.
211: \def\argremovec#1\c#2\relax{\toks0 = {#1}}
212: \def\argremovecomment#1\comment#2\relax{\toks0 = {#1}}
213:
214: % \argremovec{,omment} might leave us with trailing spaces, though; e.g.,
215: % @end itemize @c foo
216: % will have two active spaces as part of the argument with the
217: % `itemize'. Here we remove all active spaces from #1, and assign the
218: % result to \toks0.
219: %
220: % This loses if there are any *other* active characters besides spaces
221: % in the argument -- _ ^ +, for example -- since they get expanded.
222: % Fortunately, Texinfo does not define any such commands. (If it ever
223: % does, the catcode of the characters in questionwill have to be changed
224: % here.) But this means we cannot call \removeactivespaces as part of
225: % \argremovec{,omment}, since @c uses \parsearg, and thus the argument
226: % that \parsearg gets might well have any character at all in it.
227: %
228: \def\removeactivespaces#1{%
229: \begingroup
230: \ignoreactivespaces
231: \edef\temp{#1}%
232: \global\toks0 = \expandafter{\temp}%
233: \endgroup
234: }
235:
236: % Change the active space to expand to nothing.
237: %
238: \begingroup
239: \obeyspaces
240: \gdef\ignoreactivespaces{\obeyspaces\let =\empty}
241: \endgroup
242:
243:
244: \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
245:
246: %% These are used to keep @begin/@end levels from running away
247: %% Call \inENV within environments (after a \begingroup)
248: \newif\ifENV \ENVfalse \def\inENV{\ifENV\relax\else\ENVtrue\fi}
249: \def\ENVcheck{%
250: \ifENV\errmessage{Still within an environment. Type Return to continue.}
251: \endgroup\fi} % This is not perfect, but it should reduce lossage
252:
253: % @begin foo is the same as @foo, for now.
254: \newhelp\EMsimple{Type <Return> to continue.}
255:
256: \outer\def\begin{\parsearg\beginxxx}
257:
258: \def\beginxxx #1{%
259: \expandafter\ifx\csname #1\endcsname\relax
260: {\errhelp=\EMsimple \errmessage{Undefined command @begin #1}}\else
261: \csname #1\endcsname\fi}
262:
263: % @end foo executes the definition of \Efoo.
264: %
265: \def\end{\parsearg\endxxx}
266: \def\endxxx #1{%
267: \removeactivespaces{#1}%
268: \edef\endthing{\the\toks0}%
269: %
270: \expandafter\ifx\csname E\endthing\endcsname\relax
271: \expandafter\ifx\csname \endthing\endcsname\relax
272: % There's no \foo, i.e., no ``environment'' foo.
273: \errhelp = \EMsimple
274: \errmessage{Undefined command `@end \endthing'}%
275: \else
276: \unmatchedenderror\endthing
277: \fi
278: \else
279: % Everything's ok; the right environment has been started.
280: \csname E\endthing\endcsname
281: \fi
282: }
283:
284: % There is an environment #1, but it hasn't been started. Give an error.
285: %
286: \def\unmatchedenderror#1{%
287: \errhelp = \EMsimple
288: \errmessage{This `@end #1' doesn't have a matching `@#1'}%
289: }
290:
291: % Define the control sequence \E#1 to give an unmatched @end error.
292: %
293: \def\defineunmatchedend#1{%
294: \expandafter\def\csname E#1\endcsname{\unmatchedenderror{#1}}%
295: }
296:
297:
298: % Single-spacing is done by various environments (specifically, in
299: % \nonfillstart and \quotations).
300: \newskip\singlespaceskip \singlespaceskip = \baselineskip
301: \def\singlespace{%
302: % Why was this kern here? It messes up equalizing space above and below
303: % environments. --karl, 6may93
304: %{\advance \baselineskip by -\singlespaceskip
305: %\kern \baselineskip}%
306: \baselineskip=\singlespaceskip
307: }
308:
309: %% Simple single-character @ commands
310:
311: % @@ prints an @
312: % Kludge this until the fonts are right (grr).
313: \def\@{{\tt \char '100}}
314:
315: % This is turned off because it was never documented
316: % and you can use @w{...} around a quote to suppress ligatures.
317: %% Define @` and @' to be the same as ` and '
318: %% but suppressing ligatures.
319: %\def\`{{`}}
320: %\def\'{{'}}
321:
322: % Used to generate quoted braces.
323:
324: \def\mylbrace {{\tt \char '173}}
325: \def\myrbrace {{\tt \char '175}}
326: \let\{=\mylbrace
327: \let\}=\myrbrace
328:
329: % @: forces normal size whitespace following.
330: \def\:{\spacefactor=1000 }
331:
332: % @* forces a line break.
333: \def\*{\hfil\break\hbox{}\ignorespaces}
334:
335: % @. is an end-of-sentence period.
336: \def\.{.\spacefactor=3000 }
337:
338: % @w prevents a word break. Without the \leavevmode, @w at the
339: % beginning of a paragraph, when TeX is still in vertical mode, would
340: % produce a whole line of output instead of starting the paragraph.
341: \def\w#1{\leavevmode\hbox{#1}}
342:
343: % @group ... @end group forces ... to be all on one page, by enclosing
344: % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
345: % to keep its height that of a normal line. According to the rules for
346: % \topskip (p.114 of the TeXbook), the glue inserted is
347: % max (\topskip - \ht (first item), 0). If that height is large,
348: % therefore, no glue is inserted, and the space between the headline and
349: % the text is small, which looks bad.
350: %
351: \def\group{\begingroup
352: \ifnum\catcode13=\active \else
353: \errhelp = \groupinvalidhelp
354: \errmessage{@group invalid in context where filling is enabled}%
355: \fi
356: %
357: % The \vtop we start below produces a box with normal height and large
358: % depth; thus, TeX puts \baselineskip glue before it, and (when the
359: % next line of text is done) \lineskip glue after it. (See p.82 of
360: % the TeXbook.) Thus, space below is not quite equal to space
361: % above. But it's pretty close.
362: \def\Egroup{%
363: \egroup % End the \vtop.
364: \endgroup % End the \group.
365: }%
366: %
367: \vtop\bgroup
368: % We have to put a strut on the last line in case the @group is in
369: % the midst of an example, rather than completely enclosing it.
370: % Otherwise, the interline space between the last line of the group
371: % and the first line afterwards is too small. But we can't put the
372: % strut in \Egroup, since there it would be on a line by itself.
373: % Hence this just inserts a strut at the beginning of each line.
374: \everypar = {\strut}%
375: %
376: % Since we have a strut on every line, we don't need any of TeX's
377: % normal interline spacing.
378: \offinterlineskip
379: %
380: % OK, but now we have to do something about blank
381: % lines in the input in @example-like environments, which normally
382: % just turn into \lisppar, which will insert no space now that we've
383: % turned off the interline space. Simplest is to make them be an
384: % empty paragraph.
385: \ifx\par\lisppar
386: \edef\par{\leavevmode \par}%
387: %
388: % Reset ^^M's definition to new definition of \par.
389: \obeylines
390: \fi
391: %
392: % We do @comment here in case we are called inside an environment,
393: % such as @example, where each end-of-line in the input causes an
394: % end-of-line in the output. We don't want the end-of-line after
395: % the `@group' to put extra space in the output. Since @group
396: % should appear on a line by itself (according to the Texinfo
397: % manual), we don't worry about eating any user text.
398: \comment
399: }
400: %
401: % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
402: % message, so this ends up printing `@group can only ...'.
403: %
404: \newhelp\groupinvalidhelp{%
405: group can only be used in environments such as @example,^^J%
406: where each line of input produces a line of output.}
407:
408: % @need space-in-mils
409: % forces a page break if there is not space-in-mils remaining.
410:
411: \newdimen\mil \mil=0.001in
412:
413: \def\need{\parsearg\needx}
414:
415: % Old definition--didn't work.
416: %\def\needx #1{\par %
417: %% This method tries to make TeX break the page naturally
418: %% if the depth of the box does not fit.
419: %{\baselineskip=0pt%
420: %\vtop to #1\mil{\vfil}\kern -#1\mil\penalty 10000
421: %\prevdepth=-1000pt
422: %}}
423:
424: \def\needx#1{%
425: % Go into vertical mode, so we don't make a big box in the middle of a
426: % paragraph.
427: \par
428: %
429: % Don't add any leading before our big empty box, but allow a page
430: % break, since the best break might be right here.
431: \allowbreak
432: \nointerlineskip
433: \vtop to #1\mil{\vfil}%
434: %
435: % TeX does not even consider page breaks if a penalty added to the
436: % main vertical list is 10000 or more. But in order to see if the
437: % empty box we just added fits on the page, we must make it consider
438: % page breaks. On the other hand, we don't want to actually break the
439: % page after the empty box. So we use a penalty of 9999.
440: %
441: % There is an extremely small chance that TeX will actually break the
442: % page at this \penalty, if there are no other feasible breakpoints in
443: % sight. (If the user is using lots of big @group commands, which
444: % almost-but-not-quite fill up a page, TeX will have a hard time doing
445: % good page breaking, for example.) However, I could not construct an
446: % example where a page broke at this \penalty; if it happens in a real
447: % document, then we can reconsider our strategy.
448: \penalty9999
449: %
450: % Back up by the size of the box, whether we did a page break or not.
451: \kern -#1\mil
452: %
453: % Do not allow a page break right after this kern.
454: \nobreak
455: }
456:
457: % @br forces paragraph break
458:
459: \let\br = \par
460:
461: % @dots{} output some dots
462:
463: \def\dots{$\ldots$}
464:
465: % @page forces the start of a new page
466:
467: \def\page{\par\vfill\supereject}
468:
469: % @exdent text....
470: % outputs text on separate line in roman font, starting at standard page margin
471:
472: % This records the amount of indent in the innermost environment.
473: % That's how much \exdent should take out.
474: \newskip\exdentamount
475:
476: % This defn is used inside fill environments such as @defun.
477: \def\exdent{\parsearg\exdentyyy}
478: \def\exdentyyy #1{{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}}
479:
480: % This defn is used inside nofill environments such as @example.
481: \def\nofillexdent{\parsearg\nofillexdentyyy}
482: \def\nofillexdentyyy #1{{\advance \leftskip by -\exdentamount
483: \leftline{\hskip\leftskip{\rm#1}}}}
484:
485: %\hbox{{\rm#1}}\hfil\break}}
486:
487: % @include file insert text of that file as input.
488:
489: \def\include{\parsearg\includezzz}
490: %Use \input\thisfile to avoid blank after \input, which may be an active
491: %char (in which case the blank would become the \input argument).
492: %The grouping keeps the value of \thisfile correct even when @include
493: %is nested.
494: \def\includezzz #1{\begingroup
495: \def\thisfile{#1}\input\thisfile
496: \endgroup}
497:
498: \def\thisfile{}
499:
500: % @center line outputs that line, centered
501:
502: \def\center{\parsearg\centerzzz}
503: \def\centerzzz #1{{\advance\hsize by -\leftskip
504: \advance\hsize by -\rightskip
505: \centerline{#1}}}
506:
507: % @sp n outputs n lines of vertical space
508:
509: \def\sp{\parsearg\spxxx}
510: \def\spxxx #1{\par \vskip #1\baselineskip}
511:
512: % @comment ...line which is ignored...
513: % @c is the same as @comment
514: % @ignore ... @end ignore is another way to write a comment
515:
516: \def\comment{\catcode 64=\other \catcode 123=\other \catcode 125=\other%
517: \parsearg \commentxxx}
518:
519: \def\commentxxx #1{\catcode 64=0 \catcode 123=1 \catcode 125=2 }
520:
521: \let\c=\comment
522:
523: % Prevent errors for section commands.
524: % Used in @ignore and in failing conditionals.
525: \def\ignoresections{%
526: \let\chapter=\relax
527: \let\unnumbered=\relax
528: \let\top=\relax
529: \let\unnumberedsec=\relax
530: \let\unnumberedsection=\relax
531: \let\unnumberedsubsec=\relax
532: \let\unnumberedsubsection=\relax
533: \let\unnumberedsubsubsec=\relax
534: \let\unnumberedsubsubsection=\relax
535: \let\section=\relax
536: \let\subsec=\relax
537: \let\subsubsec=\relax
538: \let\subsection=\relax
539: \let\subsubsection=\relax
540: \let\appendix=\relax
541: \let\appendixsec=\relax
542: \let\appendixsection=\relax
543: \let\appendixsubsec=\relax
544: \let\appendixsubsection=\relax
545: \let\appendixsubsubsec=\relax
546: \let\appendixsubsubsection=\relax
547: \let\contents=\relax
548: \let\smallbook=\relax
549: \let\titlepage=\relax
550: }
551:
552: % Used in nested conditionals, where we have to parse the Texinfo source
553: % and so want to turn off most commands, in case they are used
554: % incorrectly.
555: %
556: \def\ignoremorecommands{%
557: \let\defcv = \relax
558: \let\deffn = \relax
559: \let\deffnx = \relax
560: \let\defindex = \relax
561: \let\defivar = \relax
562: \let\defmac = \relax
563: \let\defmethod = \relax
564: \let\defop = \relax
565: \let\defopt = \relax
566: \let\defspec = \relax
567: \let\deftp = \relax
568: \let\deftypefn = \relax
569: \let\deftypefun = \relax
570: \let\deftypevar = \relax
571: \let\deftypevr = \relax
572: \let\defun = \relax
573: \let\defvar = \relax
574: \let\defvr = \relax
575: \let\ref = \relax
576: \let\xref = \relax
577: \let\printindex = \relax
578: \let\pxref = \relax
579: \let\settitle = \relax
580: \let\include = \relax
581: \let\lowersections = \relax
582: \let\down = \relax
583: \let\raisesections = \relax
584: \let\up = \relax
585: \let\set = \relax
586: \let\clear = \relax
587: }
588:
589: % Ignore @ignore ... @end ignore.
590: %
591: \def\ignore{\doignore{ignore}}
592:
593: % Also ignore @ifinfo, @menu, and @direntry text.
594: %
595: \def\ifinfo{\doignore{ifinfo}}
596: \def\menu{\doignore{menu}}
597: \def\direntry{\doignore{direntry}}
598:
599: % Ignore text until a line `@end #1'.
600: %
601: \def\doignore#1{\begingroup
602: % Don't complain about control sequences we have declared \outer.
603: \ignoresections
604: %
605: % Define a command to swallow text until we reach `@end #1'.
606: \long\def\doignoretext##1\end #1{\enddoignore}%
607: %
608: % Make sure that spaces turn into tokens that match what \doignoretext wants.
609: \catcode32 = 10
610: %
611: % And now expand that command.
612: \doignoretext
613: }
614:
615: % What we do to finish off ignored text.
616: %
617: \def\enddoignore{\endgroup\ignorespaces}%
618:
619: \newif\ifwarnedobs\warnedobsfalse
620: \def\obstexwarn{%
621: \ifwarnedobs\relax\else
622: % We need to warn folks that they may have trouble with TeX 3.0.
623: % This uses \immediate\write16 rather than \message to get newlines.
624: \immediate\write16{}
625: \immediate\write16{***WARNING*** for users of Unix TeX 3.0!}
626: \immediate\write16{This manual trips a bug in TeX version 3.0 (tex hangs).}
627: \immediate\write16{If you are running another version of TeX, relax.}
628: \immediate\write16{If you are running Unix TeX 3.0, kill this TeX process.}
629: \immediate\write16{ Then upgrade your TeX installation if you can.}
630: \immediate\write16{If you are stuck with version 3.0, run the}
631: \immediate\write16{ script ``tex3patch'' from the Texinfo distribution}
632: \immediate\write16{ to use a workaround.}
633: \immediate\write16{}
634: \warnedobstrue
635: \fi
636: }
637:
638: % **In TeX 3.0, setting text in \nullfont hangs tex. For a
639: % workaround (which requires the file ``dummy.tfm'' to be installed),
640: % uncomment the following line:
641: %%%%%\font\nullfont=dummy\let\obstexwarn=\relax
642:
643: % Ignore text, except that we keep track of conditional commands for
644: % purposes of nesting, up to an `@end #1' command.
645: %
646: \def\nestedignore#1{%
647: \obstexwarn
648: % We must actually expand the ignored text to look for the @end
649: % command, so that nested ignore constructs work. Thus, we put the
650: % text into a \vbox and then do nothing with the result. To minimize
651: % the change of memory overflow, we follow the approach outlined on
652: % page 401 of the TeXbook: make the current font be a dummy font.
653: %
654: \setbox0 = \vbox\bgroup
655: % Don't complain about control sequences we have declared \outer.
656: \ignoresections
657: %
658: % Define `@end #1' to end the box, which will in turn undefine the
659: % @end command again.
660: \expandafter\def\csname E#1\endcsname{\egroup\ignorespaces}%
661: %
662: % We are going to be parsing Texinfo commands. Most cause no
663: % trouble when they are used incorrectly, but some commands do
664: % complicated argument parsing or otherwise get confused, so we
665: % undefine them.
666: %
667: % We can't do anything about stray @-signs, unfortunately;
668: % they'll produce `undefined control sequence' errors.
669: \ignoremorecommands
670: %
671: % Set the current font to be \nullfont, a TeX primitive, and define
672: % all the font commands to also use \nullfont. We don't use
673: % dummy.tfm, as suggested in the TeXbook, because not all sites
674: % might have that installed. Therefore, math mode will still
675: % produce output, but that should be an extremely small amount of
676: % stuff compared to the main input.
677: %
678: \nullfont
679: \let\tenrm = \nullfont \let\tenit = \nullfont \let\tensl = \nullfont
680: \let\tenbf = \nullfont \let\tentt = \nullfont \let\smallcaps = \nullfont
681: \let\tensf = \nullfont
682: % Similarly for index fonts (mostly for their use in
683: % smallexample)
684: \let\indrm = \nullfont \let\indit = \nullfont \let\indsl = \nullfont
685: \let\indbf = \nullfont \let\indtt = \nullfont \let\indsc = \nullfont
686: \let\indsf = \nullfont
687: %
688: % Don't complain when characters are missing from the fonts.
689: \tracinglostchars = 0
690: %
691: % Don't bother to do space factor calculations.
692: \frenchspacing
693: %
694: % Don't report underfull hboxes.
695: \hbadness = 10000
696: %
697: % Do minimal line-breaking.
698: \pretolerance = 10000
699: %
700: % Do not execute instructions in @tex
701: \def\tex{\doignore{tex}}
702: }
703:
704: % @set VAR sets the variable VAR to an empty value.
705: % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
706: %
707: % Since we want to separate VAR from REST-OF-LINE (which might be
708: % empty), we can't just use \parsearg; we have to insert a space of our
709: % own to delimit the rest of the line, and then take it out again if we
710: % didn't need it.
711: %
712: \def\set{\parsearg\setxxx}
713: \def\setxxx#1{\setyyy#1 \endsetyyy}
714: \def\setyyy#1 #2\endsetyyy{%
715: \def\temp{#2}%
716: \ifx\temp\empty \global\expandafter\let\csname SET#1\endcsname = \empty
717: \else \setzzz{#1}#2\endsetzzz % Remove the trailing space \setxxx inserted.
718: \fi
719: }
720: \def\setzzz#1#2 \endsetzzz{\expandafter\xdef\csname SET#1\endcsname{#2}}
721:
722: % @clear VAR clears (i.e., unsets) the variable VAR.
723: %
724: \def\clear{\parsearg\clearxxx}
725: \def\clearxxx#1{\global\expandafter\let\csname SET#1\endcsname=\relax}
726:
727: % @value{foo} gets the text saved in variable foo.
728: %
729: \def\value#1{\expandafter
730: \ifx\csname SET#1\endcsname\relax
731: {\{No value for ``#1''\}}
732: \else \csname SET#1\endcsname \fi}
733:
734: % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
735: % with @set.
736: %
737: \def\ifset{\parsearg\ifsetxxx}
738: \def\ifsetxxx #1{%
739: \expandafter\ifx\csname SET#1\endcsname\relax
740: \expandafter\ifsetfail
741: \else
742: \expandafter\ifsetsucceed
743: \fi
744: }
745: \def\ifsetsucceed{\conditionalsucceed{ifset}}
746: \def\ifsetfail{\nestedignore{ifset}}
747: \defineunmatchedend{ifset}
748:
749: % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
750: % defined with @set, or has been undefined with @clear.
751: %
752: \def\ifclear{\parsearg\ifclearxxx}
753: \def\ifclearxxx #1{%
754: \expandafter\ifx\csname SET#1\endcsname\relax
755: \expandafter\ifclearsucceed
756: \else
757: \expandafter\ifclearfail
758: \fi
759: }
760: \def\ifclearsucceed{\conditionalsucceed{ifclear}}
761: \def\ifclearfail{\nestedignore{ifclear}}
762: \defineunmatchedend{ifclear}
763:
764: % @iftex always succeeds; we read the text following, through @end
765: % iftex). But `@end iftex' should be valid only after an @iftex.
766: %
767: \def\iftex{\conditionalsucceed{iftex}}
768: \defineunmatchedend{iftex}
769:
770: % We can't just want to start a group at @iftex (for example) and end it
771: % at @end iftex, since then @set commands inside the conditional have no
772: % effect (they'd get reverted at the end of the group). So we must
773: % define \Eiftex to redefine itself to be its previous value. (We can't
774: % just define it to fail again with an ``unmatched end'' error, since
775: % the @ifset might be nested.)
776: %
777: \def\conditionalsucceed#1{%
778: \edef\temp{%
779: % Remember the current value of \E#1.
780: \let\nece{prevE#1} = \nece{E#1}%
781: %
782: % At the `@end #1', redefine \E#1 to be its previous value.
783: \def\nece{E#1}{\let\nece{E#1} = \nece{prevE#1}}%
784: }%
785: \temp
786: }
787:
788: % We need to expand lots of \csname's, but we don't want to expand the
789: % control sequences after we've constructed them.
790: %
791: \def\nece#1{\expandafter\noexpand\csname#1\endcsname}
792:
793: % @asis just yields its argument. Used with @table, for example.
794: %
795: \def\asis#1{#1}
796:
797: % @math means output in math mode.
798: % We don't use $'s directly in the definition of \math because control
799: % sequences like \math are expanded when the toc file is written. Then,
800: % we read the toc file back, the $'s will be normal characters (as they
801: % should be, according to the definition of Texinfo). So we must use a
802: % control sequence to switch into and out of math mode.
803: %
804: % This isn't quite enough for @math to work properly in indices, but it
805: % seems unlikely it will ever be needed there.
806: %
807: \let\implicitmath = $
808: \def\math#1{\implicitmath #1\implicitmath}
809:
810: % @bullet and @minus need the same treatment as @math, just above.
811: \def\bullet{\implicitmath\ptexbullet\implicitmath}
812: \def\minus{\implicitmath-\implicitmath}
813:
814: \def\node{\ENVcheck\parsearg\nodezzz}
815: \def\nodezzz#1{\nodexxx [#1,]}
816: \def\nodexxx[#1,#2]{\gdef\lastnode{#1}}
817: \let\nwnode=\node
818: \let\lastnode=\relax
819:
820: \def\donoderef{\ifx\lastnode\relax\else
821: \expandafter\expandafter\expandafter\setref{\lastnode}\fi
822: \let\lastnode=\relax}
823:
824: \def\unnumbnoderef{\ifx\lastnode\relax\else
825: \expandafter\expandafter\expandafter\unnumbsetref{\lastnode}\fi
826: \let\lastnode=\relax}
827:
828: \def\appendixnoderef{\ifx\lastnode\relax\else
829: \expandafter\expandafter\expandafter\appendixsetref{\lastnode}\fi
830: \let\lastnode=\relax}
831:
832: \let\refill=\relax
833:
834: % @setfilename is done at the beginning of every texinfo file.
835: % So open here the files we need to have open while reading the input.
836: % This makes it possible to make a .fmt file for texinfo.
837: \def\setfilename{%
838: \readauxfile
839: \opencontents
840: \openindices
841: \fixbackslash % Turn off hack to swallow `\input texinfo'.
842: \global\let\setfilename=\comment % Ignore extra @setfilename cmds.
843: \comment % Ignore the actual filename.
844: }
845:
846: \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
847:
848: \def\inforef #1{\inforefzzz #1,,,,**}
849: \def\inforefzzz #1,#2,#3,#4**{See Info file \file{\ignorespaces #3{}},
850: node \samp{\ignorespaces#1{}}}
851:
852: \message{fonts,}
853:
854: % Font-change commands.
855:
856: % Texinfo supports the sans serif font style, which plain TeX does not.
857: % So we set up a \sf analogous to plain's \rm, etc.
858: \newfam\sffam
859: \def\sf{\fam=\sffam \tensf}
860: \let\li = \sf % Sometimes we call it \li, not \sf.
861:
862: %% Try out Computer Modern fonts at \magstephalf
863: \let\mainmagstep=\magstephalf
864:
865: \ifx\bigger\relax
866: \let\mainmagstep=\magstep1
867: \font\textrm=cmr12
868: \font\texttt=cmtt12
869: \else
870: \font\textrm=cmr10 scaled \mainmagstep
871: \font\texttt=cmtt10 scaled \mainmagstep
872: \fi
873: % Instead of cmb10, you many want to use cmbx10.
874: % cmbx10 is a prettier font on its own, but cmb10
875: % looks better when embedded in a line with cmr10.
876: \font\textbf=cmb10 scaled \mainmagstep
877: \font\textit=cmti10 scaled \mainmagstep
878: \font\textsl=cmsl10 scaled \mainmagstep
879: \font\textsf=cmss10 scaled \mainmagstep
880: \font\textsc=cmcsc10 scaled \mainmagstep
881: \font\texti=cmmi10 scaled \mainmagstep
882: \font\textsy=cmsy10 scaled \mainmagstep
883:
884: % A few fonts for @defun, etc.
885: \font\defbf=cmbx10 scaled \magstep1 %was 1314
886: \font\deftt=cmtt10 scaled \magstep1
887: \def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
888:
889: % Fonts for indices and small examples.
890: % We actually use the slanted font rather than the italic,
891: % because texinfo normally uses the slanted fonts for that.
892: % Do not make many font distinctions in general in the index, since they
893: % aren't very useful.
894: \font\ninett=cmtt9
895: \font\indrm=cmr9
896: \font\indit=cmsl9
897: \let\indsl=\indit
898: \let\indtt=\ninett
899: \let\indsf=\indrm
900: \let\indbf=\indrm
901: \let\indsc=\indrm
902: \font\indi=cmmi9
903: \font\indsy=cmsy9
904:
905: % Fonts for headings
906: \font\chaprm=cmbx12 scaled \magstep2
907: \font\chapit=cmti12 scaled \magstep2
908: \font\chapsl=cmsl12 scaled \magstep2
909: \font\chaptt=cmtt12 scaled \magstep2
910: \font\chapsf=cmss12 scaled \magstep2
911: \let\chapbf=\chaprm
912: \font\chapsc=cmcsc10 scaled\magstep3
913: \font\chapi=cmmi12 scaled \magstep2
914: \font\chapsy=cmsy10 scaled \magstep3
915:
916: \font\secrm=cmbx12 scaled \magstep1
917: \font\secit=cmti12 scaled \magstep1
918: \font\secsl=cmsl12 scaled \magstep1
919: \font\sectt=cmtt12 scaled \magstep1
920: \font\secsf=cmss12 scaled \magstep1
921: \font\secbf=cmbx12 scaled \magstep1
922: \font\secsc=cmcsc10 scaled\magstep2
923: \font\seci=cmmi12 scaled \magstep1
924: \font\secsy=cmsy10 scaled \magstep2
925:
926: % \font\ssecrm=cmbx10 scaled \magstep1 % This size an font looked bad.
927: % \font\ssecit=cmti10 scaled \magstep1 % The letters were too crowded.
928: % \font\ssecsl=cmsl10 scaled \magstep1
929: % \font\ssectt=cmtt10 scaled \magstep1
930: % \font\ssecsf=cmss10 scaled \magstep1
931:
932: %\font\ssecrm=cmb10 scaled 1315 % Note the use of cmb rather than cmbx.
933: %\font\ssecit=cmti10 scaled 1315 % Also, the size is a little larger than
934: %\font\ssecsl=cmsl10 scaled 1315 % being scaled magstep1.
935: %\font\ssectt=cmtt10 scaled 1315
936: %\font\ssecsf=cmss10 scaled 1315
937:
938: %\let\ssecbf=\ssecrm
939:
940: \font\ssecrm=cmbx12 scaled \magstephalf
941: \font\ssecit=cmti12 scaled \magstephalf
942: \font\ssecsl=cmsl12 scaled \magstephalf
943: \font\ssectt=cmtt12 scaled \magstephalf
944: \font\ssecsf=cmss12 scaled \magstephalf
945: \font\ssecbf=cmbx12 scaled \magstephalf
946: \font\ssecsc=cmcsc10 scaled \magstep1
947: \font\sseci=cmmi12 scaled \magstephalf
948: \font\ssecsy=cmsy10 scaled \magstep1
949: % The smallcaps and symbol fonts should actually be scaled \magstep1.5,
950: % but that is not a standard magnification.
951:
952: % Fonts for title page:
953: \font\titlerm = cmbx12 scaled \magstep3
954: \let\authorrm = \secrm
955:
956: % In order for the font changes to affect most math symbols and letters,
957: % we have to define the \textfont of the standard families. Since
958: % texinfo doesn't allow for producing subscripts and superscripts, we
959: % don't bother to reset \scriptfont and \scriptscriptfont (which would
960: % also require loading a lot more fonts).
961: %
962: \def\resetmathfonts{%
963: \textfont0 = \tenrm \textfont1 = \teni \textfont2 = \tensy
964: \textfont\itfam = \tenit \textfont\slfam = \tensl \textfont\bffam = \tenbf
965: \textfont\ttfam = \tentt \textfont\sffam = \tensf
966: }
967:
968:
969: % The font-changing commands redefine the meanings of \tenSTYLE, instead
970: % of just \STYLE. We do this so that font changes will continue to work
971: % in math mode, where it is the current \fam that is relevant in most
972: % cases, not the current. Plain TeX does, for example,
973: % \def\bf{\fam=\bffam \tenbf} By redefining \tenbf, we obviate the need
974: % to redefine \bf itself.
975: \def\textfonts{%
976: \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
977: \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
978: \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
979: \resetmathfonts}
980: \def\chapfonts{%
981: \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
982: \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
983: \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
984: \resetmathfonts}
985: \def\secfonts{%
986: \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
987: \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
988: \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
989: \resetmathfonts}
990: \def\subsecfonts{%
991: \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
992: \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
993: \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
994: \resetmathfonts}
995: \def\indexfonts{%
996: \let\tenrm=\indrm \let\tenit=\indit \let\tensl=\indsl
997: \let\tenbf=\indbf \let\tentt=\indtt \let\smallcaps=\indsc
998: \let\tensf=\indsf \let\teni=\indi \let\tensy=\indsy
999: \resetmathfonts}
1000:
1001: % Set up the default fonts, so we can use them for creating boxes.
1002: %
1003: \textfonts
1004:
1005: % Count depth in font-changes, for error checks
1006: \newcount\fontdepth \fontdepth=0
1007:
1008: % Fonts for short table of contents.
1009: \font\shortcontrm=cmr12
1010: \font\shortcontbf=cmbx12
1011: \font\shortcontsl=cmsl12
1012:
1013: %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1014: %% serif) and @ii for TeX italic
1015:
1016: % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1017: % unless the following character is such as not to need one.
1018: \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else\/\fi\fi\fi}
1019: \def\smartitalic#1{{\sl #1}\futurelet\next\smartitalicx}
1020:
1021: \let\i=\smartitalic
1022: \let\var=\smartitalic
1023: \let\dfn=\smartitalic
1024: \let\emph=\smartitalic
1025: \let\cite=\smartitalic
1026:
1027: \def\b#1{{\bf #1}}
1028: \let\strong=\b
1029:
1030: % We can't just use \exhyphenpenalty, because that only has effect at
1031: % the end of a paragraph. Restore normal hyphenation at the end of the
1032: % group within which \nohyphenation is presumably called.
1033: %
1034: \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
1035: \def\restorehyphenation{\hyphenchar\font = `- }
1036:
1037: \def\t#1{%
1038: {\tt \nohyphenation \rawbackslash \frenchspacing #1}%
1039: \null
1040: }
1041: \let\ttfont = \t
1042: %\def\samp #1{`{\tt \rawbackslash \frenchspacing #1}'\null}
1043: \def\samp #1{`\tclose{#1}'\null}
1044: \def\key #1{{\tt \nohyphenation \uppercase{#1}}\null}
1045: \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1046:
1047: \let\file=\samp
1048:
1049: % @code is a modification of @t,
1050: % which makes spaces the same size as normal in the surrounding text.
1051: \def\tclose#1{%
1052: {%
1053: % Change normal interword space to be same as for the current font.
1054: \spaceskip = \fontdimen2\font
1055: %
1056: % Switch to typewriter.
1057: \tt
1058: %
1059: % But `\ ' produces the large typewriter interword space.
1060: \def\ {{\spaceskip = 0pt{} }}%
1061: %
1062: % Turn off hyphenation.
1063: \nohyphenation
1064: %
1065: \rawbackslash
1066: \frenchspacing
1067: #1%
1068: }%
1069: \null
1070: }
1071:
1072: % We *must* turn on hyphenation at `-' and `_' in \code.
1073: % Otherwise, it is too hard to avoid overful hboxes
1074: % in the Emacs manual, the Library manual, etc.
1075:
1076: % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1077: % both hyphenation at - and hyphenation within words.
1078: % We must therefore turn them both off (\tclose does that)
1079: % and arrange explicitly to hyphenate an a dash.
1080: % -- rms.
1081: {
1082: \catcode`\-=\active
1083: \catcode`\_=\active
1084: \global\def\code{\begingroup \catcode`\-=\active \let-\codedash \catcode`\_=\active \let_\codeunder \codex}
1085: % The following is used by \doprintindex to insure that long function names
1086: % wrap around. It is necessary for - and _ to be active before the index is
1087: % read from the file, as \entry parses the arguments long before \code is
1088: % ever called. -- mycroft
1089: \global\def\indexbreaks{\catcode`\-=\active \let-\realdash \catcode`\_=\active \let_\realunder}
1090: }
1091: \def\realdash{-}
1092: \def\realunder{_}
1093: \def\codedash{-\discretionary{}{}{}}
1094: \def\codeunder{\normalunderscore\discretionary{}{}{}}
1095: \def\codex #1{\tclose{#1}\endgroup}
1096:
1097: %\let\exp=\tclose %Was temporary
1098:
1099: % @kbd is like @code, except that if the argument is just one @key command,
1100: % then @kbd has no effect.
1101:
1102: \def\xkey{\key}
1103: \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
1104: \ifx\one\xkey\ifx\threex\three \key{#2}%
1105: \else\tclose{\look}\fi
1106: \else\tclose{\look}\fi}
1107:
1108: % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1109: % argument is to make the input look right: @dmn{pt} instead of
1110: % @dmn{}pt.
1111: %
1112: \def\dmn#1{\thinspace #1}
1113:
1114: \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
1115:
1116: \def\l#1{{\li #1}\null} %
1117:
1118: \def\r#1{{\rm #1}} % roman font
1119: % Use of \lowercase was suggested.
1120: \def\sc#1{{\smallcaps#1}} % smallcaps font
1121: \def\ii#1{{\it #1}} % italic font
1122:
1123: \message{page headings,}
1124:
1125: \newskip\titlepagetopglue \titlepagetopglue = 1.5in
1126: \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
1127:
1128: % First the title page. Must do @settitle before @titlepage.
1129: \def\titlefont#1{{\titlerm #1}}
1130:
1131: \newif\ifseenauthor
1132: \newif\iffinishedtitlepage
1133:
1134: \def\shorttitlepage{\parsearg\shorttitlepagezzz}
1135: \def\shorttitlepagezzz #1{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
1136: \endgroup\page\hbox{}\page}
1137:
1138: \def\titlepage{\begingroup \parindent=0pt \textfonts
1139: \let\subtitlerm=\tenrm
1140: % I deinstalled the following change because \cmr12 is undefined.
1141: % This change was not in the ChangeLog anyway. --rms.
1142: % \let\subtitlerm=\cmr12
1143: \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}%
1144: %
1145: \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines}%
1146: %
1147: % Leave some space at the very top of the page.
1148: \vglue\titlepagetopglue
1149: %
1150: % Now you can print the title using @title.
1151: \def\title{\parsearg\titlezzz}%
1152: \def\titlezzz##1{\leftline{\titlefont{##1}}
1153: % print a rule at the page bottom also.
1154: \finishedtitlepagefalse
1155: \vskip4pt \hrule height 4pt width \hsize \vskip4pt}%
1156: % No rule at page bottom unless we print one at the top with @title.
1157: \finishedtitlepagetrue
1158: %
1159: % Now you can put text using @subtitle.
1160: \def\subtitle{\parsearg\subtitlezzz}%
1161: \def\subtitlezzz##1{{\subtitlefont \rightline{##1}}}%
1162: %
1163: % @author should come last, but may come many times.
1164: \def\author{\parsearg\authorzzz}%
1165: \def\authorzzz##1{\ifseenauthor\else\vskip 0pt plus 1filll\seenauthortrue\fi
1166: {\authorfont \leftline{##1}}}%
1167: %
1168: % Most title ``pages'' are actually two pages long, with space
1169: % at the top of the second. We don't want the ragged left on the second.
1170: \let\oldpage = \page
1171: \def\page{%
1172: \iffinishedtitlepage\else
1173: \finishtitlepage
1174: \fi
1175: \oldpage
1176: \let\page = \oldpage
1177: \hbox{}}%
1178: % \def\page{\oldpage \hbox{}}
1179: }
1180:
1181: \def\Etitlepage{%
1182: \iffinishedtitlepage\else
1183: \finishtitlepage
1184: \fi
1185: % It is important to do the page break before ending the group,
1186: % because the headline and footline are only empty inside the group.
1187: % If we use the new definition of \page, we always get a blank page
1188: % after the title page, which we certainly don't want.
1189: \oldpage
1190: \endgroup
1191: \HEADINGSon
1192: }
1193:
1194: \def\finishtitlepage{%
1195: \vskip4pt \hrule height 2pt width \hsize
1196: \vskip\titlepagebottomglue
1197: \finishedtitlepagetrue
1198: }
1199:
1200: %%% Set up page headings and footings.
1201:
1202: \let\thispage=\folio
1203:
1204: \newtoks \evenheadline % Token sequence for heading line of even pages
1205: \newtoks \oddheadline % Token sequence for heading line of odd pages
1206: \newtoks \evenfootline % Token sequence for footing line of even pages
1207: \newtoks \oddfootline % Token sequence for footing line of odd pages
1208:
1209: % Now make Tex use those variables
1210: \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
1211: \else \the\evenheadline \fi}}
1212: \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
1213: \else \the\evenfootline \fi}\HEADINGShook}
1214: \let\HEADINGShook=\relax
1215:
1216: % Commands to set those variables.
1217: % For example, this is what @headings on does
1218: % @evenheading @thistitle|@thispage|@thischapter
1219: % @oddheading @thischapter|@thispage|@thistitle
1220: % @evenfooting @thisfile||
1221: % @oddfooting ||@thisfile
1222:
1223: \def\evenheading{\parsearg\evenheadingxxx}
1224: \def\oddheading{\parsearg\oddheadingxxx}
1225: \def\everyheading{\parsearg\everyheadingxxx}
1226:
1227: \def\evenfooting{\parsearg\evenfootingxxx}
1228: \def\oddfooting{\parsearg\oddfootingxxx}
1229: \def\everyfooting{\parsearg\everyfootingxxx}
1230:
1231: {\catcode`\@=0 %
1232:
1233: \gdef\evenheadingxxx #1{\evenheadingyyy #1@|@|@|@|\finish}
1234: \gdef\evenheadingyyy #1@|#2@|#3@|#4\finish{%
1235: \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1236:
1237: \gdef\oddheadingxxx #1{\oddheadingyyy #1@|@|@|@|\finish}
1238: \gdef\oddheadingyyy #1@|#2@|#3@|#4\finish{%
1239: \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1240:
1241: \gdef\everyheadingxxx #1{\everyheadingyyy #1@|@|@|@|\finish}
1242: \gdef\everyheadingyyy #1@|#2@|#3@|#4\finish{%
1243: \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1244: \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1245:
1246: \gdef\evenfootingxxx #1{\evenfootingyyy #1@|@|@|@|\finish}
1247: \gdef\evenfootingyyy #1@|#2@|#3@|#4\finish{%
1248: \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1249:
1250: \gdef\oddfootingxxx #1{\oddfootingyyy #1@|@|@|@|\finish}
1251: \gdef\oddfootingyyy #1@|#2@|#3@|#4\finish{%
1252: \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1253:
1254: \gdef\everyfootingxxx #1{\everyfootingyyy #1@|@|@|@|\finish}
1255: \gdef\everyfootingyyy #1@|#2@|#3@|#4\finish{%
1256: \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
1257: \global\oddfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
1258: %
1259: }% unbind the catcode of @.
1260:
1261: % @headings double turns headings on for double-sided printing.
1262: % @headings single turns headings on for single-sided printing.
1263: % @headings off turns them off.
1264: % @headings on same as @headings double, retained for compatibility.
1265: % @headings after turns on double-sided headings after this page.
1266: % @headings doubleafter turns on double-sided headings after this page.
1267: % @headings singleafter turns on single-sided headings after this page.
1268: % By default, they are off.
1269:
1270: \def\headings #1 {\csname HEADINGS#1\endcsname}
1271:
1272: \def\HEADINGSoff{
1273: \global\evenheadline={\hfil} \global\evenfootline={\hfil}
1274: \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
1275: \HEADINGSoff
1276: % When we turn headings on, set the page number to 1.
1277: % For double-sided printing, put current file name in lower left corner,
1278: % chapter name on inside top of right hand pages, document
1279: % title on inside top of left hand pages, and page numbers on outside top
1280: % edge of all pages.
1281: \def\HEADINGSdouble{
1282: %\pagealignmacro
1283: \global\pageno=1
1284: \global\evenfootline={\hfil}
1285: \global\oddfootline={\hfil}
1286: \global\evenheadline={\line{\folio\hfil\thistitle}}
1287: \global\oddheadline={\line{\thischapter\hfil\folio}}
1288: }
1289: % For single-sided printing, chapter title goes across top left of page,
1290: % page number on top right.
1291: \def\HEADINGSsingle{
1292: %\pagealignmacro
1293: \global\pageno=1
1294: \global\evenfootline={\hfil}
1295: \global\oddfootline={\hfil}
1296: \global\evenheadline={\line{\thischapter\hfil\folio}}
1297: \global\oddheadline={\line{\thischapter\hfil\folio}}
1298: }
1299: \def\HEADINGSon{\HEADINGSdouble}
1300:
1301: \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
1302: \let\HEADINGSdoubleafter=\HEADINGSafter
1303: \def\HEADINGSdoublex{%
1304: \global\evenfootline={\hfil}
1305: \global\oddfootline={\hfil}
1306: \global\evenheadline={\line{\folio\hfil\thistitle}}
1307: \global\oddheadline={\line{\thischapter\hfil\folio}}
1308: }
1309:
1310: \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
1311: \def\HEADINGSsinglex{%
1312: \global\evenfootline={\hfil}
1313: \global\oddfootline={\hfil}
1314: \global\evenheadline={\line{\thischapter\hfil\folio}}
1315: \global\oddheadline={\line{\thischapter\hfil\folio}}
1316: }
1317:
1318: % Subroutines used in generating headings
1319: % Produces Day Month Year style of output.
1320: \def\today{\number\day\space
1321: \ifcase\month\or
1322: January\or February\or March\or April\or May\or June\or
1323: July\or August\or September\or October\or November\or December\fi
1324: \space\number\year}
1325:
1326: % Use this if you want the Month Day, Year style of output.
1327: %\def\today{\ifcase\month\or
1328: %January\or February\or March\or April\or May\or June\or
1329: %July\or August\or September\or October\or November\or December\fi
1330: %\space\number\day, \number\year}
1331:
1332: % @settitle line... specifies the title of the document, for headings
1333: % It generates no output of its own
1334:
1335: \def\thistitle{No Title}
1336: \def\settitle{\parsearg\settitlezzz}
1337: \def\settitlezzz #1{\gdef\thistitle{#1}}
1338:
1339: \message{tables,}
1340:
1341: % @tabs -- simple alignment
1342:
1343: % These don't work. For one thing, \+ is defined as outer.
1344: % So these macros cannot even be defined.
1345:
1346: %\def\tabs{\parsearg\tabszzz}
1347: %\def\tabszzz #1{\settabs\+#1\cr}
1348: %\def\tabline{\parsearg\tablinezzz}
1349: %\def\tablinezzz #1{\+#1\cr}
1350: %\def\&{&}
1351:
1352: % Tables -- @table, @ftable, @vtable, @item(x), @kitem(x), @xitem(x).
1353:
1354: % default indentation of table text
1355: \newdimen\tableindent \tableindent=.8in
1356: % default indentation of @itemize and @enumerate text
1357: \newdimen\itemindent \itemindent=.3in
1358: % margin between end of table item and start of table text.
1359: \newdimen\itemmargin \itemmargin=.1in
1360:
1361: % used internally for \itemindent minus \itemmargin
1362: \newdimen\itemmax
1363:
1364: % Note @table, @vtable, and @vtable define @item, @itemx, etc., with
1365: % these defs.
1366: % They also define \itemindex
1367: % to index the item name in whatever manner is desired (perhaps none).
1368:
1369: \newif\ifitemxneedsnegativevskip
1370:
1371: \def\itemxpar{\par\ifitemxneedsnegativevskip\vskip-\parskip\nobreak\fi}
1372:
1373: \def\internalBitem{\smallbreak \parsearg\itemzzz}
1374: \def\internalBitemx{\itemxpar \parsearg\itemzzz}
1375:
1376: \def\internalBxitem "#1"{\def\xitemsubtopix{#1} \smallbreak \parsearg\xitemzzz}
1377: \def\internalBxitemx "#1"{\def\xitemsubtopix{#1} \itemxpar \parsearg\xitemzzz}
1378:
1379: \def\internalBkitem{\smallbreak \parsearg\kitemzzz}
1380: \def\internalBkitemx{\itemxpar \parsearg\kitemzzz}
1381:
1382: \def\kitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \lastfunction}}%
1383: \itemzzz {#1}}
1384:
1385: \def\xitemzzz #1{\dosubind {kw}{\code{#1}}{for {\bf \xitemsubtopic}}%
1386: \itemzzz {#1}}
1387:
1388: \def\itemzzz #1{\begingroup %
1389: \advance\hsize by -\rightskip
1390: \advance\hsize by -\tableindent
1391: \setbox0=\hbox{\itemfont{#1}}%
1392: \itemindex{#1}%
1393: \nobreak % This prevents a break before @itemx.
1394: %
1395: % Be sure we are not still in the middle of a paragraph.
1396: %{\parskip = 0in
1397: %\par
1398: %}%
1399: %
1400: % If the item text does not fit in the space we have, put it on a line
1401: % by itself, and do not allow a page break either before or after that
1402: % line. We do not start a paragraph here because then if the next
1403: % command is, e.g., @kindex, the whatsit would get put into the
1404: % horizontal list on a line by itself, resulting in extra blank space.
1405: \ifdim \wd0>\itemmax
1406: %
1407: % Make this a paragraph so we get the \parskip glue and wrapping,
1408: % but leave it ragged-right.
1409: \begingroup
1410: \advance\leftskip by-\tableindent
1411: \advance\hsize by\tableindent
1412: \advance\rightskip by0pt plus1fil
1413: \leavevmode\unhbox0\par
1414: \endgroup
1415: %
1416: % We're going to be starting a paragraph, but we don't want the
1417: % \parskip glue -- logically it's part of the @item we just started.
1418: \nobreak \vskip-\parskip
1419: %
1420: % Stop a page break at the \parskip glue coming up. Unfortunately
1421: % we can't prevent a possible page break at the following
1422: % \baselineskip glue.
1423: \nobreak
1424: \endgroup
1425: \itemxneedsnegativevskipfalse
1426: \else
1427: % The item text fits into the space. Start a paragraph, so that the
1428: % following text (if any) will end up on the same line. Since that
1429: % text will be indented by \tableindent, we make the item text be in
1430: % a zero-width box.
1431: \noindent
1432: \rlap{\hskip -\tableindent\box0}\ignorespaces%
1433: \endgroup%
1434: \itemxneedsnegativevskiptrue%
1435: \fi
1436: }
1437:
1438: \def\item{\errmessage{@item while not in a table}}
1439: \def\itemx{\errmessage{@itemx while not in a table}}
1440: \def\kitem{\errmessage{@kitem while not in a table}}
1441: \def\kitemx{\errmessage{@kitemx while not in a table}}
1442: \def\xitem{\errmessage{@xitem while not in a table}}
1443: \def\xitemx{\errmessage{@xitemx while not in a table}}
1444:
1445: %% Contains a kludge to get @end[description] to work
1446: \def\description{\tablez{\dontindex}{1}{}{}{}{}}
1447:
1448: \def\table{\begingroup\inENV\obeylines\obeyspaces\tablex}
1449: {\obeylines\obeyspaces%
1450: \gdef\tablex #1^^M{%
1451: \tabley\dontindex#1 \endtabley}}
1452:
1453: \def\ftable{\begingroup\inENV\obeylines\obeyspaces\ftablex}
1454: {\obeylines\obeyspaces%
1455: \gdef\ftablex #1^^M{%
1456: \tabley\fnitemindex#1 \endtabley
1457: \def\Eftable{\endgraf\afterenvbreak\endgroup}%
1458: \let\Etable=\relax}}
1459:
1460: \def\vtable{\begingroup\inENV\obeylines\obeyspaces\vtablex}
1461: {\obeylines\obeyspaces%
1462: \gdef\vtablex #1^^M{%
1463: \tabley\vritemindex#1 \endtabley
1464: \def\Evtable{\endgraf\afterenvbreak\endgroup}%
1465: \let\Etable=\relax}}
1466:
1467: \def\dontindex #1{}
1468: \def\fnitemindex #1{\doind {fn}{\code{#1}}}%
1469: \def\vritemindex #1{\doind {vr}{\code{#1}}}%
1470:
1471: {\obeyspaces %
1472: \gdef\tabley#1#2 #3 #4 #5 #6 #7\endtabley{\endgroup%
1473: \tablez{#1}{#2}{#3}{#4}{#5}{#6}}}
1474:
1475: \def\tablez #1#2#3#4#5#6{%
1476: \aboveenvbreak %
1477: \begingroup %
1478: \def\Edescription{\Etable}% Neccessary kludge.
1479: \let\itemindex=#1%
1480: \ifnum 0#3>0 \advance \leftskip by #3\mil \fi %
1481: \ifnum 0#4>0 \tableindent=#4\mil \fi %
1482: \ifnum 0#5>0 \advance \rightskip by #5\mil \fi %
1483: \def\itemfont{#2}%
1484: \itemmax=\tableindent %
1485: \advance \itemmax by -\itemmargin %
1486: \advance \leftskip by \tableindent %
1487: \exdentamount=\tableindent
1488: \parindent = 0pt
1489: \parskip = \smallskipamount
1490: \ifdim \parskip=0pt \parskip=2pt \fi%
1491: \def\Etable{\endgraf\afterenvbreak\endgroup}%
1492: \let\item = \internalBitem %
1493: \let\itemx = \internalBitemx %
1494: \let\kitem = \internalBkitem %
1495: \let\kitemx = \internalBkitemx %
1496: \let\xitem = \internalBxitem %
1497: \let\xitemx = \internalBxitemx %
1498: }
1499:
1500: % This is the counter used by @enumerate, which is really @itemize
1501:
1502: \newcount \itemno
1503:
1504: \def\itemize{\parsearg\itemizezzz}
1505:
1506: \def\itemizezzz #1{%
1507: \begingroup % ended by the @end itemsize
1508: \itemizey {#1}{\Eitemize}
1509: }
1510:
1511: \def\itemizey #1#2{%
1512: \aboveenvbreak %
1513: \itemmax=\itemindent %
1514: \advance \itemmax by -\itemmargin %
1515: \advance \leftskip by \itemindent %
1516: \exdentamount=\itemindent
1517: \parindent = 0pt %
1518: \parskip = \smallskipamount %
1519: \ifdim \parskip=0pt \parskip=2pt \fi%
1520: \def#2{\endgraf\afterenvbreak\endgroup}%
1521: \def\itemcontents{#1}%
1522: \let\item=\itemizeitem}
1523:
1524: % Set sfcode to normal for the chars that usually have another value.
1525: % These are `.?!:;,'
1526: \def\frenchspacing{\sfcode46=1000 \sfcode63=1000 \sfcode33=1000
1527: \sfcode58=1000 \sfcode59=1000 \sfcode44=1000 }
1528:
1529: % \splitoff TOKENS\endmark defines \first to be the first token in
1530: % TOKENS, and \rest to be the remainder.
1531: %
1532: \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
1533:
1534: % Allow an optional argument of an uppercase letter, lowercase letter,
1535: % or number, to specify the first label in the enumerated list. No
1536: % argument is the same as `1'.
1537: %
1538: \def\enumerate{\parsearg\enumeratezzz}
1539: \def\enumeratezzz #1{\enumeratey #1 \endenumeratey}
1540: \def\enumeratey #1 #2\endenumeratey{%
1541: \begingroup % ended by the @end enumerate
1542: %
1543: % If we were given no argument, pretend we were given `1'.
1544: \def\thearg{#1}%
1545: \ifx\thearg\empty \def\thearg{1}\fi
1546: %
1547: % Detect if the argument is a single token. If so, it might be a
1548: % letter. Otherwise, the only valid thing it can be is a number.
1549: % (We will always have one token, because of the test we just made.
1550: % This is a good thing, since \splitoff doesn't work given nothing at
1551: % all -- the first parameter is undelimited.)
1552: \expandafter\splitoff\thearg\endmark
1553: \ifx\rest\empty
1554: % Only one token in the argument. It could still be anything.
1555: % A ``lowercase letter'' is one whose \lccode is nonzero.
1556: % An ``uppercase letter'' is one whose \lccode is both nonzero, and
1557: % not equal to itself.
1558: % Otherwise, we assume it's a number.
1559: %
1560: % We need the \relax at the end of the \ifnum lines to stop TeX from
1561: % continuing to look for a <number>.
1562: %
1563: \ifnum\lccode\expandafter`\thearg=0\relax
1564: \numericenumerate % a number (we hope)
1565: \else
1566: % It's a letter.
1567: \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
1568: \lowercaseenumerate % lowercase letter
1569: \else
1570: \uppercaseenumerate % uppercase letter
1571: \fi
1572: \fi
1573: \else
1574: % Multiple tokens in the argument. We hope it's a number.
1575: \numericenumerate
1576: \fi
1577: }
1578:
1579: % An @enumerate whose labels are integers. The starting integer is
1580: % given in \thearg.
1581: %
1582: \def\numericenumerate{%
1583: \itemno = \thearg
1584: \startenumeration{\the\itemno}%
1585: }
1586:
1587: % The starting (lowercase) letter is in \thearg.
1588: \def\lowercaseenumerate{%
1589: \itemno = \expandafter`\thearg
1590: \startenumeration{%
1591: % Be sure we're not beyond the end of the alphabet.
1592: \ifnum\itemno=0
1593: \errmessage{No more lowercase letters in @enumerate; get a bigger
1594: alphabet}%
1595: \fi
1596: \char\lccode\itemno
1597: }%
1598: }
1599:
1600: % The starting (uppercase) letter is in \thearg.
1601: \def\uppercaseenumerate{%
1602: \itemno = \expandafter`\thearg
1603: \startenumeration{%
1604: % Be sure we're not beyond the end of the alphabet.
1605: \ifnum\itemno=0
1606: \errmessage{No more uppercase letters in @enumerate; get a bigger
1607: alphabet}
1608: \fi
1609: \char\uccode\itemno
1610: }%
1611: }
1612:
1613: % Call itemizey, adding a period to the first argument and supplying the
1614: % common last two arguments. Also subtract one from the initial value in
1615: % \itemno, since @item increments \itemno.
1616: %
1617: \def\startenumeration#1{%
1618: \advance\itemno by -1
1619: \itemizey{#1.}\Eenumerate\flushcr
1620: }
1621:
1622: % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
1623: % to @enumerate.
1624: %
1625: \def\alphaenumerate{\enumerate{a}}
1626: \def\capsenumerate{\enumerate{A}}
1627: \def\Ealphaenumerate{\Eenumerate}
1628: \def\Ecapsenumerate{\Eenumerate}
1629:
1630: % Definition of @item while inside @itemize.
1631:
1632: \def\itemizeitem{%
1633: \advance\itemno by 1
1634: {\let\par=\endgraf \smallbreak}%
1635: \ifhmode \errmessage{\in hmode at itemizeitem}\fi
1636: {\parskip=0in \hskip 0pt
1637: \hbox to 0pt{\hss \itemcontents\hskip \itemmargin}%
1638: \vadjust{\penalty 1200}}%
1639: \flushcr}
1640:
1641: \message{indexing,}
1642: % Index generation facilities
1643:
1644: % Define \newwrite to be identical to plain tex's \newwrite
1645: % except not \outer, so it can be used within \newindex.
1646: {\catcode`\@=11
1647: \gdef\newwrite{\alloc@7\write\chardef\sixt@@n}}
1648:
1649: % \newindex {foo} defines an index named foo.
1650: % It automatically defines \fooindex such that
1651: % \fooindex ...rest of line... puts an entry in the index foo.
1652: % It also defines \fooindfile to be the number of the output channel for
1653: % the file that accumulates this index. The file's extension is foo.
1654: % The name of an index should be no more than 2 characters long
1655: % for the sake of vms.
1656:
1657: \def\newindex #1{
1658: \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
1659: \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
1660: \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1661: \noexpand\doindex {#1}}
1662: }
1663:
1664: % @defindex foo == \newindex{foo}
1665:
1666: \def\defindex{\parsearg\newindex}
1667:
1668: % Define @defcodeindex, like @defindex except put all entries in @code.
1669:
1670: \def\newcodeindex #1{
1671: \expandafter\newwrite \csname#1indfile\endcsname% Define number for output file
1672: \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
1673: \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1674: \noexpand\docodeindex {#1}}
1675: }
1676:
1677: \def\defcodeindex{\parsearg\newcodeindex}
1678:
1679: % @synindex foo bar makes index foo feed into index bar.
1680: % Do this instead of @defindex foo if you don't want it as a separate index.
1681: \def\synindex #1 #2 {%
1682: \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
1683: \expandafter\let\csname#1indfile\endcsname=\synindexfoo
1684: \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1685: \noexpand\doindex {#2}}%
1686: }
1687:
1688: % @syncodeindex foo bar similar, but put all entries made for index foo
1689: % inside @code.
1690: \def\syncodeindex #1 #2 {%
1691: \expandafter\let\expandafter\synindexfoo\expandafter=\csname#2indfile\endcsname
1692: \expandafter\let\csname#1indfile\endcsname=\synindexfoo
1693: \expandafter\xdef\csname#1index\endcsname{% % Define \xxxindex
1694: \noexpand\docodeindex {#2}}%
1695: }
1696:
1697: % Define \doindex, the driver for all \fooindex macros.
1698: % Argument #1 is generated by the calling \fooindex macro,
1699: % and it is "foo", the name of the index.
1700:
1701: % \doindex just uses \parsearg; it calls \doind for the actual work.
1702: % This is because \doind is more useful to call from other macros.
1703:
1704: % There is also \dosubind {index}{topic}{subtopic}
1705: % which makes an entry in a two-level index such as the operation index.
1706:
1707: \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
1708: \def\singleindexer #1{\doind{\indexname}{#1}}
1709:
1710: % like the previous two, but they put @code around the argument.
1711: \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
1712: \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
1713:
1714: \def\indexdummies{%
1715: \def\_{{\realbackslash _}}%
1716: \def\w{\realbackslash w }%
1717: \def\bf{\realbackslash bf }%
1718: \def\rm{\realbackslash rm }%
1719: \def\sl{\realbackslash sl }%
1720: \def\sf{\realbackslash sf}%
1721: \def\tt{\realbackslash tt}%
1722: \def\gtr{\realbackslash gtr}%
1723: \def\less{\realbackslash less}%
1724: \def\hat{\realbackslash hat}%
1725: \def\char{\realbackslash char}%
1726: \def\TeX{\realbackslash TeX}%
1727: \def\dots{\realbackslash dots }%
1728: \def\copyright{\realbackslash copyright }%
1729: \def\tclose##1{\realbackslash tclose {##1}}%
1730: \def\code##1{\realbackslash code {##1}}%
1731: \def\samp##1{\realbackslash samp {##1}}%
1732: \def\t##1{\realbackslash r {##1}}%
1733: \def\r##1{\realbackslash r {##1}}%
1734: \def\i##1{\realbackslash i {##1}}%
1735: \def\b##1{\realbackslash b {##1}}%
1736: \def\cite##1{\realbackslash cite {##1}}%
1737: \def\key##1{\realbackslash key {##1}}%
1738: \def\file##1{\realbackslash file {##1}}%
1739: \def\var##1{\realbackslash var {##1}}%
1740: \def\kbd##1{\realbackslash kbd {##1}}%
1741: \def\dfn##1{\realbackslash dfn {##1}}%
1742: \def\emph##1{\realbackslash emph {##1}}%
1743: }
1744:
1745: % \indexnofonts no-ops all font-change commands.
1746: % This is used when outputting the strings to sort the index by.
1747: \def\indexdummyfont#1{#1}
1748: \def\indexdummytex{TeX}
1749: \def\indexdummydots{...}
1750:
1751: \def\indexnofonts{%
1752: \let\w=\indexdummyfont
1753: \let\t=\indexdummyfont
1754: \let\r=\indexdummyfont
1755: \let\i=\indexdummyfont
1756: \let\b=\indexdummyfont
1757: \let\emph=\indexdummyfont
1758: \let\strong=\indexdummyfont
1759: \let\cite=\indexdummyfont
1760: \let\sc=\indexdummyfont
1761: %Don't no-op \tt, since it isn't a user-level command
1762: % and is used in the definitions of the active chars like <, >, |...
1763: %\let\tt=\indexdummyfont
1764: \let\tclose=\indexdummyfont
1765: \let\code=\indexdummyfont
1766: \let\file=\indexdummyfont
1767: \let\samp=\indexdummyfont
1768: \let\kbd=\indexdummyfont
1769: \let\key=\indexdummyfont
1770: \let\var=\indexdummyfont
1771: \let\TeX=\indexdummytex
1772: \let\dots=\indexdummydots
1773: }
1774:
1775: % To define \realbackslash, we must make \ not be an escape.
1776: % We must first make another character (@) an escape
1777: % so we do not become unable to do a definition.
1778:
1779: {\catcode`\@=0 \catcode`\\=\other
1780: @gdef@realbackslash{\}}
1781:
1782: \let\indexbackslash=0 %overridden during \printindex.
1783:
1784: \def\doind #1#2{%
1785: {\count10=\lastpenalty %
1786: {\indexdummies % Must do this here, since \bf, etc expand at this stage
1787: \escapechar=`\\%
1788: {\let\folio=0% Expand all macros now EXCEPT \folio
1789: \def\rawbackslashxx{\indexbackslash}% \indexbackslash isn't defined now
1790: % so it will be output as is; and it will print as backslash in the indx.
1791: %
1792: % Now process the index-string once, with all font commands turned off,
1793: % to get the string to sort the index by.
1794: {\indexnofonts
1795: \xdef\temp1{#2}%
1796: }%
1797: % Now produce the complete index entry. We process the index-string again,
1798: % this time with font commands expanded, to get what to print in the index.
1799: \edef\temp{%
1800: \write \csname#1indfile\endcsname{%
1801: \realbackslash entry {\temp1}{\folio}{#2}}}%
1802: \temp }%
1803: }\penalty\count10}}
1804:
1805: \def\dosubind #1#2#3{%
1806: {\count10=\lastpenalty %
1807: {\indexdummies % Must do this here, since \bf, etc expand at this stage
1808: \escapechar=`\\%
1809: {\let\folio=0%
1810: \def\rawbackslashxx{\indexbackslash}%
1811: %
1812: % Now process the index-string once, with all font commands turned off,
1813: % to get the string to sort the index by.
1814: {\indexnofonts
1815: \xdef\temp1{#2 #3}%
1816: }%
1817: % Now produce the complete index entry. We process the index-string again,
1818: % this time with font commands expanded, to get what to print in the index.
1819: \edef\temp{%
1820: \write \csname#1indfile\endcsname{%
1821: \realbackslash entry {\temp1}{\folio}{#2}{#3}}}%
1822: \temp }%
1823: }\penalty\count10}}
1824:
1825: % The index entry written in the file actually looks like
1826: % \entry {sortstring}{page}{topic}
1827: % or
1828: % \entry {sortstring}{page}{topic}{subtopic}
1829: % The texindex program reads in these files and writes files
1830: % containing these kinds of lines:
1831: % \initial {c}
1832: % before the first topic whose initial is c
1833: % \entry {topic}{pagelist}
1834: % for a topic that is used without subtopics
1835: % \primary {topic}
1836: % for the beginning of a topic that is used with subtopics
1837: % \secondary {subtopic}{pagelist}
1838: % for each subtopic.
1839:
1840: % Define the user-accessible indexing commands
1841: % @findex, @vindex, @kindex, @cindex.
1842:
1843: \def\findex {\fnindex}
1844: \def\kindex {\kyindex}
1845: \def\cindex {\cpindex}
1846: \def\vindex {\vrindex}
1847: \def\tindex {\tpindex}
1848: \def\pindex {\pgindex}
1849:
1850: \def\cindexsub {\begingroup\obeylines\cindexsub}
1851: {\obeylines %
1852: \gdef\cindexsub "#1" #2^^M{\endgroup %
1853: \dosubind{cp}{#2}{#1}}}
1854:
1855: % Define the macros used in formatting output of the sorted index material.
1856:
1857: % This is what you call to cause a particular index to get printed.
1858: % Write
1859: % @unnumbered Function Index
1860: % @printindex fn
1861:
1862: \def\printindex{\parsearg\doprintindex}
1863:
1864: \def\doprintindex#1{%
1865: \tex
1866: \dobreak \chapheadingskip {10000}
1867: \catcode`\%=\other\catcode`\&=\other\catcode`\#=\other
1868: \catcode`\$=\other
1869: \catcode`\~=\other
1870: \indexbreaks
1871: %
1872: % The following don't help, since the chars were translated
1873: % when the raw index was written, and their fonts were discarded
1874: % due to \indexnofonts.
1875: %\catcode`\"=\active
1876: %\catcode`\^=\active
1877: %\catcode`\_=\active
1878: %\catcode`\|=\active
1879: %\catcode`\<=\active
1880: %\catcode`\>=\active
1881: % %
1882: \def\indexbackslash{\rawbackslashxx}
1883: \indexfonts\rm \tolerance=9500 \advance\baselineskip -1pt
1884: \begindoublecolumns
1885: %
1886: % See if the index file exists and is nonempty.
1887: \openin 1 \jobname.#1s
1888: \ifeof 1
1889: % \enddoublecolumns gets confused if there is no text in the index,
1890: % and it loses the chapter title and the aux file entries for the
1891: % index. The easiest way to prevent this problem is to make sure
1892: % there is some text.
1893: (Index is nonexistent)
1894: \else
1895: %
1896: % If the index file exists but is empty, then \openin leaves \ifeof
1897: % false. We have to make TeX try to read something from the file, so
1898: % it can discover if there is anything in it.
1899: \read 1 to \temp
1900: \ifeof 1
1901: (Index is empty)
1902: \else
1903: \input \jobname.#1s
1904: \fi
1905: \fi
1906: \closein 1
1907: \enddoublecolumns
1908: \Etex
1909: }
1910:
1911: % These macros are used by the sorted index file itself.
1912: % Change them to control the appearance of the index.
1913:
1914: % Same as \bigskipamount except no shrink.
1915: % \balancecolumns gets confused if there is any shrink.
1916: \newskip\initialskipamount \initialskipamount 12pt plus4pt
1917:
1918: \def\initial #1{%
1919: {\let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
1920: \ifdim\lastskip<\initialskipamount
1921: \removelastskip \penalty-200 \vskip \initialskipamount\fi
1922: \line{\secbf#1\hfill}\kern 2pt\penalty10000}}
1923:
1924: % This typesets a paragraph consisting of #1, dot leaders, and then #2
1925: % flush to the right margin. It is used for index and table of contents
1926: % entries. The paragraph is indented by \leftskip.
1927: %
1928: \def\entry #1#2{\begingroup
1929: %
1930: % Start a new paragraph if necessary, so our assignments below can't
1931: % affect previous text.
1932: \par
1933: %
1934: % Do not fill out the last line with white space.
1935: \parfillskip = 0in
1936: %
1937: % No extra space above this paragraph.
1938: \parskip = 0in
1939: %
1940: % Do not prefer a separate line ending with a hyphen to fewer lines.
1941: \finalhyphendemerits = 0
1942: %
1943: % \hangindent is only relevant when the entry text and page number
1944: % don't both fit on one line. In that case, bob suggests starting the
1945: % dots pretty far over on the line. Unfortunately, a large
1946: % indentation looks wrong when the entry text itself is broken across
1947: % lines. So we use a small indentation and put up with long leaders.
1948: %
1949: % \hangafter is reset to 1 (which is the value we want) at the start
1950: % of each paragraph, so we need not do anything with that.
1951: \hangindent=2em
1952: %
1953: % When the entry text needs to be broken, just fill out the first line
1954: % with blank space.
1955: \rightskip = 0pt plus1fil
1956: %
1957: % Start a ``paragraph'' for the index entry so the line breaking
1958: % parameters we've set above will have an effect.
1959: \noindent
1960: %
1961: % Insert the text of the index entry. TeX will do line-breaking on it.
1962: #1%
1963: % The following is kluged to not output a line of dots in the index if
1964: % there are no page numbers. The next person who breaks this will be
1965: % cursed by a Unix daemon.
1966: \def\tempa{{\rm }}%
1967: \def\tempb{#2}%
1968: \edef\tempc{\tempa}%
1969: \edef\tempd{\tempb}%
1970: \ifx\tempc\tempd\ \else%
1971: %
1972: % If we must, put the page number on a line of its own, and fill out
1973: % this line with blank space. (The \hfil is overwhelmed with the
1974: % fill leaders glue in \indexdotfill if the page number does fit.)
1975: \hfil\penalty50
1976: \null\nobreak\indexdotfill % Have leaders before the page number.
1977: %
1978: % The `\ ' here is removed by the implicit \unskip that TeX does as
1979: % part of (the primitive) \par. Without it, a spurious underfull
1980: % \hbox ensues.
1981: \ #2% The page number ends the paragraph.
1982: \fi%
1983: \par
1984: \endgroup}
1985:
1986: % Like \dotfill except takes at least 1 em.
1987: \def\indexdotfill{\cleaders
1988: \hbox{$\mathsurround=0pt \mkern1.5mu . \mkern1.5mu$}\hskip 1em plus 1fill}
1989:
1990: \def\primary #1{\line{#1\hfil}}
1991:
1992: \newskip\secondaryindent \secondaryindent=0.5cm
1993:
1994: \def\secondary #1#2{
1995: {\parfillskip=0in \parskip=0in
1996: \hangindent =1in \hangafter=1
1997: \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill #2\par
1998: }}
1999:
2000: %% Define two-column mode, which is used in indexes.
2001: %% Adapted from the TeXbook, page 416.
2002: \catcode `\@=11
2003:
2004: \newbox\partialpage
2005:
2006: \newdimen\doublecolumnhsize
2007:
2008: \def\begindoublecolumns{\begingroup
2009: % Grab any single-column material above us.
2010: \output = {\global\setbox\partialpage
2011: =\vbox{\unvbox255\kern -\topskip \kern \baselineskip}}%
2012: \eject
2013: %
2014: % Now switch to the double-column output routine.
2015: \output={\doublecolumnout}%
2016: %
2017: % Change the page size parameters. We could do this once outside this
2018: % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
2019: % format, but then we repeat the same computation. Repeating a couple
2020: % of assignments once per index is clearly meaningless for the
2021: % execution time, so we may as well do it once.
2022: %
2023: % First we halve the line length, less a little for the gutter between
2024: % the columns. We compute the gutter based on the line length, so it
2025: % changes automatically with the paper format. The magic constant
2026: % below is chosen so that the gutter has the same value (well, +- <
2027: % 1pt) as it did when we hard-coded it.
2028: %
2029: % We put the result in a separate register, \doublecolumhsize, so we
2030: % can restore it in \pagesofar, after \hsize itself has (potentially)
2031: % been clobbered.
2032: %
2033: \doublecolumnhsize = \hsize
2034: \advance\doublecolumnhsize by -.04154\hsize
2035: \divide\doublecolumnhsize by 2
2036: \hsize = \doublecolumnhsize
2037: %
2038: % Double the \vsize as well. (We don't need a separate register here,
2039: % since nobody clobbers \vsize.)
2040: \vsize = 2\vsize
2041: \doublecolumnpagegoal
2042: }
2043:
2044: \def\enddoublecolumns{\eject \endgroup \pagegoal=\vsize \unvbox\partialpage}
2045:
2046: \def\doublecolumnsplit{\splittopskip=\topskip \splitmaxdepth=\maxdepth
2047: \global\dimen@=\pageheight \global\advance\dimen@ by-\ht\partialpage
2048: \global\setbox1=\vsplit255 to\dimen@ \global\setbox0=\vbox{\unvbox1}
2049: \global\setbox3=\vsplit255 to\dimen@ \global\setbox2=\vbox{\unvbox3}
2050: \ifdim\ht0>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2051: \ifdim\ht2>\dimen@ \setbox255=\vbox{\unvbox0\unvbox2} \global\setbox255=\copy5 \fi
2052: }
2053: \def\doublecolumnpagegoal{%
2054: \dimen@=\vsize \advance\dimen@ by-2\ht\partialpage \global\pagegoal=\dimen@
2055: }
2056: \def\pagesofar{\unvbox\partialpage %
2057: \hsize=\doublecolumnhsize % have to restore this since output routine
2058: \wd0=\hsize \wd2=\hsize \hbox to\pagewidth{\box0\hfil\box2}}
2059: \def\doublecolumnout{%
2060: \setbox5=\copy255
2061: {\vbadness=10000 \doublecolumnsplit}
2062: \ifvbox255
2063: \setbox0=\vtop to\dimen@{\unvbox0}
2064: \setbox2=\vtop to\dimen@{\unvbox2}
2065: \onepageout\pagesofar \unvbox255 \penalty\outputpenalty
2066: \else
2067: \setbox0=\vbox{\unvbox5}
2068: \ifvbox0
2069: \dimen@=\ht0 \advance\dimen@ by\topskip \advance\dimen@ by-\baselineskip
2070: \divide\dimen@ by2 \splittopskip=\topskip \splitmaxdepth=\maxdepth
2071: {\vbadness=10000
2072: \loop \global\setbox5=\copy0
2073: \setbox1=\vsplit5 to\dimen@
2074: \setbox3=\vsplit5 to\dimen@
2075: \ifvbox5 \global\advance\dimen@ by1pt \repeat
2076: \setbox0=\vbox to\dimen@{\unvbox1}
2077: \setbox2=\vbox to\dimen@{\unvbox3}
2078: \global\setbox\partialpage=\vbox{\pagesofar}
2079: \doublecolumnpagegoal
2080: }
2081: \fi
2082: \fi
2083: }
2084:
2085: \catcode `\@=\other
2086: \message{sectioning,}
2087: % Define chapters, sections, etc.
2088:
2089: \newcount \chapno
2090: \newcount \secno \secno=0
2091: \newcount \subsecno \subsecno=0
2092: \newcount \subsubsecno \subsubsecno=0
2093:
2094: % This counter is funny since it counts through charcodes of letters A, B, ...
2095: \newcount \appendixno \appendixno = `\@
2096: \def\appendixletter{\char\the\appendixno}
2097:
2098: \newwrite \contentsfile
2099: % This is called from \setfilename.
2100: \def\opencontents{\openout \contentsfile = \jobname.toc}
2101:
2102: % Each @chapter defines this as the name of the chapter.
2103: % page headings and footings can use it. @section does likewise
2104:
2105: \def\thischapter{} \def\thissection{}
2106: \def\seccheck#1{\if \pageno<0 %
2107: \errmessage{@#1 not allowed after generating table of contents}\fi
2108: %
2109: }
2110:
2111: \def\chapternofonts{%
2112: \let\rawbackslash=\relax%
2113: \let\frenchspacing=\relax%
2114: \def\result{\realbackslash result}
2115: \def\equiv{\realbackslash equiv}
2116: \def\expansion{\realbackslash expansion}
2117: \def\print{\realbackslash print}
2118: \def\TeX{\realbackslash TeX}
2119: \def\dots{\realbackslash dots}
2120: \def\copyright{\realbackslash copyright}
2121: \def\tt{\realbackslash tt}
2122: \def\bf{\realbackslash bf }
2123: \def\w{\realbackslash w}
2124: \def\less{\realbackslash less}
2125: \def\gtr{\realbackslash gtr}
2126: \def\hat{\realbackslash hat}
2127: \def\char{\realbackslash char}
2128: \def\tclose##1{\realbackslash tclose {##1}}
2129: \def\code##1{\realbackslash code {##1}}
2130: \def\samp##1{\realbackslash samp {##1}}
2131: \def\r##1{\realbackslash r {##1}}
2132: \def\b##1{\realbackslash b {##1}}
2133: \def\key##1{\realbackslash key {##1}}
2134: \def\file##1{\realbackslash file {##1}}
2135: \def\kbd##1{\realbackslash kbd {##1}}
2136: % These are redefined because @smartitalic wouldn't work inside xdef.
2137: \def\i##1{\realbackslash i {##1}}
2138: \def\cite##1{\realbackslash cite {##1}}
2139: \def\var##1{\realbackslash var {##1}}
2140: \def\emph##1{\realbackslash emph {##1}}
2141: \def\dfn##1{\realbackslash dfn {##1}}
2142: }
2143:
2144: \newcount\absseclevel % used to calculate proper heading level
2145: \newcount\secbase\secbase=0 % @raise/lowersections modify this count
2146:
2147: % @raisesections: treat @section as chapter, @subsection as section, etc.
2148: \def\raisesections{\global\advance\secbase by -1}
2149: \let\up=\raisesections % original BFox name
2150:
2151: % @lowersections: treat @chapter as section, @section as subsection, etc.
2152: \def\lowersections{\global\advance\secbase by 1}
2153: \let\down=\lowersections % original BFox name
2154:
2155: % Choose a numbered-heading macro
2156: % #1 is heading level if unmodified by @raisesections or @lowersections
2157: % #2 is text for heading
2158: \def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2159: \ifcase\absseclevel
2160: \chapterzzz{#2}
2161: \or
2162: \seczzz{#2}
2163: \or
2164: \numberedsubseczzz{#2}
2165: \or
2166: \numberedsubsubseczzz{#2}
2167: \else
2168: \ifnum \absseclevel<0
2169: \chapterzzz{#2}
2170: \else
2171: \numberedsubsubseczzz{#2}
2172: \fi
2173: \fi
2174: }
2175:
2176: % like \numhead, but chooses appendix heading levels
2177: \def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2178: \ifcase\absseclevel
2179: \appendixzzz{#2}
2180: \or
2181: \appendixsectionzzz{#2}
2182: \or
2183: \appendixsubseczzz{#2}
2184: \or
2185: \appendixsubsubseczzz{#2}
2186: \else
2187: \ifnum \absseclevel<0
2188: \appendixzzz{#2}
2189: \else
2190: \appendixsubsubseczzz{#2}
2191: \fi
2192: \fi
2193: }
2194:
2195: % like \numhead, but chooses numberless heading levels
2196: \def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1
2197: \ifcase\absseclevel
2198: \unnumberedzzz{#2}
2199: \or
2200: \unnumberedseczzz{#2}
2201: \or
2202: \unnumberedsubseczzz{#2}
2203: \or
2204: \unnumberedsubsubseczzz{#2}
2205: \else
2206: \ifnum \absseclevel<0
2207: \unnumberedzzz{#2}
2208: \else
2209: \unnumberedsubsubseczzz{#2}
2210: \fi
2211: \fi
2212: }
2213:
2214:
2215: \def\thischaptername{No Chapter Title}
2216: \outer\def\chapter{\parsearg\chapteryyy}
2217: \def\chapteryyy #1{\numhead0{#1}} % normally numhead0 calls chapterzzz
2218: \def\chapterzzz #1{\seccheck{chapter}%
2219: \secno=0 \subsecno=0 \subsubsecno=0
2220: \global\advance \chapno by 1 \message{Chapter \the\chapno}%
2221: \chapmacro {#1}{\the\chapno}%
2222: \gdef\thissection{#1}%
2223: \gdef\thischaptername{#1}%
2224: % We don't substitute the actual chapter name into \thischapter
2225: % because we don't want its macros evaluated now.
2226: \xdef\thischapter{Chapter \the\chapno: \noexpand\thischaptername}%
2227: {\chapternofonts%
2228: \edef\temp{{\realbackslash chapentry {#1}{\the\chapno}{\noexpand\folio}}}%
2229: \escapechar=`\\%
2230: \write \contentsfile \temp %
2231: \donoderef %
2232: \global\let\section = \numberedsec
2233: \global\let\subsection = \numberedsubsec
2234: \global\let\subsubsection = \numberedsubsubsec
2235: }}
2236:
2237: \outer\def\appendix{\parsearg\appendixyyy}
2238: \def\appendixyyy #1{\apphead0{#1}} % normally apphead0 calls appendixzzz
2239: \def\appendixzzz #1{\seccheck{appendix}%
2240: \secno=0 \subsecno=0 \subsubsecno=0
2241: \global\advance \appendixno by 1 \message{Appendix \appendixletter}%
2242: \chapmacro {#1}{Appendix \appendixletter}%
2243: \gdef\thissection{#1}%
2244: \gdef\thischaptername{#1}%
2245: \xdef\thischapter{Appendix \appendixletter: \noexpand\thischaptername}%
2246: {\chapternofonts%
2247: \edef\temp{{\realbackslash chapentry
2248: {#1}{Appendix \appendixletter}{\noexpand\folio}}}%
2249: \escapechar=`\\%
2250: \write \contentsfile \temp %
2251: \appendixnoderef %
2252: \global\let\section = \appendixsec
2253: \global\let\subsection = \appendixsubsec
2254: \global\let\subsubsection = \appendixsubsubsec
2255: }}
2256:
2257: \outer\def\top{\parsearg\unnumberedyyy}
2258: \outer\def\unnumbered{\parsearg\unnumberedyyy}
2259: \def\unnumberedyyy #1{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
2260: \def\unnumberedzzz #1{\seccheck{unnumbered}%
2261: \secno=0 \subsecno=0 \subsubsecno=0
2262: %
2263: % This used to be simply \message{#1}, but TeX fully expands the
2264: % argument to \message. Therefore, if #1 contained @-commands, TeX
2265: % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
2266: % expanded @cite (which turns out to cause errors because \cite is meant
2267: % to be executed, not expanded).
2268: %
2269: % Anyway, we don't want the fully-expanded definition of @cite to appear
2270: % as a result of the \message, we just want `@cite' itself. We use
2271: % \the<toks register> to achieve this: TeX expands \the<toks> only once,
2272: % simply yielding the contents of the <toks register>.
2273: \toks0 = {#1}\message{(\the\toks0)}%
2274: %
2275: \unnumbchapmacro {#1}%
2276: \gdef\thischapter{#1}\gdef\thissection{#1}%
2277: {\chapternofonts%
2278: \edef\temp{{\realbackslash unnumbchapentry {#1}{\noexpand\folio}}}%
2279: \escapechar=`\\%
2280: \write \contentsfile \temp %
2281: \unnumbnoderef %
2282: \global\let\section = \unnumberedsec
2283: \global\let\subsection = \unnumberedsubsec
2284: \global\let\subsubsection = \unnumberedsubsubsec
2285: }}
2286:
2287: \outer\def\numberedsec{\parsearg\secyyy}
2288: \def\secyyy #1{\numhead1{#1}} % normally calls seczzz
2289: \def\seczzz #1{\seccheck{section}%
2290: \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2291: \gdef\thissection{#1}\secheading {#1}{\the\chapno}{\the\secno}%
2292: {\chapternofonts%
2293: \edef\temp{{\realbackslash secentry %
2294: {#1}{\the\chapno}{\the\secno}{\noexpand\folio}}}%
2295: \escapechar=`\\%
2296: \write \contentsfile \temp %
2297: \donoderef %
2298: \penalty 10000 %
2299: }}
2300:
2301: \outer\def\appenixsection{\parsearg\appendixsecyyy}
2302: \outer\def\appendixsec{\parsearg\appendixsecyyy}
2303: \def\appendixsecyyy #1{\apphead1{#1}} % normally calls appendixsectionzzz
2304: \def\appendixsectionzzz #1{\seccheck{appendixsection}%
2305: \subsecno=0 \subsubsecno=0 \global\advance \secno by 1 %
2306: \gdef\thissection{#1}\secheading {#1}{\appendixletter}{\the\secno}%
2307: {\chapternofonts%
2308: \edef\temp{{\realbackslash secentry %
2309: {#1}{\appendixletter}{\the\secno}{\noexpand\folio}}}%
2310: \escapechar=`\\%
2311: \write \contentsfile \temp %
2312: \appendixnoderef %
2313: \penalty 10000 %
2314: }}
2315:
2316: \outer\def\unnumberedsec{\parsearg\unnumberedsecyyy}
2317: \def\unnumberedsecyyy #1{\unnmhead1{#1}} % normally calls unnumberedseczzz
2318: \def\unnumberedseczzz #1{\seccheck{unnumberedsec}%
2319: \plainsecheading {#1}\gdef\thissection{#1}%
2320: {\chapternofonts%
2321: \edef\temp{{\realbackslash unnumbsecentry{#1}{\noexpand\folio}}}%
2322: \escapechar=`\\%
2323: \write \contentsfile \temp %
2324: \unnumbnoderef %
2325: \penalty 10000 %
2326: }}
2327:
2328: \outer\def\numberedsubsec{\parsearg\numberedsubsecyyy}
2329: \def\numberedsubsecyyy #1{\numhead2{#1}} % normally calls numberedsubseczzz
2330: \def\numberedsubseczzz #1{\seccheck{subsection}%
2331: \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2332: \subsecheading {#1}{\the\chapno}{\the\secno}{\the\subsecno}%
2333: {\chapternofonts%
2334: \edef\temp{{\realbackslash subsecentry %
2335: {#1}{\the\chapno}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2336: \escapechar=`\\%
2337: \write \contentsfile \temp %
2338: \donoderef %
2339: \penalty 10000 %
2340: }}
2341:
2342: \outer\def\appendixsubsec{\parsearg\appendixsubsecyyy}
2343: \def\appendixsubsecyyy #1{\apphead2{#1}} % normally calls appendixsubseczzz
2344: \def\appendixsubseczzz #1{\seccheck{appendixsubsec}%
2345: \gdef\thissection{#1}\subsubsecno=0 \global\advance \subsecno by 1 %
2346: \subsecheading {#1}{\appendixletter}{\the\secno}{\the\subsecno}%
2347: {\chapternofonts%
2348: \edef\temp{{\realbackslash subsecentry %
2349: {#1}{\appendixletter}{\the\secno}{\the\subsecno}{\noexpand\folio}}}%
2350: \escapechar=`\\%
2351: \write \contentsfile \temp %
2352: \appendixnoderef %
2353: \penalty 10000 %
2354: }}
2355:
2356: \outer\def\unnumberedsubsec{\parsearg\unnumberedsubsecyyy}
2357: \def\unnumberedsubsecyyy #1{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
2358: \def\unnumberedsubseczzz #1{\seccheck{unnumberedsubsec}%
2359: \plainsecheading {#1}\gdef\thissection{#1}%
2360: {\chapternofonts%
2361: \edef\temp{{\realbackslash unnumbsubsecentry{#1}{\noexpand\folio}}}%
2362: \escapechar=`\\%
2363: \write \contentsfile \temp %
2364: \unnumbnoderef %
2365: \penalty 10000 %
2366: }}
2367:
2368: \outer\def\numberedsubsubsec{\parsearg\numberedsubsubsecyyy}
2369: \def\numberedsubsubsecyyy #1{\numhead3{#1}} % normally numberedsubsubseczzz
2370: \def\numberedsubsubseczzz #1{\seccheck{subsubsection}%
2371: \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2372: \subsubsecheading {#1}
2373: {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2374: {\chapternofonts%
2375: \edef\temp{{\realbackslash subsubsecentry %
2376: {#1}
2377: {\the\chapno}{\the\secno}{\the\subsecno}{\the\subsubsecno}
2378: {\noexpand\folio}}}%
2379: \escapechar=`\\%
2380: \write \contentsfile \temp %
2381: \donoderef %
2382: \penalty 10000 %
2383: }}
2384:
2385: \outer\def\appendixsubsubsec{\parsearg\appendixsubsubsecyyy}
2386: \def\appendixsubsubsecyyy #1{\apphead3{#1}} % normally appendixsubsubseczzz
2387: \def\appendixsubsubseczzz #1{\seccheck{appendixsubsubsec}%
2388: \gdef\thissection{#1}\global\advance \subsubsecno by 1 %
2389: \subsubsecheading {#1}
2390: {\appendixletter}{\the\secno}{\the\subsecno}{\the\subsubsecno}%
2391: {\chapternofonts%
2392: \edef\temp{{\realbackslash subsubsecentry{#1}%
2393: {\appendixletter}
2394: {\the\secno}{\the\subsecno}{\the\subsubsecno}{\noexpand\folio}}}%
2395: \escapechar=`\\%
2396: \write \contentsfile \temp %
2397: \appendixnoderef %
2398: \penalty 10000 %
2399: }}
2400:
2401: \outer\def\unnumberedsubsubsec{\parsearg\unnumberedsubsubsecyyy}
2402: \def\unnumberedsubsubsecyyy #1{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
2403: \def\unnumberedsubsubseczzz #1{\seccheck{unnumberedsubsubsec}%
2404: \plainsecheading {#1}\gdef\thissection{#1}%
2405: {\chapternofonts%
2406: \edef\temp{{\realbackslash unnumbsubsubsecentry{#1}{\noexpand\folio}}}%
2407: \escapechar=`\\%
2408: \write \contentsfile \temp %
2409: \unnumbnoderef %
2410: \penalty 10000 %
2411: }}
2412:
2413: % These are variants which are not "outer", so they can appear in @ifinfo.
2414: % Actually, they should now be obsolete; ordinary section commands should work.
2415: \def\infotop{\parsearg\unnumberedzzz}
2416: \def\infounnumbered{\parsearg\unnumberedzzz}
2417: \def\infounnumberedsec{\parsearg\unnumberedseczzz}
2418: \def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz}
2419: \def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz}
2420:
2421: \def\infoappendix{\parsearg\appendixzzz}
2422: \def\infoappendixsec{\parsearg\appendixseczzz}
2423: \def\infoappendixsubsec{\parsearg\appendixsubseczzz}
2424: \def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz}
2425:
2426: \def\infochapter{\parsearg\chapterzzz}
2427: \def\infosection{\parsearg\sectionzzz}
2428: \def\infosubsection{\parsearg\subsectionzzz}
2429: \def\infosubsubsection{\parsearg\subsubsectionzzz}
2430:
2431: % These macros control what the section commands do, according
2432: % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
2433: % Define them by default for a numbered chapter.
2434: \global\let\section = \numberedsec
2435: \global\let\subsection = \numberedsubsec
2436: \global\let\subsubsection = \numberedsubsubsec
2437:
2438: % Define @majorheading, @heading and @subheading
2439:
2440: % NOTE on use of \vbox for chapter headings, section headings, and
2441: % such:
2442: % 1) We use \vbox rather than the earlier \line to permit
2443: % overlong headings to fold.
2444: % 2) \hyphenpenalty is set to 10000 because hyphenation in a
2445: % heading is obnoxious; this forbids it.
2446: % 3) Likewise, headings look best if no \parindent is used, and
2447: % if justification is not attempted. Hence \raggedright.
2448:
2449:
2450: \def\majorheading{\parsearg\majorheadingzzz}
2451: \def\majorheadingzzz #1{%
2452: {\advance\chapheadingskip by 10pt \chapbreak }%
2453: {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2454: \parindent=0pt\raggedright
2455: \rm #1\hfill}}\bigskip \par\penalty 200}
2456:
2457: \def\chapheading{\parsearg\chapheadingzzz}
2458: \def\chapheadingzzz #1{\chapbreak %
2459: {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2460: \parindent=0pt\raggedright
2461: \rm #1\hfill}}\bigskip \par\penalty 200}
2462:
2463: \def\heading{\parsearg\secheadingi}
2464:
2465: \def\subheading{\parsearg\subsecheadingi}
2466:
2467: \def\subsubheading{\parsearg\subsubsecheadingi}
2468:
2469: % These macros generate a chapter, section, etc. heading only
2470: % (including whitespace, linebreaking, etc. around it),
2471: % given all the information in convenient, parsed form.
2472:
2473: %%% Args are the skip and penalty (usually negative)
2474: \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
2475:
2476: \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
2477:
2478: %%% Define plain chapter starts, and page on/off switching for it
2479: % Parameter controlling skip before chapter headings (if needed)
2480:
2481: \newskip \chapheadingskip \chapheadingskip = 30pt plus 8pt minus 4pt
2482:
2483: \def\chapbreak{\dobreak \chapheadingskip {-4000}}
2484: \def\chappager{\par\vfill\supereject}
2485: \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
2486:
2487: \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
2488:
2489: \def\CHAPPAGoff{
2490: \global\let\pchapsepmacro=\chapbreak
2491: \global\let\pagealignmacro=\chappager}
2492:
2493: \def\CHAPPAGon{
2494: \global\let\pchapsepmacro=\chappager
2495: \global\let\pagealignmacro=\chappager
2496: \global\def\HEADINGSon{\HEADINGSsingle}}
2497:
2498: \def\CHAPPAGodd{
2499: \global\let\pchapsepmacro=\chapoddpage
2500: \global\let\pagealignmacro=\chapoddpage
2501: \global\def\HEADINGSon{\HEADINGSdouble}}
2502:
2503: \CHAPPAGon
2504:
2505: \def\CHAPFplain{
2506: \global\let\chapmacro=\chfplain
2507: \global\let\unnumbchapmacro=\unnchfplain}
2508:
2509: \def\chfplain #1#2{%
2510: \pchapsepmacro
2511: {%
2512: \chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2513: \parindent=0pt\raggedright
2514: \rm #2\enspace #1}%
2515: }%
2516: \bigskip
2517: \penalty5000
2518: }
2519:
2520: \def\unnchfplain #1{%
2521: \pchapsepmacro %
2522: {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2523: \parindent=0pt\raggedright
2524: \rm #1\hfill}}\bigskip \par\penalty 10000 %
2525: }
2526: \CHAPFplain % The default
2527:
2528: \def\unnchfopen #1{%
2529: \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2530: \parindent=0pt\raggedright
2531: \rm #1\hfill}}\bigskip \par\penalty 10000 %
2532: }
2533:
2534: \def\chfopen #1#2{\chapoddpage {\chapfonts
2535: \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
2536: \par\penalty 5000 %
2537: }
2538:
2539: \def\CHAPFopen{
2540: \global\let\chapmacro=\chfopen
2541: \global\let\unnumbchapmacro=\unnchfopen}
2542:
2543: % Parameter controlling skip before section headings.
2544:
2545: \newskip \subsecheadingskip \subsecheadingskip = 17pt plus 8pt minus 4pt
2546: \def\subsecheadingbreak{\dobreak \subsecheadingskip {-500}}
2547:
2548: \newskip \secheadingskip \secheadingskip = 21pt plus 8pt minus 4pt
2549: \def\secheadingbreak{\dobreak \secheadingskip {-1000}}
2550:
2551: % @paragraphindent is defined for the Info formatting commands only.
2552: \let\paragraphindent=\comment
2553:
2554: % Section fonts are the base font at magstep2, which produces
2555: % a size a bit more than 14 points in the default situation.
2556:
2557: \def\secheading #1#2#3{\secheadingi {#2.#3\enspace #1}}
2558: \def\plainsecheading #1{\secheadingi {#1}}
2559: \def\secheadingi #1{{\advance \secheadingskip by \parskip %
2560: \secheadingbreak}%
2561: {\secfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2562: \parindent=0pt\raggedright
2563: \rm #1\hfill}}%
2564: \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
2565:
2566:
2567: % Subsection fonts are the base font at magstep1,
2568: % which produces a size of 12 points.
2569:
2570: \def\subsecheading #1#2#3#4{\subsecheadingi {#2.#3.#4\enspace #1}}
2571: \def\subsecheadingi #1{{\advance \subsecheadingskip by \parskip %
2572: \subsecheadingbreak}%
2573: {\subsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2574: \parindent=0pt\raggedright
2575: \rm #1\hfill}}%
2576: \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000 }
2577:
2578: \def\subsubsecfonts{\subsecfonts} % Maybe this should change:
2579: % Perhaps make sssec fonts scaled
2580: % magstep half
2581: \def\subsubsecheading #1#2#3#4#5{\subsubsecheadingi {#2.#3.#4.#5\enspace #1}}
2582: \def\subsubsecheadingi #1{{\advance \subsecheadingskip by \parskip %
2583: \subsecheadingbreak}%
2584: {\subsubsecfonts \vbox{\hyphenpenalty=10000\tolerance=5000
2585: \parindent=0pt\raggedright
2586: \rm #1\hfill}}%
2587: \ifdim \parskip<10pt \kern 10pt\kern -\parskip\fi \penalty 10000}
2588:
2589:
2590: \message{toc printing,}
2591:
2592: % Finish up the main text and prepare to read what we've written
2593: % to \contentsfile.
2594:
2595: \newskip\contentsrightmargin \contentsrightmargin=1in
2596: \def\startcontents#1{%
2597: \pagealignmacro
2598: \immediate\closeout \contentsfile
2599: \ifnum \pageno>0
2600: \pageno = -1 % Request roman numbered pages.
2601: \fi
2602: % Don't need to put `Contents' or `Short Contents' in the headline.
2603: % It is abundantly clear what they are.
2604: \unnumbchapmacro{#1}\def\thischapter{}%
2605: \begingroup % Set up to handle contents files properly.
2606: \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11
2607: \raggedbottom % Worry more about breakpoints than the bottom.
2608: \advance\hsize by -\contentsrightmargin % Don't use the full line length.
2609: }
2610:
2611:
2612: % Normal (long) toc.
2613: \outer\def\contents{%
2614: \startcontents{Table of Contents}%
2615: \input \jobname.toc
2616: \endgroup
2617: \vfill \eject
2618: }
2619:
2620: % And just the chapters.
2621: \outer\def\summarycontents{%
2622: \startcontents{Short Contents}%
2623: %
2624: \let\chapentry = \shortchapentry
2625: \let\unnumbchapentry = \shortunnumberedentry
2626: % We want a true roman here for the page numbers.
2627: \secfonts
2628: \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl
2629: \rm
2630: \advance\baselineskip by 1pt % Open it up a little.
2631: \def\secentry ##1##2##3##4{}
2632: \def\unnumbsecentry ##1##2{}
2633: \def\subsecentry ##1##2##3##4##5{}
2634: \def\unnumbsubsecentry ##1##2{}
2635: \def\subsubsecentry ##1##2##3##4##5##6{}
2636: \def\unnumbsubsubsecentry ##1##2{}
2637: \input \jobname.toc
2638: \endgroup
2639: \vfill \eject
2640: }
2641: \let\shortcontents = \summarycontents
2642:
2643: % These macros generate individual entries in the table of contents.
2644: % The first argument is the chapter or section name.
2645: % The last argument is the page number.
2646: % The arguments in between are the chapter number, section number, ...
2647:
2648: % Chapter-level things, for both the long and short contents.
2649: \def\chapentry#1#2#3{\dochapentry{#2\labelspace#1}{#3}}
2650:
2651: % See comments in \dochapentry re vbox and related settings
2652: \def\shortchapentry#1#2#3{%
2653: \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno{#3}}%
2654: }
2655:
2656: % Typeset the label for a chapter or appendix for the short contents.
2657: % The arg is, e.g. `Appendix A' for an appendix, or `3' for a chapter.
2658: % We could simplify the code here by writing out an \appendixentry
2659: % command in the toc file for appendices, instead of using \chapentry
2660: % for both, but it doesn't seem worth it.
2661: \setbox0 = \hbox{\shortcontrm Appendix }
2662: \newdimen\shortappendixwidth \shortappendixwidth = \wd0
2663:
2664: \def\shortchaplabel#1{%
2665: % We typeset #1 in a box of constant width, regardless of the text of
2666: % #1, so the chapter titles will come out aligned.
2667: \setbox0 = \hbox{#1}%
2668: \dimen0 = \ifdim\wd0 > \shortappendixwidth \shortappendixwidth \else 0pt \fi
2669: %
2670: % This space should be plenty, since a single number is .5em, and the
2671: % widest letter (M) is 1em, at least in the Computer Modern fonts.
2672: % (This space doesn't include the extra space that gets added after
2673: % the label; that gets put in in \shortchapentry above.)
2674: \advance\dimen0 by 1.1em
2675: \hbox to \dimen0{#1\hfil}%
2676: }
2677:
2678: \def\unnumbchapentry#1#2{\dochapentry{#1}{#2}}
2679: \def\shortunnumberedentry#1#2{\tocentry{#1}{\doshortpageno{#2}}}
2680:
2681: % Sections.
2682: \def\secentry#1#2#3#4{\dosecentry{#2.#3\labelspace#1}{#4}}
2683: \def\unnumbsecentry#1#2{\dosecentry{#1}{#2}}
2684:
2685: % Subsections.
2686: \def\subsecentry#1#2#3#4#5{\dosubsecentry{#2.#3.#4\labelspace#1}{#5}}
2687: \def\unnumbsubsecentry#1#2{\dosubsecentry{#1}{#2}}
2688:
2689: % And subsubsections.
2690: \def\subsubsecentry#1#2#3#4#5#6{%
2691: \dosubsubsecentry{#2.#3.#4.#5\labelspace#1}{#6}}
2692: \def\unnumbsubsubsecentry#1#2{\dosubsubsecentry{#1}{#2}}
2693:
2694:
2695: % This parameter controls the indentation of the various levels.
2696: \newdimen\tocindent \tocindent = 3pc
2697:
2698: % Now for the actual typesetting. In all these, #1 is the text and #2 is the
2699: % page number.
2700: %
2701: % If the toc has to be broken over pages, we would want to be at chapters
2702: % if at all possible; hence the \penalty.
2703: \def\dochapentry#1#2{%
2704: \penalty-300 \vskip\baselineskip
2705: \begingroup
2706: \chapentryfonts
2707: \tocentry{#1}{\dopageno{#2}}%
2708: \endgroup
2709: \nobreak\vskip .25\baselineskip
2710: }
2711:
2712: \def\dosecentry#1#2{\begingroup
2713: \secentryfonts \leftskip=\tocindent
2714: \tocentry{#1}{\dopageno{#2}}%
2715: \endgroup}
2716:
2717: \def\dosubsecentry#1#2{\begingroup
2718: \subsecentryfonts \leftskip=2\tocindent
2719: \tocentry{#1}{\dopageno{#2}}%
2720: \endgroup}
2721:
2722: \def\dosubsubsecentry#1#2{\begingroup
2723: \subsubsecentryfonts \leftskip=3\tocindent
2724: \tocentry{#1}{\dopageno{#2}}%
2725: \endgroup}
2726:
2727: % Final typesetting of a toc entry; we use the same \entry macro as for
2728: % the index entries, but we want to suppress hyphenation here. (We
2729: % can't do that in the \entry macro, since index entries might consist
2730: % of hyphenated-identifiers-that-do-not-fit-on-a-line-and-nothing-else.)
2731: %
2732: \def\tocentry#1#2{\begingroup
2733: \hyphenpenalty = 10000
2734: \entry{#1}{#2}%
2735: \endgroup}
2736:
2737: % Space between chapter (or whatever) number and the title.
2738: \def\labelspace{\hskip1em \relax}
2739:
2740: \def\dopageno#1{{\rm #1}}
2741: \def\doshortpageno#1{{\rm #1}}
2742:
2743: \def\chapentryfonts{\secfonts \rm}
2744: \def\secentryfonts{\textfonts}
2745: \let\subsecentryfonts = \textfonts
2746: \let\subsubsecentryfonts = \textfonts
2747:
2748:
2749: \message{environments,}
2750:
2751: % Since these characters are used in examples, it should be an even number of
2752: % \tt widths. Each \tt character is 1en, so two makes it 1em.
2753: % Furthermore, these definitions must come after we define our fonts.
2754: \newbox\dblarrowbox \newbox\longdblarrowbox
2755: \newbox\pushcharbox \newbox\bullbox
2756: \newbox\equivbox \newbox\errorbox
2757:
2758: \let\ptexequiv = \equiv
2759:
2760: %{\tentt
2761: %\global\setbox\dblarrowbox = \hbox to 1em{\hfil$\Rightarrow$\hfil}
2762: %\global\setbox\longdblarrowbox = \hbox to 1em{\hfil$\mapsto$\hfil}
2763: %\global\setbox\pushcharbox = \hbox to 1em{\hfil$\dashv$\hfil}
2764: %\global\setbox\equivbox = \hbox to 1em{\hfil$\ptexequiv$\hfil}
2765: % Adapted from the manmac format (p.420 of TeXbook)
2766: %\global\setbox\bullbox = \hbox to 1em{\kern.15em\vrule height .75ex width .85ex
2767: % depth .1ex\hfil}
2768: %}
2769:
2770: \def\point{$\star$}
2771:
2772: \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2773: \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
2774: \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2775:
2776: \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2777:
2778: % Adapted from the TeXbook's \boxit.
2779: {\tentt \global\dimen0 = 3em}% Width of the box.
2780: \dimen2 = .55pt % Thickness of rules
2781: % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2782: \setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt}
2783:
2784: \global\setbox\errorbox=\hbox to \dimen0{\hfil
2785: \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2786: \advance\hsize by -2\dimen2 % Rules.
2787: \vbox{
2788: \hrule height\dimen2
2789: \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2790: \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2791: \kern3pt\vrule width\dimen2}% Space to right.
2792: \hrule height\dimen2}
2793: \hfil}
2794:
2795: % The @error{} command.
2796: \def\error{\leavevmode\lower.7ex\copy\errorbox}
2797:
2798: % @tex ... @end tex escapes into raw Tex temporarily.
2799: % One exception: @ is still an escape character, so that @end tex works.
2800: % But \@ or @@ will get a plain tex @ character.
2801:
2802: \def\tex{\begingroup
2803: \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
2804: \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
2805: \catcode `\^=7 \catcode `\_=8 \catcode `\~=13 \let~=\tie
2806: \catcode `\%=14
2807: \catcode 43=12
2808: \catcode`\"=12
2809: \catcode`\==12
2810: \catcode`\|=12
2811: \catcode`\<=12
2812: \catcode`\>=12
2813: \escapechar=`\\
2814: %
2815: \let\{=\ptexlbrace
2816: \let\}=\ptexrbrace
2817: \let\.=\ptexdot
2818: \let\*=\ptexstar
2819: \let\dots=\ptexdots
2820: \def\@{@}%
2821: \let\bullet=\ptexbullet
2822: \let\b=\ptexb \let\c=\ptexc \let\i=\ptexi \let\t=\ptext \let\l=\ptexl
2823: \let\L=\ptexL
2824: %
2825: \let\Etex=\endgroup}
2826:
2827: % Define @lisp ... @endlisp.
2828: % @lisp does a \begingroup so it can rebind things,
2829: % including the definition of @endlisp (which normally is erroneous).
2830:
2831: % Amount to narrow the margins by for @lisp.
2832: \newskip\lispnarrowing \lispnarrowing=0.4in
2833:
2834: % This is the definition that ^^M gets inside @lisp, @example, and other
2835: % such environments. \null is better than a space, since it doesn't
2836: % have any width.
2837: \def\lisppar{\null\endgraf}
2838:
2839: % Make each space character in the input produce a normal interword
2840: % space in the output. Don't allow a line break at this space, as this
2841: % is used only in environments like @example, where each line of input
2842: % should produce a line of output anyway.
2843: %
2844: {\obeyspaces %
2845: \gdef\sepspaces{\obeyspaces\let =\tie}}
2846:
2847: % Define \obeyedspace to be our active space, whatever it is. This is
2848: % for use in \parsearg.
2849: {\sepspaces%
2850: \global\let\obeyedspace= }
2851:
2852: % This space is always present above and below environments.
2853: \newskip\envskipamount \envskipamount = 0pt
2854:
2855: % Make spacing and below environment symmetrical. We use \parskip here
2856: % to help in doing that, since in @example-like environments \parskip
2857: % is reset to zero; thus the \afterenvbreak inserts no space -- but the
2858: % start of the next paragraph will insert \parskip
2859: %
2860: \def\aboveenvbreak{{\advance\envskipamount by \parskip
2861: \endgraf \ifdim\lastskip<\envskipamount
2862: \removelastskip \penalty-50 \vskip\envskipamount \fi}}
2863:
2864: \let\afterenvbreak = \aboveenvbreak
2865:
2866: % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
2867: \let\nonarrowing=\relax
2868:
2869: %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2870: % \cartouche: draw rectangle w/rounded corners around argument
2871: \font\circle=lcircle10
2872: \newdimen\circthick
2873: \newdimen\cartouter\newdimen\cartinner
2874: \newskip\normbskip\newskip\normpskip\newskip\normlskip
2875: \circthick=\fontdimen8\circle
2876: %
2877: \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
2878: \def\ctr{{\hskip 6pt\circle\char'010}}
2879: \def\cbl{{\circle\char'012\hskip -6pt}}
2880: \def\cbr{{\hskip 6pt\circle\char'011}}
2881: \def\carttop{\hbox to \cartouter{\hskip\lskip
2882: \ctl\leaders\hrule height\circthick\hfil\ctr
2883: \hskip\rskip}}
2884: \def\cartbot{\hbox to \cartouter{\hskip\lskip
2885: \cbl\leaders\hrule height\circthick\hfil\cbr
2886: \hskip\rskip}}
2887: %
2888: \newskip\lskip\newskip\rskip
2889:
2890: \long\def\cartouche{%
2891: \begingroup
2892: \lskip=\leftskip \rskip=\rightskip
2893: \leftskip=0pt\rightskip=0pt %we want these *outside*.
2894: \cartinner=\hsize \advance\cartinner by-\lskip
2895: \advance\cartinner by-\rskip
2896: \cartouter=\hsize
2897: \advance\cartouter by 18pt % allow for 3pt kerns on either
2898: % side, and for 6pt waste from
2899: % each corner char
2900: \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
2901: % Flag to tell @lisp, etc., not to narrow margin.
2902: \let\nonarrowing=\comment
2903: \vbox\bgroup
2904: \baselineskip=0pt\parskip=0pt\lineskip=0pt
2905: \carttop
2906: \hbox\bgroup
2907: \hskip\lskip
2908: \vrule\kern3pt
2909: \vbox\bgroup
2910: \hsize=\cartinner
2911: \kern3pt
2912: \begingroup
2913: \baselineskip=\normbskip
2914: \lineskip=\normlskip
2915: \parskip=\normpskip
2916: \vskip -\parskip
2917: \def\Ecartouche{%
2918: \endgroup
2919: \kern3pt
2920: \egroup
2921: \kern3pt\vrule
2922: \hskip\rskip
2923: \egroup
2924: \cartbot
2925: \egroup
2926: \endgroup
2927: }}
2928:
2929:
2930: % This macro is called at the beginning of all the @example variants,
2931: % inside a group.
2932: \def\nonfillstart{%
2933: \aboveenvbreak
2934: \inENV % This group ends at the end of the body
2935: \hfuzz = 12pt % Don't be fussy
2936: \sepspaces % Make spaces be word-separators rather than space tokens.
2937: \singlespace
2938: \let\par = \lisppar % don't ignore blank lines
2939: \obeylines % each line of input is a line of output
2940: \parskip = 0pt
2941: \parindent = 0pt
2942: \emergencystretch = 0pt % don't try to avoid overfull boxes
2943: % @cartouche defines \nonarrowing to inhibit narrowing
2944: % at next level down.
2945: \ifx\nonarrowing\relax
2946: \advance \leftskip by \lispnarrowing
2947: \exdentamount=\lispnarrowing
2948: \let\exdent=\nofillexdent
2949: \let\nonarrowing=\relax
2950: \fi
2951: }
2952:
2953: % To ending an @example-like environment, we first end the paragraph
2954: % (via \afterenvbreak's vertical glue), and then the group. That way we
2955: % keep the zero \parskip that the environments set -- \parskip glue
2956: % will be inserted at the beginning of the next paragraph in the
2957: % document, after the environment.
2958: %
2959: \def\nonfillfinish{\afterenvbreak\endgroup}%
2960:
2961: % This macro is
2962: \def\lisp{\begingroup
2963: \nonfillstart
2964: \let\Elisp = \nonfillfinish
2965: \tt
2966: \rawbackslash % have \ input char produce \ char from current font
2967: \gobble
2968: }
2969:
2970: % Define the \E... control sequence only if we are inside the
2971: % environment, so the error checking in \end will work.
2972: %
2973: % We must call \lisp last in the definition, since it reads the
2974: % return following the @example (or whatever) command.
2975: %
2976: \def\example{\begingroup \def\Eexample{\nonfillfinish\endgroup}\lisp}
2977: \def\smallexample{\begingroup \def\Esmallexample{\nonfillfinish\endgroup}\lisp}
2978: \def\smalllisp{\begingroup \def\Esmalllisp{\nonfillfinish\endgroup}\lisp}
2979:
2980: % @smallexample and @smalllisp. This is not used unless the @smallbook
2981: % command is given. Originally contributed by Pavel@xerox.
2982: %
2983: \def\smalllispx{\begingroup
2984: \nonfillstart
2985: \let\Esmalllisp = \nonfillfinish
2986: \let\Esmallexample = \nonfillfinish
2987: %
2988: % Smaller interline space and fonts for small examples.
2989: \baselineskip 10pt
2990: \indexfonts \tt
2991: \rawbackslash % output the \ character from the current font
2992: \gobble
2993: }
2994:
2995: % This is @display; same as @lisp except use roman font.
2996: %
2997: \def\display{\begingroup
2998: \nonfillstart
2999: \let\Edisplay = \nonfillfinish
3000: \gobble
3001: }
3002:
3003: % This is @format; same as @display except don't narrow margins.
3004: %
3005: \def\format{\begingroup
3006: \let\nonarrowing = t
3007: \nonfillstart
3008: \let\Eformat = \nonfillfinish
3009: \gobble
3010: }
3011:
3012: % @flushleft (same as @format) and @flushright.
3013: %
3014: \def\flushleft{\begingroup
3015: \let\nonarrowing = t
3016: \nonfillstart
3017: \let\Eflushleft = \nonfillfinish
3018: \gobble
3019: }
3020: \def\flushright{\begingroup
3021: \let\nonarrowing = t
3022: \nonfillstart
3023: \let\Eflushright = \nonfillfinish
3024: \advance\leftskip by 0pt plus 1fill
3025: \gobble}
3026:
3027: % @quotation does normal linebreaking and narrows the margins.
3028: %
3029: \def\quotation{%
3030: \begingroup\inENV %This group ends at the end of the @quotation body
3031: {\parskip=0pt % because we will skip by \parskip too, later
3032: \aboveenvbreak}%
3033: \singlespace
3034: \parindent=0pt
3035: \let\Equotation = \nonfillfinish
3036: % @cartouche defines \nonarrowing to inhibit narrowing
3037: % at next level down.
3038: \ifx\nonarrowing\relax
3039: \advance \leftskip by \lispnarrowing
3040: \advance \rightskip by \lispnarrowing
3041: \exdentamount=\lispnarrowing
3042: \let\nonarrowing=\relax
3043: \fi}
3044:
3045: \message{defuns,}
3046: % Define formatter for defuns
3047: % First, allow user to change definition object font (\df) internally
3048: \def\setdeffont #1 {\csname DEF#1\endcsname}
3049:
3050: \newskip\defbodyindent \defbodyindent=.4in
3051: \newskip\defargsindent \defargsindent=50pt
3052: \newskip\deftypemargin \deftypemargin=12pt
3053: \newskip\deflastargmargin \deflastargmargin=18pt
3054:
3055: \newcount\parencount
3056: % define \functionparens, which makes ( and ) and & do special things.
3057: % \functionparens affects the group it is contained in.
3058: \def\activeparens{%
3059: \catcode`\(=\active \catcode`\)=\active \catcode`\&=\active
3060: \catcode`\[=\active \catcode`\]=\active}
3061:
3062: % Make control sequences which act like normal parenthesis chars.
3063: \let\lparen = ( \let\rparen = )
3064:
3065: {\activeparens % Now, smart parens don't turn on until &foo (see \amprm)
3066:
3067: % Be sure that we always have a definition for `(', etc. For example,
3068: % if the fn name has parens in it, \boldbrax will not be in effect yet,
3069: % so TeX would otherwise complain about undefined control sequence.
3070: \global\let(=\lparen \global\let)=\rparen
3071: \global\let[=\lbrack \global\let]=\rbrack
3072:
3073: \gdef\functionparens{\boldbrax\let&=\amprm\parencount=0 }
3074: \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
3075:
3076: % Definitions of (, ) and & used in args for functions.
3077: % This is the definition of ( outside of all parentheses.
3078: \gdef\oprm#1 {{\rm\char`\(}#1 \bf \let(=\opnested %
3079: \global\advance\parencount by 1 }
3080: %
3081: % This is the definition of ( when already inside a level of parens.
3082: \gdef\opnested{\char`\(\global\advance\parencount by 1 }
3083: %
3084: \gdef\clrm{% Print a paren in roman if it is taking us back to depth of 0.
3085: % also in that case restore the outer-level definition of (.
3086: \ifnum \parencount=1 {\rm \char `\)}\sl \let(=\oprm \else \char `\) \fi
3087: \global\advance \parencount by -1 }
3088: % If we encounter &foo, then turn on ()-hacking afterwards
3089: \gdef\amprm#1 {{\rm\}\let(=\oprm \let)=\clrm\ }
3090: %
3091: \gdef\normalparens{\boldbrax\let&=\ampnr}
3092: } % End of definition inside \activeparens
3093: %% These parens (in \boldbrax) actually are a little bolder than the
3094: %% contained text. This is especially needed for [ and ]
3095: \def\opnr{{\sf\char`\(}} \def\clnr{{\sf\char`\)}} \def\ampnr{\&}
3096: \def\lbrb{{\bf\char`\[}} \def\rbrb{{\bf\char`\]}}
3097:
3098: % First, defname, which formats the header line itself.
3099: % #1 should be the function name.
3100: % #2 should be the type of definition, such as "Function".
3101:
3102: \def\defname #1#2{%
3103: % Get the values of \leftskip and \rightskip as they were
3104: % outside the @def...
3105: \dimen2=\leftskip
3106: \advance\dimen2 by -\defbodyindent
3107: \dimen3=\rightskip
3108: \advance\dimen3 by -\defbodyindent
3109: \noindent %
3110: \setbox0=\hbox{\hskip \deflastargmargin{\rm #2}\hskip \deftypemargin}%
3111: \dimen0=\hsize \advance \dimen0 by -\wd0 % compute size for first line
3112: \dimen1=\hsize \advance \dimen1 by -\defargsindent %size for continuations
3113: \parshape 2 0in \dimen0 \defargsindent \dimen1 %
3114: % Now output arg 2 ("Function" or some such)
3115: % ending at \deftypemargin from the right margin,
3116: % but stuck inside a box of width 0 so it does not interfere with linebreaking
3117: {% Adjust \hsize to exclude the ambient margins,
3118: % so that \rightline will obey them.
3119: \advance \hsize by -\dimen2 \advance \hsize by -\dimen3
3120: \rlap{\rightline{{\rm #2}\hskip \deftypemargin}}}%
3121: % Make all lines underfull and no complaints:
3122: \tolerance=10000 \hbadness=10000
3123: \advance\leftskip by -\defbodyindent
3124: \exdentamount=\defbodyindent
3125: {\df #1}\enskip % Generate function name
3126: }
3127:
3128: % Actually process the body of a definition
3129: % #1 should be the terminating control sequence, such as \Edefun.
3130: % #2 should be the "another name" control sequence, such as \defunx.
3131: % #3 should be the control sequence that actually processes the header,
3132: % such as \defunheader.
3133:
3134: \def\defparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3135: \medbreak %
3136: % Define the end token that this defining construct specifies
3137: % so that it will exit this group.
3138: \def#1{\endgraf\endgroup\medbreak}%
3139: \def#2{\begingroup\obeylines\activeparens\spacesplit#3}%
3140: \parindent=0in
3141: \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3142: \exdentamount=\defbodyindent
3143: \begingroup %
3144: \catcode 61=\active % 61 is `='
3145: \obeylines\activeparens\spacesplit#3}
3146:
3147: \def\defmethparsebody #1#2#3#4 {\begingroup\inENV %
3148: \medbreak %
3149: % Define the end token that this defining construct specifies
3150: % so that it will exit this group.
3151: \def#1{\endgraf\endgroup\medbreak}%
3152: \def#2##1 {\begingroup\obeylines\activeparens\spacesplit{#3{##1}}}%
3153: \parindent=0in
3154: \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3155: \exdentamount=\defbodyindent
3156: \begingroup\obeylines\activeparens\spacesplit{#3{#4}}}
3157:
3158: \def\defopparsebody #1#2#3#4#5 {\begingroup\inENV %
3159: \medbreak %
3160: % Define the end token that this defining construct specifies
3161: % so that it will exit this group.
3162: \def#1{\endgraf\endgroup\medbreak}%
3163: \def#2##1 ##2 {\def#4{##1}%
3164: \begingroup\obeylines\activeparens\spacesplit{#3{##2}}}%
3165: \parindent=0in
3166: \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3167: \exdentamount=\defbodyindent
3168: \begingroup\obeylines\activeparens\spacesplit{#3{#5}}}
3169:
3170: % These parsing functions are similar to the preceding ones
3171: % except that they do not make parens into active characters.
3172: % These are used for "variables" since they have no arguments.
3173:
3174: \def\defvarparsebody #1#2#3{\begingroup\inENV% Environment for definitionbody
3175: \medbreak %
3176: % Define the end token that this defining construct specifies
3177: % so that it will exit this group.
3178: \def#1{\endgraf\endgroup\medbreak}%
3179: \def#2{\begingroup\obeylines\spacesplit#3}%
3180: \parindent=0in
3181: \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3182: \exdentamount=\defbodyindent
3183: \begingroup %
3184: \catcode 61=\active %
3185: \obeylines\spacesplit#3}
3186:
3187: % This is used for \def{tp,vr}parsebody. It could probably be used for
3188: % some of the others, too, with some judicious conditionals.
3189: %
3190: \def\parsebodycommon#1#2#3{%
3191: \begingroup\inENV %
3192: \medbreak %
3193: % Define the end token that this defining construct specifies
3194: % so that it will exit this group.
3195: \def#1{\endgraf\endgroup\medbreak}%
3196: \def#2##1 {\begingroup\obeylines\spacesplit{#3{##1}}}%
3197: \parindent=0in
3198: \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3199: \exdentamount=\defbodyindent
3200: \begingroup\obeylines
3201: }
3202:
3203: \def\defvrparsebody#1#2#3#4 {%
3204: \parsebodycommon{#1}{#2}{#3}%
3205: \spacesplit{#3{#4}}%
3206: }
3207:
3208: % This loses on `@deftp {Data Type} {struct termios}' -- it thinks the
3209: % type is just `struct', because we lose the braces in `{struct
3210: % termios}' when \spacesplit reads its undelimited argument. Sigh.
3211: % \let\deftpparsebody=\defvrparsebody
3212: %
3213: % So, to get around this, we put \empty in with the type name. That
3214: % way, TeX won't find exactly `{...}' as an undelimited argument, and
3215: % won't strip off the braces.
3216: %
3217: \def\deftpparsebody #1#2#3#4 {%
3218: \parsebodycommon{#1}{#2}{#3}%
3219: \spacesplit{\parsetpheaderline{#3{#4}}}\empty
3220: }
3221:
3222: % Fine, but then we have to eventually remove the \empty *and* the
3223: % braces (if any). That's what this does, putting the result in \tptemp.
3224: %
3225: \def\removeemptybraces\empty#1\relax{\def\tptemp{#1}}%
3226:
3227: % After \spacesplit has done its work, this is called -- #1 is the final
3228: % thing to call, #2 the type name (which starts with \empty), and #3
3229: % (which might be empty) the arguments.
3230: %
3231: \def\parsetpheaderline#1#2#3{%
3232: \removeemptybraces#2\relax
3233: #1{\tptemp}{#3}%
3234: }%
3235:
3236: \def\defopvarparsebody #1#2#3#4#5 {\begingroup\inENV %
3237: \medbreak %
3238: % Define the end token that this defining construct specifies
3239: % so that it will exit this group.
3240: \def#1{\endgraf\endgroup\medbreak}%
3241: \def#2##1 ##2 {\def#4{##1}%
3242: \begingroup\obeylines\spacesplit{#3{##2}}}%
3243: \parindent=0in
3244: \advance\leftskip by \defbodyindent \advance \rightskip by \defbodyindent
3245: \exdentamount=\defbodyindent
3246: \begingroup\obeylines\spacesplit{#3{#5}}}
3247:
3248: % Split up #2 at the first space token.
3249: % call #1 with two arguments:
3250: % the first is all of #2 before the space token,
3251: % the second is all of #2 after that space token.
3252: % If #2 contains no space token, all of it is passed as the first arg
3253: % and the second is passed as empty.
3254:
3255: {\obeylines
3256: \gdef\spacesplit#1#2^^M{\endgroup\spacesplitfoo{#1}#2 \relax\spacesplitfoo}%
3257: \long\gdef\spacesplitfoo#1#2 #3#4\spacesplitfoo{%
3258: \ifx\relax #3%
3259: #1{#2}{}\else #1{#2}{#3#4}\fi}}
3260:
3261: % So much for the things common to all kinds of definitions.
3262:
3263: % Define @defun.
3264:
3265: % First, define the processing that is wanted for arguments of \defun
3266: % Use this to expand the args and terminate the paragraph they make up
3267:
3268: \def\defunargs #1{\functionparens \sl
3269: % Expand, preventing hyphenation at `-' chars.
3270: % Note that groups don't affect changes in \hyphenchar.
3271: \hyphenchar\tensl=0
3272: #1%
3273: \hyphenchar\tensl=45
3274: \ifnum\parencount=0 \else \errmessage{unbalanced parens in @def arguments}\fi%
3275: \interlinepenalty=10000
3276: \advance\rightskip by 0pt plus 1fil
3277: \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3278: }
3279:
3280: \def\deftypefunargs #1{%
3281: % Expand, preventing hyphenation at `-' chars.
3282: % Note that groups don't affect changes in \hyphenchar.
3283: \functionparens
3284: \tclose{#1}% avoid \code because of side effects on active chars
3285: \interlinepenalty=10000
3286: \advance\rightskip by 0pt plus 1fil
3287: \endgraf\penalty 10000\vskip -\parskip\penalty 10000%
3288: }
3289:
3290: % Do complete processing of one @defun or @defunx line already parsed.
3291:
3292: % @deffn Command forward-char nchars
3293:
3294: \def\deffn{\defmethparsebody\Edeffn\deffnx\deffnheader}
3295:
3296: \def\deffnheader #1#2#3{\doind {fn}{\code{#2}}%
3297: \begingroup\defname {#2}{#1}\defunargs{#3}\endgroup %
3298: \catcode 61=\other % Turn off change made in \defparsebody
3299: }
3300:
3301: % @defun == @deffn Function
3302:
3303: \def\defun{\defparsebody\Edefun\defunx\defunheader}
3304:
3305: \def\defunheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3306: \begingroup\defname {#1}{Function}%
3307: \defunargs {#2}\endgroup %
3308: \catcode 61=\other % Turn off change made in \defparsebody
3309: }
3310:
3311: % @deftypefun int foobar (int @var{foo}, float @var{bar})
3312:
3313: \def\deftypefun{\defparsebody\Edeftypefun\deftypefunx\deftypefunheader}
3314:
3315: % #1 is the data type. #2 is the name and args.
3316: \def\deftypefunheader #1#2{\deftypefunheaderx{#1}#2 \relax}
3317: % #1 is the data type, #2 the name, #3 the args.
3318: \def\deftypefunheaderx #1#2 #3\relax{%
3319: \doind {fn}{\code{#2}}% Make entry in function index
3320: \begingroup\defname {\code{#1} #2}{Function}%
3321: \deftypefunargs {#3}\endgroup %
3322: \catcode 61=\other % Turn off change made in \defparsebody
3323: }
3324:
3325: % @deftypefn {Library Function} int foobar (int @var{foo}, float @var{bar})
3326:
3327: \def\deftypefn{\defmethparsebody\Edeftypefn\deftypefnx\deftypefnheader}
3328:
3329: % #1 is the classification. #2 is the data type. #3 is the name and args.
3330: \def\deftypefnheader #1#2#3{\deftypefnheaderx{#1}{#2}#3 \relax}
3331: % #1 is the classification, #2 the data type, #3 the name, #4 the args.
3332: \def\deftypefnheaderx #1#2#3 #4\relax{%
3333: \doind {fn}{\code{#3}}% Make entry in function index
3334: \begingroup
3335: \normalparens % notably, turn off `&' magic, which prevents
3336: % at least some C++ text from working
3337: \defname {\code{#2} #3}{#1}%
3338: \deftypefunargs {#4}\endgroup %
3339: \catcode 61=\other % Turn off change made in \defparsebody
3340: }
3341:
3342: % @defmac == @deffn Macro
3343:
3344: \def\defmac{\defparsebody\Edefmac\defmacx\defmacheader}
3345:
3346: \def\defmacheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3347: \begingroup\defname {#1}{Macro}%
3348: \defunargs {#2}\endgroup %
3349: \catcode 61=\other % Turn off change made in \defparsebody
3350: }
3351:
3352: % @defspec == @deffn Special Form
3353:
3354: \def\defspec{\defparsebody\Edefspec\defspecx\defspecheader}
3355:
3356: \def\defspecheader #1#2{\doind {fn}{\code{#1}}% Make entry in function index
3357: \begingroup\defname {#1}{Special Form}%
3358: \defunargs {#2}\endgroup %
3359: \catcode 61=\other % Turn off change made in \defparsebody
3360: }
3361:
3362: % This definition is run if you use @defunx
3363: % anywhere other than immediately after a @defun or @defunx.
3364:
3365: \def\deffnx #1 {\errmessage{@deffnx in invalid context}}
3366: \def\defunx #1 {\errmessage{@defunx in invalid context}}
3367: \def\defmacx #1 {\errmessage{@defmacx in invalid context}}
3368: \def\defspecx #1 {\errmessage{@defspecx in invalid context}}
3369: \def\deftypefnx #1 {\errmessage{@deftypefnx in invalid context}}
3370: \def\deftypeunx #1 {\errmessage{@deftypeunx in invalid context}}
3371:
3372: % @defmethod, and so on
3373:
3374: % @defop {Funny Method} foo-class frobnicate argument
3375:
3376: \def\defop #1 {\def\defoptype{#1}%
3377: \defopparsebody\Edefop\defopx\defopheader\defoptype}
3378:
3379: \def\defopheader #1#2#3{%
3380: \dosubind {fn}{\code{#2}}{on #1}% Make entry in function index
3381: \begingroup\defname {#2}{\defoptype{} on #1}%
3382: \defunargs {#3}\endgroup %
3383: }
3384:
3385: % @defmethod == @defop Method
3386:
3387: \def\defmethod{\defmethparsebody\Edefmethod\defmethodx\defmethodheader}
3388:
3389: \def\defmethodheader #1#2#3{%
3390: \dosubind {fn}{\code{#2}}{on #1}% entry in function index
3391: \begingroup\defname {#2}{Method on #1}%
3392: \defunargs {#3}\endgroup %
3393: }
3394:
3395: % @defcv {Class Option} foo-class foo-flag
3396:
3397: \def\defcv #1 {\def\defcvtype{#1}%
3398: \defopvarparsebody\Edefcv\defcvx\defcvarheader\defcvtype}
3399:
3400: \def\defcvarheader #1#2#3{%
3401: \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3402: \begingroup\defname {#2}{\defcvtype{} of #1}%
3403: \defvarargs {#3}\endgroup %
3404: }
3405:
3406: % @defivar == @defcv {Instance Variable}
3407:
3408: \def\defivar{\defvrparsebody\Edefivar\defivarx\defivarheader}
3409:
3410: \def\defivarheader #1#2#3{%
3411: \dosubind {vr}{\code{#2}}{of #1}% Make entry in var index
3412: \begingroup\defname {#2}{Instance Variable of #1}%
3413: \defvarargs {#3}\endgroup %
3414: }
3415:
3416: % These definitions are run if you use @defmethodx, etc.,
3417: % anywhere other than immediately after a @defmethod, etc.
3418:
3419: \def\defopx #1 {\errmessage{@defopx in invalid context}}
3420: \def\defmethodx #1 {\errmessage{@defmethodx in invalid context}}
3421: \def\defcvx #1 {\errmessage{@defcvx in invalid context}}
3422: \def\defivarx #1 {\errmessage{@defivarx in invalid context}}
3423:
3424: % Now @defvar
3425:
3426: % First, define the processing that is wanted for arguments of @defvar.
3427: % This is actually simple: just print them in roman.
3428: % This must expand the args and terminate the paragraph they make up
3429: \def\defvarargs #1{\normalparens #1%
3430: \interlinepenalty=10000
3431: \endgraf\penalty 10000\vskip -\parskip\penalty 10000}
3432:
3433: % @defvr Counter foo-count
3434:
3435: \def\defvr{\defvrparsebody\Edefvr\defvrx\defvrheader}
3436:
3437: \def\defvrheader #1#2#3{\doind {vr}{\code{#2}}%
3438: \begingroup\defname {#2}{#1}\defvarargs{#3}\endgroup}
3439:
3440: % @defvar == @defvr Variable
3441:
3442: \def\defvar{\defvarparsebody\Edefvar\defvarx\defvarheader}
3443:
3444: \def\defvarheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3445: \begingroup\defname {#1}{Variable}%
3446: \defvarargs {#2}\endgroup %
3447: }
3448:
3449: % @defopt == @defvr {User Option}
3450:
3451: \def\defopt{\defvarparsebody\Edefopt\defoptx\defoptheader}
3452:
3453: \def\defoptheader #1#2{\doind {vr}{\code{#1}}% Make entry in var index
3454: \begingroup\defname {#1}{User Option}%
3455: \defvarargs {#2}\endgroup %
3456: }
3457:
3458: % @deftypevar int foobar
3459:
3460: \def\deftypevar{\defvarparsebody\Edeftypevar\deftypevarx\deftypevarheader}
3461:
3462: % #1 is the data type. #2 is the name.
3463: \def\deftypevarheader #1#2{%
3464: \doind {vr}{\code{#2}}% Make entry in variables index
3465: \begingroup\defname {\code{#1} #2}{Variable}%
3466: \interlinepenalty=10000
3467: \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3468: \endgroup}
3469:
3470: % @deftypevr {Global Flag} int enable
3471:
3472: \def\deftypevr{\defvrparsebody\Edeftypevr\deftypevrx\deftypevrheader}
3473:
3474: \def\deftypevrheader #1#2#3{\doind {vr}{\code{#3}}%
3475: \begingroup\defname {\code{#2} #3}{#1}
3476: \interlinepenalty=10000
3477: \endgraf\penalty 10000\vskip -\parskip\penalty 10000
3478: \endgroup}
3479:
3480: % This definition is run if you use @defvarx
3481: % anywhere other than immediately after a @defvar or @defvarx.
3482:
3483: \def\defvrx #1 {\errmessage{@defvrx in invalid context}}
3484: \def\defvarx #1 {\errmessage{@defvarx in invalid context}}
3485: \def\defoptx #1 {\errmessage{@defoptx in invalid context}}
3486: \def\deftypevarx #1 {\errmessage{@deftypevarx in invalid context}}
3487: \def\deftypevrx #1 {\errmessage{@deftypevrx in invalid context}}
3488:
3489: % Now define @deftp
3490: % Args are printed in bold, a slight difference from @defvar.
3491:
3492: \def\deftpargs #1{\bf \defvarargs{#1}}
3493:
3494: % @deftp Class window height width ...
3495:
3496: \def\deftp{\deftpparsebody\Edeftp\deftpx\deftpheader}
3497:
3498: \def\deftpheader #1#2#3{\doind {tp}{\code{#2}}%
3499: \begingroup\defname {#2}{#1}\deftpargs{#3}\endgroup}
3500:
3501: % This definition is run if you use @deftpx, etc
3502: % anywhere other than immediately after a @deftp, etc.
3503:
3504: \def\deftpx #1 {\errmessage{@deftpx in invalid context}}
3505:
3506: \message{cross reference,}
3507: % Define cross-reference macros
3508: \newwrite \auxfile
3509:
3510: \newif\ifhavexrefs % True if xref values are known.
3511: \newif\ifwarnedxrefs % True if we warned once that they aren't known.
3512:
3513: % \setref{foo} defines a cross-reference point named foo.
3514:
3515: \def\setref#1{%
3516: \dosetq{#1-title}{Ytitle}%
3517: \dosetq{#1-pg}{Ypagenumber}%
3518: \dosetq{#1-snt}{Ysectionnumberandtype}}
3519:
3520: \def\unnumbsetref#1{%
3521: \dosetq{#1-title}{Ytitle}%
3522: \dosetq{#1-pg}{Ypagenumber}%
3523: \dosetq{#1-snt}{Ynothing}}
3524:
3525: \def\appendixsetref#1{%
3526: \dosetq{#1-title}{Ytitle}%
3527: \dosetq{#1-pg}{Ypagenumber}%
3528: \dosetq{#1-snt}{Yappendixletterandtype}}
3529:
3530: % \xref, \pxref, and \ref generate cross-references to specified points.
3531: % For \xrefX, #1 is the node name, #2 the name of the Info
3532: % cross-reference, #3 the printed node name, #4 the name of the Info
3533: % file, #5 the name of the printed manual. All but the node name can be
3534: % omitted.
3535: %
3536: \def\pxref#1{see \xrefX[#1,,,,,,,]}
3537: \def\xref#1{See \xrefX[#1,,,,,,,]}
3538: \def\ref#1{\xrefX[#1,,,,,,,]}
3539: \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup%
3540: \def\printedmanual{\ignorespaces #5}%
3541: \def\printednodename{\ignorespaces #3}%
3542: %
3543: \setbox1=\hbox{\printedmanual}%
3544: \setbox0=\hbox{\printednodename}%
3545: \ifdim \wd0=0pt%
3546: % No printed node name was explicitly given.
3547: \ifx SETxref-automatic-section-title %
3548: % This line should make the actual chapter or section title appear inside
3549: % the square brackets. Use the real section title if we have it.
3550: \ifdim \wd1>0pt%
3551: % It is in another manual, so we don't have it.
3552: \def\printednodename{\ignorespaces #1} \else%
3553: % We know the real title if we have the xref values.
3554: \ifhavexrefs \def\printednodename{\refx{#1-title}}%
3555: % Otherwise just copy the Info node name.
3556: \else \def\printednodename{\ignorespaces #1} \fi%
3557: \fi\def\printednodename{#1-title}%
3558: \else% This line just uses the node name.
3559: \def\printednodename{\ignorespaces #1}%
3560: \fi% ends \ifx SETxref-automatic-section-title
3561: \fi% ends \ifdim \wd0
3562: %
3563: %
3564: % If we use \unhbox0 and \unhbox1 to print the node names, TeX does
3565: % not insert empty discretionaries after hyphens, which means that it
3566: % will not find a line break at a hyphen in a node names. Since some
3567: % manuals are best written with fairly long node names, containing
3568: % hyphens, this is a loss. Therefore, we simply give the text of
3569: % the node name again, so it is as if TeX is seeing it for the first
3570: % time.
3571: \ifdim \wd1>0pt
3572: section ``\printednodename'' in \cite{\printedmanual}%
3573: \else%
3574: \turnoffactive%
3575: \refx{#1-snt}{} [\printednodename], page\tie\refx{#1-pg}{}%
3576: \fi
3577: \endgroup}
3578:
3579: % \dosetq is the interface for calls from other macros
3580:
3581: % Use \turnoffactive so that punctuation chars such as underscore
3582: % work in node names.
3583: \def\dosetq #1#2{{\let\folio=0 \turnoffactive%
3584: \edef\next{\write\auxfile{\internalsetq {#1}{#2}}}%
3585: \next}}
3586:
3587: % \internalsetq {foo}{page} expands into
3588: % CHARACTERS 'xrdef {foo}{...expansion of \Ypage...}
3589: % When the aux file is read, ' is the escape character
3590:
3591: \def\internalsetq #1#2{'xrdef {#1}{\csname #2\endcsname}}
3592:
3593: % Things to be expanded by \internalsetq
3594:
3595: \def\Ypagenumber{\folio}
3596:
3597: \def\Ytitle{\thissection}
3598:
3599: \def\Ynothing{}
3600:
3601: \def\Ysectionnumberandtype{%
3602: \ifnum\secno=0 Chapter\xreftie\the\chapno %
3603: \else \ifnum \subsecno=0 Section\xreftie\the\chapno.\the\secno %
3604: \else \ifnum \subsubsecno=0 %
3605: Section\xreftie\the\chapno.\the\secno.\the\subsecno %
3606: \else %
3607: Section\xreftie\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno %
3608: \fi \fi \fi }
3609:
3610: \def\Yappendixletterandtype{%
3611: \ifnum\secno=0 Appendix\xreftie'char\the\appendixno{}%
3612: \else \ifnum \subsecno=0 Section\xreftie'char\the\appendixno.\the\secno %
3613: \else \ifnum \subsubsecno=0 %
3614: Section\xreftie'char\the\appendixno.\the\secno.\the\subsecno %
3615: \else %
3616: Section\xreftie'char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno %
3617: \fi \fi \fi }
3618:
3619: \gdef\xreftie{'tie}
3620:
3621: % Use TeX 3.0's \inputlineno to get the line number, for better error
3622: % messages, but if we're using an old version of TeX, don't do anything.
3623: %
3624: \ifx\inputlineno\thisisundefined
3625: \let\linenumber = \empty % Non-3.0.
3626: \else
3627: \def\linenumber{\the\inputlineno:\space}
3628: \fi
3629:
3630: % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
3631: % If its value is nonempty, SUFFIX is output afterward.
3632:
3633: \def\refx#1#2{%
3634: \expandafter\ifx\csname X#1\endcsname\relax
3635: % If not defined, say something at least.
3636: $\langle$un\-de\-fined$\rangle$%
3637: \ifhavexrefs
3638: \message{\linenumber Undefined cross reference `#1'.}%
3639: \else
3640: \ifwarnedxrefs\else
3641: \global\warnedxrefstrue
3642: \message{Cross reference values unknown; you must run TeX again.}%
3643: \fi
3644: \fi
3645: \else
3646: % It's defined, so just use it.
3647: \csname X#1\endcsname
3648: \fi
3649: #2% Output the suffix in any case.
3650: }
3651:
3652: % Read the last existing aux file, if any. No error if none exists.
3653:
3654: % This is the macro invoked by entries in the aux file.
3655: \def\xrdef #1#2{
3656: {\catcode`\'=\other\expandafter \gdef \csname X#1\endcsname {#2}}}
3657:
3658: \def\readauxfile{%
3659: \begingroup
3660: \catcode `\^^@=\other
3661: \catcode `\&=\other
3662: \catcode `\=\other
3663: \catcode `\^^C=\other
3664: \catcode `\^^D=\other
3665: \catcode `\^^E=\other
3666: \catcode `\^^F=\other
3667: \catcode `\^^G=\other
3668: \catcode `\^^H=\other
3669: \catcode `\ =\other
3670: \catcode `\^^L=\other
3671: \catcode `\=\other
3672: \catcode `\=\other
3673: \catcode `\=\other
3674: \catcode `\=\other
3675: \catcode `\=\other
3676: \catcode `\=\other
3677: \catcode `\=\other
3678: \catcode `\=\other
3679: \catcode `\=\other
3680: \catcode `\=\other
3681: \catcode `\=\other
3682: \catcode `\=\other
3683: \catcode 26=\other
3684: \catcode `\^^[=\other
3685: \catcode `\^^\=\other
3686: \catcode `\^^]=\other
3687: \catcode `\^^^=\other
3688: \catcode `\^^_=\other
3689: \catcode `\@=\other
3690: \catcode `\^=\other
3691: \catcode `\~=\other
3692: \catcode `\[=\other
3693: \catcode `\]=\other
3694: \catcode`\"=\other
3695: \catcode`\_=\other
3696: \catcode`\|=\other
3697: \catcode`\<=\other
3698: \catcode`\>=\other
3699: \catcode `\$=\other
3700: \catcode `\#=\other
3701: \catcode `\&=\other
3702: % `\+ does not work, so use 43.
3703: \catcode 43=\other
3704: % the aux file uses ' as the escape.
3705: % Turn off \ as an escape so we do not lose on
3706: % entries which were dumped with control sequences in their names.
3707: % For example, 'xrdef {$\leq $-fun}{page ...} made by @defun ^^
3708: % Reference to such entries still does not work the way one would wish,
3709: % but at least they do not bomb out when the aux file is read in.
3710: \catcode `\{=1 \catcode `\}=2
3711: \catcode `\%=\other
3712: \catcode `\'=0
3713: \catcode `\\=\other
3714: \openin 1 \jobname.aux
3715: \ifeof 1 \else \closein 1 \input \jobname.aux \global\havexrefstrue
3716: \global\warnedobstrue
3717: \fi
3718: % Open the new aux file. Tex will close it automatically at exit.
3719: \openout \auxfile=\jobname.aux
3720: \endgroup}
3721:
3722:
3723: % Footnotes.
3724:
3725: \newcount \footnoteno
3726:
3727: % The trailing space in the following definition for supereject is
3728: % vital for proper filling; pages come out unaligned when you do a
3729: % pagealignmacro call if that space before the closing brace is
3730: % removed.
3731: \def\supereject{\par\penalty -20000\footnoteno =0 }
3732:
3733: % @footnotestyle is meaningful for info output only..
3734: \let\footnotestyle=\comment
3735:
3736: \let\ptexfootnote=\footnote
3737:
3738: {\catcode `\@=11
3739: %
3740: % Auto-number footnotes. Otherwise like plain.
3741: \gdef\footnote{%
3742: \global\advance\footnoteno by \@ne
3743: \edef\thisfootno{$^{\the\footnoteno}$}%
3744: %
3745: % In case the footnote comes at the end of a sentence, preserve the
3746: % extra spacing after we do the footnote number.
3747: \let\@sf\empty
3748: \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\/\fi
3749: %
3750: % Remove inadvertent blank space before typesetting the footnote number.
3751: \unskip
3752: \thisfootno\@sf
3753: \footnotezzz
3754: }%
3755:
3756: % Don't bother with the trickery in plain.tex to not require the
3757: % footnote text as a parameter. Our footnotes don't need to be so general.
3758: %
3759: \long\gdef\footnotezzz#1{\insert\footins{%
3760: % We want to typeset this text as a normal paragraph, even if the
3761: % footnote reference occurs in (for example) a display environment.
3762: % So reset some parameters.
3763: \interlinepenalty\interfootnotelinepenalty
3764: \splittopskip\ht\strutbox % top baseline for broken footnotes
3765: \splitmaxdepth\dp\strutbox
3766: \floatingpenalty\@MM
3767: \leftskip\z@skip
3768: \rightskip\z@skip
3769: \spaceskip\z@skip
3770: \xspaceskip\z@skip
3771: \parindent\defaultparindent
3772: %
3773: % Hang the footnote text off the number.
3774: \hang
3775: \textindent{\thisfootno}%
3776: %
3777: % Don't crash into the line above the footnote text. Since this
3778: % expands into a box, it must come within the paragraph, lest it
3779: % provide a place where TeX can split the footnote.
3780: \footstrut
3781: #1\strut}%
3782: }
3783:
3784: }%end \catcode `\@=11
3785:
3786: % Set the baselineskip to #1, and the lineskip and strut size
3787: % correspondingly. There is no deep meaning behind these magic numbers
3788: % used as factors; they just match (closely enough) what Knuth defined.
3789: %
3790: \def\lineskipfactor{.08333}
3791: \def\strutheightpercent{.70833}
3792: \def\strutdepthpercent {.29167}
3793: %
3794: \def\setleading#1{%
3795: \normalbaselineskip = #1\relax
3796: \normallineskip = \lineskipfactor\normalbaselineskip
3797: \normalbaselines
3798: \setbox\strutbox =\hbox{%
3799: \vrule width0pt height\strutheightpercent\baselineskip
3800: depth \strutdepthpercent \baselineskip
3801: }%
3802: }
3803:
3804: % @| inserts a changebar to the left of the current line. It should
3805: % surround any changed text. This approach does *not* work if the
3806: % change spans more than two lines of output. To handle that, we would
3807: % have adopt a much more difficult approach (putting marks into the main
3808: % vertical list for the beginning and end of each change).
3809: %
3810: \def\|{%
3811: % \vadjust can only be used in horizontal mode.
3812: \leavevmode
3813: %
3814: % Append this vertical mode material after the current line in the output.
3815: \vadjust{%
3816: % We want to insert a rule with the height and depth of the current
3817: % leading; that is exactly what \strutbox is supposed to record.
3818: \vskip-\baselineskip
3819: %
3820: % \vadjust-items are inserted at the left edge of the type. So
3821: % the \llap here moves out into the left-hand margin.
3822: \llap{%
3823: %
3824: % For a thicker or thinner bar, change the `1pt'.
3825: \vrule height\baselineskip width1pt
3826: %
3827: % This is the space between the bar and the text.
3828: \hskip 12pt
3829: }%
3830: }%
3831: }
3832:
3833: % For a final copy, take out the rectangles
3834: % that mark overfull boxes (in case you have decided
3835: % that the text looks ok even though it passes the margin).
3836: %
3837: \def\finalout{\overfullrule=0pt}
3838:
3839:
3840: % End of control word definitions.
3841:
3842: \message{and turning on texinfo input format.}
3843:
3844: \def\openindices{%
3845: \newindex{cp}%
3846: \newcodeindex{fn}%
3847: \newcodeindex{vr}%
3848: \newcodeindex{tp}%
3849: \newcodeindex{ky}%
3850: \newcodeindex{pg}%
3851: }
3852:
3853: % Set some numeric style parameters, for 8.5 x 11 format.
3854:
3855: %\hsize = 6.5in
3856: \newdimen\defaultparindent \defaultparindent = 15pt
3857: \parindent = \defaultparindent
3858: \parskip 18pt plus 1pt
3859: \setleading{15pt}
3860: \advance\topskip by 1.2cm
3861:
3862: % Prevent underfull vbox error messages.
3863: \vbadness=10000
3864:
3865: % Following George Bush, just get rid of widows and orphans.
3866: \widowpenalty=10000
3867: \clubpenalty=10000
3868:
3869: % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
3870: % using an old version of TeX, don't do anything. We want the amount of
3871: % stretch added to depend on the line length, hence the dependence on
3872: % \hsize. This makes it come to about 9pt for the 8.5x11 format.
3873: %
3874: \ifx\emergencystretch\thisisundefined
3875: % Allow us to assign to \emergencystretch anyway.
3876: \def\emergencystretch{\dimen0}%
3877: \else
3878: \emergencystretch = \hsize
3879: \divide\emergencystretch by 45
3880: \fi
3881:
3882: % Use @smallbook to reset parameters for 7x9.5 format (or else 7x9.25)
3883: \def\smallbook{
3884:
3885: % These values for secheadingskip and subsecheadingskip are
3886: % experiments. RJC 7 Aug 1992
3887: \global\secheadingskip = 17pt plus 6pt minus 3pt
3888: \global\subsecheadingskip = 14pt plus 6pt minus 3pt
3889:
3890: \global\lispnarrowing = 0.3in
3891: \setleading{12pt}
3892: \advance\topskip by -1cm
3893: \global\parskip 3pt plus 1pt
3894: \global\hsize = 5in
3895: \global\vsize=7.5in
3896: \global\tolerance=700
3897: \global\hfuzz=1pt
3898: \global\contentsrightmargin=0pt
3899:
3900: \global\pagewidth=\hsize
3901: \global\pageheight=\vsize
3902:
3903: \global\let\smalllisp=\smalllispx
3904: \global\let\smallexample=\smalllispx
3905: \global\def\Esmallexample{\Esmalllisp}
3906: }
3907:
3908: % Use @afourpaper to print on European A4 paper.
3909: \def\afourpaper{
3910: \global\tolerance=700
3911: \global\hfuzz=1pt
3912: \setleading{12pt}
3913: \global\parskip 15pt plus 1pt
3914:
3915: \global\vsize= 53\baselineskip
3916: \advance\vsize by \topskip
3917: %\global\hsize= 5.85in % A4 wide 10pt
3918: \global\hsize= 6.5in
3919: \global\outerhsize=\hsize
3920: \global\advance\outerhsize by 0.5in
3921: \global\outervsize=\vsize
3922: \global\advance\outervsize by 0.6in
3923:
3924: \global\pagewidth=\hsize
3925: \global\pageheight=\vsize
3926: }
3927:
3928: % Define macros to output various characters with catcode for normal text.
3929: \catcode`\"=\other
3930: \catcode`\~=\other
3931: \catcode`\^=\other
3932: \catcode`\_=\other
3933: \catcode`\|=\other
3934: \catcode`\<=\other
3935: \catcode`\>=\other
3936: \catcode`\+=\other
3937: \def\normaldoublequote{"}
3938: \def\normaltilde{~}
3939: \def\normalcaret{^}
3940: \def\normalunderscore{_}
3941: \def\normalverticalbar{|}
3942: \def\normalless{<}
3943: \def\normalgreater{>}
3944: \def\normalplus{+}
3945:
3946: % This macro is used to make a character print one way in ttfont
3947: % where it can probably just be output, and another way in other fonts,
3948: % where something hairier probably needs to be done.
3949: %
3950: % #1 is what to print if we are indeed using \tt; #2 is what to print
3951: % otherwise. Since all the Computer Modern typewriter fonts have zero
3952: % interword stretch (and shrink), and it is reasonable to expect all
3953: % typewriter fonts to have this, we can check that font parameter.
3954: %
3955: \def\ifusingtt#1#2{\ifdim \fontdimen3\the\font=0pt #1\else #2\fi}
3956:
3957: % Turn off all special characters except @
3958: % (and those which the user can use as if they were ordinary).
3959: % Most of these we simply print from the \tt font, but for some, we can
3960: % use math or other variants that look better in normal text.
3961:
3962: \catcode`\"=\active
3963: \def\activedoublequote{{\tt \char '042}}
3964: \let"=\activedoublequote
3965: \catcode`\~=\active
3966: \def~{{\tt \char '176}}
3967: \chardef\hat=`\^
3968: \catcode`\^=\active
3969: \def^{{\tt \hat}}
3970:
3971: \catcode`\_=\active
3972: \def_{\ifusingtt\normalunderscore\_}
3973: % Subroutine for the previous macro.
3974: \def\_{\lvvmode \kern.06em \vbox{\hrule width.3em height.1ex}}
3975:
3976: % \lvvmode is equivalent in function to \leavevmode.
3977: % Using \leavevmode runs into trouble when written out to
3978: % an index file due to the expansion of \leavevmode into ``\unhbox
3979: % \voidb@x'' ---which looks to TeX like ``\unhbox \voidb\x'' due to our
3980: % magic tricks with @.
3981: \def\lvvmode{\vbox to 0pt{}}
3982:
3983: \catcode`\|=\active
3984: \def|{{\tt \char '174}}
3985: \chardef \less=`\<
3986: \catcode`\<=\active
3987: \def<{{\tt \less}}
3988: \chardef \gtr=`\>
3989: \catcode`\>=\active
3990: \def>{{\tt \gtr}}
3991: \catcode`\+=\active
3992: \def+{{\tt \char 43}}
3993: %\catcode 27=\active
3994: %\def^^[{$\diamondsuit$}
3995:
3996: % Used sometimes to turn off (effectively) the active characters
3997: % even after parsing them.
3998: \def\turnoffactive{\let"=\normaldoublequote
3999: \let~=\normaltilde
4000: \let^=\normalcaret
4001: \let_=\normalunderscore
4002: \let|=\normalverticalbar
4003: \let<=\normalless
4004: \let>=\normalgreater
4005: \let+=\normalplus}
4006:
4007: % Set up an active definition for =, but don't enable it most of the time.
4008: {\catcode`\==\active
4009: \global\def={{\tt \char 61}}}
4010:
4011: \catcode`\@=0
4012:
4013: % \rawbackslashxx output one backslash character in current font
4014: \global\chardef\rawbackslashxx=`\\
4015: %{\catcode`\\=\other
4016: %@gdef@rawbackslashxx{\}}
4017:
4018: % \rawbackslash redefines \ as input to do \rawbackslashxx.
4019: {\catcode`\\=\active
4020: @gdef@rawbackslash{@let\=@rawbackslashxx }}
4021:
4022: % \normalbackslash outputs one backslash in fixed width font.
4023: \def\normalbackslash{{\tt\rawbackslashxx}}
4024:
4025: % Say @foo, not \foo, in error messages.
4026: \escapechar=`\@
4027:
4028: % \catcode 17=0 % Define control-q
4029: \catcode`\\=\active
4030:
4031: % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
4032: % That is what \eatinput is for; after that, the `\' should revert to printing
4033: % a backslash.
4034: %
4035: @gdef@eatinput input texinfo{@fixbackslash}
4036: @global@let\ = @eatinput
4037:
4038: % On the other hand, perhaps the file did not have a `\input texinfo'. Then
4039: % the first `\{ in the file would cause an error. This macro tries to fix
4040: % that, assuming it is called before the first `\' could plausibly occur.
4041: %
4042: @gdef@fixbackslash{@ifx\@eatinput @let\ = @normalbackslash @fi}
4043:
4044: %% These look ok in all fonts, so just make them not special. The @rm below
4045: %% makes sure that the current font starts out as the newly loaded cmr10
4046: @catcode`@$=@other @catcode`@%=@other @catcode`@&=@other @catcode`@#=@other
4047:
4048: @textfonts
4049: @rm
4050:
4051: @c Local variables:
4052: @c page-delimiter: "^\\\\message"
4053: @c End:
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.