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 \\
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>
}}
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>
}}
64 \begin{describe
}{gf
}{guess-metaclass @<class> @> @<metaclass>
}
68 {make-sod-class @<name> @<superclasses> @<pset> \&optional @<floc>
73 {define-sod-class @<name> (@<superclass>^*) \\
\ind
74 @
{ @<keyword> @<value> @
}^* \\
80 {\dhead{lmac
}{slot @<name> @<type> @
{ @<keyword> @<value> @
}^*
}
81 \dhead{lmac
}{instance-initializer @<nick> @<name>
82 @<value-kind> @<value-form>
83 @
{ @<keyword> @<value> @
}^*
}
84 \dhead{lmac
}{class-initializer @<nick> @<name>
85 @<value-kind> @<value-form>
86 @
{ @<keyword> @<value> @
}^*
}
87 \dhead{lmac
}{message @<name> @<type> @
{ @<keyword> @<value> @
}^*
}
88 \dhead{lmac
}{method @<nick> @<name> @<type> @<body>
89 @
{ @<keyword> @<value> @
}^*
}}
93 {find-superclass-by-nick @<class> @<nick> @> @<superclass>
}
97 {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>
}
100 \begin{describe
}{fun
}{valid-name-p @<name> @> @<generalized-boolean>
}
103 \begin{describe
}{fun
}{find-root-superclass @<class> @> @<superclass>
}
106 \begin{describe
}{fun
}{find-root-metaclass @<class> @> @<metaclass>
}
109 \begin{describe
}{cls
}{sod-slot () \&key :name :location :pset :class :type
}
113 {\dhead{gf
}{sod-slot-name @<slot> @> @<string>
}
114 \dhead{gf
}{sod-slot-class @<slot> @> @<class>
}
115 \dhead{gf
}{sod-slot-type @<slot> @> @<c-type>
}}
119 {make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
125 {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
128 {find-class-slot-by-name @<class> @<super-nick> @<slot-name>
132 \begin{describe
}{fun
}
133 {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
137 \begin{describe
}{cls
}
138 {sod-class-slot (sod-slot) \\
\ind
139 \&key :name :location :pset :class :type
140 :initializer-function :prepare-function
}
144 {\dhead{gf
}{sod-slot-initializer-function @<slot> @> @<function>
}
145 \dhead{gf
}{sod-slot-prepare-function @<slot> @> @<function>
}}
149 {\dhead{cls
}{sod-initializer ()
150 \&key :slot :location :class :value-kind :value-form
}
151 \dhead{cls
}{sod-instance-initializer (sod-initializer)
152 \&key :slot :location :class :value-kind :value-form
}
153 \dhead{cls
}{sod-class-initializer (sod-initializer)
154 \&key :slot :location :class :value-kind :value-form
}}
158 {\dhead{gf
}{sod-initializer-slot @<init> @> @<slot>
}
159 \dhead{gf
}{sod-initializer-value-kind @<init> @> @<kind>
}
160 \dhead{gf
}{sod-initializer-value-form @<init> @> @<fragment>
}}
165 {make-slot-instance-initializer \=@<class> @<nick> @<name>
166 @<value-kind> @<value-form> \+ \\
167 @<pset> \&optional @<floc> \-
170 {make-slot-class-initializer \=@<class> @<nick> @<name>
171 @<value-kind> @<value-form> \+ \\
172 @<pset> \&optional @<floc> \-
177 {make-sod-initializer-using-slot \=@<class> @<slot> @<init-class>
178 @<value-kind> @<value-form> \+ \\
179 @<pset> \&optional @<floc> \-
183 \begin{describe
}{cls
}{sod-message () \&key :name :location :class :type
}
187 {\dhead{gf
}{sod-message-name @<message> @> @<string>
}
188 \dhead{gf
}{sod-message-class @<message> @> @<class>
}
189 \dhead{gf
}{sod-message-type @<message> @> @<c-type>
}}
193 {make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
197 \begin{describe
}{gf
}{check-message-type @<message> @<type>
}
200 \begin{describe
}{fun
}
201 {find-message-by-name @<class> @<super-nick> @<message-name>
205 \begin{describe
}{cls
}
206 {sod-method () \&key :message :location :class :type :body
}
210 {\dhead{gf
}{sod-method-message @<method> @> @<message>
}
211 \dhead{gf
}{sod-method-class @<method> @> @<class>
}
212 \dhead{gf
}{sod-method-type @<method> @> @<c-type>
}
213 \dhead{gf
}{sod-method-body @<method> @> @<fragment-or-nil>
}}
217 {make-sod-method \=@<class> @<nick> @<name> @<type> @<body> \+ \\
218 @<pset> \&optional @<floc> \-
223 {make-sod-method-using-message \=@<message> @<class>
224 @<type> @<body> \+ \\
225 @<pset> \&optional @<floc> \-
230 {sod-message-method-class @<message> @<class> @<pset> @> @<method-class>
}
233 \begin{describe
}{gf
}{check-method-type @<method> @<message> @<type>
}
236 \begin{describe
}{fun
}
237 {argument-lists-compatible-p @<message-args> @<method-args>
238 @> @<generalized-boolean>
}
241 %%%--------------------------------------------------------------------------
242 \section{Class finalization protocol
} \label{sec:meta.finalization
}
245 {\dhead{gf
}{sod-class-precedence-list <class> @> @<list>
}
246 \dhead{gf
}{sod-class-type @<class> @> @<c-type>
}
247 \dhead{gf
}{sod-class-chain-head @<class> @> @<class>
}
248 \dhead{gf
}{sod-class-chain @<class> @> @<list>
}
249 \dhead{gf
}{sod-class-chains @<class> @> @<list>
}
250 \dhead{gf
}{sod-class-state @<class> @> @<state>
}}
253 \begin{describe
}{gf
}{compute-cpl @<class> @> @<list>
}
256 \begin{describe
}{gf
}{compute-chains @<class> @> @<list>
}
259 \begin{describe
}{gf
}{check-sod-class @<class>
}
262 \begin{describe
}{gf
}{finalize-sod-class @<class>
}
265 \begin{describe
}{fun
}{clos-cpl @<class> @> @<list>
}
268 \begin{describe
}{fun
}{dylan-cpl @<class> @> @<list>
}
271 \begin{describe
}{fun
}{c3-cpl @<class> @> @<list>
}
274 \begin{describe
}{fun
}{flavors-cpl @<class> @> @<list>
}
277 \begin{describe
}{fun
}{python-cpl @<class> @> @<list>
}
280 \begin{describe
}{fun
}{l*loops-cpl @<class> @> @<list>
}
282 %%%----- That's all, folks --------------------------------------------------
286 %%% TeX-master: "sod.tex"