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
}{fun
}
215 {designated-condition
216 \=@<default-type> @<datum> @<arguments> \\
217 \>\&key :allow-pointless-arguments
221 \begin{describe
}{mac
}
222 {default-slot (@<instance> @<slot> @
[@<slot-names>@
]) \\
\ind
226 \begin{describe
}{mac
}
227 {define-on-demand-slot @<class> @<slot> (@<instance>) \\
\ind
228 @
[[ @<declaration>^* @! @<doc-string> @
]] \\
232 %%%--------------------------------------------------------------------------
233 \section{Condition utilities
} \label{sec:misc.condition
}
235 These symbols are defined in the @|sod-parser| package.
237 \begin{describe
}{cls
}{enclosing-condition (condition) \&key :condition
}
241 {enclosed-condition @<enclosing-condition> @> @<condition>
}
244 \begin{describe
}{cls
}{information (condition) \&key
}
247 \begin{describe
}{cls
}
248 {simple-information (simple-condition information) \\
\ind
249 \&key :format-control :format-arguments
}
252 \begin{describe
}{fun
}{info @<datum> \&rest @<arguments> @> @<flag>
}
255 \begin{describe
}{rst
}{noted
}
258 \begin{describe
}{fun
}{cerror* @<datum> \&rest @<arguments>
}
261 %%%--------------------------------------------------------------------------
262 \section{Option parser
} \label{sec:misc.optparse
}
264 These symbols are defined in the @!optparse| package.
266 \begin{describe
}{fun
}{exit \&optional (@<code>
0) \&key :abrupt
}
269 \begin{describe
}{var
}{*program-name*
}
272 \begin{describe
}{var
}{*command-line*
}
275 \begin{describe
}{fun
}{set-command-line-arguments
}
278 \begin{describe
}{fun
}{moan @<format-string> \&rest @<format-args>
}
281 \begin{describe
}{fun
}{die @<format-string> \&rest @<format-args>
}
284 \begin{describe
}{var
}{*options*
}
287 \begin{describe
}{cls
}{option
}
290 \begin{describe
}{fun
}{optionp @<object> @> @<generalized-boolean>
}
293 \begin{describe
}{fun
}
294 {make-option \=@<long-name> @<short-name> \+\\
295 \&optional @<arg-name> \\
296 \&key :tag :negated-tag
297 :arg-optional-p :documentation \-
302 {\dhead{fun
}{opt-short-name @<option> @> @<character-or-null>
}
303 \dhead{fun
}{setf (opt-short-name @<option>) @<character-or-null>
}
304 \dhead{fun
}{opt-long-name @<option> @> @<string-or-null>
}
305 \dhead{fun
}{setf (opt-long-name @<option>) @<string-or-null>
}
306 \dhead{fun
}{opt-tag @<option> @> @<tag>
}
307 \dhead{fun
}{setf (opt-tag @<option>) @<tag>
}
308 \dhead{fun
}{opt-negated-tag @<option> @> @<tag>
}
309 \dhead{fun
}{setf (opt-negated-tag @<option>) @<tag>
}
310 \dhead{fun
}{opt-arg-name @<option> @> @<string-or-null>
}
311 \dhead{fun
}{setf (opt-arg-name @<option>) @<string-or-null>
}
312 \dhead{fun
}{opt-optional-p @<option> @> @<generalized-boolean>
}
313 \dhead{fun
}{setf (opt-optional-p @<option>) @<generalized-boolean>
}
314 \dhead{fun
}{opt-documentation @<option> @> @<string-or-null>
}
315 \dhead{fun
}{setf (opt-documentation @<option>) @<string-or-null>
}}
318 \begin{describe
}{cls
}{option-parser
}
321 \begin{describe
}{fun
}{option-parser-p @<object> @> @<generalized-boolean>
}
324 \begin{describe
}{fun
}
325 {make-option-parser \&key \=:args :options :non-option :numericp \+ \\
326 :negated-numeric-p long-only-p \-
327 \nlret @<option-parser>
}
331 {\dhead{fun
}{op-options @<option-parser> @> @<list>
}
332 \dhead{fun
}{setf (op-options @<option-parser>) @<list>
}
333 \dhead{fun
}{op-non-option @<option-parser> @> @<action>
}
334 \dhead{fun
}{setf (op-non-option @<option-parser>) @<action>
}
335 \dhead{fun
}{op-long-only-p @<option-parser> @> @<generalized-boolean>
}
336 \dhead{fun
}{setf (op-long-only-p @<option-parser>) @<generalized-boolean>
}
337 \dhead{fun
}{op-numeric-p @<option-parser> @> @<generalized-boolean>
}
338 \dhead{fun
}{setf (op-numeric-p @<option-parser>) @<generalized-boolean>
}
339 \dhead{fun
}{op-negated-numeric-p @<option-parser> @<generalized-boolean>
}
340 \dhead{fun
}{setf (op-negated-numeric-p @<option-parser>) @<generalized-boolean>
}
341 \dhead{fun
}{op-negated-p @<option-parser> @> @<generalized-boolean>
}
342 \dhead{fun
}{setf (op-negated-p @<option-parser>) @<generalized-boolean>
}}
345 \begin{describe
}{cls
}
346 {option-parse-error (error simple-condition)
347 \&key :format-control :format-arguments
}
350 \begin{describe
}{fun
}{option-parse-remainder @<option-parser>
}
353 \begin{describe
}{fun
}{option-parse-return @<tag> \&optional @<argument>
}
356 \begin{describe
}{fun
}{option-parse-next @<option-parser>
}
359 \begin{describe
}{mac
}{option-parse-try @<form>^*
}
362 \begin{describe
}{mac
}{with-unix-error-reporting () @<form>^*
}
365 \begin{describe
}{mac
}
366 {defopthandler @<name> (@<var> @
[@<arg>@
]) @<lambda-list> \\
\ind
367 @
[[ @<declaration>^* @! @<doc-string> @
]] \\
371 \begin{describe
}{fun
}
372 {invoke-option-handler @<handler> @<locative> @<arg> @<arguments>
}
375 \begin{describe
}{opt
}{set \&optional @<value>
}
378 \begin{describe
}{opt
}{clear \&optional @<value>
}
381 \begin{describe
}{opt
}{inc \&optional @<maximum> @<step>
}
384 \begin{describe
}{opt
}{dec \&optional <minimum> <step>
}
387 \begin{describe
}{opt
}{read
}
390 \begin{describe
}{opt
}{int \&key :radix :min :max
}
393 \begin{describe
}{opt
}{string
}
396 \begin{describe
}{opt
}{keyword \&optional @<valid>
}
399 \begin{describe
}{opt
}{list \&optional @<handler> \&rest @<handler-args>
}
402 \begin{describe
}{mac
}
403 {defoptmacro @<name> @<lambda-list> \\
\ind
404 @
[[ @<declaration>^* @! @<doc-string> @
]] \\
408 \begin{describe
}{fun
}{parse-option-form @<form>
}
411 \begin{describe
}{mac
}
412 {options @
{ \=@<string> @! \+ \\
413 @<option-macro> @! (@<option-macro> @<macro-arg>^*) @! \\
414 (@
[[ \=@<character> @! (:short-name @<character>) @! \+ \\
415 @<string>^* @! @<symbol> @! @<rational> @!
416 (:long-name @<string>) @! \\
417 (@<string> @<format-arg>^+) @!
418 (:doc @<string> @<format-arg>^*) @! \\
419 (:arg @<arg-name>) @! (:opt-arg @<arg-name>) @! \\
420 @<keyword> @! (:tag @<tag>) @!
421 (:negated-tag @<tag>) @! \\
422 @
{ (@<handler> @<var> @<handler-arg>^*) @
}^*
426 \begin{describe
}{fun
}
427 {simple-usage @<option-list> \&optional @<mandatory-args> @> @<list>
}
430 \begin{describe
}{fun
}{show-usage @<prog> @<usage> \&optional @<stream>
}
433 \begin{describe
}{fun
}
434 {show-help @<prog> @<usage> @<option-list> \&optional @<stream>
}
437 \begin{describe
}{fun
}{sanity-check-option-list @<option-list>
}
442 \dhead{var
}{*version*
}
443 \dhead{var
}{*usage*
}}
446 \begin{describe
}{fun
}{do-usage \&optional @<stream>
}
449 \begin{describe
}{fun
}{die-usage
}
452 \begin{describe
}{optmac
}
453 {help-options \&key :short-help :short-version :short-usage
}
456 \begin{describe
}{fun
}
457 {define-program \&key \=:program-name \+ \\
458 :help :version :usage :full-usage \\
462 \begin{describe
}{mac
}
463 {do-options (@
[[ :parser @<option-parser> @
]]) \\
\ind
464 @
{ (@
{ @<case> @! (@<case>^*)@
} (@
[@
[@<opt-var>@
] @<arg-var>@
])
468 %%%--------------------------------------------------------------------------
469 \section{Property sets
} \label{sec:misc.pset
}
471 \begin{describe
}{fun
}{property-key @<name> @> @<keyword>
}
474 \begin{describe
}{gf
}{decode-property @<raw-value> @> @<type> @<value>
}
477 \begin{describe
}{cls
}{property
}
480 \begin{describe
}{fun
}{propertyp @<object> @> @<generalized-boolean>
}
483 \begin{describe
}{fun
}
484 {make-property @<name> @<raw-value> \&key :type :location :seenp
}
488 {\dhead{fun
}{p-name @<property> @> @<name>
}
489 \dhead{fun
}{p-value @<property> @> @<value>
}
490 \dhead{fun
}{p-type @<property> @> @<type>
}
491 \dhead{fun
}{p-key @<property> @> @<symbol>
}
492 \dhead{fun
}{p-seenp @<property> @> @<boolean>
}
493 \dhead{fun
}{setf (p-seenp @<property>) @<boolean>
}}
496 \begin{describe
}{gf
}{decode-property @<raw-value> @> @<type> @<value>
}
500 {coerce-property-value @<value> @<type> @<wanted> @> @<coerced-value>
}
503 \begin{describe
}{cls
}{pset
}
506 \begin{describe
}{fun
}{psetp @<object> @> @<generalized-boolean>
}
509 \begin{describe
}{fun
}{make-pset @> @<pset>
}
512 \begin{describe
}{fun
}{pset-get @<pset> @<key> @> @<property-or-nil>
}
515 \begin{describe
}{fun
}{pset-store @<pset> @<property> @> @<property>
}
518 \begin{describe
}{fun
}{pset-map @<func> @<pset>
}
521 \begin{describe
}{mac
}
522 {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*
}
525 \begin{describe
}{fun
}
526 {store-property @<pset> @<name> @<value> \&key :type :location
530 \begin{describe
}{fun
}
531 {get-property @<pset> @<name> @<type> \&optional @<default>
532 @> @<value> @<floc-or-nil>
}
535 \begin{describe
}{fun
}
536 {add-property @<pset> @<name> @<value> \&key :type :location
540 \begin{describe
}{fun
}{make-property-set \&rest @<plist> @> @<pset>
}
543 \begin{describe
}{gf
}{property-set @<thing> @> @<pset>
}
546 \begin{describe
}{fun
}{check-unused-properties @<pset>
}
549 \begin{describe
}{mac
}
550 {default-slot-from-property
551 (@<instance> @<slot> @
[@<slot-names>@
]) \\
\ind\ind
552 (@<pset> @<property> @<type> @
[@<prop-var> @<convert-form>^*@
]) \- \\
557 \begin{describe
}{fun
}
558 {parse-property @<scanner> @<pset>
559 @> @<result> @<success-flag> @<consumed-flag>
}
562 \begin{describe
}{fun
}
563 {parse-property-set @<scanner>
564 @> @<result> @<success-flag> @<consumed-flag>
}
567 %%%--------------------------------------------------------------------------
568 \section{Miscellaneous translator features
} \label{sec:misc.pset
}
570 \begin{describe
}{var
}{*sod-version*
}
573 \begin{describe
}{var
}{*debugout-pathname*
}
576 \begin{describe
}{fun
}
577 {test-module @<path> \&key :reason :clear :backtrace @> @<status>
}
580 \begin{describe
}{fun
}
581 {test-parse-c-type @<string>
582 @> t @<c-type> @<kernel> @<string> @! nil @<indicator>
}
585 \begin{describe
}{mac
}
586 {test-parser (@<scanner> \&key :backtrace) @<parser> @<input>
587 @> @<result> @<status> @<remainder>
}
590 \begin{describe
}{fun
}{exercise
}
593 \begin{describe
}{fun
}{sod-frontend:main
}
596 %%%----- That's all, folks --------------------------------------------------
600 %%% TeX-master: "sod.tex"