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

   1 %%% -*-latex-*-
   2 %%%
   3 %%% Translation-time metaobjects
   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{Translation-time metaobjects} \label{ch:meta}
  27
  28 %%%--------------------------------------------------------------------------
  29 \section{Base metaobject classes} \label{sec:meta.classes}
  30
  31 \begin{describe}{cls}
  32     {sod-class ()                                               \\ \ind
  33       \&key \=:name :nick :location :pset                     \+\\
  34               :superclasses :link :metaclass                    \\
  35               :slots :instance-initializers :class-initializers \\
  36               :initargs :initfrags :tearfrags                   \\
  37               :messages :methods}
  38 \end{describe}
  39
  40 \begin{describe*}
  41     {\dhead{gf}{sod-class-name @<class> @> @<string>}
  42      \dhead{gf}{sod-class-nickname @<class> @> @<string>}
  43      \dhead{gf}{sod-class-direct-superclasses @<class> @> @<list>}
  44      \dhead{gf}{sod-class-chain-link @<class> @> @<class-or-nil>}
  45      \dhead{gf}{sod-class-metaclass @<class> @> @<metaclass>}
  46      \dhead{gf}{sod-class-slots @<class> @> @<list>}
  47      \dhead{gf}{setf (sod-class-slots @<class>) @<list>}
  48      \dhead{gf}{sod-class-instance-initializers @<class> @> @<list>}
  49      \dhead{gf}{setf (sod-class-instance-initializers @<class>) @<list>}
  50      \dhead{gf}{sod-class-class-initializers @<class> @> @<list>}
  51      \dhead{gf}{setf (sod-class-class-initializers @<class>) @<list>}
  52      \dhead{gf}{sod-class-initargs @<class> @> @<list>}
  53      \dhead{gf}{setf (sod-class-initargs @<class>) @<list>}
  54      \dhead{gf}{sod-class-initfrags @<class> @> @<list>}
  55      \dhead{gf}{setf (sod-class-initfrags @<class>) @<list>}
  56      \dhead{gf}{sod-class-tearfrags @<class> @> @<list>}
  57      \dhead{gf}{setf (sod-class-tearfrags @<class>) @<list>}
  58      \dhead{gf}{sod-class-messages @<class> @> @<list>}
  59      \dhead{gf}{setf (sod-class-messages @<class>) @<list>}
  60      \dhead{gf}{sod-class-methods @<class> @> @<list>}
  61      \dhead{gf}{setf (sod-class-methods @<class>) @<list>}}
  62 \end{describe*}
  63
  64 \begin{describe}{fun}
  65     {make-sod-class @<name> @<superclasses> @<pset> \&key :location
  66       @> @<class>}
  67 \end{describe}
  68
  69 \begin{describe*}
  70     {\dhead{lmac}{slot @<name> @<type> @{ @<keyword> @<value> @}^*}
  71      \dhead{lmac}{instance-initializer @<nick> @<name>
  72                                        @<value-kind> @<value-form>
  73                                        @{ @<keyword> @<value> @}^*}
  74      \dhead{lmac}{class-initializer @<nick> @<name>
  75                                     @<value-kind> @<value-form>
  76                                     @{ @<keyword> @<value> @}^*}
  77      \dhead{lmac}{message @<name> @<type> @{ @<keyword> @<value> @}^*}
  78      \dhead{lmac}{method @<nick> @<name> @<type> @<body>
  79                          @{ @<keyword> @<value> @}^*}}
  80 \end{describe*}
  81
  82 \begin{describe}{fun}
  83     {find-superclass-by-nick @<class> @<nick> @> @<superclass>}
  84 \end{describe}
  85
  86 \begin{describe}{ty}{inheritance-path-reporter-state}
  87 \end{describe}
  88
  89 \begin{describe}{fun}{make-inheritance-path-reporter-state @> @<state>}
  90 \end{describe}
  91
  92 \begin{describe}{fun}{report-inheritance-path @<state> @<super>}
  93 \end{describe}
  94
  95 \begin{describe}{fun}
  96     {select-minimal-class-property
  97         \=@<supers> @<key> @<order> @<default> @<what> \\
  98         \>\&key :present :allow-empty
  99       \nlret @<object>}
 100 \end{describe}
 101
 102 \begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
 103 \end{describe}
 104
 105 \begin{describe}{fun}
 106     {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
 107 \end{describe}
 108
 109 \begin{describe}{fun}{valid-name-p @<name> @> @<generalized-boolean>}
 110 \end{describe}
 111
 112 \begin{describe}{fun}{find-root-superclass @<class> @> @<superclass>}
 113 \end{describe}
 114
 115 \begin{describe}{fun}{find-root-metaclass @<class> @> @<metaclass>}
 116 \end{describe}
 117
 118 \begin{describe}{cls}{sod-slot () \&key :name :location :pset :class :type}
 119 \end{describe}
 120
 121 \begin{describe*}
 122     {\dhead{gf}{sod-slot-name @<slot> @> @<string>}
 123      \dhead{gf}{sod-slot-class @<slot> @> @<class>}
 124      \dhead{gf}{sod-slot-type @<slot> @> @<c-type>}}
 125 \end{describe*}
 126
 127 \begin{describe}{gf}
 128     {make-sod-slot @<class> @<name> @<type> @<pset> \&key :location
 129       @> @<slot>}
 130 \end{describe}
 131
 132 \begin{describe*}
 133     {\dhead{fun}
 134       {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
 135         @> @<slot>}
 136      \dhead{fun}
 137       {find-class-slot-by-name @<class> @<super-nick> @<slot-name>
 138         @> @<slot>}}
 139 \end{describe*}
 140
 141 \begin{describe}{cls}
 142     {sod-class-slot (sod-slot)                                  \\ \ind
 143       \&key :name :location :pset :class :type
 144             :initializer-function :prepare-function}
 145 \end{describe}
 146
 147 \begin{describe*}
 148     {\dhead{gf}{sod-slot-initializer-function @<slot> @> @<function>}
 149      \dhead{gf}{sod-slot-prepare-function @<slot> @> @<function>}}
 150 \end{describe*}
 151
 152 \begin{describe*}
 153     {\dhead{cls}{sod-initializer ()
 154        \&key :slot :location :class :value}
 155      \dhead{cls}{sod-instance-initializer (sod-initializer)
 156        \&key :slot :location :class :value}
 157      \dhead{cls}{sod-class-initializer (sod-initializer)
 158        \&key :slot :location :class :value}}
 159 \end{describe*}
 160
 161 \begin{describe*}
 162     {\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
 163      \dhead{gf}{sod-initializer-value @<init> @> @<fragment>}}
 164 \end{describe*}
 165
 166 \begin{describe*}
 167     {\dhead{gf}
 168       {make-sod-instance-initializer
 169           \=@<class> @<nick> @<name> @<value> @<pset> \\
 170           \>\&key :inhibit-initargs :location
 171         \nlret @<init>}
 172      \dhead{gf}
 173       {make-sod-class-initializer
 174           \=@<class> @<nick> @<name> @<value> @<pset> \&key :location
 175         \nlret @<init>}}
 176 \end{describe*}
 177
 178 \begin{describe}{gf}
 179     {make-sod-initializer-using-slot
 180         @<class> @<slot> @<init-class> @<value> @<pset> @<floc>
 181       \nlret @<init>}
 182 \end{describe}
 183
 184 \begin{describe}{cls}{sod-initarg () \&key :class :location :name :type}
 185 \end{describe}
 186
 187 \begin{describe*}
 188     {\dhead{gf}{sod-initarg-class @<initarg> @> @<class>}
 189      \dhead{gf}{sod-initarg-name @<initarg> @> @<string>}
 190      \dhead{gf}{sod-initarg-type @<initarg> @> @<c-type>}}
 191 \end{describe*}
 192
 193 \begin{describe}{cls}
 194     {sod-user-initarg (sod-initarg)
 195       \&key :class :location :name :type :default}
 196 \end{describe}
 197
 198 \begin{describe}{gf}
 199      {make-sod-user-initarg @<class> @<name> @<type> @<pset>
 200                             \&key :default :location}
 201 \end{describe}
 202
 203 \begin{describe}{gf}{sod-initarg-default @<initarg> @> @<default>}
 204 \end{describe}
 205
 206 \begin{describe}{cls}
 207     {sod-slot-initarg (sod-initarg)
 208       \&key :class :location :name :type :slot}
 209 \end{describe}
 210
 211 \begin{describe}{gf}{sod-initarg-slot @<initarg> @> @<slot>}
 212 \end{describe}
 213
 214 \begin{describe}{gf}
 215     {make-sod-slot-initarg @<class> @<name> @<nick> @<slot-name> @<pset>
 216                            \&key :location}
 217 \end{describe}
 218
 219 \begin{describe}{gf}
 220     {make-sod-slot-initarg-using-slot @<class> @<name> @<slot> @<pset>
 221                                       \&key :location}
 222 \end{describe}
 223
 224 \begin{describe*}
 225     {\dhead{gf}{make-sod-class-initfrag @<class> @<frag> @<pset>
 226                                         \&key :location}
 227      \dhead{gf}{make-sod-class-tearfrag @<class> @<frag> @<pset>
 228                                         \&key :location}}
 229 \end{describe*}
 230
 231 \begin{describe}{cls}{sod-message () \&key :name :location :class :type}
 232 \end{describe}
 233
 234 \begin{describe*}
 235     {\dhead{gf}{sod-message-name @<message> @> @<string>}
 236      \dhead{gf}{sod-message-class @<message> @> @<class>}
 237      \dhead{gf}{sod-message-type @<message> @> @<c-type>}}
 238 \end{describe*}
 239
 240 \begin{describe}{gf}
 241     {make-sod-message @<class> @<name> @<type> @<pset> \&key :location
 242       @> @<message>}
 243 \end{describe}
 244
 245 \begin{describe}{gf}{check-message-type @<message> @<type>}
 246 \end{describe}
 247
 248 \begin{describe}{fun}
 249     {find-message-by-name @<class> @<super-nick> @<message-name>
 250       @> @<message>}
 251 \end{describe}
 252
 253 \begin{describe}{cls}
 254     {sod-method () \&key :message :location :class :type :body}
 255 \end{describe}
 256
 257 \begin{describe*}
 258     {\dhead{gf}{sod-method-message @<method> @> @<message>}
 259      \dhead{gf}{sod-method-class @<method> @> @<class>}
 260      \dhead{gf}{sod-method-type @<method> @> @<c-type>}
 261      \dhead{gf}{sod-method-body @<method> @> @<fragment-or-nil>}}
 262 \end{describe*}
 263
 264 \begin{describe}{gf}
 265     {make-sod-method
 266         \=@<class> @<nick> @<name> @<type> @<body>            \+\\
 267           @<pset> \&key :location                             \-
 268       \nlret @<method>}
 269 \end{describe}
 270
 271 \begin{describe}{gf}
 272     {make-sod-method-using-message
 273         \=@<message> @<class>
 274           @<type> @<body>                                     \+\\
 275           @<pset> \&key :location                             \-
 276       \nlret @<method>}
 277 \end{describe}
 278
 279 \begin{describe}{gf}
 280     {sod-message-method-class @<message> @<class> @<pset> @> @<method-class>}
 281 \end{describe}
 282
 283 \begin{describe}{gf}{check-method-type @<method> @<message> @<type>}
 284 \end{describe}
 285
 286 \begin{describe}{fun}
 287     {argument-lists-compatible-p @<message-args> @<method-args>
 288       @> @<generalized-boolean>}
 289 \end{describe}
 290
 291 \begin{describe}{fun}{check-method-return-type @<method-type> @<return-type>}
 292 \end{describe}
 293
 294 \begin{describe}{fun}
 295     {check-method-return-type-against-message @<method-type> @<message-type>}
 296 \end{describe}
 297
 298 \begin{describe}{fun}
 299     {check-method-argument-lists @<method-type> @<message-type>}
 300 \end{describe}
 301
 302 %%%--------------------------------------------------------------------------
 303 \section{Class finalization protocol} \label{sec:meta.finalization}
 304
 305 \begin{describe}{mac}
 306     {finalization-error (@<token> @<arg>^*) \\ \ind
 307       @<declaration>^* \\
 308       @<form>^* \-
 309      \nlret @<value>^*}
 310 \end{describe}
 311
 312 \begin{describe}{fun}{finalization-failed}
 313 \end{describe}
 314
 315 \begin{describe*}
 316     {\dhead{gf}{sod-class-precedence-list @<class> @> @<list>}
 317      \dhead{gf}{sod-class-type @<class> @> @<c-type>}
 318      \dhead{gf}{sod-class-chain-head @<class> @> @<class>}
 319      \dhead{gf}{sod-class-chain @<class> @> @<list>}
 320      \dhead{gf}{sod-class-chains @<class> @> @<list>}
 321      \dhead{gf}{sod-class-state @<class> @> @<state>}}
 322 \end{describe*}
 323
 324 \begin{describe}{gf}{compute-cpl @<class> @> @<list>}
 325 \end{describe}
 326
 327 \begin{describe}{fun}
 328     {report-class-list-merge-error @<class> @<lists> @<error>}
 329 \end{describe}
 330
 331 \begin{describe}{fun}{merge-class-lists @<class> @<lists> @<pick> @> @<list>}
 332 \end{describe}
 333
 334 \begin{describe}{gf}{compute-chains @<class> @> @<list>}
 335 \end{describe}
 336
 337 \begin{describe}{gf}{check-class-initializer @<slot> @<class>}
 338   \begin{describe}{meth}{effective-slot,sod-class}
 339       {check-class-initializer (@<slot> effective-slot) (@<class> sod-class)}
 340   \end{describe}
 341   \begin{describe}{meth}{sod-class-effective-slot,sod-class}
 342       {check-class-initializer (@<slot> sod-class-effective-slot)
 343                                (@<class> sod-class)}
 344   \end{describe}
 345 \end{describe}
 346
 347 \begin{describe}{gf}{check-sod-class @<class>}
 348 \end{describe}
 349
 350 \begin{describe}{gf}{finalize-sod-class @<class> @> @<generalized-boolean>}
 351   \begin{describe}{meth}{sod-class}
 352       {finalize-sod-class (@<class> sod-class)}
 353   \end{describe}
 354   \begin{describe}{ar-meth}{sod-class}
 355       {finalize-sod-class (@<class> sod-class) @> @<generalized-boolean>}
 356   \end{describe}
 357 \end{describe}
 358
 359 \begin{describe}{fun}{clos-cpl @<class> @> @<list>}
 360 \end{describe}
 361
 362 \begin{describe}{fun}{dylan-cpl @<class> @> @<list>}
 363 \end{describe}
 364
 365 \begin{describe}{fun}{c3-cpl @<class> @> @<list>}
 366 \end{describe}
 367
 368 \begin{describe}{fun}{flavors-cpl @<class> @> @<list>}
 369 \end{describe}
 370
 371 \begin{describe}{fun}{python-cpl @<class> @> @<list>}
 372 \end{describe}
 373
 374 \begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
 375 \end{describe}
 376
 377 %%%----- That's all, folks --------------------------------------------------
 378
 379 %%% Local variables:
 380 %%% mode: LaTeX
 381 %%% TeX-master: "sod.tex"
 382 %%% TeX-PDF-mode: t
 383 %%% End: