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