3 %%% Translation-time metaobjects
5 %%% (c) 2015 Straylight/Edgeware
8 %%%----- Licensing notice ---------------------------------------------------
10 %%% This file is part of the Sensible Object Design, an object system for C.
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.
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.
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.
26 \chapter{Translation-time metaobjects} \label{ch:meta}
28 %%%--------------------------------------------------------------------------
29 \section{Base metaobject classes} \label{sec:meta.classes}
33 \&key \=:name :nick :location :pset \+ \\
34 :superclasses :link :metaclass \\
35 :slots :instance-initializers :class-initializers \\
36 :initargs :initfrags :tearfrags \\
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>}
52 \dhead{gf}{sod-class-initargs @<class> @> @<list>}
53 \dhead{gf}{setf (sod-class-initargs @<class>) @<list>}
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>}
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>}}
65 {make-sod-class @<name> @<superclasses> @<pset> \&optional @<floc>
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> @}^*}}
83 {find-superclass-by-nick @<class> @<nick> @> @<superclass>}
87 {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
90 \begin{describe}{fun}{valid-name-p @<name> @> @<generalized-boolean>}
93 \begin{describe}{fun}{find-root-superclass @<class> @> @<superclass>}
96 \begin{describe}{fun}{find-root-metaclass @<class> @> @<metaclass>}
99 \begin{describe}{cls}{sod-slot () \&key :name :location :pset :class :type}
103 {\dhead{gf}{sod-slot-name @<slot> @> @<string>}
104 \dhead{gf}{sod-slot-class @<slot> @> @<class>}
105 \dhead{gf}{sod-slot-type @<slot> @> @<c-type>}}
109 {make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
115 {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
118 {find-class-slot-by-name @<class> @<super-nick> @<slot-name>
122 \begin{describe}{fun}
123 {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
127 \begin{describe}{cls}
128 {sod-class-slot (sod-slot) \\ \ind
129 \&key :name :location :pset :class :type
130 :initializer-function :prepare-function}
134 {\dhead{gf}{sod-slot-initializer-function @<slot> @> @<function>}
135 \dhead{gf}{sod-slot-prepare-function @<slot> @> @<function>}}
139 {\dhead{cls}{sod-initializer ()
140 \&key :slot :location :class :value}
141 \dhead{cls}{sod-instance-initializer (sod-initializer)
142 \&key :slot :location :class :value}
143 \dhead{cls}{sod-class-initializer (sod-initializer)
144 \&key :slot :location :class :value}}
148 {\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
149 \dhead{gf}{sod-initializer-value @<init> @> @<fragment>}}
154 {make-slot-instance-initializer
155 \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
158 {make-slot-class-initializer
159 \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
164 {make-sod-initializer-using-slot
165 \=@<class> @<slot> @<init-class> @<value> @<pset> \&optional @<floc>
169 \begin{describe}{cls}{sod-initarg () \&key :class :location :name :type}
173 {\dhead{gf}{sod-initarg-class @<initarg> @> @<class>}
174 \dhead{gf}{sod-initarg-name @<initarg> @> @<string>}
175 \dhead{gf}{sod-initarg-type @<initarg> @> @<c-type>}}
178 \begin{describe}{cls}
179 {sod-user-initarg (sod-initarg)
180 \&key :class :location :name :type :default}
184 {make-sod-user-initarg @<class> @<name> @<type> @<pset>
185 \&optional @<default> @<floc>}
188 \begin{describe}{gf}{sod-initarg-default @<initarg> @> @<default>}
191 \begin{describe}{cls}
192 {sod-slot-initarg (sod-initarg)
193 \&key :class :location :name :type :slot}
196 \begin{describe}{gf}{sod-initarg-slot @<initarg> @> @<slot>}
200 {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
205 {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
210 {make-sod-slot-initarg-using-slot @<class> @<name> @<slot> @<pset>
215 {\dhead{gf}{make-sod-class-initfrag @<class> @<frag> @<pset>
217 \dhead{gf}{make-sod-class-tearfrag @<class> @<frag> @<pset>
221 \begin{describe}{cls}{sod-message () \&key :name :location :class :type}
225 {\dhead{gf}{sod-message-name @<message> @> @<string>}
226 \dhead{gf}{sod-message-class @<message> @> @<class>}
227 \dhead{gf}{sod-message-type @<message> @> @<c-type>}}
231 {make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
235 \begin{describe}{gf}{check-message-type @<message> @<type>}
238 \begin{describe}{fun}
239 {find-message-by-name @<class> @<super-nick> @<message-name>
243 \begin{describe}{cls}
244 {sod-method () \&key :message :location :class :type :body}
248 {\dhead{gf}{sod-method-message @<method> @> @<message>}
249 \dhead{gf}{sod-method-class @<method> @> @<class>}
250 \dhead{gf}{sod-method-type @<method> @> @<c-type>}
251 \dhead{gf}{sod-method-body @<method> @> @<fragment-or-nil>}}
255 {make-sod-method \=@<class> @<nick> @<name> @<type> @<body> \+ \\
256 @<pset> \&optional @<floc> \-
261 {make-sod-method-using-message \=@<message> @<class>
262 @<type> @<body> \+ \\
263 @<pset> \&optional @<floc> \-
268 {sod-message-method-class @<message> @<class> @<pset> @> @<method-class>}
271 \begin{describe}{gf}{check-method-type @<method> @<message> @<type>}
274 \begin{describe}{fun}
275 {argument-lists-compatible-p @<message-args> @<method-args>
276 @> @<generalized-boolean>}
279 \begin{describe}{fun}{check-method-return-type @<method-type> @<return-type>}
282 \begin{describe}{fun}
283 {check-method-return-type-against-message @<method-type> @<message-type>}
286 \begin{describe}{fun}
287 {check-method-argument-lists @<method-type> @<message-type>}
290 %%%--------------------------------------------------------------------------
291 \section{Class finalization protocol} \label{sec:meta.finalization}
294 {\dhead{gf}{sod-class-precedence-list <class> @> @<list>}
295 \dhead{gf}{sod-class-type @<class> @> @<c-type>}
296 \dhead{gf}{sod-class-chain-head @<class> @> @<class>}
297 \dhead{gf}{sod-class-chain @<class> @> @<list>}
298 \dhead{gf}{sod-class-chains @<class> @> @<list>}
299 \dhead{gf}{sod-class-state @<class> @> @<state>}}
302 \begin{describe}{gf}{compute-cpl @<class> @> @<list>}
305 \begin{describe}{gf}{compute-chains @<class> @> @<list>}
308 \begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
311 \begin{describe}{gf}{check-sod-class @<class>}
314 \begin{describe}{gf}{finalize-sod-class @<class>}
317 \begin{describe}{fun}{clos-cpl @<class> @> @<list>}
320 \begin{describe}{fun}{dylan-cpl @<class> @> @<list>}
323 \begin{describe}{fun}{c3-cpl @<class> @> @<list>}
326 \begin{describe}{fun}{flavors-cpl @<class> @> @<list>}
329 \begin{describe}{fun}{python-cpl @<class> @> @<list>}
332 \begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
335 %%%----- That's all, folks --------------------------------------------------
339 %%% TeX-master: "sod.tex"