r8263: rename entities.xml to entities.inc
[hyperobject.git] / mop.lisp
index c9fb4f2e89be8863dd4ec747eb1a16b0b23999e6..5307f3ed545f07ed60be74ca9ee88378f1ab2cce 100644 (file)
--- a/mop.lisp
+++ b/mop.lisp
 ;;;; in Text, HTML, and XML formats. This includes hyperlinking
 ;;;; capability and sub-objects.
 ;;;;
-;;;; $Id: mop.lisp,v 1.72 2003/05/15 06:05:46 kevin Exp $
+;;;; $Id$
 ;;;;
 ;;;; This file is Copyright (c) 2000-2003 by Kevin M. Rosenberg
 ;;;; *************************************************************************
  
-(in-package :hyperobject)
-
-(eval-when (:compile-toplevel :execute)
-  (declaim (optimize (speed 2) (safety 2) (compilation-speed 0) (debug 2))))
+(in-package #:hyperobject)
 
 ;; Main class
 
    (version :initarg :version :initform nil
            :accessor version
            :documentation "Version number for class")
-   (sql-name :initarg :sql-name :initform nil)
+   (closures :initarg :closures :initform nil
+            :accessor closures
+            :documentation "Closures to call on slot chnages")
+   (sql-name :initarg :sql-name :accessor sql-name :initform nil
+            :documentation "SQL Name for this class")
+   (guid :initarg :guid :accessor guid :initform nil
+        :documentation "ID string for this class")
 
    ;;; The remainder of these fields are calculated one time
    ;;; in finalize-inheritence.
    (direct-rules :type list :initform nil :initarg :direct-rules
                 :accessor direct-rules
                 :documentation "List of rules to fire on slot changes.")
+   (direct-views :type list :initform nil :initarg :direct-views
+                :accessor direct-views
+                :documentation "List of views")
    (class-id :type integer :initform nil
             :accessor class-id
             :documentation "Unique ID for the class")
    (default-view :initform nil :initarg :default-view :accessor default-view
                 :documentation "The default view for a class")
-
+   (documementation :initform nil :initarg :documentation
+                   :documentation "Documentation string for hyperclass.")
+   
    ;; SQL commands
    (create-table-cmd :initform nil :reader create-table-cmd)
    (create-indices-cmds :initform nil :reader create-index-cmds)
   (:documentation "Metaclass for Markup Language classes."))
 
 (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 (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"))
+  ((name-class :type symbol :initarg :name-class :reader name-class)
+   (name-slot :type symbol :initarg :name-slot :reader name-slot)
+   (subobj-class :type symbol :initarg :subobj-class :reader subobj-class)
+   (lookup :type (or function symbol) :initarg :lookup :reader lookup)
+   (lookup-keys :type list :initarg :lookup-keys :reader lookup-keys))
+  (:documentation "subobject information")
+  (:default-initargs :name-class nil :name-slot nil :subobj-class nil
+                    :lookup nil :lookup-keys nil))
 
 
 (defmethod print-object ((obj subobject) (s stream))
-  (print-unreadable-object (obj s :type t :identity t)
-    (format s "~S" (name obj))))
+  (print-unreadable-object (obj s :type t)
+    (format s "~S" (name-slot obj))))
 
 (defclass hyperlink ()
   ((name :type symbol :initform nil :initarg :name :reader name)
   (print-unreadable-object (obj s :type t :identity t)
     (format s "~S" (name obj))))
 
-#+(or cmu scl sbcl)
 (defmethod validate-superclass ((class hyperobject-class) (superclass standard-class))
   t)
 
 (defmethod finalize-inheritance :after ((cl hyperobject-class))
+  ;; Work-around needed for OpenMCL
+  #+ignore
+  (unless (find-class (class-name cl))
+    (setf (find-class (class-name cl)) cl))
+  
   (init-hyperobject-class cl)
   )
 
       (when (and ,required (null value))
        (error "hyperobject class slot ~A must have a value" name))
       (list name `',value))
-    #+(or allegro sbcl cmu scl)
+    #+(or allegro sbcl cmu scl openmcl)
     (declare (ignore slot-name required))
     )
 
     (atom
      (ensure-keyword vt))
     (cons
-     (cons (ensure-keyword (car vt)) (cdr vt)))
+     (list (ensure-keyword (car vt)) (cadr vt)))
     (t
      t)))
 
-#+ignore
-(defmethod compute-effective-slot-definition :around ((cl hyperobject-class) #+ho-normal-cesd name dsds)
-  #+allegro (declare (ignore name))
+(defmethod compute-effective-slot-definition :around ((cl hyperobject-class)
+                                                     #+ho-normal-cesd name
+                                                     dsds)
+  (declare (ignore #+ho-normal-cesd name))
+  (let ((esd (call-next-method)))
+    (if (typep esd 'hyperobject-esd)
+       (compute-hyperobject-esd esd dsds)
+       esd)))
+
+(defun compute-hyperobject-esd (esd dsds)
   (let* ((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 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)))
-
+    (multiple-value-bind (sql-type sql-length) 
+       (value-type-to-sql-type value-type)
+      (setf (esd-sql-type esd) sql-type)
+      (setf (esd-sql-length esd) sql-length))
+    (setf (slot-value esd 'type) (value-type-to-lisp-type value-type))
+    (setf (esd-value-type esd) value-type)
+    (setf (esd-user-name esd)
+         (aif (dsd-user-name dsd)
+              it
+              (string-downcase (symbol-name (slot-definition-name dsd)))))
+    (setf (esd-sql-name esd)
+         (aif (dsd-sql-name dsd)
+              it
+              (lisp-name-to-sql-name (slot-definition-name dsd))))
+    (setf (esd-sql-name esd)
+         (aif (dsd-sql-name dsd)
+              it
+              (lisp-name-to-sql-name (slot-definition-name dsd))))
+    (dolist (name '(print-formatter subobject hyperlink hyperlink-parameters
+                   description value-constraint indexed null-allowed
+                   unique short-description void-text read-only-groups
+                   hidden-groups unit disable-predicate view-type
+                   list-of-values stored))
+      (setf (slot-value esd name) (slot-value dsd name)))
+    esd))
+
+(defun lisp-name-to-sql-name (lisp)
+  "Convert a lisp name (atom or list, string or symbol) into a canonical
+SQL name"
+  (unless (stringp lisp)
+    (setq lisp
+         (typecase lisp
+           (symbol (symbol-name lisp))
+           (t (write-to-string lisp)))))
+  (do* ((len (length lisp))
+       (sql (make-string len))
+       (i 0 (1+ i)))
+      ((= i len) (string-upcase sql))
+    (declare (fixnum i)
+            (simple-string sql))
+    (setf (schar sql i)
+         (let ((c (char lisp i)))
+           (case c
+             ((#\- #\$ #\+ #\#) #\_)
+             (otherwise c))))))
 
 #+ho-normal-cesd
 (setq cl:*features* (delete :ho-normal-cesd cl:*features*))
   (or (eq type 'string)
       (and (listp type) (some #'(lambda (x) (eq x 'string)) type))))
 
+(defun base-value-type (value-type)
+  (if (atom value-type)
+      value-type
+    (car value-type)))
+
 (defun value-type-to-lisp-type (value-type)
-  (case (if (atom value-type)
-           value-type
-           (car value-type))
+  (case (base-value-type value-type)
     ((:string :cdata :varchar :char)
      '(or null string))
+    (:datetime
+     '(or null integer))
     (:character
      '(or null character))
     (:fixnum
      '(or null fixnum))
     (:boolean
      '(or null boolean))
-    (:integer
+    ((:integer :long-integer)
      '(or null integer))
     ((:float :single-float)
      '(or null single-float))
 
 (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)))
+  (let ((type (base-value-type value-type))
        (length (when (consp value-type)
                  (cadr value-type))))
     (values
      (case type
-       ((:string :cdata)
-       :string)
+       ((:char :character)
+       :char)
+       (:varchar
+       :varchar)
        ((:fixnum :integer)
        :integer)
+       (:long-integer
+       :long-integer)
        (:boolean
        :boolean)
        ((:float :single-float)
        :single-float)
        (:double-float
        :double-float)
+       (:datetime
+        :long-integer)
        (otherwise
        :text))
      length)))
 
 ;;;; Class initialization function
 
-;; defines a slot-unbound method for class and slot-name, fills
-;; the slot by calling reader function with the slot values of
-;; the instance's reader-keys
-(defmacro def-lazy-reader (class slot-name reader &rest reader-keys)
-  (let* ((the-slot-name (gensym))
-        (the-class (gensym))
-        (the-instance (gensym))
-        (keys '()))
-    (dolist (key reader-keys)
-      (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)))))
-
-
-#+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)))))
-
-#+(or allegro scl)
-(progn
-  ;; One entry for each class with lazy readers defined.  The value is a plist mapping
-  ;; slot-name to a lazy reader, each of which is a list of a function and slot-names.
-  (defvar *lazy-readers* (make-hash-table))
-
-(defmethod slot-unbound :around ((class hyperobject-class) instance slot-name)
-    (let ((lazy-reader (loop for super in (mop:class-precedence-list class)
-                            as lazy-reader = (getf (gethash super *lazy-readers*) slot-name)
-                            when lazy-reader return it)))
-      (if lazy-reader
-         (setf (slot-value instance slot-name)
-               (apply (car lazy-reader)
-                      (loop for arg-slot-name in (cdr lazy-reader)
-                            collect (slot-value instance arg-slot-name))))
-         ;; No lazy reader -- defer to regular slot-unbound handling.
-         (call-next-method))))
-
-  ;; The reader is a function and the reader-keys are slot names.  The slot is lazily set to
-  ;; the result of applying the function to the slot-values of those slots, and that value
-  ;; is also returned.
-  (defun ensure-lazy-reader (class-name slot-name reader &rest reader-keys)
-    (setf (getf (gethash (find-class class-name) *lazy-readers*) slot-name)
-         (list* reader (copy-list reader-keys))))
-
-  (defun remove-lazy-reader (class-name slot-name)
-    (setf (getf (gethash (find-class class-name) *lazy-readers*) slot-name)
-         nil))
-  
-  ) ;; #+(or allegro scl)
+;; One entry for each class with lazy readers defined.  The value is a plist mapping
+;; slot-name to a lazy reader, each of which is a list of a function and slot-names.
+(defvar *lazy-readers* (make-hash-table))
+
+(defmethod slot-unbound ((class hyperobject-class) instance slot-name)
+  (let ((lazy-reader
+        (loop for super in (class-precedence-list class)
+              as lazy-reader = (getf (gethash super *lazy-readers*) slot-name)
+              when lazy-reader return it)))
+    (if lazy-reader
+       (setf (slot-value instance slot-name)
+             (if (atom lazy-reader)
+                 (make-instance lazy-reader)
+                 (apply (car lazy-reader)
+                        (loop for arg-slot-name in (cdr lazy-reader)
+                              collect (slot-value instance arg-slot-name)))))
+       ;; No lazy reader -- defer to regular slot-unbound handling.
+       (call-next-method))))
+
+;; The reader is a function and the reader-keys are slot names.  The slot is lazily set to
+;; the result of applying the function to the slot-values of those slots, and that value
+;; is also returned.
+(defun ensure-lazy-reader (cl class-name slot-name subobj-class reader 
+                          &rest reader-keys)
+  (setf (getf (gethash cl *lazy-readers*) slot-name)
+    (aif subobj-class
+        it
+        (list* reader (copy-list reader-keys)))))
+
+(defun remove-lazy-reader (class-name slot-name)
+  (setf (getf (gethash (find-class class-name) *lazy-readers*) slot-name)
+    nil))
 
 
 (defun finalize-subobjects (cl)
                    (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)))))
+                                  :subobj-class (when (atom subobj-def)
+                                                  subobj-def)
+                                  :lookup (when (listp subobj-def)
+                                            (car subobj-def))
+                                  :lookup-keys (when (listp subobj-def)
+                                                 (cdr subobj-def)))))
               (unless (eq (lookup subobject) t)
-                #+ignore ;; #-(or sbcl cmu lispworks)
-                (eval
-                 `(hyperobject::def-lazy-reader ,(name-class subobject)
-                   ,(name-slot subobject) ,(lookup subobject)
-                   ,@(lookup-keys subobject)))
-                #+(or sbcl cmu lispworks allegro scl)
-                (apply #'ensure-lazy-reader 
+                (apply #'ensure-lazy-reader
+                       cl
                        (name-class subobject) (name-slot subobject)
-                       (lookup subobject) (lookup-keys subobject)))
-              (push subobject subobjects))))
+                       (subobj-class 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)
                                   (user-name cl))
                    2)))
 
-  (dolist (name '(user-name description))
+  (dolist (name '(user-name description version guid sql-name))
     (awhen (slot-value cl name)
           (setf (slot-value cl name)
-                (etypecase (slot-value cl name)
-                  (cons (car it))
-                  ((or string symbol) it))))))
+            (if (listp it)
+                (car it)
+              it))))
+  
+  (unless (sql-name cl)
+    (setf (sql-name cl) (lisp-name-to-sql-name (class-name cl))))
+  )
 
 (defun finalize-documentation (cl)
   "Calculate class documentation slot"
   (let ((*print-circle* nil))
-    (setf (documentation (class-name cl) 'class)
+    (setf (documentation cl 'type)
          (format nil "Hyperobject~A~A~A~A"
                  (aif (user-name cl)
                       (format nil ": ~A" it ""))
   #+(or cmu sbcl) (reverse (class-slots (class-of obj)))
   #-(or cmu sbcl) (class-slots (class-of obj)))
 
+(defun all-subobjects (obj)
+  "Returns a list of all subobjects in an object"
+  (let ((so-list '()))
+    (dolist (subobj-obj (subobjects (class-of obj)) (nreverse so-list))
+      (dolist (so (funcall (name-slot subobj-obj) obj))
+        (push so so-list)))))