X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/cac85e0be5833902081c903f75e348b949294fb9..1c2db39a35b4efe99594b2a53737d4f0971d01d8:/doc/misc.tex

diff --git a/doc/misc.tex b/doc/misc.tex
index 92223d1..e77d512 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
@@ -31,15 +31,15 @@
 These symbols are defined in the @|sod-utilities| package.
 
 \begin{describe}{mac}
-    {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
-      @<declaration>^* \\
+    {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*)      \\ \ind
+      @<declaration>^*                                          \\
       @<form>^*}
 \end{describe}
 
 \begin{describe}{mac}
     {once-only (@[[ :environment @<env> @]]
-                @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
-      @<declaration>^* \\
+                @{ @<var> @! (@<var> @[@<value-form>@]) @}^*)   \\ \ind
+      @<declaration>^*                                          \\
       @<form>^*}
 \end{describe}
 
@@ -65,8 +65,8 @@ These symbols are defined in the @|sod-utilities| package.
 \begin{describe}{mac}
     {with-locatives
         @{ @<var> @! (@{ @<var> @!
-                         (@<var> @[@<locative>@]) @}^*) @} \\ \ind
-      @<declaration>^* \\
+                         (@<var> @[@<locative>@]) @}^*) @}      \\ \ind
+      @<declaration>^*                                          \\
       @<form>^*}
 \end{describe}
 
@@ -76,6 +76,9 @@ These symbols are defined in the @|sod-utilities| package.
 \begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
 \end{describe}
 
+\begin{describe}{mac}{aand @<form>^*}
+\end{describe}
+
 \begin{describe}{mac}{awhen @<condition> @<form>^*}
 \end{describe}
 
@@ -126,6 +129,11 @@ These symbols are defined in the @|sod-utilities| package.
     {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}{cls}{inconsistent-merge-error (error) \&key :candidates}
 \end{describe}
 
@@ -133,17 +141,21 @@ These symbols are defined in the @|sod-utilities| package.
 \end{describe}
 
 \begin{describe}{fun}
-    {merge-lists @<lists> \&key :pick (:test \#'eql) @> @<list>}
+    {merge-lists @<lists> \&key :pick (:test \#'eql) :present @> @<list>}
 \end{describe}
 
 \begin{describe}{mac}
     {categorize (\=@<item-var> @<items>
-                   @[[ :bind (@{ @<var> @! (@<var> @[@<value>@]) @}^*) @]])
-                                                                 \\ \ind\ind
-        (@{ (@<cat-var> @<cat-predicate>) @}^*) \- \\
-      @<declaration>^* \\
-      @<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}
@@ -168,22 +180,29 @@ These symbols are defined in the @|sod-utilities| package.
     {compose @<function> \&rest @<more-functions> @> @<function>}
 \end{describe}
 
+\begin{describe}{mac}{defvar @<name> @<documentation> @> @<name>}
+\end{describe}
+
 \begin{describe}{fun}{symbolicate \&rest @<symbols> @> @<symbol>}
 \end{describe}
 
 \begin{describe}{mac}
-    {maybe-print-unreadable-object (@<object> @<stream>
-                                    @[[ :type @<type> @!
-                                        :identity @<identity> @]]) \\ \ind
-      @<declaration>^* \\
+    {maybe-print-unreadable-object
+        (@<object> @<stream>
+         @[[ :type @<type> @!
+             :identity @<identity> @]])                         \\ \ind
+      @<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
-      @<declaration>^* \\
+                     :indexvar @<var> @]])                      \\ \ind
+      @<declaration>^*                                          \\
       @{ @<tag> @! @<statement> @}^*}
 \end{describe}
 
@@ -192,14 +211,30 @@ These symbols are defined in the @|sod-utilities| package.
                            @[[ :read-only @<read-only-flag> @]]}
 \end{describe}
 
+\begin{describe}{cls}
+    {simple-control-error (control-error simple-error)
+        \&key :format-control :format-arguments}
+\end{describe}
+
+\begin{describe}{fun}
+    {designated-condition
+        \=@<default-type> @<datum> @<arguments>                 \\
+        \>\&key :allow-pointless-arguments
+      \nlret @<condition>}
+\end{describe}
+
+\begin{describe}{fun}
+    {invoke-associated-restart @<restart> @<condition> \&rest @<arguments>}
+\end{describe}
+
 \begin{describe}{mac}
-    {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
+    {default-slot (@<instance> @<slot> @[@<slot-names>@])       \\ \ind
       @<form>^*}
 \end{describe}
 
 \begin{describe}{mac}
-    {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
-      @[[ @<declaration>^* @! @<doc-string> @]] \\
+    {define-on-demand-slot @<class> @<slot> (@<instance>)       \\ \ind
+      @[[ @<declaration>^* @! @<doc-string> @]]                 \\
       @<form>^*}
 \end{describe}
 
@@ -215,6 +250,22 @@ These symbols are defined in the @|sod-parser| package.
     {enclosed-condition @<enclosing-condition> @> @<condition>}
 \end{describe}
 
+\begin{describe}{cls}{information (condition) \&key}
+\end{describe}
+
+\begin{describe}{cls}
+    {simple-information (simple-condition information)          \\ \ind
+      \&key :format-control :format-arguments}
+\end{describe}
+
+\begin{describe}{fun}{info @<datum> \&rest @<arguments> @> @<flag>}
+\end{describe}
+
+\begin{describe*}
+    {\dhead{rst}{noted}
+     \dhead{fun}{noted \&optional @<condition>}}
+\end{describe*}
+
 \begin{describe}{fun}{cerror* @<datum> \&rest @<arguments>}
 \end{describe}
 
@@ -251,9 +302,10 @@ These symbols are defined in the @!optparse| package.
 \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}
 
@@ -375,7 +427,7 @@ 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>^*) @}^*
@@ -445,13 +497,9 @@ These symbols are defined in the @!optparse| package.
 
 \begin{describe*}
     {\dhead{fun}{p-name @<property> @> @<name>}
-     \dhead{fun}{setf (p-name @<property>) @<name>}
      \dhead{fun}{p-value @<property> @> @<value>}
-     \dhead{fun}{setf (p-value @<property>) @<value>}
      \dhead{fun}{p-type @<property> @> @<type>}
-     \dhead{fun}{setf (p-type @<property>) @<type>}
      \dhead{fun}{p-key @<property> @> @<symbol>}
-     \dhead{fun}{setf (p-key @<property>) @<symbol>}
      \dhead{fun}{p-seenp @<property> @> @<boolean>}
      \dhead{fun}{setf (p-seenp @<property>) @<boolean>}}
 \end{describe*}
@@ -518,6 +566,11 @@ These symbols are defined in the @!optparse| package.
 \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}
@@ -531,7 +584,18 @@ These symbols are defined in the @!optparse| package.
 \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}{mac}
+    {test-parser (@<scanner> \&key :backtrace) @<parser> @<input>
+      @> @<result> @<status> @<remainder>}
 \end{describe}
 
 \begin{describe}{fun}{exercise}
