[sod] / doc / meta.tex

%%% -*-latex-*-
%%%
%%% Translation-time metaobjects
%%%
%%% (c) 2015 Straylight/Edgeware
%%%

%%%----- Licensing notice ---------------------------------------------------
%%%
%%% 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
%%% the Free Software Foundation; either version 2 of the License, or
%%% (at your option) any later version.
%%%
%%% SOD is distributed in the hope that it will be useful,
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%%% GNU General Public License for more details.
%%%
%%% You should have received a copy of the GNU General Public License
%%% along with SOD; if not, write to the Free Software Foundation,
%%% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

\chapter{Translation-time metaobjects} \label{ch:meta}

%%%--------------------------------------------------------------------------
\section{Base metaobject classes} \label{sec:meta.classes}

\begin{describe}{cls}
    {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{gf}{sod-class-nickname @<class> @> @<string>}
     \dhead{gf}{sod-class-direct-superclasses @<class> @> @<list>}
     \dhead{gf}{sod-class-chain-link @<class> @> @<class-or-nil>}
     \dhead{gf}{sod-class-metaclass @<class> @> @<metaclass>}
     \dhead{gf}{sod-class-slots @<class> @> @<list>}
     \dhead{gf}{setf (sod-class-slots @<class>) @<list>}
     \dhead{gf}{sod-class-instance-initializers @<class> @> @<list>}
     \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*}

\begin{describe}{fun}
    {make-sod-class @<name> @<superclasses> @<pset> \&optional @<floc>
      @> @<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}

\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}
    {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}
    {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
\end{describe}

\begin{describe}{fun}{valid-name-p @<name> @> @<generalized-boolean>}
\end{describe}

\begin{describe}{fun}{find-root-superclass @<class> @> @<superclass>}
\end{describe}

\begin{describe}{fun}{find-root-metaclass @<class> @> @<metaclass>}
\end{describe}

\begin{describe}{cls}{sod-slot () \&key :name :location :pset :class :type}
\end{describe}

\begin{describe*}
    {\dhead{gf}{sod-slot-name @<slot> @> @<string>}
     \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>
      @> @<slot>}
\end{describe}

\begin{describe*}
    {\dhead{fun}
      {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
        @> @<slot>}
     \dhead{fun}
      {find-class-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
            :initializer-function :prepare-function}
\end{describe}

\begin{describe*}
    {\dhead{gf}{sod-slot-initializer-function @<slot> @> @<function>}
     \dhead{gf}{sod-slot-prepare-function @<slot> @> @<function>}}
\end{describe*}

\begin{describe*}
    {\dhead{cls}{sod-initializer ()
       \&key :slot :location :class :value}
     \dhead{cls}{sod-instance-initializer (sod-initializer)
       \&key :slot :location :class :value}
     \dhead{cls}{sod-class-initializer (sod-initializer)
       \&key :slot :location :class :value}}
\end{describe*}

\begin{describe*}
    {\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
     \dhead{gf}{sod-initializer-value @<init> @> @<fragment>}}
\end{describe*}

\begin{describe*}
    {\dhead{gf}
      {make-slot-instance-initializer
          \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
        \nlret @<init>}
     \dhead{gf}
      {make-slot-class-initializer
          \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
        \nlret @<init>}}
\end{describe*}

\begin{describe}{gf}
    {make-sod-initializer-using-slot
        \=@<class> @<slot> @<init-class> @<value> @<pset> \&optional @<floc>
      \nlret @<init>}
\end{describe}

\begin{describe}{cls}{sod-initarg () \&key :class :location :name :type}
\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>}}
\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>}
\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-class-initfrag @<class> @<frag> @<pset>
                                        \&optional @<floc>}
     \dhead{gf}{make-sod-class-tearfrag @<class> @<frag> @<pset>
                                        \&optional @<floc>}}
\end{describe*}

\begin{describe}{cls}{sod-message () \&key :name :location :class :type}
\end{describe}

