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>
}
86 \begin{describe
}{ty
}{inheritance-path-reporter-state
}
89 \begin{describe
}{fun
}{make-inheritance-path-reporter-state @> @<state>
}
92 \begin{describe
}{fun
}{report-inheritance-path @<state> @<super>
}
96 {select-minimal-class-property
97 \=@<supers> @<key> @<order> @<default> @<what> \\
98 \>\&key :present :allow-empty
102 \begin{describe
}{gf
}{guess-metaclass @<class> @> @<metaclass>
}
105 \begin{describe
}{fun
}
106 {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>
}
109 \begin{describe
}{fun
}{valid-name-p @<name> @> @<generalized-boolean>
}
112 \begin{describe
}{fun
}{find-root-superclass @<class> @> @<superclass>
}
115 \begin{describe
}{fun
}{find-root-metaclass @<class> @> @<metaclass>
}
118 \begin{describe
}{cls
}{sod-slot () \&key :name :location :pset :class :type
}
122 {\dhead{gf
}{sod-slot-name @<slot> @> @<string>
}
123 \dhead{gf
}{sod-slot-class @<slot> @> @<class>
}
124 \dhead{gf
}{sod-slot-type @<slot> @> @<c-type>
}}
128 {make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
134 {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
137 {find-class-slot-by-name @<class> @<super-nick> @<slot-name>
141 \begin{describe
}{fun
}
142 {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
146 \begin{describe
}{cls
}
147 {sod-class-slot (sod-slot) \\
\ind
148 \&key :name :location :pset :class :type
149 :initializer-function :prepare-function
}
153 {\dhead{gf
}{sod-slot-initializer-function @<slot> @> @<function>
}
154 \dhead{gf
}{sod-slot-prepare-function @<slot> @> @<function>
}}
158 {\dhead{cls
}{sod-initializer ()
159 \&key :slot :location :class :value
}
160 \dhead{cls
}{sod-instance-initializer (sod-initializer)
161 \&key :slot :location :class :value
}
162 \dhead{cls
}{sod-class-initializer (sod-initializer)
163 \&key :slot :location :class :value
}}
167 {\dhead{gf
}{sod-initializer-slot @<init> @> @<slot>
}
168 \dhead{gf
}{sod-initializer-value @<init> @> @<fragment>
}}
173 {make-slot-instance-initializer
174 \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
177 {make-slot-class-initializer
178 \=@<class> @<nick> @<name> @<value> @<pset> \&optional @<floc>
183 {make-sod-initializer-using-slot
184 \=@<class> @<slot> @<init-class> @<value> @<pset> \&optional @<floc>
188 \begin{describe
}{cls
}{sod-initarg () \&key :class :location :name :type
}
192 {\dhead{gf
}{sod-initarg-class @<initarg> @> @<class>
}
193 \dhead{gf
}{sod-initarg-name @<initarg> @> @<string>
}
194 \dhead{gf
}{sod-initarg-type @<initarg> @> @<c-type>
}}
197 \begin{describe
}{cls
}
198 {sod-user-initarg (sod-initarg)
199 \&key :class :location :name :type :default
}
203 {make-sod-user-initarg @<class> @<name> @<type> @<pset>
204 \&optional @<default> @<floc>
}
207 \begin{describe
}{gf
}{sod-initarg-default @<initarg> @> @<default>
}
210 \begin{describe
}{cls
}
211 {sod-slot-initarg (sod-initarg)
212 \&key :class :location :name :type :slot
}
215 \begin{describe
}{gf
}{sod-initarg-slot @<initarg> @> @<slot>
}
219 {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
224 {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
229 {make-sod-slot-initarg-using-slot @<class> @<name> @<slot> @<pset>
234 {\dhead{gf
}{make-sod-class-initfrag @<class> @<frag> @<pset>
236 \dhead{gf
}{make-sod-class-tearfrag @<class> @<frag> @<pset>
240 \begin{describe
}{cls
}{sod-message () \&key :name :location :class :type
}
244 {\dhead{gf
}{sod-message-name @<message> @> @<string>
}
245 \dhead{gf
}{sod-message-class @<message> @> @<class>
}
246 \dhead{gf
}{sod-message-type @<message> @> @<c-type>
}}
250 {make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
254 \begin{describe
}{gf
}{check-message-type @<message> @<type>
}
257 \begin{describe
}{fun
}
258 {find-message-by-name @<class> @<super-nick> @<message-name>
262 \begin{describe
}{cls
}
263 {sod-method () \&key :message :location :class :type :body
}
267 {\dhead{gf
}{sod-method-message @<method> @> @<message>
}
268 \dhead{gf
}{sod-method-class @<method> @> @<class>
}
269 \dhead{gf
}{sod-method-type @<method> @> @<c-type>
}
270 \dhead{gf
}{sod-method-body @<method> @> @<fragment-or-nil>
}}
275 \=@<class> @<nick> @<name> @<type> @<body> \+\\
276 @<pset> \&optional @<floc> \-
281 {make-sod-method-using-message
282 \=@<message> @<class>
284 @<pset> \&optional @<floc> \-
289 {sod-message-method-class @<message> @<class> @<pset> @> @<method-class>
}
292 \begin{describe
}{gf
}{check-method-type @<method> @<message> @<type>
}
295 \begin{describe
}{fun
}
296 {argument-lists-compatible-p @<message-args> @<method-args>
297 @> @<generalized-boolean>
}
300 \begin{describe
}{fun
}{check-method-return-type @<method-type> @<return-type>
}
303 \begin{describe
}{fun
}
304 {check-method-return-type-against-message @<method-type> @<message-type>
}
307 \begin{describe
}{fun
}
308 {check-method-argument-lists @<method-type> @<message-type>
}
311 %%%--------------------------------------------------------------------------
312 \section{Class finalization protocol
} \label{sec:meta.finalization
}
314 \begin{describe
}{mac
}
315 {finalization-error (@<token> @<arg>^*) \\
\ind
321 \begin{describe
}{fun
}{finalization-failed
}
325 {\dhead{gf
}{sod-class-precedence-list @<class> @> @<list>
}
326 \dhead{gf
}{sod-class-type @<class> @> @<c-type>
}
327 \dhead{gf
}{sod-class-chain-head @<class> @> @<class>
}
328 \dhead{gf
}{sod-class-chain @<class> @> @<list>
}
329 \dhead{gf
}{sod-class-chains @<class> @> @<list>
}
330 \dhead{gf
}{sod-class-state @<class> @> @<state>
}}
333 \begin{describe
}{gf
}{compute-cpl @<class> @> @<list>
}
336 \begin{describe
}{fun
}
337 {report-class-list-merge-error @<class> @<lists> @<error>
}
340 \begin{describe
}{fun
}{merge-class-lists @<class> @<lists> @<pick> @> @<list>
}
343 \begin{describe
}{gf
}{compute-chains @<class> @> @<list>
}
346 \begin{describe
}{gf
}{check-class-initializer @<slot> @<class>
}
347 \begin{describe
}{meth
}
348 {check-class-initializer (@<slot> effective-slot) (@<class> sod-class)
}
350 \begin{describe
}{meth
}
351 {check-class-initializer (@<slot> sod-class-effective-slot)
352 (@<class> sod-class)
}
356 \begin{describe
}{gf
}{check-sod-class @<class>
}
359 \begin{describe
}{gf
}{finalize-sod-class @<class> @> @<generalized-boolean>
}
360 \begin{describe
}{meth
}{finalize-sod-class (@<class> sod-class)
}
362 \begin{describe
}{ar-meth
}{finalize-sod-class (@<class> sod-class)
363 @> @<generalized-boolean>
}
367 \begin{describe
}{fun
}{clos-cpl @<class> @> @<list>
}
370 \begin{describe
}{fun
}{dylan-cpl @<class> @> @<list>
}
373 \begin{describe
}{fun
}{c3-cpl @<class> @> @<list>
}
376 \begin{describe
}{fun
}{flavors-cpl @<class> @> @<list>
}
379 \begin{describe
}{fun
}{python-cpl @<class> @> @<list>
}
382 \begin{describe
}{fun
}{l*loops-cpl @<class> @> @<list>
}
385 %%%----- That's all, folks --------------------------------------------------
389 %%% TeX-master: "sod.tex"