mdw@git.distorted.org.uk Git - sod/blob - doc/sod.sty

   1 %%% -*-latex-*-
   2 %%%
   3 %%% Styles and other hacking for the Sod manual
   4 %%%
   5 %%% (c) 2015 Straylight/Edgeware
   6 %%%
   7
   8 %%%----- Licensing notice ---------------------------------------------------
   9 %%%
  10 %%% This file is part of the Sensible Object Design, an object system for C.
  11 %%%
  12 %%% SOD is free software; you can redistribute it and/or modify
  13 %%% it under the terms of the GNU General Public License as published by
  14 %%% the Free Software Foundation; either version 2 of the License, or
  15 %%% (at your option) any later version.
  16 %%%
  17 %%% SOD is distributed in the hope that it will be useful,
  18 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 %%% GNU General Public License for more details.
  21 %%%
  22 %%% You should have received a copy of the GNU General Public License
  23 %%% along with SOD; if not, write to the Free Software Foundation,
  24 %%% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25
  26 \ProvidesPackage{sod}
  27
  28 %%%--------------------------------------------------------------------------
  29 %%% Basic style things.
  30
  31 %% More reference types.
  32 \defxref{p}{part}
  33
  34 %% A gadget to include in `\xref': call as
  35 %%
  36 %%      \xref[\instead{THING}]{LABEL}
  37 %%
  38 %% to replace the usual `section' or whatever with THING.
  39 \def\instead#1#2{#1}
  40
  41 %% Other languages with special typesetting.
  42 \def\Cplusplus{C\kern-\p@++}
  43 \def\Csharp{C\#}
  44
  45 %% Special maths notation.
  46 \def\chain#1#2{\mathsf{ch}_{#1}(#2)}
  47 \def\chainhead#1#2{\mathsf{hd}_{#1}(#2)}
  48 \def\chaintail#1#2{\mathsf{tl}_{#1}(#2)}
  49
  50 %% Other mathematical tweaks.
  51 \let\implies\Rightarrow
  52 \let\epsilon\varepsilon
  53
  54 %% A table heading cell.  Clone and hack \multicolumn.
  55 \def\thd{\omit\@ifnextchar[\thd@{\thd@[l]}}
  56 \def\thd@[#1]#2{%
  57   \begingroup
  58     \tab@multicol \tab@initread \let\tab@looped\tab@err@multi
  59     \tab@preamble{}\def\tab@midtext{\bfseries#2}\tab@readpreamble{#1}%
  60     \the\tab@preamble
  61   \endgroup \ignorespaces
  62 }
  63
  64 %% Unix manpage references.
  65 \def\man#1#2{\textbf{#1}(#2)}
  66
  67 %% Listings don't need to be small.
  68 \let\listingsize\relax
  69
  70 %% Notes for later.
  71 \def\fixme#1{\leavevmode\marginpar{FIXME}\index{FIXME}[FIXME: #1]}
  72
  73 %% Diagram settings.
  74 \tikzset{
  75   every picture/.style={>=stealth, thick},
  76   lit/.style={font=\sffamily}
  77 }
  78
  79 %% Metavariables are italics without decoration.
  80 \def\syntleft{\normalfont\itshape}
  81 \let\syntright\empty
  82
  83 %% Literal code is in sans face.
  84 \def\codeface{\upshape\sffamily}
  85 \DeclareRobustCommand\code[1]{%
  86   \ifmmode\hbox\else\leavevmode\fi%
  87   {\normalfont\codeface\/#1\/}%
  88 }
  89 \def\ulitleft{\normalfont\codeface}
  90 \let\ulitright\empty
  91 \def\lit@i#1#2#3{\ifmmode\leavevmode\hbox\fi{#1{#3\/}#2}}
  92
  93 %% Conditionally enter maths mode.  Can't use \ensuremath here because we
  94 %% aren't necessarily sure where the maths will actually end.
  95 \let\m@maybe@end\relax
  96 \def\m@maybe{\ifmmode\else$\let\m@maybe@end$\fi}
  97
  98 %% Standard syntax shortcuts.
  99 \atdef <#1>{\synt{#1}\@scripts}
 100 \atdef "#1"{\lit*{#1}\@scripts}
 101 \atdef `#1'{\lit{#1}\@scripts}
 102 \atdef |#1|{\lit*{#1}\@scripts}
 103
 104 %% A handy abbreviation; `\\' itself is too good to steal.
 105 \atdef \\{\textbackslash}
 106
 107 %% Intercept grammar typesetting and replace the vertical bar with the
 108 %% maths-font version.
 109 \let\@@syn@shorts\syn@shorts
 110 \def\syn@shorts{\def\textbar{\hbox{$|$}}\@@syn@shorts}
 111
 112 %% Collect super- and subscripts.  (Note that underscores are active for the
 113 %% most part.)  When we're done, end maths mode if we entered it
 114 %% conditionally.
 115 \def\@scripts{\futurelet\@ch\@scripts@i}
 116 \begingroup\lccode`\~=`\_\lowercase{\endgroup
 117 \def\@scripts@i{\if1\ifx\@ch~1\else\ifx\@ch_1\else\ifx\@ch^1\else0\fi\fi\fi%
 118   \expandafter\@scripts@ii\else\expandafter\m@maybe@end\fi}}
 119 \def\@scripts@ii#1#2{\m@maybe#1{#2}\@scripts}
 120
 121 %% Doubling characters, maybe.  Either way, chain onto \@scripts.
 122 \def\dbl@maybe#1{\let\@tempa#1\futurelet\@ch\dbl@maybe@i}
 123 \def\dbl@maybe@i{\m@maybe\ifx\@ch\@tempa\@tempa\!\@tempa%
 124   \expandafter\@firstoftwo\expandafter\@scripts%
 125   \else\@tempa\expandafter\@scripts\fi}
 126
 127 %% Lookahead without eating spaces.
 128 \def\@ifnextchar@preserve#1#2#3{%
 129   \let\want@= #1\def\@tempa{#2}\def\@tempb{#3}%
 130   \futurelet\nch@\@ifnch@p%
 131 }
 132 \def\@ifnch@p{%
 133   \ifx\want@\nch@\expandafter\@tempa\else\expandafter\@tempb\fi}
 134
 135 %% Extra syntax for Lisp templates.  These produce the maths-font versions of
 136 %% characters, which should contrast well against the sans face used for
 137 %% literals.
 138 \atdef [{\dbl@maybe[}
 139 \atdef ]{\dbl@maybe]}
 140 \atdef {{\m@maybe\{\@scripts}
 141 \atdef }{\m@maybe\}\@scripts}
 142 \atdef ({\m@maybe(\@scripts}
 143 \atdef ){\m@maybe)\@scripts}
 144 \atdef !{\m@maybe|\@scripts}
 145
 146 \def\returns{\m@maybe\longrightarrow\m@maybe@end\hspace{0.5em}\ignorespaces}
 147 \def\nlret{\\\hspace{4em}\returns}
 148 \atdef >{\leavevmode\unskip\hspace{0.5em}\returns}
 149
 150 %% Extra syntax for common tokens.
 151 \atdef ~{\textasciitilde}
 152 \atdef -{\leavevmode\hbox\bgroup\futurelet\ch@\@dash}
 153 \def\@dash{%
 154   \ifx\ch@>%
 155     --\raisebox{.4pt}{>}%
 156     \def\next@{\@firstoftwo{\egroup\penalty200\relax}}%
 157   \else\ifx\ch@-%
 158     --\,%
 159     \def\next@{\@firstoftwo{\futurelet\ch@\@dash}}%
 160   \else%
 161     --%
 162     \let\next@\egroup%
 163   \fi\fi
 164   \next@%
 165 }
 166
 167 %% Comment setting.
 168 \def\comment#1{\mbox{\normalfont\itshape\/#1\/}}
 169 \atdef /*#1*/{/*\comment{#1}*/}
 170 \def\@semis;{\@ifnextchar@preserve;{;\@semis}\@semicomment}
 171 \def\@semicomment#1\\{\comment{#1}\\}
 172 \atdef ;{;\@semis;}
 173
 174 %% Put a chunk of text in a box.
 175 \newenvironment{boxy}[1][\q@]{%
 176   \savenotes%
 177   \dimen@\linewidth\advance\dimen@-1.2pt\advance\dimen@-2ex%
 178   \medskip%
 179   \vbox\bgroup\hrule\hbox\bgroup\vrule%
 180   \vbox\bgroup\vskip1ex\hbox\bgroup\hskip1ex\minipage\dimen@%
 181   \def\@temp{#1}\ifx\@temp\q@\else\leavevmode{\headfam\bfseries#1\quad}\fi%
 182 }{%
 183   \endminipage\hskip1ex\egroup\vskip1ex\egroup%
 184   \vrule\egroup\hrule\egroup%
 185   \medskip%
 186   \spewnotes%
 187 }
 188
 189 %%%--------------------------------------------------------------------------
 190 %%% Environment for setting programs.
 191
 192 %% Save `\kill' so that `longtable' won't clobber it.
 193 \let\prog@@kill\kill
 194
 195 %% Main guts of `prog' and `nprog'.
 196 \def\@prog{%
 197   \let\prog@@cr\@tabcr%
 198   \let\@tabcr\@progcr%
 199   \let\kill\prog@@kill%
 200   \codeface%
 201   \tabbing%
 202 }
 203
 204 %% Newlines: called by `\\' within a `prog'.
 205 %%
 206 %% \\           newline without following break
 207 %% \\[SKIP]     newline /with/ break and vertical glue
 208 %% \\*[SKIP]    newline without break, with optional glue
 209 %% \\+          newline with break and a vertical gap
 210 %% \\-          newline without break, with a tiny gap
 211 \def\@progcr{\futurelet\@tempa\@progcr@i}
 212 \def\@progcr@i{%
 213   \ifx\@tempa\@sptoken\let\next@\@progcr@sp\else
 214   \if1\ifx\@tempa[1\else
 215       \ifx\@tempa*1\else
 216       0\fi\fi
 217     \let\next@\prog@@cr\else
 218   \if1\ifx\@tempa+1\else
 219       \ifx\@tempa-1\else
 220       0\fi\fi
 221     \let\next@\@progcr@ii\else
 222   \let\next@\@progcr@a\fi\fi\fi
 223   \next@}
 224 \def\@progcr@a{\prog@@cr*{}\ignorespaces}
 225 \def\@progcr@ii#1{\csname @progcr@#1\endcsname\ignorespaces}
 226 \@namedef{@progcr@+}{\prog@@cr[\medskipamount]}
 227 \@namedef{@progcr@-}{\prog@@cr*[\jot]}
 228 {\def\:{\gdef\@progcr@sp}\: {\@progcr}} % \@progcr@sp eats space and recurses
 229
 230 %% Set a program in `codeface', with implicit tabbing and other toys.
 231 %% Newlines are explicit, because otherwise I need comments in weird places
 232 %% to make the vertical spacing come out properly.  You can write
 233 %% `\obeylines' if you really want to.
 234 \def\prog{\quote\@prog}
 235 \def\endprog{\endtabbing\endquote}
 236
 237 %% Like `prog', but without indenting the code.  Use this within environments
 238 %% which already set their contents out from the body text in some
 239 %% distinctive way.
 240 \let\nprog\@prog
 241 \let\endnprog\endtabbing
 242
 243 %% Indent the following material.  Cancel using `\-'.
 244 \def\ind{\quad\=\+\kill}
 245
 246 %% Show a backslash by the right-hand margin; for multiline macros etc.
 247 \def\macsl{\`\textbackslash\hskip\leftmargin}
 248
 249 %% \maplist{THING}{{ITEM}...}: Invoke THING{ITEM} for each ITEM in turn.
 250 \def\maplist#1#2{\map@i{#1}#2\q@}
 251 \def\map@i#1{\def\next@{\map@ii{#1}}\futurelet\ch@\next@}
 252 \def\map@ii#1{\ifx\ch@\q@\expandafter\@gobble%
 253   \else\def\next@{\map@iii{#1}}\expandafter\next@\fi}
 254 \def\map@iii#1#2{#1{#2}\map@i{#1}}
 255
 256 %% \crossproduct{THING}{{LIST}...} where each LIST is {ITEM}...
 257 %% For each possible way of selecting one ITEM from each LIST, in order,
 258 %% invoke THING{{ITEM}...}
 259 \toksdef\cprod@new=0
 260 \toksdef\cprod@old=2
 261 \toksdef\cprod@head=4
 262 \toksdef\cprod@tail=6
 263 \def\crossproduct#1#2{%
 264   \cprod@new{{}}%
 265   \maplist{\cprod@f{#1}}{#2}%
 266   \cprod@head{#1}%
 267   \edef\next@{\noexpand\maplist{\the\cprod@head}{\the\cprod@new}}
 268   \next@%
 269 }
 270 \def\cprod@f#1#2{%
 271   \cprod@old\cprod@new\cprod@new{}%
 272   \maplist\cprod@g{#2}%
 273 }
 274 \def\cprod@g#1{%
 275   \cprod@head{#1}%
 276   \expandafter\maplist\expandafter\cprod@h\expandafter{\the\cprod@old}%
 277 }
 278 \def\cprod@h#1{%
 279   \cprod@tail{#1}%
 280   \cprod@new\expandafter{\the\expandafter\cprod@new\expandafter{%
 281       \the\expandafter\cprod@tail\the\cprod@head}}%
 282 }
 283
 284 %%%--------------------------------------------------------------------------
 285 %%% Machinery for describing functions, etc.
 286
 287 %% \definedescribecategory{CAT}[KIND]{NAME}
 288 %%
 289 %% Define a category of things to document.  CAT is a short label identifying
 290 %% the category to `\describe', `\descref', and friends.  The NAME is the
 291 %% text to show in the description headline; it is a macro body which is
 292 %% passed an argument `#1' that applies a modifier to some portion of the
 293 %% text.
 294 %%
 295 %% The KIND allows additional arguments to be collected, included in label
 296 %% strings, and mentioned in the index.  The default is `plain'.
 297 \def\definedescribecategory#1{%
 298   \@ifnextchar[{\def@desc{#1}}{\def@desc{#1}[plain]}}
 299 \def\def@desc#1[#2]#3{\@namedef{cat!#1}##1{#3}\@namedef{catsw!#1}{#2}}
 300
 301 %% \describecategoryname[MOD]{CAT}
 302 %%
 303 %% Typeset the category name for CAT, modified by MOD.
 304 \def\describecategoryname{\@ifnextchar[\@descname@i{\@descname@i[]}}
 305 \def\@descname@i[#1]#2{%
 306   \expandafter\let\expandafter\@tempa\csname cat!#2\endcsname%
 307   \expandafter\let\expandafter\@tempb\csname modcat/#1\endcsname%
 308   \ifx\@tempa\relax\@tempb{#2}\else\@tempa\@tempb\fi}
 309
 310 %% Call a modifier method.
 311 \def\@mod@dispatch#1#2{\csname #1/#2\endcsname}
 312
 313 %% Call a description method given the category.
 314 \def\@desc@dispatch#1#2{%
 315   \csname #1/%
 316     \expandafter\ifx\csname catsw!#2\endcsname\relax plain%
 317     \else \csname catsw!#2\endcsname \fi%
 318   \endcsname%
 319 }
 320
 321 %% Modifier methods for the default `plain' modifier.
 322 \@namedef{modcat/plain}#1{#1}
 323 \@namedef{modlabel/plain}#1{#1}
 324 \@namedef{modindex/plain}#1{#1@\noexpand\code{#1}}
 325
 326 %% Modifier methods for `setf'.  The name text prefixes the relevant word
 327 %% with `setf-'.
 328 \@namedef{modcat/setf}#1{\code{setf}-#1}
 329 \@namedef{modlabel/setf}#1{setf/#1}
 330 \@namedef{modindex/setf}#1{#1@\noexpand\code{#1}}
 331
 332 %% Modifier methods for words with *earmuffs*.  Sort into the index without
 333 %% the earmuffs.
 334 \@namedef{modcat/muffs}#1{#1}
 335 \@namedef{modlabel/muffs}#1{#1}
 336 \@namedef{modindex/muffs}#1{\@unmuff#1@\noexpand\code{#1}}
 337 \def\@unmuff*#1*{#1}
 338
 339 %% Modifier methods for :keywords.  Sort into the index without the `:'.
 340 \@namedef{modcat/kwd}#1{#1}
 341 \@namedef{modlabel/kwd}#1{#1}
 342 \@namedef{modindex/kwd}#1{\@gobble#1@\noexpand\code{#1}}
 343
 344 %% Category-kind methods for plain categories.
 345 \@namedef{descargs/plain}#1{#1{}}
 346 \@namedef{desclabel/plain}#1#2#3{#2:\@mod@dispatch{modlabel}{#1}{#3}}
 347 \@namedef{descindex/plain}#1#2#3{%
 348   \@mod@dispatch{modindex}{#1}{#3}!%
 349   \protect\describecategoryname[#1]{#2}%
 350 }
 351
 352 %% Category-kind methods for `method' categories.  Collect an extra argument
 353 %% listing the specializers: include them in the label, and typeset them in
 354 %% the index.
 355 \def\fmtspecs#1#2{%
 356   \if!#2!\else\count@\z@\toks@{}#1\fmtspecs@i#2,\q@,\fi}
 357 \def\fmtspecs@i#1,{%
 358   \def\@tempa{#1}%
 359   \ifx\@tempa\q@%
 360     \ifcase\count@(no args?!)%
 361     \or% nothin' doin
 362     \or \space and %
 363     \else, and %
 364     \fi%
 365     \the\toks@%
 366   \else%
 367     \ifnum\count@>\@ne, \fi%
 368     \the\toks@%
 369     \toks@{\code{#1}}\advance\count@\@ne%
 370     \expandafter\fmtspecs@i%
 371   \fi%
 372 }
 373 \@namedef{descargs/method}#1#2{#1{{#2}}}
 374 \@namedef{desclabel/method}#1#2#3#4%
 375   {#2:\@mod@dispatch{modlabel}{#1}{#4}(#3)}
 376 \@namedef{descindex/method}#1#2#3#4{%
 377   \@mod@dispatch{modindex}{#1}{#4}!%
 378   \protect\describecategoryname[#1]{#2}%
 379   \protect\fmtspecs{ specialized at }{#3}%
 380 }
 381
 382 %% Some magic strings.
 383 \def\q@{\q@}
 384 \def\@setf{setf}
 385 \def\@starstar{**}
 386
 387 %% \parse@dhd{NEXT}[MOD]{CAT}{...}...[NAME]{SYNOPSIS}
 388 %%
 389 %% Parse the arguments for a description header, and call
 390 %%
 391 %%      NEXT{MOD}{CAT}{{...}...}{NAME}{SYNOPSIS}
 392 %%
 393 %% Here, {...}... represents the additional category-kind arguments.  See
 394 %% `describe' for what all of this means.
 395 \def\parse@dhd#1{%  {NEXT}
 396   \@ifnextchar[{\parse@dhd@a{#1}}{\parse@dhd@c{#1}}}
 397 \def\parse@dhd@a#1[#2]#3{%  {NEXT}[MOD]{CAT}
 398   \@desc@dispatch{descargs}{#3}{\parse@dhd@ab{#1}{#2}{#3}}}
 399 \def\parse@dhd@ab#1#2#3#4{%  {NEXT}{MOD}{CAT}{{...}...}
 400   \@ifnextchar[{\parse@dhd@ac{#1}{#2}{#3}{#4}}{\parse@dhd@ad{#1}{#2}{#3}{#4}}}
 401 \def\parse@dhd@ac#1#2#3#4[#5]#6{%  {NEXT}{MOD}{CAT}{{...}...}[NAME]{SYNOPSIS}
 402   #1{#2}{#3}{#4}{#5}{#6}}
 403 \def\parse@dhd@ad#1#2#3#4#5{%  {NEXT}{MOD}{CAT}{{...}...}{NAME [ARGS...]}
 404   \parse@dhd@ae{#1}{#2}{#3}{#4}{#5}#5 \q@}
 405 \def\parse@dhd@ae#1#2#3#4#5#6 #7\q@{%
 406   % {NEXT}{MOD}{CAT}{{...}...}{SYNSOPSIS}NAME [ARGS...]\q@
 407   #1{#2}{#3}{#4}{#6}{#5}}
 408
 409 \def\parse@dhd@c#1#2{%  {NEXT}{CAT}
 410   \@desc@dispatch{descargs}{#2}{\parse@dhd@cb{#1}{#2}}}
 411 \def\parse@dhd@cb#1#2#3{%  {NEXT}{CAT}{{...}...}
 412   \@ifnextchar[{\parse@dhd@cc{#1}{#2}{#3}}{\parse@dhd@cd{#1}{#2}{#3}}}
 413 \def\parse@dhd@cc#1#2#3[#4]#5{%  {NEXT}{CAT}{{...}...}[NAME]{SYNOPSIS}
 414   #1{plain}{#2}{#3}{#4}{#5}}
 415 \def\parse@dhd@cd#1#2#3#4{%  {NEXT}{CAT}{{...}...}{SYNOPSIS}
 416   \parse@dhd@ce{#1}{#2}{#3}{#4}#4 \q@}
 417 \def\parse@dhd@ce#1#2#3#4#5 #6\q@{%
 418   % {NEXT}{CAT}{{...}...}{SYNOPSIS}NAME [ARGS...]\q@
 419   \def\temp@{#5}%
 420   \ifx\@setf\temp@\def\next@{\parse@dhd@csetf{#1}{#2}{#3}{#4}#6 \q@}%
 421   \else\def\temp@##1##2*##3\q@{\def\temp@{##1##3}}\temp@#5*\q@%
 422     \ifx\temp@\@starstar\def\next@{#1{muffs}{#2}{#3}{#5}{#4}}%
 423     \else\def\temp@##1##2\q@{\def\temp@{##1}}\temp@#5\q@%
 424       \if:\temp@\def\next@{#1{kwd}{#2}{#3}{#5}{#4}}%
 425       \else\def\next@{#1{plain}{#2}{#3}{#5}{#4}}\fi\fi\fi%
 426   \next@%
 427 }
 428 \def\parse@dhd@csetf#1#2#3#4(#5 #6\q@{%
 429   % {NEXT}{CAT}{{...}...}{SYNOPSIS}(NAME [ARGS...])\q@
 430   #1{setf}{#2}{#3}{#5}{#4}}
 431
 432 %% \dhead[MOD]{CAT}{...}...[NAME]{SYNOPSIS}
 433 %% \dhead*[MOD]{CAT}{...}...[NAME]{SYNOPSIS}
 434 %%
 435 %% Typeset a description head.  Use this within the first argument of
 436 %% `describe*'; see `describe' for the details.
 437 %%
 438 %% With `*', don't set labels or add items to the index.
 439 \newif\if@dheadfirst
 440 \newif\if@dheadindex
 441 \def\dhead{\@ifstar%
 442   {\parse@dhd{\global\@dheadindexfalse\dhead@}}%
 443   {\parse@dhd{\global\@dheadindextrue\dhead@}}}
 444 \def\dhead@#1#2#3#4#5{%  {MOD}{CAT}{{...}...}{NAME}{SYNOPSIS}
 445   \if@dheadfirst\global\@dheadfirstfalse\else\relax\\*[\smallskipamount]\fi%
 446   \if@dheadindex%
 447     \phantomsection%
 448     {\let\protect\@empty\let\@uscore\relax%
 449      \edef\temp@{\@desc@dispatch{desclabel}{#2}{#1}{#2}#3{#4}}%
 450      \def\@uscore{_\@gobble}\expandafter\message\expandafter{\temp@}%
 451      \def\@uscore{-\@gobble}\expandafter\label\expandafter{\temp@}}%
 452     {\begingroup\lccode`\~=`\_\lowercase{\endgroup\def~{_}}%
 453      \protected@edef\@tempa##1{%
 454        \noexpand\index{\@desc@dispatch{descindex}{#2}{#1}{#2}#3{#4}##1}}%
 455      \toks@\expandafter{\@tempa{|)}}%
 456      \toks\tw@\expandafter{\after@desc}%
 457      \xdef\after@desc{\the\toks\tw@\the\toks@}%
 458      \@tempa{|(}}%
 459   \fi%
 460   \rlap{\hb@xt@\linewidth{\hfil\normalfont\bfseries
 461       [\describecategoryname[#1]{#2}]}}%
 462   #5%
 463 }
 464
 465 %% Main guts of a description environment.  The argument here typesets the
 466 %% header line(s).
 467 \def\desc@begin#1{%
 468   \let\saved@after@desc\after@desc%
 469   \gdef\after@desc{}%
 470   \normalfont%
 471   \if@nobreak\else\par\goodbreak\fi%
 472   \global\@dheadfirsttrue%
 473   \begingroup%
 474     \let\@endparenv\relax%
 475     \clubpenalty\@M \widowpenalty\@M \interlinepenalty50%
 476     \@prog#1\endtabbing%
 477   \endgroup%
 478   \penalty\@M\@afterheading%
 479   \list{}{\rightmargin\z@\topsep\z@}\item%
 480 }
 481 \def\desc@end{\endlist\after@desc\global\let\after@desc\saved@after@desc}
 482
 483 %% \begin{describe}[MOD]{CAT}{...}...[NAME]{SYNOPSIS}
 484 %%   ...
 485 %% \end{describe}
 486 %%
 487 %% Describe some kind of program object.  The CAT names the category of thing
 488 %% being described -- this will be shown in the header, and index.  The
 489 %% SYNOPSIS is an implicit `prog' environment in which invoking the thing can
 490 %% be summarized.
 491 %%
 492 %% The {...}... are any additional arguments required by the category's kind
 493 %% (e.g., method specializers).
 494 %%
 495 %% The NAME is the name of the thing, which ends up in the index and
 496 %% cross-reference label.  If omitted, it defaults to the first word of the
 497 %% SYNOPSIS, except that there are some special cases.
 498 %%
 499 %% The MOD is the modifier to apply.  If omitted, it will usually default to
 500 %% `plain', but in the absence of a NAME, some kinds of synopses are
 501 %% recognized specially:
 502 %%
 503 %%   * `setf (NAME ...) ...': selects NAME, and defaults MOD to `setf'.
 504 %%
 505 %%   * `*NAME*': defaults MOD to `muffs'.
 506 %%
 507 %%   * `:NAME': defaults MOD to `kwd'.
 508 \def\describe{\parse@dhd\desc@}
 509 \def\desc@#1#2#3#4#5{%
 510   \global\@dheadindextrue%
 511   \desc@begin{\dhead@{#1}{#2}{#3}{#4}{#5}}%
 512 }
 513 \let\enddescribe\desc@end
 514
 515 %% \begin{describe*}
 516 %%     {\dhead[MOD]{CAT}{...}...[NAME]{SYNOPSIS}
 517 %%      ...}
 518 %%   ...
 519 %% \end{describe*}
 520 %%
 521 %% This is the fancy form of `describe' for describing several different
 522 %% things at once.
 523 \@namedef{describe*}#1{\desc@begin{#1}}
 524 \expandafter\let\csname enddescribe*\endcsname\desc@end
 525
 526 %% \parse@dlbl{NEXT}[MOD]{CAT}{...}...{LABEL}
 527 %%
 528 %% Parse a description label, and call
 529 %%
 530 %%      NEXT{MOD}{CAT}{{...}...}{LABEL}
 531 %%
 532 %% This handles defaulting the MOD correctly, based on the LABEL text.  See
 533 %% `\descref' for the details.
 534 \def\parse@dlbl#1{\@ifnextchar[{\parse@dlbl@a{#1}}{\parse@dlbl@c{#1}}}
 535 \def\parse@dlbl@a#1[#2]#3{\@desc@dispatch{descargs}{#3}{#1{#2}{#3}}}
 536 \def\parse@dlbl@c#1#2%
 537   {\@desc@dispatch{descargs}{#2}{\parse@dlbl@cb{#1}{#2}}}
 538 \def\parse@dlbl@cb#1#2#3#4{%
 539   \def\temp@##1##2*##3\q@{\def\temp@{##1##3}}\temp@#4*\q@%
 540     \ifx\temp@\@starstar\def\next@{#1{muffs}{#2}{#3}{#4}}%
 541     \else\def\temp@##1##2\q@{\def\temp@{##1}}\temp@#4\q@%
 542       \if:\temp@\def\next@{#1{kwd}{#2}{#3}{#4}}
 543       \else\def\next@{#1{plain}{#2}{#3}{#4}}\fi\fi%
 544   \next@%
 545 }
 546
 547 %% \descref[MOD]{CAT}{...}...{LABEL}[TEXT]
 548 %% \descref*[MOD]{CAT}{...}...{LABEL}
 549 %%
 550 %% Typesets a cross-reference to a described thing.  The CAT names the
 551 %% category of thing being described, and the LABEL names the specific thing.
 552 %%
 553 %% The {...}... are any additional arguments required by the category's kind
 554 %% (e.g., method specializers).
 555 %%
 556 %% The MOD is the modifier to apply, similar (but subtly different from) to
 557 %% the `describe' environment.  If omitted, it will usually default to
 558 %% `plain', but in the absence of a NAME, some kinds of synopses are
 559 %% recognized specially:
 560 %%
 561 %%   * `*NAME*': defaults MOD to `muffs'.
 562 %%
 563 %%   * `:NAME': defaults MOD to `kwd'.
 564 %%
 565 %% (`setf' is /not/ specially detected here.  Write an explicit `setf'
 566 %% modifier if necessary, because it's no more typing.)
 567 %%
 568 %% Usually a page-number cross-reference is included, so as to help readers
 569 %% of a dead-tree copy; this is suppressed by the `*' version.
 570 \def\descref{\@ifstar%
 571   {\parse@dlbl{\descref@i\relax\@gobble\relax}}%
 572   {\parse@dlbl{\descref@i{ (}\autopageref)}}}
 573 \def\descref@i#1#2#3#4#5#6#7{\@ifnextchar@preserve[%
 574   % {PGA}{PGB}{PGC}{MOD}{CAT}{{...}...}{LABEL}
 575   {\descref@ii{#1}{#2}{#3}{#4}{#5}{#6}{#7}}%
 576   {\descref@iii{#1}{#2}{#3}{#4}{#5}{#6}{#7}{}}}
 577 \def\descref@ii#1#2#3#4#5#6#7[#8]%
 578   % {PGA}{PGB}{PGC}{MOD}{CAT}{{...}...}{LABEL}[AFTER]
 579   {\descref@iii{#1}{#2}{#3}{#4}{#5}{#6}{#7}{ #8}}
 580 \def\descref@iii#1#2#3#4#5#6#7#8{%
 581   % {PGA}{PGB}{PGC}{MOD}{CAT}{{...}...}{LABEL}{AFTER}
 582   \begingroup%
 583     \let\protect\@empty\def\@uscore{-\@gobble}%
 584     \edef\temp@{\@desc@dispatch{desclabel}{#5}{#4}{#5}#6{#7}}%
 585     \edef\next@##1##2##3{\endgroup%
 586       \noexpand\hyperref[\temp@]{##1}##2{\temp@}##3}%
 587   \next@{\code{#7}}{#8#1#2}{#3}%
 588 }
 589
 590 %% \descindex[MOD]{CAT}{...}...{LABEL}[SUFFIX]
 591 %%
 592 %% Set a label and index entry here, as if for a description.  The CAT names
 593 %% the category of thing being described, and the LABEL names the specific
 594 %% thing, as for `\descref'.  The {...}... are any additional arguments
 595 %% required by the category's kind (e.g., method specializers).  The MOD is
 596 %% the modifier to apply; see `\descref' for the details.
 597 %%
 598 %% The SUFFIX is appended to the index-entry text; by default it is empty.
 599 %% Useful values are `|(' and `|)' to set ranges.
 600 \def\descindex{\parse@dlbl\descindex@i}
 601 \def\descindex@i#1#2#3#4{\@ifnextchar[%
 602   {\descindex@ii{#1}{#2}{#3}{#4}}%
 603   {\descindex@ii{#1}{#2}{#3}{#4}[]}}
 604 \def\descindex@ii#1#2#3#4[#5]{%
 605   {\begingroup\lccode`\~=`\_\lowercase{\endgroup\def~{_}}%
 606    \protected@edef\@tempa{%
 607      \noexpand\index{\@desc@dispatch{descindex}{#2}{#1}{#2}#3{#4}#5}}%
 608    \@tempa}%
 609 }
 610
 611 %% \desclabel[MOD]{CAT}{...}...{LABEL}[INDEX-SUFFIX]
 612 %%
 613 %% Set a label and index entry here, as if for a description.  The CAT names
 614 %% the category of thing being described, and the LABEL names the specific
 615 %% thing, as for `\descref'.  The {...}... are any additional arguments
 616 %% required by the category's kind (e.g., method specializers).  The MOD is
 617 %% the modifier to apply; see `\descref' for the details.
 618 %%
 619 %% This will also add an index entry, as for `\descindex'; the INDEX-SUFFIX
 620 %% argument has the same effect as its SUFFIX argument.
 621 \def\desclabel{\parse@dlbl\desclabel@i}
 622 \def\desclabel@i#1#2#3#4{%
 623   \begingroup%
 624     \let\protect\@empty\def\@uscore{-\@gobble}%
 625     \edef\@tempa{\@desc@dispatch{desclabel}{#2}{#1}{#2}#3{#4}}%
 626     \phantomsection\label{\@tempa}%
 627   \endgroup%
 628   \descindex@i{#1}{#2}{#3}{#4}%
 629 }
 630
 631 %% Description categories.
 632 \definedescribecategory{sym}{symbol}
 633 \definedescribecategory{fun}{#1{function}}
 634 \definedescribecategory{gf}{generic #1{function}}
 635 \definedescribecategory{msg}{message}
 636 \definedescribecategory{var}{variable}
 637 \definedescribecategory{modvar}{module variable}
 638 \definedescribecategory{const}{constant}
 639 \definedescribecategory{meth}[method]{primary #1{method}}
 640 \definedescribecategory{ar-meth}[method]{\code{:around} #1{method}}
 641 \definedescribecategory{be-meth}[method]{\code{:before} #1{method}}
 642 \definedescribecategory{af-meth}[method]{\code{:after} #1{method}}
 643 \definedescribecategory{cls}{class}
 644 \definedescribecategory{rst}{restart}
 645 \definedescribecategory{ty}{type}
 646 \definedescribecategory{mac}{#1{macro}}
 647 \definedescribecategory{feat}{feature macro}
 648 \definedescribecategory{lmac}{local #1{macro}}
 649 \definedescribecategory{parse}{parser spec}
 650 \definedescribecategory{parseform}{parser form}
 651 \definedescribecategory{opt}{option handler}
 652 \definedescribecategory{optmac}{option macro}
 653 \definedescribecategory{plug}{pluggable parser}
 654
 655 %%%----- That's all, folks --------------------------------------------------
 656 \endinput