;;;; in Text, HTML, and XML formats. This includes hyperlinking
;;;; capability and sub-objects.
;;;;
-;;;; $Id: mop.lisp,v 1.13 2002/12/13 22:26:41 kevin Exp $
-;;;;
-;;;; This file is Copyright (c) 2000-2002 by Kevin M. Rosenberg
+;;;; $Id: mop.lisp,v 1.71 2003/05/14 05:36:22 kevin Exp $
;;;;
+;;;; This file is Copyright (c) 2000-2003 by Kevin M. Rosenberg
;;;; *************************************************************************
(in-package :hyperobject)
(user-name :initarg :user-name :type string :initform nil
:accessor user-name
:documentation "User name for class")
+ (user-name-plural :initarg :user-name-plural :type string :initform nil
+ :accessor user-name-plural
+ :documentation "Plural user name for class")
(default-print-slots :initarg :default-print-slots :type list :initform nil
:accessor default-print-slots
:documentation "Defaults slots for a view")
(version :initarg :version :initform nil
:accessor version
:documentation "Version number for class")
- (sql-name :initarg :table-name :initform nil)
+ (sql-name :initarg :sql-name :initform nil)
;;; The remainder of these fields are calculated one time
;;; in finalize-inheritence.
"List of fields that contain a list of subobjects objects.")
(hyperlinks :type list :initform nil :accessor hyperlinks
:documentation "List of fields that have hyperlinks")
- (direct-rules :type list :initform nil :accessor direct-rules
+ (direct-rules :type list :initform nil :initarg :direct-rules
+ :accessor direct-rules
:documentation "List of rules to fire on slot changes.")
(class-id :type integer :initform nil
:accessor class-id
(defclass subobject ()
((name-class :type symbol :initform nil :initarg :name-class :reader name-class)
(name-slot :type symbol :initform nil :initarg :name-slot :reader name-slot)
- (lookup :type symbol :initform nil :initarg :lookup :reader lookup)
+ (lookup :type (or function symbol) :initform nil :initarg :lookup :reader lookup)
(lookup-keys :type list :initform nil :initarg :lookup-keys
:reader lookup-keys))
(:documentation "Contains subobject information"))
(defclass hyperlink ()
((name :type symbol :initform nil :initarg :name :reader name)
- (lookup :type function :initform nil :initarg :lookup :reader lookup)
+ (lookup
+ ;; The type specifier seems to break sbcl
+ :type (or function symbol)
+ ;; :type t
+ :initform nil :initarg :lookup :reader lookup)
(link-parameters :type list :initform nil :initarg :link-parameters
:reader link-parameters)))
(init-hyperobject-class cl)
)
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (when (>= (length (generic-function-lambda-list
+ (ensure-generic-function
+ 'compute-effective-slot-definition)))
+ 3)
+ (pushnew :ho-normal-cesd cl:*features*))
+
+ (when (>= (length (generic-function-lambda-list
+ (ensure-generic-function
+ 'direct-slot-definition-class)))
+ 3)
+ (pushnew :ho-normal-dsdc cl:*features*))
+
+ (when (>= (length (generic-function-lambda-list
+ (ensure-generic-function
+ 'effective-slot-definition-class)))
+ 3)
+ (pushnew :ho-normal-esdc cl:*features*)))
+
;; Slot definitions
-(defmethod direct-slot-definition-class ((cl hyperobject-class)
- #+allegro &rest
- iargs)
+(defmethod direct-slot-definition-class ((cl hyperobject-class)
+ #+ho-normal-dsdc &rest iargs)
(find-class 'hyperobject-dsd))
+(defmethod effective-slot-definition-class ((cl hyperobject-class)
+ #+ho-normal-esdc &rest iargs)
+ (find-class 'hyperobject-esd))
-; Slot definitions
+
+;;; Slot definitions
(eval-when (:compile-toplevel :load-toplevel :execute)
(defmacro process-class-option (slot-name &optional required)
`(defmethod clos:process-a-class-option ((class hyperobject-class)
(name (eql ,slot-name))
value)
- (when (and ,required (null value))
- (error "hyperobject class slot ~A must have a value" name))
- (list name `',value))
+ (when (and ,required (null value))
+ (error "hyperobject class slot ~A must have a value" name))
+ (list name `',value))
#+(or allegro sbcl cmu scl)
(declare (ignore slot-name required))
)
`(defmethod clos:process-a-slot-option ((class hyperobject-class)
(option (eql ,slot-name))
value
- already-processed-other-options
+ already-processed-options
slot)
- (list option `',value))
+ (list* option `',value already-processed-options))
#-lispworks
(declare (ignore slot-name))
)
(eval
`(defclass hyperobject-dsd (standard-direct-slot-definition)
- (,@(mapcar #'(lambda (x)
- `(,(intern (symbol-name x))
- :initform nil))
- *slot-options-no-initarg*)
- ,@(mapcar #'(lambda (x)
- `(,(intern (symbol-name x))
- :initarg
- ,(intern (symbol-name x) (symbol-name :keyword))
- :initform nil
- :accessor
- ,(intern (concatenate 'string
- (symbol-name :dsd-)
- (symbol-name x)))))
- *slot-options*))))
+ (,@(mapcar #'(lambda (x)
+ `(,(intern (symbol-name x))
+ :initform nil))
+ *slot-options-no-initarg*)
+ ,@(mapcar #'(lambda (x)
+ `(,(intern (symbol-name x))
+ :initarg
+ ,(intern (symbol-name x) (symbol-name :keyword))
+ :initform nil
+ :accessor
+ ,(intern (concatenate 'string
+ (symbol-name :dsd-)
+ (symbol-name x)))))
+ *slot-options*))))
(eval
`(defclass hyperobject-esd (standard-effective-slot-definition)
- (,@(mapcar #'(lambda (x)
- `(,(intern (symbol-name x))
- :initarg
- ,(intern (symbol-name x) (symbol-name :keyword))
- :initform nil
- :accessor
- ,(intern (concatenate 'string
- (symbol-name :esd-)
- (symbol-name x)))))
- (append *slot-options* *slot-options-no-initarg*)))))
+ (,@(mapcar #'(lambda (x)
+ `(,(intern (symbol-name x))
+ :initarg
+ ,(intern (symbol-name x) (symbol-name :keyword))
+ :initform nil
+ :accessor
+ ,(intern (concatenate 'string
+ (symbol-name :esd-)
+ (symbol-name x)))))
+ (append *slot-options* *slot-options-no-initarg*)))))
) ;; eval-when
(defun intern-in-keyword (obj)
(t
obj)))
-(defmethod compute-effective-slot-definition :around ((cl hyperobject-class)
- #+(or allegro lispworks) name
- dsds)
- #+allergo (declare (ignore name))
+(defun canonicalize-value-type (vt)
+ (typecase vt
+ (atom
+ (ensure-keyword vt))
+ (cons
+ (cons (ensure-keyword (car vt)) (cdr vt)))
+ (t
+ t)))
+
+#+ignore
+(defmethod compute-effective-slot-definition :around ((cl hyperobject-class) #+ho-normal-cesd name dsds)
+ #+allegro (declare (ignore name))
(let* ((dsd (car dsds))
- (ho-type (intern-in-keyword (slot-value dsd 'type)))
- (sql-type (ho-type-to-sql-type ho-type))
- (length (when (consp ho-type) (cadr ho-type))))
- #+allergo (declare (ignore name))
- (setf (slot-value dsd 'ho-type) ho-type)
- (setf (slot-value dsd 'sql-type) sql-type)
- (setf (slot-value dsd 'type) (ho-type-to-lisp-type ho-type))
- (let ((ia (compute-effective-slot-definition-initargs
- cl #+lispworks name dsds)))
- (apply
- #'make-instance 'hyperobject-esd
- :ho-type ho-type
- :sql-type sql-type
- :length length
- :print-formatter (slot-value dsd 'print-formatter)
- :subobject (slot-value dsd 'subobject)
- :hyperlink (slot-value dsd 'hyperlink)
- :hyperlink-parameters (slot-value dsd 'hyperlink-parameters)
- :description (slot-value dsd 'description)
- :user-name (slot-value dsd 'user-name)
- :index (slot-value dsd 'index)
- :value-constraint (slot-value dsd 'value-constraint)
- :null-allowed (slot-value dsd 'null-allowed)
- ia))))
-
-(defun ho-type-to-lisp-type (ho-type)
- (when (consp ho-type)
- (setq ho-type (car ho-type)))
- (check-type ho-type symbol)
- (case ho-type
- ((or :string :cdata :varchar :char)
- 'string)
+ (value-type (canonicalize-value-type (slot-value dsd 'value-type))))
+ (multiple-value-bind (sql-type length) (value-type-to-sql-type value-type)
+ (setf (slot-value dsd 'sql-type) sql-type)
+ (setf (slot-value dsd 'type) (value-type-to-lisp-type value-type))
+ (let ((ia (compute-effective-slot-definition-initargs cl #+lispworks name dsds)))
+ (apply
+ #'make-instance 'hyperobject-esd
+ :value-type value-type
+ :sql-type sql-type
+ :length length
+ :print-formatter (slot-value dsd 'print-formatter)
+ :subobject (slot-value dsd 'subobject)
+ :hyperlink (slot-value dsd 'hyperlink)
+ :hyperlink-parameters (slot-value dsd 'hyperlink-parameters)
+ :description (slot-value dsd 'description)
+ :user-name (slot-value dsd 'user-name)
+ :user-name-plural (slot-value dsd 'user-name-plural)
+ :index (slot-value dsd 'index)
+ :value-constraint (slot-value dsd 'value-constraint)
+ :null-allowed (slot-value dsd 'null-allowed)
+ ia)))))
+
+(defmethod compute-effective-slot-definition :around ((cl hyperobject-class) #+ho-normal-cesd name dsds)
+ #+ho-normal-cesd (declare (ignore name))
+ (let* ((esd (call-next-method))
+ (dsd (car dsds))
+ (value-type (canonicalize-value-type (slot-value dsd 'value-type))))
+ (multiple-value-bind (sql-type length) (value-type-to-sql-type value-type)
+ (setf (slot-value esd 'sql-type) sql-type)
+ (setf (slot-value esd 'length) length)
+ (setf (slot-value esd 'type) (value-type-to-lisp-type value-type))
+ (setf (slot-value esd 'value-type) value-type)
+ (dolist (name '(print-formatter subobject hyperlink hyperlink-parameters
+ description value-constraint index null-allowed user-name))
+ (setf (slot-value esd name) (slot-value dsd name)))
+ esd)))
+
+
+#+ho-normal-cesd
+(setq cl:*features* (delete :ho-normal-cesd cl:*features*))
+#+ho-normal-dsdc
+(setq cl:*features* (delete :ho-normal-dsdc cl:*features*))
+#+ho-normal-esdc
+(setq cl:*features* (delete :ho-normal-esdc cl:*features*))
+
+(defun lisp-type-is-a-string (type)
+ (or (eq type 'string)
+ (and (listp type) (some #'(lambda (x) (eq x 'string)) type))))
+
+(defun value-type-to-lisp-type (value-type)
+ (case (if (atom value-type)
+ value-type
+ (car value-type))
+ ((:string :cdata :varchar :char)
+ '(or null string))
(:character
- 'character)
- (:fixnum
- 'fixnum)
- (:boolean
- 'boolean)
- (:integer
- 'integer)
- ((or :float :single-float)
- 'single-float)
- (:double-float
- 'double-float)
- (nil
- t)
- (otherwise
- ho-type)))
-
-(defun ho-type-to-sql-type (ho-type)
- (when (consp ho-type)
- (setq ho-type (car ho-type)))
- (check-type ho-type symbol)
- (case ho-type
- ((or :string :cdata)
- 'string)
+ '(or null character))
(:fixnum
- 'integer)
+ '(or null fixnum))
(:boolean
- 'boolean)
+ '(or null boolean))
(:integer
- 'integer)
- ((or :float :single-float)
- 'single-float)
+ '(or null integer))
+ ((:float :single-float)
+ '(or null single-float))
(:double-float
- 'double-float)
- (nil
- t)
+ '(or null double-float))
(otherwise
- ho-type)))
-
+ t)))
+
+(defun value-type-to-sql-type (value-type)
+ "Return two values, the sql type and field length."
+ (let ((type (if (atom value-type)
+ value-type
+ (car value-type)))
+ (length (when (consp value-type)
+ (cadr value-type))))
+ (values
+ (case type
+ ((:string :cdata)
+ :string)
+ ((:fixnum :integer)
+ :integer)
+ (:boolean
+ :boolean)
+ ((:float :single-float)
+ :single-float)
+ (:double-float
+ :double-float)
+ (otherwise
+ :text))
+ length)))
;;;; Class initialization function
(push (list 'slot-value the-instance (list 'quote key)) keys))
(setq keys (nreverse keys))
`(defmethod slot-unbound (,the-class (,the-instance ,class)
- (,the-slot-name (eql ',slot-name)))
- (declare (ignore ,the-class))
- (setf (slot-value ,the-instance ,the-slot-name)
- (,reader ,@keys)))))
+ (,the-slot-name (eql ',slot-name)))
+ (declare (ignore ,the-class))
+ (setf (slot-value ,the-instance ,the-slot-name) (,reader ,@keys)))))
+
+
+#+lispworks
+(defun intern-eql-specializer (slot)
+ `(eql ,slot))
+
+#+(or sbcl cmu lispworks)
+(defun ensure-lazy-reader (class-name slot-name reader &rest reader-keys)
+ (let ((keys nil)
+ (gf (ensure-generic-function 'slot-unbound)))
+ (dolist (key reader-keys)
+ (push (list 'slot-value 'the-instance (list 'quote key)) keys))
+ (setq keys (nreverse keys))
+ (multiple-value-bind (method-lambda init-args-values)
+ (make-method-lambda
+ gf
+ (class-prototype (generic-function-method-class gf))
+ #-lispworks
+ `(lambda (the-class the-instance the-slot-name)
+ (declare (ignore the-class))
+ (setf (slot-value the-instance the-slot-name) (,reader ,@keys)))
+ #+lispworks
+ '(the-class the-instance the-slot-name)
+ #+lispworks
+ nil
+ #+lispworks
+ `(setf (slot-value the-instance the-slot-name) (,reader ,@keys))
+ nil)
+ (add-method gf
+ (apply
+ #'make-instance (generic-function-method-class gf)
+ ':specializers (list (class-of (find-class class-name))
+ (find-class class-name)
+ (intern-eql-specializer slot-name))
+ ':lambda-list '(the-class the-instance the-slot-name)
+ ':function (compile nil method-lambda)
+ init-args-values)))))
(defun finalize-subobjects (cl)
"Process class subobjects slot"
(setf (subobjects cl)
- (let ((subobjects '()))
- (dolist (slot (class-slots cl))
- (let-when (subobj-def (esd-subobject slot))
- (let ((subobject (make-instance 'subobject
- :name-class (class-name cl)
- :name-slot (slot-definition-name slot)
- :lookup (if (atom subobj-def)
- subobj-def
- (car subobj-def))
- :lookup-keys (if (atom subobj-def)
- nil
- (cdr subobj-def)))))
- (unless (eq (lookup subobject) t)
- (eval `(def-lazy-reader ,(name-class subobject)
- ,(name-slot subobject) ,(lookup subobject)
- ,@(lookup-keys subobject))))
- (push subobject subobjects))))
- subobjects)))
+ (let ((subobjects '()))
+ (dolist (slot (class-slots cl))
+ (let-when
+ (subobj-def (esd-subobject slot))
+ (let ((subobject
+ (make-instance 'subobject
+ :name-class (class-name cl)
+ :name-slot (slot-definition-name slot)
+ :lookup (if (atom subobj-def)
+ subobj-def
+ (car subobj-def))
+ :lookup-keys (if (atom subobj-def)
+ nil
+ (cdr subobj-def)))))
+ (unless (eq (lookup subobject) t)
+ #-(or sbcl cmu lispworks)
+ (eval
+ `(hyperobject::def-lazy-reader ,(name-class subobject)
+ ,(name-slot subobject) ,(lookup subobject)
+ ,@(lookup-keys subobject)))
+ #+(or sbcl cmu lispworks)
+ (apply #'ensure-lazy-reader
+ (name-class subobject) (name-slot subobject)
+ (lookup subobject) (lookup-keys subobject)))
+ (push subobject subobjects))))
+ ;; sbcl/cmu reverse class-slots compared to the defclass form
+ ;; so re-reverse on cmu/sbcl
+ #+(or cmu sbcl) subobjects
+ #-(or cmu sbcl) (nreverse subobjects)
+ )))
+
+
+(defun finalize-class-slots (cl)
+ "Make sure all class slots have an expected value"
+ (unless (user-name cl)
+ (setf (user-name cl) (format nil "~:(~A~)" (class-name cl))))
+
+ (setf (user-name-plural cl)
+ (if (and (consp (user-name cl)) (cadr (user-name cl)))
+ (cadr (user-name cl))
+ (format nil "~A~P" (if (consp (user-name cl))
+ (car (user-name cl))
+ (user-name cl))
+ 2)))
+
+ (dolist (name '(user-name description))
+ (awhen (slot-value cl name)
+ (setf (slot-value cl name)
+ (etypecase (slot-value cl name)
+ (cons (car it))
+ ((or string symbol) it))))))
(defun finalize-documentation (cl)
"Calculate class documentation slot"
- (awhen (slot-value cl 'user-name)
- (setf (slot-value cl 'user-name)
- (etypecase (slot-value cl 'user-name)
- (cons (car it))
- ((or string symbol) it))))
- (awhen (slot-value cl 'description)
- (setf (slot-value cl 'description)
- (etypecase (slot-value cl 'description)
- (cons (car it))
- ((or string symbol) it))))
-
(let ((*print-circle* nil))
(setf (documentation (class-name cl) 'class)
- (format nil "Hyperobject~A~A~A~A"
- (aif (user-name cl)
- (format nil ": ~A" it ""))
- (aif (description cl)
- (format nil "~%Class description: ~A" it) "")
- (aif (subobjects cl)
- (format nil "~%Subobjects:~{ ~A~}" (mapcar #'name-slot it)) "")
- (aif (default-print-slots cl)
- (format nil "~%Default print slots:~{ ~A~}" it) "")
- ))))
+ (format nil "Hyperobject~A~A~A~A"
+ (aif (user-name cl)
+ (format nil ": ~A" it ""))
+ (aif (description cl)
+ (format nil "~%Class description: ~A" it) "")
+ (aif (subobjects cl)
+ (format nil "~%Subobjects:~{ ~A~}" (mapcar #'name-slot it)) "")
+ (aif (default-print-slots cl)
+ (format nil "~%Default print slots:~{ ~A~}" it) "")
+ ))))
(defun finalize-hyperlinks (cl)
(let ((hyperlinks '()))
(dolist (esd (class-slots cl))
(awhen (slot-value esd 'hyperlink)
- (push
- (make-instance 'hyperlink
- :name (slot-definition-name esd)
- :lookup it
- :link-parameters (slot-value esd 'hyperlink-parameters))
- hyperlinks)))
+ (push
+ (make-instance 'hyperlink
+ :name (slot-definition-name esd)
+ :lookup it
+ :link-parameters (slot-value esd 'hyperlink-parameters))
+ hyperlinks)))
+ ;; cmu/sbcl reverse class-slots compared to the defclass form
+ ;; hyperlinks is already reversed from the dolist/push loop, so re-reverse on sbcl/cmu
+ #-(or cmu sbcl) (setq hyperlinks (nreverse hyperlinks))
(setf (slot-value cl 'hyperlinks) hyperlinks)))
(defun init-hyperobject-class (cl)
(finalize-hyperlinks cl)
(finalize-sql cl)
(finalize-rules cl)
+ (finalize-class-slots cl)
(finalize-documentation cl))
(find name (class-slots cl) :key #'slot-definition-name))
(defun hyperobject-class-user-name (obj)
- (awhen (user-name (class-of obj))
- (if (consp it)
- (car it)
- it)))
+ (user-name (class-of obj)))
+
+(defun hyperobject-class-user-name-plural (obj)
+ (user-name-plural (class-of obj)))
(defun hyperobject-class-subobjects (obj)
(subobjects (class-of obj)))
(defun hyperobject-class-hyperlinks (obj)
(hyperlinks (class-of obj)))
-(defun hyperobject-class-fields (obj)
- (class-slots (class-of obj)))
-
-;;; Slot accessor and class rules
-
-(defclass rule ()
- ((dependants :initarg dependants :initform nil :accessor dependants)
- (volatile :initarg modifieds :initform nil :accessor modifieds)
- (source-code :initarg source-code :initform nil :accessor source-code)
- (function :initform nil :accessor function)))
+(defun hyperobject-class-slots (obj)
+ ;; cmucl/sbcl reverse class-slots
+ #+(or cmu sbcl) (reverse (class-slots (class-of obj)))
+ #-(or cmu sbcl) (class-slots (class-of obj)))
-(defun compile-rule (source-code cl)
- )
-
-(defun finalize-rules (cl)
- (let* ((direct-rules (direct-rules cl))
- (rule-vector (make-vector (length direct-rules) :fill-pointer nil
- :adjustable nil)))
- (dotimes (i (length direct-rules))
- (destructuring-bind (name (&key dependants volatile) &rest source-code)
- (nth i direct-rules)
- (setf (aref rule-vector i) (make-instance 'rule
- :name name
- :dependants depedenants
- :volatile volatile
- :source-code source-code
- :function (compile-rule source-code cl)))))
- (setf (rules cl) rule-vector)))
-
-(defun fire-class-rules (cl obj)
- "Fire all class rules. Called after a slot is modified."
- (dolist (rule (direct-rules cl))
- (cmsg "firing rule: ~a" rule)))
-
-
-(defmethod (setf slot-value-using-class)
- :around (new-value (cl hyperobject-class) obj
- (slot standard-effective-slot-definition))
- (cmsg-c :verbose "Setf slot value: class: ~s, obj: ~s, slot: ~s, value: ~s" cl (class-of obj) slot new-value)
- (let ((func (esd-value-constraint slot)))
- (cond
- ((and func (not (funcall func new-value obj)))
- (warn "Rejected change to value of slot ~a of object ~a"
- (slot-definition-name slot) obj)
- (slot-value obj (slot-definition-name slot)))
- (t
- (call-next-method)
- (fire-class-rules cl obj)
- new-value))))
-
-(defmethod slot-value-using-class :around ((cl hyperobject-class) obj
- (slot standard-effective-slot-definition))
- (let ((value (call-next-method)))
- (cmsg-c :verbose "slot value: class: ~s, obj: ~s, slot: ~s" cl (class-of obj) slot)
- value))