Static instance support.
[sod] / doc / meta.tex
index 24a7af8..f341414 100644 (file)
@@ -39,6 +39,7 @@
 
 \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>}
 \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*}
-    {\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}{fun}
     {find-superclass-by-nick @<class> @<nick> @> @<superclass>}
 \end{describe}
@@ -99,6 +87,9 @@
       \nlret @<object>}
 \end{describe}
 
+\begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
+\end{describe}
+
 \begin{describe}{fun}
     {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
 \end{describe}
 
 \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}
 
         @> @<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
       \&key :name :location :pset :class :type
 
 \begin{describe*}
     {\dhead{cls}{sod-initializer ()
-       \&key :slot :location :class :value}
+                  \&key :slot :location :class :value}
      \dhead{cls}{sod-instance-initializer (sod-initializer)
-       \&key :slot :location :class :value}
+                  \&key :slot :location :class :value}
      \dhead{cls}{sod-class-initializer (sod-initializer)
-       \&key :slot :location :class :value}}
+                  \&key :slot :location :class :value}}
 \end{describe*}
 
 \begin{describe*}
     {\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
-     \dhead{gf}{sod-initializer-value @<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> @<pset> \&optional @<floc>
+      {make-sod-instance-initializer
+          \=@<class> @<nick> @<name> @<value> @<pset> \\
+          \>\&key :inhibit-initargs :location :add-to-class
         \nlret @<init>}
      \dhead{gf}
-      {make-slot-class-initializer
-          \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
+      {make-sod-class-initializer
+          \=@<class> @<nick> @<name> @<value> @<pset> \\
+          \>\&key :location :add-to-class
         \nlret @<init>}}
 \end{describe*}
 
 \begin{describe}{gf}
     {make-sod-initializer-using-slot
-        \=@<class> @<slot> @<init-class> @<value> @<pset> \&optional @<floc>
+        @<class> @<slot> @<init-class> @<value> @<pset> @<floc>
       \nlret @<init>}
 \end{describe}
 
-\begin{describe}{cls}{sod-initarg () \&key :class :location :name :type}
-\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-type @<initarg> @> @<c-type>}
+     \dhead{gf}{sod-initarg-default @<initarg> @> @<default>}
+     \dhead{gf}{sod-initarg-slot @<initarg> @> @<slot>}}
 \end{describe*}
 
-\begin{describe}{cls}
-    {sod-user-initarg (sod-initarg)
-      \&key :class :location :name :type :default}
-\end{describe}
-
-\begin{describe}{gf}
-     {make-sod-user-initarg @<class> @<name> @<type> @<pset>
-                            \&optional @<default> @<floc>}
-\end{describe}
-
-\begin{describe}{gf}{sod-initarg-default @<initarg> @> @<default>}
-\end{describe}
-
-\begin{describe}{cls}
-    {sod-slot-initarg (sod-initarg)
-      \&key :class :location :name :type :slot}
-\end{describe}
-
-\begin{describe}{gf}{sod-initarg-slot @<initarg> @> @<slot>}
+\begin{describe}{gf}{sod-initarg-argument @<initarg> @> @<argument>}
 \end{describe}
 
 \begin{describe}{gf}
-    {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
-                           \&optional @<floc>}
+    {make-sod-user-initarg @<class> @<name> @<type> @<pset>
+                           \&key :default :location
+     \nlret @<initarg>}
 \end{describe}
 
-\begin{describe}{gf}
-    {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
-                           \&optional @<floc>}
-\end{describe}
-
-\begin{describe}{gf}
-    {make-sod-slot-initarg-using-slot @<class> @<name> @<slot> @<pset>
-                                      \&optional @<floc>}
-\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>
-                                        \&optional @<floc>}
+                                        \&key :location}
      \dhead{gf}{make-sod-class-tearfrag @<class> @<frag> @<pset>
-                                        \&optional @<floc>}}
+                                        \&key :location}}
 \end{describe*}
 
-\begin{describe}{cls}{sod-message () \&key :name :location :class :type}
+\begin{describe}{cls}
+    {sod-message () \&key :name :location :readonly :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-readonly-p @<message> @> @<generalized-boolean>}
      \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}
 
 
 \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>}}
 \begin{describe}{gf}
     {make-sod-method
         \=@<class> @<nick> @<name> @<type> @<body>            \+\\
-          @<pset> \&optional @<floc>                          \-
+          @<pset> \&key :location                             \-
       \nlret @<method>}
 \end{describe}
 
     {make-sod-method-using-message
         \=@<message> @<class>
           @<type> @<body>                                     \+\\
-          @<pset> \&optional @<floc>                          \-
+          @<pset> \&key :location                             \-
       \nlret @<method>}
 \end{describe}
 
     {check-method-argument-lists @<method-type> @<message-type>}
 \end{describe}
 
+\begin{describe}{cls}
+    {static-instance ()
+      \&key :name :location :externp :constp :class :initializers}
+\end{describe}
+
+\begin{describe*}
+    {\dhead{gf}{static-instance-name @<static-instance> @> @<string>}
+     \dhead{gf}{static-instance-extern-p @<static-instance>
+                 @> @<generalized-boolean>}
+     \dhead{gf}{static-instance-const-p @<static-instance>
+                 @> @<generalized-boolean>}
+     \dhead{gf}{static-instance-class @<static-instance> @> @<class>}
+     \dhead{gf}{static-instance-initializers @<static-instance> @> @<list>}
+     \dhead{gf}
+       {setf (static-instance-initializers @<static-instance>) @<list>}}
+\end{describe*}
+
+\begin{describe}{gf}
+    {make-static-instance @<class> @<name> @<initializers>
+      @<pset> @<location> \&key
+     \nlret @<static-instance>}
+\end{describe}
+
 %%%--------------------------------------------------------------------------
 \section{Class finalization protocol} \label{sec:meta.finalization}
 
 \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> @> @<generalized-boolean>}
-  \begin{describe}{meth}{finalize-sod-class (@<class> sod-class)}
+  \begin{describe}{meth}{sod-class}
+      {finalize-sod-class (@<class> sod-class)}
   \end{describe}
-  \begin{describe}{ar-meth}{finalize-sod-class (@<class> sod-class)
-                              @> @<generalized-boolean>}
+  \begin{describe}{ar-meth}{sod-class}
+      {finalize-sod-class (@<class> sod-class) @> @<generalized-boolean>}
   \end{describe}
 \end{describe}