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