\begin{describe*}
    {\dhead{gf}{sod-message-name @<message> @> @<string>}
     \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>
      @> @<message>}
\end{describe}

\begin{describe}{gf}{check-message-type @<message> @<type>}
\end{describe}

\begin{describe}{fun}
    {find-message-by-name @<class> @<super-nick> @<message-name>
      @> @<message>}
\end{describe}

\begin{describe}{cls}
    {sod-method () \&key :message :location :class :type :body}
\end{describe}

\begin{describe*}
    {\dhead{gf}{sod-method-message @<method> @> @<message>}
     \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>                          \-
      \nlret @<method>}
\end{describe}

\begin{describe}{gf}
    {make-sod-method-using-message
        \=@<message> @<class>
          @<type> @<body>                                     \+\\
          @<pset> \&optional @<floc>                          \-
      \nlret @<method>}
\end{describe}

\begin{describe}{gf}
    {sod-message-method-class @<message> @<class> @<pset> @> @<method-class>}
\end{describe}

\begin{describe}{gf}{check-method-type @<method> @<message> @<type>}
\end{describe}

\begin{describe}{fun}
    {argument-lists-compatible-p @<message-args> @<method-args>
      @> @<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-type @<class> @> @<c-type>}
     \dhead{gf}{sod-class-chain-head @<class> @> @<class>}
     \dhead{gf}{sod-class-chain @<class> @> @<list>}
     \dhead{gf}{sod-class-chains @<class> @> @<list>}
     \dhead{gf}{sod-class-state @<class> @> @<state>}}
\end{describe*}

\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}{check-class-initializer @<slot> @<class>}
  \begin{describe}{meth}
      {check-class-initializer (@<slot> effective-slot) (@<class> sod-class)}
  \end{describe}
  \begin{describe}{meth}
      {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)}
  \end{describe}
  \begin{describe}{ar-meth}{finalize-sod-class (@<class> sod-class)
                              @> @<generalized-boolean>}
  \end{describe}
\end{describe}

\begin{describe}{fun}{clos-cpl @<class> @> @<list>}
\end{describe}

\begin{describe}{fun}{dylan-cpl @<class> @> @<list>}
\end{describe}

\begin{describe}{fun}{c3-cpl @<class> @> @<list>}
\end{describe}

\begin{describe}{fun}{flavors-cpl @<class> @> @<list>}
\end{describe}

\begin{describe}{fun}{python-cpl @<class> @> @<list>}
\end{describe}

\begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
\end{describe}

%%%----- That's all, folks --------------------------------------------------

%%% Local variables:
%%% mode: LaTeX
%%% TeX-master: "sod.tex"
%%% TeX-PDF-mode: t
%%% End:
Commit	Line	Data
756f4928 MW	1	%%% --latex--
	2	%%%
	3	%%% Translation-time metaobjects
	4	%%%
	5	%%% (c) 2015 Straylight/Edgeware
	6	%%%
	7
	8	%%%----- Licensing notice ---------------------------------------------------
	9	%%%
e0808c47	10	%%% This file is part of the Sensible Object Design, an object system for C.
756f4928 MW	11	%%%
	12	%%% SOD is free software; you can redistribute it and/or modify
	13	%%% it under the terms of the GNU General Public License as published by
	14	%%% the Free Software Foundation; either version 2 of the License, or
	15	%%% (at your option) any later version.
	16	%%%
	17	%%% SOD is distributed in the hope that it will be useful,
	18	%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	%%% GNU General Public License for more details.
	21	%%%
	22	%%% You should have received a copy of the GNU General Public License
	23	%%% along with SOD; if not, write to the Free Software Foundation,
	24	%%% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	25
	26	\chapter{Translation-time metaobjects} \label{ch:meta}
	27
	28	%%%--------------------------------------------------------------------------
	29	\section{Base metaobject classes} \label{sec:meta.classes}
	30
	31	\begin{describe}{cls}
