X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/7e94c5fe2eff01fe81fde1f54c53d3eefb254ba0..5f32b8fda0421d16fc3455d1ce9aef746afbd818:/doc/sod.sty

diff --git a/doc/sod.sty b/doc/sod.sty
index 71b72fe..2b68df4 100644
--- a/doc/sod.sty
+++ b/doc/sod.sty
@@ -7,7 +7,7 @@
 
 %%%----- Licensing notice ---------------------------------------------------
 %%%
-%%% This file is part of the Sensble Object Design, an object system for C.
+%%% This file is part of the Sensible Object Design, an object system for C.
 %%%
 %%% SOD is free software; you can redistribute it and/or modify
 %%% it under the terms of the GNU General Public License as published by
@@ -62,10 +62,14 @@
 \let\syntright\empty
 
 %% Literal code is in sans face.
-\let\codeface\sffamily
-\def\code#1{\ifmmode\hbox\fi{\normalfont\codeface\/#1\/}}
+\def\codeface{\upshape\sffamily}
+\DeclareRobustCommand\code[1]{%
+  \ifmmode\hbox\else\leavevmode\fi%
+  {\normalfont\codeface\/#1\/}%
+}
 \def\ulitleft{\normalfont\codeface}
 \let\ulitright\empty
+\def\lit@i#1#2#3{\ifmmode\leavevmode\hbox\fi{#1{#3\/}#2}}
 
 %% Conditionally enter maths mode.  Can't use \ensuremath here because we
 %% aren't necessarily sure where the maths will actually end.
@@ -76,7 +80,7 @@
 \atdef <#1>{\synt{#1}\@scripts}
 \atdef "#1"{\lit*{#1}\@scripts}
 \atdef `#1'{\lit{#1}\@scripts}
-\atdef |#1|{\textsf{#1}\@scripts}
+\atdef |#1|{\lit*{#1}\@scripts}
 
 %% A handy abbreviation; `\\' itself is too good to steal.
 \atdef \\{\textbackslash}
@@ -113,17 +117,44 @@
 \atdef !{\m@maybe|\@scripts}
 \def\returns{\m@maybe\longrightarrow\m@maybe@end\hspace{0.5em}\ignorespaces}
 \atdef >{\leavevmode\unskip\hspace{0.5em}\returns}
-\atdef -#1{\if>#1{\ensuremath\rightarrow}\fi}
+\atdef -#1{\if>#1\hbox{--\raisebox{.4pt}{>}}\penalty200\relax\fi}
 
 %% Comment setting.
-\atdef ;#1\\{\normalfont\itshape;#1\\}
+\def\comment#1{\mbox{\normalfont\itshape\/#1\/}}
+\atdef /*#1*/{/*\comment{#1}*/}
+\def\@semis{\@ifnextchar;{;\@semis}\@semicomment}
+\def\@semicomment#1\\{\comment{#1}\\}
+\atdef ;#1\\{;\@semis}
 
 %% Environment for setting programs.  Newlines are explicit, because
 %% otherwise I need comments in weird places to make the vertical spacing
 %% come out properly.  You can write `\obeylines' if you really want to.
-\def\prog{\codeface\quote\tabbing}
+\def\@prog{\let\prog@@cr\@tabcr\let\@tabcr\@progcr\codeface\tabbing}
+\def\prog{\quote\@prog}
 \def\endprog{\endtabbing\endquote}
+\let\nprog\@prog
+\let\endnprog\endtabbing
 \def\ind{\quad\=\+\kill}
+\def\@progcr{\futurelet\@tempa\@progcr@i}
+{\def\:{\gdef\@progcr@sp}\: {\@progcr}}
+\atdef~{\textasciitilde}
+\def\@progcr@i{%
+  \ifx\@tempa\@sptoken\let\next@\@progcr@sp\else
+  \if1\ifx\@tempa[1\else
+      \ifx\@tempa*1\else
+      0\fi\fi
+    \let\next@\prog@@cr\else
+  \if1\ifx\@tempa+1\else
+      \ifx\@tempa-1\else
+      0\fi\fi
+    \let\next@\@progcr@ii\else
+  \let\next@\@progcr@a\fi\fi\fi
+  \next@}
+\def\@progcr@a{\prog@@cr*{}\ignorespaces}
+\def\@progcr@ii#1{\csname @progcr@#1\endcsname\ignorespaces}
+\@namedef{@progcr@+}{\prog@@cr[\medskipamount]}
+\@namedef{@progcr@-}{\prog@@cr*[\jot]}
+\def\macsl{\`\textbackslash\hskip\leftmargin}
 
 %% Put a chunk of text in a box.
 \newenvironment{boxy}[1][\q@]{%
@@ -145,17 +176,28 @@
 \def\describecategoryname#1{%
   \expandafter\let\expandafter\@tempa\csname cat!#1\endcsname%
   \ifx\@tempa\relax#1\else\@tempa\fi}
+\definedescribecategory{sym}{symbol}
 \definedescribecategory{fun}{function}
 \definedescribecategory{gf}{generic function}
+\definedescribecategory{msg}{message}
 \definedescribecategory{var}{variable}
+\definedescribecategory{modvar}{module variable}
 \definedescribecategory{const}{constant}
 \definedescribecategory{meth}{primary method}
-\definedescribecategory{ar-meth}{around-method}
-\definedescribecategory{be-meth}{before-method}
-\definedescribecategory{af-meth}{after-method}
+\definedescribecategory{ar-meth}{around method}
+\definedescribecategory{be-meth}{before method}
+\definedescribecategory{af-meth}{after method}
 \definedescribecategory{cls}{class}
+\definedescribecategory{rst}{restart}
 \definedescribecategory{ty}{type}
+\definedescribecategory{type}{type}
 \definedescribecategory{mac}{macro}
+\definedescribecategory{lmac}{local macro}
+\definedescribecategory{parse}{parser spec}
+\definedescribecategory{parseform}{parser form}
+\definedescribecategory{opt}{option handler}
+\definedescribecategory{optmac}{option macro}
+\definedescribecategory{plug}{pluggable parser}
 \def\nlret{\\\hspace{4em}\returns}
 
 \def\q@{\q@}
@@ -170,24 +212,38 @@
   \if@dheadfirst\global\@dheadfirstfalse\else\relax\\[\smallskipamount]\fi%
   {\let\protect\@empty\def\@uscore{_\@gobble}\message{#2:#1}%
    \def\@uscore{-\@gobble}\edef\@tempa{\noexpand\label{#2:#1}}\@tempa}%
-  \rlap{\rightline{\normalfont\bfseries[\describecategoryname{#2}]}}%
+  {\begingroup\lccode`\~=`\_\lowercase{\endgroup\def~{_}}%
+   \protected@edef\@tempa##1{%
+     \noexpand\index{%
+       #1@{\noexpand\code{#1}}!%
+       \csname cat!#2\endcsname%
+       ##1%
+     }%
+   }%
+   \@tempa{|(}%
+   \toks@\expandafter{\after@desc}%
+   \toks\tw@\expandafter{\@tempa{|)}}%
+   \xdef\after@desc{\the\toks@\the\toks\tw@}}%
+  \rlap{\hb@xt@\linewidth{\hfil\normalfont\bfseries
+      [\describecategoryname{#2}]}}%
   #3%
 }
 
 \def\desc@begin#1{%
+  \let\saved@after@desc\after@desc%
+  \gdef\after@desc{}%
   \normalfont%
   \if@nobreak\else\par\goodbreak\fi%
   \global\@dheadfirsttrue%
   \begingroup%
-    \codeface%
     \let\@endparenv\relax%
     \clubpenalty\@M \widowpenalty\@M \interlinepenalty50%
-    \tabbing#1\endtabbing%
+    \@prog#1\endtabbing%
   \endgroup%
   \penalty\@M\@afterheading%
   \list{}{\rightmargin\z@\topsep\z@}\item%
 }
-\let\desc@end\endlist
+\def\desc@end{\endlist\after@desc\global\let\after@desc\saved@after@desc}
 
 \@namedef{describe*}#1{\desc@begin{#1}}
 \expandafter\let\csname enddescribe*\endcsname\desc@end
@@ -195,5 +251,14 @@
 \def\desc@#1#2#3{\desc@begin{\dhead@{#1}{#2}{#3}}}
 \let\enddescribe\desc@end
 
+\def\descref#1{\@ifnextchar[{\descref@i{#1}}{\descref@ii{#1}{}}}
+\def\descref@i#1[#2]{\descref@ii{#1}{ #2}}
+\def\descref@ii#1#2#3{%
+  \code{#1}#2 (page~%
+  {\let\protect\@empty%
+   \def\@uscore{-\@gobble}\edef\@tempa{\noexpand\pageref{#3:#1}}\@tempa}%
+  )%
+}
+
 %%%----- That's all, folks --------------------------------------------------
 \endinput