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