020b9e2b MW	32	{sod-class () \\ \ind
	33	\&key \=:name :nick :location :pset \+\\
	34	:superclasses :link :metaclass \\
756f4928	35	:slots :instance-initializers :class-initializers \\
020b9e2b	36	:initargs :initfrags :tearfrags \\
b2983f35	37	:messages :methods}
756f4928 MW	38	\end{describe}
	39
	40	\begin{describe*}
	41	{\dhead{gf}{sod-class-name @<class> @> @<string>}
	42	\dhead{gf}{sod-class-nickname @<class> @> @<string>}
	43	\dhead{gf}{sod-class-direct-superclasses @<class> @> @<list>}
	44	\dhead{gf}{sod-class-chain-link @<class> @> @<class-or-nil>}
	45	\dhead{gf}{sod-class-metaclass @<class> @> @<metaclass>}
	46	\dhead{gf}{sod-class-slots @<class> @> @<list>}
	47	\dhead{gf}{setf (sod-class-slots @<class>) @<list>}
	48	\dhead{gf}{sod-class-instance-initializers @<class> @> @<list>}
	49	\dhead{gf}{setf (sod-class-instance-initializers @<class>) @<list>}
	50	\dhead{gf}{sod-class-class-initializers @<class> @> @<list>}
	51	\dhead{gf}{setf (sod-class-class-initializers @<class>) @<list>}
b2983f35 MW	52	\dhead{gf}{sod-class-initargs @<class> @> @<list>}
b2983f35 MW	53	\dhead{gf}{setf (sod-class-initargs @<class>) @<list>}
a42893dd MW	54	\dhead{gf}{sod-class-initfrags @<class> @> @<list>}
	55	\dhead{gf}{setf (sod-class-initfrags @<class>) @<list>}
	56	\dhead{gf}{sod-class-tearfrags @<class> @> @<list>}
	57	\dhead{gf}{setf (sod-class-tearfrags @<class>) @<list>}
756f4928 MW	58	\dhead{gf}{sod-class-messages @<class> @> @<list>}
	59	\dhead{gf}{setf (sod-class-messages @<class>) @<list>}
	60	\dhead{gf}{sod-class-methods @<class> @> @<list>}
	61	\dhead{gf}{setf (sod-class-methods @<class>) @<list>}}
	62	\end{describe*}
	63
756f4928 MW	64	\begin{describe}{fun}
	65	{make-sod-class @<name> @<superclasses> @<pset> \&optional @<floc>
	66	@> @<class>}
	67	\end{describe}
	68
756f4928 MW	69	\begin{describe*}
	70	{\dhead{lmac}{slot @<name> @<type> @{ @<keyword> @<value> @}^*}
	71	\dhead{lmac}{instance-initializer @<nick> @<name>
	72	@<value-kind> @<value-form>
	73	@{ @<keyword> @<value> @}^*}
	74	\dhead{lmac}{class-initializer @<nick> @<name>
	75	@<value-kind> @<value-form>
	76	@{ @<keyword> @<value> @}^*}
	77	\dhead{lmac}{message @<name> @<type> @{ @<keyword> @<value> @}^*}
	78	\dhead{lmac}{method @<nick> @<name> @<type> @<body>
	79	@{ @<keyword> @<value> @}^*}}
	80	\end{describe*}
	81
	82	\begin{describe}{fun}
	83	{find-superclass-by-nick @<class> @<nick> @> @<superclass>}
	84	\end{describe}
	85
17c7c784 MW	86	\begin{describe}{ty}{inheritance-path-reporter-state}
	87	\end{describe}
	88
	89	\begin{describe}{fun}{make-inheritance-path-reporter-state @> @<state>}
	90	\end{describe}
	91
	92	\begin{describe}{fun}{report-inheritance-path @<state> @<super>}
	93	\end{describe}
	94
756f4928	95	\begin{describe}{fun}
6e92afa7 MW	96	{select-minimal-class-property
	97	\=@<supers> @<key> @<order> @<default> @<what> \\
	98	\>\&key :present :allow-empty
	99	\nlret @<object>}
	100	\end{describe}
	101
