"Fossies" - the Fresh Open Source Software Archive

Member "nano-4.5/doc/texinfo.tex" (10 Nov 2018, 382211 Bytes) of package /linux/misc/nano-4.5.tar.xz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) TeX and LaTeX source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code 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{2018-02-12.17}
    7 %
    8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
    9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
   10 % 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018
   11 % Free Software Foundation, Inc.
   12 %
   13 % This texinfo.tex file is free software: you can redistribute it and/or
   14 % modify it under the terms of the GNU General Public License as
   15 % published by the Free Software Foundation, either version 3 of the
   16 % License, or (at your option) any later version.
   17 %
   18 % This texinfo.tex file is distributed in the hope that it will be
   19 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
   20 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   21 % General Public License for more details.
   22 %
   23 % You should have received a copy of the GNU General Public License
   24 % along with this program.  If not, see <https://www.gnu.org/licenses/>.
   25 %
   26 % As a special exception, when this file is read by TeX when processing
   27 % a Texinfo source document, you may use the result without
   28 % restriction. This Exception is an additional permission under section 7
   29 % of the GNU General Public License, version 3 ("GPLv3").
   30 %
   31 % Please try the latest version of texinfo.tex before submitting bug
   32 % reports; you can get the latest version from:
   33 %   https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
   34 %   https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
   35 %   https://www.gnu.org/software/texinfo/ (the Texinfo home page)
   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 https://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 % LaTeX's \typeout.  This ensures that the messages it is used for
   71 % are identical in format to the corresponding ones from latex/pdflatex.
   72 \def\typeout{\immediate\write17}%
   73 
   74 \chardef\other=12
   75 
   76 % We never want plain's \outer definition of \+ in Texinfo.
   77 % For @tex, we can use \tabalign.
   78 \let\+ = \relax
   79 
   80 % Save some plain tex macros whose names we will redefine.
   81 \let\ptexb=\b
   82 \let\ptexbullet=\bullet
   83 \let\ptexc=\c
   84 \let\ptexcomma=\,
   85 \let\ptexdot=\.
   86 \let\ptexdots=\dots
   87 \let\ptexend=\end
   88 \let\ptexequiv=\equiv
   89 \let\ptexexclam=\!
   90 \let\ptexfootnote=\footnote
   91 \let\ptexgtr=>
   92 \let\ptexhat=^
   93 \let\ptexi=\i
   94 \let\ptexindent=\indent
   95 \let\ptexinsert=\insert
   96 \let\ptexlbrace=\{
   97 \let\ptexless=<
   98 \let\ptexnewwrite\newwrite
   99 \let\ptexnoindent=\noindent
  100 \let\ptexplus=+
  101 \let\ptexraggedright=\raggedright
  102 \let\ptexrbrace=\}
  103 \let\ptexslash=\/
  104 \let\ptexsp=\sp
  105 \let\ptexstar=\*
  106 \let\ptexsup=\sup
  107 \let\ptext=\t
  108 \let\ptextop=\top
  109 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
  110 
  111 % If this character appears in an error message or help string, it
  112 % starts a new line in the output.
  113 \newlinechar = `^^J
  114 
  115 % Use TeX 3.0's \inputlineno to get the line number, for better error
  116 % messages, but if we're using an old version of TeX, don't do anything.
  117 %
  118 \ifx\inputlineno\thisisundefined
  119   \let\linenumber = \empty % Pre-3.0.
  120 \else
  121   \def\linenumber{l.\the\inputlineno:\space}
  122 \fi
  123 
  124 % Set up fixed words for English if not already set.
  125 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
  126 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
  127 \ifx\putworderror\undefined     \gdef\putworderror{error}\fi
  128 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
  129 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
  130 \ifx\putwordIndexIsEmpty\undefined       \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
  131 \ifx\putwordIndexNonexistent\undefined   \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
  132 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
  133 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
  134 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
  135 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
  136 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
  137 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
  138 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
  139 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
  140 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
  141 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
  142 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
  143 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
  144 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
  145 %
  146 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
  147 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
  148 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
  149 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
  150 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
  151 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
  152 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
  153 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
  154 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
  155 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
  156 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
  157 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
  158 %
  159 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
  160 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
  161 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
  162 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
  163 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
  164 
  165 % Give the space character the catcode for a space.
  166 \def\spaceisspace{\catcode`\ =10\relax}
  167 
  168 % Likewise for ^^M, the end of line character.
  169 \def\endlineisspace{\catcode13=10\relax}
  170 
  171 \chardef\dashChar  = `\-
  172 \chardef\slashChar = `\/
  173 \chardef\underChar = `\_
  174 
  175 % Ignore a token.
  176 %
  177 \def\gobble#1{}
  178 
  179 % The following is used inside several \edef's.
  180 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
  181 
  182 % Hyphenation fixes.
  183 \hyphenation{
  184   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
  185   auto-ma-ti-cal-ly ap-pen-dix bit-map bit-maps
  186   data-base data-bases eshell fall-ing half-way long-est man-u-script
  187   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
  188   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
  189   spell-ing spell-ings
  190   stand-alone strong-est time-stamp time-stamps which-ever white-space
  191   wide-spread wrap-around
  192 }
  193 
  194 % Sometimes it is convenient to have everything in the transcript file
  195 % and nothing on the terminal.  We don't just call \tracingall here,
  196 % since that produces some useless output on the terminal.  We also make
  197 % some effort to order the tracing commands to reduce output in the log
  198 % file; cf. trace.sty in LaTeX.
  199 %
  200 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
  201 \def\loggingall{%
  202   \tracingstats2
  203   \tracingpages1
  204   \tracinglostchars2  % 2 gives us more in etex
  205   \tracingparagraphs1
  206   \tracingoutput1
  207   \tracingmacros2
  208   \tracingrestores1
  209   \showboxbreadth\maxdimen \showboxdepth\maxdimen
  210   \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
  211     \tracingscantokens1
  212     \tracingifs1
  213     \tracinggroups1
  214     \tracingnesting2
  215     \tracingassigns1
  216   \fi
  217   \tracingcommands3  % 3 gives us more in etex
  218   \errorcontextlines16
  219 }%
  220 
  221 % @errormsg{MSG}.  Do the index-like expansions on MSG, but if things
  222 % aren't perfect, it's not the end of the world, being an error message,
  223 % after all.
  224 % 
  225 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
  226 \def\doerrormsg#1{\errmessage{#1}}
  227 
  228 % add check for \lastpenalty to plain's definitions.  If the last thing
  229 % we did was a \nobreak, we don't want to insert more space.
  230 %
  231 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
  232   \removelastskip\penalty-50\smallskip\fi\fi}
  233 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
  234   \removelastskip\penalty-100\medskip\fi\fi}
  235 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
  236   \removelastskip\penalty-200\bigskip\fi\fi}
  237 
  238 % Output routine
  239 %
  240 
  241 % For a final copy, take out the rectangles
  242 % that mark overfull boxes (in case you have decided
  243 % that the text looks ok even though it passes the margin).
  244 %
  245 \def\finalout{\overfullrule=0pt }
  246 
  247 % Do @cropmarks to get crop marks.
  248 %
  249 \newif\ifcropmarks
  250 \let\cropmarks = \cropmarkstrue
  251 %
  252 % Dimensions to add cropmarks at corners.
  253 % Added by P. A. MacKay, 12 Nov. 1986
  254 %
  255 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
  256 \newdimen\cornerlong  \cornerlong=1pc
  257 \newdimen\cornerthick \cornerthick=.3pt
  258 \newdimen\topandbottommargin \topandbottommargin=.75in
  259 
  260 % Output a mark which sets \thischapter, \thissection and \thiscolor.
  261 % We dump everything together because we only have one kind of mark.
  262 % This works because we only use \botmark / \topmark, not \firstmark.
  263 %
  264 % A mark contains a subexpression of the \ifcase ... \fi construct.
  265 % \get*marks macros below extract the needed part using \ifcase.
  266 %
  267 % Another complication is to let the user choose whether \thischapter
  268 % (\thissection) refers to the chapter (section) in effect at the top
  269 % of a page, or that at the bottom of a page.
  270 
  271 % \domark is called twice inside \chapmacro, to add one
  272 % mark before the section break, and one after.
  273 %   In the second call \prevchapterdefs is the same as \lastchapterdefs,
  274 % and \prevsectiondefs is the same as \lastsectiondefs.
  275 %   Then if the page is not broken at the mark, some of the previous
  276 % section appears on the page, and we can get the name of this section
  277 % from \firstmark for @everyheadingmarks top.
  278 %   @everyheadingmarks bottom uses \botmark.
  279 %
  280 % See page 260 of The TeXbook.
  281 \def\domark{%
  282   \toks0=\expandafter{\lastchapterdefs}%
  283   \toks2=\expandafter{\lastsectiondefs}%
  284   \toks4=\expandafter{\prevchapterdefs}%
  285   \toks6=\expandafter{\prevsectiondefs}%
  286   \toks8=\expandafter{\lastcolordefs}%
  287   \mark{%
  288                    \the\toks0 \the\toks2  % 0: marks for @everyheadingmarks top
  289       \noexpand\or \the\toks4 \the\toks6  % 1: for @everyheadingmarks bottom
  290     \noexpand\else \the\toks8             % 2: color marks
  291   }%
  292 }
  293 
  294 % \gettopheadingmarks, \getbottomheadingmarks,
  295 % \getcolormarks - extract needed part of mark.
  296 %
  297 % \topmark doesn't work for the very first chapter (after the title
  298 % page or the contents), so we use \firstmark there -- this gets us
  299 % the mark with the chapter defs, unless the user sneaks in, e.g.,
  300 % @setcolor (or @url, or @link, etc.) between @contents and the very
  301 % first @chapter.
  302 \def\gettopheadingmarks{%
  303   \ifcase0\topmark\fi
  304   \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
  305 }
  306 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
  307 \def\getcolormarks{\ifcase2\topmark\fi}
  308 
  309 % Avoid "undefined control sequence" errors.
  310 \def\lastchapterdefs{}
  311 \def\lastsectiondefs{}
  312 \def\lastsection{}
  313 \def\prevchapterdefs{}
  314 \def\prevsectiondefs{}
  315 \def\lastcolordefs{}
  316 
  317 % Margin to add to right of even pages, to left of odd pages.
  318 \newdimen\bindingoffset
  319 \newdimen\normaloffset
  320 \newdimen\txipagewidth \newdimen\txipageheight
  321 
  322 % Main output routine.
  323 %
  324 \chardef\PAGE = 255
  325 \output = {\onepageout{\pagecontents\PAGE}}
  326 
  327 \newbox\headlinebox
  328 \newbox\footlinebox
  329 
  330 % \onepageout takes a vbox as an argument.
  331 % \shipout a vbox for a single page, adding an optional header, footer,
  332 % cropmarks, and footnote.  This also causes index entries for this page
  333 % to be written to the auxiliary files.
  334 %
  335 \def\onepageout#1{%
  336   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
  337   %
  338   \ifodd\pageno  \advance\hoffset by \bindingoffset
  339   \else \advance\hoffset by -\bindingoffset\fi
  340   %
  341   % Common context changes for both heading and footing.
  342   % Do this outside of the \shipout so @code etc. will be expanded in
  343   % the headline as they should be, not taken literally (outputting ''code).
  344   \def\commmonheadfootline{\let\hsize=\txipagewidth \texinfochars}
  345   %
  346   % Retrieve the information for the headings from the marks in the page,
  347   % and call Plain TeX's \makeheadline and \makefootline, which use the
  348   % values in \headline and \footline.
  349   %
  350   % This is used to check if we are on the first page of a chapter.
  351   \ifcase1\topmark\fi
  352   \let\prevchaptername\thischaptername
  353   \ifcase0\firstmark\fi
  354   \let\curchaptername\thischaptername
  355   %
  356   \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
  357   \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
  358   %
  359   \ifx\curchaptername\prevchaptername
  360     \let\thischapterheading\thischapter
  361   \else
  362     % \thischapterheading is the same as \thischapter except it is blank
  363     % for the first page of a chapter.  This is to prevent the chapter name 
  364     % being shown twice.
  365     \def\thischapterheading{}%
  366   \fi
  367   %
  368   \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
  369   \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
  370   %
  371   {%
  372     % Set context for writing to auxiliary files like index files.
  373     % Have to do this stuff outside the \shipout because we want it to
  374     % take effect in \write's, yet the group defined by the \vbox ends
  375     % before the \shipout runs.
  376     %
  377     \indexdummies         % don't expand commands in the output.
  378     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
  379                % the page break happens to be in the middle of an example.
  380                % We don't want .vr (or whatever) entries like this:
  381                % \entry{{\indexbackslash }acronym}{32}{\code {\acronym}}
  382                % "\acronym" won't work when it's read back in;
  383                % it needs to be
  384                % {\code {{\backslashcurfont }acronym}
  385     \shipout\vbox{%
  386       % Do this early so pdf references go to the beginning of the page.
  387       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
  388       %
  389       \ifcropmarks \vbox to \outervsize\bgroup
  390         \hsize = \outerhsize
  391         \vskip-\topandbottommargin
  392         \vtop to0pt{%
  393           \line{\ewtop\hfil\ewtop}%
  394           \nointerlineskip
  395           \line{%
  396             \vbox{\moveleft\cornerthick\nstop}%
  397             \hfill
  398             \vbox{\moveright\cornerthick\nstop}%
  399           }%
  400           \vss}%
  401         \vskip\topandbottommargin
  402         \line\bgroup
  403           \hfil % center the page within the outer (page) hsize.
  404           \ifodd\pageno\hskip\bindingoffset\fi
  405           \vbox\bgroup
  406       \fi
  407       %
  408       \unvbox\headlinebox
  409       \pagebody{#1}%
  410       \ifdim\ht\footlinebox > 0pt
  411         % Only leave this space if the footline is nonempty.
  412         % (We lessened \vsize for it in \oddfootingyyy.)
  413         % The \baselineskip=24pt in plain's \makefootline has no effect.
  414         \vskip 24pt
  415         \unvbox\footlinebox
  416       \fi
  417       %
  418       \ifcropmarks
  419           \egroup % end of \vbox\bgroup
  420         \hfil\egroup % end of (centering) \line\bgroup
  421         \vskip\topandbottommargin plus1fill minus1fill
  422         \boxmaxdepth = \cornerthick
  423         \vbox to0pt{\vss
  424           \line{%
  425             \vbox{\moveleft\cornerthick\nsbot}%
  426             \hfill
  427             \vbox{\moveright\cornerthick\nsbot}%
  428           }%
  429           \nointerlineskip
  430           \line{\ewbot\hfil\ewbot}%
  431         }%
  432       \egroup % \vbox from first cropmarks clause
  433       \fi
  434     }% end of \shipout\vbox
  435   }% end of group with \indexdummies
  436   \advancepageno
  437   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
  438 }
  439 
  440 \newinsert\margin \dimen\margin=\maxdimen
  441 
  442 % Main part of page, including any footnotes
  443 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
  444 {\catcode`\@ =11
  445 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
  446 % marginal hacks, juha@viisa.uucp (Juha Takala)
  447 \ifvoid\margin\else % marginal info is present
  448   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
  449 \dimen@=\dp#1\relax \unvbox#1\relax
  450 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
  451 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
  452 }
  453 
  454 % Here are the rules for the cropmarks.  Note that they are
  455 % offset so that the space between them is truly \outerhsize or \outervsize
  456 % (P. A. MacKay, 12 November, 1986)
  457 %
  458 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
  459 \def\nstop{\vbox
  460   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
  461 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
  462 \def\nsbot{\vbox
  463   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
  464 
  465 
  466 % Argument parsing
  467 
  468 % Parse an argument, then pass it to #1.  The argument is the rest of
  469 % the input line (except we remove a trailing comment).  #1 should be a
  470 % macro which expects an ordinary undelimited TeX argument.
  471 % For example, \def\foo{\parsearg\fooxxx}.
  472 %
  473 \def\parsearg{\parseargusing{}}
  474 \def\parseargusing#1#2{%
  475   \def\argtorun{#2}%
  476   \begingroup
  477     \obeylines
  478     \spaceisspace
  479     #1%
  480     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
  481 }
  482 
  483 {\obeylines %
  484   \gdef\parseargline#1^^M{%
  485     \endgroup % End of the group started in \parsearg.
  486     \argremovecomment #1\comment\ArgTerm%
  487   }%
  488 }
  489 
  490 % First remove any @comment, then any @c comment.  Also remove a @texinfoc
  491 % comment (see \scanmacro for details).  Pass the result on to \argcheckspaces.
  492 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
  493 \def\argremovec#1\c#2\ArgTerm{\argremovetexinfoc #1\texinfoc\ArgTerm}
  494 \def\argremovetexinfoc#1\texinfoc#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
  495 
  496 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
  497 %
  498 % \argremovec might leave us with trailing space, e.g.,
  499 %    @end itemize  @c foo
  500 % This space token undergoes the same procedure and is eventually removed
  501 % by \finishparsearg.
  502 %
  503 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
  504 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
  505 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
  506   \def\temp{#3}%
  507   \ifx\temp\empty
  508     % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
  509     \let\temp\finishparsearg
  510   \else
  511     \let\temp\argcheckspaces
  512   \fi
  513   % Put the space token in:
  514   \temp#1 #3\ArgTerm
  515 }
  516 
  517 % If a _delimited_ argument is enclosed in braces, they get stripped; so
  518 % to get _exactly_ the rest of the line, we had to prevent such situation.
  519 % We prepended an \empty token at the very beginning and we expand it now,
  520 % just before passing the control to \argtorun.
  521 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
  522 % either the null string, or it ends with \^^M---thus there is no danger
  523 % that a pair of braces would be stripped.
  524 %
  525 % But first, we have to remove the trailing space token.
  526 %
  527 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
  528 
  529 
  530 % \parseargdef - define a command taking an argument on the line
  531 %
  532 % \parseargdef\foo{...}
  533 %   is roughly equivalent to
  534 % \def\foo{\parsearg\Xfoo}
  535 % \def\Xfoo#1{...}
  536 \def\parseargdef#1{%
  537   \expandafter \doparseargdef \csname\string#1\endcsname #1%
  538 }
  539 \def\doparseargdef#1#2{%
  540   \def#2{\parsearg#1}%
  541   \def#1##1%
  542 }
  543 
  544 % Several utility definitions with active space:
  545 {
  546   \obeyspaces
  547   \gdef\obeyedspace{ }
  548 
  549   % Make each space character in the input produce a normal interword
  550   % space in the output.  Don't allow a line break at this space, as this
  551   % is used only in environments like @example, where each line of input
  552   % should produce a line of output anyway.
  553   %
  554   \gdef\sepspaces{\obeyspaces\let =\tie}
  555 
  556   % If an index command is used in an @example environment, any spaces
  557   % therein should become regular spaces in the raw index file, not the
  558   % expansion of \tie (\leavevmode \penalty \@M \ ).
  559   \gdef\unsepspaces{\let =\space}
  560 }
  561 
  562 
  563 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
  564 
  565 % Define the framework for environments in texinfo.tex.  It's used like this:
  566 %
  567 %   \envdef\foo{...}
  568 %   \def\Efoo{...}
  569 %
  570 % It's the responsibility of \envdef to insert \begingroup before the
  571 % actual body; @end closes the group after calling \Efoo.  \envdef also
  572 % defines \thisenv, so the current environment is known; @end checks
  573 % whether the environment name matches.  The \checkenv macro can also be
  574 % used to check whether the current environment is the one expected.
  575 %
  576 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
  577 % are not treated as environments; they don't open a group.  (The
  578 % implementation of @end takes care not to call \endgroup in this
  579 % special case.)
  580 
  581 
  582 % At run-time, environments start with this:
  583 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
  584 % initialize
  585 \let\thisenv\empty
  586 
  587 % ... but they get defined via ``\envdef\foo{...}'':
  588 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
  589 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
  590 
  591 % Check whether we're in the right environment:
  592 \def\checkenv#1{%
  593   \def\temp{#1}%
  594   \ifx\thisenv\temp
  595   \else
  596     \badenverr
  597   \fi
  598 }
  599 
  600 % Environment mismatch, #1 expected:
  601 \def\badenverr{%
  602   \errhelp = \EMsimple
  603   \errmessage{This command can appear only \inenvironment\temp,
  604     not \inenvironment\thisenv}%
  605 }
  606 \def\inenvironment#1{%
  607   \ifx#1\empty
  608     outside of any environment%
  609   \else
  610     in environment \expandafter\string#1%
  611   \fi
  612 }
  613 
  614 % @end foo executes the definition of \Efoo.
  615 % But first, it executes a specialized version of \checkenv
  616 %
  617 \parseargdef\end{%
  618   \if 1\csname iscond.#1\endcsname
  619   \else
  620     % The general wording of \badenverr may not be ideal.
  621     \expandafter\checkenv\csname#1\endcsname
  622     \csname E#1\endcsname
  623     \endgroup
  624   \fi
  625 }
  626 
  627 \newhelp\EMsimple{Press RETURN to continue.}
  628 
  629 
  630 % Be sure we're in horizontal mode when doing a tie, since we make space
  631 % equivalent to this in @example-like environments. Otherwise, a space
  632 % at the beginning of a line will start with \penalty -- and
  633 % since \penalty is valid in vertical mode, we'd end up putting the
  634 % penalty on the vertical list instead of in the new paragraph.
  635 {\catcode`@ = 11
  636  % Avoid using \@M directly, because that causes trouble
  637  % if the definition is written into an index file.
  638  \global\let\tiepenalty = \@M
  639  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
  640 }
  641 
  642 % @: forces normal size whitespace following.
  643 \def\:{\spacefactor=1000 }
  644 
  645 % @* forces a line break.
  646 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
  647 
  648 % @/ allows a line break.
  649 \let\/=\allowbreak
  650 
  651 % @. is an end-of-sentence period.
  652 \def\.{.\spacefactor=\endofsentencespacefactor\space}
  653 
  654 % @! is an end-of-sentence bang.
  655 \def\!{!\spacefactor=\endofsentencespacefactor\space}
  656 
  657 % @? is an end-of-sentence query.
  658 \def\?{?\spacefactor=\endofsentencespacefactor\space}
  659 
  660 % @frenchspacing on|off  says whether to put extra space after punctuation.
  661 %
  662 \def\onword{on}
  663 \def\offword{off}
  664 %
  665 \parseargdef\frenchspacing{%
  666   \def\temp{#1}%
  667   \ifx\temp\onword \plainfrenchspacing
  668   \else\ifx\temp\offword \plainnonfrenchspacing
  669   \else
  670     \errhelp = \EMsimple
  671     \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
  672   \fi\fi
  673 }
  674 
  675 % @w prevents a word break.  Without the \leavevmode, @w at the
  676 % beginning of a paragraph, when TeX is still in vertical mode, would
  677 % produce a whole line of output instead of starting the paragraph.
  678 \def\w#1{\leavevmode\hbox{#1}}
  679 
  680 % @group ... @end group forces ... to be all on one page, by enclosing
  681 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
  682 % to keep its height that of a normal line.  According to the rules for
  683 % \topskip (p.114 of the TeXbook), the glue inserted is
  684 % max (\topskip - \ht (first item), 0).  If that height is large,
  685 % therefore, no glue is inserted, and the space between the headline and
  686 % the text is small, which looks bad.
  687 %
  688 % Another complication is that the group might be very large.  This can
  689 % cause the glue on the previous page to be unduly stretched, because it
  690 % does not have much material.  In this case, it's better to add an
  691 % explicit \vfill so that the extra space is at the bottom.  The
  692 % threshold for doing this is if the group is more than \vfilllimit
  693 % percent of a page (\vfilllimit can be changed inside of @tex).
  694 %
  695 \newbox\groupbox
  696 \def\vfilllimit{0.7}
  697 %
  698 \envdef\group{%
  699   \ifnum\catcode`\^^M=\active \else
  700     \errhelp = \groupinvalidhelp
  701     \errmessage{@group invalid in context where filling is enabled}%
  702   \fi
  703   \startsavinginserts
  704   %
  705   \setbox\groupbox = \vtop\bgroup
  706     % Do @comment since we are called inside an environment such as
  707     % @example, where each end-of-line in the input causes an
  708     % end-of-line in the output.  We don't want the end-of-line after
  709     % the `@group' to put extra space in the output.  Since @group
  710     % should appear on a line by itself (according to the Texinfo
  711     % manual), we don't worry about eating any user text.
  712     \comment
  713 }
  714 %
  715 % The \vtop produces a box with normal height and large depth; thus, TeX puts
  716 % \baselineskip glue before it, and (when the next line of text is done)
  717 % \lineskip glue after it.  Thus, space below is not quite equal to space
  718 % above.  But it's pretty close.
  719 \def\Egroup{%
  720     % To get correct interline space between the last line of the group
  721     % and the first line afterwards, we have to propagate \prevdepth.
  722     \endgraf % Not \par, as it may have been set to \lisppar.
  723     \global\dimen1 = \prevdepth
  724   \egroup           % End the \vtop.
  725   \addgroupbox
  726   \prevdepth = \dimen1
  727   \checkinserts
  728 }
  729 
  730 \def\addgroupbox{
  731   % \dimen0 is the vertical size of the group's box.
  732   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
  733   % \dimen2 is how much space is left on the page (more or less).
  734   \dimen2 = \txipageheight   \advance\dimen2 by -\pagetotal
  735   % if the group doesn't fit on the current page, and it's a big big
  736   % group, force a page break.
  737   \ifdim \dimen0 > \dimen2
  738     \ifdim \pagetotal < \vfilllimit\txipageheight
  739       \page
  740     \fi
  741   \fi
  742   \box\groupbox
  743 }
  744 
  745 %
  746 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
  747 % message, so this ends up printing `@group can only ...'.
  748 %
  749 \newhelp\groupinvalidhelp{%
  750 group can only be used in environments such as @example,^^J%
  751 where each line of input produces a line of output.}
  752 
  753 % @need space-in-mils
  754 % forces a page break if there is not space-in-mils remaining.
  755 
  756 \newdimen\mil  \mil=0.001in
  757 
  758 \parseargdef\need{%
  759   % Ensure vertical mode, so we don't make a big box in the middle of a
  760   % paragraph.
  761   \par
  762   %
  763   % If the @need value is less than one line space, it's useless.
  764   \dimen0 = #1\mil
  765   \dimen2 = \ht\strutbox
  766   \advance\dimen2 by \dp\strutbox
  767   \ifdim\dimen0 > \dimen2
  768     %
  769     % Do a \strut just to make the height of this box be normal, so the
  770     % normal leading is inserted relative to the preceding line.
  771     % And a page break here is fine.
  772     \vtop to #1\mil{\strut\vfil}%
  773     %
  774     % TeX does not even consider page breaks if a penalty added to the
  775     % main vertical list is 10000 or more.  But in order to see if the
  776     % empty box we just added fits on the page, we must make it consider
  777     % page breaks.  On the other hand, we don't want to actually break the
  778     % page after the empty box.  So we use a penalty of 9999.
  779     %
  780     % There is an extremely small chance that TeX will actually break the
  781     % page at this \penalty, if there are no other feasible breakpoints in
  782     % sight.  (If the user is using lots of big @group commands, which
  783     % almost-but-not-quite fill up a page, TeX will have a hard time doing
  784     % good page breaking, for example.)  However, I could not construct an
  785     % example where a page broke at this \penalty; if it happens in a real
  786     % document, then we can reconsider our strategy.
  787     \penalty9999
  788     %
  789     % Back up by the size of the box, whether we did a page break or not.
  790     \kern -#1\mil
  791     %
  792     % Do not allow a page break right after this kern.
  793     \nobreak
  794   \fi
  795 }
  796 
  797 % @br   forces paragraph break (and is undocumented).
  798 
  799 \let\br = \par
  800 
  801 % @page forces the start of a new page.
  802 %
  803 \def\page{\par\vfill\supereject}
  804 
  805 % @exdent text....
  806 % outputs text on separate line in roman font, starting at standard page margin
  807 
  808 % This records the amount of indent in the innermost environment.
  809 % That's how much \exdent should take out.
  810 \newskip\exdentamount
  811 
  812 % This defn is used inside fill environments such as @defun.
  813 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
  814 
  815 % This defn is used inside nofill environments such as @example.
  816 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
  817   \leftline{\hskip\leftskip{\rm#1}}}}
  818 
  819 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
  820 % paragraph.  For more general purposes, use the \margin insertion
  821 % class.  WHICH is `l' or `r'.  Not documented, written for gawk manual.
  822 %
  823 \newskip\inmarginspacing \inmarginspacing=1cm
  824 \def\strutdepth{\dp\strutbox}
  825 %
  826 \def\doinmargin#1#2{\strut\vadjust{%
  827   \nobreak
  828   \kern-\strutdepth
  829   \vtop to \strutdepth{%
  830     \baselineskip=\strutdepth
  831     \vss
  832     % if you have multiple lines of stuff to put here, you'll need to
  833     % make the vbox yourself of the appropriate size.
  834     \ifx#1l%
  835       \llap{\ignorespaces #2\hskip\inmarginspacing}%
  836     \else
  837       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
  838     \fi
  839     \null
  840   }%
  841 }}
  842 \def\inleftmargin{\doinmargin l}
  843 \def\inrightmargin{\doinmargin r}
  844 %
  845 % @inmargin{TEXT [, RIGHT-TEXT]}
  846 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
  847 % else use TEXT for both).
  848 %
  849 \def\inmargin#1{\parseinmargin #1,,\finish}
  850 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
  851   \setbox0 = \hbox{\ignorespaces #2}%
  852   \ifdim\wd0 > 0pt
  853     \def\lefttext{#1}%  have both texts
  854     \def\righttext{#2}%
  855   \else
  856     \def\lefttext{#1}%  have only one text
  857     \def\righttext{#1}%
  858   \fi
  859   %
  860   \ifodd\pageno
  861     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
  862   \else
  863     \def\temp{\inleftmargin\lefttext}%
  864   \fi
  865   \temp
  866 }
  867 
  868 % @include FILE -- \input text of FILE.
  869 %
  870 \def\include{\parseargusing\filenamecatcodes\includezzz}
  871 \def\includezzz#1{%
  872   \pushthisfilestack
  873   \def\thisfile{#1}%
  874   {%
  875     \makevalueexpandable  % we want to expand any @value in FILE.
  876     \turnoffactive        % and allow special characters in the expansion
  877     \indexnofonts         % Allow `@@' and other weird things in file names.
  878     \wlog{texinfo.tex: doing @include of #1^^J}%
  879     \edef\temp{\noexpand\input #1 }%
  880     %
  881     % This trickery is to read FILE outside of a group, in case it makes
  882     % definitions, etc.
  883     \expandafter
  884   }\temp
  885   \popthisfilestack
  886 }
  887 \def\filenamecatcodes{%
  888   \catcode`\\=\other
  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   \catcode`\'=\other
  899 }
  900 
  901 \def\pushthisfilestack{%
  902   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
  903 }
  904 \def\pushthisfilestackX{%
  905   \expandafter\pushthisfilestackY\thisfile\StackTerm
  906 }
  907 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
  908   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
  909 }
  910 
  911 \def\popthisfilestack{\errthisfilestackempty}
  912 \def\errthisfilestackempty{\errmessage{Internal error:
  913   the stack of filenames is empty.}}
  914 %
  915 \def\thisfile{}
  916 
  917 % @center line
  918 % outputs that line, centered.
  919 %
  920 \parseargdef\center{%
  921   \ifhmode
  922     \let\centersub\centerH
  923   \else
  924     \let\centersub\centerV
  925   \fi
  926   \centersub{\hfil \ignorespaces#1\unskip \hfil}%
  927   \let\centersub\relax % don't let the definition persist, just in case
  928 }
  929 \def\centerH#1{{%
  930   \hfil\break
  931   \advance\hsize by -\leftskip
  932   \advance\hsize by -\rightskip
  933   \line{#1}%
  934   \break
  935 }}
  936 %
  937 \newcount\centerpenalty
  938 \def\centerV#1{%
  939   % The idea here is the same as in \startdefun, \cartouche, etc.: if
  940   % @center is the first thing after a section heading, we need to wipe
  941   % out the negative parskip inserted by \sectionheading, but still
  942   % prevent a page break here.
  943   \centerpenalty = \lastpenalty
  944   \ifnum\centerpenalty>10000 \vskip\parskip \fi
  945   \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
  946   \line{\kern\leftskip #1\kern\rightskip}%
  947 }
  948 
  949 % @sp n   outputs n lines of vertical space
  950 %
  951 \parseargdef\sp{\vskip #1\baselineskip}
  952 
  953 % @comment ...line which is ignored...
  954 % @c is the same as @comment
  955 % @ignore ... @end ignore  is another way to write a comment
  956 
  957 
  958 \def\c{\begingroup \catcode`\^^M=\active%
  959 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
  960 \cxxx}
  961 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
  962 %
  963 \let\comment\c
  964 
  965 % @paragraphindent NCHARS
  966 % We'll use ems for NCHARS, close enough.
  967 % NCHARS can also be the word `asis' or `none'.
  968 % We cannot feasibly implement @paragraphindent asis, though.
  969 %
  970 \def\asisword{asis} % no translation, these are keywords
  971 \def\noneword{none}
  972 %
  973 \parseargdef\paragraphindent{%
  974   \def\temp{#1}%
  975   \ifx\temp\asisword
  976   \else
  977     \ifx\temp\noneword
  978       \defaultparindent = 0pt
  979     \else
  980       \defaultparindent = #1em
  981     \fi
  982   \fi
  983   \parindent = \defaultparindent
  984 }
  985 
  986 % @exampleindent NCHARS
  987 % We'll use ems for NCHARS like @paragraphindent.
  988 % It seems @exampleindent asis isn't necessary, but
  989 % I preserve it to make it similar to @paragraphindent.
  990 \parseargdef\exampleindent{%
  991   \def\temp{#1}%
  992   \ifx\temp\asisword
  993   \else
  994     \ifx\temp\noneword
  995       \lispnarrowing = 0pt
  996     \else
  997       \lispnarrowing = #1em
  998     \fi
  999   \fi
 1000 }
 1001 
 1002 % @firstparagraphindent WORD
 1003 % If WORD is `none', then suppress indentation of the first paragraph
 1004 % after a section heading.  If WORD is `insert', then do indent at such
 1005 % paragraphs.
 1006 %
 1007 % The paragraph indentation is suppressed or not by calling
 1008 % \suppressfirstparagraphindent, which the sectioning commands do.
 1009 % We switch the definition of this back and forth according to WORD.
 1010 % By default, we suppress indentation.
 1011 %
 1012 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
 1013 \def\insertword{insert}
 1014 %
 1015 \parseargdef\firstparagraphindent{%
 1016   \def\temp{#1}%
 1017   \ifx\temp\noneword
 1018     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
 1019   \else\ifx\temp\insertword
 1020     \let\suppressfirstparagraphindent = \relax
 1021   \else
 1022     \errhelp = \EMsimple
 1023     \errmessage{Unknown @firstparagraphindent option `\temp'}%
 1024   \fi\fi
 1025 }
 1026 
 1027 % Here is how we actually suppress indentation.  Redefine \everypar to
 1028 % \kern backwards by \parindent, and then reset itself to empty.
 1029 %
 1030 % We also make \indent itself not actually do anything until the next
 1031 % paragraph.
 1032 %
 1033 \gdef\dosuppressfirstparagraphindent{%
 1034   \gdef\indent  {\restorefirstparagraphindent \indent}%
 1035   \gdef\noindent{\restorefirstparagraphindent \noindent}%
 1036   \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
 1037 }
 1038 %
 1039 \gdef\restorefirstparagraphindent{%
 1040   \global\let\indent = \ptexindent
 1041   \global\let\noindent = \ptexnoindent
 1042   \global\everypar = {}%
 1043 }
 1044 
 1045 
 1046 % @refill is a no-op.
 1047 \let\refill=\relax
 1048 
 1049 % @setfilename INFO-FILENAME - ignored
 1050 \let\setfilename=\comment
 1051 
 1052 % @bye.
 1053 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
 1054 
 1055 
 1056 \message{pdf,}
 1057 % adobe `portable' document format
 1058 \newcount\tempnum
 1059 \newcount\lnkcount
 1060 \newtoks\filename
 1061 \newcount\filenamelength
 1062 \newcount\pgn
 1063 \newtoks\toksA
 1064 \newtoks\toksB
 1065 \newtoks\toksC
 1066 \newtoks\toksD
 1067 \newbox\boxA
 1068 \newbox\boxB
 1069 \newcount\countA
 1070 \newif\ifpdf
 1071 \newif\ifpdfmakepagedest
 1072 
 1073 %
 1074 % For LuaTeX
 1075 %
 1076 
 1077 \newif\iftxiuseunicodedestname
 1078 \txiuseunicodedestnamefalse % For pdfTeX etc.
 1079 
 1080 \ifx\luatexversion\thisisundefined
 1081 \else
 1082   % Use Unicode destination names
 1083   \txiuseunicodedestnametrue
 1084   % Escape PDF strings with converting UTF-16 from UTF-8
 1085   \begingroup
 1086     \catcode`\%=12
 1087     \directlua{
 1088       function UTF16oct(str)
 1089         tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
 1090         for c in string.utfvalues(str) do
 1091           if c < 0x10000 then
 1092             tex.sprint(
 1093               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
 1094                             string.char(0x5c) .. string.char(0x25) .. '03o',
 1095                             (c / 256), (c % 256)))
 1096           else
 1097             c = c - 0x10000
 1098             local c_hi = c / 1024 + 0xd800
 1099             local c_lo = c % 1024 + 0xdc00
 1100             tex.sprint(
 1101               string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
 1102                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
 1103                             string.char(0x5c) .. string.char(0x25) .. '03o' ..
 1104                             string.char(0x5c) .. string.char(0x25) .. '03o',
 1105                             (c_hi / 256), (c_hi % 256),
 1106                             (c_lo / 256), (c_lo % 256)))
 1107           end
 1108         end
 1109       end
 1110     }
 1111   \endgroup
 1112   \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
 1113   % Escape PDF strings without converting
 1114   \begingroup
 1115     \directlua{
 1116       function PDFescstr(str)
 1117         for c in string.bytes(str) do
 1118           if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
 1119             tex.sprint(
 1120               string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
 1121                             c))
 1122           else
 1123             tex.sprint(string.char(c))
 1124           end
 1125         end
 1126       end
 1127     }
 1128   \endgroup
 1129   \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
 1130   \ifnum\luatexversion>84
 1131     % For LuaTeX >= 0.85
 1132     \def\pdfdest{\pdfextension dest}
 1133     \let\pdfoutput\outputmode
 1134     \def\pdfliteral{\pdfextension literal}
 1135     \def\pdfcatalog{\pdfextension catalog}
 1136     \def\pdftexversion{\numexpr\pdffeedback version\relax}
 1137     \let\pdfximage\saveimageresource
 1138     \let\pdfrefximage\useimageresource
 1139     \let\pdflastximage\lastsavedimageresourceindex
 1140     \def\pdfendlink{\pdfextension endlink\relax}
 1141     \def\pdfoutline{\pdfextension outline}
 1142     \def\pdfstartlink{\pdfextension startlink}
 1143     \def\pdffontattr{\pdfextension fontattr}
 1144     \def\pdfobj{\pdfextension obj}
 1145     \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
 1146     \let\pdfpagewidth\pagewidth
 1147     \let\pdfpageheight\pageheight
 1148     \edef\pdfhorigin{\pdfvariable horigin}
 1149     \edef\pdfvorigin{\pdfvariable vorigin}
 1150   \fi
 1151 \fi
 1152 
 1153 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
 1154 % can be set).  So we test for \relax and 0 as well as being undefined.
 1155 \ifx\pdfoutput\thisisundefined
 1156 \else
 1157   \ifx\pdfoutput\relax
 1158   \else
 1159     \ifcase\pdfoutput
 1160     \else
 1161       \pdftrue
 1162     \fi
 1163   \fi
 1164 \fi
 1165 
 1166 % PDF uses PostScript string constants for the names of xref targets,
 1167 % for display in the outlines, and in other places.  Thus, we have to
 1168 % double any backslashes.  Otherwise, a name like "\node" will be
 1169 % interpreted as a newline (\n), followed by o, d, e.  Not good.
 1170 % 
 1171 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
 1172 % related messages.  The final outcome is that it is up to the TeX user
 1173 % to double the backslashes and otherwise make the string valid, so
 1174 % that's what we do.  pdftex 1.30.0 (ca.2005) introduced a primitive to
 1175 % do this reliably, so we use it.
 1176 
 1177 % #1 is a control sequence in which to do the replacements,
 1178 % which we \xdef.
 1179 \def\txiescapepdf#1{%
 1180   \ifx\pdfescapestring\thisisundefined
 1181     % No primitive available; should we give a warning or log?
 1182     % Many times it won't matter.
 1183     \xdef#1{#1}%
 1184   \else
 1185     % The expandable \pdfescapestring primitive escapes parentheses,
 1186     % backslashes, and other special chars.
 1187     \xdef#1{\pdfescapestring{#1}}%
 1188   \fi
 1189 }
 1190 \def\txiescapepdfutfsixteen#1{%
 1191   \ifx\pdfescapestrutfsixteen\thisisundefined
 1192     % No UTF-16 converting macro available.
 1193     \txiescapepdf{#1}%
 1194   \else
 1195     \xdef#1{\pdfescapestrutfsixteen{#1}}%
 1196   \fi
 1197 }
 1198 
 1199 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
 1200 with PDF output, and none of those formats could be found.  (.eps cannot
 1201 be supported due to the design of the PDF format; use regular TeX (DVI
 1202 output) for that.)}
 1203 
 1204 \ifpdf
 1205   %
 1206   % Color manipulation macros using ideas from pdfcolor.tex,
 1207   % except using rgb instead of cmyk; the latter is said to render as a
 1208   % very dark gray on-screen and a very dark halftone in print, instead
 1209   % of actual black. The dark red here is dark enough to print on paper as
 1210   % nearly black, but still distinguishable for online viewing.  We use
 1211   % black by default, though.
 1212   \def\rgbDarkRed{0.50 0.09 0.12}
 1213   \def\rgbBlack{0 0 0}
 1214   %
 1215   % rg sets the color for filling (usual text, etc.);
 1216   % RG sets the color for stroking (thin rules, e.g., normal _'s).
 1217   \def\pdfsetcolor#1{\pdfliteral{#1 rg  #1 RG}}
 1218   %
 1219   % Set color, and create a mark which defines \thiscolor accordingly,
 1220   % so that \makeheadline knows which color to restore.
 1221   \def\setcolor#1{%
 1222     \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
 1223     \domark
 1224     \pdfsetcolor{#1}%
 1225   }
 1226   %
 1227   \def\maincolor{\rgbBlack}
 1228   \pdfsetcolor{\maincolor}
 1229   \edef\thiscolor{\maincolor}
 1230   \def\lastcolordefs{}
 1231   %
 1232   \def\makefootline{%
 1233     \baselineskip24pt
 1234     \line{\pdfsetcolor{\maincolor}\the\footline}%
 1235   }
 1236   %
 1237   \def\makeheadline{%
 1238     \vbox to 0pt{%
 1239       \vskip-22.5pt
 1240       \line{%
 1241         \vbox to8.5pt{}%
 1242         % Extract \thiscolor definition from the marks.
 1243         \getcolormarks
 1244         % Typeset the headline with \maincolor, then restore the color.
 1245         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
 1246       }%
 1247       \vss
 1248     }%
 1249     \nointerlineskip
 1250   }
 1251   %
 1252   %
 1253   \pdfcatalog{/PageMode /UseOutlines}
 1254   %
 1255   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
 1256   \def\dopdfimage#1#2#3{%
 1257     \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
 1258     \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
 1259     %
 1260     % pdftex (and the PDF format) support .pdf, .png, .jpg (among
 1261     % others).  Let's try in that order, PDF first since if
 1262     % someone has a scalable image, presumably better to use that than a
 1263     % bitmap.
 1264     \let\pdfimgext=\empty
 1265     \begingroup
 1266       \openin 1 #1.pdf \ifeof 1
 1267         \openin 1 #1.PDF \ifeof 1
 1268           \openin 1 #1.png \ifeof 1
 1269             \openin 1 #1.jpg \ifeof 1
 1270               \openin 1 #1.jpeg \ifeof 1
 1271                 \openin 1 #1.JPG \ifeof 1
 1272                   \errhelp = \nopdfimagehelp
 1273                   \errmessage{Could not find image file #1 for pdf}%
 1274                 \else \gdef\pdfimgext{JPG}%
 1275                 \fi
 1276               \else \gdef\pdfimgext{jpeg}%
 1277               \fi
 1278             \else \gdef\pdfimgext{jpg}%
 1279             \fi
 1280           \else \gdef\pdfimgext{png}%
 1281           \fi
 1282         \else \gdef\pdfimgext{PDF}%
 1283         \fi
 1284       \else \gdef\pdfimgext{pdf}%
 1285       \fi
 1286       \closein 1
 1287     \endgroup
 1288     %
 1289     % without \immediate, ancient pdftex seg faults when the same image is
 1290     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
 1291     \ifnum\pdftexversion < 14
 1292       \immediate\pdfimage
 1293     \else
 1294       \immediate\pdfximage
 1295     \fi
 1296       \ifdim \wd0 >0pt width \pdfimagewidth \fi
 1297       \ifdim \wd2 >0pt height \pdfimageheight \fi
 1298       \ifnum\pdftexversion<13
 1299          #1.\pdfimgext
 1300        \else
 1301          {#1.\pdfimgext}%
 1302        \fi
 1303     \ifnum\pdftexversion < 14 \else
 1304       \pdfrefximage \pdflastximage
 1305     \fi}
 1306   %
 1307   \def\setpdfdestname#1{{%
 1308     % We have to set dummies so commands such as @code, and characters
 1309     % such as \, aren't expanded when present in a section title.
 1310     \indexnofonts
 1311     \makevalueexpandable
 1312     \turnoffactive
 1313     \iftxiuseunicodedestname
 1314       \ifx \declaredencoding \latone
 1315         % Pass through Latin-1 characters.
 1316         % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
 1317       \else
 1318         \ifx \declaredencoding \utfeight
 1319           % Pass through Unicode characters.
 1320         \else
 1321           % Use ASCII approximations in destination names.
 1322           \passthroughcharsfalse
 1323         \fi
 1324       \fi
 1325     \else
 1326       % Use ASCII approximations in destination names.
 1327       \passthroughcharsfalse
 1328     \fi
 1329     \def\pdfdestname{#1}%
 1330     \txiescapepdf\pdfdestname
 1331   }}
 1332   %
 1333   \def\setpdfoutlinetext#1{{%
 1334     \indexnofonts
 1335     \makevalueexpandable
 1336     \turnoffactive
 1337     \ifx \declaredencoding \latone
 1338       % The PDF format can use an extended form of Latin-1 in bookmark
 1339       % strings.  See Appendix D of the PDF Reference, Sixth Edition, for
 1340       % the "PDFDocEncoding".
 1341       \passthroughcharstrue
 1342       % Pass through Latin-1 characters.
 1343       %   LuaTeX: Convert to Unicode
 1344       %   pdfTeX: Use Latin-1 as PDFDocEncoding
 1345       \def\pdfoutlinetext{#1}%
 1346     \else
 1347       \ifx \declaredencoding \utfeight
 1348         \ifx\luatexversion\thisisundefined
 1349           % For pdfTeX  with UTF-8.
 1350           % TODO: the PDF format can use UTF-16 in bookmark strings,
 1351           % but the code for this isn't done yet.
 1352           % Use ASCII approximations.
 1353           \passthroughcharsfalse
 1354           \def\pdfoutlinetext{#1}%
 1355         \else
 1356           % For LuaTeX with UTF-8.
 1357           % Pass through Unicode characters for title texts.
 1358           \passthroughcharstrue
 1359           \def\pdfoutlinetext{#1}%
 1360         \fi
 1361       \else
 1362         % For non-Latin-1 or non-UTF-8 encodings.
 1363         % Use ASCII approximations.
 1364         \passthroughcharsfalse
 1365         \def\pdfoutlinetext{#1}%
 1366       \fi
 1367     \fi
 1368     % LuaTeX: Convert to UTF-16
 1369     % pdfTeX: Use Latin-1 as PDFDocEncoding
 1370     \txiescapepdfutfsixteen\pdfoutlinetext
 1371   }}
 1372   %
 1373   \def\pdfmkdest#1{%
 1374     \setpdfdestname{#1}%
 1375     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
 1376   }
 1377   %
 1378   % used to mark target names; must be expandable.
 1379   \def\pdfmkpgn#1{#1}
 1380   %
 1381   % by default, use black for everything.
 1382   \def\urlcolor{\rgbBlack}
 1383   \def\linkcolor{\rgbBlack}
 1384   \def\endlink{\setcolor{\maincolor}\pdfendlink}
 1385   %
 1386   % Adding outlines to PDF; macros for calculating structure of outlines
 1387   % come from Petr Olsak
 1388   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
 1389     \else \csname#1\endcsname \fi}
 1390   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
 1391     \advance\tempnum by 1
 1392     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
 1393   %
 1394   % #1 is the section text, which is what will be displayed in the
 1395   % outline by the pdf viewer.  #2 is the pdf expression for the number
 1396   % of subentries (or empty, for subsubsections).  #3 is the node text,
 1397   % which might be empty if this toc entry had no corresponding node.
 1398   % #4 is the page number
 1399   %
 1400   \def\dopdfoutline#1#2#3#4{%
 1401     % Generate a link to the node text if that exists; else, use the
 1402     % page number.  We could generate a destination for the section
 1403     % text in the case where a section has no node, but it doesn't
 1404     % seem worth the trouble, since most documents are normally structured.
 1405     \setpdfoutlinetext{#1}
 1406     \setpdfdestname{#3}
 1407     \ifx\pdfdestname\empty
 1408       \def\pdfdestname{#4}%
 1409     \fi
 1410     %
 1411     \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
 1412   }
 1413   %
 1414   \def\pdfmakeoutlines{%
 1415     \begingroup
 1416       % Read toc silently, to get counts of subentries for \pdfoutline.
 1417       \def\partentry##1##2##3##4{}% ignore parts in the outlines
 1418       \def\numchapentry##1##2##3##4{%
 1419     \def\thischapnum{##2}%
 1420     \def\thissecnum{0}%
 1421     \def\thissubsecnum{0}%
 1422       }%
 1423       \def\numsecentry##1##2##3##4{%
 1424     \advancenumber{chap\thischapnum}%
 1425     \def\thissecnum{##2}%
 1426     \def\thissubsecnum{0}%
 1427       }%
 1428       \def\numsubsecentry##1##2##3##4{%
 1429     \advancenumber{sec\thissecnum}%
 1430     \def\thissubsecnum{##2}%
 1431       }%
 1432       \def\numsubsubsecentry##1##2##3##4{%
 1433     \advancenumber{subsec\thissubsecnum}%
 1434       }%
 1435       \def\thischapnum{0}%
 1436       \def\thissecnum{0}%
 1437       \def\thissubsecnum{0}%
 1438       %
 1439       % use \def rather than \let here because we redefine \chapentry et
 1440       % al. a second time, below.
 1441       \def\appentry{\numchapentry}%
 1442       \def\appsecentry{\numsecentry}%
 1443       \def\appsubsecentry{\numsubsecentry}%
 1444       \def\appsubsubsecentry{\numsubsubsecentry}%
 1445       \def\unnchapentry{\numchapentry}%
 1446       \def\unnsecentry{\numsecentry}%
 1447       \def\unnsubsecentry{\numsubsecentry}%
 1448       \def\unnsubsubsecentry{\numsubsubsecentry}%
 1449       \readdatafile{toc}%
 1450       %
 1451       % Read toc second time, this time actually producing the outlines.
 1452       % The `-' means take the \expnumber as the absolute number of
 1453       % subentries, which we calculated on our first read of the .toc above.
 1454       %
 1455       % We use the node names as the destinations.
 1456       \def\numchapentry##1##2##3##4{%
 1457         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
 1458       \def\numsecentry##1##2##3##4{%
 1459         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
 1460       \def\numsubsecentry##1##2##3##4{%
 1461         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
 1462       \def\numsubsubsecentry##1##2##3##4{% count is always zero
 1463         \dopdfoutline{##1}{}{##3}{##4}}%
 1464       %
 1465       % PDF outlines are displayed using system fonts, instead of
 1466       % document fonts.  Therefore we cannot use special characters,
 1467       % since the encoding is unknown.  For example, the eogonek from
 1468       % Latin 2 (0xea) gets translated to a | character.  Info from
 1469       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
 1470       %
 1471       % TODO this right, we have to translate 8-bit characters to
 1472       % their "best" equivalent, based on the @documentencoding.  Too
 1473       % much work for too little return.  Just use the ASCII equivalents
 1474       % we use for the index sort strings.
 1475       % 
 1476       \indexnofonts
 1477       \setupdatafile
 1478       % We can have normal brace characters in the PDF outlines, unlike
 1479       % Texinfo index files.  So set that up.
 1480       \def\{{\lbracecharliteral}%
 1481       \def\}{\rbracecharliteral}%
 1482       \catcode`\\=\active \otherbackslash
 1483       \input \tocreadfilename
 1484     \endgroup
 1485   }
 1486   {\catcode`[=1 \catcode`]=2
 1487    \catcode`{=\other \catcode`}=\other
 1488    \gdef\lbracecharliteral[{]%
 1489    \gdef\rbracecharliteral[}]%
 1490   ]
 1491   %
 1492   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
 1493     \ifx\PP\D\let\nextsp\relax
 1494     \else\let\nextsp\skipspaces
 1495       \addtokens{\filename}{\PP}%
 1496       \advance\filenamelength by 1
 1497     \fi
 1498     \nextsp}
 1499   \def\getfilename#1{%
 1500     \filenamelength=0
 1501     % If we don't expand the argument now, \skipspaces will get
 1502     % snagged on things like "@value{foo}".
 1503     \edef\temp{#1}%
 1504     \expandafter\skipspaces\temp|\relax
 1505   }
 1506   \ifnum\pdftexversion < 14
 1507     \let \startlink \pdfannotlink
 1508   \else
 1509     \let \startlink \pdfstartlink
 1510   \fi
 1511   % make a live url in pdf output.
 1512   \def\pdfurl#1{%
 1513     \begingroup
 1514       % it seems we really need yet another set of dummies; have not
 1515       % tried to figure out what each command should do in the context
 1516       % of @url.  for now, just make @/ a no-op, that's the only one
 1517       % people have actually reported a problem with.
 1518       %
 1519       \normalturnoffactive
 1520       \def\@{@}%
 1521       \let\/=\empty
 1522       \makevalueexpandable
 1523       % do we want to go so far as to use \indexnofonts instead of just
 1524       % special-casing \var here?
 1525       \def\var##1{##1}%
 1526       %
 1527       \leavevmode\setcolor{\urlcolor}%
 1528       \startlink attr{/Border [0 0 0]}%
 1529         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
 1530     \endgroup}
 1531   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
 1532   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
 1533   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
 1534   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
 1535   \def\maketoks{%
 1536     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
 1537     \ifx\first0\adn0
 1538     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
 1539     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
 1540     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
 1541     \else
 1542       \ifnum0=\countA\else\makelink\fi
 1543       \ifx\first.\let\next=\done\else
 1544         \let\next=\maketoks
 1545         \addtokens{\toksB}{\the\toksD}
 1546         \ifx\first,\addtokens{\toksB}{\space}\fi
 1547       \fi
 1548     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
 1549     \next}
 1550   \def\makelink{\addtokens{\toksB}%
 1551     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
 1552   \def\pdflink#1{%
 1553     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
 1554     \setcolor{\linkcolor}#1\endlink}
 1555   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
 1556 \else
 1557   % non-pdf mode
 1558   \let\pdfmkdest = \gobble
 1559   \let\pdfurl = \gobble
 1560   \let\endlink = \relax
 1561   \let\setcolor = \gobble
 1562   \let\pdfsetcolor = \gobble
 1563   \let\pdfmakeoutlines = \relax
 1564 \fi  % \ifx\pdfoutput
 1565 
 1566 %
 1567 % For XeTeX
 1568 %
 1569 \ifx\XeTeXrevision\thisisundefined
 1570 \else
 1571   %
 1572   % XeTeX version check
 1573   %
 1574   \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
 1575     % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
 1576     % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
 1577     % For avoiding PDF destination name replacement, we use this special
 1578     % instead of xdvipdfmx's command line option `-C 0x0010'.
 1579     \special{dvipdfmx:config C 0x0010}
 1580     % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
 1581     % It can handle Unicode destination names for PDF.
 1582     \txiuseunicodedestnametrue
 1583   \else
 1584     % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
 1585     % `dvipdfmx:config' special.
 1586     % So for avoiding PDF destination name replacement,
 1587     % xdvipdfmx's command line option `-C 0x0010' is necessary.
 1588     %
 1589     % XeTeX < 0.99995 can not handle Unicode destination names for PDF
 1590     % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
 1591     % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
 1592     \txiuseunicodedestnamefalse
 1593   \fi
 1594   %
 1595   % Color support
 1596   %
 1597   \def\rgbDarkRed{0.50 0.09 0.12}
 1598   \def\rgbBlack{0 0 0}
 1599   %
 1600   \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
 1601   %
 1602   % Set color, and create a mark which defines \thiscolor accordingly,
 1603   % so that \makeheadline knows which color to restore.
 1604   \def\setcolor#1{%
 1605     \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
 1606     \domark
 1607     \pdfsetcolor{#1}%
 1608   }
 1609   %
 1610   \def\maincolor{\rgbBlack}
 1611   \pdfsetcolor{\maincolor}
 1612   \edef\thiscolor{\maincolor}
 1613   \def\lastcolordefs{}
 1614   %
 1615   \def\makefootline{%
 1616     \baselineskip24pt
 1617     \line{\pdfsetcolor{\maincolor}\the\footline}%
 1618   }
 1619   %
 1620   \def\makeheadline{%
 1621     \vbox to 0pt{%
 1622       \vskip-22.5pt
 1623       \line{%
 1624         \vbox to8.5pt{}%
 1625         % Extract \thiscolor definition from the marks.
 1626         \getcolormarks
 1627         % Typeset the headline with \maincolor, then restore the color.
 1628         \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
 1629       }%
 1630       \vss
 1631     }%
 1632     \nointerlineskip
 1633   }
 1634   %
 1635   % PDF outline support
 1636   %
 1637   % Emulate pdfTeX primitive
 1638   \def\pdfdest name#1 xyz{%
 1639     \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
 1640   }
 1641   %
 1642   \def\setpdfdestname#1{{%
 1643     % We have to set dummies so commands such as @code, and characters
 1644     % such as \, aren't expanded when present in a section title.
 1645     \indexnofonts
 1646     \makevalueexpandable
 1647     \turnoffactive
 1648     \iftxiuseunicodedestname
 1649       % Pass through Unicode characters.
 1650     \else
 1651       % Use ASCII approximations in destination names.
 1652       \passthroughcharsfalse
 1653     \fi
 1654     \def\pdfdestname{#1}%
 1655     \txiescapepdf\pdfdestname
 1656   }}
 1657   %
 1658   \def\setpdfoutlinetext#1{{%
 1659     \turnoffactive
 1660     % Always use Unicode characters in title texts.
 1661     \def\pdfoutlinetext{#1}%
 1662     % For XeTeX, xdvipdfmx converts to UTF-16.
 1663     % So we do not convert.
 1664     \txiescapepdf\pdfoutlinetext
 1665   }}
 1666   %
 1667   \def\pdfmkdest#1{%
 1668     \setpdfdestname{#1}%
 1669     \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
 1670   }
 1671   %
 1672   % by default, use black for everything.
 1673   \def\urlcolor{\rgbBlack}
 1674   \def\linkcolor{\rgbBlack}
 1675   \def\endlink{\setcolor{\maincolor}\pdfendlink}
 1676   %
 1677   \def\dopdfoutline#1#2#3#4{%
 1678     \setpdfoutlinetext{#1}
 1679     \setpdfdestname{#3}
 1680     \ifx\pdfdestname\empty
 1681       \def\pdfdestname{#4}%
 1682     \fi
 1683     %
 1684     \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
 1685       << /S /GoTo /D (\pdfdestname) >> >> }%
 1686   }
 1687   %
 1688   \def\pdfmakeoutlines{%
 1689     \begingroup
 1690       %
 1691       % For XeTeX, counts of subentries are not necessary.
 1692       % Therefore, we read toc only once.
 1693       %
 1694       % We use node names as destinations.
 1695       \def\partentry##1##2##3##4{}% ignore parts in the outlines
 1696       \def\numchapentry##1##2##3##4{%
 1697         \dopdfoutline{##1}{1}{##3}{##4}}%
 1698       \def\numsecentry##1##2##3##4{%
 1699         \dopdfoutline{##1}{2}{##3}{##4}}%
 1700       \def\numsubsecentry##1##2##3##4{%
 1701         \dopdfoutline{##1}{3}{##3}{##4}}%
 1702       \def\numsubsubsecentry##1##2##3##4{%
 1703         \dopdfoutline{##1}{4}{##3}{##4}}%
 1704       %
 1705       \let\appentry\numchapentry%
 1706       \let\appsecentry\numsecentry%
 1707       \let\appsubsecentry\numsubsecentry%
 1708       \let\appsubsubsecentry\numsubsubsecentry%
 1709       \let\unnchapentry\numchapentry%
 1710       \let\unnsecentry\numsecentry%
 1711       \let\unnsubsecentry\numsubsecentry%
 1712       \let\unnsubsubsecentry\numsubsubsecentry%
 1713       %
 1714       % For XeTeX, xdvipdfmx converts strings to UTF-16.
 1715       % Therefore, the encoding and the language may not be considered.
 1716       %
 1717       \indexnofonts
 1718       \setupdatafile
 1719       % We can have normal brace characters in the PDF outlines, unlike
 1720       % Texinfo index files.  So set that up.
 1721       \def\{{\lbracecharliteral}%
 1722       \def\}{\rbracecharliteral}%
 1723       \catcode`\\=\active \otherbackslash
 1724       \input \tocreadfilename
 1725     \endgroup
 1726   }
 1727   {\catcode`[=1 \catcode`]=2
 1728    \catcode`{=\other \catcode`}=\other
 1729    \gdef\lbracecharliteral[{]%
 1730    \gdef\rbracecharliteral[}]%
 1731   ]
 1732 
 1733   \special{pdf:docview << /PageMode /UseOutlines >> }
 1734   % ``\special{pdf:tounicode ...}'' is not necessary
 1735   % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
 1736   % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
 1737   % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
 1738   % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
 1739 %
 1740   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
 1741     \ifx\PP\D\let\nextsp\relax
 1742     \else\let\nextsp\skipspaces
 1743       \addtokens{\filename}{\PP}%
 1744       \advance\filenamelength by 1
 1745     \fi
 1746     \nextsp}
 1747   \def\getfilename#1{%
 1748     \filenamelength=0
 1749     % If we don't expand the argument now, \skipspaces will get
 1750     % snagged on things like "@value{foo}".
 1751     \edef\temp{#1}%
 1752     \expandafter\skipspaces\temp|\relax
 1753   }
 1754   % make a live url in pdf output.
 1755   \def\pdfurl#1{%
 1756     \begingroup
 1757       % it seems we really need yet another set of dummies; have not
 1758       % tried to figure out what each command should do in the context
 1759       % of @url.  for now, just make @/ a no-op, that's the only one
 1760       % people have actually reported a problem with.
 1761       %
 1762       \normalturnoffactive
 1763       \def\@{@}%
 1764       \let\/=\empty
 1765       \makevalueexpandable
 1766       % do we want to go so far as to use \indexnofonts instead of just
 1767       % special-casing \var here?
 1768       \def\var##1{##1}%
 1769       %
 1770       \leavevmode\setcolor{\urlcolor}%
 1771       \special{pdf:bann << /Border [0 0 0]
 1772         /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
 1773     \endgroup}
 1774   \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
 1775   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
 1776   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
 1777   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
 1778   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
 1779   \def\maketoks{%
 1780     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
 1781     \ifx\first0\adn0
 1782     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
 1783     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
 1784     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
 1785     \else
 1786       \ifnum0=\countA\else\makelink\fi
 1787       \ifx\first.\let\next=\done\else
 1788         \let\next=\maketoks
 1789         \addtokens{\toksB}{\the\toksD}
 1790         \ifx\first,\addtokens{\toksB}{\space}\fi
 1791       \fi
 1792     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
 1793     \next}
 1794   \def\makelink{\addtokens{\toksB}%
 1795     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
 1796   \def\pdflink#1{%
 1797     \special{pdf:bann << /Border [0 0 0]
 1798       /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
 1799     \setcolor{\linkcolor}#1\endlink}
 1800   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
 1801 %
 1802   %
 1803   % @image support
 1804   %
 1805   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
 1806   \def\doxeteximage#1#2#3{%
 1807     \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
 1808     \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
 1809     %
 1810     % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
 1811     % others).  Let's try in that order, PDF first since if
 1812     % someone has a scalable image, presumably better to use that than a
 1813     % bitmap.
 1814     \let\xeteximgext=\empty
 1815     \begingroup
 1816       \openin 1 #1.pdf \ifeof 1
 1817         \openin 1 #1.PDF \ifeof 1
 1818           \openin 1 #1.png \ifeof 1
 1819             \openin 1 #1.jpg \ifeof 1
 1820               \openin 1 #1.jpeg \ifeof 1
 1821                 \openin 1 #1.JPG \ifeof 1
 1822                   \errmessage{Could not find image file #1 for XeTeX}%
 1823                 \else \gdef\xeteximgext{JPG}%
 1824                 \fi
 1825               \else \gdef\xeteximgext{jpeg}%
 1826               \fi
 1827             \else \gdef\xeteximgext{jpg}%
 1828             \fi
 1829           \else \gdef\xeteximgext{png}%
 1830           \fi
 1831         \else \gdef\xeteximgext{PDF}%
 1832         \fi
 1833       \else \gdef\xeteximgext{pdf}%
 1834       \fi
 1835       \closein 1
 1836     \endgroup
 1837     %
 1838     \def\xetexpdfext{pdf}%
 1839     \ifx\xeteximgext\xetexpdfext
 1840       \XeTeXpdffile "#1".\xeteximgext ""
 1841     \else
 1842       \def\xetexpdfext{PDF}%
 1843       \ifx\xeteximgext\xetexpdfext
 1844         \XeTeXpdffile "#1".\xeteximgext ""
 1845       \else
 1846         \XeTeXpicfile "#1".\xeteximgext ""
 1847       \fi
 1848     \fi
 1849     \ifdim \wd0 >0pt width \xeteximagewidth \fi
 1850     \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
 1851   }
 1852 \fi
 1853 
 1854 
 1855 %
 1856 \message{fonts,}
 1857 
 1858 % Set the baselineskip to #1, and the lineskip and strut size
 1859 % correspondingly.  There is no deep meaning behind these magic numbers
 1860 % used as factors; they just match (closely enough) what Knuth defined.
 1861 %
 1862 \def\lineskipfactor{.08333}
 1863 \def\strutheightpercent{.70833}
 1864 \def\strutdepthpercent {.29167}
 1865 %
 1866 % can get a sort of poor man's double spacing by redefining this.
 1867 \def\baselinefactor{1}
 1868 %
 1869 \newdimen\textleading
 1870 \def\setleading#1{%
 1871   \dimen0 = #1\relax
 1872   \normalbaselineskip = \baselinefactor\dimen0
 1873   \normallineskip = \lineskipfactor\normalbaselineskip
 1874   \normalbaselines
 1875   \setbox\strutbox =\hbox{%
 1876     \vrule width0pt height\strutheightpercent\baselineskip
 1877                     depth \strutdepthpercent \baselineskip
 1878   }%
 1879 }
 1880 
 1881 % PDF CMaps.  See also LaTeX's t1.cmap.
 1882 %
 1883 % do nothing with this by default.
 1884 \expandafter\let\csname cmapOT1\endcsname\gobble
 1885 \expandafter\let\csname cmapOT1IT\endcsname\gobble
 1886 \expandafter\let\csname cmapOT1TT\endcsname\gobble
 1887 
 1888 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
 1889 % (\pdffontattr was introduced many years ago, but people still run
 1890 % older pdftex's; it's easy to conditionalize, so we do.)
 1891 \ifpdf \ifx\pdffontattr\thisisundefined \else
 1892   \begingroup
 1893     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
 1894     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
 1895 %%DocumentNeededResources: ProcSet (CIDInit)
 1896 %%IncludeResource: ProcSet (CIDInit)
 1897 %%BeginResource: CMap (TeX-OT1-0)
 1898 %%Title: (TeX-OT1-0 TeX OT1 0)
 1899 %%Version: 1.000
 1900 %%EndComments
 1901 /CIDInit /ProcSet findresource begin
 1902 12 dict begin
 1903 begincmap
 1904 /CIDSystemInfo
 1905 << /Registry (TeX)
 1906 /Ordering (OT1)
 1907 /Supplement 0
 1908 >> def
 1909 /CMapName /TeX-OT1-0 def
 1910 /CMapType 2 def
 1911 1 begincodespacerange
 1912 <00> <7F>
 1913 endcodespacerange
 1914 8 beginbfrange
 1915 <00> <01> <0393>
 1916 <09> <0A> <03A8>
 1917 <23> <26> <0023>
 1918 <28> <3B> <0028>
 1919 <3F> <5B> <003F>
 1920 <5D> <5E> <005D>
 1921 <61> <7A> <0061>
 1922 <7B> <7C> <2013>
 1923 endbfrange
 1924 40 beginbfchar
 1925 <02> <0398>
 1926 <03> <039B>
 1927 <04> <039E>
 1928 <05> <03A0>
 1929 <06> <03A3>
 1930 <07> <03D2>
 1931 <08> <03A6>
 1932 <0B> <00660066>
 1933 <0C> <00660069>
 1934 <0D> <0066006C>
 1935 <0E> <006600660069>
 1936 <0F> <00660066006C>
 1937 <10> <0131>
 1938 <11> <0237>
 1939 <12> <0060>
 1940 <13> <00B4>
 1941 <14> <02C7>
 1942 <15> <02D8>
 1943 <16> <00AF>
 1944 <17> <02DA>
 1945 <18> <00B8>
 1946 <19> <00DF>
 1947 <1A> <00E6>
 1948 <1B> <0153>
 1949 <1C> <00F8>
 1950 <1D> <00C6>
 1951 <1E> <0152>
 1952 <1F> <00D8>
 1953 <21> <0021>
 1954 <22> <201D>
 1955 <27> <2019>
 1956 <3C> <00A1>
 1957 <3D> <003D>
 1958 <3E> <00BF>
 1959 <5C> <201C>
 1960 <5F> <02D9>
 1961 <60> <2018>
 1962 <7D> <02DD>
 1963 <7E> <007E>
 1964 <7F> <00A8>
 1965 endbfchar
 1966 endcmap
 1967 CMapName currentdict /CMap defineresource pop
 1968 end
 1969 end
 1970 %%EndResource
 1971 %%EOF
 1972     }\endgroup
 1973   \expandafter\edef\csname cmapOT1\endcsname#1{%
 1974     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
 1975   }%
 1976 %
 1977 % \cmapOT1IT
 1978   \begingroup
 1979     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
 1980     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
 1981 %%DocumentNeededResources: ProcSet (CIDInit)
 1982 %%IncludeResource: ProcSet (CIDInit)
 1983 %%BeginResource: CMap (TeX-OT1IT-0)
 1984 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
 1985 %%Version: 1.000
 1986 %%EndComments
 1987 /CIDInit /ProcSet findresource begin
 1988 12 dict begin
 1989 begincmap
 1990 /CIDSystemInfo
 1991 << /Registry (TeX)
 1992 /Ordering (OT1IT)
 1993 /Supplement 0
 1994 >> def
 1995 /CMapName /TeX-OT1IT-0 def
 1996 /CMapType 2 def
 1997 1 begincodespacerange
 1998 <00> <7F>
 1999 endcodespacerange
 2000 8 beginbfrange
 2001 <00> <01> <0393>
 2002 <09> <0A> <03A8>
 2003 <25> <26> <0025>
 2004 <28> <3B> <0028>
 2005 <3F> <5B> <003F>
 2006 <5D> <5E> <005D>
 2007 <61> <7A> <0061>
 2008 <7B> <7C> <2013>
 2009 endbfrange
 2010 42 beginbfchar
 2011 <02> <0398>
 2012 <03> <039B>
 2013 <04> <039E>
 2014 <05> <03A0>
 2015 <06> <03A3>
 2016 <07> <03D2>
 2017 <08> <03A6>
 2018 <0B> <00660066>
 2019 <0C> <00660069>
 2020 <0D> <0066006C>
 2021 <0E> <006600660069>
 2022 <0F> <00660066006C>
 2023 <10> <0131>
 2024 <11> <0237>
 2025 <12> <0060>
 2026 <13> <00B4>
 2027 <14> <02C7>
 2028 <15> <02D8>
 2029 <16> <00AF>
 2030 <17> <02DA>
 2031 <18> <00B8>
 2032 <19> <00DF>
 2033 <1A> <00E6>
 2034 <1B> <0153>
 2035 <1C> <00F8>
 2036 <1D> <00C6>
 2037 <1E> <0152>
 2038 <1F> <00D8>
 2039 <21> <0021>
 2040 <22> <201D>
 2041 <23> <0023>
 2042 <24> <00A3>
 2043 <27> <2019>
 2044 <3C> <00A1>
 2045 <3D> <003D>
 2046 <3E> <00BF>
 2047 <5C> <201C>
 2048 <5F> <02D9>
 2049 <60> <2018>
 2050 <7D> <02DD>
 2051 <7E> <007E>
 2052 <7F> <00A8>
 2053 endbfchar
 2054 endcmap
 2055 CMapName currentdict /CMap defineresource pop
 2056 end
 2057 end
 2058 %%EndResource
 2059 %%EOF
 2060     }\endgroup
 2061   \expandafter\edef\csname cmapOT1IT\endcsname#1{%
 2062     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
 2063   }%
 2064 %
 2065 % \cmapOT1TT
 2066   \begingroup
 2067     \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
 2068     \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
 2069 %%DocumentNeededResources: ProcSet (CIDInit)
 2070 %%IncludeResource: ProcSet (CIDInit)
 2071 %%BeginResource: CMap (TeX-OT1TT-0)
 2072 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
 2073 %%Version: 1.000
 2074 %%EndComments
 2075 /CIDInit /ProcSet findresource begin
 2076 12 dict begin
 2077 begincmap
 2078 /CIDSystemInfo
 2079 << /Registry (TeX)
 2080 /Ordering (OT1TT)
 2081 /Supplement 0
 2082 >> def
 2083 /CMapName /TeX-OT1TT-0 def
 2084 /CMapType 2 def
 2085 1 begincodespacerange
 2086 <00> <7F>
 2087 endcodespacerange
 2088 5 beginbfrange
 2089 <00> <01> <0393>
 2090 <09> <0A> <03A8>
 2091 <21> <26> <0021>
 2092 <28> <5F> <0028>
 2093 <61> <7E> <0061>
 2094 endbfrange
 2095 32 beginbfchar
 2096 <02> <0398>
 2097 <03> <039B>
 2098 <04> <039E>
 2099 <05> <03A0>
 2100 <06> <03A3>
 2101 <07> <03D2>
 2102 <08> <03A6>
 2103 <0B> <2191>
 2104 <0C> <2193>
 2105 <0D> <0027>
 2106 <0E> <00A1>
 2107 <0F> <00BF>
 2108 <10> <0131>
 2109 <11> <0237>
 2110 <12> <0060>
 2111 <13> <00B4>
 2112 <14> <02C7>
 2113 <15> <02D8>
 2114 <16> <00AF>
 2115 <17> <02DA>
 2116 <18> <00B8>
 2117 <19> <00DF>
 2118 <1A> <00E6>
 2119 <1B> <0153>
 2120 <1C> <00F8>
 2121 <1D> <00C6>
 2122 <1E> <0152>
 2123 <1F> <00D8>
 2124 <20> <2423>
 2125 <27> <2019>
 2126 <60> <2018>
 2127 <7F> <00A8>
 2128 endbfchar
 2129 endcmap
 2130 CMapName currentdict /CMap defineresource pop
 2131 end
 2132 end
 2133 %%EndResource
 2134 %%EOF
 2135     }\endgroup
 2136   \expandafter\edef\csname cmapOT1TT\endcsname#1{%
 2137     \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
 2138   }%
 2139 \fi\fi
 2140 
 2141 
 2142 % Set the font macro #1 to the font named \fontprefix#2.
 2143 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
 2144 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
 2145 % Example:
 2146 % #1 = \textrm
 2147 % #2 = \rmshape
 2148 % #3 = 10
 2149 % #4 = \mainmagstep
 2150 % #5 = OT1
 2151 %
 2152 \def\setfont#1#2#3#4#5{%
 2153   \font#1=\fontprefix#2#3 scaled #4
 2154   \csname cmap#5\endcsname#1%
 2155 }
 2156 % This is what gets called when #5 of \setfont is empty.
 2157 \let\cmap\gobble
 2158 %
 2159 % (end of cmaps)
 2160 
 2161 % Use cm as the default font prefix.
 2162 % To specify the font prefix, you must define \fontprefix
 2163 % before you read in texinfo.tex.
 2164 \ifx\fontprefix\thisisundefined
 2165 \def\fontprefix{cm}
 2166 \fi
 2167 % Support font families that don't use the same naming scheme as CM.
 2168 \def\rmshape{r}
 2169 \def\rmbshape{bx}               % where the normal face is bold
 2170 \def\bfshape{b}
 2171 \def\bxshape{bx}
 2172 \def\ttshape{tt}
 2173 \def\ttbshape{tt}
 2174 \def\ttslshape{sltt}
 2175 \def\itshape{ti}
 2176 \def\itbshape{bxti}
 2177 \def\slshape{sl}
 2178 \def\slbshape{bxsl}
 2179 \def\sfshape{ss}
 2180 \def\sfbshape{ss}
 2181 \def\scshape{csc}
 2182 \def\scbshape{csc}
 2183 
 2184 % Definitions for a main text size of 11pt.  (The default in Texinfo.)
 2185 %
 2186 \def\definetextfontsizexi{%
 2187 % Text fonts (11.2pt, magstep1).
 2188 \def\textnominalsize{11pt}
 2189 \edef\mainmagstep{\magstephalf}
 2190 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
 2191 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
 2192 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
 2193 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
 2194 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
 2195 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
 2196 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
 2197 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
 2198 \font\texti=cmmi10 scaled \mainmagstep
 2199 \font\textsy=cmsy10 scaled \mainmagstep
 2200 \def\textecsize{1095}
 2201 
 2202 % A few fonts for @defun names and args.
 2203 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
 2204 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
 2205 \setfont\defsl\slshape{10}{\magstep1}{OT1TT}
 2206 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
 2207 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
 2208 \let\ttslfont=\defttsl \let\slfont=\defsl \bf}
 2209 
 2210 % Fonts for indices, footnotes, small examples (9pt).
 2211 \def\smallnominalsize{9pt}
 2212 \setfont\smallrm\rmshape{9}{1000}{OT1}
 2213 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
 2214 \setfont\smallbf\bfshape{10}{900}{OT1}
 2215 \setfont\smallit\itshape{9}{1000}{OT1IT}
 2216 \setfont\smallsl\slshape{9}{1000}{OT1}
 2217 \setfont\smallsf\sfshape{9}{1000}{OT1}
 2218 \setfont\smallsc\scshape{10}{900}{OT1}
 2219 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
 2220 \font\smalli=cmmi9
 2221 \font\smallsy=cmsy9
 2222 \def\smallecsize{0900}
 2223 
 2224 % Fonts for small examples (8pt).
 2225 \def\smallernominalsize{8pt}
 2226 \setfont\smallerrm\rmshape{8}{1000}{OT1}
 2227 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
 2228 \setfont\smallerbf\bfshape{10}{800}{OT1}
 2229 \setfont\smallerit\itshape{8}{1000}{OT1IT}
 2230 \setfont\smallersl\slshape{8}{1000}{OT1}
 2231 \setfont\smallersf\sfshape{8}{1000}{OT1}
 2232 \setfont\smallersc\scshape{10}{800}{OT1}
 2233 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
 2234 \font\smalleri=cmmi8
 2235 \font\smallersy=cmsy8
 2236 \def\smallerecsize{0800}
 2237 
 2238 % Fonts for math mode superscripts (7pt).
 2239 \def\sevennominalsize{7pt}
 2240 \setfont\sevenrm\rmshape{7}{1000}{OT1}
 2241 \setfont\seventt\ttshape{10}{700}{OT1TT}
 2242 \setfont\sevenbf\bfshape{10}{700}{OT1}
 2243 \setfont\sevenit\itshape{7}{1000}{OT1IT}
 2244 \setfont\sevensl\slshape{10}{700}{OT1}
 2245 \setfont\sevensf\sfshape{10}{700}{OT1}
 2246 \setfont\sevensc\scshape{10}{700}{OT1}
 2247 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
 2248 \font\seveni=cmmi7
 2249 \font\sevensy=cmsy7
 2250 \def\sevenecsize{0700}
 2251 
 2252 % Fonts for title page (20.4pt):
 2253 \def\titlenominalsize{20pt}
 2254 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
 2255 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
 2256 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
 2257 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
 2258 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
 2259 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
 2260 \let\titlebf=\titlerm
 2261 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
 2262 \font\titlei=cmmi12 scaled \magstep3
 2263 \font\titlesy=cmsy10 scaled \magstep4
 2264 \def\titleecsize{2074}
 2265 
 2266 % Chapter (and unnumbered) fonts (17.28pt).
 2267 \def\chapnominalsize{17pt}
 2268 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
 2269 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
 2270 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
 2271 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
 2272 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
 2273 \setfont\chapsf\sfbshape{17}{1000}{OT1}
 2274 \let\chapbf=\chaprm
 2275 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
 2276 \font\chapi=cmmi12 scaled \magstep2
 2277 \font\chapsy=cmsy10 scaled \magstep3
 2278 \def\chapecsize{1728}
 2279 
 2280 % Section fonts (14.4pt).
 2281 \def\secnominalsize{14pt}
 2282 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
 2283 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
 2284 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
 2285 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
 2286 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
 2287 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
 2288 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
 2289 \let\secbf\secrm
 2290 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
 2291 \font\seci=cmmi12 scaled \magstep1
 2292 \font\secsy=cmsy10 scaled \magstep2
 2293 \def\sececsize{1440}
 2294 
 2295 % Subsection fonts (13.15pt).
 2296 \def\ssecnominalsize{13pt}
 2297 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
 2298 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
 2299 \setfont\ssecsl\slbshape{10}{1315}{OT1}
 2300 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
 2301 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
 2302 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
 2303 \let\ssecbf\ssecrm
 2304 \setfont\ssecsc\scbshape{10}{1315}{OT1}
 2305 \font\sseci=cmmi12 scaled \magstephalf
 2306 \font\ssecsy=cmsy10 scaled 1315
 2307 \def\ssececsize{1200}
 2308 
 2309 % Reduced fonts for @acronym in text (10pt).
 2310 \def\reducednominalsize{10pt}
 2311 \setfont\reducedrm\rmshape{10}{1000}{OT1}
 2312 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
 2313 \setfont\reducedbf\bfshape{10}{1000}{OT1}
 2314 \setfont\reducedit\itshape{10}{1000}{OT1IT}
 2315 \setfont\reducedsl\slshape{10}{1000}{OT1}
 2316 \setfont\reducedsf\sfshape{10}{1000}{OT1}
 2317 \setfont\reducedsc\scshape{10}{1000}{OT1}
 2318 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
 2319 \font\reducedi=cmmi10
 2320 \font\reducedsy=cmsy10
 2321 \def\reducedecsize{1000}
 2322 
 2323 \textleading = 13.2pt % line spacing for 11pt CM
 2324 \textfonts            % reset the current fonts
 2325 \rm
 2326 } % end of 11pt text font size definitions, \definetextfontsizexi
 2327 
 2328 
 2329 % Definitions to make the main text be 10pt Computer Modern, with
 2330 % section, chapter, etc., sizes following suit.  This is for the GNU
 2331 % Press printing of the Emacs 22 manual.  Maybe other manuals in the
 2332 % future.  Used with @smallbook, which sets the leading to 12pt.
 2333 %
 2334 \def\definetextfontsizex{%
 2335 % Text fonts (10pt).
 2336 \def\textnominalsize{10pt}
 2337 \edef\mainmagstep{1000}
 2338 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
 2339 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
 2340 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
 2341 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
 2342 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
 2343 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
 2344 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
 2345 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
 2346 \font\texti=cmmi10 scaled \mainmagstep
 2347 \font\textsy=cmsy10 scaled \mainmagstep
 2348 \def\textecsize{1000}
 2349 
 2350 % A few fonts for @defun names and args.
 2351 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
 2352 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
 2353 \setfont\defsl\slshape{10}{\magstephalf}{OT1TT}
 2354 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
 2355 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
 2356 \let\slfont=\defsl \let\ttslfont=\defttsl \bf}
 2357 
 2358 % Fonts for indices, footnotes, small examples (9pt).
 2359 \def\smallnominalsize{9pt}
 2360 \setfont\smallrm\rmshape{9}{1000}{OT1}
 2361 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
 2362 \setfont\smallbf\bfshape{10}{900}{OT1}
 2363 \setfont\smallit\itshape{9}{1000}{OT1IT}
 2364 \setfont\smallsl\slshape{9}{1000}{OT1}
 2365 \setfont\smallsf\sfshape{9}{1000}{OT1}
 2366 \setfont\smallsc\scshape{10}{900}{OT1}
 2367 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
 2368 \font\smalli=cmmi9
 2369 \font\smallsy=cmsy9
 2370 \def\smallecsize{0900}
 2371 
 2372 % Fonts for small examples (8pt).
 2373 \def\smallernominalsize{8pt}
 2374 \setfont\smallerrm\rmshape{8}{1000}{OT1}
 2375 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
 2376 \setfont\smallerbf\bfshape{10}{800}{OT1}
 2377 \setfont\smallerit\itshape{8}{1000}{OT1IT}
 2378 \setfont\smallersl\slshape{8}{1000}{OT1}
 2379 \setfont\smallersf\sfshape{8}{1000}{OT1}
 2380 \setfont\smallersc\scshape{10}{800}{OT1}
 2381 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
 2382 \font\smalleri=cmmi8
 2383 \font\smallersy=cmsy8
 2384 \def\smallerecsize{0800}
 2385 
 2386 % Fonts for math mode superscripts (7pt).
 2387 \def\sevennominalsize{7pt}
 2388 \setfont\sevenrm\rmshape{7}{1000}{OT1}
 2389 \setfont\seventt\ttshape{10}{700}{OT1TT}
 2390 \setfont\sevenbf\bfshape{10}{700}{OT1}
 2391 \setfont\sevenit\itshape{7}{1000}{OT1IT}
 2392 \setfont\sevensl\slshape{10}{700}{OT1}
 2393 \setfont\sevensf\sfshape{10}{700}{OT1}
 2394 \setfont\sevensc\scshape{10}{700}{OT1}
 2395 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
 2396 \font\seveni=cmmi7
 2397 \font\sevensy=cmsy7
 2398 \def\sevenecsize{0700}
 2399 
 2400 % Fonts for title page (20.4pt):
 2401 \def\titlenominalsize{20pt}
 2402 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
 2403 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
 2404 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
 2405 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
 2406 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
 2407 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
 2408 \let\titlebf=\titlerm
 2409 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
 2410 \font\titlei=cmmi12 scaled \magstep3
 2411 \font\titlesy=cmsy10 scaled \magstep4
 2412 \def\titleecsize{2074}
 2413 
 2414 % Chapter fonts (14.4pt).
 2415 \def\chapnominalsize{14pt}
 2416 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
 2417 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
 2418 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
 2419 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
 2420 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
 2421 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
 2422 \let\chapbf\chaprm
 2423 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
 2424 \font\chapi=cmmi12 scaled \magstep1
 2425 \font\chapsy=cmsy10 scaled \magstep2
 2426 \def\chapecsize{1440}
 2427 
 2428 % Section fonts (12pt).
 2429 \def\secnominalsize{12pt}
 2430 \setfont\secrm\rmbshape{12}{1000}{OT1}
 2431 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
 2432 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
 2433 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
 2434 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
 2435 \setfont\secsf\sfbshape{12}{1000}{OT1}
 2436 \let\secbf\secrm
 2437 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
 2438 \font\seci=cmmi12
 2439 \font\secsy=cmsy10 scaled \magstep1
 2440 \def\sececsize{1200}
 2441 
 2442 % Subsection fonts (10pt).
 2443 \def\ssecnominalsize{10pt}
 2444 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
 2445 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
 2446 \setfont\ssecsl\slbshape{10}{1000}{OT1}
 2447 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
 2448 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
 2449 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
 2450 \let\ssecbf\ssecrm
 2451 \setfont\ssecsc\scbshape{10}{1000}{OT1}
 2452 \font\sseci=cmmi10
 2453 \font\ssecsy=cmsy10
 2454 \def\ssececsize{1000}
 2455 
 2456 % Reduced fonts for @acronym in text (9pt).
 2457 \def\reducednominalsize{9pt}
 2458 \setfont\reducedrm\rmshape{9}{1000}{OT1}
 2459 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
 2460 \setfont\reducedbf\bfshape{10}{900}{OT1}
 2461 \setfont\reducedit\itshape{9}{1000}{OT1IT}
 2462 \setfont\reducedsl\slshape{9}{1000}{OT1}
 2463 \setfont\reducedsf\sfshape{9}{1000}{OT1}
 2464 \setfont\reducedsc\scshape{10}{900}{OT1}
 2465 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
 2466 \font\reducedi=cmmi9
 2467 \font\reducedsy=cmsy9
 2468 \def\reducedecsize{0900}
 2469 
 2470 \divide\parskip by 2  % reduce space between paragraphs
 2471 \textleading = 12pt   % line spacing for 10pt CM
 2472 \textfonts            % reset the current fonts
 2473 \rm
 2474 } % end of 10pt text font size definitions, \definetextfontsizex
 2475 
 2476 % Fonts for short table of contents.
 2477 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
 2478 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1}  % no cmb12
 2479 \setfont\shortcontsl\slshape{12}{1000}{OT1}
 2480 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
 2481 
 2482 
 2483 % We provide the user-level command
 2484 %   @fonttextsize 10
 2485 % (or 11) to redefine the text font size.  pt is assumed.
 2486 %
 2487 \def\xiword{11}
 2488 \def\xword{10}
 2489 \def\xwordpt{10pt}
 2490 %
 2491 \parseargdef\fonttextsize{%
 2492   \def\textsizearg{#1}%
 2493   %\wlog{doing @fonttextsize \textsizearg}%
 2494   %
 2495   % Set \globaldefs so that documents can use this inside @tex, since
 2496   % makeinfo 4.8 does not support it, but we need it nonetheless.
 2497   %
 2498  \begingroup \globaldefs=1
 2499   \ifx\textsizearg\xword \definetextfontsizex
 2500   \else \ifx\textsizearg\xiword \definetextfontsizexi
 2501   \else
 2502     \errhelp=\EMsimple
 2503     \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
 2504   \fi\fi
 2505  \endgroup
 2506 }
 2507 
 2508 %
 2509 % Change the current font style to #1, remembering it in \curfontstyle.
 2510 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
 2511 % italics, not bold italics.
 2512 %
 2513 \def\setfontstyle#1{%
 2514   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
 2515   \csname #1font\endcsname  % change the current font
 2516 }
 2517 
 2518 \def\rm{\fam=0 \setfontstyle{rm}}
 2519 \def\it{\fam=\itfam \setfontstyle{it}}
 2520 \def\sl{\fam=\slfam \setfontstyle{sl}}
 2521 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
 2522 \def\tt{\fam=\ttfam \setfontstyle{tt}}
 2523 
 2524 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
 2525 % So we set up a \sf.
 2526 \newfam\sffam
 2527 \def\sf{\fam=\sffam \setfontstyle{sf}}
 2528 
 2529 % We don't need math for this font style.
 2530 \def\ttsl{\setfontstyle{ttsl}}
 2531 
 2532 
 2533 % In order for the font changes to affect most math symbols and letters,
 2534 % we have to define the \textfont of the standard families.
 2535 % We don't bother to reset \scriptscriptfont; awaiting user need.
 2536 %
 2537 \def\resetmathfonts{%
 2538   \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
 2539   \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
 2540   \textfont\ttfam=\ttfont \textfont\sffam=\sffont
 2541   %
 2542   % Fonts for superscript.  Note that the 7pt fonts are used regardless
 2543   % of the current font size.
 2544   \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
 2545   \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
 2546   \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
 2547   \scriptfont\sffam=\sevensf
 2548 }
 2549 
 2550 %
 2551 
 2552 % The font-changing commands (all called \...fonts) redefine the meanings
 2553 % of \STYLEfont, instead of just \STYLE.  We do this because \STYLE needs
 2554 % to also set the current \fam for math mode.  Our \STYLE (e.g., \rm)
 2555 % commands hardwire \STYLEfont to set the current font.
 2556 %
 2557 % The fonts used for \ifont are for "math italics"  (\itfont is for italics
 2558 % in regular text).  \syfont is also used in math mode only.
 2559 %
 2560 % Each font-changing command also sets the names \lsize (one size lower)
 2561 % and \lllsize (three sizes lower).  These relative commands are used
 2562 % in, e.g., the LaTeX logo and acronyms.
 2563 %
 2564 % This all needs generalizing, badly.
 2565 %
 2566 
 2567 \def\assignfonts#1{%
 2568   \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
 2569   \expandafter\let\expandafter\itfont\csname #1it\endcsname
 2570   \expandafter\let\expandafter\slfont\csname #1sl\endcsname
 2571   \expandafter\let\expandafter\bffont\csname #1bf\endcsname
 2572   \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
 2573   \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
 2574   \expandafter\let\expandafter\sffont  \csname #1sf\endcsname
 2575   \expandafter\let\expandafter\ifont   \csname #1i\endcsname
 2576   \expandafter\let\expandafter\syfont  \csname #1sy\endcsname
 2577   \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
 2578 }
 2579 
 2580 \newif\ifrmisbold
 2581 
 2582 % Select smaller font size with the current style.  Used to change font size
 2583 % in, e.g., the LaTeX logo and acronyms.  If we are using bold fonts for
 2584 % normal roman text, also use bold fonts for roman text in the smaller size.
 2585 \def\switchtolllsize{%
 2586    \expandafter\assignfonts\expandafter{\lllsize}%
 2587    \ifrmisbold
 2588      \let\rmfont\bffont
 2589    \fi
 2590    \csname\curfontstyle\endcsname
 2591 }%
 2592 
 2593 \def\switchtolsize{%
 2594    \expandafter\assignfonts\expandafter{\lsize}%
 2595    \ifrmisbold
 2596      \let\rmfont\bffont
 2597    \fi
 2598    \csname\curfontstyle\endcsname
 2599 }%
 2600 
 2601 \def\definefontsetatsize#1#2#3#4#5{%
 2602 \expandafter\def\csname #1fonts\endcsname{%
 2603   \def\curfontsize{#1}%
 2604   \def\lsize{#2}\def\lllsize{#3}%
 2605   \csname rmisbold#5\endcsname
 2606   \assignfonts{#1}%
 2607   \resetmathfonts
 2608   \setleading{#4}%
 2609 }}
 2610 
 2611 \definefontsetatsize{text}   {reduced}{smaller}{\textleading}{false}
 2612 \definefontsetatsize{title}  {chap}   {subsec} {27pt}  {true}
 2613 \definefontsetatsize{chap}   {sec}    {text}   {19pt}  {true}
 2614 \definefontsetatsize{sec}    {subsec} {reduced}{17pt}  {true}
 2615 \definefontsetatsize{ssec}   {text}   {small}  {15pt}  {true}
 2616 \definefontsetatsize{reduced}{small}  {smaller}{10.5pt}{false}
 2617 \definefontsetatsize{small}  {smaller}{smaller}{10.5pt}{false}
 2618 \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
 2619 
 2620 \def\titlefont#1{{\titlefonts\rm #1}}
 2621 \let\subsecfonts = \ssecfonts
 2622 \let\subsubsecfonts = \ssecfonts
 2623 
 2624 % Define these just so they can be easily changed for other fonts.
 2625 \def\angleleft{$\langle$}
 2626 \def\angleright{$\rangle$}
 2627 
 2628 % Set the fonts to use with the @small... environments.
 2629 \let\smallexamplefonts = \smallfonts
 2630 
 2631 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
 2632 % can fit this many characters:
 2633 %   8.5x11=86   smallbook=72  a4=90  a5=69
 2634 % If we use \scriptfonts (8pt), then we can fit this many characters:
 2635 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
 2636 % For me, subjectively, the few extra characters that fit aren't worth
 2637 % the additional smallness of 8pt.  So I'm making the default 9pt.
 2638 %
 2639 % By the way, for comparison, here's what fits with @example (10pt):
 2640 %   8.5x11=71  smallbook=60  a4=75  a5=58
 2641 % --karl, 24jan03.
 2642 
 2643 % Set up the default fonts, so we can use them for creating boxes.
 2644 %
 2645 \definetextfontsizexi
 2646 
 2647 
 2648 \message{markup,}
 2649 
 2650 % Check if we are currently using a typewriter font.  Since all the
 2651 % Computer Modern typewriter fonts have zero interword stretch (and
 2652 % shrink), and it is reasonable to expect all typewriter fonts to have
 2653 % this property, we can check that font parameter.
 2654 %
 2655 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
 2656 
 2657 % Markup style infrastructure.  \defmarkupstylesetup\INITMACRO will
 2658 % define and register \INITMACRO to be called on markup style changes.
 2659 % \INITMACRO can check \currentmarkupstyle for the innermost
 2660 % style.
 2661 
 2662 \let\currentmarkupstyle\empty
 2663 
 2664 \def\setupmarkupstyle#1{%
 2665   \def\currentmarkupstyle{#1}%
 2666   \markupstylesetup
 2667 }
 2668 
 2669 \let\markupstylesetup\empty
 2670 
 2671 \def\defmarkupstylesetup#1{%
 2672   \expandafter\def\expandafter\markupstylesetup
 2673     \expandafter{\markupstylesetup #1}%
 2674   \def#1%
 2675 }
 2676 
 2677 % Markup style setup for left and right quotes.
 2678 \defmarkupstylesetup\markupsetuplq{%
 2679   \expandafter\let\expandafter \temp
 2680     \csname markupsetuplq\currentmarkupstyle\endcsname
 2681   \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
 2682 }
 2683 
 2684 \defmarkupstylesetup\markupsetuprq{%
 2685   \expandafter\let\expandafter \temp
 2686     \csname markupsetuprq\currentmarkupstyle\endcsname
 2687   \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
 2688 }
 2689 
 2690 {
 2691 \catcode`\'=\active
 2692 \catcode`\`=\active
 2693 
 2694 \gdef\markupsetuplqdefault{\let`\lq}
 2695 \gdef\markupsetuprqdefault{\let'\rq}
 2696 
 2697 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
 2698 \gdef\markupsetcodequoteright{\let'\codequoteright}
 2699 }
 2700 
 2701 \let\markupsetuplqcode \markupsetcodequoteleft
 2702 \let\markupsetuprqcode \markupsetcodequoteright
 2703 %
 2704 \let\markupsetuplqexample \markupsetcodequoteleft
 2705 \let\markupsetuprqexample \markupsetcodequoteright
 2706 %
 2707 \let\markupsetuplqkbd     \markupsetcodequoteleft
 2708 \let\markupsetuprqkbd     \markupsetcodequoteright
 2709 %
 2710 \let\markupsetuplqsamp \markupsetcodequoteleft
 2711 \let\markupsetuprqsamp \markupsetcodequoteright
 2712 %
 2713 \let\markupsetuplqverb \markupsetcodequoteleft
 2714 \let\markupsetuprqverb \markupsetcodequoteright
 2715 %
 2716 \let\markupsetuplqverbatim \markupsetcodequoteleft
 2717 \let\markupsetuprqverbatim \markupsetcodequoteright
 2718 
 2719 % Allow an option to not use regular directed right quote/apostrophe
 2720 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
 2721 % The undirected quote is ugly, so don't make it the default, but it
 2722 % works for pasting with more pdf viewers (at least evince), the
 2723 % lilypond developers report.  xpdf does work with the regular 0x27.
 2724 %
 2725 \def\codequoteright{%
 2726   \ifmonospace
 2727     \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
 2728       \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
 2729         '%
 2730       \else \char'15 \fi
 2731     \else \char'15 \fi
 2732    \else
 2733      '%
 2734    \fi
 2735 }
 2736 %
 2737 % and a similar option for the left quote char vs. a grave accent.
 2738 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
 2739 % the code environments to do likewise.
 2740 %
 2741 \def\codequoteleft{%
 2742   \ifmonospace
 2743     \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
 2744       \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
 2745         % [Knuth] pp. 380,381,391
 2746         % \relax disables Spanish ligatures ?` and !` of \tt font.
 2747         \relax`%
 2748       \else \char'22 \fi
 2749     \else \char'22 \fi
 2750    \else
 2751      \relax`%
 2752    \fi
 2753 }
 2754 
 2755 % Commands to set the quote options.
 2756 % 
 2757 \parseargdef\codequoteundirected{%
 2758   \def\temp{#1}%
 2759   \ifx\temp\onword
 2760     \expandafter\let\csname SETtxicodequoteundirected\endcsname
 2761       = t%
 2762   \else\ifx\temp\offword
 2763     \expandafter\let\csname SETtxicodequoteundirected\endcsname
 2764       = \relax
 2765   \else
 2766     \errhelp = \EMsimple
 2767     \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
 2768   \fi\fi
 2769 }
 2770 %
 2771 \parseargdef\codequotebacktick{%
 2772   \def\temp{#1}%
 2773   \ifx\temp\onword
 2774     \expandafter\let\csname SETtxicodequotebacktick\endcsname
 2775       = t%
 2776   \else\ifx\temp\offword
 2777     \expandafter\let\csname SETtxicodequotebacktick\endcsname
 2778       = \relax
 2779   \else
 2780     \errhelp = \EMsimple
 2781     \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
 2782   \fi\fi
 2783 }
 2784 
 2785 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
 2786 \def\noligaturesquoteleft{\relax\lq}
 2787 
 2788 % Count depth in font-changes, for error checks
 2789 \newcount\fontdepth \fontdepth=0
 2790 
 2791 % Font commands.
 2792 
 2793 % #1 is the font command (\sl or \it), #2 is the text to slant.
 2794 % If we are in a monospaced environment, however, 1) always use \ttsl,
 2795 % and 2) do not add an italic correction.
 2796 \def\dosmartslant#1#2{%
 2797   \ifusingtt 
 2798     {{\ttsl #2}\let\next=\relax}%
 2799     {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
 2800   \next
 2801 }
 2802 \def\smartslanted{\dosmartslant\sl}
 2803 \def\smartitalic{\dosmartslant\it}
 2804 
 2805 % Output an italic correction unless \next (presumed to be the following
 2806 % character) is such as not to need one.
 2807 \def\smartitaliccorrection{%
 2808   \ifx\next,%
 2809   \else\ifx\next-%
 2810   \else\ifx\next.%
 2811   \else\ifx\next\.%
 2812   \else\ifx\next\comma%
 2813   \else\ptexslash
 2814   \fi\fi\fi\fi\fi
 2815   \aftersmartic
 2816 }
 2817 
 2818 % Unconditional use \ttsl, and no ic.  @var is set to this for defuns.
 2819 \def\ttslanted#1{{\ttsl #1}}
 2820 
 2821 % @cite is like \smartslanted except unconditionally use \sl.  We never want
 2822 % ttsl for book titles, do we?
 2823 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
 2824 
 2825 \def\aftersmartic{}
 2826 \def\var#1{%
 2827   \let\saveaftersmartic = \aftersmartic
 2828   \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
 2829   \smartslanted{#1}%
 2830 }
 2831 
 2832 \let\i=\smartitalic
 2833 \let\slanted=\smartslanted
 2834 \let\dfn=\smartslanted
 2835 \let\emph=\smartitalic
 2836 
 2837 % Explicit font changes: @r, @sc, undocumented @ii.
 2838 \def\r#1{{\rm #1}}              % roman font
 2839 \def\sc#1{{\smallcaps#1}}       % smallcaps font
 2840 \def\ii#1{{\it #1}}             % italic font
 2841 
 2842 % @b, explicit bold.  Also @strong.
 2843 \def\b#1{{\bf #1}}
 2844 \let\strong=\b
 2845 
 2846 % @sansserif, explicit sans.
 2847 \def\sansserif#1{{\sf #1}}
 2848 
 2849 % We can't just use \exhyphenpenalty, because that only has effect at
 2850 % the end of a paragraph.  Restore normal hyphenation at the end of the
 2851 % group within which \nohyphenation is presumably called.
 2852 %
 2853 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
 2854 \def\restorehyphenation{\hyphenchar\font = `- }
 2855 
 2856 % Set sfcode to normal for the chars that usually have another value.
 2857 % Can't use plain's \frenchspacing because it uses the `\x notation, and
 2858 % sometimes \x has an active definition that messes things up.
 2859 %
 2860 \catcode`@=11
 2861   \def\plainfrenchspacing{%
 2862     \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
 2863     \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
 2864     \def\endofsentencespacefactor{1000}% for @. and friends
 2865   }
 2866   \def\plainnonfrenchspacing{%
 2867     \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
 2868     \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
 2869     \def\endofsentencespacefactor{3000}% for @. and friends
 2870   }
 2871 \catcode`@=\other
 2872 \def\endofsentencespacefactor{3000}% default
 2873 
 2874 % @t, explicit typewriter.
 2875 \def\t#1{%
 2876   {\tt \rawbackslash \plainfrenchspacing #1}%
 2877   \null
 2878 }
 2879 
 2880 % @samp.
 2881 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
 2882 
 2883 % @indicateurl is \samp, that is, with quotes.
 2884 \let\indicateurl=\samp
 2885 
 2886 % @code (and similar) prints in typewriter, but with spaces the same
 2887 % size as normal in the surrounding text, without hyphenation, etc.
 2888 % This is a subroutine for that.
 2889 \def\tclose#1{%
 2890   {%
 2891     % Change normal interword space to be same as for the current font.
 2892     \spaceskip = \fontdimen2\font
 2893     %
 2894     % Switch to typewriter.
 2895     \tt
 2896     %
 2897     % But `\ ' produces the large typewriter interword space.
 2898     \def\ {{\spaceskip = 0pt{} }}%
 2899     %
 2900     % Turn off hyphenation.
 2901     \nohyphenation
 2902     %
 2903     \rawbackslash
 2904     \plainfrenchspacing
 2905     #1%
 2906   }%
 2907   \null % reset spacefactor to 1000
 2908 }
 2909 
 2910 % We *must* turn on hyphenation at `-' and `_' in @code.
 2911 % (But see \codedashfinish below.)
 2912 % Otherwise, it is too hard to avoid overfull hboxes
 2913 % in the Emacs manual, the Library manual, etc.
 2914 %
 2915 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
 2916 % both hyphenation at - and hyphenation within words.
 2917 % We must therefore turn them both off (\tclose does that)
 2918 % and arrange explicitly to hyphenate at a dash. -- rms.
 2919 {
 2920   \catcode`\-=\active \catcode`\_=\active
 2921   \catcode`\'=\active \catcode`\`=\active
 2922   \global\let'=\rq \global\let`=\lq  % default definitions
 2923   %
 2924   \global\def\code{\begingroup
 2925     \setupmarkupstyle{code}%
 2926     % The following should really be moved into \setupmarkupstyle handlers.
 2927     \catcode\dashChar=\active  \catcode\underChar=\active
 2928     \ifallowcodebreaks
 2929      \let-\codedash
 2930      \let_\codeunder
 2931     \else
 2932      \let-\normaldash
 2933      \let_\realunder
 2934     \fi
 2935     % Given -foo (with a single dash), we do not want to allow a break
 2936     % after the hyphen.
 2937     \global\let\codedashprev=\codedash
 2938     %
 2939     \codex
 2940   }
 2941   %
 2942   \gdef\codedash{\futurelet\next\codedashfinish}
 2943   \gdef\codedashfinish{%
 2944     \normaldash % always output the dash character itself.
 2945     % 
 2946     % Now, output a discretionary to allow a line break, unless
 2947     % (a) the next character is a -, or
 2948     % (b) the preceding character is a -.
 2949     % E.g., given --posix, we do not want to allow a break after either -.
 2950     % Given --foo-bar, we do want to allow a break between the - and the b.
 2951     \ifx\next\codedash \else
 2952       \ifx\codedashprev\codedash 
 2953       \else \discretionary{}{}{}\fi
 2954     \fi
 2955     % we need the space after the = for the case when \next itself is a
 2956     % space token; it would get swallowed otherwise.  As in @code{- a}.
 2957     \global\let\codedashprev= \next
 2958   }
 2959 }
 2960 \def\normaldash{-}
 2961 %
 2962 \def\codex #1{\tclose{#1}\endgroup}
 2963 
 2964 \def\codeunder{%
 2965   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
 2966   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
 2967   % will therefore expand the active definition of _, which is us
 2968   % (inside @code that is), therefore an endless loop.
 2969   \ifusingtt{\ifmmode
 2970                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
 2971              \else\normalunderscore \fi
 2972              \discretionary{}{}{}}%
 2973             {\_}%
 2974 }
 2975 
 2976 % An additional complication: the above will allow breaks after, e.g.,
 2977 % each of the four underscores in __typeof__.  This is bad.
 2978 % @allowcodebreaks provides a document-level way to turn breaking at -
 2979 % and _ on and off.
 2980 %
 2981 \newif\ifallowcodebreaks  \allowcodebreakstrue
 2982 
 2983 \def\keywordtrue{true}
 2984 \def\keywordfalse{false}
 2985 
 2986 \parseargdef\allowcodebreaks{%
 2987   \def\txiarg{#1}%
 2988   \ifx\txiarg\keywordtrue
 2989     \allowcodebreakstrue
 2990   \else\ifx\txiarg\keywordfalse
 2991     \allowcodebreaksfalse
 2992   \else
 2993     \errhelp = \EMsimple
 2994     \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
 2995   \fi\fi
 2996 }
 2997 
 2998 % For @command, @env, @file, @option quotes seem unnecessary,
 2999 % so use \code rather than \samp.
 3000 \let\command=\code
 3001 \let\env=\code
 3002 \let\file=\code
 3003 \let\option=\code
 3004 
 3005 % @uref (abbreviation for `urlref') aka @url takes an optional
 3006 % (comma-separated) second argument specifying the text to display and
 3007 % an optional third arg as text to display instead of (rather than in
 3008 % addition to) the url itself.  First (mandatory) arg is the url.
 3009 
 3010 % TeX-only option to allow changing PDF output to show only the second
 3011 % arg (if given), and not the url (which is then just the link target).
 3012 \newif\ifurefurlonlylink
 3013 
 3014 % The main macro is \urefbreak, which allows breaking at expected
 3015 % places within the url.  (There used to be another version, which
 3016 % didn't support automatic breaking.)
 3017 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
 3018 \let\uref=\urefbreak
 3019 %
 3020 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
 3021 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
 3022   \unsepspaces
 3023   \pdfurl{#1}%
 3024   \setbox0 = \hbox{\ignorespaces #3}%
 3025   \ifdim\wd0 > 0pt
 3026     \unhbox0 % third arg given, show only that
 3027   \else
 3028     \setbox0 = \hbox{\ignorespaces #2}% look for second arg
 3029     \ifdim\wd0 > 0pt
 3030       \ifpdf
 3031         % For pdfTeX and LuaTeX
 3032         \ifurefurlonlylink
 3033           % PDF plus option to not display url, show just arg
 3034           \unhbox0             
 3035         \else
 3036           % PDF, normally display both arg and url for consistency,
 3037           % visibility, if the pdf is eventually used to print, etc.
 3038           \unhbox0\ (\urefcode{#1})%
 3039         \fi
 3040       \else
 3041         \ifx\XeTeXrevision\thisisundefined
 3042           \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
 3043         \else
 3044           % For XeTeX
 3045           \ifurefurlonlylink
 3046             % PDF plus option to not display url, show just arg
 3047             \unhbox0             
 3048           \else
 3049             % PDF, normally display both arg and url for consistency,
 3050             % visibility, if the pdf is eventually used to print, etc.
 3051             \unhbox0\ (\urefcode{#1})%
 3052           \fi
 3053         \fi
 3054       \fi
 3055     \else
 3056       \urefcode{#1}% only url given, so show it
 3057     \fi
 3058   \fi
 3059   \endlink
 3060 \endgroup}
 3061 
 3062 % Allow line breaks around only a few characters (only).
 3063 \def\urefcatcodes{%
 3064   \catcode`\&=\active \catcode`\.=\active
 3065   \catcode`\#=\active \catcode`\?=\active
 3066   \catcode`\/=\active
 3067 }
 3068 {
 3069   \urefcatcodes
 3070   %
 3071   \global\def\urefcode{\begingroup
 3072     \setupmarkupstyle{code}%
 3073     \urefcatcodes
 3074     \let&\urefcodeamp
 3075     \let.\urefcodedot
 3076     \let#\urefcodehash
 3077     \let?\urefcodequest
 3078     \let/\urefcodeslash
 3079     \codex
 3080   }
 3081   %
 3082   % By default, they are just regular characters.
 3083   \global\def&{\normalamp}
 3084   \global\def.{\normaldot}
 3085   \global\def#{\normalhash}
 3086   \global\def?{\normalquest}
 3087   \global\def/{\normalslash}
 3088 }
 3089 
 3090 % we put a little stretch before and after the breakable chars, to help
 3091 % line breaking of long url's.  The unequal skips make look better in
 3092 % cmtt at least, especially for dots.
 3093 \def\urefprestretchamount{.13em}
 3094 \def\urefpoststretchamount{.1em}
 3095 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
 3096 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
 3097 %
 3098 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
 3099 \def\urefcodedot{\urefprestretch .\urefpoststretch}
 3100 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
 3101 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
 3102 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
 3103 {
 3104   \catcode`\/=\active
 3105   \global\def\urefcodeslashfinish{%
 3106     \urefprestretch \slashChar
 3107     % Allow line break only after the final / in a sequence of
 3108     % slashes, to avoid line break between the slashes in http://.
 3109     \ifx\next/\else \urefpoststretch \fi
 3110   }
 3111 }
 3112 
 3113 % One more complication: by default we'll break after the special
 3114 % characters, but some people like to break before the special chars, so
 3115 % allow that.  Also allow no breaking at all, for manual control.
 3116 % 
 3117 \parseargdef\urefbreakstyle{%
 3118   \def\txiarg{#1}%
 3119   \ifx\txiarg\wordnone
 3120     \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
 3121   \else\ifx\txiarg\wordbefore
 3122     \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
 3123   \else\ifx\txiarg\wordafter
 3124     \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
 3125   \else
 3126     \errhelp = \EMsimple
 3127     \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
 3128   \fi\fi\fi
 3129 }
 3130 \def\wordafter{after}
 3131 \def\wordbefore{before}
 3132 \def\wordnone{none}
 3133 
 3134 \urefbreakstyle after
 3135 
 3136 % @url synonym for @uref, since that's how everyone uses it.
 3137 %
 3138 \let\url=\uref
 3139 
 3140 % rms does not like angle brackets --karl, 17may97.
 3141 % So now @email is just like @uref, unless we are pdf.
 3142 %
 3143 %\def\email#1{\angleleft{\tt #1}\angleright}
 3144 \ifpdf
 3145   \def\email#1{\doemail#1,,\finish}
 3146   \def\doemail#1,#2,#3\finish{\begingroup
 3147     \unsepspaces
 3148     \pdfurl{mailto:#1}%
 3149     \setbox0 = \hbox{\ignorespaces #2}%
 3150     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
 3151     \endlink
 3152   \endgroup}
 3153 \else
 3154   \ifx\XeTeXrevision\thisisundefined
 3155     \let\email=\uref
 3156   \else
 3157     \def\email#1{\doemail#1,,\finish}
 3158     \def\doemail#1,#2,#3\finish{\begingroup
 3159       \unsepspaces
 3160       \pdfurl{mailto:#1}%
 3161       \setbox0 = \hbox{\ignorespaces #2}%
 3162       \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
 3163       \endlink
 3164     \endgroup}
 3165   \fi
 3166 \fi
 3167 
 3168 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
 3169 %   `example' (@kbd uses ttsl only inside of @example and friends),
 3170 %   or `code' (@kbd uses normal tty font always).
 3171 \parseargdef\kbdinputstyle{%
 3172   \def\txiarg{#1}%
 3173   \ifx\txiarg\worddistinct
 3174     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
 3175   \else\ifx\txiarg\wordexample
 3176     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
 3177   \else\ifx\txiarg\wordcode
 3178     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
 3179   \else
 3180     \errhelp = \EMsimple
 3181     \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
 3182   \fi\fi\fi
 3183 }
 3184 \def\worddistinct{distinct}
 3185 \def\wordexample{example}
 3186 \def\wordcode{code}
 3187 
 3188 % Default is `distinct'.
 3189 \kbdinputstyle distinct
 3190 
 3191 % @kbd is like @code, except that if the argument is just one @key command,
 3192 % then @kbd has no effect.
 3193 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
 3194 
 3195 \def\xkey{\key}
 3196 \def\kbdsub#1#2#3\par{%
 3197   \def\one{#1}\def\three{#3}\def\threex{??}%
 3198   \ifx\one\xkey\ifx\threex\three \key{#2}%
 3199   \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
 3200   \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
 3201 }
 3202 
 3203 % definition of @key that produces a lozenge.  Doesn't adjust to text size.
 3204 %\setfont\keyrm\rmshape{8}{1000}{OT1}
 3205 %\font\keysy=cmsy9
 3206 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
 3207 %  \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
 3208 %    \vbox{\hrule\kern-0.4pt
 3209 %     \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
 3210 %    \kern-0.4pt\hrule}%
 3211 %  \kern-.06em\raise0.4pt\hbox{\angleright}}}}
 3212 
 3213 % definition of @key with no lozenge.  If the current font is already
 3214 % monospace, don't change it; that way, we respect @kbdinputstyle.  But
 3215 % if it isn't monospace, then use \tt.
 3216 %
 3217 \def\key#1{{\setupmarkupstyle{key}%
 3218   \nohyphenation
 3219   \ifmonospace\else\tt\fi
 3220   #1}\null}
 3221 
 3222 % @clicksequence{File @click{} Open ...}
 3223 \def\clicksequence#1{\begingroup #1\endgroup}
 3224 
 3225 % @clickstyle @arrow   (by default)
 3226 \parseargdef\clickstyle{\def\click{#1}}
 3227 \def\click{\arrow}
 3228 
 3229 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
 3230 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
 3231 %
 3232 \def\dmn#1{\thinspace #1}
 3233 
 3234 % @acronym for "FBI", "NATO", and the like.
 3235 % We print this one point size smaller, since it's intended for
 3236 % all-uppercase.
 3237 %
 3238 \def\acronym#1{\doacronym #1,,\finish}
 3239 \def\doacronym#1,#2,#3\finish{%
 3240   {\switchtolsize #1}%
 3241   \def\temp{#2}%
 3242   \ifx\temp\empty \else
 3243     \space ({\unsepspaces \ignorespaces \temp \unskip})%
 3244   \fi
 3245   \null % reset \spacefactor=1000
 3246 }
 3247 
 3248 % @abbr for "Comput. J." and the like.
 3249 % No font change, but don't do end-of-sentence spacing.
 3250 %
 3251 \def\abbr#1{\doabbr #1,,\finish}
 3252 \def\doabbr#1,#2,#3\finish{%
 3253   {\plainfrenchspacing #1}%
 3254   \def\temp{#2}%
 3255   \ifx\temp\empty \else
 3256     \space ({\unsepspaces \ignorespaces \temp \unskip})%
 3257   \fi
 3258   \null % reset \spacefactor=1000
 3259 }
 3260 
 3261 % @asis just yields its argument.  Used with @table, for example.
 3262 %
 3263 \def\asis#1{#1}
 3264 
 3265 % @math outputs its argument in math mode.
 3266 %
 3267 % One complication: _ usually means subscripts, but it could also mean
 3268 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
 3269 % _ active, and distinguish by seeing if the current family is \slfam,
 3270 % which is what @var uses.
 3271 {
 3272   \catcode`\_ = \active
 3273   \gdef\mathunderscore{%
 3274     \catcode`\_=\active
 3275     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
 3276   }
 3277 }
 3278 % Another complication: we want \\ (and @\) to output a math (or tt) \.
 3279 % FYI, plain.tex uses \\ as a temporary control sequence (for no
 3280 % particular reason), but this is not advertised and we don't care.
 3281 %
 3282 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
 3283 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
 3284 %
 3285 \def\math{%
 3286   \ifmmode\else % only go into math if not in math mode already
 3287     \tex
 3288     \mathunderscore
 3289     \let\\ = \mathbackslash
 3290     \mathactive
 3291     % make the texinfo accent commands work in math mode
 3292     \let\"=\ddot
 3293     \let\'=\acute
 3294     \let\==\bar
 3295     \let\^=\hat
 3296     \let\`=\grave
 3297     \let\u=\breve
 3298     \let\v=\check
 3299     \let\~=\tilde
 3300     \let\dotaccent=\dot
 3301     % have to provide another name for sup operator
 3302     \let\mathopsup=\sup
 3303   $\expandafter\finishmath\fi
 3304 }
 3305 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
 3306 
 3307 % Some active characters (such as <) are spaced differently in math.
 3308 % We have to reset their definitions in case the @math was an argument
 3309 % to a command which sets the catcodes (such as @item or @section).
 3310 %
 3311 {
 3312   \catcode`^ = \active
 3313   \catcode`< = \active
 3314   \catcode`> = \active
 3315   \catcode`+ = \active
 3316   \catcode`' = \active
 3317   \gdef\mathactive{%
 3318     \let^ = \ptexhat
 3319     \let< = \ptexless
 3320     \let> = \ptexgtr
 3321     \let+ = \ptexplus
 3322     \let' = \ptexquoteright
 3323   }
 3324 }
 3325 
 3326 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
 3327 % If in text, use math to place as sub/superscript, but switch
 3328 % into text mode, with smaller fonts.  This is a different font than the
 3329 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
 3330 % fix it (significant additions to font machinery) until someone notices.
 3331 %
 3332 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
 3333 \def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
 3334 %
 3335 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
 3336 \def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
 3337 
 3338 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
 3339 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
 3340 % except specified as a normal braced arg, so no newlines to worry about.
 3341 % 
 3342 \def\outfmtnametex{tex}
 3343 %
 3344 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
 3345 \long\def\doinlinefmt#1,#2,\finish{%
 3346   \def\inlinefmtname{#1}%
 3347   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
 3348 }
 3349 % 
 3350 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
 3351 % FMTNAME is tex, else ELSE-TEXT.
 3352 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
 3353 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
 3354   \def\inlinefmtname{#1}%
 3355   \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
 3356 }
 3357 %
 3358 % For raw, must switch into @tex before parsing the argument, to avoid
 3359 % setting catcodes prematurely.  Doing it this way means that, for
 3360 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
 3361 % ignored.  But this isn't important because if people want a literal
 3362 % *right* brace they would have to use a command anyway, so they may as
 3363 % well use a command to get a left brace too.  We could re-use the
 3364 % delimiter character idea from \verb, but it seems like overkill.
 3365 % 
 3366 \long\def\inlineraw{\tex \doinlineraw}
 3367 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
 3368 \def\doinlinerawtwo#1,#2,\finish{%
 3369   \def\inlinerawname{#1}%
 3370   \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
 3371   \endgroup % close group opened by \tex.
 3372 }
 3373 
 3374 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
 3375 %
 3376 \long\def\inlineifset#1{\doinlineifset #1,\finish}
 3377 \long\def\doinlineifset#1,#2,\finish{%
 3378   \def\inlinevarname{#1}%
 3379   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
 3380   \else\ignorespaces#2\fi
 3381 }
 3382 
 3383 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
 3384 %
 3385 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
 3386 \long\def\doinlineifclear#1,#2,\finish{%
 3387   \def\inlinevarname{#1}%
 3388   \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
 3389 }
 3390 
 3391 
 3392 \message{glyphs,}
 3393 % and logos.
 3394 
 3395 % @@ prints an @, as does @atchar{}.
 3396 \def\@{\char64 }
 3397 \let\atchar=\@
 3398 
 3399 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
 3400 \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
 3401 \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
 3402 \let\{=\lbracechar
 3403 \let\}=\rbracechar
 3404 
 3405 % @comma{} to avoid , parsing problems.
 3406 \let\comma = ,
 3407 
 3408 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
 3409 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
 3410 \let\, = \ptexc
 3411 \let\dotaccent = \ptexdot
 3412 \def\ringaccent#1{{\accent23 #1}}
 3413 \let\tieaccent = \ptext
 3414 \let\ubaraccent = \ptexb
 3415 \let\udotaccent = \d
 3416 
 3417 % Other special characters: @questiondown @exclamdown @ordf @ordm
 3418 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
 3419 \def\questiondown{?`}
 3420 \def\exclamdown{!`}
 3421 \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
 3422 \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
 3423 
 3424 % Dotless i and dotless j, used for accents.
 3425 \def\imacro{i}
 3426 \def\jmacro{j}
 3427 \def\dotless#1{%
 3428   \def\temp{#1}%
 3429   \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
 3430   \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
 3431   \else \errmessage{@dotless can be used only with i or j}%
 3432   \fi\fi
 3433 }
 3434 
 3435 % The \TeX{} logo, as in plain, but resetting the spacing so that a
 3436 % period following counts as ending a sentence.  (Idea found in latex.)
 3437 %
 3438 \edef\TeX{\TeX \spacefactor=1000 }
 3439 
 3440 % @LaTeX{} logo.  Not quite the same results as the definition in
 3441 % latex.ltx, since we use a different font for the raised A; it's most
 3442 % convenient for us to use an explicitly smaller font, rather than using
 3443 % the \scriptstyle font (since we don't reset \scriptstyle and
 3444 % \scriptscriptstyle).
 3445 %
 3446 \def\LaTeX{%
 3447   L\kern-.36em
 3448   {\setbox0=\hbox{T}%
 3449    \vbox to \ht0{\hbox{%
 3450      \ifx\textnominalsize\xwordpt
 3451        % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
 3452        % Revert to plain's \scriptsize, which is 7pt.
 3453        \count255=\the\fam $\fam\count255 \scriptstyle A$%
 3454      \else
 3455        % For 11pt, we can use our lllsize.
 3456        \switchtolllsize A%
 3457      \fi
 3458      }%
 3459      \vss
 3460   }}%
 3461   \kern-.15em
 3462   \TeX
 3463 }
 3464 
 3465 % Some math mode symbols.  Define \ensuremath to switch into math mode
 3466 % unless we are already there.  Expansion tricks may not be needed here,
 3467 % but safer, and can't hurt.
 3468 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
 3469 \def\ensuredmath#1{$\relax#1$}
 3470 %
 3471 \def\bullet{\ensuremath\ptexbullet}
 3472 \def\geq{\ensuremath\ge}
 3473 \def\leq{\ensuremath\le}
 3474 \def\minus{\ensuremath-}
 3475 
 3476 % @dots{} outputs an ellipsis using the current font.
 3477 % We do .5em per period so that it has the same spacing in the cm
 3478 % typewriter fonts as three actual period characters; on the other hand,
 3479 % in other typewriter fonts three periods are wider than 1.5em.  So do
 3480 % whichever is larger.
 3481 %
 3482 \def\dots{%
 3483   \leavevmode
 3484   \setbox0=\hbox{...}% get width of three periods
 3485   \ifdim\wd0 > 1.5em
 3486     \dimen0 = \wd0
 3487   \else
 3488     \dimen0 = 1.5em
 3489   \fi
 3490   \hbox to \dimen0{%
 3491     \hskip 0pt plus.25fil
 3492     .\hskip 0pt plus1fil
 3493     .\hskip 0pt plus1fil
 3494     .\hskip 0pt plus.5fil
 3495   }%
 3496 }
 3497 
 3498 % @enddots{} is an end-of-sentence ellipsis.
 3499 %
 3500 \def\enddots{%
 3501   \dots
 3502   \spacefactor=\endofsentencespacefactor
 3503 }
 3504 
 3505 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
 3506 %
 3507 % Since these characters are used in examples, they should be an even number of
 3508 % \tt widths. Each \tt character is 1en, so two makes it 1em.
 3509 %
 3510 \def\point{$\star$}
 3511 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
 3512 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
 3513 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
 3514 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
 3515 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
 3516 
 3517 % The @error{} command.
 3518 % Adapted from the TeXbook's \boxit.
 3519 %
 3520 \newbox\errorbox
 3521 %
 3522 {\ttfont \global\dimen0 = 3em}% Width of the box.
 3523 \dimen2 = .55pt % Thickness of rules
 3524 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
 3525 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
 3526 %
 3527 \setbox\errorbox=\hbox to \dimen0{\hfil
 3528    \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
 3529    \advance\hsize by -2\dimen2 % Rules.
 3530    \vbox{%
 3531       \hrule height\dimen2
 3532       \hbox{\vrule width\dimen2 \kern3pt          % Space to left of text.
 3533          \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
 3534          \kern3pt\vrule width\dimen2}% Space to right.
 3535       \hrule height\dimen2}
 3536     \hfil}
 3537 %
 3538 \def\error{\leavevmode\lower.7ex\copy\errorbox}
 3539 
 3540 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
 3541 %
 3542 \def\pounds{{\it\$}}
 3543 
 3544 % @euro{} comes from a separate font, depending on the current style.
 3545 % We use the free feym* fonts from the eurosym package by Henrik
 3546 % Theiling, which support regular, slanted, bold and bold slanted (and
 3547 % "outlined" (blackboard board, sort of) versions, which we don't need).
 3548 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
 3549 %
 3550 % Although only regular is the truly official Euro symbol, we ignore
 3551 % that.  The Euro is designed to be slightly taller than the regular
 3552 % font height.
 3553 %
 3554 % feymr - regular
 3555 % feymo - slanted
 3556 % feybr - bold
 3557 % feybo - bold slanted
 3558 %
 3559 % There is no good (free) typewriter version, to my knowledge.
 3560 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
 3561 % Hmm.
 3562 %
 3563 % Also doesn't work in math.  Do we need to do math with euro symbols?
 3564 % Hope not.
 3565 %
 3566 %
 3567 \def\euro{{\eurofont e}}
 3568 \def\eurofont{%
 3569   % We set the font at each command, rather than predefining it in
 3570   % \textfonts and the other font-switching commands, so that
 3571   % installations which never need the symbol don't have to have the
 3572   % font installed.
 3573   %
 3574   % There is only one designed size (nominal 10pt), so we always scale
 3575   % that to the current nominal size.
 3576   %
 3577   % By the way, simply using "at 1em" works for cmr10 and the like, but
 3578   % does not work for cmbx10 and other extended/shrunken fonts.
 3579   %
 3580   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
 3581   %
 3582   \ifx\curfontstyle\bfstylename
 3583     % bold:
 3584     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
 3585   \else
 3586     % regular:
 3587     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
 3588   \fi
 3589   \thiseurofont
 3590 }
 3591 
 3592 % Glyphs from the EC fonts.  We don't use \let for the aliases, because
 3593 % sometimes we redefine the original macro, and the alias should reflect
 3594 % the redefinition.
 3595 %
 3596 % Use LaTeX names for the Icelandic letters.
 3597 \def\DH{{\ecfont \char"D0}} % Eth
 3598 \def\dh{{\ecfont \char"F0}} % eth
 3599 \def\TH{{\ecfont \char"DE}} % Thorn
 3600 \def\th{{\ecfont \char"FE}} % thorn
 3601 %
 3602 \def\guillemetleft{{\ecfont \char"13}}
 3603 \def\guillemotleft{\guillemetleft}
 3604 \def\guillemetright{{\ecfont \char"14}}
 3605 \def\guillemotright{\guillemetright}
 3606 \def\guilsinglleft{{\ecfont \char"0E}}
 3607 \def\guilsinglright{{\ecfont \char"0F}}
 3608 \def\quotedblbase{{\ecfont \char"12}}
 3609 \def\quotesinglbase{{\ecfont \char"0D}}
 3610 %
 3611 % This positioning is not perfect (see the ogonek LaTeX package), but
 3612 % we have the precomposed glyphs for the most common cases.  We put the
 3613 % tests to use those glyphs in the single \ogonek macro so we have fewer
 3614 % dummy definitions to worry about for index entries, etc.
 3615 %
 3616 % ogonek is also used with other letters in Lithuanian (IOU), but using
 3617 % the precomposed glyphs for those is not so easy since they aren't in
 3618 % the same EC font.
 3619 \def\ogonek#1{{%
 3620   \def\temp{#1}%
 3621   \ifx\temp\macrocharA\Aogonek
 3622   \else\ifx\temp\macrochara\aogonek
 3623   \else\ifx\temp\macrocharE\Eogonek
 3624   \else\ifx\temp\macrochare\eogonek
 3625   \else
 3626     \ecfont \setbox0=\hbox{#1}%
 3627     \ifdim\ht0=1ex\accent"0C #1%
 3628     \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
 3629     \fi
 3630   \fi\fi\fi\fi
 3631   }%
 3632 }
 3633 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
 3634 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
 3635 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
 3636 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
 3637 %
 3638 % Use the European Computer Modern fonts (cm-super in outline format)
 3639 % for non-CM glyphs.  That is ec* for regular text and tc* for the text
 3640 % companion symbols (LaTeX TS1 encoding).  Both are part of the ec
 3641 % package and follow the same conventions.
 3642 % 
 3643 \def\ecfont{\etcfont{e}}
 3644 \def\tcfont{\etcfont{t}}
 3645 %
 3646 \def\etcfont#1{%
 3647   % We can't distinguish serif/sans and italic/slanted, but this
 3648   % is used for crude hacks anyway (like adding French and German
 3649   % quotes to documents typeset with CM, where we lose kerning), so
 3650   % hopefully nobody will notice/care.
 3651   \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
 3652   \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
 3653   \ifmonospace
 3654     % typewriter:
 3655     \font\thisecfont = #1ctt\ecsize \space at \nominalsize
 3656   \else
 3657     \ifx\curfontstyle\bfstylename
 3658       % bold:
 3659       \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
 3660     \else
 3661       % regular:
 3662       \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
 3663     \fi
 3664   \fi
 3665   \thisecfont
 3666 }
 3667 
 3668 % @registeredsymbol - R in a circle.  The font for the R should really
 3669 % be smaller yet, but lllsize is the best we can do for now.
 3670 % Adapted from the plain.tex definition of \copyright.
 3671 %
 3672 \def\registeredsymbol{%
 3673   $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
 3674                \hfil\crcr\Orb}}%
 3675     }$%
 3676 }
 3677 
 3678 % @textdegree - the normal degrees sign.
 3679 %
 3680 \def\textdegree{$^\circ$}
 3681 
 3682 % Laurent Siebenmann reports \Orb undefined with:
 3683 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
 3684 % so we'll define it if necessary.
 3685 %
 3686 \ifx\Orb\thisisundefined
 3687 \def\Orb{\mathhexbox20D}
 3688 \fi
 3689 
 3690 % Quotes.
 3691 \chardef\quotedblleft="5C
 3692 \chardef\quotedblright=`\"
 3693 \chardef\quoteleft=`\`
 3694 \chardef\quoteright=`\'
 3695 
 3696 
 3697 \message{page headings,}
 3698 
 3699 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
 3700 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
 3701 
 3702 % First the title page.  Must do @settitle before @titlepage.
 3703 \newif\ifseenauthor
 3704 \newif\iffinishedtitlepage
 3705 
 3706 % @setcontentsaftertitlepage used to do an implicit @contents or
 3707 % @shortcontents after @end titlepage, but it is now obsolete.
 3708 \def\setcontentsaftertitlepage{%
 3709   \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
 3710               command; move your @contents command if you want the contents
 3711               after the title page.}}%
 3712 \def\setshortcontentsaftertitlepage{%
 3713   \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
 3714               command; move your @shortcontents and @contents commands if you 
 3715               want the contents after the title page.}}%
 3716 
 3717 \parseargdef\shorttitlepage{%
 3718   \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
 3719   \endgroup\page\hbox{}\page}
 3720 
 3721 \envdef\titlepage{%
 3722   % Open one extra group, as we want to close it in the middle of \Etitlepage.
 3723   \begingroup
 3724     \parindent=0pt \textfonts
 3725     % Leave some space at the very top of the page.
 3726     \vglue\titlepagetopglue
 3727     % No rule at page bottom unless we print one at the top with @title.
 3728     \finishedtitlepagetrue
 3729     %
 3730     % Most title ``pages'' are actually two pages long, with space
 3731     % at the top of the second.  We don't want the ragged left on the second.
 3732     \let\oldpage = \page
 3733     \def\page{%
 3734       \iffinishedtitlepage\else
 3735      \finishtitlepage
 3736       \fi
 3737       \let\page = \oldpage
 3738       \page
 3739       \null
 3740     }%
 3741 }
 3742 
 3743 \def\Etitlepage{%
 3744     \iffinishedtitlepage\else
 3745     \finishtitlepage
 3746     \fi
 3747     % It is important to do the page break before ending the group,
 3748     % because the headline and footline are only empty inside the group.
 3749     % If we use the new definition of \page, we always get a blank page
 3750     % after the title page, which we certainly don't want.
 3751     \oldpage
 3752   \endgroup
 3753   %
 3754   % Need this before the \...aftertitlepage checks so that if they are
 3755   % in effect the toc pages will come out with page numbers.
 3756   \HEADINGSon
 3757 }
 3758 
 3759 \def\finishtitlepage{%
 3760   \vskip4pt \hrule height 2pt width \hsize
 3761   \vskip\titlepagebottomglue
 3762   \finishedtitlepagetrue
 3763 }
 3764 
 3765 % Settings used for typesetting titles: no hyphenation, no indentation,
 3766 % don't worry much about spacing, ragged right.  This should be used
 3767 % inside a \vbox, and fonts need to be set appropriately first. \par should
 3768 % be specified before the end of the \vbox, since a vbox is a group.
 3769 % 
 3770 \def\raggedtitlesettings{%
 3771   \rm
 3772   \hyphenpenalty=10000
 3773   \parindent=0pt
 3774   \tolerance=5000
 3775   \ptexraggedright
 3776 }
 3777 
 3778 % Macros to be used within @titlepage:
 3779 
 3780 \let\subtitlerm=\rmfont
 3781 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
 3782 
 3783 \parseargdef\title{%
 3784   \checkenv\titlepage
 3785   \vbox{\titlefonts \raggedtitlesettings #1\par}%
 3786   % print a rule at the page bottom also.
 3787   \finishedtitlepagefalse
 3788   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
 3789 }
 3790 
 3791 \parseargdef\subtitle{%
 3792   \checkenv\titlepage
 3793   {\subtitlefont \rightline{#1}}%
 3794 }
 3795 
 3796 % @author should come last, but may come many times.
 3797 % It can also be used inside @quotation.
 3798 %
 3799 \parseargdef\author{%
 3800   \def\temp{\quotation}%
 3801   \ifx\thisenv\temp
 3802     \def\quotationauthor{#1}% printed in \Equotation.
 3803   \else
 3804     \checkenv\titlepage
 3805     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
 3806     {\secfonts\rm \leftline{#1}}%
 3807   \fi
 3808 }
 3809 
 3810 
 3811 % Set up page headings and footings.
 3812 
 3813 \let\thispage=\folio
 3814 
 3815 \newtoks\evenheadline    % headline on even pages
 3816 \newtoks\oddheadline     % headline on odd pages
 3817 \newtoks\evenfootline    % footline on even pages
 3818 \newtoks\oddfootline     % footline on odd pages
 3819 
 3820 % Now make \makeheadline and \makefootline in Plain TeX use those variables
 3821 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
 3822                             \else \the\evenheadline \fi}}
 3823 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
 3824                             \else \the\evenfootline \fi}\HEADINGShook}
 3825 \let\HEADINGShook=\relax
 3826 
 3827 % Commands to set those variables.
 3828 % For example, this is what  @headings on  does
 3829 % @evenheading @thistitle|@thispage|@thischapter
 3830 % @oddheading @thischapter|@thispage|@thistitle
 3831 % @evenfooting @thisfile||
 3832 % @oddfooting ||@thisfile
 3833 
 3834 
 3835 \def\evenheading{\parsearg\evenheadingxxx}
 3836 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
 3837 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
 3838 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
 3839 
 3840 \def\oddheading{\parsearg\oddheadingxxx}
 3841 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
 3842 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
 3843 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
 3844 
 3845 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
 3846 
 3847 \def\evenfooting{\parsearg\evenfootingxxx}
 3848 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
 3849 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
 3850 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
 3851 
 3852 \def\oddfooting{\parsearg\oddfootingxxx}
 3853 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
 3854 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
 3855   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
 3856   %
 3857   % Leave some space for the footline.  Hopefully ok to assume
 3858   % @evenfooting will not be used by itself.
 3859   \global\advance\txipageheight by -12pt
 3860   \global\advance\vsize by -12pt
 3861 }
 3862 
 3863 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
 3864 
 3865 % @evenheadingmarks top     \thischapter <- chapter at the top of a page
 3866 % @evenheadingmarks bottom  \thischapter <- chapter at the bottom of a page
 3867 %
 3868 % The same set of arguments for:
 3869 %
 3870 % @oddheadingmarks
 3871 % @evenfootingmarks
 3872 % @oddfootingmarks
 3873 % @everyheadingmarks
 3874 % @everyfootingmarks
 3875 
 3876 % These define \getoddheadingmarks, \getevenheadingmarks,
 3877 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
 3878 % \gettopheadingmarks, \getbottomheadingmarks.
 3879 %
 3880 \def\evenheadingmarks{\headingmarks{even}{heading}}
 3881 \def\oddheadingmarks{\headingmarks{odd}{heading}}
 3882 \def\evenfootingmarks{\headingmarks{even}{footing}}
 3883 \def\oddfootingmarks{\headingmarks{odd}{footing}}
 3884 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
 3885                           \headingmarks{odd}{heading}{#1} }
 3886 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
 3887                           \headingmarks{odd}{footing}{#1} }
 3888 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
 3889 \def\headingmarks#1#2#3 {%
 3890   \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
 3891   \global\expandafter\let\csname get#1#2marks\endcsname \temp
 3892 }
 3893 
 3894 \everyheadingmarks bottom
 3895 \everyfootingmarks bottom
 3896 
 3897 % @headings double      turns headings on for double-sided printing.
 3898 % @headings single      turns headings on for single-sided printing.
 3899 % @headings off         turns them off.
 3900 % @headings on          same as @headings double, retained for compatibility.
 3901 % @headings after       turns on double-sided headings after this page.
 3902 % @headings doubleafter turns on double-sided headings after this page.
 3903 % @headings singleafter turns on single-sided headings after this page.
 3904 % By default, they are off at the start of a document,
 3905 % and turned `on' after @end titlepage.
 3906 
 3907 \parseargdef\headings{\csname HEADINGS#1\endcsname}
 3908 
 3909 \def\headingsoff{% non-global headings elimination
 3910   \evenheadline={\hfil}\evenfootline={\hfil}%
 3911    \oddheadline={\hfil}\oddfootline={\hfil}%
 3912 }
 3913 
 3914 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
 3915 \HEADINGSoff  % it's the default
 3916 
 3917 % When we turn headings on, set the page number to 1.
 3918 % For double-sided printing, put current file name in lower left corner,
 3919 % chapter name on inside top of right hand pages, document
 3920 % title on inside top of left hand pages, and page numbers on outside top
 3921 % edge of all pages.
 3922 \def\HEADINGSdouble{%
 3923 \global\pageno=1
 3924 \global\evenfootline={\hfil}
 3925 \global\oddfootline={\hfil}
 3926 \global\evenheadline={\line{\folio\hfil\thistitle}}
 3927 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
 3928 \global\let\contentsalignmacro = \chapoddpage
 3929 }
 3930 \let\contentsalignmacro = \chappager
 3931 
 3932 % For single-sided printing, chapter title goes across top left of page,
 3933 % page number on top right.
 3934 \def\HEADINGSsingle{%
 3935 \global\pageno=1
 3936 \global\evenfootline={\hfil}
 3937 \global\oddfootline={\hfil}
 3938 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
 3939 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
 3940 \global\let\contentsalignmacro = \chappager
 3941 }
 3942 \def\HEADINGSon{\HEADINGSdouble}
 3943 
 3944 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
 3945 \let\HEADINGSdoubleafter=\HEADINGSafter
 3946 \def\HEADINGSdoublex{%
 3947 \global\evenfootline={\hfil}
 3948 \global\oddfootline={\hfil}
 3949 \global\evenheadline={\line{\folio\hfil\thistitle}}
 3950 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
 3951 \global\let\contentsalignmacro = \chapoddpage
 3952 }
 3953 
 3954 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
 3955 \def\HEADINGSsinglex{%
 3956 \global\evenfootline={\hfil}
 3957 \global\oddfootline={\hfil}
 3958 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
 3959 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
 3960 \global\let\contentsalignmacro = \chappager
 3961 }
 3962 
 3963 % Subroutines used in generating headings
 3964 % This produces Day Month Year style of output.
 3965 % Only define if not already defined, in case a txi-??.tex file has set
 3966 % up a different format (e.g., txi-cs.tex does this).
 3967 \ifx\today\thisisundefined
 3968 \def\today{%
 3969   \number\day\space
 3970   \ifcase\month
 3971   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
 3972   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
 3973   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
 3974   \fi
 3975   \space\number\year}
 3976 \fi
 3977 
 3978 % @settitle line...  specifies the title of the document, for headings.
 3979 % It generates no output of its own.
 3980 \def\thistitle{\putwordNoTitle}
 3981 \def\settitle{\parsearg{\gdef\thistitle}}
 3982 
 3983 
 3984 \message{tables,}
 3985 % Tables -- @table, @ftable, @vtable, @item(x).
 3986 
 3987 % default indentation of table text
 3988 \newdimen\tableindent \tableindent=.8in
 3989 % default indentation of @itemize and @enumerate text
 3990 \newdimen\itemindent  \itemindent=.3in
 3991 % margin between end of table item and start of table text.
 3992 \newdimen\itemmargin  \itemmargin=.1in
 3993 
 3994 % used internally for \itemindent minus \itemmargin
 3995 \newdimen\itemmax
 3996 
 3997 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
 3998 % these defs.
 3999 % They also define \itemindex
 4000 % to index the item name in whatever manner is desired (perhaps none).
 4001 
 4002 \newif\ifitemxneedsnegativevskip
 4003 
 4004 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
 4005 
 4006 \def\internalBitem{\smallbreak \parsearg\itemzzz}
 4007 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
 4008 
 4009 \def\itemzzz #1{\begingroup %
 4010   \advance\hsize by -\rightskip
 4011   \advance\hsize by -\tableindent
 4012   \setbox0=\hbox{\itemindicate{#1}}%
 4013   \itemindex{#1}%
 4014   \nobreak % This prevents a break before @itemx.
 4015   %
 4016   % If the item text does not fit in the space we have, put it on a line
 4017   % by itself, and do not allow a page break either before or after that
 4018   % line.  We do not start a paragraph here because then if the next
 4019   % command is, e.g., @kindex, the whatsit would get put into the
 4020   % horizontal list on a line by itself, resulting in extra blank space.
 4021   \ifdim \wd0>\itemmax
 4022     %
 4023     % Make this a paragraph so we get the \parskip glue and wrapping,
 4024     % but leave it ragged-right.
 4025     \begingroup
 4026       \advance\leftskip by-\tableindent
 4027       \advance\hsize by\tableindent
 4028       \advance\rightskip by0pt plus1fil\relax
 4029       \leavevmode\unhbox0\par
 4030     \endgroup
 4031     %
 4032     % We're going to be starting a paragraph, but we don't want the
 4033     % \parskip glue -- logically it's part of the @item we just started.
 4034     \nobreak \vskip-\parskip
 4035     %
 4036     % Stop a page break at the \parskip glue coming up.  However, if
 4037     % what follows is an environment such as @example, there will be no
 4038     % \parskip glue; then the negative vskip we just inserted would
 4039     % cause the example and the item to crash together.  So we use this
 4040     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
 4041     % \parskip glue after all.  Section titles are handled this way also.
 4042     %
 4043     \penalty 10001
 4044     \endgroup
 4045     \itemxneedsnegativevskipfalse
 4046   \else
 4047     % The item text fits into the space.  Start a paragraph, so that the
 4048     % following text (if any) will end up on the same line.
 4049     \noindent
 4050     % Do this with kerns and \unhbox so that if there is a footnote in
 4051     % the item text, it can migrate to the main vertical list and
 4052     % eventually be printed.
 4053     \nobreak\kern-\tableindent
 4054     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
 4055     \unhbox0
 4056     \nobreak\kern\dimen0
 4057     \endgroup
 4058     \itemxneedsnegativevskiptrue
 4059   \fi
 4060 }
 4061 
 4062 \def\item{\errmessage{@item while not in a list environment}}
 4063 \def\itemx{\errmessage{@itemx while not in a list environment}}
 4064 
 4065 % @table, @ftable, @vtable.
 4066 \envdef\table{%
 4067   \let\itemindex\gobble
 4068   \tablecheck{table}%
 4069 }
 4070 \envdef\ftable{%
 4071   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
 4072   \tablecheck{ftable}%
 4073 }
 4074 \envdef\vtable{%
 4075   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
 4076   \tablecheck{vtable}%
 4077 }
 4078 \def\tablecheck#1{%
 4079   \ifnum \the\catcode`\^^M=\active
 4080     \endgroup
 4081     \errmessage{This command won't work in this context; perhaps the problem is
 4082       that we are \inenvironment\thisenv}%
 4083     \def\next{\doignore{#1}}%
 4084   \else
 4085     \let\next\tablex
 4086   \fi
 4087   \next
 4088 }
 4089 \def\tablex#1{%
 4090   \def\itemindicate{#1}%
 4091   \parsearg\tabley
 4092 }
 4093 \def\tabley#1{%
 4094   {%
 4095     \makevalueexpandable
 4096     \edef\temp{\noexpand\tablez #1\space\space\space}%
 4097     \expandafter
 4098   }\temp \endtablez
 4099 }
 4100 \def\tablez #1 #2 #3 #4\endtablez{%
 4101   \aboveenvbreak
 4102   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
 4103   \ifnum 0#2>0 \tableindent=#2\mil \fi
 4104   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
 4105   \itemmax=\tableindent
 4106   \advance \itemmax by -\itemmargin
 4107   \advance \leftskip by \tableindent
 4108   \exdentamount=\tableindent
 4109   \parindent = 0pt
 4110   \parskip = \smallskipamount
 4111   \ifdim \parskip=0pt \parskip=2pt \fi
 4112   \let\item = \internalBitem
 4113   \let\itemx = \internalBitemx
 4114 }
 4115 \def\Etable{\endgraf\afterenvbreak}
 4116 \let\Eftable\Etable
 4117 \let\Evtable\Etable
 4118 \let\Eitemize\Etable
 4119 \let\Eenumerate\Etable
 4120 
 4121 % This is the counter used by @enumerate, which is really @itemize
 4122 
 4123 \newcount \itemno
 4124 
 4125 \envdef\itemize{\parsearg\doitemize}
 4126 
 4127 \def\doitemize#1{%
 4128   \aboveenvbreak
 4129   \itemmax=\itemindent
 4130   \advance\itemmax by -\itemmargin
 4131   \advance\leftskip by \itemindent
 4132   \exdentamount=\itemindent
 4133   \parindent=0pt
 4134   \parskip=\smallskipamount
 4135   \ifdim\parskip=0pt \parskip=2pt \fi
 4136   %
 4137   % Try typesetting the item mark so that if the document erroneously says
 4138   % something like @itemize @samp (intending @table), there's an error
 4139   % right away at the @itemize.  It's not the best error message in the
 4140   % world, but it's better than leaving it to the @item.  This means if
 4141   % the user wants an empty mark, they have to say @w{} not just @w.
 4142   \def\itemcontents{#1}%
 4143   \setbox0 = \hbox{\itemcontents}%
 4144   %
 4145   % @itemize with no arg is equivalent to @itemize @bullet.
 4146   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
 4147   %
 4148   \let\item=\itemizeitem
 4149 }
 4150 
 4151 % Definition of @item while inside @itemize and @enumerate.
 4152 %
 4153 \def\itemizeitem{%
 4154   \advance\itemno by 1  % for enumerations
 4155   {\let\par=\endgraf \smallbreak}% reasonable place to break
 4156   {%
 4157    % If the document has an @itemize directly after a section title, a
 4158    % \nobreak will be last on the list, and \sectionheading will have
 4159    % done a \vskip-\parskip.  In that case, we don't want to zero
 4160    % parskip, or the item text will crash with the heading.  On the
 4161    % other hand, when there is normal text preceding the item (as there
 4162    % usually is), we do want to zero parskip, or there would be too much
 4163    % space.  In that case, we won't have a \nobreak before.  At least
 4164    % that's the theory.
 4165    \ifnum\lastpenalty<10000 \parskip=0in \fi
 4166    \noindent
 4167    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
 4168    %
 4169    \ifinner\else
 4170      \vadjust{\penalty 1200}% not good to break after first line of item.
 4171    \fi
 4172    % We can be in inner vertical mode in a footnote, although an
 4173    % @itemize looks awful there.
 4174   }%
 4175   \flushcr
 4176 }
 4177 
 4178 % \splitoff TOKENS\endmark defines \first to be the first token in
 4179 % TOKENS, and \rest to be the remainder.
 4180 %
 4181 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
 4182 
 4183 % Allow an optional argument of an uppercase letter, lowercase letter,
 4184 % or number, to specify the first label in the enumerated list.  No
 4185 % argument is the same as `1'.
 4186 %
 4187 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
 4188 \def\enumeratey #1 #2\endenumeratey{%
 4189   % If we were given no argument, pretend we were given `1'.
 4190   \def\thearg{#1}%
 4191   \ifx\thearg\empty \def\thearg{1}\fi
 4192   %
 4193   % Detect if the argument is a single token.  If so, it might be a
 4194   % letter.  Otherwise, the only valid thing it can be is a number.
 4195   % (We will always have one token, because of the test we just made.
 4196   % This is a good thing, since \splitoff doesn't work given nothing at
 4197   % all -- the first parameter is undelimited.)
 4198   \expandafter\splitoff\thearg\endmark
 4199   \ifx\rest\empty
 4200     % Only one token in the argument.  It could still be anything.
 4201     % A ``lowercase letter'' is one whose \lccode is nonzero.
 4202     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
 4203     %   not equal to itself.
 4204     % Otherwise, we assume it's a number.
 4205     %
 4206     % We need the \relax at the end of the \ifnum lines to stop TeX from
 4207     % continuing to look for a <number>.
 4208     %
 4209     \ifnum\lccode\expandafter`\thearg=0\relax
 4210       \numericenumerate % a number (we hope)
 4211     \else
 4212       % It's a letter.
 4213       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
 4214         \lowercaseenumerate % lowercase letter
 4215       \else
 4216         \uppercaseenumerate % uppercase letter
 4217       \fi
 4218     \fi
 4219   \else
 4220     % Multiple tokens in the argument.  We hope it's a number.
 4221     \numericenumerate
 4222   \fi
 4223 }
 4224 
 4225 % An @enumerate whose labels are integers.  The starting integer is
 4226 % given in \thearg.
 4227 %
 4228 \def\numericenumerate{%
 4229   \itemno = \thearg
 4230   \startenumeration{\the\itemno}%
 4231 }
 4232 
 4233 % The starting (lowercase) letter is in \thearg.
 4234 \def\lowercaseenumerate{%
 4235   \itemno = \expandafter`\thearg
 4236   \startenumeration{%
 4237     % Be sure we're not beyond the end of the alphabet.
 4238     \ifnum\itemno=0
 4239       \errmessage{No more lowercase letters in @enumerate; get a bigger
 4240                   alphabet}%
 4241     \fi
 4242     \char\lccode\itemno
 4243   }%
 4244 }
 4245 
 4246 % The starting (uppercase) letter is in \thearg.
 4247 \def\uppercaseenumerate{%
 4248   \itemno = \expandafter`\thearg
 4249   \startenumeration{%
 4250     % Be sure we're not beyond the end of the alphabet.
 4251     \ifnum\itemno=0
 4252       \errmessage{No more uppercase letters in @enumerate; get a bigger
 4253                   alphabet}
 4254     \fi
 4255     \char\uccode\itemno
 4256   }%
 4257 }
 4258 
 4259 % Call \doitemize, adding a period to the first argument and supplying the
 4260 % common last two arguments.  Also subtract one from the initial value in
 4261 % \itemno, since @item increments \itemno.
 4262 %
 4263 \def\startenumeration#1{%
 4264   \advance\itemno by -1
 4265   \doitemize{#1.}\flushcr
 4266 }
 4267 
 4268 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
 4269 % to @enumerate.
 4270 %
 4271 \def\alphaenumerate{\enumerate{a}}
 4272 \def\capsenumerate{\enumerate{A}}
 4273 \def\Ealphaenumerate{\Eenumerate}
 4274 \def\Ecapsenumerate{\Eenumerate}
 4275 
 4276 
 4277 % @multitable macros
 4278 % Amy Hendrickson, 8/18/94, 3/6/96
 4279 %
 4280 % @multitable ... @end multitable will make as many columns as desired.
 4281 % Contents of each column will wrap at width given in preamble.  Width
 4282 % can be specified either with sample text given in a template line,
 4283 % or in percent of \hsize, the current width of text on page.
 4284 
 4285 % Table can continue over pages but will only break between lines.
 4286 
 4287 % To make preamble:
 4288 %
 4289 % Either define widths of columns in terms of percent of \hsize:
 4290 %   @multitable @columnfractions .25 .3 .45
 4291 %   @item ...
 4292 %
 4293 %   Numbers following @columnfractions are the percent of the total
 4294 %   current hsize to be used for each column. You may use as many
 4295 %   columns as desired.
 4296 
 4297 
 4298 % Or use a template:
 4299 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
 4300 %   @item ...
 4301 %   using the widest term desired in each column.
 4302 
 4303 % Each new table line starts with @item, each subsequent new column
 4304 % starts with @tab. Empty columns may be produced by supplying @tab's
 4305 % with nothing between them for as many times as empty columns are needed,
 4306 % ie, @tab@tab@tab will produce two empty columns.
 4307 
 4308 % @item, @tab do not need to be on their own lines, but it will not hurt
 4309 % if they are.
 4310 
 4311 % Sample multitable:
 4312 
 4313 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
 4314 %   @item first col stuff @tab second col stuff @tab third col
 4315 %   @item
 4316 %   first col stuff
 4317 %   @tab
 4318 %   second col stuff
 4319 %   @tab
 4320 %   third col
 4321 %   @item first col stuff @tab second col stuff
 4322 %   @tab Many paragraphs of text may be used in any column.
 4323 %
 4324 %         They will wrap at the width determined by the template.
 4325 %   @item@tab@tab This will be in third column.
 4326 %   @end multitable
 4327 
 4328 % Default dimensions may be reset by user.
 4329 % @multitableparskip is vertical space between paragraphs in table.
 4330 % @multitableparindent is paragraph indent in table.
 4331 % @multitablecolmargin is horizontal space to be left between columns.
 4332 % @multitablelinespace is space to leave between table items, baseline
 4333 %                                                            to baseline.
 4334 %   0pt means it depends on current normal line spacing.
 4335 %
 4336 \newskip\multitableparskip
 4337 \newskip\multitableparindent
 4338 \newdimen\multitablecolspace
 4339 \newskip\multitablelinespace
 4340 \multitableparskip=0pt
 4341 \multitableparindent=6pt
 4342 \multitablecolspace=12pt
 4343 \multitablelinespace=0pt
 4344 
 4345 % Macros used to set up halign preamble:
 4346 %
 4347 \let\endsetuptable\relax
 4348 \def\xendsetuptable{\endsetuptable}
 4349 \let\columnfractions\relax
 4350 \def\xcolumnfractions{\columnfractions}
 4351 \newif\ifsetpercent
 4352 
 4353 % #1 is the @columnfraction, usually a decimal number like .5, but might
 4354 % be just 1.  We just use it, whatever it is.
 4355 %
 4356 \def\pickupwholefraction#1 {%
 4357   \global\advance\colcount by 1
 4358   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
 4359   \setuptable
 4360 }
 4361 
 4362 \newcount\colcount
 4363 \def\setuptable#1{%
 4364   \def\firstarg{#1}%
 4365   \ifx\firstarg\xendsetuptable
 4366     \let\go = \relax
 4367   \else
 4368     \ifx\firstarg\xcolumnfractions
 4369       \global\setpercenttrue
 4370     \else
 4371       \ifsetpercent
 4372          \let\go\pickupwholefraction
 4373       \else
 4374          \global\advance\colcount by 1
 4375          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
 4376                    % separator; typically that is always in the input, anyway.
 4377          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
 4378       \fi
 4379     \fi
 4380     \ifx\go\pickupwholefraction
 4381       % Put the argument back for the \pickupwholefraction call, so
 4382       % we'll always have a period there to be parsed.
 4383       \def\go{\pickupwholefraction#1}%
 4384     \else
 4385       \let\go = \setuptable
 4386     \fi%
 4387   \fi
 4388   \go
 4389 }
 4390 
 4391 % multitable-only commands.
 4392 % 
 4393 % @headitem starts a heading row, which we typeset in bold.  Assignments
 4394 % have to be global since we are inside the implicit group of an
 4395 % alignment entry.  \everycr below resets \everytab so we don't have to
 4396 % undo it ourselves.
 4397 \def\headitemfont{\b}% for people to use in the template row; not changeable
 4398 \def\headitem{%
 4399   \checkenv\multitable
 4400   \crcr
 4401   \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
 4402   \global\everytab={\bf}% can't use \headitemfont since the parsing differs
 4403   \the\everytab % for the first item
 4404 }%
 4405 %
 4406 % default for tables with no headings.
 4407 \let\headitemcrhook=\relax
 4408 %
 4409 % A \tab used to include \hskip1sp.  But then the space in a template
 4410 % line is not enough.  That is bad.  So let's go back to just `&' until
 4411 % we again encounter the problem the 1sp was intended to solve.
 4412 %                   --karl, nathan@acm.org, 20apr99.
 4413 \def\tab{\checkenv\multitable &\the\everytab}%
 4414 
 4415 % @multitable ... @end multitable definitions:
 4416 %
 4417 \newtoks\everytab  % insert after every tab.
 4418 %
 4419 \envdef\multitable{%
 4420   \vskip\parskip
 4421   \startsavinginserts
 4422   %
 4423   % @item within a multitable starts a normal row.
 4424   % We use \def instead of \let so that if one of the multitable entries
 4425   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
 4426   % \endtemplate) expanding \doitemize.
 4427   \def\item{\crcr}%
 4428   %
 4429   \tolerance=9500
 4430   \hbadness=9500
 4431   \setmultitablespacing
 4432   \parskip=\multitableparskip
 4433   \parindent=\multitableparindent
 4434   \overfullrule=0pt
 4435   \global\colcount=0
 4436   %
 4437   \everycr = {%
 4438     \noalign{%
 4439       \global\everytab={}% Reset from possible headitem.
 4440       \global\colcount=0 % Reset the column counter.
 4441       %
 4442       % Check for saved footnotes, etc.:
 4443       \checkinserts
 4444       %
 4445       % Perhaps a \nobreak, then reset:
 4446       \headitemcrhook
 4447       \global\let\headitemcrhook=\relax
 4448     }%
 4449   }%
 4450   %
 4451   \parsearg\domultitable
 4452 }
 4453 \def\domultitable#1{%
 4454   % To parse everything between @multitable and @item:
 4455   \setuptable#1 \endsetuptable
 4456   %
 4457   % This preamble sets up a generic column definition, which will
 4458   % be used as many times as user calls for columns.
 4459   % \vtop will set a single line and will also let text wrap and
 4460   % continue for many paragraphs if desired.
 4461   \halign\bgroup &%
 4462     \global\advance\colcount by 1
 4463     \multistrut
 4464     \vtop{%
 4465       % Use the current \colcount to find the correct column width:
 4466       \hsize=\expandafter\csname col\the\colcount\endcsname
 4467       %
 4468       % In order to keep entries from bumping into each other
 4469       % we will add a \leftskip of \multitablecolspace to all columns after
 4470       % the first one.
 4471       %
 4472       % If a template has been used, we will add \multitablecolspace
 4473       % to the width of each template entry.
 4474       %
 4475       % If the user has set preamble in terms of percent of \hsize we will
 4476       % use that dimension as the width of the column, and the \leftskip
 4477       % will keep entries from bumping into each other.  Table will start at
 4478       % left margin and final column will justify at right margin.
 4479       %
 4480       % Make sure we don't inherit \rightskip from the outer environment.
 4481       \rightskip=0pt
 4482       \ifnum\colcount=1
 4483     % The first column will be indented with the surrounding text.
 4484     \advance\hsize by\leftskip
 4485       \else
 4486     \ifsetpercent \else
 4487       % If user has not set preamble in terms of percent of \hsize
 4488       % we will advance \hsize by \multitablecolspace.
 4489       \advance\hsize by \multitablecolspace
 4490     \fi
 4491        % In either case we will make \leftskip=\multitablecolspace:
 4492       \leftskip=\multitablecolspace
 4493       \fi
 4494       % Ignoring space at the beginning and end avoids an occasional spurious
 4495       % blank line, when TeX decides to break the line at the space before the
 4496       % box from the multistrut, so the strut ends up on a line by itself.
 4497       % For example:
 4498       % @multitable @columnfractions .11 .89
 4499       % @item @code{#}
 4500       % @tab Legal holiday which is valid in major parts of the whole country.
 4501       % Is automatically provided with highlighting sequences respectively
 4502       % marking characters.
 4503       \noindent\ignorespaces##\unskip\multistrut
 4504     }\cr
 4505 }
 4506 \def\Emultitable{%
 4507   \crcr
 4508   \egroup % end the \halign
 4509   \global\setpercentfalse
 4510 }
 4511 
 4512 \def\setmultitablespacing{%
 4513   \def\multistrut{\strut}% just use the standard line spacing
 4514   %
 4515   % Compute \multitablelinespace (if not defined by user) for use in
 4516   % \multitableparskip calculation.  We used define \multistrut based on
 4517   % this, but (ironically) that caused the spacing to be off.
 4518   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
 4519 \ifdim\multitablelinespace=0pt
 4520 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
 4521 \global\advance\multitablelinespace by-\ht0
 4522 \fi
 4523 % Test to see if parskip is larger than space between lines of
 4524 % table. If not, do nothing.
 4525 %        If so, set to same dimension as multitablelinespace.
 4526 \ifdim\multitableparskip>\multitablelinespace
 4527 \global\multitableparskip=\multitablelinespace
 4528 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
 4529                                       % than skip between lines in the table.
 4530 \fi%
 4531 \ifdim\multitableparskip=0pt
 4532 \global\multitableparskip=\multitablelinespace
 4533 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
 4534                                       % than skip between lines in the table.
 4535 \fi}
 4536 
 4537 
 4538 \message{conditionals,}
 4539 
 4540 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
 4541 % @ifnotxml always succeed.  They currently do nothing; we don't
 4542 % attempt to check whether the conditionals are properly nested.  But we
 4543 % have to remember that they are conditionals, so that @end doesn't
 4544 % attempt to close an environment group.
 4545 %
 4546 \def\makecond#1{%
 4547   \expandafter\let\csname #1\endcsname = \relax
 4548   \expandafter\let\csname iscond.#1\endcsname = 1
 4549 }
 4550 \makecond{iftex}
 4551 \makecond{ifnotdocbook}
 4552 \makecond{ifnothtml}
 4553 \makecond{ifnotinfo}
 4554 \makecond{ifnotplaintext}
 4555 \makecond{ifnotxml}
 4556 
 4557 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
 4558 %
 4559 \def\direntry{\doignore{direntry}}
 4560 \def\documentdescription{\doignore{documentdescription}}
 4561 \def\docbook{\doignore{docbook}}
 4562 \def\html{\doignore{html}}
 4563 \def\ifdocbook{\doignore{ifdocbook}}
 4564 \def\ifhtml{\doignore{ifhtml}}
 4565 \def\ifinfo{\doignore{ifinfo}}
 4566 \def\ifnottex{\doignore{ifnottex}}
 4567 \def\ifplaintext{\doignore{ifplaintext}}
 4568 \def\ifxml{\doignore{ifxml}}
 4569 \def\ignore{\doignore{ignore}}
 4570 \def\menu{\doignore{menu}}
 4571 \def\xml{\doignore{xml}}
 4572 
 4573 % Ignore text until a line `@end #1', keeping track of nested conditionals.
 4574 %
 4575 % A count to remember the depth of nesting.
 4576 \newcount\doignorecount
 4577 
 4578 \def\doignore#1{\begingroup
 4579   % Scan in ``verbatim'' mode:
 4580   \obeylines
 4581   \catcode`\@ = \other
 4582   \catcode`\{ = \other
 4583   \catcode`\} = \other
 4584   %
 4585   % Make sure that spaces turn into tokens that match what \doignoretext wants.
 4586   \spaceisspace
 4587   %
 4588   % Count number of #1's that we've seen.
 4589   \doignorecount = 0
 4590   %
 4591   % Swallow text until we reach the matching `@end #1'.
 4592   \dodoignore{#1}%
 4593 }
 4594 
 4595 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
 4596   \obeylines %
 4597   %
 4598   \gdef\dodoignore#1{%
 4599     % #1 contains the command name as a string, e.g., `ifinfo'.
 4600     %
 4601     % Define a command to find the next `@end #1'.
 4602     \long\def\doignoretext##1^^M@end #1{%
 4603       \doignoretextyyy##1^^M@#1\_STOP_}%
 4604     %
 4605     % And this command to find another #1 command, at the beginning of a
 4606     % line.  (Otherwise, we would consider a line `@c @ifset', for
 4607     % example, to count as an @ifset for nesting.)
 4608     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
 4609     %
 4610     % And now expand that command.
 4611     \doignoretext ^^M%
 4612   }%
 4613 }
 4614 
 4615 \def\doignoreyyy#1{%
 4616   \def\temp{#1}%
 4617   \ifx\temp\empty           % Nothing found.
 4618     \let\next\doignoretextzzz
 4619   \else                 % Found a nested condition, ...
 4620     \advance\doignorecount by 1
 4621     \let\next\doignoretextyyy       % ..., look for another.
 4622     % If we're here, #1 ends with ^^M\ifinfo (for example).
 4623   \fi
 4624   \next #1% the token \_STOP_ is present just after this macro.
 4625 }
 4626 
 4627 % We have to swallow the remaining "\_STOP_".
 4628 %
 4629 \def\doignoretextzzz#1{%
 4630   \ifnum\doignorecount = 0  % We have just found the outermost @end.
 4631     \let\next\enddoignore
 4632   \else             % Still inside a nested condition.
 4633     \advance\doignorecount by -1
 4634     \let\next\doignoretext      % Look for the next @end.
 4635   \fi
 4636   \next
 4637 }
 4638 
 4639 % Finish off ignored text.
 4640 { \obeylines%
 4641   % Ignore anything after the last `@end #1'; this matters in verbatim
 4642   % environments, where otherwise the newline after an ignored conditional
 4643   % would result in a blank line in the output.
 4644   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
 4645 }
 4646 
 4647 
 4648 % @set VAR sets the variable VAR to an empty value.
 4649 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
 4650 %
 4651 % Since we want to separate VAR from REST-OF-LINE (which might be
 4652 % empty), we can't just use \parsearg; we have to insert a space of our
 4653 % own to delimit the rest of the line, and then take it out again if we
 4654 % didn't need it.
 4655 % We rely on the fact that \parsearg sets \catcode`\ =10.
 4656 %
 4657 \parseargdef\set{\setyyy#1 \endsetyyy}
 4658 \def\setyyy#1 #2\endsetyyy{%
 4659   {%
 4660     \makevalueexpandable
 4661     \def\temp{#2}%
 4662     \edef\next{\gdef\makecsname{SET#1}}%
 4663     \ifx\temp\empty
 4664       \next{}%
 4665     \else
 4666       \setzzz#2\endsetzzz
 4667     \fi
 4668   }%
 4669 }
 4670 % Remove the trailing space \setxxx inserted.
 4671 \def\setzzz#1 \endsetzzz{\next{#1}}
 4672 
 4673 % @clear VAR clears (i.e., unsets) the variable VAR.
 4674 %
 4675 \parseargdef\clear{%
 4676   {%
 4677     \makevalueexpandable
 4678     \global\expandafter\let\csname SET#1\endcsname=\relax
 4679   }%
 4680 }
 4681 
 4682 % @value{foo} gets the text saved in variable foo.
 4683 \def\value{\begingroup\makevalueexpandable\valuexxx}
 4684 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
 4685 {
 4686   \catcode`\-=\active \catcode`\_=\active
 4687   %
 4688   \gdef\makevalueexpandable{%
 4689     \let\value = \expandablevalue
 4690     % We don't want these characters active, ...
 4691     \catcode`\-=\other \catcode`\_=\other
 4692     % ..., but we might end up with active ones in the argument if
 4693     % we're called from @code, as @code{@value{foo-bar_}}, though.
 4694     % So \let them to their normal equivalents.
 4695     \let-\normaldash \let_\normalunderscore
 4696   }
 4697 }
 4698 
 4699 % We have this subroutine so that we can handle at least some @value's
 4700 % properly in indexes (we call \makevalueexpandable in \indexdummies).
 4701 % The command has to be fully expandable (if the variable is set), since
 4702 % the result winds up in the index file.  This means that if the
 4703 % variable's value contains other Texinfo commands, it's almost certain
 4704 % it will fail (although perhaps we could fix that with sufficient work
 4705 % to do a one-level expansion on the result, instead of complete).
 4706 % 
 4707 % Unfortunately, this has the consequence that when _ is in the *value*
 4708 % of an @set, it does not print properly in the roman fonts (get the cmr
 4709 % dot accent at position 126 instead).  No fix comes to mind, and it's
 4710 % been this way since 2003 or earlier, so just ignore it.
 4711 % 
 4712 \def\expandablevalue#1{%
 4713   \expandafter\ifx\csname SET#1\endcsname\relax
 4714     {[No value for ``#1'']}%
 4715     \message{Variable `#1', used in @value, is not set.}%
 4716   \else
 4717     \csname SET#1\endcsname
 4718   \fi
 4719 }
 4720 
 4721 % Like \expandablevalue, but completely expandable (the \message in the
 4722 % definition above operates at the execution level of TeX).  Used when
 4723 % writing to auxiliary files, due to the expansion that \write does.
 4724 % If flag is undefined, pass through an unexpanded @value command: maybe it 
 4725 % will be set by the time it is read back in.
 4726 %
 4727 % NB flag names containing - or _ may not work here.
 4728 \def\dummyvalue#1{%
 4729   \expandafter\ifx\csname SET#1\endcsname\relax
 4730     \noexpand\value{#1}%
 4731   \else
 4732     \csname SET#1\endcsname
 4733   \fi
 4734 }
 4735 
 4736 % Used for @value's in index entries to form the sort key: expand the @value
 4737 % if possible, otherwise sort late.
 4738 \def\indexnofontsvalue#1{%
 4739   \expandafter\ifx\csname SET#1\endcsname\relax
 4740     ZZZZZZZ
 4741   \else
 4742     \csname SET#1\endcsname
 4743   \fi
 4744 }
 4745 
 4746 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
 4747 % with @set.
 4748 % 
 4749 % To get the special treatment we need for `@end ifset,' we call
 4750 % \makecond and then redefine.
 4751 %
 4752 \makecond{ifset}
 4753 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
 4754 \def\doifset#1#2{%
 4755   {%
 4756     \makevalueexpandable
 4757     \let\next=\empty
 4758     \expandafter\ifx\csname SET#2\endcsname\relax
 4759       #1% If not set, redefine \next.
 4760     \fi
 4761     \expandafter
 4762   }\next
 4763 }
 4764 \def\ifsetfail{\doignore{ifset}}
 4765 
 4766 % @ifclear VAR ... @end executes the `...' iff VAR has never been
 4767 % defined with @set, or has been undefined with @clear.
 4768 %
 4769 % The `\else' inside the `\doifset' parameter is a trick to reuse the
 4770 % above code: if the variable is not set, do nothing, if it is set,
 4771 % then redefine \next to \ifclearfail.
 4772 %
 4773 \makecond{ifclear}
 4774 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
 4775 \def\ifclearfail{\doignore{ifclear}}
 4776 
 4777 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
 4778 % without the @) is in fact defined.  We can only feasibly check at the
 4779 % TeX level, so something like `mathcode' is going to considered
 4780 % defined even though it is not a Texinfo command.
 4781 % 
 4782 \makecond{ifcommanddefined}
 4783 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
 4784 %
 4785 \def\doifcmddefined#1#2{{%
 4786     \makevalueexpandable
 4787     \let\next=\empty
 4788     \expandafter\ifx\csname #2\endcsname\relax
 4789       #1% If not defined, \let\next as above.
 4790     \fi
 4791     \expandafter
 4792   }\next
 4793 }
 4794 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
 4795 
 4796 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
 4797 \makecond{ifcommandnotdefined}
 4798 \def\ifcommandnotdefined{%
 4799   \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
 4800 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
 4801 
 4802 % Set the `txicommandconditionals' variable, so documents have a way to
 4803 % test if the @ifcommand...defined conditionals are available.
 4804 \set txicommandconditionals
 4805 
 4806 % @dircategory CATEGORY  -- specify a category of the dir file
 4807 % which this file should belong to.  Ignore this in TeX.
 4808 \let\dircategory=\comment
 4809 
 4810 % @defininfoenclose.
 4811 \let\definfoenclose=\comment
 4812 
 4813 
 4814 \message{indexing,}
 4815 % Index generation facilities
 4816 
 4817 % Define \newwrite to be identical to plain tex's \newwrite
 4818 % except not \outer, so it can be used within macros and \if's.
 4819 \edef\newwrite{\makecsname{ptexnewwrite}}
 4820 
 4821 % \newindex {foo} defines an index named IX.
 4822 % It automatically defines \IXindex such that
 4823 % \IXindex ...rest of line... puts an entry in the index IX.
 4824 % It also defines \IXindfile to be the number of the output channel for
 4825 % the file that accumulates this index.  The file's extension is IX.
 4826 % The name of an index should be no more than 2 characters long
 4827 % for the sake of vms.
 4828 %
 4829 \def\newindex#1{%
 4830   \expandafter\chardef\csname#1indfile\endcsname=0
 4831   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
 4832     \noexpand\doindex{#1}}
 4833 }
 4834 
 4835 % @defindex foo  ==  \newindex{foo}
 4836 %
 4837 \def\defindex{\parsearg\newindex}
 4838 
 4839 % Define @defcodeindex, like @defindex except put all entries in @code.
 4840 %
 4841 \def\defcodeindex{\parsearg\newcodeindex}
 4842 %
 4843 \def\newcodeindex#1{%
 4844   \expandafter\chardef\csname#1indfile\endcsname=0
 4845   \expandafter\xdef\csname#1index\endcsname{%
 4846     \noexpand\docodeindex{#1}}%
 4847 }
 4848 
 4849 % The default indices:
 4850 \newindex{cp}%      concepts,
 4851 \newcodeindex{fn}%  functions,
 4852 \newcodeindex{vr}%  variables,
 4853 \newcodeindex{tp}%  types,
 4854 \newcodeindex{ky}%  keys
 4855 \newcodeindex{pg}%  and programs.
 4856 
 4857 
 4858 % @synindex foo bar    makes index foo feed into index bar.
 4859 % Do this instead of @defindex foo if you don't want it as a separate index.
 4860 %
 4861 % @syncodeindex foo bar   similar, but put all entries made for index foo
 4862 % inside @code.
 4863 %
 4864 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
 4865 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
 4866 
 4867 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
 4868 % #3 the target index (bar).
 4869 \def\dosynindex#1#2#3{%
 4870   \requireopenindexfile{#3}%
 4871   % redefine \fooindfile:
 4872   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
 4873   \expandafter\let\csname#2indfile\endcsname=\temp
 4874   % redefine \fooindex:
 4875   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
 4876 }
 4877 
 4878 % Define \doindex, the driver for all index macros.
 4879 % Argument #1 is generated by the calling \fooindex macro,
 4880 % and it is the two-letter name of the index.
 4881 
 4882 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
 4883 \def\doindexxxx #1{\doind{\indexname}{#1}}
 4884 
 4885 % like the previous two, but they put @code around the argument.
 4886 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
 4887 \def\docodeindexxxx #1{\doind{\indexname}{\code{#1}}}
 4888 
 4889 
 4890 % Used when writing an index entry out to an index file to prevent
 4891 % expansion of Texinfo commands that can appear in an index entry.
 4892 %
 4893 \def\indexdummies{%
 4894   \escapechar = `\\     % use backslash in output files.
 4895   \definedummyletter\@%
 4896   \definedummyletter\ %
 4897   %
 4898   % For texindex which always views { and } as separators.
 4899   \def\{{\lbracechar{}}%
 4900   \def\}{\rbracechar{}}%
 4901   %
 4902   % Do the redefinitions.
 4903   \definedummies
 4904 }
 4905 
 4906 % Used for the aux and toc files, where @ is the escape character.
 4907 %
 4908 \def\atdummies{%
 4909   \definedummyletter\@%
 4910   \definedummyletter\ %
 4911   \definedummyletter\{%
 4912   \definedummyletter\}%
 4913   %
 4914   % Do the redefinitions.
 4915   \definedummies
 4916   \otherbackslash
 4917 }
 4918 
 4919 % \definedummyword defines \#1 as \string\#1\space, thus effectively
 4920 % preventing its expansion.  This is used only for control words,
 4921 % not control letters, because the \space would be incorrect for
 4922 % control characters, but is needed to separate the control word
 4923 % from whatever follows.
 4924 %
 4925 % These can be used both for control words that take an argument and
 4926 % those that do not.  If it is followed by {arg} in the input, then
 4927 % that will dutifully get written to the index (or wherever).
 4928 %
 4929 % For control letters, we have \definedummyletter, which omits the
 4930 % space.
 4931 %
 4932 \def\definedummyword  #1{\def#1{\string#1\space}}%
 4933 \def\definedummyletter#1{\def#1{\string#1}}%
 4934 \let\definedummyaccent\definedummyletter
 4935 
 4936 % Called from \indexdummies and \atdummies, to effectively prevent
 4937 % the expansion of commands.
 4938 %
 4939 \def\definedummies{%
 4940   %
 4941   \let\commondummyword\definedummyword
 4942   \let\commondummyletter\definedummyletter
 4943   \let\commondummyaccent\definedummyaccent
 4944   \commondummiesnofonts
 4945   %
 4946   \definedummyletter\_%
 4947   \definedummyletter\-%
 4948   %
 4949   % Non-English letters.
 4950   \definedummyword\AA
 4951   \definedummyword\AE
 4952   \definedummyword\DH
 4953   \definedummyword\L
 4954   \definedummyword\O
 4955   \definedummyword\OE
 4956   \definedummyword\TH
 4957   \definedummyword\aa
 4958   \definedummyword\ae
 4959   \definedummyword\dh
 4960   \definedummyword\exclamdown
 4961   \definedummyword\l
 4962   \definedummyword\o
 4963   \definedummyword\oe
 4964   \definedummyword\ordf
 4965   \definedummyword\ordm
 4966   \definedummyword\questiondown
 4967   \definedummyword\ss
 4968   \definedummyword\th
 4969   %
 4970   % Although these internal commands shouldn't show up, sometimes they do.
 4971   \definedummyword\bf
 4972   \definedummyword\gtr
 4973   \definedummyword\hat
 4974   \definedummyword\less
 4975   \definedummyword\sf
 4976   \definedummyword\sl
 4977   \definedummyword\tclose
 4978   \definedummyword\tt
 4979   %
 4980   \definedummyword\LaTeX
 4981   \definedummyword\TeX
 4982   %
 4983   % Assorted special characters.
 4984   \definedummyword\atchar
 4985   \definedummyword\arrow
 4986   \definedummyword\bullet
 4987   \definedummyword\comma
 4988   \definedummyword\copyright
 4989   \definedummyword\registeredsymbol
 4990   \definedummyword\dots
 4991   \definedummyword\enddots
 4992   \definedummyword\entrybreak
 4993   \definedummyword\equiv
 4994   \definedummyword\error
 4995   \definedummyword\euro
 4996   \definedummyword\expansion
 4997   \definedummyword\geq
 4998   \definedummyword\guillemetleft
 4999   \definedummyword\guillemetright
 5000   \definedummyword\guilsinglleft
 5001   \definedummyword\guilsinglright
 5002   \definedummyword\lbracechar
 5003   \definedummyword\leq
 5004   \definedummyword\mathopsup
 5005   \definedummyword\minus
 5006   \definedummyword\ogonek
 5007   \definedummyword\pounds
 5008   \definedummyword\point
 5009   \definedummyword\print
 5010   \definedummyword\quotedblbase
 5011   \definedummyword\quotedblleft
 5012   \definedummyword\quotedblright
 5013   \definedummyword\quoteleft
 5014   \definedummyword\quoteright
 5015   \definedummyword\quotesinglbase
 5016   \definedummyword\rbracechar
 5017   \definedummyword\result
 5018   \definedummyword\sub
 5019   \definedummyword\sup
 5020   \definedummyword\textdegree
 5021   %
 5022   % We want to disable all macros so that they are not expanded by \write.
 5023   \macrolist
 5024   \let\value\dummyvalue
 5025   %
 5026   \normalturnoffactive
 5027 }
 5028 
 5029 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
 5030 % Define \commondummyletter, \commondummyaccent and \commondummyword before
 5031 % using.  Used for accents, font commands, and various control letters.
 5032 %
 5033 \def\commondummiesnofonts{%
 5034   % Control letters and accents.
 5035   \commondummyletter\!%
 5036   \commondummyaccent\"%
 5037   \commondummyaccent\'%
 5038   \commondummyletter\*%
 5039   \commondummyaccent\,%
 5040   \commondummyletter\.%
 5041   \commondummyletter\/%
 5042   \commondummyletter\:%
 5043   \commondummyaccent\=%
 5044   \commondummyletter\?%
 5045   \commondummyaccent\^%
 5046   \commondummyaccent\`%
 5047   \commondummyaccent\~%
 5048   \commondummyword\u
 5049   \commondummyword\v
 5050   \commondummyword\H
 5051   \commondummyword\dotaccent
 5052   \commondummyword\ogonek
 5053   \commondummyword\ringaccent
 5054   \commondummyword\tieaccent
 5055   \commondummyword\ubaraccent
 5056   \commondummyword\udotaccent
 5057   \commondummyword\dotless
 5058   %
 5059   % Texinfo font commands.
 5060   \commondummyword\b
 5061   \commondummyword\i
 5062   \commondummyword\r
 5063   \commondummyword\sansserif
 5064   \commondummyword\sc
 5065   \commondummyword\slanted
 5066   \commondummyword\t
 5067   %
 5068   % Commands that take arguments.
 5069   \commondummyword\abbr
 5070   \commondummyword\acronym
 5071   \commondummyword\anchor
 5072   \commondummyword\cite
 5073   \commondummyword\code
 5074   \commondummyword\command
 5075   \commondummyword\dfn
 5076   \commondummyword\dmn
 5077   \commondummyword\email
 5078   \commondummyword\emph
 5079   \commondummyword\env
 5080   \commondummyword\file
 5081   \commondummyword\image
 5082   \commondummyword\indicateurl
 5083   \commondummyword\inforef
 5084   \commondummyword\kbd
 5085   \commondummyword\key
 5086   \commondummyword\math
 5087   \commondummyword\option
 5088   \commondummyword\pxref
 5089   \commondummyword\ref
 5090   \commondummyword\samp
 5091   \commondummyword\strong
 5092   \commondummyword\tie
 5093   \commondummyword\U
 5094   \commondummyword\uref
 5095   \commondummyword\url
 5096   \commondummyword\var
 5097   \commondummyword\verb
 5098   \commondummyword\w
 5099   \commondummyword\xref
 5100 }
 5101 
 5102 % For testing: output @{ and @} in index sort strings as \{ and \}.
 5103 \newif\ifusebracesinindexes
 5104 
 5105 \let\indexlbrace\relax
 5106 \let\indexrbrace\relax
 5107 
 5108 {\catcode`\@=0
 5109 \catcode`\\=13
 5110   @gdef@backslashdisappear{@def\{}}
 5111 }
 5112 
 5113 {
 5114 \catcode`\<=13
 5115 \catcode`\-=13
 5116 \catcode`\`=13
 5117   \gdef\indexnonalnumdisappear{%
 5118     \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
 5119       % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
 5120       % (Introduced for FSFS 2nd ed.)
 5121       \let`=\empty
 5122     \fi
 5123     %
 5124     \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
 5125       \backslashdisappear
 5126     \fi
 5127     %
 5128     \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
 5129       \def-{}%
 5130     \fi
 5131     \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
 5132       \def<{}%
 5133     \fi
 5134     \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
 5135       \def\@{}%
 5136     \fi
 5137   }
 5138 
 5139   \gdef\indexnonalnumreappear{%
 5140     \useindexbackslash
 5141     \let-\normaldash
 5142     \let<\normalless
 5143     \def\@{@}%
 5144   }
 5145 }
 5146 
 5147 
 5148 % \indexnofonts is used when outputting the strings to sort the index
 5149 % by, and when constructing control sequence names.  It eliminates all
 5150 % control sequences and just writes whatever the best ASCII sort string
 5151 % would be for a given command (usually its argument).
 5152 %
 5153 \def\indexnofonts{%
 5154   % Accent commands should become @asis.
 5155   \def\commondummyaccent##1{\let##1\asis}%
 5156   % We can just ignore other control letters.
 5157   \def\commondummyletter##1{\let##1\empty}%
 5158   % All control words become @asis by default; overrides below.
 5159   \let\commondummyword\commondummyaccent
 5160   \commondummiesnofonts
 5161   %
 5162   % Don't no-op \tt, since it isn't a user-level command
 5163   % and is used in the definitions of the active chars like <, >, |, etc.
 5164   % Likewise with the other plain tex font commands.
 5165   %\let\tt=\asis
 5166   %
 5167   \def\ { }%
 5168   \def\@{@}%
 5169   \def\_{\normalunderscore}%
 5170   \def\-{}% @- shouldn't affect sorting
 5171   %
 5172   \uccode`\1=`\{ \uppercase{\def\{{1}}%
 5173   \uccode`\1=`\} \uppercase{\def\}{1}}%
 5174   \let\lbracechar\{%
 5175   \let\rbracechar\}%
 5176   %
 5177   % Non-English letters.
 5178   \def\AA{AA}%
 5179   \def\AE{AE}%
 5180   \def\DH{DZZ}%
 5181   \def\L{L}%
 5182   \def\OE{OE}%
 5183   \def\O{O}%
 5184   \def\TH{TH}%
 5185   \def\aa{aa}%
 5186   \def\ae{ae}%
 5187   \def\dh{dzz}%
 5188   \def\exclamdown{!}%
 5189   \def\l{l}%
 5190   \def\oe{oe}%
 5191   \def\ordf{a}%
 5192   \def\ordm{o}%
 5193   \def\o{o}%
 5194   \def\questiondown{?}%
 5195   \def\ss{ss}%
 5196   \def\th{th}%
 5197   %
 5198   \def\LaTeX{LaTeX}%
 5199   \def\TeX{TeX}%
 5200   %
 5201   % Assorted special characters.  \defglyph gives the control sequence a
 5202   % definition that removes the {} that follows its use.
 5203   \defglyph\atchar{@}%
 5204   \defglyph\arrow{->}%
 5205   \defglyph\bullet{bullet}%
 5206   \defglyph\comma{,}%
 5207   \defglyph\copyright{copyright}%
 5208   \defglyph\dots{...}%
 5209   \defglyph\enddots{...}%
 5210   \defglyph\equiv{==}%
 5211   \defglyph\error{error}%
 5212   \defglyph\euro{euro}%
 5213   \defglyph\expansion{==>}%
 5214   \defglyph\geq{>=}%
 5215   \defglyph\guillemetleft{<<}%
 5216   \defglyph\guillemetright{>>}%
 5217   \defglyph\guilsinglleft{<}%
 5218   \defglyph\guilsinglright{>}%
 5219   \defglyph\leq{<=}%
 5220   \defglyph\lbracechar{\{}%
 5221   \defglyph\minus{-}%
 5222   \defglyph\point{.}%
 5223   \defglyph\pounds{pounds}%
 5224   \defglyph\print{-|}%
 5225   \defglyph\quotedblbase{"}%
 5226   \defglyph\quotedblleft{"}%
 5227   \defglyph\quotedblright{"}%
 5228   \defglyph\quoteleft{`}%
 5229   \defglyph\quoteright{'}%
 5230   \defglyph\quotesinglbase{,}%
 5231   \defglyph\rbracechar{\}}%
 5232   \defglyph\registeredsymbol{R}%
 5233   \defglyph\result{=>}%
 5234   \defglyph\textdegree{o}%
 5235   %
 5236   % We need to get rid of all macros, leaving only the arguments (if present).
 5237   % Of course this is not nearly correct, but it is the best we can do for now.
 5238   % makeinfo does not expand macros in the argument to @deffn, which ends up
 5239   % writing an index entry, and texindex isn't prepared for an index sort entry
 5240   % that starts with \.
 5241   %
 5242   % Since macro invocations are followed by braces, we can just redefine them
 5243   % to take a single TeX argument.  The case of a macro invocation that
 5244   % goes to end-of-line is not handled.
 5245   %
 5246   \macrolist
 5247   \let\value\indexnofontsvalue
 5248 }
 5249 \def\defglyph#1#2{\def#1##1{#2}} % see above
 5250 
 5251 
 5252 
 5253 
 5254 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
 5255 
 5256 % Most index entries go through here, but \dosubind is the general case.
 5257 % #1 is the index name, #2 is the entry text.
 5258 \def\doind#1#2{\dosubind{#1}{#2}{}}
 5259 
 5260 % There is also \dosubind {index}{topic}{subtopic}
 5261 % which makes an entry in a two-level index such as the operation index.
 5262 % TODO: Two-level index?  Operation index?
 5263 
 5264 % Workhorse for all indexes.
 5265 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
 5266 % empty if called from \doind, as we usually are (the main exception
 5267 % is with most defuns, which call us directly).
 5268 %
 5269 \def\dosubind#1#2#3{%
 5270   \iflinks
 5271   {%
 5272     \requireopenindexfile{#1}%
 5273     % Store the main index entry text (including the third arg).
 5274     \toks0 = {#2}%
 5275     % If third arg is present, precede it with a space.
 5276     \def\thirdarg{#3}%
 5277     \ifx\thirdarg\empty \else
 5278       \toks0 = \expandafter{\the\toks0 \space #3}%
 5279     \fi
 5280     %
 5281     \edef\writeto{\csname#1indfile\endcsname}%
 5282     %
 5283     \safewhatsit\dosubindwrite
 5284   }%
 5285   \fi
 5286 }
 5287 
 5288 % Check if an index file has been opened, and if not, open it.
 5289 \def\requireopenindexfile#1{%
 5290 \ifnum\csname #1indfile\endcsname=0
 5291   \expandafter\newwrite \csname#1indfile\endcsname
 5292   \edef\suffix{#1}%
 5293   % A .fls suffix would conflict with the file extension for the output
 5294   % of -recorder, so use .f1s instead.
 5295   \ifx\suffix\indexisfl\def\suffix{f1}\fi
 5296   % Open the file
 5297   \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
 5298   % Using \immediate above here prevents an object entering into the current 
 5299   % box, which could confound checks such as those in \safewhatsit for
 5300   % preceding skips.
 5301   \typeout{Writing index file \jobname.\suffix}%
 5302 \fi}
 5303 \def\indexisfl{fl}
 5304 
 5305 % Output \ as {\indexbackslash}, because \ is an escape character in
 5306 % the index files.
 5307 \let\indexbackslash=\relax
 5308 {\catcode`\@=0 \catcode`\\=\active
 5309   @gdef@useindexbackslash{@def\{{@indexbackslash}}}
 5310 }
 5311 
 5312 % Definition for writing index entry text.
 5313 \def\sortas#1{\ignorespaces}%
 5314 
 5315 % Definition for writing index entry sort key.  Should occur at the at
 5316 % the beginning of the index entry, like
 5317 %     @cindex @sortas{september} \september
 5318 % The \ignorespaces takes care of following space, but there's no way
 5319 % to remove space before it.
 5320 {
 5321 \catcode`\-=13
 5322 \gdef\indexwritesortas{%
 5323   \begingroup
 5324   \indexnonalnumreappear
 5325   \indexwritesortasxxx}
 5326 \gdef\indexwritesortasxxx#1{%
 5327   \xdef\indexsortkey{#1}\endgroup}
 5328 }
 5329 
 5330 
 5331 % Write the entry in \toks0 to the index file.
 5332 %
 5333 \def\dosubindwrite{%
 5334   % Put the index entry in the margin if desired.
 5335   \ifx\SETmarginindex\relax\else
 5336     \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
 5337   \fi
 5338   %
 5339   % Remember, we are within a group.
 5340   \indexdummies % Must do this here, since \bf, etc expand at this stage
 5341   \useindexbackslash % \indexbackslash isn't defined now so it will be output 
 5342                      % as is; and it will print as backslash.
 5343   % The braces around \indexbrace are recognized by texindex.
 5344   %
 5345   % Get the string to sort by, by processing the index entry with all
 5346   % font commands turned off.
 5347   {\indexnofonts
 5348    \def\lbracechar{{\indexlbrace}}%
 5349    \def\rbracechar{{\indexrbrace}}%
 5350    \let\{=\lbracechar
 5351    \let\}=\rbracechar
 5352    \indexnonalnumdisappear
 5353    \xdef\indexsortkey{}%
 5354    \let\sortas=\indexwritesortas
 5355    \edef\temp{\the\toks0}%
 5356    \setbox\dummybox = \hbox{\temp}% Make sure to execute any \sortas
 5357    \ifx\indexsortkey\empty
 5358      \xdef\indexsortkey{\temp}%
 5359      \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
 5360    \fi
 5361   }%
 5362   %
 5363   % Set up the complete index entry, with both the sort key and
 5364   % the original text, including any font commands.  We write
 5365   % three arguments to \entry to the .?? file (four in the
 5366   % subentry case), texindex reduces to two when writing the .??s
 5367   % sorted result.
 5368   \edef\temp{%
 5369     \write\writeto{%
 5370       \string\entry{\indexsortkey}{\noexpand\folio}{\the\toks0}}%
 5371   }%
 5372   \temp
 5373 }
 5374 \newbox\dummybox % used above
 5375 
 5376 % Take care of unwanted page breaks/skips around a whatsit:
 5377 %
 5378 % If a skip is the last thing on the list now, preserve it
 5379 % by backing up by \lastskip, doing the \write, then inserting
 5380 % the skip again.  Otherwise, the whatsit generated by the
 5381 % \write or \pdfdest will make \lastskip zero.  The result is that
 5382 % sequences like this:
 5383 % @end defun
 5384 % @tindex whatever
 5385 % @defun ...
 5386 % will have extra space inserted, because the \medbreak in the
 5387 % start of the @defun won't see the skip inserted by the @end of
 5388 % the previous defun.
 5389 %
 5390 % But don't do any of this if we're not in vertical mode.  We
 5391 % don't want to do a \vskip and prematurely end a paragraph.
 5392 %
 5393 % Avoid page breaks due to these extra skips, too.
 5394 %
 5395 % But wait, there is a catch there:
 5396 % We'll have to check whether \lastskip is zero skip.  \ifdim is not
 5397 % sufficient for this purpose, as it ignores stretch and shrink parts
 5398 % of the skip.  The only way seems to be to check the textual
 5399 % representation of the skip.
 5400 %
 5401 % The following is almost like \def\zeroskipmacro{0.0pt} except that
 5402 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
 5403 %
 5404 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
 5405 %
 5406 \newskip\whatsitskip
 5407 \newcount\whatsitpenalty
 5408 %
 5409 % ..., ready, GO:
 5410 %
 5411 \def\safewhatsit#1{\ifhmode
 5412   #1%
 5413  \else
 5414   % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
 5415   \whatsitskip = \lastskip
 5416   \edef\lastskipmacro{\the\lastskip}%
 5417   \whatsitpenalty = \lastpenalty
 5418   %
 5419   % If \lastskip is nonzero, that means the last item was a
 5420   % skip.  And since a skip is discardable, that means this
 5421   % -\whatsitskip glue we're inserting is preceded by a
 5422   % non-discardable item, therefore it is not a potential
 5423   % breakpoint, therefore no \nobreak needed.
 5424   \ifx\lastskipmacro\zeroskipmacro
 5425   \else
 5426     \vskip-\whatsitskip
 5427   \fi
 5428   %
 5429   #1%
 5430   %
 5431   \ifx\lastskipmacro\zeroskipmacro
 5432     % If \lastskip was zero, perhaps the last item was a penalty, and
 5433     % perhaps it was >=10000, e.g., a \nobreak.  In that case, we want
 5434     % to re-insert the same penalty (values >10000 are used for various
 5435     % signals); since we just inserted a non-discardable item, any
 5436     % following glue (such as a \parskip) would be a breakpoint.  For example:
 5437     %   @deffn deffn-whatever
 5438     %   @vindex index-whatever
 5439     %   Description.
 5440     % would allow a break between the index-whatever whatsit
 5441     % and the "Description." paragraph.
 5442     \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
 5443   \else
 5444     % On the other hand, if we had a nonzero \lastskip,
 5445     % this make-up glue would be preceded by a non-discardable item
 5446     % (the whatsit from the \write), so we must insert a \nobreak.
 5447     \nobreak\vskip\whatsitskip
 5448   \fi
 5449 \fi}
 5450 
 5451 % The index entry written in the file actually looks like
 5452 %  \entry {sortstring}{page}{topic}
 5453 % or
 5454 %  \entry {sortstring}{page}{topic}{subtopic}
 5455 % The texindex program reads in these files and writes files
 5456 % containing these kinds of lines:
 5457 %  \initial {c}
 5458 %     before the first topic whose initial is c
 5459 %  \entry {topic}{pagelist}
 5460 %     for a topic that is used without subtopics
 5461 %  \primary {topic}
 5462 %     for the beginning of a topic that is used with subtopics
 5463 %  \secondary {subtopic}{pagelist}
 5464 %     for each subtopic.
 5465 
 5466 % Define the user-accessible indexing commands
 5467 % @findex, @vindex, @kindex, @cindex.
 5468 
 5469 \def\findex {\fnindex}
 5470 \def\kindex {\kyindex}
 5471 \def\cindex {\cpindex}
 5472 \def\vindex {\vrindex}
 5473 \def\tindex {\tpindex}
 5474 \def\pindex {\pgindex}
 5475 
 5476 \def\cindexsub {\begingroup\obeylines\cindexsub}
 5477 {\obeylines %
 5478 \gdef\cindexsub "#1" #2^^M{\endgroup %
 5479 \dosubind{cp}{#2}{#1}}}
 5480 
 5481 % Define the macros used in formatting output of the sorted index material.
 5482 
 5483 % @printindex causes a particular index (the ??s file) to get printed.
 5484 % It does not print any chapter heading (usually an @unnumbered).
 5485 %
 5486 \parseargdef\printindex{\begingroup
 5487   \dobreak \chapheadingskip{10000}%
 5488   %
 5489   \smallfonts \rm
 5490   \tolerance = 9500
 5491   \plainfrenchspacing
 5492   \everypar = {}% don't want the \kern\-parindent from indentation suppression.
 5493   %
 5494   % See if the index file exists and is nonempty.
 5495   % Change catcode of @ here so that if the index file contains
 5496   % \initial {@}
 5497   % as its first line, TeX doesn't complain about mismatched braces
 5498   % (because it thinks @} is a control sequence).
 5499   \catcode`\@ = 12
 5500   % See comment in \requireopenindexfile.
 5501   \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
 5502   \openin 1 \jobname.\indexname s
 5503   \ifeof 1
 5504     % \enddoublecolumns gets confused if there is no text in the index,
 5505     % and it loses the chapter title and the aux file entries for the
 5506     % index.  The easiest way to prevent this problem is to make sure
 5507     % there is some text.
 5508     \putwordIndexNonexistent
 5509     \typeout{No file \jobname.\indexname s.}%
 5510   \else
 5511     \catcode`\\ = 0
 5512     %
 5513     % If the index file exists but is empty, then \openin leaves \ifeof
 5514     % false.  We have to make TeX try to read something from the file, so
 5515     % it can discover if there is anything in it.
 5516     \read 1 to \thisline
 5517     \ifeof 1
 5518       \putwordIndexIsEmpty
 5519     \else
 5520       % Index files are almost Texinfo source, but we use \ as the escape
 5521       % character.  It would be better to use @, but that's too big a change
 5522       % to make right now.
 5523       \def\indexbackslash{\ttbackslash}%
 5524       \let\indexlbrace\{   % Likewise, set these sequences for braces
 5525       \let\indexrbrace\}   % used in the sort key.
 5526       \begindoublecolumns
 5527       \let\dotheinsertentrybox\dotheinsertentryboxwithpenalty
 5528       %
 5529       % Read input from the index file line by line.
 5530       \loopdo
 5531         \ifeof1 \else
 5532           \read 1 to \nextline
 5533         \fi
 5534         %
 5535         \indexinputprocessing
 5536         \thisline
 5537         %
 5538         \ifeof1\else
 5539         \let\thisline\nextline
 5540       \repeat
 5541       %%
 5542       \enddoublecolumns
 5543     \fi
 5544   \fi
 5545   \closein 1
 5546 \endgroup}
 5547 \def\loopdo#1\repeat{\def\body{#1}\loopdoxxx}
 5548 \def\loopdoxxx{\let\next=\relax\body\let\next=\loopdoxxx\fi\next}
 5549 
 5550 \def\indexinputprocessing{%
 5551   \ifeof1
 5552     \let\firsttoken\relax
 5553   \else
 5554     \edef\act{\gdef\noexpand\firsttoken{\getfirsttoken\nextline}}%
 5555     \act
 5556   \fi
 5557 }
 5558 \def\getfirsttoken#1{\expandafter\getfirsttokenx#1\endfirsttoken}
 5559 \long\def\getfirsttokenx#1#2\endfirsttoken{\noexpand#1}
 5560 
 5561 
 5562 % These macros are used by the sorted index file itself.
 5563 % Change them to control the appearance of the index.
 5564 
 5565 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
 5566 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
 5567 \catcode`\$=3
 5568 \gdef\initialglyphs{%
 5569   % Some changes for non-alphabetic characters.  Using the glyphs from the
 5570   % math fonts looks more consistent than the typewriter font used elsewhere
 5571   % for these characters.
 5572   \def\indexbackslash{\math{\backslash}}%
 5573   \let\\=\indexbackslash
 5574   %
 5575   % Can't get bold backslash so don't use bold forward slash
 5576   \catcode`\/=13
 5577   \def/{{\secrmnotbold \normalslash}}%
 5578   \def-{{\normaldash\normaldash}}% en dash `--'
 5579   \def^{{\chapbf \normalcaret}}%
 5580   \def~{{\chapbf \normaltilde}}%
 5581   \def\_{%
 5582      \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
 5583   \def|{$\vert$}%
 5584   \def<{$\less$}%
 5585   \def>{$\gtr$}%
 5586   \def+{$\normalplus$}%
 5587 }}
 5588 
 5589 \def\initial{%
 5590   \bgroup
 5591   \initialglyphs
 5592   \initialx
 5593 }
 5594 
 5595 \def\initialx#1{%
 5596   % Remove any glue we may have, we'll be inserting our own.
 5597   \removelastskip
 5598   %
 5599   % We like breaks before the index initials, so insert a bonus.
 5600   % The glue before the bonus allows a little bit of space at the
 5601   % bottom of a column to reduce an increase in inter-line spacing.
 5602   \nobreak
 5603   \vskip 0pt plus 5\baselineskip
 5604   \penalty -300 
 5605   \vskip 0pt plus -5\baselineskip
 5606   %
 5607   % Typeset the initial.  Making this add up to a whole number of
 5608   % baselineskips increases the chance of the dots lining up from column
 5609   % to column.  It still won't often be perfect, because of the stretch
 5610   % we need before each entry, but it's better.
 5611   %
 5612   % No shrink because it confuses \balancecolumns.
 5613   \vskip 1.67\baselineskip plus 1\baselineskip
 5614   \leftline{\secfonts \kern-0.05em \secbf #1}%
 5615   % \secfonts is inside the argument of \leftline so that the change of
 5616   % \baselineskip will not affect any glue inserted before the vbox that
 5617   % \leftline creates.
 5618   % Do our best not to break after the initial.
 5619   \nobreak
 5620   \vskip .33\baselineskip plus .1\baselineskip
 5621   \egroup % \initialglyphs
 5622 }
 5623 
 5624 \newdimen\entryrightmargin
 5625 \entryrightmargin=0pt
 5626 
 5627 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
 5628 % then page number (#2) flushed to the right margin.  It is used for index
 5629 % and table of contents entries.  The paragraph is indented by \leftskip.
 5630 %
 5631 \def\entry{%
 5632   \begingroup
 5633     %
 5634     % For pdfTeX and XeTeX.
 5635     % The redefinition of \domark stops marks being added in \pdflink to 
 5636     % preserve coloured links across page boundaries.  Otherwise the marks
 5637     % would get in the way of \lastbox in \insertentrybox.
 5638     \let\domark\relax
 5639     %
 5640     % Start a new paragraph if necessary, so our assignments below can't
 5641     % affect previous text.
 5642     \par
 5643     %
 5644     % No extra space above this paragraph.
 5645     \parskip = 0in
 5646     %
 5647     % When reading the text of entry, convert explicit line breaks
 5648     % from @* into spaces.  The user might give these in long section
 5649     % titles, for instance.
 5650     \def\*{\unskip\space\ignorespaces}%
 5651     \def\entrybreak{\hfil\break}% An undocumented command
 5652     %
 5653     % Swallow the left brace of the text (first parameter):
 5654     \afterassignment\doentry
 5655     \let\temp =
 5656 }
 5657 \def\entrybreak{\unskip\space\ignorespaces}%
 5658 \def\doentry{%
 5659     % Save the text of the entry
 5660     \global\setbox\boxA=\hbox\bgroup
 5661     \bgroup % Instead of the swallowed brace.
 5662       \noindent
 5663       \aftergroup\finishentry
 5664       % And now comes the text of the entry.
 5665       % Not absorbing as a macro argument reduces the chance of problems
 5666       % with catcodes occurring.
 5667 }
 5668 {\catcode`\@=11
 5669 \gdef\finishentry#1{%
 5670     \egroup % end box A
 5671     \dimen@ = \wd\boxA % Length of text of entry
 5672     \global\setbox\boxA=\hbox\bgroup\unhbox\boxA
 5673     % #1 is the page number.
 5674     %
 5675     % Get the width of the page numbers, and only use
 5676     % leaders if they are present.
 5677     \global\setbox\boxB = \hbox{#1}%
 5678     \ifdim\wd\boxB = 0pt
 5679       \null\nobreak\hfill\ %
 5680     \else
 5681       %
 5682       \null\nobreak\indexdotfill % Have leaders before the page number.
 5683       %
 5684       \ifpdf
 5685         \pdfgettoks#1.%
 5686         \hskip\skip\thinshrinkable\the\toksA
 5687       \else
 5688         \ifx\XeTeXrevision\thisisundefined
 5689           \hskip\skip\thinshrinkable #1%
 5690         \else
 5691           \pdfgettoks#1.%
 5692           \hskip\skip\thinshrinkable\the\toksA
 5693         \fi
 5694       \fi
 5695     \fi
 5696     \egroup % end \boxA
 5697     \ifdim\wd\boxB = 0pt
 5698       \global\setbox\entrybox=\vbox{\unhbox\boxA}%
 5699     \else
 5700     \global\setbox\entrybox=\vbox\bgroup
 5701       % We want the text of the entries to be aligned to the left, and the
 5702       % page numbers to be aligned to the right.
 5703       %
 5704       \parindent = 0pt
 5705       \advance\leftskip by 0pt plus 1fil
 5706       \advance\leftskip by 0pt plus -1fill
 5707       \rightskip = 0pt plus -1fil
 5708       \advance\rightskip by 0pt plus 1fill
 5709       % Cause last line, which could consist of page numbers on their own
 5710       % if the list of page numbers is long, to be aligned to the right.
 5711       \parfillskip=0pt plus -1fill
 5712       %
 5713       \advance\rightskip by \entryrightmargin
 5714       % Determine how far we can stretch into the margin.
 5715       % This allows, e.g., "Appendix H  GNU Free Documentation License" to
 5716       % fit on one line in @letterpaper format.
 5717       \ifdim\entryrightmargin>2.1em
 5718         \dimen@i=2.1em
 5719       \else
 5720         \dimen@i=0em
 5721       \fi
 5722       \advance \parfillskip by 0pt minus 1\dimen@i
 5723       %
 5724       \dimen@ii = \hsize
 5725       \advance\dimen@ii by -1\leftskip
 5726       \advance\dimen@ii by -1\entryrightmargin
 5727       \advance\dimen@ii by 1\dimen@i
 5728       \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
 5729       \ifdim\dimen@ > 0.8\dimen@ii   % due to long index text
 5730         % Try to split the text roughly evenly.  \dimen@ will be the length of 
 5731         % the first line.
 5732         \dimen@ = 0.7\dimen@
 5733         \dimen@ii = \hsize
 5734         \ifnum\dimen@>\dimen@ii
 5735           % If the entry is too long (for example, if it needs more than
 5736           % two lines), use all the space in the first line.
 5737           \dimen@ = \dimen@ii
 5738         \fi
 5739         \advance\leftskip by 0pt plus 1fill % ragged right
 5740         \advance \dimen@ by 1\rightskip
 5741         \parshape = 2 0pt \dimen@ 0em \dimen@ii
 5742         % Ideally we'd add a finite glue at the end of the first line only,
 5743         % instead of using \parshape with explicit line lengths, but TeX
 5744         % doesn't seem to provide a way to do such a thing.
 5745         %
 5746         % Indent all lines but the first one.
 5747         \advance\leftskip by 1em
 5748         \advance\parindent by -1em
 5749       \fi\fi
 5750       \indent % start paragraph
 5751       \unhbox\boxA
 5752       %
 5753       % Do not prefer a separate line ending with a hyphen to fewer lines.
 5754       \finalhyphendemerits = 0
 5755       %
 5756       % Word spacing - no stretch
 5757       \spaceskip=\fontdimen2\font minus \fontdimen4\font
 5758       %
 5759       \linepenalty=1000  % Discourage line breaks.
 5760       \hyphenpenalty=5000  % Discourage hyphenation.
 5761       %
 5762       \par % format the paragraph
 5763     \egroup % The \vbox
 5764     \fi
 5765   \endgroup
 5766   \dotheinsertentrybox
 5767 }}
 5768 
 5769 \newskip\thinshrinkable
 5770 \skip\thinshrinkable=.15em minus .15em
 5771 
 5772 \newbox\entrybox
 5773 \def\insertentrybox{%
 5774   \ourunvbox\entrybox
 5775 }
 5776 
 5777 % default definition
 5778 \let\dotheinsertentrybox\insertentrybox
 5779 
 5780 % Use \lastbox to take apart vbox box by box, and add each sub-box
 5781 % to the current vertical list.
 5782 \def\ourunvbox#1{%
 5783 \bgroup % for local binding of \delayedbox
 5784   % Remove the last box from box #1
 5785   \global\setbox#1=\vbox{%
 5786     \unvbox#1%
 5787     \unskip % remove any glue
 5788     \unpenalty
 5789     \global\setbox\interbox=\lastbox
 5790   }%
 5791   \setbox\delayedbox=\box\interbox
 5792   \ifdim\ht#1=0pt\else
 5793     \ourunvbox#1 % Repeat on what's left of the box
 5794     \nobreak
 5795   \fi
 5796   \box\delayedbox
 5797 \egroup
 5798 }
 5799 \newbox\delayedbox
 5800 \newbox\interbox
 5801 
 5802 % Used from \printindex.  \firsttoken should be the first token
 5803 % after the \entry.  If it's not another \entry, we are at the last
 5804 % line of a group of index entries, so insert a penalty to discourage
 5805 % widowed index entries.
 5806 \def\dotheinsertentryboxwithpenalty{%
 5807   \ifx\firsttoken\isentry
 5808   \else
 5809     \penalty 9000
 5810   \fi
 5811   \insertentrybox
 5812 }
 5813 \def\isentry{\entry}%
 5814 
 5815 % Like plain.tex's \dotfill, except uses up at least 1 em.
 5816 % The filll stretch here overpowers both the fil and fill stretch to push
 5817 % the page number to the right.
 5818 \def\indexdotfill{\cleaders
 5819   \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
 5820 
 5821 
 5822 \def\primary #1{\line{#1\hfil}}
 5823 
 5824 \newskip\secondaryindent \secondaryindent=0.5cm
 5825 \def\secondary#1#2{{%
 5826   \parfillskip=0in
 5827   \parskip=0in
 5828   \hangindent=1in
 5829   \hangafter=1
 5830   \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
 5831   \ifpdf
 5832     \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
 5833   \else
 5834     \ifx\XeTeXrevision\thisisundefined
 5835       #2
 5836     \else
 5837       \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
 5838     \fi
 5839   \fi
 5840   \par
 5841 }}
 5842 
 5843 % Define two-column mode, which we use to typeset indexes.
 5844 % Adapted from the TeXbook, page 416, which is to say,
 5845 % the manmac.tex format used to print the TeXbook itself.
 5846 \catcode`\@=11  % private names
 5847 
 5848 \newbox\partialpage
 5849 \newdimen\doublecolumnhsize
 5850 
 5851 % Use inside an output routine to save \topmark and \firstmark
 5852 \def\savemarks{%
 5853   \global\savedtopmark=\expandafter{\topmark }%
 5854   \global\savedfirstmark=\expandafter{\firstmark }%
 5855 }
 5856 \newtoks\savedtopmark
 5857 \newtoks\savedfirstmark
 5858 
 5859 % Set \topmark and \firstmark for next time \output runs.
 5860 % Can't be run from withinside \output (because any material
 5861 % added while an output routine is active, including 
 5862 % penalties, is saved for after it finishes).  The page so far
 5863 % should be empty, otherwise what's on it will be thrown away.
 5864 \def\restoremarks{%
 5865   \mark{\the\savedtopmark}%
 5866   \bgroup\output = {%
 5867     \setbox\dummybox=\box\PAGE
 5868   }abc\eject\egroup
 5869   % "abc" because output routine doesn't fire for a completely empty page.
 5870   \mark{\the\savedfirstmark}%
 5871 }
 5872 
 5873 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
 5874   % If not much space left on page, start a new page.
 5875   \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
 5876   %
 5877   % Grab any single-column material above us.
 5878   \output = {%
 5879     %
 5880     % Here is a possibility not foreseen in manmac: if we accumulate a
 5881     % whole lot of material, we might end up calling this \output
 5882     % routine twice in a row (see the doublecol-lose test, which is
 5883     % essentially a couple of indexes with @setchapternewpage off).  In
 5884     % that case we just ship out what is in \partialpage with the normal
 5885     % output routine.  Generally, \partialpage will be empty when this
 5886     % runs and this will be a no-op.  See the indexspread.tex test case.
 5887     \ifvoid\partialpage \else
 5888       \onepageout{\pagecontents\partialpage}%
 5889     \fi
 5890     %
 5891     \global\setbox\partialpage = \vbox{%
 5892       % Unvbox the main output page.
 5893       \unvbox\PAGE
 5894       \kern-\topskip \kern\baselineskip
 5895     }%
 5896     \savemarks
 5897   }%
 5898   \eject % run that output routine to set \partialpage
 5899   \restoremarks
 5900   %
 5901   % We recover the two marks that the last output routine saved in order
 5902   % to propagate the information in marks added around a chapter heading,
 5903   % which could be otherwise be lost by the time the final page is output.
 5904   %
 5905   %
 5906   % Use the double-column output routine for subsequent pages.
 5907   \output = {\doublecolumnout}%
 5908   %
 5909   % Change the page size parameters.  We could do this once outside this
 5910   % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
 5911   % format, but then we repeat the same computation.  Repeating a couple
 5912   % of assignments once per index is clearly meaningless for the
 5913   % execution time, so we may as well do it in one place.
 5914   %
 5915   % First we halve the line length, less a little for the gutter between
 5916   % the columns.  We compute the gutter based on the line length, so it
 5917   % changes automatically with the paper format.  The magic constant
 5918   % below is chosen so that the gutter has the same value (well, +-<1pt)
 5919   % as it did when we hard-coded it.
 5920   %
 5921   % We put the result in a separate register, \doublecolumhsize, so we
 5922   % can restore it in \pagesofar, after \hsize itself has (potentially)
 5923   % been clobbered.
 5924   %
 5925   \doublecolumnhsize = \hsize
 5926     \advance\doublecolumnhsize by -.04154\hsize
 5927     \divide\doublecolumnhsize by 2
 5928   \hsize = \doublecolumnhsize
 5929   %
 5930   % Double the \vsize as well.
 5931   \advance\vsize by -\ht\partialpage
 5932   \vsize = 2\vsize
 5933   %
 5934   % For the benefit of balancing columns
 5935   \advance\baselineskip by 0pt plus 0.5pt
 5936 }
 5937 
 5938 % The double-column output routine for all double-column pages except
 5939 % the last, which is done by \balancecolumns.
 5940 %
 5941 \def\doublecolumnout{%
 5942   %
 5943   \splittopskip=\topskip \splitmaxdepth=\maxdepth
 5944   % Get the available space for the double columns -- the normal
 5945   % (undoubled) page height minus any material left over from the
 5946   % previous page.
 5947   \dimen@ = \vsize
 5948   \divide\dimen@ by 2
 5949   %
 5950   % box0 will be the left-hand column, box2 the right.
 5951   \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
 5952   \global\advance\vsize by 2\ht\partialpage
 5953   \onepageout\pagesofar
 5954   \unvbox\PAGE
 5955   \penalty\outputpenalty
 5956 }
 5957 %
 5958 % Re-output the contents of the output page -- any previous material,
 5959 % followed by the two boxes we just split, in box0 and box2.
 5960 \def\pagesofar{%
 5961   \unvbox\partialpage
 5962   %
 5963   \hsize = \doublecolumnhsize
 5964   \wd0=\hsize \wd2=\hsize
 5965   \hbox to\txipagewidth{\box0\hfil\box2}%
 5966 }
 5967 
 5968 
 5969 % Finished with with double columns.
 5970 \def\enddoublecolumns{%
 5971   % The following penalty ensures that the page builder is exercised
 5972   % _before_ we change the output routine.  This is necessary in the
 5973   % following situation:
 5974   %
 5975   % The last section of the index consists only of a single entry.
 5976   % Before this section, \pagetotal is less than \pagegoal, so no
 5977   % break occurs before the last section starts.  However, the last
 5978   % section, consisting of \initial and the single \entry, does not
 5979   % fit on the page and has to be broken off.  Without the following
 5980   % penalty the page builder will not be exercised until \eject
 5981   % below, and by that time we'll already have changed the output
 5982   % routine to the \balancecolumns version, so the next-to-last
 5983   % double-column page will be processed with \balancecolumns, which
 5984   % is wrong:  The two columns will go to the main vertical list, with
 5985   % the broken-off section in the recent contributions.  As soon as
 5986   % the output routine finishes, TeX starts reconsidering the page
 5987   % break.  The two columns and the broken-off section both fit on the
 5988   % page, because the two columns now take up only half of the page
 5989   % goal.  When TeX sees \eject from below which follows the final
 5990   % section, it invokes the new output routine that we've set after
 5991   % \balancecolumns below; \onepageout will try to fit the two columns
 5992   % and the final section into the vbox of \txipageheight (see
 5993   % \pagebody), causing an overfull box.
 5994   %
 5995   % Note that glue won't work here, because glue does not exercise the
 5996   % page builder, unlike penalties (see The TeXbook, pp. 280-281).
 5997   \penalty0
 5998   %
 5999   \output = {%
 6000     % Split the last of the double-column material.
 6001     \savemarks
 6002     \balancecolumns
 6003   }%
 6004   \eject % call the \output just set
 6005   \ifdim\pagetotal=0pt
 6006     % Having called \balancecolumns once, we do not
 6007     % want to call it again.  Therefore, reset \output to its normal
 6008     % definition right away.
 6009     \global\output = {\onepageout{\pagecontents\PAGE}}%
 6010     %
 6011     \endgroup % started in \begindoublecolumns
 6012     \restoremarks
 6013     % Leave the double-column material on the current page, no automatic
 6014     % page break.
 6015     \box\balancedcolumns
 6016     %
 6017     % \pagegoal was set to the doubled \vsize above, since we restarted
 6018     % the current page.  We're now back to normal single-column
 6019     % typesetting, so reset \pagegoal to the normal \vsize.
 6020     \global\vsize = \txipageheight %
 6021     \pagegoal = \txipageheight %
 6022   \else
 6023     % We had some left-over material.  This might happen when \doublecolumnout
 6024     % is called in \balancecolumns.  Try again.
 6025     \expandafter\enddoublecolumns
 6026   \fi
 6027 }
 6028 \newbox\balancedcolumns
 6029 \setbox\balancedcolumns=\vbox{shouldnt see this}%
 6030 %
 6031 % Only called for the last of the double column material.  \doublecolumnout 
 6032 % does the others.
 6033 \def\balancecolumns{%
 6034   \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
 6035   \dimen@ = \ht0
 6036   \advance\dimen@ by \topskip
 6037   \advance\dimen@ by-\baselineskip
 6038   \ifdim\dimen@<5\baselineskip
 6039     % Don't split a short final column in two.
 6040     \setbox2=\vbox{}%
 6041     \global\setbox\balancedcolumns=\vbox{\pagesofar}%
 6042   \else
 6043     \divide\dimen@ by 2 % target to split to
 6044     \dimen@ii = \dimen@
 6045     \splittopskip = \topskip
 6046     % Loop until left column is at least as high as the right column.
 6047     {%
 6048       \vbadness = 10000
 6049       \loop
 6050         \global\setbox3 = \copy0
 6051         \global\setbox1 = \vsplit3 to \dimen@
 6052       \ifdim\ht1<\ht3
 6053         \global\advance\dimen@ by 1pt
 6054       \repeat
 6055     }%
 6056     % Now the left column is in box 1, and the right column in box 3.
 6057     %
 6058     % Check whether the left column has come out higher than the page itself.  
 6059     % (Note that we have doubled \vsize for the double columns, so
 6060     % the actual height of the page is 0.5\vsize).
 6061     \ifdim2\ht1>\vsize
 6062       % It appears that we have been called upon to balance too much material.
 6063       % Output some of it with \doublecolumnout, leaving the rest on the page.
 6064       \setbox\PAGE=\box0
 6065       \doublecolumnout
 6066     \else
 6067       % Compare the heights of the two columns.
 6068       \ifdim4\ht1>5\ht3
 6069         % Column heights are too different, so don't make their bottoms
 6070         % flush with each other.
 6071         \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
 6072         \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
 6073       \else
 6074         % Make column bottoms flush with each other.
 6075         \setbox2=\vbox to\ht1{\unvbox3\unskip}%
 6076         \setbox0=\vbox to\ht1{\unvbox1\unskip}%
 6077       \fi
 6078       \global\setbox\balancedcolumns=\vbox{\pagesofar}%
 6079     \fi
 6080   \fi
 6081   %
 6082 }
 6083 \catcode`\@ = \other
 6084 
 6085 
 6086 \message{sectioning,}
 6087 % Chapters, sections, etc.
 6088 
 6089 % Let's start with @part.
 6090 \outer\parseargdef\part{\partzzz{#1}}
 6091 \def\partzzz#1{%
 6092   \chapoddpage
 6093   \null
 6094   \vskip.3\vsize  % move it down on the page a bit
 6095   \begingroup
 6096     \noindent \titlefonts\rm #1\par % the text
 6097     \let\lastnode=\empty      % no node to associate with
 6098     \writetocentry{part}{#1}{}% but put it in the toc
 6099     \headingsoff              % no headline or footline on the part page
 6100     % This outputs a mark at the end of the page that clears \thischapter
 6101     % and \thissection, as is done in \startcontents.
 6102     \let\pchapsepmacro\relax
 6103     \chapmacro{}{Yomitfromtoc}{}%
 6104     \chapoddpage
 6105   \endgroup
 6106 }
 6107 
 6108 % \unnumberedno is an oxymoron.  But we count the unnumbered
 6109 % sections so that we can refer to them unambiguously in the pdf
 6110 % outlines by their "section number".  We avoid collisions with chapter
 6111 % numbers by starting them at 10000.  (If a document ever has 10000
 6112 % chapters, we're in trouble anyway, I'm sure.)
 6113 \newcount\unnumberedno \unnumberedno = 10000
 6114 \newcount\chapno
 6115 \newcount\secno        \secno=0
 6116 \newcount\subsecno     \subsecno=0
 6117 \newcount\subsubsecno  \subsubsecno=0
 6118 
 6119 % This counter is funny since it counts through charcodes of letters A, B, ...
 6120 \newcount\appendixno  \appendixno = `\@
 6121 %
 6122 % \def\appendixletter{\char\the\appendixno}
 6123 % We do the following ugly conditional instead of the above simple
 6124 % construct for the sake of pdftex, which needs the actual
 6125 % letter in the expansion, not just typeset.
 6126 %
 6127 \def\appendixletter{%
 6128   \ifnum\appendixno=`A A%
 6129   \else\ifnum\appendixno=`B B%
 6130   \else\ifnum\appendixno=`C C%
 6131   \else\ifnum\appendixno=`D D%
 6132   \else\ifnum\appendixno=`E E%
 6133   \else\ifnum\appendixno=`F F%
 6134   \else\ifnum\appendixno=`G G%
 6135   \else\ifnum\appendixno=`H H%
 6136   \else\ifnum\appendixno=`I I%
 6137   \else\ifnum\appendixno=`J J%
 6138   \else\ifnum\appendixno=`K K%
 6139   \else\ifnum\appendixno=`L L%
 6140   \else\ifnum\appendixno=`M M%
 6141   \else\ifnum\appendixno=`N N%
 6142   \else\ifnum\appendixno=`O O%
 6143   \else\ifnum\appendixno=`P P%
 6144   \else\ifnum\appendixno=`Q Q%
 6145   \else\ifnum\appendixno=`R R%
 6146   \else\ifnum\appendixno=`S S%
 6147   \else\ifnum\appendixno=`T T%
 6148   \else\ifnum\appendixno=`U U%
 6149   \else\ifnum\appendixno=`V V%
 6150   \else\ifnum\appendixno=`W W%
 6151   \else\ifnum\appendixno=`X X%
 6152   \else\ifnum\appendixno=`Y Y%
 6153   \else\ifnum\appendixno=`Z Z%
 6154   % The \the is necessary, despite appearances, because \appendixletter is
 6155   % expanded while writing the .toc file.  \char\appendixno is not
 6156   % expandable, thus it is written literally, thus all appendixes come out
 6157   % with the same letter (or @) in the toc without it.
 6158   \else\char\the\appendixno
 6159   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
 6160   \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
 6161 
 6162 % Each @chapter defines these (using marks) as the number+name, number
 6163 % and name of the chapter.  Page headings and footings can use
 6164 % these.  @section does likewise.
 6165 \def\thischapter{}
 6166 \def\thischapternum{}
 6167 \def\thischaptername{}
 6168 \def\thissection{}
 6169 \def\thissectionnum{}
 6170 \def\thissectionname{}
 6171 
 6172 \newcount\absseclevel % used to calculate proper heading level
 6173 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
 6174 
 6175 % @raisesections: treat @section as chapter, @subsection as section, etc.
 6176 \def\raisesections{\global\advance\secbase by -1}
 6177 \let\up=\raisesections % original BFox name
 6178 
 6179 % @lowersections: treat @chapter as section, @section as subsection, etc.
 6180 \def\lowersections{\global\advance\secbase by 1}
 6181 \let\down=\lowersections % original BFox name
 6182 
 6183 % we only have subsub.
 6184 \chardef\maxseclevel = 3
 6185 %
 6186 % A numbered section within an unnumbered changes to unnumbered too.
 6187 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
 6188 \chardef\unnlevel = \maxseclevel
 6189 %
 6190 % Trace whether the current chapter is an appendix or not:
 6191 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
 6192 \def\chapheadtype{N}
 6193 
 6194 % Choose a heading macro
 6195 % #1 is heading type
 6196 % #2 is heading level
 6197 % #3 is text for heading
 6198 \def\genhead#1#2#3{%
 6199   % Compute the abs. sec. level:
 6200   \absseclevel=#2
 6201   \advance\absseclevel by \secbase
 6202   % Make sure \absseclevel doesn't fall outside the range:
 6203   \ifnum \absseclevel < 0
 6204     \absseclevel = 0
 6205   \else
 6206     \ifnum \absseclevel > 3
 6207       \absseclevel = 3
 6208     \fi
 6209   \fi
 6210   % The heading type:
 6211   \def\headtype{#1}%
 6212   \if \headtype U%
 6213     \ifnum \absseclevel < \unnlevel
 6214       \chardef\unnlevel = \absseclevel
 6215     \fi
 6216   \else
 6217     % Check for appendix sections:
 6218     \ifnum \absseclevel = 0
 6219       \edef\chapheadtype{\headtype}%
 6220     \else
 6221       \if \headtype A\if \chapheadtype N%
 6222     \errmessage{@appendix... within a non-appendix chapter}%
 6223       \fi\fi
 6224     \fi
 6225     % Check for numbered within unnumbered:
 6226     \ifnum \absseclevel > \unnlevel
 6227       \def\headtype{U}%
 6228     \else
 6229       \chardef\unnlevel = 3
 6230     \fi
 6231   \fi
 6232   % Now print the heading:
 6233   \if \headtype U%
 6234     \ifcase\absseclevel
 6235     \unnumberedzzz{#3}%
 6236     \or \unnumberedseczzz{#3}%
 6237     \or \unnumberedsubseczzz{#3}%
 6238     \or \unnumberedsubsubseczzz{#3}%
 6239     \fi
 6240   \else
 6241     \if \headtype A%
 6242       \ifcase\absseclevel
 6243       \appendixzzz{#3}%
 6244       \or \appendixsectionzzz{#3}%
 6245       \or \appendixsubseczzz{#3}%
 6246       \or \appendixsubsubseczzz{#3}%
 6247       \fi
 6248     \else
 6249