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