%%%----- Licensing notice ---------------------------------------------------
%%%
-%%% This file is part of the Sensble Object Design, an object system for C.
+%%% This file is part of the Sensible Object Design, an object system for C.
%%%
%%% SOD is free software; you can redistribute it and/or modify
%%% it under the terms of the GNU General Public License as published by
These symbols are defined in the @|sod-utilities| package.
+
+\subsection{Macro utilities}
+
\begin{describe}{mac}
- {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
- @<body-form>^*}
+ {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{describe}{mac}
{once-only (@[[ :environment @<env> @]]
- @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
- @<body-form>^*}
+ @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{describe}{mac}
- {parse-body @<body> @> @<doc-string> @<declarations> @<body-forms>}
+ {parse-body @<body> \&key :docp :declp
+ @> @<doc-string> @<declarations> @<body-forms>}
+\end{describe}
+
+\begin{describe}{cls}{loc}
+\end{describe}
+
+\begin{describe}{fun}{symbolicate \&rest @<symbols> @> @<symbol>}
+\end{describe}
+
+
+\subsection{Locatives}
+
+\begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
+\end{describe}
+
+\begin{describe}{mac}{locf @<place> @> @<locative>}
+\end{describe}
+
+\begin{describe*}
+ {\dhead{fun}{ref @<locative> @> @<value>}
+ \dhead{fun}{setf (ref @<locative>) @<value>}}
+\end{describe*}
+
+\begin{describe}{mac}
+ {with-locatives
+ @{ @<var> @! (@{ @<var> @!
+ (@<var> @[@<locative>@]) @}^*) @} \\ \ind
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
+
+\subsection{Anaphorics}
+
\begin{describe}{sym}{it}
\end{describe}
\begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
\end{describe}
-\begin{describe}{mac}{awhen @<condition> @<body-form>^*}
+\begin{describe}{mac}{aand @<form>^*}
+\end{describe}
+
+\begin{describe}{mac}{awhen @<condition> @<form>^*}
\end{describe}
\begin{describe}{mac}{acond @{ (@<condition> @<form>^*) @}^*}
\begin{describe}{mac}{asetf @{ @<place> @<value> @}^*}
\end{describe}
+
+\subsection{Metaobject protocol utilities}
+
\begin{describe}{gf}{instance-initargs @<instance>}
\end{describe}
\dhead{gf}{eql-specializer-object @<specializer> @> @<value>}}
\end{describe*}
+
+\subsection{Other CLOS utilities}
+
+\begin{describe}{mac}
+ {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
+ @<form>^*}
+\end{describe}
+
+\begin{describe}{mac}
+ {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*}
+\end{describe}
+
+
+\subsection{Building lists}
+
\begin{describe}{fun}{make-list-builder \&optional @<initial> @> @<builder>}
\end{describe}
\begin{describe}{fun}{lbuild-list @<builder> @> @<list>}
\end{describe}
-\begin{describe}{fun}
- {mappend @<function> @<list> \&rest @<more-lists> @> @<result-list>}
-\end{describe}
-\begin{describe}{cls}{inconsistent-merge-error (error) \&key :candidates}
+\subsection{Merging lists}
+
+\begin{describe}{cls}
+ {inconsistent-merge-error (error) \&key :candidates :present}
\end{describe}
\begin{describe}{gf}{merge-error-candidates @<error> @> @<list>}
\end{describe}
+\begin{describe}{gf}{merge-error-present-function @<error> @> @<function>}
+\end{describe}
+
\begin{describe}{fun}
- {merge-lists @<lists> \&key :pick (:test \#'eql) @> @<list>}
+ {merge-lists @<lists> \&key :pick (:test \#'eql) :present @> @<list>}
+\end{describe}
+
+
+\subsection{Other list utilities}
+
+\begin{describe}{fun}
+ {mappend @<function> @<list> \&rest @<more-lists> @> @<result-list>}
+\end{describe}
+
+\begin{describe}{fun}
+ {distinguished-point-shortest-paths @<root> @<neighbours-func>
+ @> @<list>}
\end{describe}
\begin{describe}{mac}
{categorize (\=@<item-var> @<items>
- @[[ :bind (@{ @<var> @! (@<var> @[@<value>@]) @}^*) @]])
- \\ \ind\ind
- (@{ @<cat-var> @<cat-predicate> @}^*) \- \\
- @<body-form>^* \-
- \nlret @<value>^*}
+ @[[ :bind (@{ @<var> @!
+ (@<var> @[@<value>@]) @}^*) @]])
+ \\ \ind\ind
+ (@{ (@<cat-var> @<cat-predicate>) @}^*) \-\\
+ @<declaration>^* \\
+ @<form>^*
+ \-\nlret @<value>^*}
+\end{describe}
+
+\begin{describe}{fun}{partial-order-minima @<items> @<order> @> @<list>}
\end{describe}
\begin{describe}{fun}
- {frob-identifier @<string> \&key :swap-case :swap-hyphen
- @> @<frobbed-string>}
+ {find-duplicates @<report> @<sequence> \&key :identity :test}
\end{describe}
-\begin{describe}{fun}{whitespace-char-p @<character> @> @<generic-function>}
+
+\subsection{Position tracking}
+
+\begin{describe}{fun}
+ {whitespace-char-p @<character> @> @<generalized-boolean>}
\end{describe}
\begin{describe}{fun}
@> @<old-line> @<old-column>}
\end{describe}
-\begin{describe}{fun}
- {compose @<function> \&rest @<more-functions> @> @<function>}
-\end{describe}
-\begin{describe}{fun}{symbolicate \&rest @<symbols> @> @<symbol>}
-\end{describe}
+\subsection{Object printing}
\begin{describe}{mac}
- {maybe-print-unreadable-object (@<object> @<stream>
- @[[ :type @<type> @!
- :identity @<identity> @]]) \\ \ind
- @<body-form>^*}
+ {maybe-print-unreadable-object
+ (@<object> @<stream>
+ @[[ :type @<type> @!
+ :identity @<identity> @]]) \\ \ind
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
-\begin{describe}{mac}
- {dosequence (@<var> @<sequence>
- @[[ :start @<start> @! :end @<end> @!
- :indexvar @<var> @]]) \\ \ind
- @{ @<tag> @! @<body-form> @}^*}
+\begin{describe}{fun}{print-ugly-stuff @<stream> @<func> @> @<value>^*}
\end{describe}
-\begin{describe}{mac}
- {define-access-wrapper @<from> @<to>
- @[[ :read-only @<read-only-flag> @]]}
+
+\subsection{Condition utilities}
+
+\begin{describe}{cls}
+ {simple-control-error (control-error simple-error)
+ \&key :format-control :format-arguments}
\end{describe}
-\begin{describe}{mac}
- {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
- @<body-form>^*}
+\begin{describe}{fun}
+ {designated-condition
+ \=@<default-type> @<datum> @<arguments> \\
+ \>\&key :allow-pointless-arguments
+ \nlret @<condition>}
\end{describe}
-\begin{describe}{mac}
- {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
- @<body-form>^*}
+\begin{describe}{fun}
+ {invoke-associated-restart @<restart> @<condition> \&rest @<arguments>}
\end{describe}
-%%%--------------------------------------------------------------------------
-\section{Condition utilities} \label{sec:misc.condition}
+\begin{describe*}
+ {\dhead{cls}{enclosing-condition (condition) \&key :condition}
+ \dhead{gf}{enclosed-condition @<enclosing-condition> @> @<condition>}}
+\end{describe*}
-These symbols are defined in the @|sod-parser| package.
+\begin{describe}{cls}{information (condition) \&key}
+\end{describe}
-\begin{describe}{cls}{enclosing-condition (condition) \&key :condition}
+\begin{describe}{cls}
+ {simple-information (simple-condition information) \\ \ind
+ \&key :format-control :format-arguments}
\end{describe}
-\begin{describe}{gf}
- {enclosed-condition @<enclosing-condition> @> @<condition>}
+\begin{describe*}
+ {\dhead{fun}{info @<datum> \&rest @<arguments> @> @<flag>}
+ \dhead{rst}{noted}
+ \dhead{fun}{noted \&optional @<condition>}}
+\end{describe*}
+
+\begin{describe}{fun}
+ {promiscuous-cerror @<continue-string> @<datum> \&rest @<arguments>}
\end{describe}
\begin{describe}{fun}{cerror* @<datum> \&rest @<arguments>}
\end{describe}
-%%%--------------------------------------------------------------------------
-\section{Option parser} \label{sec:misc.optparse}
-These symbols are defined in the @!optparse| package.
+\subsection{Very miscellaneous utilities}
-\begin{describe}{fun}{exit \&optional (@<code> 0) \&key :abrupt}
+\begin{describe}{fun}
+ {frob-identifier @<string> \&key :swap-case :swap-hyphen
+ @> @<frobbed-string>}
\end{describe}
-\begin{describe}{var}{*program-name*}
+\begin{describe}{fun}
+ {compose @<function> \&rest @<more-functions> @> @<function>}
\end{describe}
-\begin{describe}{var}{*command-line*}
+\begin{describe}{mac}{defvar-unbound @<name> @<documentation> @> @<name>}
\end{describe}
-\begin{describe}{fun}{set-command-line-arguments}
+\begin{describe}{mac}
+ {dosequence (@<var> @<sequence>
+ @[[ :start @<start> @! :end @<end> @!
+ :indexvar @<var> @]]) \\ \ind
+ @<declaration>^* \\
+ @{ @<tag> @! @<statement> @}^*}
\end{describe}
-\begin{describe}{cls}{loc}
+\begin{describe}{mac}
+ {define-access-wrapper @<from> @<to>
+ @[[ :read-only @<read-only-flag> @]]}
\end{describe}
-\begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
+%%%--------------------------------------------------------------------------
+\section{Option parser} \label{sec:misc.optparse}
+
+These symbols are defined in the @|optparse| package.
+
+\begin{describe}{fun}{exit \&optional (@<code> 0) \&key :abrupt}
\end{describe}
-\begin{describe}{macro}{locf @<place> @> @<locative>}
+\begin{describe}{var}{*program-name*}
\end{describe}
-\begin{describe*}
- {\dhead{fun}{ref @<locative> @> @<value>}
- \dhead{fun}{setf (ref @<locative>) @<value>}}
-\end{describe*}
+\begin{describe}{var}{*command-line*}
+\end{describe}
-\begin{describe}{mac}
- {with-locatives
- @{ @<var> @! (@{ @<var> @!
- (@<var> @[@<locative>@]) @}^*) @} \\ \ind
- @<body-form>^*}
+\begin{describe}{fun}{set-command-line-arguments}
\end{describe}
\begin{describe}{fun}{moan @<format-string> \&rest @<format-args>}
\end{describe}
\begin{describe}{fun}
- {make-option \=@<long-name> @<short-name> \+ \\
- \&optional @<arg-name> \\
- \&key :tag :negated-tag :arg-optional-p :documentation \-
+ {make-option \=@<long-name> @<short-name> \+\\
+ \&optional @<arg-name> \\
+ \&key :tag :negated-tag
+ :arg-optional-p :documentation \-
\nlret @<option>}
\end{describe}
\begin{describe}{fun}{option-parse-next @<option-parser>}
\end{describe}
-\begin{describe}{mac}{option-parse-try @<body-form>^*}
+\begin{describe}{mac}{option-parse-try @<form>^*}
\end{describe}
-\begin{describe}{mac}{with-unix-error-reporting () @<body-form>^*}
+\begin{describe}{mac}{with-unix-error-reporting () @<form>^*}
\end{describe}
\begin{describe}{mac}
{defopthandler @<name> (@<var> @[@<arg>@]) @<lambda-list> \\ \ind
- @<body-form>^*}
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*}
\end{describe}
\begin{describe}{fun}
\begin{describe}{opt}{list \&optional @<handler> \&rest @<handler-args>}
\end{describe}
-\begin{describe}{mac}{defoptmacro @<name> @<lambda-list> @<body-form>^*}
+\begin{describe}{mac}
+ {defoptmacro @<name> @<lambda-list> \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*}
\end{describe}
\begin{describe}{fun}{parse-option-form @<form>}
(:long-name @<string>) @! \\
(@<string> @<format-arg>^+) @!
(:doc @<string> @<format-arg>^*) @! \\
- (:opt-arg @<arg-name>) @! \\
+ (:
arg @<arg-name>) @! (:opt-arg @<arg-name>) @! \\
@<keyword> @! (:tag @<tag>) @!
(:negated-tag @<tag>) @! \\
- @{ (@<handler> @<var> @<handler-arg>^*) @}^* @]]) @}^*}
+ @{ (@<handler> @<var> @<handler-arg>^*) @}^*
+ @]]) @}^*}
\end{describe}
\begin{describe}{fun}
%%%--------------------------------------------------------------------------
\section{Property sets} \label{sec:misc.pset}
+\begin{describe}{fun}{property-key @<name> @> @<keyword>}
+\end{describe}
+
+\begin{describe}{gf}{decode-property @<raw-value> @> @<type> @<value>}
+\end{describe}
+
+\begin{describe}{cls}{property}
+\end{describe}
+
+\begin{describe}{fun}{propertyp @<object> @> @<generalized-boolean>}
+\end{describe}
+
+\begin{describe}{fun}
+ {make-property @<name> @<raw-value> \&key :type :location :seenp}
+\end{describe}
+
+\begin{describe*}
+ {\dhead{fun}{p-name @<property> @> @<name>}
+ \dhead{fun}{p-value @<property> @> @<value>}
+ \dhead{fun}{p-type @<property> @> @<type>}
+ \dhead{fun}{p-key @<property> @> @<symbol>}
+ \dhead{fun}{p-seenp @<property> @> @<boolean>}
+ \dhead{fun}{setf (p-seenp @<property>) @<boolean>}}
+\end{describe*}
+
+\begin{describe}{gf}
+ {coerce-property-value @<value> @<type> @<wanted> @> @<coerced-value>}
+\end{describe}
+
+\begin{describe}{cls}{pset}
+\end{describe}
+
+\begin{describe}{fun}{psetp @<object> @> @<generalized-boolean>}
+\end{describe}
+
+\begin{describe}{fun}{make-pset @> @<pset>}
+\end{describe}
+
+\begin{describe}{fun}{pset-get @<pset> @<key> @> @<property-or-nil>}
+\end{describe}
+
+\begin{describe}{fun}{pset-store @<pset> @<property> @> @<property>}
+\end{describe}
+
+\begin{describe}{fun}{pset-map @<func> @<pset>}
+\end{describe}
+
+\begin{describe}{mac}
+ {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*}
+\end{describe}
+
+\begin{describe}{fun}
+ {store-property @<pset> @<name> @<value> \&key :type :location
+ @> @<property>}
+\end{describe}
+
+\begin{describe}{fun}
+ {get-property @<pset> @<name> @<type> \&optional @<default>
+ @> @<value> @<floc-or-nil>}
+\end{describe}
+
+\begin{describe}{fun}
+ {add-property @<pset> @<name> @<value> \&key :type :location
+ @> @<property>}
+\end{describe}
+
+\begin{describe}{fun}{make-property-set \&rest @<plist> @> @<pset>}
+\end{describe}
+
+\begin{describe}{gf}{property-set @<thing> @> @<pset>}
+\end{describe}
+
+\begin{describe}{fun}{check-unused-properties @<pset>}
+\end{describe}
+
+\begin{describe}{mac}
+ {default-slot-from-property
+ (@<instance> @<slot> @[@<slot-names>@]) \\ \ind\ind
+ (@<pset> @<property> @<type> @[@<prop-var> @<convert-form>^*@]) \- \\
+ @<declaration>^* \\
+ @<default-form>^*}
+\end{describe}
+
+\begin{describe}{fun}
+ {parse-property @<scanner> @<pset>
+ @> @<result> @<success-flag> @<consumed-flag>}
+\end{describe}
+
+\begin{describe}{fun}
+ {parse-property-set @<scanner>
+ @> @<result> @<success-flag> @<consumed-flag>}
+\end{describe}
+
%%%--------------------------------------------------------------------------
-\section{Miscellaneous translator features} \label{sec:misc.pset}
+\section{Miscellaneous translator features} \label{sec:misc.misc}
\begin{describe}{var}{*sod-version*}
\end{describe}
\begin{describe}{var}{*debugout-pathname*}
\end{describe}
-\begin{describe}{fun}{test-module @<path> @<reason>}
+\begin{describe}{fun}
+ {test-module @<path> \&key :reason :clear :backtrace @> @<status>}
+\end{describe}
+
+\begin{describe}{fun}
+ {test-parse-c-type @<string>
+ @> t @<c-type> @<kernel> @<string> @! nil @<indicator>}
+\end{describe}
+
+\begin{describe}{fun}
+ {test-parse-pset @<string>
+ @> t @<pset> @! nil @<indicator>}
+\end{describe}
+
+\begin{describe}{mac}
+ {test-parser (@<scanner> \&key :backtrace) @<parser> @<input>
+ @> @<result> @<status> @<remainder>}
\end{describe}
\begin{describe}{fun}{exercise}
\end{describe}
+\begin{describe}{fun}{sod-frontend:main}
+\end{describe}
+
%%%----- That's all, folks --------------------------------------------------
%%% Local variables:
~mdw / sod / blobdiff