X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/7262683bc1c233d85839ed70472d490e5ec39fab..e520bc2484f96c38991fb8d3b49cd9a3b2410842:/doc/misc.tex

diff --git a/doc/misc.tex b/doc/misc.tex
index 2126c16..06791f4 100644
--- a/doc/misc.tex
+++ b/doc/misc.tex
@@ -7,7 +7,7 @@
 
 %%%----- 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
@@ -32,17 +32,20 @@ These symbols are defined in the @|sod-utilities| package.
 
 \begin{describe}{mac}
     {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
-      @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
 \end{describe}
 
 \begin{describe}{mac}
     {once-only (@[[ :environment @<env> @]]
                 @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
-      @<body-form>^*}
+      @<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}
@@ -51,7 +54,7 @@ These symbols are defined in the @|sod-utilities| package.
 \begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
 \end{describe}
 
-\begin{describe}{macro}{locf @<place> @> @<locative>}
+\begin{describe}{mac}{locf @<place> @> @<locative>}
 \end{describe}
 
 \begin{describe*}
@@ -63,7 +66,8 @@ These symbols are defined in the @|sod-utilities| package.
     {with-locatives
         @{ @<var> @! (@{ @<var> @!
                          (@<var> @[@<locative>@]) @}^*) @} \\ \ind
-      @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
 \end{describe}
 
 \begin{describe}{sym}{it}
@@ -72,7 +76,7 @@ These symbols are defined in the @|sod-utilities| package.
 \begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
 \end{describe}
 
-\begin{describe}{mac}{awhen @<condition> @<body-form>^*}
+\begin{describe}{mac}{awhen @<condition> @<form>^*}
 \end{describe}
 
 \begin{describe}{mac}{acond @{ (@<condition> @<form>^*) @}^*}
@@ -136,7 +140,8 @@ These symbols are defined in the @|sod-utilities| package.
     {categorize (\=@<item-var> @<items>
                    @[[ :bind (@{ @<var> @! (@<var> @[@<value>@]) @}^*) @]])
                                                                  \\ \ind\ind
-        (@{ @<cat-var> @<cat-predicate> @}^*) \- \\
+        (@{ (@<cat-var> @<cat-predicate>) @}^*) \- \\
+      @<declaration>^* \\
       @<body-form>^* \-
      \nlret @<value>^*}
 \end{describe}
@@ -170,14 +175,19 @@ These symbols are defined in the @|sod-utilities| package.
     {maybe-print-unreadable-object (@<object> @<stream>
                                     @[[ :type @<type> @!
                                         :identity @<identity> @]]) \\ \ind
-       @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
+\end{describe}
+
+\begin{describe}{fun}{print-ugly-stuff @<stream> @<func> @> @<value>^*}
 \end{describe}
 
 \begin{describe}{mac}
     {dosequence (@<var> @<sequence>
                  @[[ :start @<start> @! :end @<end> @!
                      :indexvar @<var> @]]) \\ \ind
-      @{ @<tag> @! @<body-form> @}^*}
+      @<declaration>^* \\
+      @{ @<tag> @! @<statement> @}^*}
 \end{describe}
 
 \begin{describe}{mac}
@@ -187,12 +197,13 @@ These symbols are defined in the @|sod-utilities| package.
 
 \begin{describe}{mac}
     {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
-      @<body-form>^*}
+      @<form>^*}
 \end{describe}
 
 \begin{describe}{mac}
     {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
-      @<body-form>^*}
+      @[[ @<declaration>^* @! @<doc-string> @]] \\
+      @<form>^*}
 \end{describe}
 
 %%%--------------------------------------------------------------------------
@@ -307,15 +318,16 @@ These symbols are defined in the @!optparse| package.
 \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}
@@ -349,7 +361,10 @@ These symbols are defined in the @!optparse| package.
 \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>}
@@ -363,10 +378,11 @@ These symbols are defined in the @!optparse| package.
                          (: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}
@@ -414,6 +430,97 @@ These symbols are defined in the @!optparse| package.
 %%%--------------------------------------------------------------------------
 \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}{decode-property @<raw-value> @> @<type> @<value>}
+\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-set @<scanner>
+      @> @<result> @<success-flag> @<consumed-flag>}
+\end{describe}
+
 %%%--------------------------------------------------------------------------
 \section{Miscellaneous translator features} \label{sec:misc.pset}
 
@@ -426,9 +533,17 @@ These symbols are defined in the @!optparse| package.
 \begin{describe}{fun}{test-module @<path> @<reason>}
 \end{describe}
 
+\begin{describe}{mac}
+    {test-parser (@<scanner>) @<parser> @<input>
+      @> @<success-flag> @<result> @<remainder>}
+\end{describe}
+
 \begin{describe}{fun}{exercise}
 \end{describe}
 
+\begin{describe}{fun}{sod-frontend:main}
+\end{describe}
+
 %%%----- That's all, folks --------------------------------------------------
 
 %%% Local variables:
