f23d6a05ca42dee46d426916a87f5c5de3b16da6
[sod] / doc / misc.tex
1 %%% -*-latex-*-
2 %%%
3 %%% Miscellaneous functionality
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 \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}
34 {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
35 @<declaration>^* \\
36 @<form>^*}
37 \end{describe}
38
39 \begin{describe}{mac}
40 {once-only (@[[ :environment @<env> @]]
41 @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
42 @<declaration>^* \\
43 @<form>^*}
44 \end{describe}
45
46 \begin{describe}{mac}
47 {parse-body @<body> \&key :docp :declp
48 @> @<doc-string> @<declarations> @<body-forms>}
49 \end{describe}
50
51 \begin{describe}{cls}{loc}
52 \end{describe}
53
54 \begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
55 \end{describe}
56
57 \begin{describe}{mac}{locf @<place> @> @<locative>}
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> @!
68 (@<var> @[@<locative>@]) @}^*) @} \\ \ind
69 @<declaration>^* \\
70 @<form>^*}
71 \end{describe}
72
73 \begin{describe}{sym}{it}
74 \end{describe}
75
76 \begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
77 \end{describe}
78
79 \begin{describe}{mac}{aand @<form>^*}
80 \end{describe}
81
82 \begin{describe}{mac}{awhen @<condition> @<form>^*}
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
132 \begin{describe}{fun}
133 {distinguished-point-shortest-paths @<root> @<neighbours-func>
134 @> @<list>}
135 \end{describe}
136
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}
144 {merge-lists @<lists> \&key :pick (:test \#'eql) :present @> @<list>}
145 \end{describe}
146
147 \begin{describe}{mac}
148 {categorize (\=@<item-var> @<items>
149 @[[ :bind (@{ @<var> @!
150 (@<var> @[@<value>@]) @}^*) @]])
151 \\ \ind\ind
152 (@{ (@<cat-var> @<cat-predicate>) @}^*) \-\\
153 @<declaration>^* \\
154 @<form>^*
155 \-\nlret @<value>^*}
156 \end{describe}
157
158 \begin{describe}{fun}{partial-order-minima @<items> @<order> @> @<list>}
159 \end{describe}
160
161 \begin{describe}{fun}
162 {find-duplicates @<report> @<sequence> \&key :identity :test}
163 \end{describe}
164
165 \begin{describe}{fun}
166 {frob-identifier @<string> \&key :swap-case :swap-hyphen
167 @> @<frobbed-string>}
168 \end{describe}
169
170 \begin{describe}{fun}
171 {whitespace-char-p @<character> @> @<generalized-boolean>}
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
188 \begin{describe}{mac}{defvar @<name> @<documentation> @> @<name>}
189 \end{describe}
190
191 \begin{describe}{fun}{symbolicate \&rest @<symbols> @> @<symbol>}
192 \end{describe}
193
194 \begin{describe}{mac}
195 {maybe-print-unreadable-object
196 (@<object> @<stream>
197 @[[ :type @<type> @!
198 :identity @<identity> @]]) \\ \ind
199 @<declaration>^* \\
200 @<form>^*}
201 \end{describe}
202
203 \begin{describe}{fun}{print-ugly-stuff @<stream> @<func> @> @<value>^*}
204 \end{describe}
205
206 \begin{describe}{mac}
207 {dosequence (@<var> @<sequence>
208 @[[ :start @<start> @! :end @<end> @!
209 :indexvar @<var> @]]) \\ \ind
210 @<declaration>^* \\
211 @{ @<tag> @! @<statement> @}^*}
212 \end{describe}
213
214 \begin{describe}{mac}
215 {define-access-wrapper @<from> @<to>
216 @[[ :read-only @<read-only-flag> @]]}
217 \end{describe}
218
219 \begin{describe}{cls}
220 {simple-control-error (control-error simple-error)
221 \&key :format-control :format-arguments}
222 \end{describe}
223
224 \begin{describe}{fun}
225 {designated-condition
226 \=@<default-type> @<datum> @<arguments> \\
227 \>\&key :allow-pointless-arguments
228 \nlret @<condition>}
229 \end{describe}
230
231 \begin{describe}{fun}
232 {invoke-associated-restart @<restart> @<condition> \&rest @<arguments>}
233 \end{describe}
234
235 \begin{describe}{mac}
236 {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
237 @<form>^*}
238 \end{describe}
239
240 \begin{describe}{mac}
241 {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
242 @[[ @<declaration>^* @! @<doc-string> @]] \\
243 @<form>^*}
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
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
269 \begin{describe*}
270 {\dhead{rst}{noted}
271 \dhead{fun}{noted \&optional @<condition>}}
272 \end{describe*}
273
274 \begin{describe}{fun}{cerror* @<datum> \&rest @<arguments>}
275 \end{describe}
276
277 %%%--------------------------------------------------------------------------
278 \section{Option parser} \label{sec:misc.optparse}
279
280 These symbols are defined in the @|optparse| package.
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
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}
310 {make-option \=@<long-name> @<short-name> \+\\
311 \&optional @<arg-name> \\
312 \&key :tag :negated-tag
313 :arg-optional-p :documentation \-
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
375 \begin{describe}{mac}{option-parse-try @<form>^*}
376 \end{describe}
377
378 \begin{describe}{mac}{with-unix-error-reporting () @<form>^*}
379 \end{describe}
380
381 \begin{describe}{mac}
382 {defopthandler @<name> (@<var> @[@<arg>@]) @<lambda-list> \\ \ind
383 @[[ @<declaration>^* @! @<doc-string> @]] \\
384 @<form>^*}
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
418 \begin{describe}{mac}
419 {defoptmacro @<name> @<lambda-list> \\ \ind
420 @[[ @<declaration>^* @! @<doc-string> @]] \\
421 @<form>^*}
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>^*) @! \\
435 (:arg @<arg-name>) @! (:opt-arg @<arg-name>) @! \\
436 @<keyword> @! (:tag @<tag>) @!
437 (:negated-tag @<tag>) @! \\
438 @{ (@<handler> @<var> @<handler-arg>^*) @}^*
439 @]]) @}^*}
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
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>}
505 \dhead{fun}{p-value @<property> @> @<value>}
506 \dhead{fun}{p-type @<property> @> @<type>}
507 \dhead{fun}{p-key @<property> @> @<symbol>}
508 \dhead{fun}{p-seenp @<property> @> @<boolean>}
509 \dhead{fun}{setf (p-seenp @<property>) @<boolean>}}
510 \end{describe*}
511
512 \begin{describe}{gf}{decode-property @<raw-value> @> @<type> @<value>}
513 \end{describe}
514
515 \begin{describe}{gf}
516 {coerce-property-value @<value> @<type> @<wanted> @> @<coerced-value>}
517 \end{describe}
518
519 \begin{describe}{cls}{pset}
520 \end{describe}
521
522 \begin{describe}{fun}{psetp @<object> @> @<generalized-boolean>}
523 \end{describe}
524
525 \begin{describe}{fun}{make-pset @> @<pset>}
526 \end{describe}
527
528 \begin{describe}{fun}{pset-get @<pset> @<key> @> @<property-or-nil>}
529 \end{describe}
530
531 \begin{describe}{fun}{pset-store @<pset> @<property> @> @<property>}
532 \end{describe}
533
534 \begin{describe}{fun}{pset-map @<func> @<pset>}
535 \end{describe}
536
537 \begin{describe}{mac}
538 {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*}
539 \end{describe}
540
541 \begin{describe}{fun}
542 {store-property @<pset> @<name> @<value> \&key :type :location
543 @> @<property>}
544 \end{describe}
545
546 \begin{describe}{fun}
547 {get-property @<pset> @<name> @<type> \&optional @<default>
548 @> @<value> @<floc-or-nil>}
549 \end{describe}
550
551 \begin{describe}{fun}
552 {add-property @<pset> @<name> @<value> \&key :type :location
553 @> @<property>}
554 \end{describe}
555
556 \begin{describe}{fun}{make-property-set \&rest @<plist> @> @<pset>}
557 \end{describe}
558
559 \begin{describe}{gf}{property-set @<thing> @> @<pset>}
560 \end{describe}
561
562 \begin{describe}{fun}{check-unused-properties @<pset>}
563 \end{describe}
564
565 \begin{describe}{mac}
566 {default-slot-from-property
567 (@<instance> @<slot> @[@<slot-names>@]) \\ \ind\ind
568 (@<pset> @<property> @<type> @[@<prop-var> @<convert-form>^*@]) \- \\
569 @<declaration>^* \\
570 @<default-form>^*}
571 \end{describe}
572
573 \begin{describe}{fun}
574 {parse-property @<scanner> @<pset>
575 @> @<result> @<success-flag> @<consumed-flag>}
576 \end{describe}
577
578 \begin{describe}{fun}
579 {parse-property-set @<scanner>
580 @> @<result> @<success-flag> @<consumed-flag>}
581 \end{describe}
582
583 %%%--------------------------------------------------------------------------
584 \section{Miscellaneous translator features} \label{sec:misc.pset}
585
586 \begin{describe}{var}{*sod-version*}
587 \end{describe}
588
589 \begin{describe}{var}{*debugout-pathname*}
590 \end{describe}
591
592 \begin{describe}{fun}
593 {test-module @<path> \&key :reason :clear :backtrace @> @<status>}
594 \end{describe}
595
596 \begin{describe}{fun}
597 {test-parse-c-type @<string>
598 @> t @<c-type> @<kernel> @<string> @! nil @<indicator>}
599 \end{describe}
600
601 \begin{describe}{fun}
602 {test-parse-pset @<string>
603 @> t @<pset> @! nil @<indicator>}
604 \end{describe}
605
606 \begin{describe}{mac}
607 {test-parser (@<scanner> \&key :backtrace) @<parser> @<input>
608 @> @<result> @<status> @<remainder>}
609 \end{describe}
610
611 \begin{describe}{fun}{exercise}
612 \end{describe}
613
614 \begin{describe}{fun}{sod-frontend:main}
615 \end{describe}
616
617 %%%----- That's all, folks --------------------------------------------------
618
619 %%% Local variables:
620 %%% mode: LaTeX
621 %%% TeX-master: "sod.tex"
622 %%% TeX-PDF-mode: t
623 %%% End: