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}{cls}{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}{cls}{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-head @<ichain> @> @<class>}
 119      \dhead{gf}{ichain-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}{cls}{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}{gf}
 153     {compute-vtmsgs @<class> @<subclass> @<chain-head> @<chain-tail>
 154       @> @<vtmsgs>}
 155 \end{describe}
 156
 157 \begin{describe}{cls}
 158     {class-pointer () \&key :class :chain-head :metaclass :meta-chain-head}
 159 \end{describe}
 160
 161 \begin{describe*}
 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>}}
 166 \end{describe*}
 167
 168 \begin{describe}{fun}
 169     {make-class-pointer @<class> @<chain-head>
 170                         @<metaclass> @<meta-chain-head>
 171       @> @<class-pointer>}
 172 \end{describe}
 173
 174 \begin{describe}{cls}{base-offset () \&key :class :chain-head}
 175 \end{describe}
 176
 177 \begin{describe*}
 178     {\dhead{gf}{base-offset-class @<base-offset> @> @<class>}
 179      \dhead{gf}{base-offset-chain-head @<base-offset> @> @<class>}}
 180 \end{describe*}
 181
 182 \begin{describe}{fun}
 183     {make-base-offset @<class> @<chain-head> @> @<base-offset>}
 184 \end{describe}
 185
 186 \begin{describe}{cls}{chain-offset () \&key :class :chain-head :target-head}
 187 \end{describe}
 188
 189 \begin{describe*}
 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>}}
 193 \end{describe*}
 194
 195 \begin{describe}{fun}
 196     {make-chain-offset @<class> @<chain-head> @<target-head>
 197       @> @<chain-offset>}
 198 \end{describe}
 199
 200 \begin{describe}{cls}{vtable () \&key :class :chain-head :chain-tail :body}
 201 \end{describe}
 202
 203 \begin{describe*}
 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>}}
 208 \end{describe*}
 209
 210 \begin{describe}{gf}
 211     {compute-vtable-items @<class> @<super>
 212                           @<chain-head> @<chain-tail>
 213                           @<emit-function>}
 214 \end{describe}
 215
 216 \begin{describe}{gf}{compute-vtable @<class> @<chain> @> @<vtable>}
 217 \end{describe}
 218
 219 \begin{describe}{gf}{sod-class-vtables @<class> @> @<list>}
 220 \end{describe}
 221
 222 \begin{describe}{gf}{compute-vtables @<class> @> @<list>}
 223 \end{describe}
 224
 225 %%%--------------------------------------------------------------------------
 226 \section{Method combination} \label{sec:layout.methods}
 227
 228 \begin{describe}{cls}{effective-method () \&key :message :class :keywords}
 229 \end{describe}
 230
 231 \begin{describe*}
 232     {\dhead{gf}{effective-method-message @<method> @> @<message>}
 233      \dhead{gf}{effective-method-class @<method> @> @<class>}
 234      \dhead{gf}{effective-method-keywords @<method> @> @<list>}}
 235 \end{describe*}
 236
 237 \begin{describe}{gf}
 238     {sod-message-applicable-methods @<message> @<class> @> list}
 239 \end{describe}
 240
 241 \begin{describe}{gf}
 242     {sod-message-keyword-argument-lists @<message> @<class>
 243                                         @<direct-methods> @<state>
 244       \nlret @<list>}
 245 \end{describe}
 246
 247 \begin{describe}{fun}
 248     {compute-effective-method-keyword-arguments @<message>
 249                                                 @<class>
 250                                                 @<direct-methods>
 251       \nlret @<list>}
 252 \end{describe}
 253
 254 \begin{describe}{gf}
 255     {sod-message-check-methods @<message> @<class> @<direct-methods>}
 256 \end{describe}
 257
 258 \begin{describe}{gf}
 259     {sod-message-effective-method-class @<message> @> @<class>}
 260 \end{describe}
 261
 262 \begin{describe}{gf}{primary-method-class @<message> @> @<class>}
 263 \end{describe}
 264
 265 \begin{describe}{gf}
 266     {compute-sod-effective-method @<message> @<class> @> @<method>}
 267 \end{describe}
 268
 269 \begin{describe}{gf}{sod-class-effective-methods @<class> @> @<list>}
 270 \end{describe}
 271
 272 \begin{describe}{gf}{compute-effective-methods @<class> @> @<list>}
 273 \end{describe}
 274
 275 \begin{describe}{cls}
 276     {method-entry () \&key :method :chain-head :chain-tail :role}
 277 \end{describe}
 278
 279 \begin{describe*}
 280     {\dhead{gf}{method-entry-effective-method @<method-entry> @> @<method>}
 281      \dhead{gf}{method-entry-chain-head @<method-entry> @> @<class>}
 282      \dhead{gf}{method-entry-chain-tail @<method-entry> @> @<class>}
 283      \dhead{gf}{method-entry-role @<method-entry> @> @<role>}}
 284 \end{describe*}
 285
 286 \begin{describe}{gf}
 287     {make-method-entries @<effective-method> @<chain-head> @<chain-tail>
 288       @> @<list>}
 289 \end{describe}
 290
 291
 292 \begin{describe}{gf}{sod-message-argument-tail @<message> @> @<list>}
 293 \end{describe}
 294
 295 \begin{describe}{gf}{sod-method-function-type @<method> @> @<c-type>}
 296 \end{describe}
 297
 298 \begin{describe}{gf}{sod-method-next-method-type @<method> @> @<c-type>}
 299 \end{describe}
 300
 301 \begin{describe}{gf}{sod-method-description @<method> @> @<string>}
 302 \end{describe}
 303
 304 \begin{describe}{gf}{sod-method-function-name @<method> @> @<string>}
 305 \end{describe}
 306
 307 \begin{describe}{fun}{varargs-message-p @<message> @> @<generalized-boolean>}
 308 \end{describe}
 309
 310 \begin{describe}{fun}{keyword-message-p @<message> @> @<generalized-boolean>}
 311 \end{describe}
 312
 313 \begin{describe}{gf}{method-entry-function-type @<entry> @> @<c-type>}
 314 \end{describe}
 315
 316 \begin{describe}{gf}{method-entry-slot-name @<entry> @> @<string>}
 317 \end{describe}
 318
 319 \begin{describe}{gf}
 320     {method-entry-slot-name-by-role @<entry> @<role> @<name> @> @<string>}
 321 \end{describe}
 322
 323 \begin{describe}{gf}
 324     {effective-method-basic-argument-names @<method> @> @<list>}
 325 \end{describe}
 326
 327 \begin{describe}{gf}
 328     {effective-method-live-p @<method> @> @<generalized-boolean>}
 329 \end{describe}
 330
 331
 332 \begin{describe}{cls}
 333     {method-codegen (codegen)                                   \\ \ind
 334       \&key :vars :insts :temp-index
 335             :message :class :method :target}
 336 \end{describe}
 337
 338 \begin{describe*}
 339     {\dhead{gf}{codegen-message @<codegen> @> @<message>}
 340      \dhead{gf}{codegen-class @<codegen> @> @<class>}
 341      \dhead{gf}{codegen-method @<codegen> @> @<method>}
 342      \dhead{gf}{codegen-target @<codegen> @> @<target>}}
 343 \end{describe*}
 344
 345 \begin{describe*}
 346     {\dhead{cls}{convert-to-ilayout-inst (inst)}
 347      \dhead{fun}
 348        {make-convert-to-ilayout-inst @<class> @<chain-head> @<expr>}}
 349   \def\makelabels#1#2{%
 350     #1{gf}{inst-class}[#2]#1{gf}{inst-chain-head}[#2]%
 351     \descindex{gf}{inst-expr}[#2]%
 352   }
 353   \makelabels{\desclabel}{|(}
 354
 355   \begin{prog}
 356     SOD_ILAYOUT(@<class>, @<chain-head-nick>, @<expr>)
 357   \end{prog}
 358
 359   \makelabels{\descindex}{|)}
 360 \end{describe*}
 361
 362
 363 \begin{describe}{gf}
 364     {compute-effective-method-body @<method> @<codegen> @<target>}
 365 \end{describe}
 366
 367 \begin{describe}{gf}{simple-method-body @<method> @<codegen> @<target>}
 368 \end{describe}
 369
 370 \begin{describe}{fun}
 371     {invoke-method @<codegen> @<target> @<arguments-tail> @<direct-method>}
 372 \end{describe}
 373
 374 \begin{describe}{fun}{ensure-ilayout-var @<codegen> @<super>}
 375 \end{describe}
 376
 377 \begin{describe}{fun}{make-trampoline @<codegen> @<super> @<body-func>}
 378 \end{describe}
 379
 380 \begin{describe}{gf}{effective-method-function-name @<method> @> @<string>}
 381 \end{describe}
 382
 383 \begin{describe}{gf}
 384     {method-entry-function-name @<method> @<chain-head> @<role> @> @<string>}
 385 \end{describe}
 386
 387 \begin{describe}{gf}{compute-method-entry-functions @<method> @> @<list>}
 388 \end{describe}
 389
 390 \begin{describe}{fun}
 391     {invoke-delegation-chain @<codegen> @<target> @<basic-tail>
 392                              @<chain> @<kernel-func>}
 393 \end{describe}
 394
 395 \begin{describe}{cls}
 396     {basic-message (sod-message) \&key :name :location :class :type}
 397 \end{describe}
 398
 399 \begin{describe}{cls}
 400     {simple-message (basic-message) \&key :name :location :class :type}
 401 \end{describe}
 402
 403 \begin{describe}{cls}
 404     {basic-direct-method (sod-method)
 405       \&key :message :location :class :type :body :role}
 406 \end{describe}
 407
 408 \begin{describe}{gf}{sod-method-role @<method> @> @<role>}
 409 \end{describe}
 410
 411 \begin{describe}{cls}
 412     {daemon-direct-method (basic-direct-method)                 \\ \ind
 413       \&key :message :location :class :type :body :role}
 414 \end{describe}
 415
 416 \begin{describe}{cls}
 417     {delegating-direct-method (basic-direct-method)             \\ \ind
 418       \&key :message :location :class :type :body :role}
 419 \end{describe}
 420
 421 \begin{describe}{cls}
 422     {basic-effective-method (effective-method)                  \\ \ind
 423       \&key :message :class :around-methods :before-methods :after-methods}
 424 \end{describe}
 425
 426 \begin{describe*}
 427     {\dhead{gf}
 428        {effective-method-around-methods @<effective-method> @> @<list>}
 429      \dhead{gf}
 430        {effective-method-before-methods @<effective-method> @> @<list>}
 431      \dhead{gf}
 432        {effective-method-after-methods @<effective-method> @> @<list>}
 433      \dhead{gf}{effective-method-functions @<effective-method> @> @<list>}}
 434 \end{describe*}
 435
 436 \begin{describe}{cls}
 437     {simple-effective-method (basic-effective-method)           \\ \ind
 438       \&key :message :class
 439             :around-methods :before-methods :after-methods :primary-methods}
 440 \end{describe}
 441
 442 \begin{describe}{fun}
 443     {basic-effective-method-body @<codegen> @<target> @<method> @<body>}
 444 \end{describe}
 445
 446 \begin{describe}{cls}
 447     {standard-message (simple-message) \&key :name :location :class :type}
 448 \end{describe}
 449
 450 \begin{describe}{cls}
 451     {standard-effective-method (simple-effective-method)        \\ \ind
 452       \&key :message :class
 453             :around-methods :before-methods :after-methods :primary-methods}
 454 \end{describe}
 455
 456 \begin{describe}{cls}
 457     {aggregating-message (simple-message)
 458       \&key :name :location :class :type :combination}
 459 \end{describe}
 460
 461 \begin{describe*}
 462     {\dhead{gf}{sod-message-combination @<message> @> @<keyword>}
 463      \dhead{gf}{sod-message-kernel-function @<message> @> @<function>}}
 464 \end{describe*}
 465
 466 \begin{describe}{gf}
 467     {aggregating-message-properties @<message> @<combination> @> @<plist>}
 468 \end{describe}
 469
 470 \begin{describe}{gf}
 471     {compute-aggregating-message-kernel
 472       \=@<message> @<combination> @<target>                   \+\\
 473         @<methods> @<arg-names> \&key}
 474 \end{describe}
 475
 476 \begin{describe}{gf}
 477     {check-aggregating-message-type @<message> @<combination> @<c-type>}
 478 \end{describe}
 479
 480 \begin{describe}{cls}
 481      {aggregating-effective-method (simple-effective-method)    \\ \ind
 482       \&key :message :class
 483             :around-methods :before-methods :after-methods :primary-methods}
 484 \end{describe}
 485
 486 \begin{describe}{mac}
 487     {define-aggregating-method-combination @<combination>       \\ \ind\ind
 488         ((@<var-name>^*)
 489          @[[ :codegen @<codegen-var> @!
 490              :methods @<methods-var> @]])                     \-\\
 491       @[[ \=:properties (@{ (@{ @<name> @! (@[@<keyword>@] @<name>) @}
 492                              @<c-type>
 493                              @[@<default>
 494                                @[@<suppliedp-var>@]@]) @}^*) @! \+\\
 495             :return-type @<c-type> @!                           \\
 496             :around @<around-func> @!
 497             :first-method @<first-method-func> @!
 498             :method @<method-func> @]]}
 499 \end{describe}
 500
 501 %%% the method combination story
 502 %% compute-effective-methods --> compute-sod-effective-method
 503
 504 %% hook-output (basic-effective-method :c)
 505 %%   basic-effective-method.functions
 506 %%     compute-method-entry-functions
 507 %%       compute-effective-method-body
 508 %%
 509 %% compute-effective-method-body (simple-effective-method)
 510 %%   basic-effective-method-body
 511 %%   simple-method-body (standard-effective-method)
 512 %%   simple-method-body (aggregating-effective-method)
 513 %%     message-kernel-function
 514
 515 %%%----- That's all, folks --------------------------------------------------
 516
 517 %%% Local variables:
 518 %%% mode: LaTeX
 519 %%% TeX-master: "sod.tex"
 520 %%% TeX-PDF-mode: t
 521 %%% End: