[sod] / src / class-finalize-proto.lisp

;;; -*-lisp-*-
;;;
;;; Class finalization protocol
;;;
;;; (c) 2009 Straylight/Edgeware
;;;

;;;----- Licensing notice ---------------------------------------------------
;;;
;;; This file is part of the Sensble Object Design, an object system for C.
;;;
;;; SOD is free software; you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 2 of the License, or
;;; (at your option) any later version.
;;;
;;; SOD is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with SOD; if not, write to the Free Software Foundation,
;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

(cl:in-package #:sod)

;;;--------------------------------------------------------------------------
;;; Protocol definition.

(defgeneric compute-cpl (class)
  (:documentation
   "Returns the class precedence list for CLASS."))

(defgeneric compute-chains (class)
  (:documentation
   "Compute the layout chains for CLASS.

   Returns the following three values.

     * the head of the class's primary chain;

     * the class's primary chain as a list, most- to least-specific; and

     * the complete collection of chains, as a list of lists, each most- to
       least-specific, with the primary chain first.

   These values will be stored in the CHAIN-HEAD, CHAIN and CHAINS slots.

   If the chains are ill-formed (i.e., not distinct) then an error is
   signalled."))

(defgeneric check-sod-class (class)
  (:documentation
   "Check the CLASS for validity.

   This is done as part of class finalization.  The checks performed are as
   follows.

     * The class name and nickname, and the names of messages, obey the
       rules (see VALID-NAME-P).

     * The messages and slots have distinct names.

     * The classes in the class-precedence-list have distinct nicknames.

     * The chain-link is actually a proper (though not necessarily direct)
       superclass.

     * The chosen metaclass is actually a subclass of all of the
       superclasses' metaclasses.

   Returns true if all is well; false (and signals errors) if anything was
   wrong."))

(defgeneric finalize-sod-class (class)
  (:documentation
   "Computes all of the gory details about a class.

   Once one has stopped inserting methods and slots and so on into a class,
   one needs to finalize it to determine the layout structure and the class
   precedence list and so on.  More precisely that gets done is this:

     * Related classes (i.e., direct superclasses and the metaclass) are
       finalized if they haven't been already.

     * If you've been naughty and failed to store a list of slots or
       whatever, then an empty list is inserted.

     * The class precedence list is computed and stored.

     * The class is checked for compiance with the well-formedness rules.

     * The layout chains are computed."))

;;;----- That's all, folks --------------------------------------------------
Commit	Line	Data
dea4d055 MW	1	;;; --lisp--
	2	;;;
	3	;;; Class finalization protocol
	4	;;;
	5	;;; (c) 2009 Straylight/Edgeware
	6	;;;
	7
	8	;;;----- Licensing notice ---------------------------------------------------
	9	;;;
	10	;;; This file is part of the Sensble 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	(cl:in-package #:sod)
	27
	28	;;;--------------------------------------------------------------------------
	29	;;; Protocol definition.
	30
	31	(defgeneric compute-cpl (class)
	32	(:documentation
	33	"Returns the class precedence list for CLASS."))
	34
	35	(defgeneric compute-chains (class)
	36	(:documentation
	37	"Compute the layout chains for CLASS.
	38
	39	Returns the following three values.
	40
	41	* the head of the class's primary chain;
	42
	43	* the class's primary chain as a list, most- to least-specific; and
	44
	45	* the complete collection of chains, as a list of lists, each most- to
	46	least-specific, with the primary chain first.
	47
	48	These values will be stored in the CHAIN-HEAD, CHAIN and CHAINS slots.
	49
	50	If the chains are ill-formed (i.e., not distinct) then an error is
	51	signalled."))
	52
	53	(defgeneric check-sod-class (class)
	54	(:documentation
	55	"Check the CLASS for validity.
	56
	57	This is done as part of class finalization. The checks performed are as
	58	follows.
	59
	60	* The class name and nickname, and the names of messages, obey the
	61	rules (see VALID-NAME-P).
	62
	63	* The messages and slots have distinct names.
	64
65	* The classes in the class-precedence-list have distinct nicknames.
66
67	* The chain-link is actually a proper (though not necessarily direct)
68	superclass.
69
70	* The chosen metaclass is actually a subclass of all of the
71	superclasses' metaclasses.
72
73	Returns true if all is well; false (and signals errors) if anything was
74	wrong."))
75
76	(defgeneric finalize-sod-class (class)
77	(:documentation
78	"Computes all of the gory details about a class.
79
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:
83
84	* Related classes (i.e., direct superclasses and the metaclass) are
85	finalized if they haven't been already.
86
87	* If you've been naughty and failed to store a list of slots or
88	whatever, then an empty list is inserted.
89
90	* The class precedence list is computed and stored.
91
92	* The class is checked for compiance with the well-formedness rules.
93
94	* The layout chains are computed."))
95
96	;;;----- That's all, folks --------------------------------------------------