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