X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/f64eb323a5798e155cc494043f5f750abf50a482..2242bae8744c32179cd43ff3531f0f4843b28254:/doc/sod.sty

diff --git a/doc/sod.sty b/doc/sod.sty
index 9c9aaf8..d3e7740 100644
--- a/doc/sod.sty
+++ b/doc/sod.sty
@@ -57,18 +57,28 @@
 %% Listings don't need to be small.
 \let\listingsize\relax
 
+%% Notes for later.
+\def\fixme#1{\leavevmode\marginpar{FIXME}\index{FIXME}[FIXME: #1]}
+
+%% Diagram settings.
+\tikzset{
+  every picture/.style={>=stealth, thick},
+  lit/.style={font=\sffamily}
+}
+
 %% Metavariables are italics without decoration.
 \def\syntleft{\normalfont\itshape}
 \let\syntright\empty
 
 %% Literal code is in sans face.
-\let\codeface\sffamily
+\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.
@@ -79,7 +89,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}
@@ -119,7 +129,11 @@
 \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
@@ -132,6 +146,7 @@
 \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
@@ -148,6 +163,7 @@
 \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@]{%
@@ -181,6 +197,7 @@
 \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}
@@ -193,14 +210,23 @@
 \def\nlret{\\\hspace{4em}\returns}
 
 \def\q@{\q@}
-\def\parse@dhd#1{\@ifnextchar[{\parse@dhd@a{#1}}{\parse@dhd@c{#1}}}
-\def\parse@dhd@a#1[#2]{#1{#2}}
-\def\parse@dhd@c#1#2#3{\parse@dhd@cc{#1}{#2}{#3}#3 \q@}
-\def\parse@dhd@cc#1#2#3#4 #5\q@{#1{#4}{#2}{#3}}
+
+%% \parse@dhd{NEXT}[NAME]{CAT}{SYNOPSIS}
+%% call NEXT{NAME}{CAT}{SYNOPSIS}
+%%            #1    #2     #3
+\def\parse@dhd#1{%  {NEXT}
+  \@ifnextchar[{\parse@dhd@cc{#1}}{\parse@dhd@cd{#1}}}
+\def\parse@dhd@cc#1[#2]#3#4{%  {NEXT}[NAME]{CAT}{SYNOPSIS}
+  #1{#2}{#3}{#4}}
+\def\parse@dhd@cd#1#2#3{%  {NEXT}{CAT}{SYNOPSIS}
+  \parse@dhd@ce{#1}{#2}{#3}#3 \q@}
+\def\parse@dhd@ce#1#2#3#4 #5\q@{%
+  % {NEXT}{CAT}{SYNOPSIS}NAME [ARGS...]\q@
+  #1{#4}{#2}{#3}}
 
 \newif\if@dheadfirst
 \def\dhead{\parse@dhd\dhead@}
-\def\dhead@#1#2#3{%
+\def\dhead@#1#2#3{%  {NAME}{CAT}{SYNOPSIS}
   \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}%
