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