14 Sep 2007 Kevin Rosenberg <kevin@rosenberg.net>
[clsql.git] / sql / metaclasses.lisp
index bb02da3899c849151288056ac2080f06ea0532d4..bed60eeea4825fca492dbd2ebc62cf0943dc07a3 100644 (file)
@@ -3,7 +3,7 @@
 ;;;;
 ;;;; $Id$
 ;;;;
-;;;; CLSQL metaclass for standard-db-objects created in the OODDL. 
+;;;; CLSQL metaclass for standard-db-objects created in the OODDL.
 ;;;;
 ;;;; This file is part of CLSQL.
 ;;;;
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (when (>= (length (generic-function-lambda-list
-                    (ensure-generic-function
-                     'compute-effective-slot-definition)))
-           3)
+                     (ensure-generic-function
+                      'compute-effective-slot-definition)))
+            3)
     (pushnew :kmr-normal-cesd cl:*features*))
-  
+
   (when (>= (length (generic-function-lambda-list
-                    (ensure-generic-function
-                     'direct-slot-definition-class)))
-           3)
+                     (ensure-generic-function
+                      'direct-slot-definition-class)))
+            3)
     (pushnew :kmr-normal-dsdc cl:*features*))
-  
+
   (when (>= (length (generic-function-lambda-list
-                    (ensure-generic-function
-                     'effective-slot-definition-class)))
-           3)
+                     (ensure-generic-function
+                      'effective-slot-definition-class)))
+            3)
     (pushnew :kmr-normal-esdc cl:*features*)))
 
 
@@ -57,7 +57,7 @@
 ;;; Lispworks 4.2 and before requires special processing of extra slot and class options
 
 (defvar +extra-slot-options+ '(:column :db-kind :db-type :db-reader :void-value :db-constraints
-                              :db-writer :db-info))
+                               :db-writer :db-info))
 (defvar +extra-class-options+ '(:base-table))
 
 #+lispworks
   (eval `(process-class-option standard-db-class ,class-option)))
 
 (defmethod validate-superclass ((class standard-db-class)
-                               (superclass standard-class))
+                                (superclass standard-class))
   t)
 
 (defun table-name-from-arg (arg)
   (cond ((symbolp arg)
-        arg)
-       ((typep arg 'sql-ident)
-        (slot-value arg 'name))
-       ((stringp arg)
-        (intern (symbol-name-default-case arg)))))
+         (intern (sql-escape arg)))
+        ((typep arg 'sql-ident)
+         (if (symbolp (slot-value arg 'name))
+             (intern (sql-escape (slot-value arg 'name)))
+             (sql-escape (slot-value arg 'name))))
+        ((stringp arg)
+         (sql-escape arg))))
 
 (defun column-name-from-arg (arg)
   (cond ((symbolp arg)
-        arg)
-       ((typep arg 'sql-ident)
-        (slot-value arg 'name))
-       ((stringp arg)
-        (intern (symbol-name-default-case arg)))))
+         arg)
+        ((typep arg 'sql-ident)
+         (slot-value arg 'name))
+        ((stringp arg)
+         (intern (symbol-name-default-case arg)))))
 
 
 (defun remove-keyword-arg (arglist akey)
   (let ((mylist arglist)
-       (newlist ()))
+        (newlist ()))
     (labels ((pop-arg (alist)
-            (let ((arg (pop alist))
-                  (val (pop alist)))
-              (unless (equal arg akey)
-                (setf newlist (append (list arg val) newlist)))
-              (when alist (pop-arg alist)))))
+             (let ((arg (pop alist))
+                   (val (pop alist)))
+               (unless (equal arg akey)
+                 (setf newlist (append (list arg val) newlist)))
+               (when alist (pop-arg alist)))))
       (pop-arg mylist))
     newlist))
 
 (defmethod initialize-instance :around ((class standard-db-class)
                                         &rest all-keys
-                                       &key direct-superclasses base-table
+                                        &key direct-superclasses base-table
                                         qualifier
-                                       &allow-other-keys)
+                                        &allow-other-keys)
   (let ((root-class (find-class 'standard-db-object nil))
-       (vmc (find-class 'standard-db-class)))
+        (vmc 'standard-db-class))
     (setf (view-class-qualifier class)
           (car qualifier))
     (if root-class
-       (if (member-if #'(lambda (super)
-                          (eq (class-of super) vmc)) direct-superclasses)
-           (call-next-method)
+        (if (some #'(lambda (super) (typep super vmc))
+                  direct-superclasses)
+            (call-next-method)
             (apply #'call-next-method
                    class
-                  :direct-superclasses (append (list root-class)
+                   :direct-superclasses (append (list root-class)
                                                 direct-superclasses)
-                  (remove-keyword-arg all-keys :direct-superclasses)))
-       (call-next-method))
+                   (remove-keyword-arg all-keys :direct-superclasses)))
+        (call-next-method))
     (setf (view-table class)
-          (table-name-from-arg (sql-escape (or (and base-table
-                                                    (if (listp base-table)
-                                                        (car base-table)
-                                                        base-table))
-                                               (class-name class)))))
+          (table-name-from-arg (or (and base-table
+                                        (if (listp base-table)
+                                            (car base-table)
+                                            base-table))
+                                   (class-name class))))
     (register-metaclass class (nth (1+ (position :direct-slots all-keys))
                                    all-keys))))
 
 (defmethod reinitialize-instance :around ((class standard-db-class)
                                           &rest all-keys
-                                          &key base-table 
+                                          &key base-table
                                           direct-superclasses qualifier
                                           &allow-other-keys)
   (let ((root-class (find-class 'standard-db-object nil))
-       (vmc (find-class 'standard-db-class)))
+        (vmc 'standard-db-class))
     (setf (view-table class)
           (table-name-from-arg (sql-escape (or (and base-table
                                                     (if (listp base-table)
     (setf (view-class-qualifier class)
           (car qualifier))
     (if (and root-class (not (equal class root-class)))
-       (if (member-if #'(lambda (super)
-                          (eq (class-of super) vmc)) direct-superclasses)
-           (call-next-method)
+        (if (some #'(lambda (super) (typep super vmc))
+                  direct-superclasses)
+            (call-next-method)
             (apply #'call-next-method
                    class
                    :direct-superclasses (append (list root-class)
                                                 direct-superclasses)
-                  (remove-keyword-arg all-keys :direct-superclasses)))
+                   (remove-keyword-arg all-keys :direct-superclasses)))
         (call-next-method)))
   (register-metaclass class (nth (1+ (position :direct-slots all-keys))
                                  all-keys)))
 
 (defun describe-db-layout (class)
   (flet ((not-db-col (col)
-           (not (member (nth 2 col)  '(nil :base :key))))
+           (not (member (nth 2 col) '(nil :base :key))))
          (frob-slot (slot)
-           (let ((type (slot-value slot 'type)))
+           (let ((type (slot-definition-type slot)))
              (if (eq type t)
                  (setq type nil))
              (list (slot-value slot 'name)
       (setq all-slots (remove-if #'not-db-col all-slots))
       (setq all-slots (stable-sort all-slots #'string< :key #'car))
       (setf (object-definition class) all-slots))
-    #-allegro
+    #-(or sbcl allegro)
     (setf (key-slots class) (remove-if-not (lambda (slot)
-                                            (eql (slot-value slot 'db-kind)
-                                                 :key))
-                                          (ordered-class-slots class)))))
+                                             (eql (slot-value slot 'db-kind)
+                                                  :key))
+                                           (ordered-class-slots class)))))
 
-#+allegro
+#+(or sbcl allegro)
 (defmethod finalize-inheritance :after ((class standard-db-class))
   (setf (key-slots class) (remove-if-not (lambda (slot)
-                                          (eql (slot-value slot 'db-kind)
-                                               :key))
-                                        (ordered-class-slots class))))
+                                           (eql (slot-value slot 'db-kind)
+                                                :key))
+                                         (ordered-class-slots class))))
 
 ;; return the deepest view-class ancestor for a given view class
 
@@ -294,54 +296,55 @@ column definition in the database.")
     :documentation "Description of the join.")
    (specified-type
     :accessor specified-type
+    :initarg specified-type
     :initform nil
-    :documentation "KMR: Internal slot storing the :type specified by user.")))
+    :documentation "Internal slot storing the :type specified by user.")))
 
 (defparameter *db-info-lambda-list*
   '(&key join-class
-        home-key
-        foreign-key
+         home-key
+         foreign-key
          (key-join nil)
          (target-slot nil)
-        (retrieval :immmediate)
-        (set nil)))
-         
+         (retrieval :immmediate)
+         (set nil)))
+
 (defun parse-db-info (db-info-list)
   (destructuring-bind
-       (&key join-class home-key key-join foreign-key (delete-rule nil)
-             (target-slot nil) (retrieval :deferred) (set nil))
+        (&key join-class home-key key-join foreign-key (delete-rule nil)
+              (target-slot nil) (retrieval :deferred) (set t))
       db-info-list
     (let ((ih (make-hash-table :size 6)))
       (if join-class
-         (setf (gethash :join-class ih) join-class)
-         (error "Must specify :join-class in :db-info"))
+          (setf (gethash :join-class ih) join-class)
+          (error "Must specify :join-class in :db-info"))
       (if home-key
-         (setf (gethash :home-key ih) home-key)
-         (error "Must specify :home-key in :db-info"))
+          (setf (gethash :home-key ih) home-key)
+          (error "Must specify :home-key in :db-info"))
       (when delete-rule
-       (setf (gethash :delete-rule ih) delete-rule))
+        (setf (gethash :delete-rule ih) delete-rule))
       (if foreign-key
-         (setf (gethash :foreign-key ih) foreign-key)
-         (error "Must specify :foreign-key in :db-info"))
+          (setf (gethash :foreign-key ih) foreign-key)
+          (error "Must specify :foreign-key in :db-info"))
       (when key-join
         (setf (gethash :key-join ih) t))
       (when target-slot
-       (setf (gethash :target-slot ih) target-slot))
+        (setf (gethash :target-slot ih) target-slot))
       (when set
-       (setf (gethash :set ih) set))
+        (setf (gethash :set ih) set))
       (when retrieval
-       (progn
-         (setf (gethash :retrieval ih) retrieval)
-         (if (eql retrieval :immediate)
-             (setf (gethash :set ih) nil))))
+        (progn
+          (setf (gethash :retrieval ih) retrieval)
+          (if (eql retrieval :immediate)
+              (setf (gethash :set ih) nil))))
       ih)))
 
 (defclass view-class-direct-slot-definition (view-class-slot-definition-mixin
-                                            standard-direct-slot-definition)
+                                             standard-direct-slot-definition)
   ())
 
 (defclass view-class-effective-slot-definition (view-class-slot-definition-mixin
-                                               standard-effective-slot-definition)
+                                                standard-effective-slot-definition)
   ())
 
 (defmethod direct-slot-definition-class ((class standard-db-class)
@@ -351,8 +354,8 @@ column definition in the database.")
   (find-class 'view-class-direct-slot-definition))
 
 (defmethod effective-slot-definition-class ((class standard-db-class)
-                                           #+kmr-normal-esdc &rest
-                                           initargs)
+                                            #+kmr-normal-esdc &rest
+                                            initargs)
   (declare (ignore initargs))
   (find-class 'view-class-effective-slot-definition))
 
@@ -367,50 +370,46 @@ column definition in the database.")
   "Need to sort order of class slots so they are the same across
 implementations."
   (let ((slots (call-next-method))
-       desired-sequence
-       output-slots)
+        desired-sequence
+        output-slots)
     (dolist (c (compute-class-precedence-list class))
       (dolist (s (class-direct-slots c))
-       (let ((name (slot-definition-name s)))
-         (unless (find name desired-sequence)
-           (push name desired-sequence)))))
+        (let ((name (slot-definition-name s)))
+          (unless (find name desired-sequence)
+            (push name desired-sequence)))))
     (dolist (desired desired-sequence)
       (let ((slot (find desired slots :key #'slot-definition-name)))
-       (assert slot)
-       (push slot output-slots)))
+        (assert slot)
+        (push slot output-slots)))
     output-slots))
 
-(defun compute-lisp-type-from-slot-specification (slotd specified-type)
-  "Computes the Lisp type for a user-specified type. Needed for OpenMCL
-which does type checking before storing a value in a slot."
-  ;; This function is called after the base compute-effective-slots is called.
-  ;; OpenMCL sets the type-predicate based on the initial value of the slots type.
-  ;; so we have to override the type-predicates here
-  (cond
-    ((consp specified-type)
-     (cond
-       ((and (symbolp (car specified-type))
-            (string-equal (symbol-name (car specified-type)) "string"))
-       'string)
-       ((and (symbolp (car specified-type))
-            (string-equal (symbol-name (car specified-type)) "varchar"))
-       'string)
-       ((and (symbolp (car specified-type))
-            (string-equal (symbol-name (car specified-type)) "char"))
-       'string)
-       (t
-       specified-type)))
-    ((eq (ensure-keyword specified-type) :bigint)
-     'integer)
-    ((eq (ensure-keyword specified-type) :char)
-     'character)
-    ((eq (ensure-keyword specified-type) :varchar)
-     'string)
-    ((and specified-type
-         (not (eql :not-null (slot-value slotd 'db-constraints))))
-     `(or null ,specified-type))
-    (t
-     specified-type)))
+(defun compute-lisp-type-from-specified-type (specified-type db-constraints)
+  "Computes the Lisp type for a user-specified type."
+  (let ((type
+         (cond
+           ((consp specified-type)
+            (let* ((first (first specified-type))
+                   (name (etypecase first
+                           (symbol (symbol-name first))
+                           (string first))))
+              (cond
+               ((or (string-equal name "string")
+                    (string-equal name "varchar")
+                    (string-equal name "char"))
+                'string)
+               (t
+                specified-type))))
+           ((eq (ensure-keyword specified-type) :bigint)
+            'integer)
+           ((eq (ensure-keyword specified-type) :char)
+            'character)
+           ((eq (ensure-keyword specified-type) :varchar)
+            'string)
+           (t
+            specified-type))))
+    (if (and type (not (member :not-null (listify db-constraints))))
+        `(or null ,type)
+      type)))
 
 ;; Compute the slot definition for slots in a view-class.  Figures out
 ;; what kind of database value (if any) is stored there, generates and
@@ -430,110 +429,132 @@ which does type checking before storing a value in a slot."
       (car list)
       list))
 
+(defmethod initialize-instance :around ((obj view-class-direct-slot-definition)
+                                        &rest initargs)
+  (do* ((parsed (list obj))
+        (name (first initargs) (first initargs))
+        (val (second initargs) (second initargs))
+        (type nil)
+        (db-constraints nil))
+      ((null initargs)
+       (setq parsed
+             (append parsed
+                     (list 'specified-type type
+                           :type (compute-lisp-type-from-specified-type
+                                  type db-constraints))))
+       (apply #'call-next-method parsed))
+    (case name
+      (:db-constraints
+       (setq db-constraints val)
+       (setq parsed (append parsed (list name val))))
+      (:type
+       (setq type val))
+      (t
+       (setq parsed (append parsed (list name val)))))
+    (setq initargs (cddr initargs))))
+
 (defmethod compute-effective-slot-definition ((class standard-db-class)
-                                             #+kmr-normal-cesd slot-name
-                                             direct-slots)
+                                              #+kmr-normal-cesd slot-name
+                                              direct-slots)
   #+kmr-normal-cesd (declare (ignore slot-name))
-  
+
   ;; KMR: store the user-specified type and then compute
   ;; real Lisp type and store it
   (let ((dsd (car direct-slots)))
-    (when (and (typep dsd 'view-class-slot-definition-mixin)
-              (null (specified-type dsd)))
-      (setf (specified-type dsd)
-       (slot-definition-type dsd))
-      (setf (slot-value dsd 'type)
-       (compute-lisp-type-from-slot-specification 
-        dsd (slot-definition-type dsd))))
-      
     (let ((esd (call-next-method)))
       (typecase dsd
-       (view-class-slot-definition-mixin
-        ;; Use the specified :column argument if it is supplied, otherwise
-        ;; the column slot is filled in with the slot-name,  but transformed
-        ;; to be sql safe, - to _ and such.
-        (setf (slot-value esd 'column)
-          (column-name-from-arg
-           (if (slot-boundp dsd 'column)
-               (delistify-dsd (view-class-slot-column dsd))
-             (column-name-from-arg
-              (sql-escape (slot-definition-name dsd))))))
-        
-        (setf (slot-value esd 'db-type)
-          (when (slot-boundp dsd 'db-type)
-            (delistify-dsd
-             (view-class-slot-db-type dsd))))
-        
-        (setf (slot-value esd 'void-value)
-              (delistify-dsd
-               (view-class-slot-void-value dsd)))
-        
-        ;; :db-kind slot value defaults to :base (store slot value in
-        ;; database)
-        
-        (setf (slot-value esd 'db-kind)
-          (if (slot-boundp dsd 'db-kind)
-              (delistify-dsd (view-class-slot-db-kind dsd))
-            :base))
-        
-        (setf (slot-value esd 'db-writer)
-          (when (slot-boundp dsd 'db-writer)
-            (delistify-dsd (view-class-slot-db-writer dsd))))
-        (setf (slot-value esd 'db-constraints)
-          (when (slot-boundp dsd 'db-constraints)
-            (delistify-dsd (view-class-slot-db-constraints dsd))))
-        
-        ;; I wonder if this slot option and the previous could be merged,
-        ;; so that :base and :key remain keyword options, but :db-kind
-        ;; :join becomes :db-kind (:join <db info .... >)?
-
-        (setf (slot-value esd 'db-info)
-              (when (slot-boundp dsd 'db-info)
-                (let ((dsd-info (view-class-slot-db-info dsd)))
-                  (cond
-                    ((atom dsd-info)
-                     dsd-info)
-                    ((and (listp dsd-info) (> (length dsd-info) 1)
-                          (atom (car dsd-info)))
-                     (parse-db-info dsd-info))
-                    ((and (listp dsd-info) (= 1 (length dsd-info))
-                          (listp (car dsd-info)))
-                     (parse-db-info (car dsd-info)))))))
-        
-        (setf (specified-type esd)
-              (delistify-dsd (specified-type dsd)))
-        
-        )
-       ;; all other slots
-       (t
-        (let ((type-predicate #+openmcl (slot-value esd 'ccl::type-predicate)))
-          #-openmcl (declare (ignore type-predicate))
-          (change-class esd 'view-class-effective-slot-definition
-                        #+allegro :name 
-                        #+allegro (slot-definition-name dsd))
-          #+openmcl (setf (slot-value esd 'ccl::type-predicate)
-                          type-predicate))
-        
-        (setf (slot-value esd 'column)
-          (column-name-from-arg
-           (sql-escape (slot-definition-name dsd))))
-
-        (setf (slot-value esd 'db-info) nil)
-        (setf (slot-value esd 'db-kind) :virtual)
-        (setf (specified-type esd) (slot-definition-type dsd)))
-       )
+        (view-class-slot-definition-mixin
+         ;; Use the specified :column argument if it is supplied, otherwise
+         ;; the column slot is filled in with the slot-name,  but transformed
+         ;; to be sql safe, - to _ and such.
+         (setf (slot-value esd 'column)
+           (column-name-from-arg
+            (if (slot-boundp dsd 'column)
+                (delistify-dsd (view-class-slot-column dsd))
+              (column-name-from-arg
+               (sql-escape (slot-definition-name dsd))))))
+
+         (setf (slot-value esd 'db-type)
+           (when (slot-boundp dsd 'db-type)
+             (delistify-dsd
+              (view-class-slot-db-type dsd))))
+
+         (setf (slot-value esd 'void-value)
+               (delistify-dsd
+                (view-class-slot-void-value dsd)))
+
+         ;; :db-kind slot value defaults to :base (store slot value in
+         ;; database)
+
+         (setf (slot-value esd 'db-kind)
+           (if (slot-boundp dsd 'db-kind)
+               (delistify-dsd (view-class-slot-db-kind dsd))
+             :base))
+
+         (setf (slot-value esd 'db-reader)
+           (when (slot-boundp dsd 'db-reader)
+             (delistify-dsd (view-class-slot-db-reader dsd))))
+         (setf (slot-value esd 'db-writer)
+           (when (slot-boundp dsd 'db-writer)
+             (delistify-dsd (view-class-slot-db-writer dsd))))
+         (setf (slot-value esd 'db-constraints)
+           (when (slot-boundp dsd 'db-constraints)
+             (delistify-dsd (view-class-slot-db-constraints dsd))))
+
+         ;; I wonder if this slot option and the previous could be merged,
+         ;; so that :base and :key remain keyword options, but :db-kind
+         ;; :join becomes :db-kind (:join <db info .... >)?
+
+         (setf (slot-value esd 'db-info)
+               (when (slot-boundp dsd 'db-info)
+                 (let ((dsd-info (view-class-slot-db-info dsd)))
+                   (cond
+                     ((atom dsd-info)
+                      dsd-info)
+                     ((and (listp dsd-info) (> (length dsd-info) 1)
+                           (atom (car dsd-info)))
+                      (parse-db-info dsd-info))
+                     ((and (listp dsd-info) (= 1 (length dsd-info))
+                           (listp (car dsd-info)))
+                      (parse-db-info (car dsd-info)))))))
+
+         (setf (specified-type esd)
+               (delistify-dsd (specified-type dsd)))
+
+         )
+        ;; all other slots
+        (t
+         (unless (typep esd 'view-class-effective-slot-definition)
+           (warn "Non view-class-direct-slot object with non-view-class-effective-slot-definition in compute-effective-slot-definition")
+
+           (let ((type-predicate #+openmcl (slot-value esd 'ccl::type-predicate)))
+             #-openmcl (declare (ignore type-predicate))
+             #-(or clisp sbcl)  (change-class esd 'view-class-effective-slot-definition
+                                              #+allegro :name
+                                              #+allegro (slot-definition-name dsd))
+             #+openmcl (setf (slot-value esd 'ccl::type-predicate)
+                             type-predicate)))
+
+         (setf (slot-value esd 'column)
+           (column-name-from-arg
+            (sql-escape (slot-definition-name dsd))))
+
+         (setf (slot-value esd 'db-info) nil)
+         (setf (slot-value esd 'db-kind) :virtual)
+         (setf (specified-type esd) (slot-definition-type dsd)))
+        )
       esd)))
-  
+
 (defun slotdefs-for-slots-with-class (slots class)
   (let ((result nil))
     (dolist (s slots)
       (let ((c (slotdef-for-slot-with-class s class)))
-       (if c (setf result (cons c result)))))
+        (if c (setf result (cons c result)))))
     result))
 
 (defun slotdef-for-slot-with-class (slot class)
   (find-if #'(lambda (d) (eql slot (slot-definition-name d)))
-          (class-slots class)))
+           (class-slots class)))
 
 #+ignore
 (eval-when (:compile-toplevel :load-toplevel :execute)