mdw@git.distorted.org.uk Git - sod/blob - doc/layout.tex

   1 %%% -*-latex-*-
   2 %%%
   3 %%% Class layout and method combination protocols
   4 %%%
   5 %%% (c) 2015 Straylight/Edgeware
   6 %%%
   7
   8 %%%----- Licensing notice ---------------------------------------------------
   9 %%%
  10 %%% This file is part of the Sensible Object Design, an object system for C.
  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
 127 \begin{describe}{gf}{sod-class-ilayout <class> @> @<ilayout>}
 128 \end{describe}
 129
 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
 207 \begin{describe}{gf}{sod-class-vtables @<class> @> @<list>}
 208 \end{describe}
 209
 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 :keywords}
 217 \end{describe}
 218
 219 \begin{describe*}
 220     {\dhead{gf}{effective-method-message @<method> @> @<message>}
 221      \dhead{gf}{effective-method-class @<method> @> @<class>}
 222      \dhead{gf}{effective-method-keywords @<method> @> @<list>}}
 223 \end{describe*}
 224
 225 \begin{describe}{gf}
 226     {sod-message-effective-method-class @<message> @> @<class>}
 227 \end{describe}
 228
 229 \begin{describe}{gf}{primary-method-class @<message> @> @<class>}
 230 \end{describe}
 231
 232 \begin{describe}{gf}
 233     {compute-sod-effective-method @<message> @<class> @> @<method>}
 234 \end{describe}
 235
 236 \begin{describe}{gf}{sod-class-effective-methods @<class> @> @<list>}
 237 \end{describe}
 238
 239 \begin{describe}{gf}{compute-effective-methods @<class> @> @<list>}
 240 \end{describe}
 241
 242 \begin{describe}{cls}
 243     {method-entry () \&key :method :chain-head :chain-tail :role}
 244 \end{describe}
 245
 246 \begin{describe*}
 247     {\dhead{gf}{method-entry-effective-method @<method-entry> @> @<method>}
 248      \dhead{gf}{method-entry-chain-head @<method-entry> @> @<class>}
 249      \dhead{gf}{method-entry-chain-tail @<method-entry> @> @<class>}
 250      \dhead{gf}{method-entry-role @<method-entry> @> @<role>}}
 251 \end{describe*}
 252
 253 \begin{describe}{gf}
 254     {make-method-entries @<effective-method> @<chain-head> @<chain-tail>
 255       @> @<list>}
 256 \end{describe}
 257
 258
 259 \begin{describe}{gf}{sod-message-argument-tail @<message> @> @<list>}
 260 \end{describe}
 261
 262 \begin{describe}{gf}{sod-message-no-varargs-tail @<message> @> @<list>}
 263 \end{describe}
 264
 265 \begin{describe}{gf}{sod-method-function-type @<method> @> @<c-type>}
 266 \end{describe}
 267
 268 \begin{describe}{gf}{sod-method-next-method-type @<method> @> @<c-type>}
 269 \end{describe}
 270
 271 \begin{describe}{gf}{sod-method-function-name @<method> @> @<string>}
 272 \end{describe}
 273
 274 \begin{describe}{fun}{varargs-message-p @<message> @> @<generalized-boolean>}
 275 \end{describe}
 276
 277 \begin{describe}{fun}{keyword-message-p @<message> @> @<generalized-boolean>}
 278 \end{describe}
 279
 280 \begin{describe}{gf}{method-entry-function-type @<entry> @> @<c-type>}
 281 \end{describe}
 282
 283 \begin{describe}{gf}{method-entry-slot-name @<entry> @> @<string>}
 284 \end{describe}
 285
 286 \begin{describe}{gf}
 287     {method-entry-slot-name-by-role @<entry> @<role> @<name> @> @<string>}
 288 \end{describe}
 289
 290 \begin{describe}{gf}
 291     {effective-method-basic-argument-names @<method> @> @<list>}
 292 \end{describe}
 293
 294
 295
 296 \begin{describe}{cls}
 297     {method-codegen (codegen) \\ \ind
 298       \&key :vars :insts :temp-index
 299             :message :class :method :target}
 300 \end{describe}
 301
 302 \begin{describe*}
 303     {\dhead{gf}{codegen-message @<codegen> @> @<message>}
 304      \dhead{gf}{codegen-class @<codegen> @> @<class>}
 305      \dhead{gf}{codegen-method @<codegen> @> @<method>}
 306      \dhead{gf}{codegen-target @<codegen> @> @<target>}}
 307 \end{describe*}
 308
 309 \begin{describe*}
 310     {\dhead{cls}{convert-to-ilayout-inst (inst)}
 311      \dhead{fun}
 312        {make-convert-to-ilayout-inst @<class> @<chain-head> @<expr>}}
 313   \begin{prog}
 314     SOD_ILAYOUT(@<class>, @<chain-head-nick>, @<expr>)
 315   \end{prog}
 316 \end{describe*}
 317
 318
 319 \begin{describe}{gf}
 320     {compute-effective-method-body @<method> @<codegen> @<target>}
 321 \end{describe}
 322
 323 \begin{describe}{gf}{simple-method-body @<method> @<codegen> @<target>}
 324 \end{describe}
 325
 326 \begin{describe}{fun}
 327     {invoke-method @<codegen> @<target> @<arguments-tail> @<direct-method>}
 328 \end{describe}
 329
 330 \begin{describe}{fun}{ensure-ilayout-var @<codegen> @<super>}
 331 \end{describe}
 332
 333 \begin{describe}{fun}{make-trampoline @<codegen> @<super> @<body-func>}
 334 \end{describe}
 335
 336 \begin{describe}{gf}{effective-method-function-name @<method> @> @<string>}
 337 \end{describe}
 338
 339 \begin{describe}{gf}
 340     {method-entry-function-name @<method> @<chain-head> @<role> @> @<string>}
 341 \end{describe}
 342
 343 \begin{describe}{gf}{compute-method-entry-functions @<method> @> @<list>}
 344 \end{describe}
 345
 346 \begin{describe}{fun}
 347     {invoke-delegation-chain @<codegen> @<target> @<basic-tail>
 348                              @<chain> @<kernel-func>}
 349 \end{describe}
 350
 351 \begin{describe}{cls}
 352     {basic-message (sod-message) \&key :name :location :class :type}
 353 \end{describe}
 354
 355 \begin{describe}{cls}
 356     {simple-message (basic-message) \&key :name :location :class :type}
 357 \end{describe}
 358
 359 \begin{describe}{cls}
 360     {basic-direct-method (sod-method)
 361       \&key :message :location :class :type :body :role}
 362 \end{describe}
 363
 364 \begin{describe}{gf}{sod-method-role @<method> @> @<role>}
 365 \end{describe}
 366
 367 \begin{describe}{cls}
 368     {daemon-direct-method (basic-direct-method) \\ \ind
 369       \&key :message :location :class :type :body :role}
 370 \end{describe}
 371
 372 \begin{describe}{cls}
 373     {delegating-direct-method (basic-direct-method) \\ \ind
 374       \&key :message :location :class :type :body :role}
 375 \end{describe}
 376
 377 \begin{describe}{cls}
 378     {basic-effective-method (effective-method) \\ \ind
 379       \&key :message :class :around-methods :before-methods :after-methods}
 380 \end{describe}
 381
 382 \begin{describe*}
 383     {\dhead{gf}
 384        {effective-method-around-methods @<effective-method> @> @<list>}
 385      \dhead{gf}
 386        {effective-method-before-methods @<effective-method> @> @<list>}
 387      \dhead{gf}
 388        {effective-method-after-methods @<effective-method> @> @<list>}
 389      \dhead{gf}{effective-method-functions @<effective-method> @> @<list>}}
 390 \end{describe*}
 391
 392 \begin{describe}{cls}
 393     {simple-effective-method (basic-effective-method) \\ \ind
 394       \&key :message :class
 395             :around-methods :before-methods :after-methods :primary-methods}
 396 \end{describe}
 397
 398 \begin{describe}{fun}
 399     {basic-effective-method-body @<codegen> @<target> @<method> @<body>}
 400 \end{describe}
 401
 402 \begin{describe}{cls}
 403     {standard-message (simple-message) \&key :name :location :class :type}
 404 \end{describe}
 405
 406 \begin{describe}{cls}
 407     {standard-effective-method (simple-effective-method) \\ \ind
 408       \&key :message :class
 409             :around-methods :before-methods :after-methods :primary-methods}
 410 \end{describe}
 411
 412 \begin{describe}{cls}
 413     {aggregating-message (simple-message)
 414       \&key :name :location :class :type :combination}
 415 \end{describe}
 416
 417 \begin{describe}{gf}
 418     {aggregating-message-properties @<message> @<combination> @> @<plist>}
 419 \end{describe}
 420
 421 \begin{describe}{gf}
 422     {compute-aggregating-message-kernel
 423       \=@<message> @<combination> @<target> \+ \\
 424         @<methods> @<arg-names> \&key}
 425 \end{describe}
 426
 427 \begin{describe}{gf}
 428     {check-aggregating-message-type @<message> @<combination> @<c-type>}
 429 \end{describe}
 430
 431 \begin{describe}{cls}
 432      {aggregating-effective-method (simple-effective-method) \\ \ind
 433       \&key :message :class
 434             :around-methods :before-methods :after-methods :primary-methods}
 435 \end{describe}
 436
 437 \begin{describe}{mac}
 438     {define-aggregating-method-combination @<combination> \\ \ind\ind
 439         ((@<var-name>^*)
 440          @[[ :codegen @<codegen-var> @!
 441              :methods @<methods-var> @]]) \- \\
 442       @[[ \=:properties (@{ (@{ @<name> @! (@[@<keyword>@] @<name>) @}
 443                              @<c-type>
 444                              @[@<default>
 445                                @[@<suppliedp-var>@]@]) @}^*) @! \+ \\
 446             :return-type @<c-type> @! \\
 447             :around @<around-func> @!
 448             :first-method @<first-method-func> @!
 449             :method @<method-func> @]]}
 450 \end{describe}
 451
 452 %%% the method combination story
 453 %% compute-effective-methods --> compute-sod-effective-method
 454
 455 %% hook-output (basic-effective-method :c)
 456 %%   basic-effective-method.functions
 457 %%     compute-method-entry-functions
 458 %%       compute-effective-method-body
 459 %%
 460 %% compute-effective-method-body (simple-effective-method)
 461 %%   basic-effective-method-body
 462 %%   simple-method-body (standard-effective-method)
 463 %%   simple-method-body (aggregating-effective-method)
 464 %%     message-kernel-function
 465
 466 %%%----- That's all, folks --------------------------------------------------
 467
 468 %%% Local variables:
 469 %%% mode: LaTeX
 470 %%% TeX-master: "sod.tex"
 471 %%% TeX-PDF-mode: t
 472 %%% End: