[sod] / doc / layout.tex

%%% -*-latex-*-
%%%
%%% Class layout and method combination protocols
%%%
%%% (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{Class layout and method combination}

%%%--------------------------------------------------------------------------
\section{Class layout protocol} \label{sec:layout.instance}

\begin{describe}{fun}{islots-struct-tag @<class> @> @<string>}
\end{describe}

\begin{describe}{fun}{ichain-struct-tag @<class> @<chain-head> @> @<string>}
\end{describe}

\begin{describe}{fun}{ichain-union-tag @<class> @<chain-head> @> @<string>}
\end{describe}

\begin{describe}{fun}{ilayout-struct-tag @<class> @> @<string>}
\end{describe}

\begin{describe}{fun}{vtmsgs-struct-tag @<class> @<super> @> @<string>}
\end{describe}

\begin{describe}{fun}{vtable-union-tag @<class> @<chain-head> @> @<string>}
\end{describe}

\begin{describe}{fun}{vtable-struct-tag @<class> @<chain-head> @> @<string>}
\end{describe}

\begin{describe}{fun}{vtable-name @<class> @<chain-head> @> @<string>}
\end{describe}

\begin{describe}{fun}{message-macro-name @<class> @<entry> @> @<string>}
\end{describe}

\begin{describe}{cls}{effective-slot () \&key :class :slot :initializer}
\end{describe}

\begin{describe*}
    {\dhead{gf}{effective-slot-class @<slot> @> @<class>}
     \dhead{gf}{effective-slot-direct-slot @<slot> @> @<direct-slot>}
     \dhead{gf}{effective-slot-initializer @<slot> @> @<init-or-nil>}}
\end{describe*}

\begin{describe}{gf}
    {find-slot-initializer @<class> @<slot> @> @<init-or-nil>}
\end{describe}

\begin{describe}{gf}
    {find-class-initializer @<slot> @<class> @> @<init-or-nil>}
\end{describe}

\begin{describe}{gf}{find-slot-initargs @<class> @<slot> @> @<list>}
\end{describe}

\begin{describe}{gf}
    {compute-effective-slot @<class> @<slot> @> @<effective-slot>}
\end{describe}

\begin{describe}{cls}
    {sod-class-effective-slot (effective-slot) \\ \ind
      \&key :class :slot :initializer-function :prepare-function}
\end{describe}

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

\begin{describe}{cls}{islots () \&key :class :subclass :slots}
\end{describe}

\begin{describe*}
    {\dhead{gf}{islots-class @<islots> @> @<class>}
     \dhead{gf}{islots-subclass @<islots> @> @<class>}
     \dhead{gf}{islots-slots @<islots> @> @<list>}}
\end{describe*}

\begin{describe}{gf}{compute-islots @<class> @<subclass> @> @<islots>}
\end{describe}

\begin{describe}{gf}{vtable-pointer () \&key :class :chain-head :chain-tail}
\end{describe}

\begin{describe*}
    {\dhead{gf}{vtable-pointer-class @<vtable-pointer> @> @<class>}
     \dhead{gf}{vtable-pointer-chain-head @<vtable-pointer> @> @<class>}
     \dhead{gf}{vtable-pointer-chain-tail @<vtable-pointer> @> @<class>}}
\end{describe*}

\begin{describe}{gf}{ichain () \&key :class :chain-head :chain-tail :body}
\end{describe}

\begin{describe*}
    {\dhead{gf}{ichain-class @<ichain> @> @<class>}
     \dhead{gf}{ichain-chain-head @<ichain> @> @<class>}
     \dhead{gf}{ichain-chain-tail @<ichain> @> @<class>}
     \dhead{gf}{ichain-body @<ichain> @> @<list>}}
\end{describe*}

\begin{describe}{gf}{compute-ichain @<class> @<chain> @> @<ichain>}
\end{describe}

\begin{describe}{gf}{ilayout () \&key :class :ichains}
\end{describe}

\begin{describe*}
    {\dhead{gf}{ilayout-class @<ilayout> @> @<class>}
     \dhead{gf}{ilayout-ichains @<ilayout> @> @<list>}}
\end{describe*}

\begin{describe}{gf}{sod-class-ilayout @<class> @> @<ilayout>}
\end{describe}

\begin{describe}{gf}{compute-ilayout @<class> @> @<ilayout>}
\end{describe}

\begin{describe}{cls}
    {vtmsgs () \&key :class :subclass :chain-head :chain-tail :entries}
\end{describe}

\begin{describe*}
    {\dhead{gf}{vtmsgs-class @<vtmsgs> @> @<class>}
     \dhead{gf}{vtmsgs-subclass @<vtmsgs> @> @<class>}
     \dhead{gf}{vtmsgs-chain-head @<vtmsgs> @> @<class>}
     \dhead{gf}{vtmsgs-chain-tail @<vtmsgs> @> @<class>}
     \dhead{gf}{vtmsgs-entries @<vtmsgs> @> @<list>}}
\end{describe*}

\begin{describe}{cls}
    {class-pointer () \&key :class :chain-head :metaclass :meta-chain-head}
\end{describe}

\begin{describe*}
    {\dhead{gf}{class-pointer-class @<class-pointer> @> @<class>}
     \dhead{gf}{class-pointer-chain-head @<class-pointer> @> @<class>}
     \dhead{gf}{class-pointer-metaclass @<class-pointer> @> @<class>}
     \dhead{gf}{class-pointer-meta-chain-head @<class-pointer> @> @<class>}}
\end{describe*}

\begin{describe}{fun}
    {make-class-pointer @<class> @<chain-head>
                        @<metaclass> @<meta-chain-head>
      @> @<class-pointer>}
\end{describe}

\begin{describe}{cls}{base-offset () \&key :class :chain-head}
\end{describe}

\begin{describe*}
    {\dhead{gf}{base-offset-class @<base-offset> @> @<class>}
     \dhead{gf}{base-offset-chain-head @<base-offset> @> @<class>}}
\end{describe*}

\begin{describe}{fun}
    {make-base-offset @<class> @<chain-head> @> @<base-offset>}
\end{describe}

\begin{describe}{cls}{chain-offset () \&key :class :chain-head :target-head}
\end{describe}

\begin{describe*}
    {\dhead{gf}{chain-offset-class @<chain-offset> @> @<class>}
     \dhead{gf}{chain-offset-chain-head @<chain-offset> @> @<class>}
     \dhead{gf}{chain-offset-target-head @<chain-offset> @> @<class>}}
\end{describe*}

\begin{describe}{fun}
    {make-chain-offset @<class> @<chain-head> @<target-head>
      @> @<chain-offset>}
\end{describe}

\begin{describe}{gf}{vtable () \&key :class :chain-head :chain-tail :body}
\end{describe}

\begin{describe*}
    {\dhead{gf}{vtable-class @<vtable> @> @<class>}
     \dhead{gf}{vtable-chain-head @<vtable> @> @<class>}
     \dhead{gf}{vtable-chain-tail @<vtable> @> @<class>}
     \dhead{gf}{vtable-body @<vtable> @> @<list>}}
\end{describe*}

\begin{describe}{gf}
    {compute-vtable-items @<class> @<super>
                          @<chain-head> @<chain-tail>
                          @<emit-function>}
\end{describe}

\begin{describe}{gf}{compute-vtable @<class> @<chain> @> @<vtable>}
\end{describe}

\begin{describe}{gf}{sod-class-vtables @<class> @> @<list>}
\end{describe}

\begin{describe}{gf}{compute-vtables @<class> @> @<list>}
\end{describe}

%%%--------------------------------------------------------------------------
\section{Method combination} \label{sec:layout.methods}

\begin{describe}{cls}{effective-method () \&key :message :class :keywords}
\end{describe}

\begin{describe*}
    {\dhead{gf}{effective-method-message @<method> @> @<message>}
     \dhead{gf}{effective-method-class @<method> @> @<class>}
     \dhead{gf}{effective-method-keywords @<method> @> @<list>}}
\end{describe*}

\begin{describe}{gf}
    {sod-message-applicable-methods @<message> @<class> @> list}
\end{describe}

\begin{describe}{gf}
    {sod-message-keyword-argument-lists @<message> @<class>
                                        @<direct-methods> @<state>
      \nlret @<list>}
\end{describe}

\begin{describe}{fun}
    {compute-effective-method-keyword-arguments @<message>
                                                @<class>
                                                @<direct-methods>
      \nlret @<list>}
\end{describe}

\begin{describe}{gf}
    {sod-message-check-methods @<message> @<class> @<direct-methods>}
\end{describe}

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

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

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

\begin{describe}{gf}{sod-class-effective-methods @<class> @> @<list>}
\end{describe}

\begin{describe}{gf}{compute-effective-methods @<class> @> @<list>}
\end{describe}

\begin{describe}{cls}
    {method-entry () \&key :method :chain-head :chain-tail :role}
\end{describe}

\begin{describe*}
    {\dhead{gf}{method-entry-effective-method @<method-entry> @> @<method>}
     \dhead{gf}{method-entry-chain-head @<method-entry> @> @<class>}
     \dhead{gf}{method-entry-chain-tail @<method-entry> @> @<class>}
     \dhead{gf}{method-entry-role @<method-entry> @> @<role>}}
\end{describe*}

\begin{describe}{gf}
    {make-method-entries @<effective-method> @<chain-head> @<chain-tail>
      @> @<list>}
\end{describe}


\begin{describe}{gf}{sod-message-argument-tail @<message> @> @<list>}
\end{describe}

\begin{describe}{gf}{sod-method-function-type @<method> @> @<c-type>}
\end{describe}

\begin{describe}{gf}{sod-method-next-method-type @<method> @> @<c-type>}
\end{describe}

\begin{describe}{gf}{sod-method-description @<method> @> @<string>}
\end{describe}

\begin{describe}{gf}{sod-method-function-name @<method> @> @<string>}
\end{describe}

\begin{describe}{fun}{varargs-message-p @<message> @> @<generalized-boolean>}
\end{describe}

\begin{describe}{fun}{keyword-message-p @<message> @> @<generalized-boolean>}
\end{describe}

\begin{describe}{gf}{method-entry-function-type @<entry> @> @<c-type>}
\end{describe}

\begin{describe}{gf}{method-entry-slot-name @<entry> @> @<string>}
\end{describe}

\begin{describe}{gf}
    {method-entry-slot-name-by-role @<entry> @<role> @<name> @> @<string>}
\end{describe}

\begin{describe}{gf}
    {effective-method-basic-argument-names @<method> @> @<list>}
\end{describe}

\begin{describe}{gf}
    {effective-method-live-p @<method> @> @<generalized-boolean>}
\end{describe}


\begin{describe}{cls}
    {method-codegen (codegen)                                   \\ \ind
      \&key :vars :insts :temp-index
            :message :class :method :target}
\end{describe}

\begin{describe*}
    {\dhead{gf}{codegen-message @<codegen> @> @<message>}
     \dhead{gf}{codegen-class @<codegen> @> @<class>}
     \dhead{gf}{codegen-method @<codegen> @> @<method>}
     \dhead{gf}{codegen-target @<codegen> @> @<target>}}
\end{describe*}

\begin{describe*}
    {\dhead{cls}{convert-to-ilayout-inst (inst)}
     \dhead{fun}
       {make-convert-to-ilayout-inst @<class> @<chain-head> @<expr>}}
  \begin{prog}
    SOD_ILAYOUT(@<class>, @<chain-head-nick>, @<expr>)
  \end{prog}
\end{describe*}


\begin{describe}{gf}
    {compute-effective-method-body @<method> @<codegen> @<target>}
\end{describe}

\begin{describe}{gf}{simple-method-body @<method> @<codegen> @<target>}
\end{describe}

\begin{describe}{fun}
    {invoke-method @<codegen> @<target> @<arguments-tail> @<direct-method>}
\end{describe}

\begin{describe}{fun}{ensure-ilayout-var @<codegen> @<super>}
\end{describe}

\begin{describe}{fun}{make-trampoline @<codegen> @<super> @<body-func>}
\end{describe}

\begin{describe}{gf}{effective-method-function-name @<method> @> @<string>}
\end{describe}

\begin{describe}{gf}
    {method-entry-function-name @<method> @<chain-head> @<role> @> @<string>}
\end{describe}

\begin{describe}{gf}{compute-method-entry-functions @<method> @> @<list>}
\end{describe}

\begin{describe}{fun}
    {invoke-delegation-chain @<codegen> @<target> @<basic-tail>
                             @<chain> @<kernel-func>}
\end{describe}

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

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

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

\begin{describe}{gf}{sod-method-role @<method> @> @<role>}
\end{describe}

\begin{describe}{cls}
    {daemon-direct-method (basic-direct-method)                 \\ \ind
      \&key :message :location :class :type :body :role}
\end{describe}

\begin{describe}{cls}
    {delegating-direct-method (basic-direct-method)             \\ \ind
      \&key :message :location :class :type :body :role}
\end{describe}

\begin{describe}{cls}
    {basic-effective-method (effective-method)                  \\ \ind
      \&key :message :class :around-methods :before-methods :after-methods}
\end{describe}

\begin{describe*}
    {\dhead{gf}
       {effective-method-around-methods @<effective-method> @> @<list>}
     \dhead{gf}
       {effective-method-before-methods @<effective-method> @> @<list>}
     \dhead{gf}
       {effective-method-after-methods @<effective-method> @> @<list>}
     \dhead{gf}{effective-method-functions @<effective-method> @> @<list>}}
\end{describe*}

\begin{describe}{cls}
    {simple-effective-method (basic-effective-method)           \\ \ind
      \&key :message :class
            :around-methods :before-methods :after-methods :primary-methods}
\end{describe}

\begin{describe}{fun}
    {basic-effective-method-body @<codegen> @<target> @<method> @<body>}
\end{describe}

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

\begin{describe}{cls}
    {standard-effective-method (simple-effective-method)        \\ \ind
      \&key :message :class
            :around-methods :before-methods :after-methods :primary-methods}
\end{describe}

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

\begin{describe}{gf}
    {aggregating-message-properties @<message> @<combination> @> @<plist>}
\end{describe}

\begin{describe}{gf}
    {compute-aggregating-message-kernel
      \=@<message> @<combination> @<target>                   \+\\
        @<methods> @<arg-names> \&key}
\end{describe}

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

\begin{describe}{cls}
     {aggregating-effective-method (simple-effective-method)    \\ \ind
      \&key :message :class
            :around-methods :before-methods :after-methods :primary-methods}
\end{describe}

\begin{describe}{mac}
    {define-aggregating-method-combination @<combination>       \\ \ind\ind
        ((@<var-name>^*)
         @[[ :codegen @<codegen-var> @!
             :methods @<methods-var> @]])                     \-\\
      @[[ \=:properties (@{ (@{ @<name> @! (@[@<keyword>@] @<name>) @}
                             @<c-type>
                             @[@<default>
                               @[@<suppliedp-var>@]@]) @}^*) @! \+\\
            :return-type @<c-type> @!                           \\
            :around @<around-func> @!
            :first-method @<first-method-func> @!
            :method @<method-func> @]]}
\end{describe}

%%% the method combination story
%% compute-effective-methods --> compute-sod-effective-method

%% hook-output (basic-effective-method :c)
%%   basic-effective-method.functions
%%     compute-method-entry-functions
%%       compute-effective-method-body
%%
%% compute-effective-method-body (simple-effective-method)
%%   basic-effective-method-body
%%   simple-method-body (standard-effective-method)
%%   simple-method-body (aggregating-effective-method)
%%     message-kernel-function

%%%----- 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	%%% Class layout and method combination protocols
	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{Class layout and method combination}
	27
	28	%%%--------------------------------------------------------------------------
	29	\section{Class layout protocol} \label{sec:layout.instance}
	30
	31	\begin{describe}{fun}{islots-struct-tag @<class> @> @<string>}
	32	\end{describe}
	33
	34	\begin{describe}{fun}{ichain-struct-tag @<class> @<chain-head> @> @<string>}
	35	\end{describe}
	36
	37	\begin{describe}{fun}{ichain-union-tag @<class> @<chain-head> @> @<string>}
	38	\end{describe}
	39
	40	\begin{describe}{fun}{ilayout-struct-tag @<class> @> @<string>}
	41	\end{describe}
	42
	43	\begin{describe}{fun}{vtmsgs-struct-tag @<class> @<super> @> @<string>}
	44	\end{describe}
	45
	46	\begin{describe}{fun}{vtable-union-tag @<class> @<chain-head> @> @<string>}
	47	\end{describe}
	48
	49	\begin{describe}{fun}{vtable-struct-tag @<class> @<chain-head> @> @<string>}
	50	\end{describe}
	51
	52	\begin{describe}{fun}{vtable-name @<class> @<chain-head> @> @<string>}
	53	\end{describe}
	54
	55	\begin{describe}{fun}{message-macro-name @<class> @<entry> @> @<string>}
	56	\end{describe}
	57
	58	\begin{describe}{cls}{effective-slot () \&key :class :slot :initializer}
	59	\end{describe}
	60
	61	\begin{describe*}
	62	{\dhead{gf}{effective-slot-class @<slot> @> @<class>}
	63	\dhead{gf}{effective-slot-direct-slot @<slot> @> @<direct-slot>}
	64	\dhead{gf}{effective-slot-initializer @<slot> @> @<init-or-nil>}}
	65	\end{describe*}
	66
	67	\begin{describe}{gf}
	68	{find-slot-initializer @<class> @<slot> @> @<init-or-nil>}
	69	\end{describe}
	70
7b118f8a MW	71	\begin{describe}{gf}
	72	{find-class-initializer @<slot> @<class> @> @<init-or-nil>}
	73	\end{describe}
	74
b2983f35 MW	75	\begin{describe}{gf}{find-slot-initargs @<class> @<slot> @> @<list>}
	76	\end{describe}
	77
756f4928 MW	78	\begin{describe}{gf}
	79	{compute-effective-slot @<class> @<slot> @> @<effective-slot>}
	80	\end{describe}
	81
	82	\begin{describe}{cls}
	83	{sod-class-effective-slot (effective-slot) \\ \ind
	84	\&key :class :slot :initializer-function :prepare-function}
	85	\end{describe}
	86
	87	\begin{describe*}
	88	{\dhead{gf}{effective-slot-initializer-function @<slot> @> @<function>}
	89	\dhead{gf}{effective-slot-prepare-function @<slot> @> @<function>}}
	90	\end{describe*}
	91
	92	\begin{describe}{cls}{islots () \&key :class :subclass :slots}
	93	\end{describe}
	94
	95	\begin{describe*}
	96	{\dhead{gf}{islots-class @<islots> @> @<class>}
	97	\dhead{gf}{islots-subclass @<islots> @> @<class>}
	98	\dhead{gf}{islots-slots @<islots> @> @<list>}}
	99	\end{describe*}
	100
	101	\begin{describe}{gf}{compute-islots @<class> @<subclass> @> @<islots>}
	102	\end{describe}
	103
	104	\begin{describe}{gf}{vtable-pointer () \&key :class :chain-head :chain-tail}
	105	\end{describe}
	106
	107	\begin{describe*}
	108	{\dhead{gf}{vtable-pointer-class @<vtable-pointer> @> @<class>}
	109	\dhead{gf}{vtable-pointer-chain-head @<vtable-pointer> @> @<class>}
	110	\dhead{gf}{vtable-pointer-chain-tail @<vtable-pointer> @> @<class>}}
	111	\end{describe*}
	112
	113	\begin{describe}{gf}{ichain () \&key :class :chain-head :chain-tail :body}
	114	\end{describe}
	115
	116	\begin{describe*}
	117	{\dhead{gf}{ichain-class @<ichain> @> @<class>}
	118	\dhead{gf}{ichain-chain-head @<ichain> @> @<class>}
	119	\dhead{gf}{ichain-chain-tail @<ichain> @> @<class>}
	120	\dhead{gf}{ichain-body @<ichain> @> @<list>}}
	121	\end{describe*}
	122
	123	\begin{describe}{gf}{compute-ichain @<class> @<chain> @> @<ichain>}
	124	\end{describe}
	125
	126	\begin{describe}{gf}{ilayout () \&key :class :ichains}
	127	\end{describe}
	128
	129	\begin{describe*}
	130	{\dhead{gf}{ilayout-class @<ilayout> @> @<class>}
	131	\dhead{gf}{ilayout-ichains @<ilayout> @> @<list>}}
	132	\end{describe*}
	133
a7011782	134	\begin{describe}{gf}{sod-class-ilayout @<class> @> @<ilayout>}
e6f472d6 MW	135	\end{describe}
e6f472d6 MW	136
756f4928 MW	137	\begin{describe}{gf}{compute-ilayout @<class> @> @<ilayout>}
	138	\end{describe}
	139
	140	\begin{describe}{cls}
	141	{vtmsgs () \&key :class :subclass :chain-head :chain-tail :entries}
	142	\end{describe}
	143
	144	\begin{describe*}
	145	{\dhead{gf}{vtmsgs-class @<vtmsgs> @> @<class>}
	146	\dhead{gf}{vtmsgs-subclass @<vtmsgs> @> @<class>}
	147	\dhead{gf}{vtmsgs-chain-head @<vtmsgs> @> @<class>}
	148	\dhead{gf}{vtmsgs-chain-tail @<vtmsgs> @> @<class>}
	149	\dhead{gf}{vtmsgs-entries @<vtmsgs> @> @<list>}}
	150	\end{describe*}
	151
	152	\begin{describe}{cls}
	153	{class-pointer () \&key :class :chain-head :metaclass :meta-chain-head}
	154	\end{describe}
	155
	156	\begin{describe*}
	157	{\dhead{gf}{class-pointer-class @<class-pointer> @> @<class>}
	158	\dhead{gf}{class-pointer-chain-head @<class-pointer> @> @<class>}
	159	\dhead{gf}{class-pointer-metaclass @<class-pointer> @> @<class>}
	160	\dhead{gf}{class-pointer-meta-chain-head @<class-pointer> @> @<class>}}
	161	\end{describe*}
	162
	163	\begin{describe}{fun}
	164	{make-class-pointer @<class> @<chain-head>
	165	@<metaclass> @<meta-chain-head>
	166	@> @<class-pointer>}
	167	\end{describe}
	168
	169	\begin{describe}{cls}{base-offset () \&key :class :chain-head}
	170	\end{describe}
	171
	172	\begin{describe*}
	173	{\dhead{gf}{base-offset-class @<base-offset> @> @<class>}
	174	\dhead{gf}{base-offset-chain-head @<base-offset> @> @<class>}}
	175	\end{describe*}
	176
	177	\begin{describe}{fun}
	178	{make-base-offset @<class> @<chain-head> @> @<base-offset>}
	179	\end{describe}
	180
	181	\begin{describe}{cls}{chain-offset () \&key :class :chain-head :target-head}
	182	\end{describe}
	183
	184	\begin{describe*}
	185	{\dhead{gf}{chain-offset-class @<chain-offset> @> @<class>}
	186	\dhead{gf}{chain-offset-chain-head @<chain-offset> @> @<class>}
	187	\dhead{gf}{chain-offset-target-head @<chain-offset> @> @<class>}}
	188	\end{describe*}
	189
	190	\begin{describe}{fun}
	191	{make-chain-offset @<class> @<chain-head> @<target-head>
	192	@> @<chain-offset>}
	193	\end{describe}
	194
	195	\begin{describe}{gf}{vtable () \&key :class :chain-head :chain-tail :body}
	196	\end{describe}
	197
	198	\begin{describe*}
	199	{\dhead{gf}{vtable-class @<vtable> @> @<class>}
	200	\dhead{gf}{vtable-chain-head @<vtable> @> @<class>}
201	\dhead{gf}{vtable-chain-tail @<vtable> @> @<class>}
202	\dhead{gf}{vtable-body @<vtable> @> @<list>}}
203	\end{describe*}
204
205	\begin{describe}{gf}
206	{compute-vtable-items @<class> @<super>
207	@<chain-head> @<chain-tail>
208	@<emit-function>}
209	\end{describe}
210
211	\begin{describe}{gf}{compute-vtable @<class> @<chain> @> @<vtable>}
212	\end{describe}
213
e6f472d6 MW	214	\begin{describe}{gf}{sod-class-vtables @<class> @> @<list>}
	215	\end{describe}
	216
756f4928 MW	217	\begin{describe}{gf}{compute-vtables @<class> @> @<list>}
	218	\end{describe}
	219
	220	%%%--------------------------------------------------------------------------
	221	\section{Method combination} \label{sec:layout.methods}
	222
43073476	223	\begin{describe}{cls}{effective-method () \&key :message :class :keywords}
756f4928 MW	224	\end{describe}
	225
	226	\begin{describe*}
	227	{\dhead{gf}{effective-method-message @<method> @> @<message>}
43073476 MW	228	\dhead{gf}{effective-method-class @<method> @> @<class>}
43073476 MW	229	\dhead{gf}{effective-method-keywords @<method> @> @<list>}}
756f4928 MW	230	\end{describe*}
756f4928 MW	231
7f2917d2	232	\begin{describe}{gf}
9c29a20f MW	233	{sod-message-applicable-methods @<message> @<class> @> list}
	234	\end{describe}
	235
	236	\begin{describe}{gf}
1ec06509 MW	237	{sod-message-keyword-argument-lists @<message> @<class>
	238	@<direct-methods> @<state>
	239	\nlret @<list>}
756f4928 MW	240	\end{describe}
756f4928 MW	241
1ec06509 MW	242	\begin{describe}{fun}
	243	{compute-effective-method-keyword-arguments @<message>
	244	@<class>
	245	@<direct-methods>
	246	\nlret @<list>}
756f4928 MW	247	\end{describe}
	248
	249	\begin{describe}{gf}
51af043f MW	250	{sod-message-check-methods @<message> @<class> @<direct-methods>}
	251	\end{describe}
	252
	253	\begin{describe}{gf}
1ec06509 MW	254	{sod-message-effective-method-class @<message> @> @<class>}
	255	\end{describe}
	256
	257	\begin{describe}{gf}{primary-method-class @<message> @> @<class>}
43ce48fd MW	258	\end{describe}
	259
	260	\begin{describe}{gf}
756f4928 MW	261	{compute-sod-effective-method @<message> @<class> @> @<method>}
	262	\end{describe}
	263
e6f472d6 MW	264	\begin{describe}{gf}{sod-class-effective-methods @<class> @> @<list>}
	265	\end{describe}
	266
756f4928 MW	267	\begin{describe}{gf}{compute-effective-methods @<class> @> @<list>}
	268	\end{describe}
	269
	270	\begin{describe}{cls}
	271	{method-entry () \&key :method :chain-head :chain-tail :role}
	272	\end{describe}
	273
	274	\begin{describe*}
	275	{\dhead{gf}{method-entry-effective-method @<method-entry> @> @<method>}
	276	\dhead{gf}{method-entry-chain-head @<method-entry> @> @<class>}
	277	\dhead{gf}{method-entry-chain-tail @<method-entry> @> @<class>}
	278	\dhead{gf}{method-entry-role @<method-entry> @> @<role>}}
	279	\end{describe*}
	280
	281	\begin{describe}{gf}
	282	{make-method-entries @<effective-method> @<chain-head> @<chain-tail>
	283	@> @<list>}
	284	\end{describe}
	285
	286
	287	\begin{describe}{gf}{sod-message-argument-tail @<message> @> @<list>}
	288	\end{describe}
	289
756f4928 MW	290	\begin{describe}{gf}{sod-method-function-type @<method> @> @<c-type>}
	291	\end{describe}
	292
	293	\begin{describe}{gf}{sod-method-next-method-type @<method> @> @<c-type>}
	294	\end{describe}
	295
675b4824 MW	296	\begin{describe}{gf}{sod-method-description @<method> @> @<string>}
	297	\end{describe}
	298
756f4928 MW	299	\begin{describe}{gf}{sod-method-function-name @<method> @> @<string>}
	300	\end{describe}
	301
	302	\begin{describe}{fun}{varargs-message-p @<message> @> @<generalized-boolean>}
	303	\end{describe}
	304
43073476 MW	305	\begin{describe}{fun}{keyword-message-p @<message> @> @<generalized-boolean>}
	306	\end{describe}
	307
756f4928 MW	308	\begin{describe}{gf}{method-entry-function-type @<entry> @> @<c-type>}
	309	\end{describe}
	310
	311	\begin{describe}{gf}{method-entry-slot-name @<entry> @> @<string>}
	312	\end{describe}
	313
	314	\begin{describe}{gf}
	315	{method-entry-slot-name-by-role @<entry> @<role> @<name> @> @<string>}
	316	\end{describe}
	317
	318	\begin{describe}{gf}
	319	{effective-method-basic-argument-names @<method> @> @<list>}
	320	\end{describe}
	321
5135d00a MW	322	\begin{describe}{gf}
	323	{effective-method-live-p @<method> @> @<generalized-boolean>}
	324	\end{describe}
756f4928 MW	325
	326
	327	\begin{describe}{cls}
020b9e2b	328	{method-codegen (codegen) \\ \ind
756f4928 MW	329	\&key :vars :insts :temp-index
	330	:message :class :method :target}
	331	\end{describe}
	332
	333	\begin{describe*}
	334	{\dhead{gf}{codegen-message @<codegen> @> @<message>}
	335	\dhead{gf}{codegen-class @<codegen> @> @<class>}
	336	\dhead{gf}{codegen-method @<codegen> @> @<method>}
	337	\dhead{gf}{codegen-target @<codegen> @> @<target>}}
	338	\end{describe*}
	339
	340	\begin{describe*}
	341	{\dhead{cls}{convert-to-ilayout-inst (inst)}
	342	\dhead{fun}
	343	{make-convert-to-ilayout-inst @<class> @<chain-head> @<expr>}}
	344	\begin{prog}
	345	SOD_ILAYOUT(@<class>, @<chain-head-nick>, @<expr>)
	346	\end{prog}
	347	\end{describe*}
	348
	349
	350	\begin{describe}{gf}
	351	{compute-effective-method-body @<method> @<codegen> @<target>}
	352	\end{describe}
	353
	354	\begin{describe}{gf}{simple-method-body @<method> @<codegen> @<target>}
	355	\end{describe}
	356
	357	\begin{describe}{fun}
	358	{invoke-method @<codegen> @<target> @<arguments-tail> @<direct-method>}
	359	\end{describe}
	360
	361	\begin{describe}{fun}{ensure-ilayout-var @<codegen> @<super>}
	362	\end{describe}
	363
	364	\begin{describe}{fun}{make-trampoline @<codegen> @<super> @<body-func>}
	365	\end{describe}
	366
	367	\begin{describe}{gf}{effective-method-function-name @<method> @> @<string>}
	368	\end{describe}
	369
	370	\begin{describe}{gf}
	371	{method-entry-function-name @<method> @<chain-head> @<role> @> @<string>}
	372	\end{describe}
	373
	374	\begin{describe}{gf}{compute-method-entry-functions @<method> @> @<list>}
	375	\end{describe}
	376
	377	\begin{describe}{fun}
	378	{invoke-delegation-chain @<codegen> @<target> @<basic-tail>
	379	@<chain> @<kernel-func>}
	380	\end{describe}
	381
	382	\begin{describe}{cls}
	383	{basic-message (sod-message) \&key :name :location :class :type}
	384	\end{describe}
	385
	386	\begin{describe}{cls}
	387	{simple-message (basic-message) \&key :name :location :class :type}
	388	\end{describe}
	389
	390	\begin{describe}{cls}
	391	{basic-direct-method (sod-method)
	392	\&key :message :location :class :type :body :role}
393	\end{describe}
394
395	\begin{describe}{gf}{sod-method-role @<method> @> @<role>}
396	\end{describe}
397
398	\begin{describe}{cls}
020b9e2b	399	{daemon-direct-method (basic-direct-method) \\ \ind
756f4928 MW	400	\&key :message :location :class :type :body :role}
	401	\end{describe}
	402
	403	\begin{describe}{cls}
020b9e2b	404	{delegating-direct-method (basic-direct-method) \\ \ind
756f4928 MW	405	\&key :message :location :class :type :body :role}
	406	\end{describe}
	407
	408	\begin{describe}{cls}
020b9e2b	409	{basic-effective-method (effective-method) \\ \ind
756f4928 MW	410	\&key :message :class :around-methods :before-methods :after-methods}
	411	\end{describe}
	412
	413	\begin{describe*}
	414	{\dhead{gf}
	415	{effective-method-around-methods @<effective-method> @> @<list>}
	416	\dhead{gf}
	417	{effective-method-before-methods @<effective-method> @> @<list>}
	418	\dhead{gf}
	419	{effective-method-after-methods @<effective-method> @> @<list>}
	420	\dhead{gf}{effective-method-functions @<effective-method> @> @<list>}}
	421	\end{describe*}
	422
	423	\begin{describe}{cls}
020b9e2b	424	{simple-effective-method (basic-effective-method) \\ \ind
756f4928 MW	425	\&key :message :class
	426	:around-methods :before-methods :after-methods :primary-methods}
	427	\end{describe}
	428
	429	\begin{describe}{fun}
	430	{basic-effective-method-body @<codegen> @<target> @<method> @<body>}
	431	\end{describe}
	432
	433	\begin{describe}{cls}
	434	{standard-message (simple-message) \&key :name :location :class :type}
	435	\end{describe}
	436
	437	\begin{describe}{cls}
020b9e2b	438	{standard-effective-method (simple-effective-method) \\ \ind
756f4928 MW	439	\&key :message :class
	440	:around-methods :before-methods :after-methods :primary-methods}
	441	\end{describe}
	442
	443	\begin{describe}{cls}
	444	{aggregating-message (simple-message)
	445	\&key :name :location :class :type :combination}
	446	\end{describe}
	447
	448	\begin{describe}{gf}
	449	{aggregating-message-properties @<message> @<combination> @> @<plist>}
	450	\end{describe}
	451
	452	\begin{describe}{gf}
	453	{compute-aggregating-message-kernel
020b9e2b	454	\=@<message> @<combination> @<target> \+\\
756f4928 MW	455	@<methods> @<arg-names> \&key}
	456	\end{describe}
	457
	458	\begin{describe}{gf}
	459	{check-aggregating-message-type @<message> @<combination> @<c-type>}
	460	\end{describe}
	461
	462	\begin{describe}{cls}
020b9e2b	463	{aggregating-effective-method (simple-effective-method) \\ \ind
756f4928 MW	464	\&key :message :class
	465	:around-methods :before-methods :after-methods :primary-methods}
	466	\end{describe}
	467
	468	\begin{describe}{mac}
020b9e2b	469	{define-aggregating-method-combination @<combination> \\ \ind\ind
756f4928 MW	470	((@<var-name>^*)
756f4928 MW	471	@[[ :codegen @<codegen-var> @!
020b9e2b	472	:methods @<methods-var> @]]) \-\\
756f4928 MW	473	@[[ \=:properties (@{ (@{ @<name> @! (@[@<keyword>@] @<name>) @}
	474	@<c-type>
	475	@[@<default>
020b9e2b MW	476	@[@<suppliedp-var>@]@]) @}^*) @! \+\\
020b9e2b MW	477	:return-type @<c-type> @! \\
756f4928 MW	478	:around @<around-func> @!
	479	:first-method @<first-method-func> @!
	480	:method @<method-func> @]]}
	481	\end{describe}
	482
	483	%%% the method combination story
	484	%% compute-effective-methods --> compute-sod-effective-method
	485
	486	%% hook-output (basic-effective-method :c)
	487	%% basic-effective-method.functions
	488	%% compute-method-entry-functions
	489	%% compute-effective-method-body
	490	%%
	491	%% compute-effective-method-body (simple-effective-method)
	492	%% basic-effective-method-body
	493	%% simple-method-body (standard-effective-method)
	494	%% simple-method-body (aggregating-effective-method)
	495	%% message-kernel-function
	496
	497	%%%----- That's all, folks --------------------------------------------------
	498
	499	%%% Local variables:
	500	%%% mode: LaTeX
	501	%%% TeX-master: "sod.tex"
	502	%%% TeX-PDF-mode: t
	503	%%% End: