[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 \\
              :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-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>
      @> @<class>}
\end{describe}

\begin{describe}{mac}
    {define-sod-class @<name> (@<superclass>^*) \\ \ind
      @{ @<keyword> @<value> @}^* \\
      @<declaration>^* \\
      @<form>^*}
\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}{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}{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
            :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-kind :value-form}
     \dhead{cls}{sod-instance-initializer (sod-initializer)
       \&key :slot :location :class :value-kind :value-form}
     \dhead{cls}{sod-class-initializer (sod-initializer)
       \&key :slot :location :class :value-kind :value-form}}
\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>}}
\end{describe*}

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

\begin{describe}{gf}
    {make-sod-initializer-using-slot \=@<class> @<slot> @<init-class>
                                       @<value-kind> @<value-form> \+ \\
                                       @<pset> \&optional @<floc> \-
      \nlret @<init>}
\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}

%%%--------------------------------------------------------------------------
\section{Class finalization protocol} \label{sec:meta.finalization}

\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}{gf}{compute-chains @<class> @> @<list>}
\end{describe}

\begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
\end{describe}

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

\begin{describe}{gf}{finalize-sod-class @<class>}
\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}
	32	{sod-class () \\ \ind
	33	\&key \=:name :nick :location :pset \+ \\
	34	:superclasses :link :metaclass \\
	35	:slots :instance-initializers :class-initializers \\
	36	:messages :methods}
	37	\end{describe}
	38
	39	\begin{describe*}
	40	{\dhead{gf}{sod-class-name @<class> @> @<string>}
	41	\dhead{gf}{sod-class-nickname @<class> @> @<string>}
	42	\dhead{gf}{sod-class-direct-superclasses @<class> @> @<list>}
	43	\dhead{gf}{sod-class-chain-link @<class> @> @<class-or-nil>}
	44	\dhead{gf}{sod-class-metaclass @<class> @> @<metaclass>}
	45	\dhead{gf}{sod-class-slots @<class> @> @<list>}
	46	\dhead{gf}{setf (sod-class-slots @<class>) @<list>}
	47	\dhead{gf}{sod-class-instance-initializers @<class> @> @<list>}
	48	\dhead{gf}{setf (sod-class-instance-initializers @<class>) @<list>}
	49	\dhead{gf}{sod-class-class-initializers @<class> @> @<list>}
	50	\dhead{gf}{setf (sod-class-class-initializers @<class>) @<list>}
	51	\dhead{gf}{sod-class-messages @<class> @> @<list>}
	52	\dhead{gf}{setf (sod-class-messages @<class>) @<list>}
	53	\dhead{gf}{sod-class-methods @<class> @> @<list>}
	54	\dhead{gf}{setf (sod-class-methods @<class>) @<list>}}
	55	\end{describe*}
	56
	57	%% layout protocol
	58	\begin{describe*}
	59	{\dhead{gf}{sod-class-ilayout <class> @> @<ilayout>}
	60	\dhead{gf}{sod-class-effective-methods @<class> @> @<list>}
	61	\dhead{gf}{sod-class-vtables @<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
	69	\begin{describe}{mac}
	70	{define-sod-class @<name> (@<superclass>^*) \\ \ind
	71	@{ @<keyword> @<value> @}^* \\
	72	@<declaration>^* \\
	73	@<form>^*}
	74	\end{describe}
	75
	76	\begin{describe*}
	77	{\dhead{lmac}{slot @<name> @<type> @{ @<keyword> @<value> @}^*}
	78	\dhead{lmac}{instance-initializer @<nick> @<name>
	79	@<value-kind> @<value-form>
	80	@{ @<keyword> @<value> @}^*}
	81	\dhead{lmac}{class-initializer @<nick> @<name>
	82	@<value-kind> @<value-form>
	83	@{ @<keyword> @<value> @}^*}
	84	\dhead{lmac}{message @<name> @<type> @{ @<keyword> @<value> @}^*}
	85	\dhead{lmac}{method @<nick> @<name> @<type> @<body>
	86	@{ @<keyword> @<value> @}^*}}
	87	\end{describe*}
	88
	89	\begin{describe}{fun}
	90	{find-superclass-by-nick @<class> @<nick> @> @<superclass>}
	91	\end{describe}
	92
	93	\begin{describe}{fun}
	94	{sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
	95	\end{describe}
	96
	97	\begin{describe}{fun}{valid-name-p @<name> @> @<generalized-boolean>}
	98	\end{describe}
	99
	100	\begin{describe}{fun}{find-root-superclass @<class> @> @<superclass>}
	101	\end{describe}
	102
	103	\begin{describe}{fun}{find-root-metaclass @<class> @> @<metaclass>}
	104	\end{describe}
	105
	106	\begin{describe}{cls}{sod-slot () \&key :name :location :pset :class :type}
	107	\end{describe}
	108
	109	\begin{describe*}
	110	{\dhead{gf}{sod-slot-name @<slot> @> @<string>}
	111	\dhead{gf}{sod-slot-class @<slot> @> @<class>}
	112	\dhead{gf}{sod-slot-type @<slot> @> @<c-type>}}
	113	\end{describe*}
	114
	115	\begin{describe}{gf}
	116	{make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
	117	@> @<slot>}
	118	\end{describe}
	119
	120	\begin{describe*}
	121	{\dhead{fun}
	122	{find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
	123	@> @<slot>}
	124	\dhead{fun}
	125	{find-class-slot-by-name @<class> @<super-nick> @<slot-name>
	126	@> @<slot>}}
	127	\end{describe*}
128
129	\begin{describe}{fun}
130	{find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
131	@> @<slot>}
132	\end{describe}
133
134	\begin{describe}{cls}
135	{sod-class-slot (sod-slot) \\ \ind
136	\&key :name :location :pset :class :type
137	:initializer-function :prepare-function}
138	\end{describe}
139
140	\begin{describe*}
141	{\dhead{gf}{sod-slot-initializer-function @<slot> @> @<function>}
142	\dhead{gf}{sod-slot-prepare-function @<slot> @> @<function>}}
143	\end{describe*}
144
145	\begin{describe*}
146	{\dhead{cls}{sod-initializer ()
147	\&key :slot :location :class :value-kind :value-form}
148	\dhead{cls}{sod-instance-initializer (sod-initializer)
149	\&key :slot :location :class :value-kind :value-form}
150	\dhead{cls}{sod-class-initializer (sod-initializer)
151	\&key :slot :location :class :value-kind :value-form}}
152	\end{describe*}
153
154	\begin{describe*}
155	{\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
156	\dhead{gf}{sod-initializer-value-kind @<init> @> @<kind>}
157	\dhead{gf}{sod-initializer-value-form @<init> @> @<fragment>}}
158	\end{describe*}
159
160	\begin{describe*}
161	{\dhead{gf}
162	{make-slot-instance-initializer \=@<class> @<nick> @<name>
163	@<value-kind> @<value-form> \+ \\
164	@<pset> \&optional @<floc> \-
165	\nlret @<init>}
166	\dhead{gf}
167	{make-slot-class-initializer \=@<class> @<nick> @<name>
168	@<value-kind> @<value-form> \+ \\
169	@<pset> \&optional @<floc> \-
170	\nlret @<init>}}
171	\end{describe*}
172
173	\begin{describe}{gf}
174	{make-sod-initializer-using-slot \=@<class> @<slot> @<init-class>
175	@<value-kind> @<value-form> \+ \\
176	@<pset> \&optional @<floc> \-
177	\nlret @<init>}
178	\end{describe}
179
180	\begin{describe}{cls}{sod-message () \&key :name :location :class :type}
181	\end{describe}
182
183	\begin{describe*}
184	{\dhead{gf}{sod-message-name @<message> @> @<string>}
185	\dhead{gf}{sod-message-class @<message> @> @<class>}
186	\dhead{gf}{sod-message-type @<message> @> @<c-type>}}
187	\end{describe*}
188
189	\begin{describe}{gf}
190	{make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
191	@> @<message>}
192	\end{describe}
193
194	\begin{describe}{gf}{check-message-type @<message> @<type>}
195	\end{describe}
196
197	\begin{describe}{fun}
198	{find-message-by-name @<class> @<super-nick> @<message-name>
199	@> @<message>}
200	\end{describe}
201
202	\begin{describe}{cls}
203	{sod-method () \&key :message :location :class :type :body}
204	\end{describe}
205
206	\begin{describe*}
207	{\dhead{gf}{sod-method-message @<method> @> @<message>}
208	\dhead{gf}{sod-method-class @<method> @> @<class>}
209	\dhead{gf}{sod-method-type @<method> @> @<c-type>}
210	\dhead{gf}{sod-method-body @<method> @> @<fragment-or-nil>}}
211	\end{describe*}
212
213	\begin{describe}{gf}
214	{make-sod-method \=@<class> @<nick> @<name> @<type> @<body> \+ \\
215	@<pset> \&optional @<floc> \-
216	\nlret @<method>}
217	\end{describe}
218
219	\begin{describe}{gf}
220	{make-sod-method-using-message \=@<message> @<class>
221	@<type> @<body> \+ \\
222	@<pset> \&optional @<floc> \-
223	\nlret @<method>}
224	\end{describe}
225
226	\begin{describe}{gf}
227	{sod-message-method-class @<message> @<class> @<pset> @> @<method-class>}
228	\end{describe}
229
230	\begin{describe}{gf}{check-method-type @<method> @<message> @<type>}
231	\end{describe}
232
233	\begin{describe}{fun}
234	{argument-lists-compatible-p @<message-args> @<method-args>
235	@> @<generalized-boolean>}
236	\end{describe}
237
238	%%%--------------------------------------------------------------------------
239	\section{Class finalization protocol} \label{sec:meta.finalization}
240
241	\begin{describe*}
242	{\dhead{gf}{sod-class-precedence-list <class> @> @<list>}
243	\dhead{gf}{sod-class-type @<class> @> @<c-type>}
244	\dhead{gf}{sod-class-chain-head @<class> @> @<class>}
245	\dhead{gf}{sod-class-chain @<class> @> @<list>}
246	\dhead{gf}{sod-class-chains @<class> @> @<list>}
247	\dhead{gf}{sod-class-state @<class> @> @<state>}}
248	\end{describe*}
249
250	\begin{describe}{gf}{compute-cpl @<class> @> @<list>}
251	\end{describe}
252
253	\begin{describe}{gf}{compute-chains @<class> @> @<list>}
254	\end{describe}
255
981b6fb6 MW	256	\begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
	257	\end{describe}
	258
756f4928 MW	259	\begin{describe}{gf}{check-sod-class @<class>}
	260	\end{describe}
	261
	262	\begin{describe}{gf}{finalize-sod-class @<class>}
	263	\end{describe}
	264
	265	\begin{describe}{fun}{clos-cpl @<class> @> @<list>}
	266	\end{describe}
	267
	268	\begin{describe}{fun}{dylan-cpl @<class> @> @<list>}
	269	\end{describe}
	270
	271	\begin{describe}{fun}{c3-cpl @<class> @> @<list>}
	272	\end{describe}
	273
	274	\begin{describe}{fun}{flavors-cpl @<class> @> @<list>}
	275	\end{describe}
	276
	277	\begin{describe}{fun}{python-cpl @<class> @> @<list>}
	278	\end{describe}
	279
	280	\begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
	281	\end{describe}
	282	%%%----- That's all, folks --------------------------------------------------
	283
	284	%%% Local variables:
	285	%%% mode: LaTeX
	286	%%% TeX-master: "sod.tex"
	287	%%% TeX-PDF-mode: t
	288	%%% End: