3 ;;; Class finalization protocol
5 ;;; (c) 2009 Straylight/Edgeware
8 ;;;----- Licensing notice ---------------------------------------------------
10 ;;; This file is part of the Sensble Object Design, an object system for C.
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.
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.
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.
28 ;;;--------------------------------------------------------------------------
29 ;;; Protocol definition.
31 (defgeneric compute-cpl (class)
33 "Returns the class precedence list for CLASS."))
35 (defgeneric compute-chains (class)
37 "Compute the layout chains for CLASS.
39 Returns the following three values.
41 * the head of the class's primary chain;
43 * the class's primary chain as a list, most- to least-specific; and
45 * the complete collection of chains, as a list of lists, each most- to
46 least-specific, with the primary chain first.
48 These values will be stored in the CHAIN-HEAD, CHAIN and CHAINS slots.
50 If the chains are ill-formed (i.e., not distinct) then an error is
53 (defgeneric check-sod-class (class)
55 "Check the CLASS for validity.
57 This is done as part of class finalization. The checks performed are as
60 * The class name and nickname, and the names of messages, obey the
61 rules (see VALID-NAME-P).
63 * The messages and slots have distinct names.
65 * The classes in the class-precedence-list have distinct nicknames.
67 * The chain-link is actually a proper (though not necessarily direct)
70 * The chosen metaclass is actually a subclass of all of the
71 superclasses' metaclasses.
73 Returns true if all is well; false (and signals errors) if anything was
76 (defgeneric finalize-sod-class (class)
78 "Computes all of the gory details about a class.
80 Once one has stopped inserting methods and slots and so on into a class,
81 one needs to finalize it to determine the layout structure and the class
82 precedence list and so on. More precisely that gets done is this:
84 * Related classes (i.e., direct superclasses and the metaclass) are
85 finalized if they haven't been already.
87 * If you've been naughty and failed to store a list of slots or
88 whatever, then an empty list is inserted.
90 * The class precedence list is computed and stored.
92 * The class is checked for compiance with the well-formedness rules.
94 * The layout chains are computed."))
96 ;;;----- That's all, folks --------------------------------------------------