X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/981b6fb624186a54320cea34e53e16276aee2bdb..7ae23d74a4a7ec3b778f48e26d7a81a338a56111:/doc/meta.tex?ds=sidebyside

diff --git a/doc/meta.tex b/doc/meta.tex
index f412e00..dbbf2d6 100644
--- a/doc/meta.tex
+++ b/doc/meta.tex
@@ -29,15 +29,17 @@
 \section{Base metaobject classes} \label{sec:meta.classes}
 
 \begin{describe}{cls}
-    {sod-class () \\ \ind
-      \&key \=:name :nick :location :pset \+ \\
-              :superclasses :link :metaclass \\
+    {sod-class ()                                               \\ \ind
+      \&key \=:name :nick :location :pset                     \+\\
+              :superclasses :link :metaclass                    \\
               :slots :instance-initializers :class-initializers \\
+              :initargs :initfrags :tearfrags                   \\
               :messages :methods}
 \end{describe}
 
 \begin{describe*}
     {\dhead{gf}{sod-class-name @<class> @> @<string>}
+     \dhead{meth}{sod-class}{file-location (@<class> sod-class) @> @<floc>}
      \dhead{gf}{sod-class-nickname @<class> @> @<string>}
      \dhead{gf}{sod-class-direct-superclasses @<class> @> @<list>}
      \dhead{gf}{sod-class-chain-link @<class> @> @<class-or-nil>}
@@ -48,46 +50,44 @@
      \dhead{gf}{setf (sod-class-instance-initializers @<class>) @<list>}
      \dhead{gf}{sod-class-class-initializers @<class> @> @<list>}
      \dhead{gf}{setf (sod-class-class-initializers @<class>) @<list>}
+     \dhead{gf}{sod-class-initargs @<class> @> @<list>}
+     \dhead{gf}{setf (sod-class-initargs @<class>) @<list>}
+     \dhead{gf}{sod-class-initfrags @<class> @> @<list>}
+     \dhead{gf}{setf (sod-class-initfrags @<class>) @<list>}
+     \dhead{gf}{sod-class-tearfrags @<class> @> @<list>}
+     \dhead{gf}{setf (sod-class-tearfrags @<class>) @<list>}
      \dhead{gf}{sod-class-messages @<class> @> @<list>}
      \dhead{gf}{setf (sod-class-messages @<class>) @<list>}
      \dhead{gf}{sod-class-methods @<class> @> @<list>}
      \dhead{gf}{setf (sod-class-methods @<class>) @<list>}}
 \end{describe*}
 
-%% layout protocol
-\begin{describe*}
-    {\dhead{gf}{sod-class-ilayout <class> @> @<ilayout>}
-     \dhead{gf}{sod-class-effective-methods @<class> @> @<list>}
-     \dhead{gf}{sod-class-vtables @<class> @> @<list>}}
-\end{describe*}
-
 \begin{describe}{fun}
-    {make-sod-class @<name> @<superclasses> @<pset> \&optional @<floc>
+    {make-sod-class @<name> @<superclasses> @<pset> \&key :location
       @> @<class>}
 \end{describe}
 
-\begin{describe}{mac}
-    {define-sod-class @<name> (@<superclass>^*) \\ \ind
-      @{ @<keyword> @<value> @}^* \\
-      @<declaration>^* \\
-      @<form>^*}
+\begin{describe}{fun}
+    {find-superclass-by-nick @<class> @<nick> @> @<superclass>}
 \end{describe}
 
-\begin{describe*}
-    {\dhead{lmac}{slot @<name> @<type> @{ @<keyword> @<value> @}^*}
-     \dhead{lmac}{instance-initializer @<nick> @<name>
-                                       @<value-kind> @<value-form>
-                                       @{ @<keyword> @<value> @}^*}
-     \dhead{lmac}{class-initializer @<nick> @<name>
-                                    @<value-kind> @<value-form>
-                                    @{ @<keyword> @<value> @}^*}
-     \dhead{lmac}{message @<name> @<type> @{ @<keyword> @<value> @}^*}
-     \dhead{lmac}{method @<nick> @<name> @<type> @<body>
-                         @{ @<keyword> @<value> @}^*}}
-\end{describe*}
+\begin{describe}{ty}{inheritance-path-reporter-state}
+\end{describe}
+
+\begin{describe}{fun}{make-inheritance-path-reporter-state @> @<state>}
+\end{describe}
+
+\begin{describe}{fun}{report-inheritance-path @<state> @<super>}
+\end{describe}
 
 \begin{describe}{fun}
-    {find-superclass-by-nick @<class> @<nick> @> @<superclass>}
+    {select-minimal-class-property
+        \=@<supers> @<key> @<order> @<default> @<what> \\
+        \>\&key :present :allow-empty
+      \nlret @<object>}
+\end{describe}
+
+\begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
 \end{describe}
 
 \begin{describe}{fun}
@@ -108,12 +108,13 @@
 
 \begin{describe*}
     {\dhead{gf}{sod-slot-name @<slot> @> @<string>}
+     \dhead{meth}{sod-slot}{file-location (@<slot> sod-slot) @> @<floc>}
      \dhead{gf}{sod-slot-class @<slot> @> @<class>}
      \dhead{gf}{sod-slot-type @<slot> @> @<c-type>}}
 \end{describe*}
 
 \begin{describe}{gf}
-    {make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
+    {make-sod-slot @<class> @<name> @<type> @<pset> \&key :location
       @> @<slot>}
 \end{describe}
 
@@ -126,13 +127,8 @@
         @> @<slot>}}
 \end{describe*}
 
-\begin{describe}{fun}
-    {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
-      @> @<slot>}
-\end{describe}
-
 \begin{describe}{cls}
-    {sod-class-slot (sod-slot) \\ \ind
+    {sod-class-slot (sod-slot)                                  \\ \ind
       \&key :name :location :pset :class :type
             :initializer-function :prepare-function}
 \end{describe}
@@ -144,50 +140,95 @@
 
 \begin{describe*}
     {\dhead{cls}{sod-initializer ()
-       \&key :slot :location :class :value-kind :value-form}
+                  \&key :slot :location :class :value}
      \dhead{cls}{sod-instance-initializer (sod-initializer)
-       \&key :slot :location :class :value-kind :value-form}
+                  \&key :slot :location :class :value}
      \dhead{cls}{sod-class-initializer (sod-initializer)
-       \&key :slot :location :class :value-kind :value-form}}
+                  \&key :slot :location :class :value}}
 \end{describe*}
 
 \begin{describe*}
     {\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
-     \dhead{gf}{sod-initializer-value-kind @<init> @> @<kind>}
-     \dhead{gf}{sod-initializer-value-form @<init> @> @<fragment>}}
+     \dhead{meth}{sod-initializer}
+       {file-location (@<init> sod-initializer) @> @<floc>}
+     \dhead{gf}{sod-initializer-value @<init> @> @<fragment>}
+     \dhead{gf}{sod-initializer-class @<init> @> @<class>}}
 \end{describe*}
 
 \begin{describe*}
     {\dhead{gf}
-      {make-slot-instance-initializer \=@<class> @<nick> @<name>
-                                        @<value-kind> @<value-form> \+ \\
-                                        @<pset> \&optional @<floc> \-
+      {make-sod-instance-initializer
+          \=@<class> @<nick> @<name> @<value> @<pset> \\
+          \>\&key :inhibit-initargs :location
         \nlret @<init>}
      \dhead{gf}
-      {make-slot-class-initializer \=@<class> @<nick> @<name>
-                                     @<value-kind> @<value-form> \+ \\
-                                     @<pset> \&optional @<floc> \-
+      {make-sod-class-initializer
+          \=@<class> @<nick> @<name> @<value> @<pset> \&key :location
         \nlret @<init>}}
 \end{describe*}
 
 \begin{describe}{gf}
-    {make-sod-initializer-using-slot \=@<class> @<slot> @<init-class>
-                                       @<value-kind> @<value-form> \+ \\
-                                       @<pset> \&optional @<floc> \-
+    {make-sod-initializer-using-slot
+        @<class> @<slot> @<init-class> @<value> @<pset> @<floc>
       \nlret @<init>}
 \end{describe}
 
+\begin{describe*}
+    {\dhead{cls}{sod-initarg () \&key :class :location :name :type}
+     \dhead{cls}{sod-user-initarg (sod-initarg)
+                  \&key :class :location :name :type :default}
+     \dhead{cls}{sod-slot-initarg (sod-initarg)
+                  \&key :class :location :name :type :slot}}
+\end{describe*}
+
+\begin{describe*}
+    {\dhead{gf}{sod-initarg-class @<initarg> @> @<class>}
+     \dhead{gf}{sod-initarg-name @<initarg> @> @<string>}
+     \dhead{gf}{sod-initarg-type @<initarg> @> @<c-type>}
+     \dhead{gf}{sod-initarg-default @<initarg> @> @<default>}
+     \dhead{gf}{sod-initarg-slot @<initarg> @> @<slot>}}
+\end{describe*}
+
+\begin{describe}{gf}{sod-initarg-argument @<initarg> @> @<argument>}
+\end{describe}
+
+\begin{describe}{gf}
+    {make-sod-user-initarg @<class> @<name> @<type> @<pset>
+                           \&key :default :location
+     \nlret @<initarg>}
+\end{describe}
+
+\begin{describe*}
+    {\dhead{gf}
+       {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
+                              \&key :location
+        \nlret @<initarg>}
+     \dhead{gf}
+        {make-sod-slot-initarg-using-slot @<class> @<name> @<slot> @<pset>
+                                          \&key :location
+         \nlret @<initarg>}}
+\end{describe*}
+
+\begin{describe*}
+    {\dhead{gf}{make-sod-class-initfrag @<class> @<frag> @<pset>
+                                        \&key :location}
+     \dhead{gf}{make-sod-class-tearfrag @<class> @<frag> @<pset>
+                                        \&key :location}}
+\end{describe*}
+
 \begin{describe}{cls}{sod-message () \&key :name :location :class :type}
 \end{describe}
 
 \begin{describe*}
     {\dhead{gf}{sod-message-name @<message> @> @<string>}
+     \dhead{meth}{sod-message}
+       {file-location (@<message> sod-message) @> @<floc>}
      \dhead{gf}{sod-message-class @<message> @> @<class>}
      \dhead{gf}{sod-message-type @<message> @> @<c-type>}}
 \end{describe*}
 
 \begin{describe}{gf}
-    {make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
+    {make-sod-message @<class> @<name> @<type> @<pset> \&key :location
       @> @<message>}
 \end{describe}
 
@@ -205,21 +246,25 @@
 
 \begin{describe*}
     {\dhead{gf}{sod-method-message @<method> @> @<message>}
+     \dhead{meth}{sod-method}
+       {file-location (@<method> sod-method) @> @<floc>}
      \dhead{gf}{sod-method-class @<method> @> @<class>}
      \dhead{gf}{sod-method-type @<method> @> @<c-type>}
      \dhead{gf}{sod-method-body @<method> @> @<fragment-or-nil>}}
 \end{describe*}
 
 \begin{describe}{gf}
-    {make-sod-method \=@<class> @<nick> @<name> @<type> @<body> \+ \\
-                       @<pset> \&optional @<floc> \-
+    {make-sod-method
+        \=@<class> @<nick> @<name> @<type> @<body>            \+\\
+          @<pset> \&key :location                             \-
       \nlret @<method>}
 \end{describe}
 
 \begin{describe}{gf}
-    {make-sod-method-using-message \=@<message> @<class>
-                                     @<type> @<body> \+ \\
-                                     @<pset> \&optional @<floc> \-
+    {make-sod-method-using-message
+        \=@<message> @<class>
+          @<type> @<body>                                     \+\\
+          @<pset> \&key :location                             \-
       \nlret @<method>}
 \end{describe}
 
@@ -235,11 +280,32 @@
       @> @<generalized-boolean>}
 \end{describe}
 
+\begin{describe}{fun}{check-method-return-type @<method-type> @<return-type>}
+\end{describe}
+
+\begin{describe}{fun}
+    {check-method-return-type-against-message @<method-type> @<message-type>}
+\end{describe}
+
+\begin{describe}{fun}
+    {check-method-argument-lists @<method-type> @<message-type>}
+\end{describe}
+
 %%%--------------------------------------------------------------------------
 \section{Class finalization protocol} \label{sec:meta.finalization}
 
+\begin{describe}{mac}
+    {finalization-error (@<token> @<arg>^*) \\ \ind
+      @<declaration>^* \\
+      @<form>^* \-
+     \nlret @<value>^*}
+\end{describe}
+
+\begin{describe}{fun}{finalization-failed}
+\end{describe}
+
 \begin{describe*}
-    {\dhead{gf}{sod-class-precedence-list <class> @> @<list>}
+    {\dhead{gf}{sod-class-precedence-list @<class> @> @<list>}
      \dhead{gf}{sod-class-type @<class> @> @<c-type>}
      \dhead{gf}{sod-class-chain-head @<class> @> @<class>}
      \dhead{gf}{sod-class-chain @<class> @> @<list>}
@@ -250,16 +316,36 @@
 \begin{describe}{gf}{compute-cpl @<class> @> @<list>}
 \end{describe}
 
+\begin{describe}{fun}
+    {report-class-list-merge-error @<class> @<lists> @<error>}
+\end{describe}
+
+\begin{describe}{fun}{merge-class-lists @<class> @<lists> @<pick> @> @<list>}
+\end{describe}
+
 \begin{describe}{gf}{compute-chains @<class> @> @<list>}
 \end{describe}
 
-\begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
+\begin{describe}{gf}{check-class-initializer @<slot> @<class>}
+  \begin{describe}{meth}{effective-slot,sod-class}
+      {check-class-initializer (@<slot> effective-slot) (@<class> sod-class)}
+  \end{describe}
+  \begin{describe}{meth}{sod-class-effective-slot,sod-class}
+      {check-class-initializer (@<slot> sod-class-effective-slot)
+                               (@<class> sod-class)}
+  \end{describe}
 \end{describe}
 
 \begin{describe}{gf}{check-sod-class @<class>}
 \end{describe}
 
-\begin{describe}{gf}{finalize-sod-class @<class>}
+\begin{describe}{gf}{finalize-sod-class @<class> @> @<generalized-boolean>}
+  \begin{describe}{meth}{sod-class}
+      {finalize-sod-class (@<class> sod-class)}
+  \end{describe}
+  \begin{describe}{ar-meth}{sod-class}
+      {finalize-sod-class (@<class> sod-class) @> @<generalized-boolean>}
+  \end{describe}
 \end{describe}
 
 \begin{describe}{fun}{clos-cpl @<class> @> @<list>}
@@ -279,6 +365,7 @@
 
 \begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
 \end{describe}
+
 %%%----- That's all, folks --------------------------------------------------
 
 %%% Local variables:
