3 %%% Class layout and method combination protocols
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{Class layout and method combination}
28 %%%--------------------------------------------------------------------------
29 \section{Class layout protocol} \label{sec:layout.instance}
31 \begin{describe}{fun}{islots-struct-tag @<class> @> @<string>}
34 \begin{describe}{fun}{ichain-struct-tag @<class> @<chain-head> @> @<string>}
37 \begin{describe}{fun}{ichain-union-tag @<class> @<chain-head> @> @<string>}
40 \begin{describe}{fun}{ilayout-struct-tag @<class> @> @<string>}
43 \begin{describe}{fun}{vtmsgs-struct-tag @<class> @<super> @> @<string>}
46 \begin{describe}{fun}{vtable-union-tag @<class> @<chain-head> @> @<string>}
49 \begin{describe}{fun}{vtable-struct-tag @<class> @<chain-head> @> @<string>}
52 \begin{describe}{fun}{vtable-name @<class> @<chain-head> @> @<string>}
55 \begin{describe}{fun}{message-macro-name @<class> @<entry> @> @<string>}
58 \begin{describe}{cls}{effective-slot () \&key :class :slot :initializer}
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>}}
68 {find-slot-initializer @<class> @<slot> @> @<init-or-nil>}
72 {find-class-initializer @<slot> @<class> @> @<init-or-nil>}
75 \begin{describe}{gf}{find-slot-initargs @<class> @<slot> @> @<list>}
79 {compute-effective-slot @<class> @<slot> @> @<effective-slot>}
83 {sod-class-effective-slot (effective-slot) \\ \ind
84 \&key :class :slot :initializer-function :prepare-function}
88 {\dhead{gf}{effective-slot-initializer-function @<slot> @> @<function>}
89 \dhead{gf}{effective-slot-prepare-function @<slot> @> @<function>}}
92 \begin{describe}{cls}{islots () \&key :class :subclass :slots}
96 {\dhead{gf}{islots-class @<islots> @> @<class>}
97 \dhead{gf}{islots-subclass @<islots> @> @<class>}
98 \dhead{gf}{islots-slots @<islots> @> @<list>}}
101 \begin{describe}{gf}{compute-islots @<class> @<subclass> @> @<islots>}
104 \begin{describe}{cls}{vtable-pointer () \&key :class :chain-head :chain-tail}
108 {\dhead{gf}{vtable-pointer-class @<vtable-pointer> @> @<class>}
109 \dhead{gf}{vtable-pointer-chain-head @<vtable-pointer> @> @<class>}
110 \dhead{gf}{vtable-pointer-chain-tail @<vtable-pointer> @> @<class>}}
113 \begin{describe}{cls}{ichain () \&key :class :chain-head :chain-tail :body}
117 {\dhead{gf}{ichain-class @<ichain> @> @<class>}
118 \dhead{gf}{ichain-head @<ichain> @> @<class>}
119 \dhead{gf}{ichain-tail @<ichain> @> @<class>}
120 \dhead{gf}{ichain-body @<ichain> @> @<list>}}
123 \begin{describe}{gf}{compute-ichain @<class> @<chain> @> @<ichain>}
126 \begin{describe}{cls}{ilayout () \&key :class :ichains}
130 {\dhead{gf}{ilayout-class @<ilayout> @> @<class>}
131 \dhead{gf}{ilayout-ichains @<ilayout> @> @<list>}}
134 \begin{describe}{gf}{sod-class-ilayout @<class> @> @<ilayout>}
137 \begin{describe}{gf}{compute-ilayout @<class> @> @<ilayout>}
140 \begin{describe}{cls}
141 {vtmsgs () \&key :class :subclass :chain-head :chain-tail :entries}
145 {\dhead{gf}{vtmsgs-class @<vtmsgs> @> @<class>}
146 \dhead{gf}{vtmsgs-subclass @<vtmsgs> @> @<class>}
147 \dhead{gf}{vtmsgs-chain-head @<vtmsgs> @> @<class>}
148 \dhead{gf}{vtmsgs-chain-tail @<vtmsgs> @> @<class>}
149 \dhead{gf}{vtmsgs-entries @<vtmsgs> @> @<list>}}
153 {compute-vtmsgs @<class> @<subclass> @<chain-head> @<chain-tail>
157 \begin{describe}{cls}
158 {class-pointer () \&key :class :chain-head :metaclass :meta-chain-head}
162 {\dhead{gf}{class-pointer-class @<class-pointer> @> @<class>}
163 \dhead{gf}{class-pointer-chain-head @<class-pointer> @> @<class>}
164 \dhead{gf}{class-pointer-metaclass @<class-pointer> @> @<class>}
165 \dhead{gf}{class-pointer-meta-chain-head @<class-pointer> @> @<class>}}
168 \begin{describe}{fun}
169 {make-class-pointer @<class> @<chain-head>
170 @<metaclass> @<meta-chain-head>
174 \begin{describe}{cls}{base-offset () \&key :class :chain-head}
178 {\dhead{gf}{base-offset-class @<base-offset> @> @<class>}
179 \dhead{gf}{base-offset-chain-head @<base-offset> @> @<class>}}
182 \begin{describe}{fun}
183 {make-base-offset @<class> @<chain-head> @> @<base-offset>}
186 \begin{describe}{cls}{chain-offset () \&key :class :chain-head :target-head}
190 {\dhead{gf}{chain-offset-class @<chain-offset> @> @<class>}
191 \dhead{gf}{chain-offset-chain-head @<chain-offset> @> @<class>}
192 \dhead{gf}{chain-offset-target-head @<chain-offset> @> @<class>}}
195 \begin{describe}{fun}
196 {make-chain-offset @<class> @<chain-head> @<target-head>
200 \begin{describe}{cls}{vtable () \&key :class :chain-head :chain-tail :body}
204 {\dhead{gf}{vtable-class @<vtable> @> @<class>}
205 \dhead{gf}{vtable-chain-head @<vtable> @> @<class>}
206 \dhead{gf}{vtable-chain-tail @<vtable> @> @<class>}
207 \dhead{gf}{vtable-body @<vtable> @> @<list>}}
211 {compute-vtable-items @<class> @<super>
212 @<chain-head> @<chain-tail>
216 \begin{describe}{gf}{compute-vtable @<class> @<chain> @> @<vtable>}
219 \begin{describe}{gf}{sod-class-vtables @<class> @> @<list>}
222 \begin{describe}{gf}{compute-vtables @<class> @> @<list>}
225 %%%--------------------------------------------------------------------------
226 \section{Method combination} \label{sec:layout.methods}
228 \begin{describe}{cls}{effective-method () \&key :message :class :keywords}
232 {\dhead{gf}{effective-method-message @<method> @> @<message>}
233 \dhead{gf}{effective-method-class @<method> @> @<class>}
234 \dhead{gf}{effective-method-keywords @<method> @> @<list>}}
238 {sod-message-receiver-type @<message> @<class> @> @<c-type>}
242 {sod-message-applicable-methods @<message> @<class> @> list}
246 {sod-message-keyword-argument-lists @<message> @<class>
247 @<direct-methods> @<state>
251 \begin{describe}{fun}
252 {compute-effective-method-keyword-arguments @<message>
259 {sod-message-check-methods @<message> @<class> @<direct-methods>}
263 {sod-message-effective-method-class @<message> @> @<class>}
266 \begin{describe}{gf}{primary-method-class @<message> @> @<class>}
270 {compute-sod-effective-method @<message> @<class> @> @<method>}
273 \begin{describe}{gf}{sod-class-effective-methods @<class> @> @<list>}
276 \begin{describe}{gf}{compute-effective-methods @<class> @> @<list>}
279 \begin{describe}{cls}
280 {method-entry () \&key :method :chain-head :chain-tail :role}
284 {\dhead{gf}{method-entry-effective-method @<method-entry> @> @<method>}
285 \dhead{gf}{method-entry-chain-head @<method-entry> @> @<class>}
286 \dhead{gf}{method-entry-chain-tail @<method-entry> @> @<class>}
287 \dhead{gf}{method-entry-role @<method-entry> @> @<role>}}
291 {make-method-entries @<effective-method> @<chain-head> @<chain-tail>
296 \begin{describe}{gf}{sod-message-argument-tail @<message> @> @<list>}
299 \begin{describe}{gf}{sod-method-function-type @<method> @> @<c-type>}
302 \begin{describe}{gf}{sod-method-next-method-type @<method> @> @<c-type>}
305 \begin{describe}{gf}{sod-method-description @<method> @> @<string>}
308 \begin{describe}{gf}{sod-method-function-name @<method> @> @<string>}
311 \begin{describe}{fun}{varargs-message-p @<message> @> @<generalized-boolean>}
314 \begin{describe}{fun}{keyword-message-p @<message> @> @<generalized-boolean>}
317 \begin{describe}{gf}{method-entry-function-type @<entry> @> @<c-type>}
320 \begin{describe}{gf}{method-entry-slot-name @<entry> @> @<string>}
324 {method-entry-slot-name-by-role @<entry> @<role> @<name> @> @<string>}
328 {effective-method-basic-argument-names @<method> @> @<list>}
332 {effective-method-live-p @<method> @> @<generalized-boolean>}
336 \begin{describe}{cls}
337 {method-codegen (codegen) \\ \ind
338 \&key :vars :insts :temp-index
339 :message :class :method :target}
343 {\dhead{gf}{codegen-message @<codegen> @> @<message>}
344 \dhead{gf}{codegen-class @<codegen> @> @<class>}
345 \dhead{gf}{codegen-method @<codegen> @> @<method>}
346 \dhead{gf}{codegen-target @<codegen> @> @<target>}}
350 {\dhead{cls}{convert-to-ilayout-inst (inst)}
352 {make-convert-to-ilayout-inst @<class> @<chain-head> @<expr>}}
353 \def\makelabels#1#2{%
354 #1{gf}{inst-class}[#2]#1{gf}{inst-chain-head}[#2]%
355 \descindex{gf}{inst-expr}[#2]%
357 \makelabels{\desclabel}{|(}
360 SOD_ILAYOUT(@<class>, @<chain-head-nick>, @<expr>)
363 \makelabels{\descindex}{|)}
368 {compute-effective-method-body @<method> @<codegen> @<target>}
371 \begin{describe}{gf}{simple-method-body @<method> @<codegen> @<target>}
374 \begin{describe}{fun}
375 {invoke-method @<codegen> @<target> @<arguments-tail> @<direct-method>}
378 \begin{describe}{fun}{ensure-ilayout-var @<codegen> @<super>}
381 \begin{describe}{fun}{make-trampoline @<codegen> @<super> @<body-func>}
384 \begin{describe}{gf}{effective-method-function-name @<method> @> @<string>}
388 {method-entry-function-name @<method> @<chain-head> @<role> @> @<string>}
391 \begin{describe}{gf}{compute-method-entry-functions @<method> @> @<list>}
394 \begin{describe}{fun}
395 {invoke-delegation-chain @<codegen> @<target> @<basic-tail>
396 @<chain> @<kernel-func>}
399 \begin{describe}{cls}
400 {basic-message (sod-message) \&key :name :location :class :type}
403 \begin{describe}{cls}
404 {simple-message (basic-message) \&key :name :location :class :type}
407 \begin{describe}{cls}
408 {basic-direct-method (sod-method)
409 \&key :message :location :class :type :body :role}
412 \begin{describe}{gf}{sod-method-role @<method> @> @<role>}
415 \begin{describe}{cls}
416 {daemon-direct-method (basic-direct-method) \\ \ind
417 \&key :message :location :class :type :body :role}
420 \begin{describe}{cls}
421 {delegating-direct-method (basic-direct-method) \\ \ind
422 \&key :message :location :class :type :body :role}
425 \begin{describe}{cls}
426 {basic-effective-method (effective-method) \\ \ind
427 \&key :message :class :around-methods :before-methods :after-methods}
432 {effective-method-around-methods @<effective-method> @> @<list>}
434 {effective-method-before-methods @<effective-method> @> @<list>}
436 {effective-method-after-methods @<effective-method> @> @<list>}
437 \dhead{gf}{effective-method-functions @<effective-method> @> @<list>}}
440 \begin{describe}{cls}
441 {simple-effective-method (basic-effective-method) \\ \ind
442 \&key :message :class
443 :around-methods :before-methods :after-methods :primary-methods}
446 \begin{describe}{fun}
447 {basic-effective-method-body @<codegen> @<target> @<method> @<body>}
450 \begin{describe}{cls}
451 {standard-message (simple-message) \&key :name :location :class :type}
454 \begin{describe}{cls}
455 {standard-effective-method (simple-effective-method) \\ \ind
456 \&key :message :class
457 :around-methods :before-methods :after-methods :primary-methods}
460 \begin{describe}{cls}
461 {aggregating-message (simple-message)
462 \&key :name :location :class :type :combination}
466 {\dhead{gf}{sod-message-combination @<message> @> @<keyword>}
467 \dhead{gf}{sod-message-kernel-function @<message> @> @<function>}}
471 {aggregating-message-properties @<message> @<combination> @> @<plist>}
475 {compute-aggregating-message-kernel
476 \=@<message> @<combination> @<target> \+\\
477 @<methods> @<arg-names> \&key}
481 {check-aggregating-message-type @<message> @<combination> @<c-type>}
484 \begin{describe}{cls}
485 {aggregating-effective-method (simple-effective-method) \\ \ind
486 \&key :message :class
487 :around-methods :before-methods :after-methods :primary-methods}
490 \begin{describe}{mac}
491 {define-aggregating-method-combination @<combination> \\ \ind\ind
493 @[[ :codegen @<codegen-var> @!
494 :methods @<methods-var> @]]) \-\\
495 @[[ \=:properties (@{ (@{ @<name> @! (@[@<keyword>@] @<name>) @}
498 @[@<suppliedp-var>@]@]) @}^*) @! \+\\
499 :return-type @<c-type> @! \\
500 :around @<around-func> @!
501 :first-method @<first-method-func> @!
502 :method @<method-func> @]]}
505 %%% the method combination story
506 %% compute-effective-methods --> compute-sod-effective-method
508 %% hook-output (basic-effective-method :c)
509 %% basic-effective-method.functions
510 %% compute-method-entry-functions
511 %% compute-effective-method-body
513 %% compute-effective-method-body (simple-effective-method)
514 %% basic-effective-method-body
515 %% simple-method-body (standard-effective-method)
516 %% simple-method-body (aggregating-effective-method)
517 %% message-kernel-function
519 %%%----- That's all, folks --------------------------------------------------
523 %%% TeX-master: "sod.tex"