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