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               :messages :methods}
  37 \end{describe}
  38
  39 \begin{describe*}
  40     {\dhead{gf}{sod-class-name @<class> @> @<string>}
  41      \dhead{gf}{sod-class-nickname @<class> @> @<string>}
  42      \dhead{gf}{sod-class-direct-superclasses @<class> @> @<list>}
  43      \dhead{gf}{sod-class-chain-link @<class> @> @<class-or-nil>}
  44      \dhead{gf}{sod-class-metaclass @<class> @> @<metaclass>}
  45      \dhead{gf}{sod-class-slots @<class> @> @<list>}
  46      \dhead{gf}{setf (sod-class-slots @<class>) @<list>}
  47      \dhead{gf}{sod-class-instance-initializers @<class> @> @<list>}
  48      \dhead{gf}{setf (sod-class-instance-initializers @<class>) @<list>}
  49      \dhead{gf}{sod-class-class-initializers @<class> @> @<list>}
  50      \dhead{gf}{setf (sod-class-class-initializers @<class>) @<list>}
  51      \dhead{gf}{sod-class-messages @<class> @> @<list>}
  52      \dhead{gf}{setf (sod-class-messages @<class>) @<list>}
  53      \dhead{gf}{sod-class-methods @<class> @> @<list>}
  54      \dhead{gf}{setf (sod-class-methods @<class>) @<list>}}
  55 \end{describe*}
  56
  57 %% layout protocol
  58 \begin{describe*}
  59     {\dhead{gf}{sod-class-ilayout <class> @> @<ilayout>}
  60      \dhead{gf}{sod-class-effective-methods @<class> @> @<list>}
  61      \dhead{gf}{sod-class-vtables @<class> @> @<list>}}
  62 \end{describe*}
  63
  64 \begin{describe}{gf}{guess-metaclass @<class> @> @<metaclass>}
  65 \end{describe}
  66
  67 \begin{describe}{fun}
  68     {make-sod-class @<name> @<superclasses> @<pset> \&optional @<floc>
  69       @> @<class>}
  70 \end{describe}
  71
  72 \begin{describe}{mac}
  73     {define-sod-class @<name> (@<superclass>^*) \\ \ind
  74       @{ @<keyword> @<value> @}^* \\
  75       @<declaration>^* \\
  76       @<form>^*}
  77 \end{describe}
  78
  79 \begin{describe*}
  80     {\dhead{lmac}{slot @<name> @<type> @{ @<keyword> @<value> @}^*}
  81      \dhead{lmac}{instance-initializer @<nick> @<name>
  82                                        @<value-kind> @<value-form>
  83                                        @{ @<keyword> @<value> @}^*}
  84      \dhead{lmac}{class-initializer @<nick> @<name>
  85                                     @<value-kind> @<value-form>
  86                                     @{ @<keyword> @<value> @}^*}
  87      \dhead{lmac}{message @<name> @<type> @{ @<keyword> @<value> @}^*}
  88      \dhead{lmac}{method @<nick> @<name> @<type> @<body>
  89                          @{ @<keyword> @<value> @}^*}}
  90 \end{describe*}
  91
  92 \begin{describe}{fun}
  93     {find-superclass-by-nick @<class> @<nick> @> @<superclass>}
  94 \end{describe}
  95
  96 \begin{describe}{fun}
  97     {sod-subclass-p @<class-a> @<class-b> @> @<generalized-boolean>}
  98 \end{describe}
  99
 100 \begin{describe}{fun}{valid-name-p @<name> @> @<generalized-boolean>}
 101 \end{describe}
 102
 103 \begin{describe}{fun}{find-root-superclass @<class> @> @<superclass>}
 104 \end{describe}
 105
 106 \begin{describe}{fun}{find-root-metaclass @<class> @> @<metaclass>}
 107 \end{describe}
 108
 109 \begin{describe}{cls}{sod-slot () \&key :name :location :pset :class :type}
 110 \end{describe}
 111
 112 \begin{describe*}
 113     {\dhead{gf}{sod-slot-name @<slot> @> @<string>}
 114      \dhead{gf}{sod-slot-class @<slot> @> @<class>}
 115      \dhead{gf}{sod-slot-type @<slot> @> @<c-type>}}
 116 \end{describe*}
 117
 118 \begin{describe}{gf}
 119     {make-sod-slot @<class> @<name> @<type> @<pset> \&optional @<floc>
 120       @> @<slot>}
 121 \end{describe}
 122
 123 \begin{describe*}
 124     {\dhead{fun}
 125       {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
 126         @> @<slot>}
 127      \dhead{fun}
 128       {find-class-slot-by-name @<class> @<super-nick> @<slot-name>
 129         @> @<slot>}}
 130 \end{describe*}
 131
 132 \begin{describe}{fun}
 133     {find-instance-slot-by-name @<class> @<super-nick> @<slot-name>
 134       @> @<slot>}
 135 \end{describe}
 136
 137 \begin{describe}{cls}
 138     {sod-class-slot (sod-slot) \\ \ind
 139       \&key :name :location :pset :class :type
 140             :initializer-function :prepare-function}
 141 \end{describe}
 142
 143 \begin{describe*}
 144     {\dhead{gf}{sod-slot-initializer-function @<slot> @> @<function>}
 145      \dhead{gf}{sod-slot-prepare-function @<slot> @> @<function>}}
 146 \end{describe*}
 147
 148 \begin{describe*}
 149     {\dhead{cls}{sod-initializer ()
 150        \&key :slot :location :class :value-kind :value-form}
 151      \dhead{cls}{sod-instance-initializer (sod-initializer)
 152        \&key :slot :location :class :value-kind :value-form}
 153      \dhead{cls}{sod-class-initializer (sod-initializer)
 154        \&key :slot :location :class :value-kind :value-form}}
 155 \end{describe*}
 156
 157 \begin{describe*}
 158     {\dhead{gf}{sod-initializer-slot @<init> @> @<slot>}
 159      \dhead{gf}{sod-initializer-value-kind @<init> @> @<kind>}
 160      \dhead{gf}{sod-initializer-value-form @<init> @> @<fragment>}}
 161 \end{describe*}
 162
 163 \begin{describe*}
 164     {\dhead{gf}
 165       {make-slot-instance-initializer \=@<class> @<nick> @<name>
 166                                         @<value-kind> @<value-form> \+ \\
 167                                         @<pset> \&optional @<floc> \-
 168         \nlret @<init>}
 169      \dhead{gf}
 170       {make-slot-class-initializer \=@<class> @<nick> @<name>
 171                                      @<value-kind> @<value-form> \+ \\
 172                                      @<pset> \&optional @<floc> \-
 173         \nlret @<init>}}
 174 \end{describe*}
 175
 176 \begin{describe}{gf}
 177     {make-sod-initializer-using-slot \=@<class> @<slot> @<init-class>
 178                                        @<value-kind> @<value-form> \+ \\
 179                                        @<pset> \&optional @<floc> \-
 180       \nlret @<init>}
 181 \end{describe}
 182
 183 \begin{describe}{cls}{sod-message () \&key :name :location :class :type}
 184 \end{describe}
 185
 186 \begin{describe*}
 187     {\dhead{gf}{sod-message-name @<message> @> @<string>}
 188      \dhead{gf}{sod-message-class @<message> @> @<class>}
 189      \dhead{gf}{sod-message-type @<message> @> @<c-type>}}
 190 \end{describe*}
 191
 192 \begin{describe}{gf}
 193     {make-sod-message @<class> @<name> @<type> @<pset> \&optional @<floc>
 194       @> @<message>}
 195 \end{describe}
 196
 197 \begin{describe}{gf}{check-message-type @<message> @<type>}
 198 \end{describe}
 199
 200 \begin{describe}{fun}
 201     {find-message-by-name @<class> @<super-nick> @<message-name>
 202       @> @<message>}
 203 \end{describe}
 204
 205 \begin{describe}{cls}
 206     {sod-method () \&key :message :location :class :type :body}
 207 \end{describe}
 208
 209 \begin{describe*}
 210     {\dhead{gf}{sod-method-message @<method> @> @<message>}
 211      \dhead{gf}{sod-method-class @<method> @> @<class>}
 212      \dhead{gf}{sod-method-type @<method> @> @<c-type>}
 213      \dhead{gf}{sod-method-body @<method> @> @<fragment-or-nil>}}
 214 \end{describe*}
 215
 216 \begin{describe}{gf}
 217     {make-sod-method \=@<class> @<nick> @<name> @<type> @<body> \+ \\
 218                        @<pset> \&optional @<floc> \-
 219       \nlret @<method>}
 220 \end{describe}
 221
 222 \begin{describe}{gf}
 223     {make-sod-method-using-message \=@<message> @<class>
 224                                      @<type> @<body> \+ \\
 225                                      @<pset> \&optional @<floc> \-
 226       \nlret @<method>}
 227 \end{describe}
 228
 229 \begin{describe}{gf}
 230     {sod-message-method-class @<message> @<class> @<pset> @> @<method-class>}
 231 \end{describe}
 232
 233 \begin{describe}{gf}{check-method-type @<method> @<message> @<type>}
 234 \end{describe}
 235
 236 \begin{describe}{fun}
 237     {argument-lists-compatible-p @<message-args> @<method-args>
 238       @> @<generalized-boolean>}
 239 \end{describe}
 240
 241 %%%--------------------------------------------------------------------------
 242 \section{Class finalization protocol} \label{sec:meta.finalization}
 243
 244 \begin{describe*}
 245     {\dhead{gf}{sod-class-precedence-list <class> @> @<list>}
 246      \dhead{gf}{sod-class-type @<class> @> @<c-type>}
 247      \dhead{gf}{sod-class-chain-head @<class> @> @<class>}
 248      \dhead{gf}{sod-class-chain @<class> @> @<list>}
 249      \dhead{gf}{sod-class-chains @<class> @> @<list>}
 250      \dhead{gf}{sod-class-state @<class> @> @<state>}}
 251 \end{describe*}
 252
 253 \begin{describe}{gf}{compute-cpl @<class> @> @<list>}
 254 \end{describe}
 255
 256 \begin{describe}{gf}{compute-chains @<class> @> @<list>}
 257 \end{describe}
 258
 259 \begin{describe}{gf}{check-sod-class @<class>}
 260 \end{describe}
 261
 262 \begin{describe}{gf}{finalize-sod-class @<class>}
 263 \end{describe}
 264
 265 \begin{describe}{fun}{clos-cpl @<class> @> @<list>}
 266 \end{describe}
 267
 268 \begin{describe}{fun}{dylan-cpl @<class> @> @<list>}
 269 \end{describe}
 270
 271 \begin{describe}{fun}{c3-cpl @<class> @> @<list>}
 272 \end{describe}
 273
 274 \begin{describe}{fun}{flavors-cpl @<class> @> @<list>}
 275 \end{describe}
 276
 277 \begin{describe}{fun}{python-cpl @<class> @> @<list>}
 278 \end{describe}
 279
 280 \begin{describe}{fun}{l*loops-cpl @<class> @> @<list>}
 281 \end{describe}
 282 %%%----- That's all, folks --------------------------------------------------
 283
 284 %%% Local variables:
 285 %%% mode: LaTeX
 286 %%% TeX-master: "sod.tex"
 287 %%% TeX-PDF-mode: t
 288 %%% End: