Commit | Line | Data |
---|---|---|
1f7d590d MW |
1 | %%% -*-latex-*- |
2 | %%% | |
3 | %%% Styles and other hacking for the Sod manual | |
4 | %%% | |
5 | %%% (c) 2015 Straylight/Edgeware | |
6 | %%% | |
7 | ||
8 | %%%----- Licensing notice --------------------------------------------------- | |
9 | %%% | |
e0808c47 | 10 | %%% This file is part of the Sensible Object Design, an object system for C. |
1f7d590d MW |
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 | ||
82567ea9 MW |
28 | %%%-------------------------------------------------------------------------- |
29 | %%% Basic style things. | |
30 | ||
1f7d590d MW |
31 | %% More reference types. |
32 | \defxref{p}{part} | |
33 | ||
82567ea9 MW |
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. | |
ca2023b8 MW |
39 | \def\instead#1#2{#1} |
40 | ||
1f7d590d MW |
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 | ||
2ba6e0bd MW |
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 | ||
1f7d590d MW |
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 | ||
fea590fe | 70 | %% Notes for later. |
228b271d | 71 | \def\fixme#1{\leavevmode\marginpar{FIXME}\index{FIXME}[FIXME: #1]} |
fea590fe | 72 | |
a4094071 | 73 | %% Diagram settings. |
7be31112 MW |
74 | \tikzset{ |
75 | every picture/.style={>=stealth, thick}, | |
76 | lit/.style={font=\sffamily} | |
77 | } | |
a4094071 | 78 | |
1f7d590d MW |
79 | %% Metavariables are italics without decoration. |
80 | \def\syntleft{\normalfont\itshape} | |
81 | \let\syntright\empty | |
82 | ||
83 | %% Literal code is in sans face. | |
5f1bbd61 | 84 | \def\codeface{\upshape\sffamily} |
ddfe4265 MW |
85 | \DeclareRobustCommand\code[1]{% |
86 | \ifmmode\hbox\else\leavevmode\fi% | |
87 | {\normalfont\codeface\/#1\/}% | |
88 | } | |
1f7d590d MW |
89 | \def\ulitleft{\normalfont\codeface} |
90 | \let\ulitright\empty | |
48ab1447 | 91 | \def\lit@i#1#2#3{\ifmmode\leavevmode\hbox\fi{#1{#3\/}#2}} |
1f7d590d MW |
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} | |
5f1bbd61 | 102 | \atdef |#1|{\lit*{#1}\@scripts} |
1f7d590d MW |
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\@@grammar\grammar | |
110 | \def\grammar{\def\textbar{\hbox{$|$}}\@@grammar} | |
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 | |
d80aee35 | 117 | \def\@scripts@i{\if1\ifx\@ch~1\else\ifx\@ch_1\else\ifx\@ch^1\else0\fi\fi\fi% |
1f7d590d MW |
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 | ||
b13a8764 MW |
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 | ||
1f7d590d MW |
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} | |
82567ea9 | 145 | |
1f7d590d | 146 | \def\returns{\m@maybe\longrightarrow\m@maybe@end\hspace{0.5em}\ignorespaces} |
82567ea9 | 147 | \def\nlret{\\\hspace{4em}\returns} |
1f7d590d | 148 | \atdef >{\leavevmode\unskip\hspace{0.5em}\returns} |
82567ea9 MW |
149 | |
150 | %% Extra syntax for common tokens. | |
151 | \atdef ~{\textasciitilde} | |
92608d0d MW |
152 | \atdef -{\leavevmode\hbox\bgroup\futurelet\ch@\@dash} |
153 | \def\@dash{% | |
154 | \ifx\ch@>% | |
155 | --\raisebox{.4pt}{>}% | |
156 | \def\next@{\@firstoftwo{\egroup\penalty200\relax}}% | |
a8596377 MW |
157 | \else\ifx\ch@-% |
158 | --\,% | |
159 | \def\next@{\@firstoftwo{\futurelet\ch@\@dash}}% | |
92608d0d MW |
160 | \else% |
161 | --% | |
162 | \let\next@\egroup% | |
163 | \fi\fi | |
164 | \next@% | |
165 | } | |
1f7d590d MW |
166 | |
167 | %% Comment setting. | |
888d5e58 MW |
168 | \def\comment#1{\mbox{\normalfont\itshape\/#1\/}} |
169 | \atdef /*#1*/{/*\comment{#1}*/} | |
7dd104a3 | 170 | \def\@semis;{\@ifnextchar@preserve;{;\@semis}\@semicomment} |
888d5e58 | 171 | \def\@semicomment#1\\{\comment{#1}\\} |
7dd104a3 | 172 | \atdef ;{;\@semis;} |
1f7d590d | 173 | |
82567ea9 MW |
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 | %% Main guts of `prog' and `nprog'. | |
4effe575 | 193 | \def\@prog{\let\prog@@cr\@tabcr\let\@tabcr\@progcr\codeface\tabbing} |
82567ea9 MW |
194 | |
195 | %% Newlines: called by `\\' within a `prog'. | |
196 | %% | |
197 | %% \\ newline without following break | |
198 | %% \\[SKIP] newline /with/ break and vertical glue | |
199 | %% \\*[SKIP] newline without break, with optional glue | |
200 | %% \\+ newline with break and a vertical gap | |
201 | %% \\- newline without break, with a tiny gap | |
ebf5ae2e | 202 | \def\@progcr{\futurelet\@tempa\@progcr@i} |
ebf5ae2e MW |
203 | \def\@progcr@i{% |
204 | \ifx\@tempa\@sptoken\let\next@\@progcr@sp\else | |
205 | \if1\ifx\@tempa[1\else | |
206 | \ifx\@tempa*1\else | |
207 | 0\fi\fi | |
208 | \let\next@\prog@@cr\else | |
209 | \if1\ifx\@tempa+1\else | |
210 | \ifx\@tempa-1\else | |
211 | 0\fi\fi | |
212 | \let\next@\@progcr@ii\else | |
213 | \let\next@\@progcr@a\fi\fi\fi | |
214 | \next@} | |
215 | \def\@progcr@a{\prog@@cr*{}\ignorespaces} | |
216 | \def\@progcr@ii#1{\csname @progcr@#1\endcsname\ignorespaces} | |
217 | \@namedef{@progcr@+}{\prog@@cr[\medskipamount]} | |
218 | \@namedef{@progcr@-}{\prog@@cr*[\jot]} | |
82567ea9 | 219 | {\def\:{\gdef\@progcr@sp}\: {\@progcr}} % \@progcr@sp eats space and recurses |
1f7d590d | 220 | |
82567ea9 MW |
221 | %% Set a program in `codeface', with implicit tabbing and other toys. |
222 | %% Newlines are explicit, because otherwise I need comments in weird places | |
223 | %% to make the vertical spacing come out properly. You can write | |
224 | %% `\obeylines' if you really want to. | |
225 | \def\prog{\quote\@prog} | |
226 | \def\endprog{\endtabbing\endquote} | |
227 | ||
228 | %% Like `prog', but without indenting the code. Use this within environments | |
229 | %% which already set their contents out from the body text in some | |
230 | %% distinctive way. | |
231 | \let\nprog\@prog | |
232 | \let\endnprog\endtabbing | |
233 | ||
234 | %% Indent the following material. Cancel using `\-'. | |
235 | \def\ind{\quad\=\+\kill} | |
236 | ||
237 | %% Show a backslash by the right-hand margin; for multiline macros etc. | |
238 | \def\macsl{\`\textbackslash\hskip\leftmargin} | |
1f7d590d | 239 | |
82567ea9 MW |
240 | %%%-------------------------------------------------------------------------- |
241 | %%% Machinery for describing functions, etc. | |
242 | ||
243 | %% \definedescribecategory{CAT}[KIND]{NAME} | |
244 | %% | |
245 | %% Define a category of things to document. CAT is a short label identifying | |
246 | %% the category to `\describe', `\descref', and friends. The NAME is the | |
247 | %% text to show in the description headline; it is a macro body which is | |
248 | %% passed an argument `#1' that applies a modifier to some portion of the | |
249 | %% text. | |
250 | %% | |
251 | %% The KIND allows additional arguments to be collected, included in label | |
252 | %% strings, and mentioned in the index. The default is `plain'. | |
87883222 MW |
253 | \def\definedescribecategory#1{% |
254 | \@ifnextchar[{\def@desc{#1}}{\def@desc{#1}[plain]}} | |
255 | \def\def@desc#1[#2]#3{\@namedef{cat!#1}##1{#3}\@namedef{catsw!#1}{#2}} | |
82567ea9 MW |
256 | |
257 | %% \describecategoryname[MOD]{CAT} | |
258 | %% | |
259 | %% Typeset the category name for CAT, modified by MOD. | |
072f666e MW |
260 | \def\describecategoryname{\@ifnextchar[\@descname@i{\@descname@i[]}} |
261 | \def\@descname@i[#1]#2{% | |
262 | \expandafter\let\expandafter\@tempa\csname cat!#2\endcsname% | |
19a89075 | 263 | \expandafter\let\expandafter\@tempb\csname modcat/#1\endcsname% |
b35ac53a | 264 | \ifx\@tempa\relax\@tempb{#2}\else\@tempa\@tempb\fi} |
82567ea9 MW |
265 | |
266 | %% Call a modifier method. | |
22549a08 | 267 | \def\@mod@dispatch#1#2{\csname #1/#2\endcsname} |
82567ea9 MW |
268 | |
269 | %% Call a description method given the category. | |
894e3dc9 MW |
270 | \def\@desc@dispatch#1#2{% |
271 | \csname #1/% | |
82567ea9 MW |
272 | \expandafter\ifx\csname catsw!#2\endcsname\relax plain% |
273 | \else \csname catsw!#2\endcsname \fi% | |
894e3dc9 MW |
274 | \endcsname% |
275 | } | |
072f666e | 276 | |
e3e83b8a MW |
277 | %% Modifier methods for the default `plain' modifier. |
278 | \@namedef{modcat/plain}#1{#1} | |
279 | \@namedef{modlabel/plain}#1{#1} | |
280 | \@namedef{modindex/plain}#1{#1@\noexpand\code{#1}} | |
b35ac53a | 281 | |
82567ea9 MW |
282 | %% Modifier methods for `setf'. The name text prefixes the relevant word |
283 | %% with `setf-'. | |
19a89075 | 284 | \@namedef{modcat/setf}#1{\code{setf}-#1} |
22549a08 MW |
285 | \@namedef{modlabel/setf}#1{setf/#1} |
286 | \@namedef{modindex/setf}#1{#1@\noexpand\code{#1}} | |
b35ac53a | 287 | |
82567ea9 MW |
288 | %% Modifier methods for words with *earmuffs*. Sort into the index without |
289 | %% the earmuffs. | |
63288801 | 290 | \@namedef{modcat/muffs}#1{#1} |
6f38c318 MW |
291 | \@namedef{modlabel/muffs}#1{#1} |
292 | \@namedef{modindex/muffs}#1{\@unmuff#1@\noexpand\code{#1}} | |
293 | \def\@unmuff*#1*{#1} | |
63288801 | 294 | |
82567ea9 | 295 | %% Modifier methods for :keywords. Sort into the index without the `:'. |
63288801 | 296 | \@namedef{modcat/kwd}#1{#1} |
6f38c318 MW |
297 | \@namedef{modlabel/kwd}#1{#1} |
298 | \@namedef{modindex/kwd}#1{\@gobble#1@\noexpand\code{#1}} | |
63288801 | 299 | |
82567ea9 | 300 | %% Category-kind methods for plain categories. |
87883222 | 301 | \@namedef{descargs/plain}#1{#1{}} |
22549a08 | 302 | \@namedef{desclabel/plain}#1#2#3{#1:\@mod@dispatch{modlabel}{#2}{#3}} |
87883222 | 303 | \@namedef{descindex/plain}#1#2#3{% |
22549a08 | 304 | \@mod@dispatch{modindex}{#2}{#3}!% |
87883222 MW |
305 | \protect\describecategoryname[#2]{#1}% |
306 | } | |
307 | ||
82567ea9 MW |
308 | %% Category-kind methods for `method' categories. Collect an extra argument |
309 | %% listing the specializers: include them in the label, and typeset them in | |
310 | %% the index. | |
e812c742 MW |
311 | \def\fmtspecs#1#2{% |
312 | \if!#2!\else\count@\z@\toks@{}#1\fmtspecs@i#2,\q@,\fi} | |
313 | \def\fmtspecs@i#1,{% | |
87883222 MW |
314 | \def\@tempa{#1}% |
315 | \ifx\@tempa\q@% | |
316 | \ifcase\count@(no args?!)% | |
317 | \or% nothin' doin | |
318 | \or \space and % | |
319 | \else, and % | |
320 | \fi% | |
321 | \the\toks@% | |
322 | \else% | |
323 | \ifnum\count@>\@ne, \fi% | |
324 | \the\toks@% | |
325 | \toks@{\code{#1}}\advance\count@\@ne% | |
e812c742 | 326 | \expandafter\fmtspecs@i% |
87883222 MW |
327 | \fi% |
328 | } | |
82567ea9 MW |
329 | \@namedef{descargs/method}#1#2{#1{{#2}}} |
330 | \@namedef{desclabel/method}#1#2#3#4% | |
331 | {#1:\@mod@dispatch{modlabel}{#2}{#3}(#4)} | |
332 | \@namedef{descindex/method}#1#2#3#4{% | |
333 | \@mod@dispatch{modindex}{#2}{#3}!% | |
334 | \protect\describecategoryname[#2]{#1}% | |
e812c742 | 335 | \protect\fmtspecs{ specialized at }{#4}% |
82567ea9 | 336 | } |
87883222 | 337 | |
82567ea9 MW |
338 | %% Some magic strings. |
339 | \def\q@{\q@} | |
be18b63c | 340 | \def\@setf{setf} |
63288801 | 341 | \def\@starstar{**} |
82567ea9 MW |
342 | |
343 | %% \parse@dhd{NEXT}[MOD]{CAT}{...}...[NAME]{SYNOPSIS} | |
344 | %% | |
345 | %% Parse the arguments for a description header, and call | |
346 | %% | |
347 | %% NEXT{MOD}{CAT}{{...}...}{NAME}{SYNOPSIS} | |
348 | %% | |
349 | %% Here, {...}... represents the additional category-kind arguments. See | |
350 | %% `describe' for what all of this means. | |
be18b63c MW |
351 | \def\parse@dhd#1{% {NEXT} |
352 | \@ifnextchar[{\parse@dhd@a{#1}}{\parse@dhd@c{#1}}} | |
353 | \def\parse@dhd@a#1[#2]#3{% {NEXT}[MOD]{CAT} | |
354 | \@desc@dispatch{descargs}{#3}{\parse@dhd@ab{#1}{#2}{#3}}} | |
355 | \def\parse@dhd@ab#1#2#3#4{% {NEXT}{MOD}{CAT}{{...}...} | |
356 | \@ifnextchar[{\parse@dhd@ac{#1}{#2}{#3}{#4}}{\parse@dhd@ad{#1}{#2}{#3}{#4}}} | |
357 | \def\parse@dhd@ac#1#2#3#4[#5]#6{% {NEXT}{MOD}{CAT}{{...}...}[NAME]{SYNOPSIS} | |
358 | #1{#2}{#3}{#4}{#5}{#6}} | |
359 | \def\parse@dhd@ad#1#2#3#4#5{% {NEXT}{MOD}{CAT}{{...}...}{NAME [ARGS...]} | |
360 | \parse@dhd@ae{#1}{#2}{#3}{#4}{#5}#5 \q@} | |
361 | \def\parse@dhd@ae#1#2#3#4#5#6 #7\q@{% | |
362 | % {NEXT}{MOD}{CAT}{{...}...}{SYNSOPSIS}NAME [ARGS...]\q@ | |
363 | #1{#2}{#3}{#4}{#6}{#5}} | |
364 | ||
365 | \def\parse@dhd@c#1#2{% {NEXT}{CAT} | |
87883222 MW |
366 | \@desc@dispatch{descargs}{#2}{\parse@dhd@cb{#1}{#2}}} |
367 | \def\parse@dhd@cb#1#2#3{% {NEXT}{CAT}{{...}...} | |
368 | \@ifnextchar[{\parse@dhd@cc{#1}{#2}{#3}}{\parse@dhd@cd{#1}{#2}{#3}}} | |
369 | \def\parse@dhd@cc#1#2#3[#4]#5{% {NEXT}{CAT}{{...}...}[NAME]{SYNOPSIS} | |
e3e83b8a | 370 | #1{plain}{#2}{#3}{#4}{#5}} |
87883222 MW |
371 | \def\parse@dhd@cd#1#2#3#4{% {NEXT}{CAT}{{...}...}{SYNOPSIS} |
372 | \parse@dhd@ce{#1}{#2}{#3}{#4}#4 \q@} | |
373 | \def\parse@dhd@ce#1#2#3#4#5 #6\q@{% | |
374 | % {NEXT}{CAT}{{...}...}{SYNOPSIS}NAME [ARGS...]\q@ | |
375 | \def\temp@{#5}% | |
376 | \ifx\@setf\temp@\def\next@{\parse@dhd@csetf{#1}{#2}{#3}{#4}#6 \q@}% | |
63288801 | 377 | \else\def\temp@##1##2*##3\q@{\def\temp@{##1##3}}\temp@#5*\q@% |
6f38c318 | 378 | \ifx\temp@\@starstar\def\next@{#1{muffs}{#2}{#3}{#5}{#4}}% |
63288801 | 379 | \else\def\temp@##1##2\q@{\def\temp@{##1}}\temp@#5\q@% |
6f38c318 | 380 | \if:\temp@\def\next@{#1{kwd}{#2}{#3}{#5}{#4}}% |
e3e83b8a | 381 | \else\def\next@{#1{plain}{#2}{#3}{#5}{#4}}\fi\fi\fi% |
072f666e MW |
382 | \next@% |
383 | } | |
87883222 MW |
384 | \def\parse@dhd@csetf#1#2#3#4(#5 #6\q@{% |
385 | % {NEXT}{CAT}{{...}...}{SYNOPSIS}(NAME [ARGS...])\q@ | |
386 | #1{setf}{#2}{#3}{#5}{#4}} | |
7e94c5fe | 387 | |
82567ea9 MW |
388 | %% \dhead[MOD]{CAT}{...}...[NAME]{SYNOPSIS} |
389 | %% | |
390 | %% Typeset a description head. Use this within the first argument of | |
391 | %% `describe*'; see `describe' for the details. | |
7e94c5fe MW |
392 | \newif\if@dheadfirst |
393 | \def\dhead{\parse@dhd\dhead@} | |
87883222 | 394 | \def\dhead@#1#2#3#4#5{% {MOD}{CAT}{{...}...}{NAME}{SYNOPSIS} |
79766c36 | 395 | \if@dheadfirst\global\@dheadfirstfalse\else\relax\\*[\smallskipamount]\fi% |
e8511505 | 396 | \phantomsection% |
072f666e | 397 | {\let\protect\@empty\let\@uscore\relax% |
87883222 MW |
398 | \edef\temp@{\@desc@dispatch{desclabel}{#2}{#2}{#1}{#4}#3}% |
399 | \def\@uscore{_\@gobble}\expandafter\message\expandafter{\temp@}% | |
400 | \def\@uscore{-\@gobble}\expandafter\label\expandafter{\temp@}}% | |
ddfe4265 MW |
401 | {\begingroup\lccode`\~=`\_\lowercase{\endgroup\def~{_}}% |
402 | \protected@edef\@tempa##1{% | |
87883222 MW |
403 | \noexpand\index{\@desc@dispatch{descindex}{#2}{#2}{#1}{#4}#3##1}}% |
404 | \toks@\expandafter{\@tempa{|)}}% | |
405 | \toks\tw@\expandafter{\after@desc}% | |
406 | \xdef\after@desc{\the\toks\tw@\the\toks@}% | |
072f666e | 407 | \@tempa{|(}}% |
ac6e7a4e | 408 | \rlap{\hb@xt@\linewidth{\hfil\normalfont\bfseries |
072f666e | 409 | [\describecategoryname[#1]{#2}]}}% |
87883222 | 410 | #5% |
7e94c5fe MW |
411 | } |
412 | ||
82567ea9 MW |
413 | %% Main guts of a description environment. The argument here typesets the |
414 | %% header line(s). | |
7e94c5fe | 415 | \def\desc@begin#1{% |
ddfe4265 MW |
416 | \let\saved@after@desc\after@desc% |
417 | \gdef\after@desc{}% | |
1f7d590d | 418 | \normalfont% |
7e94c5fe MW |
419 | \if@nobreak\else\par\goodbreak\fi% |
420 | \global\@dheadfirsttrue% | |
421 | \begingroup% | |
7e94c5fe MW |
422 | \let\@endparenv\relax% |
423 | \clubpenalty\@M \widowpenalty\@M \interlinepenalty50% | |
ebf5ae2e | 424 | \@prog#1\endtabbing% |
7e94c5fe MW |
425 | \endgroup% |
426 | \penalty\@M\@afterheading% | |
427 | \list{}{\rightmargin\z@\topsep\z@}\item% | |
1f7d590d | 428 | } |
ddfe4265 | 429 | \def\desc@end{\endlist\after@desc\global\let\after@desc\saved@after@desc} |
7e94c5fe | 430 | |
82567ea9 MW |
431 | %% \begin{describe}[MOD]{CAT}{...}...[NAME]{SYNOPSIS} |
432 | %% ... | |
433 | %% \end{describe} | |
434 | %% | |
435 | %% Describe some kind of program object. The CAT names the category of thing | |
436 | %% being described -- this will be shown in the header, and index. The | |
437 | %% SYNOPSIS is an implicit `prog' environment in which invoking the thing can | |
438 | %% be summarized. | |
439 | %% | |
440 | %% The {...}... are any additional arguments required by the category's kind | |
441 | %% (e.g., method specializers). | |
442 | %% | |
443 | %% The NAME is the name of the thing, which ends up in the index and | |
444 | %% cross-reference label. If omitted, it defaults to the first word of the | |
445 | %% SYNOPSIS, except that there are some special cases. | |
446 | %% | |
447 | %% The MOD is the modifier to apply. If omitted, it will usually default to | |
448 | %% `plain', but in the absence of a NAME, some kinds of synopses are | |
449 | %% recognized specially: | |
450 | %% | |
451 | %% * `setf (NAME ...) ...': selects NAME, and defaults MOD to `setf'. | |
452 | %% | |
6f38c318 | 453 | %% * `*NAME*': defaults MOD to `muffs'. |
82567ea9 | 454 | %% |
6f38c318 | 455 | %% * `:NAME': defaults MOD to `kwd'. |
7e94c5fe | 456 | \def\describe{\parse@dhd\desc@} |
87883222 | 457 | \def\desc@#1#2#3#4#5{\desc@begin{\dhead@{#1}{#2}{#3}{#4}{#5}}} |
7e94c5fe | 458 | \let\enddescribe\desc@end |
1f7d590d | 459 | |
82567ea9 MW |
460 | %% \begin{describe*} |
461 | %% {\dhead[MOD]{CAT}{...}...[NAME]{SYNOPSIS} | |
462 | %% ...} | |
463 | %% ... | |
464 | %% \end{describe*} | |
465 | %% | |
466 | %% This is the fancy form of `describe' for describing several different | |
467 | %% things at once. | |
468 | \@namedef{describe*}#1{\desc@begin{#1}} | |
469 | \expandafter\let\csname enddescribe*\endcsname\desc@end | |
470 | ||
471 | %% \descref{CAT}{...}...{LABEL}[TEXT] | |
472 | %% \descref*{CAT}{...}...{LABEL} | |
473 | %% | |
474 | %% Typesets a cross-reference to a described thing. The CAT names the | |
475 | %% category of thing being described, and the LABEL names the specific thing. | |
476 | %% | |
477 | %% The {...}... are any additional arguments required by the category's kind | |
478 | %% (e.g., method specializers). | |
479 | %% | |
480 | %% The precise rules for how the LABEL matches the name in the description | |
481 | %% depend on the description's modifier: | |
482 | %% | |
6f38c318 | 483 | %% * `plain', `muffs', and `kwd': the LABEL is the same as the NAME. |
82567ea9 | 484 | %% * `setf': the LABEL should be `setf/NAME'. |
82567ea9 MW |
485 | %% |
486 | %% Usually a page-number cross-reference is included, so as to help readers | |
487 | %% of a dead-tree copy; this is suppressed by the `*' version. | |
ea214e5e MW |
488 | \def\descref{\@ifstar% |
489 | {\descref@i{}\@gobble{}}% | |
490 | {\descref@i{ (}{\noexpand\autopageref}{)}}} | |
e8d70b1b MW |
491 | \def\descref@i#1#2#3#4#5{\@ifnextchar@preserve[% |
492 | {\descref@ii{#1}{#2}{#3}{#4}{#5}}% | |
493 | {\descref@iii{#1}{#2}{#3}{#4}{#5}{}}} | |
494 | \def\descref@ii#1#2#3#4#5[#6]{\descref@iii{#1}{#2}{#3}{#4}{#5}{ #6}} | |
ea214e5e | 495 | \def\descref@iii#1#2#3#4#5#6{% |
5cf27cf1 MW |
496 | \begingroup% |
497 | \let\protect\@empty% | |
498 | \def\@uscore{-\@gobble}% | |
499 | \edef\@tempa##1{% | |
500 | \endgroup% | |
e8d70b1b | 501 | \noexpand\hyperref[#4:#5]% |
5cf27cf1 | 502 | ##1% |
e8d70b1b | 503 | #2{#4:#5}% |
5cf27cf1 | 504 | }% |
e8d70b1b | 505 | \@tempa{{\code{#5}}#6#1}#3% |
58f9b400 MW |
506 | } |
507 | ||
82567ea9 MW |
508 | %% Description categories. |
509 | \definedescribecategory{sym}{symbol} | |
510 | \definedescribecategory{fun}{#1{function}} | |
511 | \definedescribecategory{gf}{generic #1{function}} | |
512 | \definedescribecategory{msg}{message} | |
513 | \definedescribecategory{var}{variable} | |
514 | \definedescribecategory{modvar}{module variable} | |
515 | \definedescribecategory{const}{constant} | |
516 | \definedescribecategory{meth}[method]{primary #1{method}} | |
517 | \definedescribecategory{ar-meth}[method]{\code{:around} #1{method}} | |
518 | \definedescribecategory{be-meth}[method]{\code{:before} #1{method}} | |
519 | \definedescribecategory{af-meth}[method]{\code{:after} #1{method}} | |
520 | \definedescribecategory{cls}{class} | |
521 | \definedescribecategory{rst}{restart} | |
522 | \definedescribecategory{ty}{type} | |
523 | \definedescribecategory{mac}{#1{macro}} | |
524 | \definedescribecategory{feat}{feature macro} | |
525 | \definedescribecategory{lmac}{local #1{macro}} | |
526 | \definedescribecategory{parse}{parser spec} | |
527 | \definedescribecategory{parseform}{parser form} | |
528 | \definedescribecategory{opt}{option handler} | |
529 | \definedescribecategory{optmac}{option macro} | |
530 | \definedescribecategory{plug}{pluggable parser} | |
531 | ||
f1f17867 MW |
532 | %%%----- That's all, folks -------------------------------------------------- |
533 | \endinput |