3 %%% Miscellaneous functionality
5 %%% (c) 2015 Straylight/Edgeware
8 %%%----- Licensing notice ---------------------------------------------------
10 %%% This file is part of the Sensible Object Design, an object system for C.
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.
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.
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.
26 \chapter{Miscellaneous functionality} \label{ch:misc}
28 %%%--------------------------------------------------------------------------
29 \section{Utilities} \label{sec:misc.utilities}
31 These symbols are defined in the @|sod-utilities| package.
34 {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
40 {once-only (@[[ :environment @<env> @]]
41 @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
47 {parse-body @<body> \&key :docp :declp
48 @> @<doc-string> @<declarations> @<body-forms>}
51 \begin{describe}{cls}{loc}
54 \begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
57 \begin{describe}{mac}{locf @<place> @> @<locative>}
61 {\dhead{fun}{ref @<locative> @> @<value>}
62 \dhead{fun}{setf (ref @<locative>) @<value>}}
67 @{ @<var> @! (@{ @<var> @!
68 (@<var> @[@<locative>@]) @}^*) @} \\ \ind
73 \begin{describe}{sym}{it}
76 \begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
79 \begin{describe}{mac}{aand @<form>^*}
82 \begin{describe}{mac}{awhen @<condition> @<form>^*}
85 \begin{describe}{mac}{acond @{ (@<condition> @<form>^*) @}^*}
90 {acase @<scrutinee> @{ (@{ @<case> @! (@<case>^*) @} @<form>^*) @}^*}
92 {aecase @<scrutinee> @{ (@{ @<case> @! (@<case>^*) @} @<form>^*) @}^*}
93 \dhead{mac}{atypecase @<scrutinee> @{ (@<type> @<form>^*) @}^*}
94 \dhead{mac}{aetypecase @<scrutinee> @{ (@<type> @<form>^*) @}^*}}
97 \begin{describe}{mac}{asetf @{ @<place> @<value> @}^*}
100 \begin{describe}{gf}{instance-initargs @<instance>}
104 {\dhead{fun}{copy-instance @<instance> \&rest @<initargs>}
105 \dhead{gf}{copy-instance-using-class @<class> @<instance>
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>}}
116 \begin{describe}{fun}{make-list-builder \&optional @<initial> @> @<builder>}
119 \begin{describe}{fun}{lbuild-add @<builder> @<item> @> @<builder>}
122 \begin{describe}{fun}{lbuild-add-list @<builder> @<list> @> @<builder>}
125 \begin{describe}{fun}{lbuild-list @<builder> @> @<list>}
128 \begin{describe}{fun}
129 {mappend @<function> @<list> \&rest @<more-lists> @> @<result-list>}
132 \begin{describe}{fun}
133 {distinguished-point-shortest-paths @<root> @<neighbours-func>
137 \begin{describe}{cls}{inconsistent-merge-error (error) \&key :candidates}
140 \begin{describe}{gf}{merge-error-candidates @<error> @> @<list>}
143 \begin{describe}{fun}
144 {merge-lists @<lists> \&key :pick (:test \#'eql) :present @> @<list>}
147 \begin{describe}{mac}
148 {categorize (\=@<item-var> @<items>
149 @[[ :bind (@{ @<var> @!
150 (@<var> @[@<value>@]) @}^*) @]])
152 (@{ (@<cat-var> @<cat-predicate>) @}^*) \-\\
158 \begin{describe}{fun}{partial-order-minima @<items> @<order> @> @<list>}
161 \begin{describe}{fun}
162 {frob-identifier @<string> \&key :swap-case :swap-hyphen
163 @> @<frobbed-string>}
166 \begin{describe}{fun}{whitespace-char-p @<character> @> @<generic-function>}
169 \begin{describe}{fun}
170 {update-position @<character> @<line> @<column>
171 @> @<new-line> @<new-column>}
174 \begin{describe}{fun}
175 {backtrack-position @<character> @<line> @<column>
176 @> @<old-line> @<old-column>}
179 \begin{describe}{fun}
180 {compose @<function> \&rest @<more-functions> @> @<function>}
183 \begin{describe}{mac}{defvar @<name> @<documentation> @> @<name>}
186 \begin{describe}{fun}{symbolicate \&rest @<symbols> @> @<symbol>}
189 \begin{describe}{mac}
190 {maybe-print-unreadable-object
193 :identity @<identity> @]]) \\ \ind
198 \begin{describe}{fun}{print-ugly-stuff @<stream> @<func> @> @<value>^*}
201 \begin{describe}{mac}
202 {dosequence (@<var> @<sequence>
203 @[[ :start @<start> @! :end @<end> @!
204 :indexvar @<var> @]]) \\ \ind
206 @{ @<tag> @! @<statement> @}^*}
209 \begin{describe}{mac}
210 {define-access-wrapper @<from> @<to>
211 @[[ :read-only @<read-only-flag> @]]}
214 \begin{describe}{cls}
215 {simple-control-error (control-error simple-error)
216 \&key :format-control :format-arguments}
219 \begin{describe}{fun}
220 {designated-condition
221 \=@<default-type> @<datum> @<arguments> \\
222 \>\&key :allow-pointless-arguments
226 \begin{describe}{fun}
227 {invoke-associated-restart @<restart> @<condition> \&rest @<arguments>}
230 \begin{describe}{mac}
231 {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
235 \begin{describe}{mac}
236 {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
237 @[[ @<declaration>^* @! @<doc-string> @]] \\
241 %%%--------------------------------------------------------------------------
242 \section{Condition utilities} \label{sec:misc.condition}
244 These symbols are defined in the @|sod-parser| package.
246 \begin{describe}{cls}{enclosing-condition (condition) \&key :condition}
250 {enclosed-condition @<enclosing-condition> @> @<condition>}
253 \begin{describe}{cls}{information (condition) \&key}
256 \begin{describe}{cls}
257 {simple-information (simple-condition information) \\ \ind
258 \&key :format-control :format-arguments}
261 \begin{describe}{fun}{info @<datum> \&rest @<arguments> @> @<flag>}
266 \dhead{fun}{noted \&optional @<condition>}}
269 \begin{describe}{fun}{cerror* @<datum> \&rest @<arguments>}
272 %%%--------------------------------------------------------------------------
273 \section{Option parser} \label{sec:misc.optparse}
275 These symbols are defined in the @|optparse| package.
277 \begin{describe}{fun}{exit \&optional (@<code> 0) \&key :abrupt}
280 \begin{describe}{var}{*program-name*}
283 \begin{describe}{var}{*command-line*}
286 \begin{describe}{fun}{set-command-line-arguments}
289 \begin{describe}{fun}{moan @<format-string> \&rest @<format-args>}
292 \begin{describe}{fun}{die @<format-string> \&rest @<format-args>}
295 \begin{describe}{var}{*options*}
298 \begin{describe}{cls}{option}
301 \begin{describe}{fun}{optionp @<object> @> @<generalized-boolean>}
304 \begin{describe}{fun}
305 {make-option \=@<long-name> @<short-name> \+\\
306 \&optional @<arg-name> \\
307 \&key :tag :negated-tag
308 :arg-optional-p :documentation \-
313 {\dhead{fun}{opt-short-name @<option> @> @<character-or-null>}
314 \dhead{fun}{setf (opt-short-name @<option>) @<character-or-null>}
315 \dhead{fun}{opt-long-name @<option> @> @<string-or-null>}
316 \dhead{fun}{setf (opt-long-name @<option>) @<string-or-null>}
317 \dhead{fun}{opt-tag @<option> @> @<tag>}
318 \dhead{fun}{setf (opt-tag @<option>) @<tag>}
319 \dhead{fun}{opt-negated-tag @<option> @> @<tag>}
320 \dhead{fun}{setf (opt-negated-tag @<option>) @<tag>}
321 \dhead{fun}{opt-arg-name @<option> @> @<string-or-null>}
322 \dhead{fun}{setf (opt-arg-name @<option>) @<string-or-null>}
323 \dhead{fun}{opt-optional-p @<option> @> @<generalized-boolean>}
324 \dhead{fun}{setf (opt-optional-p @<option>) @<generalized-boolean>}
325 \dhead{fun}{opt-documentation @<option> @> @<string-or-null>}
326 \dhead{fun}{setf (opt-documentation @<option>) @<string-or-null>}}
329 \begin{describe}{cls}{option-parser}
332 \begin{describe}{fun}{option-parser-p @<object> @> @<generalized-boolean>}
335 \begin{describe}{fun}
336 {make-option-parser \&key \=:args :options :non-option :numericp \+ \\
337 :negated-numeric-p long-only-p \-
338 \nlret @<option-parser>}
342 {\dhead{fun}{op-options @<option-parser> @> @<list>}
343 \dhead{fun}{setf (op-options @<option-parser>) @<list>}
344 \dhead{fun}{op-non-option @<option-parser> @> @<action>}
345 \dhead{fun}{setf (op-non-option @<option-parser>) @<action>}
346 \dhead{fun}{op-long-only-p @<option-parser> @> @<generalized-boolean>}
347 \dhead{fun}{setf (op-long-only-p @<option-parser>) @<generalized-boolean>}
348 \dhead{fun}{op-numeric-p @<option-parser> @> @<generalized-boolean>}
349 \dhead{fun}{setf (op-numeric-p @<option-parser>) @<generalized-boolean>}
350 \dhead{fun}{op-negated-numeric-p @<option-parser> @<generalized-boolean>}
351 \dhead{fun}{setf (op-negated-numeric-p @<option-parser>) @<generalized-boolean>}
352 \dhead{fun}{op-negated-p @<option-parser> @> @<generalized-boolean>}
353 \dhead{fun}{setf (op-negated-p @<option-parser>) @<generalized-boolean>}}
356 \begin{describe}{cls}
357 {option-parse-error (error simple-condition)
358 \&key :format-control :format-arguments}
361 \begin{describe}{fun}{option-parse-remainder @<option-parser>}
364 \begin{describe}{fun}{option-parse-return @<tag> \&optional @<argument>}
367 \begin{describe}{fun}{option-parse-next @<option-parser>}
370 \begin{describe}{mac}{option-parse-try @<form>^*}
373 \begin{describe}{mac}{with-unix-error-reporting () @<form>^*}
376 \begin{describe}{mac}
377 {defopthandler @<name> (@<var> @[@<arg>@]) @<lambda-list> \\ \ind
378 @[[ @<declaration>^* @! @<doc-string> @]] \\
382 \begin{describe}{fun}
383 {invoke-option-handler @<handler> @<locative> @<arg> @<arguments>}
386 \begin{describe}{opt}{set \&optional @<value>}
389 \begin{describe}{opt}{clear \&optional @<value>}
392 \begin{describe}{opt}{inc \&optional @<maximum> @<step>}
395 \begin{describe}{opt}{dec \&optional <minimum> <step>}
398 \begin{describe}{opt}{read}
401 \begin{describe}{opt}{int \&key :radix :min :max}
404 \begin{describe}{opt}{string}
407 \begin{describe}{opt}{keyword \&optional @<valid>}
410 \begin{describe}{opt}{list \&optional @<handler> \&rest @<handler-args>}
413 \begin{describe}{mac}
414 {defoptmacro @<name> @<lambda-list> \\ \ind
415 @[[ @<declaration>^* @! @<doc-string> @]] \\
419 \begin{describe}{fun}{parse-option-form @<form>}
422 \begin{describe}{mac}
423 {options @{ \=@<string> @! \+ \\
424 @<option-macro> @! (@<option-macro> @<macro-arg>^*) @! \\
425 (@[[ \=@<character> @! (:short-name @<character>) @! \+ \\
426 @<string>^* @! @<symbol> @! @<rational> @!
427 (:long-name @<string>) @! \\
428 (@<string> @<format-arg>^+) @!
429 (:doc @<string> @<format-arg>^*) @! \\
430 (:arg @<arg-name>) @! (:opt-arg @<arg-name>) @! \\
431 @<keyword> @! (:tag @<tag>) @!
432 (:negated-tag @<tag>) @! \\
433 @{ (@<handler> @<var> @<handler-arg>^*) @}^*
437 \begin{describe}{fun}
438 {simple-usage @<option-list> \&optional @<mandatory-args> @> @<list>}
441 \begin{describe}{fun}{show-usage @<prog> @<usage> \&optional @<stream>}
444 \begin{describe}{fun}
445 {show-help @<prog> @<usage> @<option-list> \&optional @<stream>}
448 \begin{describe}{fun}{sanity-check-option-list @<option-list>}
453 \dhead{var}{*version*}
454 \dhead{var}{*usage*}}
457 \begin{describe}{fun}{do-usage \&optional @<stream>}
460 \begin{describe}{fun}{die-usage}
463 \begin{describe}{optmac}
464 {help-options \&key :short-help :short-version :short-usage}
467 \begin{describe}{fun}
468 {define-program \&key \=:program-name \+ \\
469 :help :version :usage :full-usage \\
473 \begin{describe}{mac}
474 {do-options (@[[ :parser @<option-parser> @]]) \\ \ind
475 @{ (@{ @<case> @! (@<case>^*)@} (@[@[@<opt-var>@] @<arg-var>@])
479 %%%--------------------------------------------------------------------------
480 \section{Property sets} \label{sec:misc.pset}
482 \begin{describe}{fun}{property-key @<name> @> @<keyword>}
485 \begin{describe}{gf}{decode-property @<raw-value> @> @<type> @<value>}
488 \begin{describe}{cls}{property}
491 \begin{describe}{fun}{propertyp @<object> @> @<generalized-boolean>}
494 \begin{describe}{fun}
495 {make-property @<name> @<raw-value> \&key :type :location :seenp}
499 {\dhead{fun}{p-name @<property> @> @<name>}
500 \dhead{fun}{p-value @<property> @> @<value>}
501 \dhead{fun}{p-type @<property> @> @<type>}
502 \dhead{fun}{p-key @<property> @> @<symbol>}
503 \dhead{fun}{p-seenp @<property> @> @<boolean>}
504 \dhead{fun}{setf (p-seenp @<property>) @<boolean>}}
507 \begin{describe}{gf}{decode-property @<raw-value> @> @<type> @<value>}
511 {coerce-property-value @<value> @<type> @<wanted> @> @<coerced-value>}
514 \begin{describe}{cls}{pset}
517 \begin{describe}{fun}{psetp @<object> @> @<generalized-boolean>}
520 \begin{describe}{fun}{make-pset @> @<pset>}
523 \begin{describe}{fun}{pset-get @<pset> @<key> @> @<property-or-nil>}
526 \begin{describe}{fun}{pset-store @<pset> @<property> @> @<property>}
529 \begin{describe}{fun}{pset-map @<func> @<pset>}
532 \begin{describe}{mac}
533 {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*}
536 \begin{describe}{fun}
537 {store-property @<pset> @<name> @<value> \&key :type :location
541 \begin{describe}{fun}
542 {get-property @<pset> @<name> @<type> \&optional @<default>
543 @> @<value> @<floc-or-nil>}
546 \begin{describe}{fun}
547 {add-property @<pset> @<name> @<value> \&key :type :location
551 \begin{describe}{fun}{make-property-set \&rest @<plist> @> @<pset>}
554 \begin{describe}{gf}{property-set @<thing> @> @<pset>}
557 \begin{describe}{fun}{check-unused-properties @<pset>}
560 \begin{describe}{mac}
561 {default-slot-from-property
562 (@<instance> @<slot> @[@<slot-names>@]) \\ \ind\ind
563 (@<pset> @<property> @<type> @[@<prop-var> @<convert-form>^*@]) \- \\
568 \begin{describe}{fun}
569 {parse-property @<scanner> @<pset>
570 @> @<result> @<success-flag> @<consumed-flag>}
573 \begin{describe}{fun}
574 {parse-property-set @<scanner>
575 @> @<result> @<success-flag> @<consumed-flag>}
578 %%%--------------------------------------------------------------------------
579 \section{Miscellaneous translator features} \label{sec:misc.pset}
581 \begin{describe}{var}{*sod-version*}
584 \begin{describe}{var}{*debugout-pathname*}
587 \begin{describe}{fun}
588 {test-module @<path> \&key :reason :clear :backtrace @> @<status>}
591 \begin{describe}{fun}
592 {test-parse-c-type @<string>
593 @> t @<c-type> @<kernel> @<string> @! nil @<indicator>}
596 \begin{describe}{fun}
597 {test-parse-pset @<string>
598 @> t @<pset> @! nil @<indicator>}
601 \begin{describe}{mac}
602 {test-parser (@<scanner> \&key :backtrace) @<parser> @<input>
603 @> @<result> @<status> @<remainder>}
606 \begin{describe}{fun}{exercise}
609 \begin{describe}{fun}{sod-frontend:main}
612 %%%----- That's all, folks --------------------------------------------------
616 %%% TeX-master: "sod.tex"