Commit | Line | Data |
---|---|---|
756f4928 MW |
1 | %%% -*-latex-*- |
2 | %%% | |
3 | %%% Class layout and method combination protocols | |
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{Class layout and method combination} | |
27 | ||
28 | %%%-------------------------------------------------------------------------- | |
29 | \section{Class layout protocol} \label{sec:layout.instance} | |
30 | ||
31 | \begin{describe}{fun}{islots-struct-tag @<class> @> @<string>} | |
32 | \end{describe} | |
33 | ||
34 | \begin{describe}{fun}{ichain-struct-tag @<class> @<chain-head> @> @<string>} | |
35 | \end{describe} | |
36 | ||
37 | \begin{describe}{fun}{ichain-union-tag @<class> @<chain-head> @> @<string>} | |
38 | \end{describe} | |
39 | ||
40 | \begin{describe}{fun}{ilayout-struct-tag @<class> @> @<string>} | |
41 | \end{describe} | |
42 | ||
43 | \begin{describe}{fun}{vtmsgs-struct-tag @<class> @<super> @> @<string>} | |
44 | \end{describe} | |
45 | ||
46 | \begin{describe}{fun}{vtable-union-tag @<class> @<chain-head> @> @<string>} | |
47 | \end{describe} | |
48 | ||
49 | \begin{describe}{fun}{vtable-struct-tag @<class> @<chain-head> @> @<string>} | |
50 | \end{describe} | |
51 | ||
52 | \begin{describe}{fun}{vtable-name @<class> @<chain-head> @> @<string>} | |
53 | \end{describe} | |
54 | ||
55 | \begin{describe}{fun}{message-macro-name @<class> @<entry> @> @<string>} | |
56 | \end{describe} | |
57 | ||
58 | \begin{describe}{cls}{effective-slot () \&key :class :slot :initializer} | |
59 | \end{describe} | |
60 | ||
61 | \begin{describe*} | |
62 | {\dhead{gf}{effective-slot-class @<slot> @> @<class>} | |
63 | \dhead{gf}{effective-slot-direct-slot @<slot> @> @<direct-slot>} | |
64 | \dhead{gf}{effective-slot-initializer @<slot> @> @<init-or-nil>}} | |
65 | \end{describe*} | |
66 | ||
67 | \begin{describe}{gf} | |
68 | {find-slot-initializer @<class> @<slot> @> @<init-or-nil>} | |
69 | \end{describe} | |
70 | ||
71 | \begin{describe}{gf} | |
72 | {compute-effective-slot @<class> @<slot> @> @<effective-slot>} | |
73 | \end{describe} | |
74 | ||
75 | \begin{describe}{cls} | |
76 | {sod-class-effective-slot (effective-slot) \\ \ind | |
77 | \&key :class :slot :initializer-function :prepare-function} | |
78 | \end{describe} | |
79 | ||
80 | \begin{describe*} | |
81 | {\dhead{gf}{effective-slot-initializer-function @<slot> @> @<function>} | |
82 | \dhead{gf}{effective-slot-prepare-function @<slot> @> @<function>}} | |
83 | \end{describe*} | |
84 | ||
85 | \begin{describe}{cls}{islots () \&key :class :subclass :slots} | |
86 | \end{describe} | |
87 | ||
88 | \begin{describe*} | |
89 | {\dhead{gf}{islots-class @<islots> @> @<class>} | |
90 | \dhead{gf}{islots-subclass @<islots> @> @<class>} | |
91 | \dhead{gf}{islots-slots @<islots> @> @<list>}} | |
92 | \end{describe*} | |
93 | ||
94 | \begin{describe}{gf}{compute-islots @<class> @<subclass> @> @<islots>} | |
95 | \end{describe} | |
96 | ||
97 | \begin{describe}{gf}{vtable-pointer () \&key :class :chain-head :chain-tail} | |
98 | \end{describe} | |
99 | ||
100 | \begin{describe*} | |
101 | {\dhead{gf}{vtable-pointer-class @<vtable-pointer> @> @<class>} | |
102 | \dhead{gf}{vtable-pointer-chain-head @<vtable-pointer> @> @<class>} | |
103 | \dhead{gf}{vtable-pointer-chain-tail @<vtable-pointer> @> @<class>}} | |
104 | \end{describe*} | |
105 | ||
106 | \begin{describe}{gf}{ichain () \&key :class :chain-head :chain-tail :body} | |
107 | \end{describe} | |
108 | ||
109 | \begin{describe*} | |
110 | {\dhead{gf}{ichain-class @<ichain> @> @<class>} | |
111 | \dhead{gf}{ichain-chain-head @<ichain> @> @<class>} | |
112 | \dhead{gf}{ichain-chain-tail @<ichain> @> @<class>} | |
113 | \dhead{gf}{ichain-body @<ichain> @> @<list>}} | |
114 | \end{describe*} | |
115 | ||
116 | \begin{describe}{gf}{compute-ichain @<class> @<chain> @> @<ichain>} | |
117 | \end{describe} | |
118 | ||
119 | \begin{describe}{gf}{ilayout () \&key :class :ichains} | |
120 | \end{describe} | |
121 | ||
122 | \begin{describe*} | |
123 | {\dhead{gf}{ilayout-class @<ilayout> @> @<class>} | |
124 | \dhead{gf}{ilayout-ichains @<ilayout> @> @<list>}} | |
125 | \end{describe*} | |
126 | ||
e6f472d6 MW |
127 | \begin{describe}{gf}{sod-class-ilayout <class> @> @<ilayout>} |
128 | \end{describe} | |
129 | ||
756f4928 MW |
130 | \begin{describe}{gf}{compute-ilayout @<class> @> @<ilayout>} |
131 | \end{describe} | |
132 | ||
133 | \begin{describe}{cls} | |
134 | {vtmsgs () \&key :class :subclass :chain-head :chain-tail :entries} | |
135 | \end{describe} | |
136 | ||
137 | \begin{describe*} | |
138 | {\dhead{gf}{vtmsgs-class @<vtmsgs> @> @<class>} | |
139 | \dhead{gf}{vtmsgs-subclass @<vtmsgs> @> @<class>} | |
140 | \dhead{gf}{vtmsgs-chain-head @<vtmsgs> @> @<class>} | |
141 | \dhead{gf}{vtmsgs-chain-tail @<vtmsgs> @> @<class>} | |
142 | \dhead{gf}{vtmsgs-entries @<vtmsgs> @> @<list>}} | |
143 | \end{describe*} | |
144 | ||
145 | \begin{describe}{cls} | |
146 | {class-pointer () \&key :class :chain-head :metaclass :meta-chain-head} | |
147 | \end{describe} | |
148 | ||
149 | \begin{describe*} | |
150 | {\dhead{gf}{class-pointer-class @<class-pointer> @> @<class>} | |
151 | \dhead{gf}{class-pointer-chain-head @<class-pointer> @> @<class>} | |
152 | \dhead{gf}{class-pointer-metaclass @<class-pointer> @> @<class>} | |
153 | \dhead{gf}{class-pointer-meta-chain-head @<class-pointer> @> @<class>}} | |
154 | \end{describe*} | |
155 | ||
156 | \begin{describe}{fun} | |
157 | {make-class-pointer @<class> @<chain-head> | |
158 | @<metaclass> @<meta-chain-head> | |
159 | @> @<class-pointer>} | |
160 | \end{describe} | |
161 | ||
162 | \begin{describe}{cls}{base-offset () \&key :class :chain-head} | |
163 | \end{describe} | |
164 | ||
165 | \begin{describe*} | |
166 | {\dhead{gf}{base-offset-class @<base-offset> @> @<class>} | |
167 | \dhead{gf}{base-offset-chain-head @<base-offset> @> @<class>}} | |
168 | \end{describe*} | |
169 | ||
170 | \begin{describe}{fun} | |
171 | {make-base-offset @<class> @<chain-head> @> @<base-offset>} | |
172 | \end{describe} | |
173 | ||
174 | \begin{describe}{cls}{chain-offset () \&key :class :chain-head :target-head} | |
175 | \end{describe} | |
176 | ||
177 | \begin{describe*} | |
178 | {\dhead{gf}{chain-offset-class @<chain-offset> @> @<class>} | |
179 | \dhead{gf}{chain-offset-chain-head @<chain-offset> @> @<class>} | |
180 | \dhead{gf}{chain-offset-target-head @<chain-offset> @> @<class>}} | |
181 | \end{describe*} | |
182 | ||
183 | \begin{describe}{fun} | |
184 | {make-chain-offset @<class> @<chain-head> @<target-head> | |
185 | @> @<chain-offset>} | |
186 | \end{describe} | |
187 | ||
188 | \begin{describe}{gf}{vtable () \&key :class :chain-head :chain-tail :body} | |
189 | \end{describe} | |
190 | ||
191 | \begin{describe*} | |
192 | {\dhead{gf}{vtable-class @<vtable> @> @<class>} | |
193 | \dhead{gf}{vtable-chain-head @<vtable> @> @<class>} | |
194 | \dhead{gf}{vtable-chain-tail @<vtable> @> @<class>} | |
195 | \dhead{gf}{vtable-body @<vtable> @> @<list>}} | |
196 | \end{describe*} | |
197 | ||
198 | \begin{describe}{gf} | |
199 | {compute-vtable-items @<class> @<super> | |
200 | @<chain-head> @<chain-tail> | |
201 | @<emit-function>} | |
202 | \end{describe} | |
203 | ||
204 | \begin{describe}{gf}{compute-vtable @<class> @<chain> @> @<vtable>} | |
205 | \end{describe} | |
206 | ||
e6f472d6 MW |
207 | \begin{describe}{gf}{sod-class-vtables @<class> @> @<list>} |
208 | \end{describe} | |
209 | ||
756f4928 MW |
210 | \begin{describe}{gf}{compute-vtables @<class> @> @<list>} |
211 | \end{describe} | |
212 | ||
213 | %%%-------------------------------------------------------------------------- | |
214 | \section{Method combination} \label{sec:layout.methods} | |
215 | ||
216 | \begin{describe}{cls}{effective-method () \&key :message :class} | |
217 | \end{describe} | |
218 | ||
219 | \begin{describe*} | |
220 | {\dhead{gf}{effective-method-message @<method> @> @<message>} | |
221 | \dhead{gf}{effective-method-class @<method> @> @<class>}} | |
222 | \end{describe*} | |
223 | ||
7f2917d2 MW |
224 | \begin{describe}{gf} |
225 | {sod-message-effective-method-class @<message> @> @<class>} | |
756f4928 MW |
226 | \end{describe} |
227 | ||
228 | \begin{describe}{gf}{primary-method-class @<message> @> @<class>} | |
229 | \end{describe} | |
230 | ||
231 | \begin{describe}{gf} | |
232 | {compute-sod-effective-method @<message> @<class> @> @<method>} | |
233 | \end{describe} | |
234 | ||
e6f472d6 MW |
235 | \begin{describe}{gf}{sod-class-effective-methods @<class> @> @<list>} |
236 | \end{describe} | |
237 | ||
756f4928 MW |
238 | \begin{describe}{gf}{compute-effective-methods @<class> @> @<list>} |
239 | \end{describe} | |
240 | ||
241 | \begin{describe}{cls} | |
242 | {method-entry () \&key :method :chain-head :chain-tail :role} | |
243 | \end{describe} | |
244 | ||
245 | \begin{describe*} | |
246 | {\dhead{gf}{method-entry-effective-method @<method-entry> @> @<method>} | |
247 | \dhead{gf}{method-entry-chain-head @<method-entry> @> @<class>} | |
248 | \dhead{gf}{method-entry-chain-tail @<method-entry> @> @<class>} | |
249 | \dhead{gf}{method-entry-role @<method-entry> @> @<role>}} | |
250 | \end{describe*} | |
251 | ||
252 | \begin{describe}{gf} | |
253 | {make-method-entries @<effective-method> @<chain-head> @<chain-tail> | |
254 | @> @<list>} | |
255 | \end{describe} | |
256 | ||
257 | ||
258 | \begin{describe}{gf}{sod-message-argument-tail @<message> @> @<list>} | |
259 | \end{describe} | |
260 | ||
261 | \begin{describe}{gf}{sod-message-no-varargs-tail @<message> @> @<list>} | |
262 | \end{describe} | |
263 | ||
264 | \begin{describe}{gf}{sod-method-function-type @<method> @> @<c-type>} | |
265 | \end{describe} | |
266 | ||
267 | \begin{describe}{gf}{sod-method-next-method-type @<method> @> @<c-type>} | |
268 | \end{describe} | |
269 | ||
270 | \begin{describe}{gf}{sod-method-function-name @<method> @> @<string>} | |
271 | \end{describe} | |
272 | ||
273 | \begin{describe}{fun}{varargs-message-p @<message> @> @<generalized-boolean>} | |
274 | \end{describe} | |
275 | ||
276 | \begin{describe}{gf}{method-entry-function-type @<entry> @> @<c-type>} | |
277 | \end{describe} | |
278 | ||
279 | \begin{describe}{gf}{method-entry-slot-name @<entry> @> @<string>} | |
280 | \end{describe} | |
281 | ||
282 | \begin{describe}{gf} | |
283 | {method-entry-slot-name-by-role @<entry> @<role> @<name> @> @<string>} | |
284 | \end{describe} | |
285 | ||
286 | \begin{describe}{gf} | |
287 | {effective-method-basic-argument-names @<method> @> @<list>} | |
288 | \end{describe} | |
289 | ||
290 | ||
291 | ||
292 | \begin{describe}{cls} | |
293 | {method-codegen (codegen) \\ \ind | |
294 | \&key :vars :insts :temp-index | |
295 | :message :class :method :target} | |
296 | \end{describe} | |
297 | ||
298 | \begin{describe*} | |
299 | {\dhead{gf}{codegen-message @<codegen> @> @<message>} | |
300 | \dhead{gf}{codegen-class @<codegen> @> @<class>} | |
301 | \dhead{gf}{codegen-method @<codegen> @> @<method>} | |
302 | \dhead{gf}{codegen-target @<codegen> @> @<target>}} | |
303 | \end{describe*} | |
304 | ||
305 | \begin{describe*} | |
306 | {\dhead{cls}{convert-to-ilayout-inst (inst)} | |
307 | \dhead{fun} | |
308 | {make-convert-to-ilayout-inst @<class> @<chain-head> @<expr>}} | |
309 | \begin{prog} | |
310 | SOD_ILAYOUT(@<class>, @<chain-head-nick>, @<expr>) | |
311 | \end{prog} | |
312 | \end{describe*} | |
313 | ||
314 | ||
315 | \begin{describe}{gf} | |
316 | {compute-effective-method-body @<method> @<codegen> @<target>} | |
317 | \end{describe} | |
318 | ||
319 | \begin{describe}{gf}{simple-method-body @<method> @<codegen> @<target>} | |
320 | \end{describe} | |
321 | ||
322 | \begin{describe}{fun} | |
323 | {invoke-method @<codegen> @<target> @<arguments-tail> @<direct-method>} | |
324 | \end{describe} | |
325 | ||
326 | \begin{describe}{fun}{ensure-ilayout-var @<codegen> @<super>} | |
327 | \end{describe} | |
328 | ||
329 | \begin{describe}{fun}{make-trampoline @<codegen> @<super> @<body-func>} | |
330 | \end{describe} | |
331 | ||
332 | \begin{describe}{gf}{effective-method-function-name @<method> @> @<string>} | |
333 | \end{describe} | |
334 | ||
335 | \begin{describe}{gf} | |
336 | {method-entry-function-name @<method> @<chain-head> @<role> @> @<string>} | |
337 | \end{describe} | |
338 | ||
339 | \begin{describe}{gf}{compute-method-entry-functions @<method> @> @<list>} | |
340 | \end{describe} | |
341 | ||
342 | \begin{describe}{fun} | |
343 | {invoke-delegation-chain @<codegen> @<target> @<basic-tail> | |
344 | @<chain> @<kernel-func>} | |
345 | \end{describe} | |
346 | ||
347 | \begin{describe}{cls} | |
348 | {basic-message (sod-message) \&key :name :location :class :type} | |
349 | \end{describe} | |
350 | ||
351 | \begin{describe}{cls} | |
352 | {simple-message (basic-message) \&key :name :location :class :type} | |
353 | \end{describe} | |
354 | ||
355 | \begin{describe}{cls} | |
356 | {basic-direct-method (sod-method) | |
357 | \&key :message :location :class :type :body :role} | |
358 | \end{describe} | |
359 | ||
360 | \begin{describe}{gf}{sod-method-role @<method> @> @<role>} | |
361 | \end{describe} | |
362 | ||
363 | \begin{describe}{cls} | |
364 | {daemon-direct-method (basic-direct-method) \\ \ind | |
365 | \&key :message :location :class :type :body :role} | |
366 | \end{describe} | |
367 | ||
368 | \begin{describe}{cls} | |
369 | {delegating-direct-method (basic-direct-method) \\ \ind | |
370 | \&key :message :location :class :type :body :role} | |
371 | \end{describe} | |
372 | ||
373 | \begin{describe}{cls} | |
374 | {basic-effective-method (effective-method) \\ \ind | |
375 | \&key :message :class :around-methods :before-methods :after-methods} | |
376 | \end{describe} | |
377 | ||
378 | \begin{describe*} | |
379 | {\dhead{gf} | |
380 | {effective-method-around-methods @<effective-method> @> @<list>} | |
381 | \dhead{gf} | |
382 | {effective-method-before-methods @<effective-method> @> @<list>} | |
383 | \dhead{gf} | |
384 | {effective-method-after-methods @<effective-method> @> @<list>} | |
385 | \dhead{gf}{effective-method-functions @<effective-method> @> @<list>}} | |
386 | \end{describe*} | |
387 | ||
388 | \begin{describe}{cls} | |
389 | {simple-effective-method (basic-effective-method) \\ \ind | |
390 | \&key :message :class | |
391 | :around-methods :before-methods :after-methods :primary-methods} | |
392 | \end{describe} | |
393 | ||
394 | \begin{describe}{fun} | |
395 | {basic-effective-method-body @<codegen> @<target> @<method> @<body>} | |
396 | \end{describe} | |
397 | ||
398 | \begin{describe}{cls} | |
399 | {standard-message (simple-message) \&key :name :location :class :type} | |
400 | \end{describe} | |
401 | ||
402 | \begin{describe}{cls} | |
403 | {standard-effective-method (simple-effective-method) \\ \ind | |
404 | \&key :message :class | |
405 | :around-methods :before-methods :after-methods :primary-methods} | |
406 | \end{describe} | |
407 | ||
408 | \begin{describe}{cls} | |
409 | {aggregating-message (simple-message) | |
410 | \&key :name :location :class :type :combination} | |
411 | \end{describe} | |
412 | ||
413 | \begin{describe}{gf} | |
414 | {aggregating-message-properties @<message> @<combination> @> @<plist>} | |
415 | \end{describe} | |
416 | ||
417 | \begin{describe}{gf} | |
418 | {compute-aggregating-message-kernel | |
419 | \=@<message> @<combination> @<target> \+ \\ | |
420 | @<methods> @<arg-names> \&key} | |
421 | \end{describe} | |
422 | ||
423 | \begin{describe}{gf} | |
424 | {check-aggregating-message-type @<message> @<combination> @<c-type>} | |
425 | \end{describe} | |
426 | ||
427 | \begin{describe}{cls} | |
428 | {aggregating-effective-method (simple-effective-method) \\ \ind | |
429 | \&key :message :class | |
430 | :around-methods :before-methods :after-methods :primary-methods} | |
431 | \end{describe} | |
432 | ||
433 | \begin{describe}{mac} | |
434 | {define-aggregating-method-combination @<combination> \\ \ind\ind | |
435 | ((@<var-name>^*) | |
436 | @[[ :codegen @<codegen-var> @! | |
437 | :methods @<methods-var> @]]) \- \\ | |
438 | @[[ \=:properties (@{ (@{ @<name> @! (@[@<keyword>@] @<name>) @} | |
439 | @<c-type> | |
440 | @[@<default> | |
441 | @[@<suppliedp-var>@]@]) @}^*) @! \+ \\ | |
442 | :return-type @<c-type> @! \\ | |
443 | :around @<around-func> @! | |
444 | :first-method @<first-method-func> @! | |
445 | :method @<method-func> @]]} | |
446 | \end{describe} | |
447 | ||
448 | %%% the method combination story | |
449 | %% compute-effective-methods --> compute-sod-effective-method | |
450 | ||
451 | %% hook-output (basic-effective-method :c) | |
452 | %% basic-effective-method.functions | |
453 | %% compute-method-entry-functions | |
454 | %% compute-effective-method-body | |
455 | %% | |
456 | %% compute-effective-method-body (simple-effective-method) | |
457 | %% basic-effective-method-body | |
458 | %% simple-method-body (standard-effective-method) | |
459 | %% simple-method-body (aggregating-effective-method) | |
460 | %% message-kernel-function | |
461 | ||
462 | %%%----- That's all, folks -------------------------------------------------- | |
463 | ||
464 | %%% Local variables: | |
465 | %%% mode: LaTeX | |
466 | %%% TeX-master: "sod.tex" | |
467 | %%% TeX-PDF-mode: t | |
468 | %%% End: |