73eceea6 MW	102	\begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
	103	\end{describe}
	104
6e92afa7	105	\begin{describe}{fun}
756f4928 MW	106	{sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
	107	\end{describe}
	108
	109	\begin{describe}{fun}{valid-name-p @<name> @> @<generalized-boolean>}
	110	\end{describe}
	111
	112	\begin{describe}{fun}{find-root-superclass @<class> @> @<superclass>}
	113	\end{describe}
	114
	115	\begin{describe}{fun}{find-root-metaclass @<class> @> @<metaclass>}
	116	\end{describe}
	117
	118	\begin{describe}{cls}{sod-slot () \&key :name :location :pset :class :type}
	119	\end{describe}
	120
	121	\begin{describe*}
	122	{\dhead{gf}{sod-slot-name @<slot> @> @<string>}
	123	\dhead{gf}{sod-slot-class @<slot> @> @<class>}
	124	\dhead{gf}{sod-slot-type @<slot> @> @<c-type>}}
	125	\end{describe*}
	126
	127	\begin{describe}{gf}
	128	{make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
	129	@> @<slot>}
	130	\end{describe}
	131
	132	\begin{describe*}
	133	{\dhead{fun}
	134	{find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
	135	@> @<slot>}
	136	\dhead{fun}
	137	{find-class-slot-by-name @<class> @<super-nick> @<slot-name>
	138	@> @<slot>}}
	139	\end{describe*}
	140
756f4928	141	\begin{describe}{cls}
020b9e2b	142	{sod-class-slot (sod-slot) \\ \ind
756f4928 MW	143	\&key :name :location :pset :class :type
	144	:initializer-function :prepare-function}
	145	\end{describe}
	146
	147	\begin{describe*}
	148	{\dhead{gf}{sod-slot-initializer-function @<slot> @> @<function>}
	149	\dhead{gf}{sod-slot-prepare-function @<slot> @> @<function>}}
	150	\end{describe*}
	151
	152	\begin{describe*}
	153	{\dhead{cls}{sod-initializer ()
a888e3ac	154	\&key :slot :location :class :value}
756f4928	155	\dhead{cls}{sod-instance-initializer (sod-initializer)
a888e3ac	156	\&key :slot :location :class :value}
756f4928	157	\dhead{cls}{sod-class-initializer (sod-initializer)
a888e3ac	158	\&key :slot :location :class :value}}
756f4928 MW	159	\end{describe*}
	160
	161	\begin{describe*}
	162	{\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
a888e3ac	163	\dhead{gf}{sod-initializer-value @<init> @> @<fragment>}}
756f4928 MW	164	\end{describe*}
	165
	166	\begin{describe*}
	167	{\dhead{gf}
a888e3ac MW	168	{make-slot-instance-initializer
a888e3ac MW	169	\=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
756f4928 MW	170	\nlret @<init>}
756f4928 MW	171	\dhead{gf}
a888e3ac MW	172	{make-slot-class-initializer
a888e3ac MW	173	\=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
756f4928 MW	174	\nlret @<init>}}
	175	\end{describe*}
	176
	177	\begin{describe}{gf}
a888e3ac MW	178	{make-sod-initializer-using-slot
a888e3ac MW	179	\=@<class> @<slot> @<init-class> @<value> @<pset> \&optional @<floc>
756f4928 MW	180	\nlret @<init>}
	181	\end{describe}
	182
b2983f35 MW	183	\begin{describe}{cls}{sod-initarg () \&key :class :location :name :type}
	184	\end{describe}
	185
	186	\begin{describe*}
	187	{\dhead{gf}{sod-initarg-class @<initarg> @> @<class>}
	188	\dhead{gf}{sod-initarg-name @<initarg> @> @<string>}
	189	\dhead{gf}{sod-initarg-type @<initarg> @> @<c-type>}}
	190	\end{describe*}
	191
	192	\begin{describe}{cls}
	193	{sod-user-initarg (sod-initarg)
	194	\&key :class :location :name :type :default}
	195	\end{describe}
	196
	197	\begin{describe}{gf}
	198	{make-sod-user-initarg @<class> @<name> @<type> @<pset>
	199	\&optional @<default> @<floc>}
	200	\end{describe}
	201
	202	\begin{describe}{gf}{sod-initarg-default @<initarg> @> @<default>}
	203	\end{describe}
	204
	205	\begin{describe}{cls}
	206	{sod-slot-initarg (sod-initarg)
	207	\&key :class :location :name :type :slot}
	208	\end{describe}
	209
	210	\begin{describe}{gf}{sod-initarg-slot @<initarg> @> @<slot>}
	211	\end{describe}
	212
	213	\begin{describe}{gf}
b2983f35 MW	214	{make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
	215	\&optional @<floc>}
	216	\end{describe}
	217
	218	\begin{describe}{gf}
	219	{make-sod-slot-initarg-using-slot @<class> @<name> @<slot> @<pset>
	220	\&optional @<floc>}
	221	\end{describe}
	222
a42893dd MW	223	\begin{describe*}
	224	{\dhead{gf}{make-sod-class-initfrag @<class> @<frag> @<pset>
	225	\&optional @<floc>}
	226	\dhead{gf}{make-sod-class-tearfrag @<class> @<frag> @<pset>
	227	\&optional @<floc>}}
	228	\end{describe*}
	229
756f4928 MW	230	\begin{describe}{cls}{sod-message () \&key :name :location :class :type}
	231	\end{describe}
	232
	233	\begin{describe*}
	234	{\dhead{gf}{sod-message-name @<message> @> @<string>}
	235	\dhead{gf}{sod-message-class @<message> @> @<class>}
	236	\dhead{gf}{sod-message-type @<message> @> @<c-type>}}
	237	\end{describe*}
	238
	239	\begin{describe}{gf}
	240	{make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
	241	@> @<message>}
	242	\end{describe}
	243
	244	\begin{describe}{gf}{check-message-type @<message> @<type>}
	245	\end{describe}
	246
	247	\begin{describe}{fun}
	248	{find-message-by-name @<class> @<super-nick> @<message-name>
	249	@> @<message>}
	250	\end{describe}
	251
	252	\begin{describe}{cls}
	253	{sod-method () \&key :message :location :class :type :body}
	254	\end{describe}
	255
	256	\begin{describe*}
	257	{\dhead{gf}{sod-method-message @<method> @> @<message>}
	258	\dhead{gf}{sod-method-class @<method> @> @<class>}
	259	\dhead{gf}{sod-method-type @<method> @> @<c-type>}
	260	\dhead{gf}{sod-method-body @<method> @> @<fragment-or-nil>}}
	261	\end{describe*}
	262
	263	\begin{describe}{gf}
020b9e2b MW	264	{make-sod-method
	265	\=@<class> @<nick> @<name> @<type> @<body> \+\\
	266	@<pset> \&optional @<floc> \-
756f4928 MW	267	\nlret @<method>}
	268	\end{describe}
	269
	270	\begin{describe}{gf}
020b9e2b MW	271	{make-sod-method-using-message
	272	\=@<message> @<class>
	273	@<type> @<body> \+\\
	274	@<pset> \&optional @<floc> \-
756f4928 MW	275	\nlret @<method>}
	276	\end{describe}
	277
	278	\begin{describe}{gf}
	279	{sod-message-method-class @<message> @<class> @<pset> @> @<method-class>}
	280	\end{describe}
	281
	282	\begin{describe}{gf}{check-method-type @<method> @<message> @<type>}
	283	\end{describe}
	284
	285	\begin{describe}{fun}
	286	{argument-lists-compatible-p @<message-args> @<method-args>
	287	@> @<generalized-boolean>}
	288	\end{describe}
	289
b70cb6d8 MW	290	\begin{describe}{fun}{check-method-return-type @<method-type> @<return-type>}
	291	\end{describe}
	292
	293	\begin{describe}{fun}
	294	{check-method-return-type-against-message @<method-type> @<message-type>}
	295	\end{describe}
	296
	297	\begin{describe}{fun}
	298	{check-method-argument-lists @<method-type> @<message-type>}
	299	\end{describe}
	300
756f4928 MW	301	%%%--------------------------------------------------------------------------
	302	\section{Class finalization protocol} \label{sec:meta.finalization}
	303
e45a106d MW	304	\begin{describe}{mac}
	305	{finalization-error (@<token> @<arg>^*) \\ \ind
	306	@<declaration>^* \\
	307	@<form>^* \-
	308	\nlret @<value>^*}
	309	\end{describe}
	310
	311	\begin{describe}{fun}{finalization-failed}
	312	\end{describe}
	313
756f4928	314	\begin{describe*}
ba07ddc2	315	{\dhead{gf}{sod-class-precedence-list @<class> @> @<list>}
756f4928 MW	316	\dhead{gf}{sod-class-type @<class> @> @<c-type>}
	317	\dhead{gf}{sod-class-chain-head @<class> @> @<class>}
	318	\dhead{gf}{sod-class-chain @<class> @> @<list>}
	319	\dhead{gf}{sod-class-chains @<class> @> @<list>}
	320	\dhead{gf}{sod-class-state @<class> @> @<state>}}
	321	\end{describe*}
	322
	323	\begin{describe}{gf}{compute-cpl @<class> @> @<list>}
	324	\end{describe}
	325
0dca577d MW	326	\begin{describe}{fun}
	327	{report-class-list-merge-error @<class> @<lists> @<error>}
	328	\end{describe}
	329
c05ed0f1	330	\begin{describe}{fun}{merge-class-lists @<class> @<lists> @<pick> @> @<list>}
e2838dc5 MW	331	\end{describe}
e2838dc5 MW	332
756f4928 MW	333	\begin{describe}{gf}{compute-chains @<class> @> @<list>}
	334	\end{describe}
	335
2c0aab07 MW	336	\begin{describe}{gf}{check-class-initializer @<slot> @<class>}
	337	\begin{describe}{meth}
	338	{check-class-initializer (@<slot> effective-slot) (@<class> sod-class)}
	339	\end{describe}
	340	\begin{describe}{meth}
	341	{check-class-initializer (@<slot> sod-class-effective-slot)
	342	(@<class> sod-class)}
	343	\end{describe}
	344	\end{describe}
	345
756f4928 MW	346	\begin{describe}{gf}{check-sod-class @<class>}
	347	\end{describe}
	348
e45a106d	349	\begin{describe}{gf}{finalize-sod-class @<class> @> @<generalized-boolean>}
32bb097f MW	350	\begin{describe}{meth}{finalize-sod-class (@<class> sod-class)}
32bb097f MW	351	\end{describe}
e45a106d MW	352	\begin{describe}{ar-meth}{finalize-sod-class (@<class> sod-class)
e45a106d MW	353	@> @<generalized-boolean>}
32bb097f	354	\end{describe}
756f4928 MW	355	\end{describe}
	356
	357	\begin{describe}{fun}{clos-cpl @<class> @> @<list>}
	358	\end{describe}
	359
	360	\begin{describe}{fun}{dylan-cpl @<class> @> @<list>}
	361	\end{describe}
	362
	363	\begin{describe}{fun}{c3-cpl @<class> @> @<list>}
	364	\end{describe}
	365
	366	\begin{describe}{fun}{flavors-cpl @<class> @> @<list>}
	367	\end{describe}
	368
	369	\begin{describe}{fun}{python-cpl @<class> @> @<list>}
	370	\end{describe}
	371
	372	\begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
	373	\end{describe}
31d4431b	374
756f4928 MW	375	%%%----- That's all, folks --------------------------------------------------
	376
	377	%%% Local variables:
	378	%%% mode: LaTeX
	379	%%% TeX-master: "sod.tex"
	380	%%% TeX-PDF-mode: t
	381	%%% End: