Commit | Line | Data |
---|---|---|
fcb6c0fb MW |
1 | %%% -*-latex-*- |
2 | %%% | |
3 | %%% Miscellaneous functionality | |
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. |
fcb6c0fb 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 | \chapter{Miscellaneous functionality} \label{ch:misc} | |
27 | ||
28 | %%%-------------------------------------------------------------------------- | |
29 | \section{Utilities} \label{sec:misc.utilities} | |
30 | ||
31 | These symbols are defined in the @|sod-utilities| package. | |
32 | ||
33 | \begin{describe}{mac} | |
020b9e2b MW |
34 | {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind |
35 | @<declaration>^* \\ | |
cac85e0b | 36 | @<form>^*} |
fcb6c0fb MW |
37 | \end{describe} |
38 | ||
39 | \begin{describe}{mac} | |
40 | {once-only (@[[ :environment @<env> @]] | |
020b9e2b MW |
41 | @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind |
42 | @<declaration>^* \\ | |
cac85e0b | 43 | @<form>^*} |
fcb6c0fb MW |
44 | \end{describe} |
45 | ||
46 | \begin{describe}{mac} | |
cac85e0b MW |
47 | {parse-body @<body> \&key :docp :declp |
48 | @> @<doc-string> @<declarations> @<body-forms>} | |
fcb6c0fb MW |
49 | \end{describe} |
50 | ||
7262683b MW |
51 | \begin{describe}{cls}{loc} |
52 | \end{describe} | |
53 | ||
54 | \begin{describe}{fun}{locp @<object> @> @<generalized-boolean>} | |
55 | \end{describe} | |
56 | ||
cac85e0b | 57 | \begin{describe}{mac}{locf @<place> @> @<locative>} |
7262683b MW |
58 | \end{describe} |
59 | ||
60 | \begin{describe*} | |
61 | {\dhead{fun}{ref @<locative> @> @<value>} | |
62 | \dhead{fun}{setf (ref @<locative>) @<value>}} | |
63 | \end{describe*} | |
64 | ||
65 | \begin{describe}{mac} | |
66 | {with-locatives | |
67 | @{ @<var> @! (@{ @<var> @! | |
020b9e2b MW |
68 | (@<var> @[@<locative>@]) @}^*) @} \\ \ind |
69 | @<declaration>^* \\ | |
cac85e0b | 70 | @<form>^*} |
7262683b MW |
71 | \end{describe} |
72 | ||
fcb6c0fb MW |
73 | \begin{describe}{sym}{it} |
74 | \end{describe} | |
75 | ||
76 | \begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]} | |
77 | \end{describe} | |
78 | ||
3e166443 MW |
79 | \begin{describe}{mac}{aand @<form>^*} |
80 | \end{describe} | |
81 | ||
cac85e0b | 82 | \begin{describe}{mac}{awhen @<condition> @<form>^*} |
fcb6c0fb MW |
83 | \end{describe} |
84 | ||
85 | \begin{describe}{mac}{acond @{ (@<condition> @<form>^*) @}^*} | |
86 | \end{describe} | |
87 | ||
88 | \begin{describe*} | |
89 | {\dhead{mac} | |
90 | {acase @<scrutinee> @{ (@{ @<case> @! (@<case>^*) @} @<form>^*) @}^*} | |
91 | \dhead{mac} | |
92 | {aecase @<scrutinee> @{ (@{ @<case> @! (@<case>^*) @} @<form>^*) @}^*} | |
93 | \dhead{mac}{atypecase @<scrutinee> @{ (@<type> @<form>^*) @}^*} | |
94 | \dhead{mac}{aetypecase @<scrutinee> @{ (@<type> @<form>^*) @}^*}} | |
95 | \end{describe*} | |
96 | ||
97 | \begin{describe}{mac}{asetf @{ @<place> @<value> @}^*} | |
98 | \end{describe} | |
99 | ||
100 | \begin{describe}{gf}{instance-initargs @<instance>} | |
101 | \end{describe} | |
102 | ||
103 | \begin{describe*} | |
104 | {\dhead{fun}{copy-instance @<instance> \&rest @<initargs>} | |
105 | \dhead{gf}{copy-instance-using-class @<class> @<instance> | |
106 | \&rest @<initargs>}} | |
107 | \end{describe*} | |
108 | ||
109 | \begin{describe*} | |
110 | {\dhead{gf}{generic-function-methods @<generic-function> @> @<list>} | |
111 | \dhead{gf}{method-specializers @<method> @> @<list>} | |
112 | \dhead{cls}{eql-specializer} | |
113 | \dhead{gf}{eql-specializer-object @<specializer> @> @<value>}} | |
114 | \end{describe*} | |
115 | ||
116 | \begin{describe}{fun}{make-list-builder \&optional @<initial> @> @<builder>} | |
117 | \end{describe} | |
118 | ||
119 | \begin{describe}{fun}{lbuild-add @<builder> @<item> @> @<builder>} | |
120 | \end{describe} | |
121 | ||
122 | \begin{describe}{fun}{lbuild-add-list @<builder> @<list> @> @<builder>} | |
123 | \end{describe} | |
124 | ||
125 | \begin{describe}{fun}{lbuild-list @<builder> @> @<list>} | |
126 | \end{describe} | |
127 | ||
128 | \begin{describe}{fun} | |
129 | {mappend @<function> @<list> \&rest @<more-lists> @> @<result-list>} | |
130 | \end{describe} | |
131 | ||
17c7c784 MW |
132 | \begin{describe}{fun} |
133 | {distinguished-point-shortest-paths @<root> @<neighbours-func> | |
134 | @> @<list>} | |
135 | \end{describe} | |
136 | ||
fcb6c0fb MW |
137 | \begin{describe}{cls}{inconsistent-merge-error (error) \&key :candidates} |
138 | \end{describe} | |
139 | ||
140 | \begin{describe}{gf}{merge-error-candidates @<error> @> @<list>} | |
141 | \end{describe} | |
142 | ||
143 | \begin{describe}{fun} | |
e2838dc5 | 144 | {merge-lists @<lists> \&key :pick (:test \#'eql) :present @> @<list>} |
fcb6c0fb MW |
145 | \end{describe} |
146 | ||
147 | \begin{describe}{mac} | |
148 | {categorize (\=@<item-var> @<items> | |
020b9e2b MW |
149 | @[[ :bind (@{ @<var> @! |
150 | (@<var> @[@<value>@]) @}^*) @]]) | |
151 | \\ \ind\ind | |
152 | (@{ (@<cat-var> @<cat-predicate>) @}^*) \-\\ | |
153 | @<declaration>^* \\ | |
cd35a54e | 154 | @<form>^* |
020b9e2b | 155 | \-\nlret @<value>^*} |
fcb6c0fb MW |
156 | \end{describe} |
157 | ||
42291726 MW |
158 | \begin{describe}{fun}{partial-order-minima @<items> @<order> @> @<list>} |
159 | \end{describe} | |
160 | ||
fcb6c0fb | 161 | \begin{describe}{fun} |
64cbfb65 MW |
162 | {find-duplicates @<report> @<sequence> \&key :identity :test} |
163 | \end{describe} | |
164 | ||
165 | \begin{describe}{fun} | |
fcb6c0fb MW |
166 | {frob-identifier @<string> \&key :swap-case :swap-hyphen |
167 | @> @<frobbed-string>} | |
168 | \end{describe} | |
169 | ||
64cbfb65 MW |
170 | \begin{describe}{fun} |
171 | {whitespace-char-p @<character> @> @<generalized-boolean>} | |
fcb6c0fb MW |
172 | \end{describe} |
173 | ||
174 | \begin{describe}{fun} | |
175 | {update-position @<character> @<line> @<column> | |
176 | @> @<new-line> @<new-column>} | |
177 | \end{describe} | |
178 | ||
179 | \begin{describe}{fun} | |
180 | {backtrack-position @<character> @<line> @<column> | |
181 | @> @<old-line> @<old-column>} | |
182 | \end{describe} | |
183 | ||
184 | \begin{describe}{fun} | |
185 | {compose @<function> \&rest @<more-functions> @> @<function>} | |
186 | \end{describe} | |
187 | ||
c34b237d MW |
188 | \begin{describe}{mac}{defvar @<name> @<documentation> @> @<name>} |
189 | \end{describe} | |
190 | ||
fcb6c0fb MW |
191 | \begin{describe}{fun}{symbolicate \&rest @<symbols> @> @<symbol>} |
192 | \end{describe} | |
193 | ||
194 | \begin{describe}{mac} | |
020b9e2b MW |
195 | {maybe-print-unreadable-object |
196 | (@<object> @<stream> | |
197 | @[[ :type @<type> @! | |
198 | :identity @<identity> @]]) \\ \ind | |
199 | @<declaration>^* \\ | |
cac85e0b | 200 | @<form>^*} |
fcb6c0fb MW |
201 | \end{describe} |
202 | ||
08b6e064 MW |
203 | \begin{describe}{fun}{print-ugly-stuff @<stream> @<func> @> @<value>^*} |
204 | \end{describe} | |
205 | ||
fcb6c0fb MW |
206 | \begin{describe}{mac} |
207 | {dosequence (@<var> @<sequence> | |
208 | @[[ :start @<start> @! :end @<end> @! | |
020b9e2b MW |
209 | :indexvar @<var> @]]) \\ \ind |
210 | @<declaration>^* \\ | |
cac85e0b | 211 | @{ @<tag> @! @<statement> @}^*} |
fcb6c0fb MW |
212 | \end{describe} |
213 | ||
214 | \begin{describe}{mac} | |
215 | {define-access-wrapper @<from> @<to> | |
216 | @[[ :read-only @<read-only-flag> @]]} | |
217 | \end{describe} | |
218 | ||
f7b60deb MW |
219 | \begin{describe}{cls} |
220 | {simple-control-error (control-error simple-error) | |
221 | \&key :format-control :format-arguments} | |
222 | \end{describe} | |
223 | ||
db6c3279 MW |
224 | \begin{describe}{fun} |
225 | {designated-condition | |
226 | \=@<default-type> @<datum> @<arguments> \\ | |
227 | \>\&key :allow-pointless-arguments | |
228 | \nlret @<condition>} | |
229 | \end{describe} | |
230 | ||
f7b60deb MW |
231 | \begin{describe}{fun} |
232 | {invoke-associated-restart @<restart> @<condition> \&rest @<arguments>} | |
233 | \end{describe} | |
234 | ||
fcb6c0fb | 235 | \begin{describe}{mac} |
020b9e2b | 236 | {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind |
cac85e0b | 237 | @<form>^*} |
fcb6c0fb MW |
238 | \end{describe} |
239 | ||
240 | \begin{describe}{mac} | |
020b9e2b MW |
241 | {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind |
242 | @[[ @<declaration>^* @! @<doc-string> @]] \\ | |
cac85e0b | 243 | @<form>^*} |
fcb6c0fb MW |
244 | \end{describe} |
245 | ||
246 | %%%-------------------------------------------------------------------------- | |
247 | \section{Condition utilities} \label{sec:misc.condition} | |
248 | ||
249 | These symbols are defined in the @|sod-parser| package. | |
250 | ||
251 | \begin{describe}{cls}{enclosing-condition (condition) \&key :condition} | |
252 | \end{describe} | |
253 | ||
254 | \begin{describe}{gf} | |
255 | {enclosed-condition @<enclosing-condition> @> @<condition>} | |
256 | \end{describe} | |
257 | ||
db6c3279 MW |
258 | \begin{describe}{cls}{information (condition) \&key} |
259 | \end{describe} | |
260 | ||
261 | \begin{describe}{cls} | |
262 | {simple-information (simple-condition information) \\ \ind | |
263 | \&key :format-control :format-arguments} | |
264 | \end{describe} | |
265 | ||
266 | \begin{describe}{fun}{info @<datum> \&rest @<arguments> @> @<flag>} | |
267 | \end{describe} | |
268 | ||
e43bd955 MW |
269 | \begin{describe*} |
270 | {\dhead{rst}{noted} | |
271 | \dhead{fun}{noted \&optional @<condition>}} | |
272 | \end{describe*} | |
db6c3279 | 273 | |
fcb6c0fb MW |
274 | \begin{describe}{fun}{cerror* @<datum> \&rest @<arguments>} |
275 | \end{describe} | |
276 | ||
277 | %%%-------------------------------------------------------------------------- | |
278 | \section{Option parser} \label{sec:misc.optparse} | |
279 | ||
054e8f8f | 280 | These symbols are defined in the @|optparse| package. |
fcb6c0fb MW |
281 | |
282 | \begin{describe}{fun}{exit \&optional (@<code> 0) \&key :abrupt} | |
283 | \end{describe} | |
284 | ||
285 | \begin{describe}{var}{*program-name*} | |
286 | \end{describe} | |
287 | ||
288 | \begin{describe}{var}{*command-line*} | |
289 | \end{describe} | |
290 | ||
291 | \begin{describe}{fun}{set-command-line-arguments} | |
292 | \end{describe} | |
293 | ||
fcb6c0fb MW |
294 | \begin{describe}{fun}{moan @<format-string> \&rest @<format-args>} |
295 | \end{describe} | |
296 | ||
297 | \begin{describe}{fun}{die @<format-string> \&rest @<format-args>} | |
298 | \end{describe} | |
299 | ||
300 | \begin{describe}{var}{*options*} | |
301 | \end{describe} | |
302 | ||
303 | \begin{describe}{cls}{option} | |
304 | \end{describe} | |
305 | ||
306 | \begin{describe}{fun}{optionp @<object> @> @<generalized-boolean>} | |
307 | \end{describe} | |
308 | ||
309 | \begin{describe}{fun} | |
020b9e2b MW |
310 | {make-option \=@<long-name> @<short-name> \+\\ |
311 | \&optional @<arg-name> \\ | |
312 | \&key :tag :negated-tag | |
313 | :arg-optional-p :documentation \- | |
fcb6c0fb MW |
314 | \nlret @<option>} |
315 | \end{describe} | |
316 | ||
317 | \begin{describe*} | |
318 | {\dhead{fun}{opt-short-name @<option> @> @<character-or-null>} | |
319 | \dhead{fun}{setf (opt-short-name @<option>) @<character-or-null>} | |
320 | \dhead{fun}{opt-long-name @<option> @> @<string-or-null>} | |
321 | \dhead{fun}{setf (opt-long-name @<option>) @<string-or-null>} | |
322 | \dhead{fun}{opt-tag @<option> @> @<tag>} | |
323 | \dhead{fun}{setf (opt-tag @<option>) @<tag>} | |
324 | \dhead{fun}{opt-negated-tag @<option> @> @<tag>} | |
325 | \dhead{fun}{setf (opt-negated-tag @<option>) @<tag>} | |
326 | \dhead{fun}{opt-arg-name @<option> @> @<string-or-null>} | |
327 | \dhead{fun}{setf (opt-arg-name @<option>) @<string-or-null>} | |
328 | \dhead{fun}{opt-optional-p @<option> @> @<generalized-boolean>} | |
329 | \dhead{fun}{setf (opt-optional-p @<option>) @<generalized-boolean>} | |
330 | \dhead{fun}{opt-documentation @<option> @> @<string-or-null>} | |
331 | \dhead{fun}{setf (opt-documentation @<option>) @<string-or-null>}} | |
332 | \end{describe*} | |
333 | ||
334 | \begin{describe}{cls}{option-parser} | |
335 | \end{describe} | |
336 | ||
337 | \begin{describe}{fun}{option-parser-p @<object> @> @<generalized-boolean>} | |
338 | \end{describe} | |
339 | ||
340 | \begin{describe}{fun} | |
341 | {make-option-parser \&key \=:args :options :non-option :numericp \+ \\ | |
342 | :negated-numeric-p long-only-p \- | |
343 | \nlret @<option-parser>} | |
344 | \end{describe} | |
345 | ||
346 | \begin{describe*} | |
347 | {\dhead{fun}{op-options @<option-parser> @> @<list>} | |
348 | \dhead{fun}{setf (op-options @<option-parser>) @<list>} | |
349 | \dhead{fun}{op-non-option @<option-parser> @> @<action>} | |
350 | \dhead{fun}{setf (op-non-option @<option-parser>) @<action>} | |
351 | \dhead{fun}{op-long-only-p @<option-parser> @> @<generalized-boolean>} | |
352 | \dhead{fun}{setf (op-long-only-p @<option-parser>) @<generalized-boolean>} | |
353 | \dhead{fun}{op-numeric-p @<option-parser> @> @<generalized-boolean>} | |
354 | \dhead{fun}{setf (op-numeric-p @<option-parser>) @<generalized-boolean>} | |
355 | \dhead{fun}{op-negated-numeric-p @<option-parser> @<generalized-boolean>} | |
356 | \dhead{fun}{setf (op-negated-numeric-p @<option-parser>) @<generalized-boolean>} | |
357 | \dhead{fun}{op-negated-p @<option-parser> @> @<generalized-boolean>} | |
358 | \dhead{fun}{setf (op-negated-p @<option-parser>) @<generalized-boolean>}} | |
359 | \end{describe*} | |
360 | ||
361 | \begin{describe}{cls} | |
362 | {option-parse-error (error simple-condition) | |
363 | \&key :format-control :format-arguments} | |
364 | \end{describe} | |
365 | ||
366 | \begin{describe}{fun}{option-parse-remainder @<option-parser>} | |
367 | \end{describe} | |
368 | ||
369 | \begin{describe}{fun}{option-parse-return @<tag> \&optional @<argument>} | |
370 | \end{describe} | |
371 | ||
372 | \begin{describe}{fun}{option-parse-next @<option-parser>} | |
373 | \end{describe} | |
374 | ||
cac85e0b | 375 | \begin{describe}{mac}{option-parse-try @<form>^*} |
fcb6c0fb MW |
376 | \end{describe} |
377 | ||
cac85e0b | 378 | \begin{describe}{mac}{with-unix-error-reporting () @<form>^*} |
fcb6c0fb MW |
379 | \end{describe} |
380 | ||
381 | \begin{describe}{mac} | |
382 | {defopthandler @<name> (@<var> @[@<arg>@]) @<lambda-list> \\ \ind | |
cac85e0b MW |
383 | @[[ @<declaration>^* @! @<doc-string> @]] \\ |
384 | @<form>^*} | |
fcb6c0fb MW |
385 | \end{describe} |
386 | ||
387 | \begin{describe}{fun} | |
388 | {invoke-option-handler @<handler> @<locative> @<arg> @<arguments>} | |
389 | \end{describe} | |
390 | ||
391 | \begin{describe}{opt}{set \&optional @<value>} | |
392 | \end{describe} | |
393 | ||
394 | \begin{describe}{opt}{clear \&optional @<value>} | |
395 | \end{describe} | |
396 | ||
397 | \begin{describe}{opt}{inc \&optional @<maximum> @<step>} | |
398 | \end{describe} | |
399 | ||
400 | \begin{describe}{opt}{dec \&optional <minimum> <step>} | |
401 | \end{describe} | |
402 | ||
403 | \begin{describe}{opt}{read} | |
404 | \end{describe} | |
405 | ||
406 | \begin{describe}{opt}{int \&key :radix :min :max} | |
407 | \end{describe} | |
408 | ||
409 | \begin{describe}{opt}{string} | |
410 | \end{describe} | |
411 | ||
412 | \begin{describe}{opt}{keyword \&optional @<valid>} | |
413 | \end{describe} | |
414 | ||
415 | \begin{describe}{opt}{list \&optional @<handler> \&rest @<handler-args>} | |
416 | \end{describe} | |
417 | ||
cac85e0b MW |
418 | \begin{describe}{mac} |
419 | {defoptmacro @<name> @<lambda-list> \\ \ind | |
420 | @[[ @<declaration>^* @! @<doc-string> @]] \\ | |
421 | @<form>^*} | |
fcb6c0fb MW |
422 | \end{describe} |
423 | ||
424 | \begin{describe}{fun}{parse-option-form @<form>} | |
425 | \end{describe} | |
426 | ||
427 | \begin{describe}{mac} | |
428 | {options @{ \=@<string> @! \+ \\ | |
429 | @<option-macro> @! (@<option-macro> @<macro-arg>^*) @! \\ | |
430 | (@[[ \=@<character> @! (:short-name @<character>) @! \+ \\ | |
431 | @<string>^* @! @<symbol> @! @<rational> @! | |
432 | (:long-name @<string>) @! \\ | |
433 | (@<string> @<format-arg>^+) @! | |
434 | (:doc @<string> @<format-arg>^*) @! \\ | |
984c3fc3 | 435 | (:arg @<arg-name>) @! (:opt-arg @<arg-name>) @! \\ |
fcb6c0fb MW |
436 | @<keyword> @! (:tag @<tag>) @! |
437 | (:negated-tag @<tag>) @! \\ | |
cac85e0b MW |
438 | @{ (@<handler> @<var> @<handler-arg>^*) @}^* |
439 | @]]) @}^*} | |
fcb6c0fb MW |
440 | \end{describe} |
441 | ||
442 | \begin{describe}{fun} | |
443 | {simple-usage @<option-list> \&optional @<mandatory-args> @> @<list>} | |
444 | \end{describe} | |
445 | ||
446 | \begin{describe}{fun}{show-usage @<prog> @<usage> \&optional @<stream>} | |
447 | \end{describe} | |
448 | ||
449 | \begin{describe}{fun} | |
450 | {show-help @<prog> @<usage> @<option-list> \&optional @<stream>} | |
451 | \end{describe} | |
452 | ||
453 | \begin{describe}{fun}{sanity-check-option-list @<option-list>} | |
454 | \end{describe} | |
455 | ||
456 | \begin{describe*} | |
457 | {\dhead{var}{*help*} | |
458 | \dhead{var}{*version*} | |
459 | \dhead{var}{*usage*}} | |
460 | \end{describe*} | |
461 | ||
462 | \begin{describe}{fun}{do-usage \&optional @<stream>} | |
463 | \end{describe} | |
464 | ||
465 | \begin{describe}{fun}{die-usage} | |
466 | \end{describe} | |
467 | ||
468 | \begin{describe}{optmac} | |
469 | {help-options \&key :short-help :short-version :short-usage} | |
470 | \end{describe} | |
471 | ||
472 | \begin{describe}{fun} | |
473 | {define-program \&key \=:program-name \+ \\ | |
474 | :help :version :usage :full-usage \\ | |
475 | :options} | |
476 | \end{describe} | |
477 | ||
478 | \begin{describe}{mac} | |
479 | {do-options (@[[ :parser @<option-parser> @]]) \\ \ind | |
480 | @{ (@{ @<case> @! (@<case>^*)@} (@[@[@<opt-var>@] @<arg-var>@]) | |
481 | @<form>^*) @}^*} | |
482 | \end{describe} | |
483 | ||
484 | %%%-------------------------------------------------------------------------- | |
485 | \section{Property sets} \label{sec:misc.pset} | |
486 | ||
2c7465ac MW |
487 | \begin{describe}{fun}{property-key @<name> @> @<keyword>} |
488 | \end{describe} | |
489 | ||
490 | \begin{describe}{gf}{decode-property @<raw-value> @> @<type> @<value>} | |
491 | \end{describe} | |
492 | ||
493 | \begin{describe}{cls}{property} | |
494 | \end{describe} | |
495 | ||
496 | \begin{describe}{fun}{propertyp @<object> @> @<generalized-boolean>} | |
497 | \end{describe} | |
498 | ||
499 | \begin{describe}{fun} | |
500 | {make-property @<name> @<raw-value> \&key :type :location :seenp} | |
501 | \end{describe} | |
502 | ||
503 | \begin{describe*} | |
504 | {\dhead{fun}{p-name @<property> @> @<name>} | |
2c7465ac | 505 | \dhead{fun}{p-value @<property> @> @<value>} |
2c7465ac | 506 | \dhead{fun}{p-type @<property> @> @<type>} |
2c7465ac | 507 | \dhead{fun}{p-key @<property> @> @<symbol>} |
2c7465ac MW |
508 | \dhead{fun}{p-seenp @<property> @> @<boolean>} |
509 | \dhead{fun}{setf (p-seenp @<property>) @<boolean>}} | |
510 | \end{describe*} | |
511 | ||
2c7465ac MW |
512 | \begin{describe}{gf} |
513 | {coerce-property-value @<value> @<type> @<wanted> @> @<coerced-value>} | |
514 | \end{describe} | |
515 | ||
516 | \begin{describe}{cls}{pset} | |
517 | \end{describe} | |
518 | ||
519 | \begin{describe}{fun}{psetp @<object> @> @<generalized-boolean>} | |
520 | \end{describe} | |
521 | ||
522 | \begin{describe}{fun}{make-pset @> @<pset>} | |
523 | \end{describe} | |
524 | ||
525 | \begin{describe}{fun}{pset-get @<pset> @<key> @> @<property-or-nil>} | |
526 | \end{describe} | |
527 | ||
528 | \begin{describe}{fun}{pset-store @<pset> @<property> @> @<property>} | |
529 | \end{describe} | |
530 | ||
531 | \begin{describe}{fun}{pset-map @<func> @<pset>} | |
532 | \end{describe} | |
533 | ||
cac85e0b MW |
534 | \begin{describe}{mac} |
535 | {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*} | |
2c7465ac MW |
536 | \end{describe} |
537 | ||
538 | \begin{describe}{fun} | |
539 | {store-property @<pset> @<name> @<value> \&key :type :location | |
540 | @> @<property>} | |
541 | \end{describe} | |
542 | ||
543 | \begin{describe}{fun} | |
544 | {get-property @<pset> @<name> @<type> \&optional @<default> | |
545 | @> @<value> @<floc-or-nil>} | |
546 | \end{describe} | |
547 | ||
548 | \begin{describe}{fun} | |
549 | {add-property @<pset> @<name> @<value> \&key :type :location | |
550 | @> @<property>} | |
551 | \end{describe} | |
552 | ||
553 | \begin{describe}{fun}{make-property-set \&rest @<plist> @> @<pset>} | |
554 | \end{describe} | |
555 | ||
556 | \begin{describe}{gf}{property-set @<thing> @> @<pset>} | |
557 | \end{describe} | |
558 | ||
559 | \begin{describe}{fun}{check-unused-properties @<pset>} | |
560 | \end{describe} | |
561 | ||
562 | \begin{describe}{mac} | |
563 | {default-slot-from-property | |
564 | (@<instance> @<slot> @[@<slot-names>@]) \\ \ind\ind | |
565 | (@<pset> @<property> @<type> @[@<prop-var> @<convert-form>^*@]) \- \\ | |
cac85e0b | 566 | @<declaration>^* \\ |
2c7465ac MW |
567 | @<default-form>^*} |
568 | \end{describe} | |
569 | ||
570 | \begin{describe}{fun} | |
b944e68b MW |
571 | {parse-property @<scanner> @<pset> |
572 | @> @<result> @<success-flag> @<consumed-flag>} | |
573 | \end{describe} | |
574 | ||
575 | \begin{describe}{fun} | |
2c7465ac MW |
576 | {parse-property-set @<scanner> |
577 | @> @<result> @<success-flag> @<consumed-flag>} | |
578 | \end{describe} | |
579 | ||
fcb6c0fb | 580 | %%%-------------------------------------------------------------------------- |
8fc2932b | 581 | \section{Miscellaneous translator features} \label{sec:misc.misc} |
fcb6c0fb MW |
582 | |
583 | \begin{describe}{var}{*sod-version*} | |
584 | \end{describe} | |
585 | ||
586 | \begin{describe}{var}{*debugout-pathname*} | |
587 | \end{describe} | |
588 | ||
60529354 MW |
589 | \begin{describe}{fun} |
590 | {test-module @<path> \&key :reason :clear :backtrace @> @<status>} | |
fcb6c0fb MW |
591 | \end{describe} |
592 | ||
4fd69126 MW |
593 | \begin{describe}{fun} |
594 | {test-parse-c-type @<string> | |
595 | @> t @<c-type> @<kernel> @<string> @! nil @<indicator>} | |
596 | \end{describe} | |
597 | ||
bf34c708 MW |
598 | \begin{describe}{fun} |
599 | {test-parse-pset @<string> | |
600 | @> t @<pset> @! nil @<indicator>} | |
601 | \end{describe} | |
602 | ||
3e21ae3f | 603 | \begin{describe}{mac} |
2b7ce7a5 MW |
604 | {test-parser (@<scanner> \&key :backtrace) @<parser> @<input> |
605 | @> @<result> @<status> @<remainder>} | |
3e21ae3f MW |
606 | \end{describe} |
607 | ||
fcb6c0fb MW |
608 | \begin{describe}{fun}{exercise} |
609 | \end{describe} | |
610 | ||
2c7465ac MW |
611 | \begin{describe}{fun}{sod-frontend:main} |
612 | \end{describe} | |
613 | ||
fcb6c0fb MW |
614 | %%%----- That's all, folks -------------------------------------------------- |
615 | ||
616 | %%% Local variables: | |
617 | %%% mode: LaTeX | |
618 | %%% TeX-master: "sod.tex" | |
619 | %%% TeX-PDF-mode: t | |
620 | %%% End: |