PageRenderTime 156ms CodeModel.GetById 18ms app.highlight 86ms RepoModel.GetById 2ms app.codeStats 1ms

/js/src/ctypes/libffi/texinfo.tex

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