-;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-\r
-;;;; *************************************************************************\r
-;;;; FILE IDENTIFICATION\r
-;;;;\r
-;;;; Name: mop.lisp\r
-;;;; Purpose: Metaobject Protocol Interface\r
-;;;; Programmer: Kevin M. Rosenberg\r
-;;;; Date Started: Apr 2000\r
-;;;;\r
-;;;; This metaclass as functions to classes to allow display\r
-;;;; in Text, HTML, and XML formats. This includes hyperlinking\r
-;;;; capability and sub-objects.\r
-;;;;\r
-;;;; $Id: mop.lisp,v 1.80 2003/06/25 19:28:31 kevin Exp $\r
-;;;;\r
-;;;; This file is Copyright (c) 2000-2003 by Kevin M. Rosenberg\r
-;;;; *************************************************************************\r
- \r
-(in-package #:hyperobject)\r
-\r
-;; Main class\r
-\r
-(defclass hyperobject-class (standard-class)\r
- ( ;; slots initialized in defclass\r
- (user-name :initarg :user-name :type string :initform nil\r
- :accessor user-name\r
- :documentation "User name for class")\r
- (user-name-plural :initarg :user-name-plural :type string :initform nil\r
- :accessor user-name-plural\r
- :documentation "Plural user name for class")\r
- (default-print-slots :initarg :default-print-slots :type list :initform nil\r
- :accessor default-print-slots\r
- :documentation "Defaults slots for a view")\r
- (description :initarg :description :initform nil\r
- :accessor description\r
- :documentation "Class description")\r
- (version :initarg :version :initform nil\r
- :accessor version\r
- :documentation "Version number for class")\r
- (closures :initarg :closures :initform nil\r
- :accessor closures\r
- :documentation "Closures to call on slot chnages")\r
- (sql-name :initarg :sql-name :accessor sql-name :initform nil\r
- :documentation "SQL Name for this class")\r
- (guid :initarg :guid :accessor guid :initform nil\r
- :documentation "ID string for this class")\r
-\r
- ;;; The remainder of these fields are calculated one time\r
- ;;; in finalize-inheritence.\r
- \r
- (subobjects :initform nil :accessor subobjects\r
- :documentation\r
- "List of fields that contain a list of subobjects objects.")\r
- (hyperlinks :type list :initform nil :accessor hyperlinks\r
- :documentation "List of fields that have hyperlinks")\r
- (direct-rules :type list :initform nil :initarg :direct-rules\r
- :accessor direct-rules\r
- :documentation "List of rules to fire on slot changes.")\r
- (class-id :type integer :initform nil\r
- :accessor class-id\r
- :documentation "Unique ID for the class")\r
- (default-view :initform nil :initarg :default-view :accessor default-view\r
- :documentation "The default view for a class")\r
-\r
- ;; SQL commands\r
- (create-table-cmd :initform nil :reader create-table-cmd)\r
- (create-indices-cmds :initform nil :reader create-index-cmds)\r
- (drop-table-cmd :initform nil :reader drop-table-cmd)\r
-\r
- (views :type list :initform nil :initarg :views :accessor views\r
- :documentation "List of views")\r
- (rules :type list :initform nil :initarg :rules :accessor rules\r
- :documentation "List of rules")\r
- )\r
- (:documentation "Metaclass for Markup Language classes."))\r
-\r
-(defclass subobject ()\r
- ((name-class :type symbol :initform nil :initarg :name-class :reader name-class)\r
- (name-slot :type symbol :initform nil :initarg :name-slot :reader name-slot)\r
- (lookup :type (or function symbol) :initform nil :initarg :lookup :reader lookup)\r
- (lookup-keys :type list :initform nil :initarg :lookup-keys\r
- :reader lookup-keys))\r
- (:documentation "Contains subobject information"))\r
-\r
-\r
-(defmethod print-object ((obj subobject) (s stream))\r
- (print-unreadable-object (obj s :type t)\r
- (format s "~S" (name-slot obj))))\r
-\r
-(defclass hyperlink ()\r
- ((name :type symbol :initform nil :initarg :name :reader name)\r
- (lookup\r
- ;; The type specifier seems to break sbcl\r
- :type (or function symbol)\r
- ;; :type t\r
- :initform nil :initarg :lookup :reader lookup)\r
- (link-parameters :type list :initform nil :initarg :link-parameters\r
- :reader link-parameters)))\r
-\r
-(defmethod print-object ((obj hyperlink) (s stream))\r
- (print-unreadable-object (obj s :type t :identity t)\r
- (format s "~S" (name obj))))\r
-\r
-(defmethod validate-superclass ((class hyperobject-class) (superclass standard-class))\r
- t)\r
-\r
-(defmethod finalize-inheritance :after ((cl hyperobject-class))\r
- (init-hyperobject-class cl)\r
- )\r
-\r
-(eval-when (:compile-toplevel :load-toplevel :execute)\r
- (when (>= (length (generic-function-lambda-list\r
- (ensure-generic-function\r
- 'compute-effective-slot-definition)))\r
- 3)\r
- (pushnew :ho-normal-cesd cl:*features*))\r
- \r
- (when (>= (length (generic-function-lambda-list\r
- (ensure-generic-function\r
- 'direct-slot-definition-class)))\r
- 3)\r
- (pushnew :ho-normal-dsdc cl:*features*))\r
- \r
- (when (>= (length (generic-function-lambda-list\r
- (ensure-generic-function\r
- 'effective-slot-definition-class)))\r
- 3)\r
- (pushnew :ho-normal-esdc cl:*features*)))\r
-\r
-;; Slot definitions\r
-(defmethod direct-slot-definition-class ((cl hyperobject-class)\r
- #+ho-normal-dsdc &rest iargs)\r
- (find-class 'hyperobject-dsd))\r
-\r
-(defmethod effective-slot-definition-class ((cl hyperobject-class) \r
- #+ho-normal-esdc &rest iargs)\r
- (find-class 'hyperobject-esd))\r
-\r
-\r
-;;; Slot definitions\r
-\r
-(eval-when (:compile-toplevel :load-toplevel :execute)\r
- (defmacro process-class-option (slot-name &optional required)\r
- #+lispworks\r
- `(defmethod clos:process-a-class-option ((class hyperobject-class)\r
- (name (eql ,slot-name))\r
- value)\r
- (when (and ,required (null value))\r
- (error "hyperobject class slot ~A must have a value" name))\r
- (list name `',value))\r
- #+(or allegro sbcl cmu scl openmcl)\r
- (declare (ignore slot-name required))\r
- )\r
-\r
- (defmacro process-slot-option (slot-name)\r
- #+lispworks\r
- `(defmethod clos:process-a-slot-option ((class hyperobject-class)\r
- (option (eql ,slot-name))\r
- value\r
- already-processed-options\r
- slot)\r
- (list* option `',value already-processed-options))\r
- #-lispworks\r
- (declare (ignore slot-name))\r
- )\r
- \r
- (dolist (option *class-options*)\r
- (eval `(process-class-option ,option)))\r
- (dolist (option *slot-options*)\r
- (eval `(process-slot-option ,option)))\r
-\r
- (eval\r
- `(defclass hyperobject-dsd (standard-direct-slot-definition)\r
- (,@(mapcar #'(lambda (x)\r
- `(,(intern (symbol-name x))\r
- :initform nil))\r
- *slot-options-no-initarg*)\r
- ,@(mapcar #'(lambda (x)\r
- `(,(intern (symbol-name x))\r
- :initarg\r
- ,(intern (symbol-name x) (symbol-name :keyword))\r
- :initform nil\r
- :accessor\r
- ,(intern (concatenate 'string\r
- (symbol-name :dsd-)\r
- (symbol-name x)))))\r
- *slot-options*))))\r
- (eval\r
- `(defclass hyperobject-esd (standard-effective-slot-definition)\r
- (,@(mapcar #'(lambda (x)\r
- `(,(intern (symbol-name x))\r
- :initarg\r
- ,(intern (symbol-name x) (symbol-name :keyword))\r
- :initform nil\r
- :accessor\r
- ,(intern (concatenate 'string\r
- (symbol-name :esd-)\r
- (symbol-name x)))))\r
- (append *slot-options* *slot-options-no-initarg*)))))\r
- ) ;; eval-when\r
-\r
-(defun intern-in-keyword (obj)\r
- (cond\r
- ((null obj)\r
- nil)\r
- ((eq t obj)\r
- t)\r
- ((atom obj)\r
- (intern (symbol-name obj) (find-package 'keyword)))\r
- ((consp obj)\r
- (cons (intern-in-keyword (car obj) ) (intern-in-keyword (cdr obj))))\r
- (t\r
- obj)))\r
-\r
-(defun canonicalize-value-type (vt)\r
- (typecase vt\r
- (atom\r
- (ensure-keyword vt))\r
- (cons\r
- (list (ensure-keyword (car vt)) (cadr vt)))\r
- (t\r
- t)))\r
-\r
-(defmethod compute-effective-slot-definition :around ((cl hyperobject-class)\r
- #+ho-normal-cesd name\r
- dsds)\r
- #+ho-normal-cesd (declare (ignore name))\r
- (let* ((esd (call-next-method))\r
- (dsd (car dsds))\r
- (value-type (canonicalize-value-type (slot-value dsd 'value-type))))\r
- (multiple-value-bind (sql-type sql-length) \r
- (value-type-to-sql-type value-type)\r
- (setf (slot-value esd 'sql-type) sql-type)\r
- (setf (slot-value esd 'sql-length) sql-length))\r
- (setf (slot-value esd 'type) (value-type-to-lisp-type value-type))\r
- (setf (slot-value esd 'value-type) value-type)\r
- (setf (slot-value esd 'user-name)\r
- (aif (slot-value dsd 'user-name)\r
- it\r
- (string-downcase (symbol-name (slot-definition-name dsd)))))\r
- (setf (slot-value esd 'sql-name)\r
- (aif (slot-value dsd 'sql-name)\r
- it\r
- (lisp-name-to-sql-name (slot-definition-name dsd))))\r
- (setf (slot-value esd 'sql-name)\r
- (aif (slot-value dsd 'sql-name)\r
- it\r
- (lisp-name-to-sql-name (slot-definition-name dsd))))\r
- (dolist (name '(print-formatter subobject hyperlink hyperlink-parameters\r
- description value-constraint indexed null-allowed\r
- unique short-description void-text read-only-groups\r
- hidden-groups unit disable-predicate view-type\r
- list-of-values stored))\r
- (setf (slot-value esd name) (slot-value dsd name)))\r
- esd))\r
-\r
-(defun lisp-name-to-sql-name (lisp)\r
- "Convert a lisp name (atom or list, string or symbol) into a canonical\r
-SQL name"\r
- (unless (stringp lisp)\r
- (setq lisp\r
- (typecase lisp\r
- (symbol (symbol-name lisp))\r
- (t (write-to-string lisp)))))\r
- (do* ((len (length lisp))\r
- (sql (make-string len))\r
- (i 0 (1+ i)))\r
- ((= i len) (string-upcase sql))\r
- (declare (fixnum i)\r
- (simple-string sql))\r
- (setf (schar sql i)\r
- (let ((c (char lisp i)))\r
- (case c\r
- ((#\- #\$ #\+ #\#) #\_)\r
- (otherwise c))))))\r
-\r
-#+ho-normal-cesd\r
-(setq cl:*features* (delete :ho-normal-cesd cl:*features*))\r
-#+ho-normal-dsdc\r
-(setq cl:*features* (delete :ho-normal-dsdc cl:*features*))\r
-#+ho-normal-esdc\r
-(setq cl:*features* (delete :ho-normal-esdc cl:*features*))\r
-\r
-(defun lisp-type-is-a-string (type)\r
- (or (eq type 'string)\r
- (and (listp type) (some #'(lambda (x) (eq x 'string)) type))))\r
-\r
-(defun base-value-type (value-type)\r
- (if (atom value-type)\r
- value-type\r
- (car value-type)))\r
-\r
-(defun value-type-to-lisp-type (value-type)\r
- (case (base-value-type value-type)\r
- ((:string :cdata :varchar :char)\r
- '(or null string))\r
- (:character\r
- '(or null character))\r
- (:fixnum\r
- '(or null fixnum))\r
- (:boolean\r
- '(or null boolean))\r
- ((:integer :long-integer)\r
- '(or null integer))\r
- ((:float :single-float)\r
- '(or null single-float))\r
- (:double-float\r
- '(or null double-float))\r
- (otherwise\r
- t)))\r
-\r
-(defun value-type-to-sql-type (value-type)\r
- "Return two values, the sql type and field length."\r
- (let ((type (base-value-type value-type))\r
- (length (when (consp value-type)\r
- (cadr value-type))))\r
- (values\r
- (case type\r
- ((:char :character)\r
- :char)\r
- (:varchar\r
- :varchar)\r
- ((:fixnum :integer)\r
- :integer)\r
- (:long-integer\r
- :long-integer)\r
- (:boolean\r
- :boolean)\r
- ((:float :single-float)\r
- :single-float)\r
- (:double-float\r
- :double-float)\r
- (otherwise\r
- :text))\r
- length)))\r
-\r
-;;;; Class initialization function\r
-\r
-;; defines a slot-unbound method for class and slot-name, fills\r
-;; the slot by calling reader function with the slot values of\r
-;; the instance's reader-keys\r
-(defmacro def-lazy-reader (class slot-name reader &rest reader-keys)\r
- (let* ((the-slot-name (gensym))\r
- (the-class (gensym))\r
- (the-instance (gensym))\r
- (keys '()))\r
- (dolist (key reader-keys)\r
- (push (list 'slot-value the-instance (list 'quote key)) keys))\r
- (setq keys (nreverse keys))\r
- `(defmethod slot-unbound (,the-class (,the-instance ,class)\r
- (,the-slot-name (eql ',slot-name)))\r
- (declare (ignore ,the-class))\r
- (setf (slot-value ,the-instance ,the-slot-name) (,reader ,@keys)))))\r
-\r
-\r
-#+lispworks\r
-(defun intern-eql-specializer (slot)\r
- `(eql ,slot))\r
-\r
-#+(or sbcl cmu lispworks)\r
-(defun ensure-lazy-reader (class-name slot-name reader &rest reader-keys)\r
- (let ((keys nil)\r
- (gf (ensure-generic-function 'slot-unbound)))\r
- (dolist (key reader-keys)\r
- (push (list 'slot-value 'the-instance (list 'quote key)) keys))\r
- (setq keys (nreverse keys))\r
- (multiple-value-bind (method-lambda init-args-values)\r
- (make-method-lambda\r
- gf\r
- (class-prototype (generic-function-method-class gf))\r
- #-lispworks\r
- `(lambda (the-class the-instance the-slot-name)\r
- (declare (ignore the-class))\r
- (setf (slot-value the-instance the-slot-name) (,reader ,@keys)))\r
- #+lispworks\r
- '(the-class the-instance the-slot-name)\r
- #+lispworks\r
- nil\r
- #+lispworks\r
- `(setf (slot-value the-instance the-slot-name) (,reader ,@keys))\r
- nil)\r
- (add-method gf\r
- (apply\r
- #'make-instance (generic-function-method-class gf)\r
- ':specializers (list (class-of (find-class class-name))\r
- (find-class class-name)\r
- (intern-eql-specializer slot-name))\r
- ':lambda-list '(the-class the-instance the-slot-name)\r
- ':function (compile nil method-lambda)\r
- init-args-values)))))\r
-\r
-#+(or allegro scl openmcl)\r
-(progn\r
- ;; One entry for each class with lazy readers defined. The value is a plist mapping\r
- ;; slot-name to a lazy reader, each of which is a list of a function and slot-names.\r
- (defvar *lazy-readers* (make-hash-table))\r
-\r
-(defmethod slot-unbound :around ((class hyperobject-class) instance slot-name)\r
- (let ((lazy-reader (loop for super in (class-precedence-list class)\r
- as lazy-reader = (getf (gethash super *lazy-readers*) slot-name)\r
- when lazy-reader return it)))\r
- (if lazy-reader\r
- (setf (slot-value instance slot-name)\r
- (apply (car lazy-reader)\r
- (loop for arg-slot-name in (cdr lazy-reader)\r
- collect (slot-value instance arg-slot-name))))\r
- ;; No lazy reader -- defer to regular slot-unbound handling.\r
- (call-next-method))))\r
-\r
- ;; The reader is a function and the reader-keys are slot names. The slot is lazily set to\r
- ;; the result of applying the function to the slot-values of those slots, and that value\r
- ;; is also returned.\r
- (defun ensure-lazy-reader (class-name slot-name reader &rest reader-keys)\r
- (setf (getf (gethash (find-class class-name) *lazy-readers*) slot-name)\r
- (list* reader (copy-list reader-keys))))\r
-\r
- (defun remove-lazy-reader (class-name slot-name)\r
- (setf (getf (gethash (find-class class-name) *lazy-readers*) slot-name)\r
- nil))\r
- \r
- ) ;; #+(or allegro sc openmcll)\r
-\r
-\r
-(defun finalize-subobjects (cl)\r
- "Process class subobjects slot"\r
- (setf (subobjects cl)\r
- (let ((subobjects '()))\r
- (dolist (slot (class-slots cl))\r
- (let-when\r
- (subobj-def (esd-subobject slot))\r
- (let ((subobject\r
- (make-instance 'subobject\r
- :name-class (class-name cl)\r
- :name-slot (slot-definition-name slot)\r
- :lookup (if (atom subobj-def)\r
- subobj-def\r
- (car subobj-def))\r
- :lookup-keys (if (atom subobj-def)\r
- nil\r
- (cdr subobj-def)))))\r
- (unless (eq (lookup subobject) t)\r
- #+ignore ;; #-(or sbcl cmu lispworks)\r
- (eval\r
- `(hyperobject::def-lazy-reader ,(name-class subobject)\r
- ,(name-slot subobject) ,(lookup subobject)\r
- ,@(lookup-keys subobject)))\r
- #+(or sbcl cmu lispworks allegro scl openmcl)\r
- (apply #'ensure-lazy-reader \r
- (name-class subobject) (name-slot subobject)\r
- (lookup subobject) (lookup-keys subobject)))\r
- (push subobject subobjects))))\r
- ;; sbcl/cmu reverse class-slots compared to the defclass form\r
- ;; so re-reverse on cmu/sbcl\r
- #+(or cmu sbcl) subobjects\r
- #-(or cmu sbcl) (nreverse subobjects)\r
- )))\r
-\r
-\r
-(defun finalize-class-slots (cl)\r
- "Make sure all class slots have an expected value"\r
- (unless (user-name cl)\r
- (setf (user-name cl) (format nil "~:(~A~)" (class-name cl))))\r
- \r
- (setf (user-name-plural cl)\r
- (if (and (consp (user-name cl)) (cadr (user-name cl)))\r
- (cadr (user-name cl))\r
- (format nil "~A~P" (if (consp (user-name cl))\r
- (car (user-name cl))\r
- (user-name cl))\r
- 2)))\r
-\r
- (dolist (name '(user-name description version guid sql-name))\r
- (awhen (slot-value cl name)\r
- (setf (slot-value cl name)\r
- (etypecase (slot-value cl name)\r
- (cons (car it))\r
- ((or string symbol) it)))))\r
- \r
- (unless (sql-name cl)\r
- (setf (sql-name cl) (lisp-name-to-sql-name (class-name cl))))\r
- )\r
-\r
-(defun finalize-documentation (cl)\r
- "Calculate class documentation slot"\r
- (let ((*print-circle* nil))\r
- (setf (documentation (class-name cl) 'class)\r
- (format nil "Hyperobject~A~A~A~A"\r
- (aif (user-name cl)\r
- (format nil ": ~A" it ""))\r
- (aif (description cl)\r
- (format nil "~%Class description: ~A" it) "")\r
- (aif (subobjects cl)\r
- (format nil "~%Subobjects:~{ ~A~}" (mapcar #'name-slot it)) "")\r
- (aif (default-print-slots cl)\r
- (format nil "~%Default print slots:~{ ~A~}" it) "")\r
- ))))\r
-\r
-(defun finalize-hyperlinks (cl)\r
- (let ((hyperlinks '()))\r
- (dolist (esd (class-slots cl))\r
- (awhen (slot-value esd 'hyperlink)\r
- (push\r
- (make-instance 'hyperlink\r
- :name (slot-definition-name esd)\r
- :lookup it\r
- :link-parameters (slot-value esd 'hyperlink-parameters))\r
- hyperlinks)))\r
- ;; cmu/sbcl reverse class-slots compared to the defclass form\r
- ;; hyperlinks is already reversed from the dolist/push loop, so re-reverse on sbcl/cmu\r
- #-(or cmu sbcl) (setq hyperlinks (nreverse hyperlinks))\r
- (setf (slot-value cl 'hyperlinks) hyperlinks)))\r
-\r
-(defun init-hyperobject-class (cl)\r
- "Initialize a hyperobject class. Calculates all class slots"\r
- (finalize-subobjects cl)\r
- (finalize-views cl)\r
- (finalize-hyperlinks cl)\r
- (finalize-sql cl)\r
- (finalize-rules cl)\r
- (finalize-class-slots cl)\r
- (finalize-documentation cl))\r
-\r
-\r
-;;;; *************************************************************************\r
-;;;; Metaclass Slot Accessors\r
-;;;; *************************************************************************\r
-\r
-(defun find-slot-by-name (cl name)\r
- (find name (class-slots cl) :key #'slot-definition-name))\r
-\r
-(defun hyperobject-class-user-name (obj)\r
- (user-name (class-of obj)))\r
-\r
-(defun hyperobject-class-user-name-plural (obj)\r
- (user-name-plural (class-of obj)))\r
-\r
-(defun hyperobject-class-subobjects (obj)\r
- (subobjects (class-of obj)))\r
-\r
-(defun hyperobject-class-hyperlinks (obj)\r
- (hyperlinks (class-of obj)))\r
-\r
-(defun hyperobject-class-slots (obj)\r
- ;; cmucl/sbcl reverse class-slots\r
- #+(or cmu sbcl) (reverse (class-slots (class-of obj)))\r
- #-(or cmu sbcl) (class-slots (class-of obj)))\r
-\r
-(defun all-subobjects (obj)\r
- "Returns a list of all subobjects in an object"\r
- (let ((so-list '()))\r
- (dolist (subobj-obj (subobjects (class-of obj)) (nreverse so-list))\r
- (dolist (so (funcall (name-slot subobj-obj) obj))\r
- (push so so-list)))))\r
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
+;;;; *************************************************************************
+;;;; FILE IDENTIFICATION
+;;;;
+;;;; Name: mop.lisp
+;;;; Purpose: Metaobject Protocol Interface
+;;;; Programmer: Kevin M. Rosenberg
+;;;; Date Started: Apr 2000
+;;;;
+;;;; This metaclass as functions to classes to allow display
+;;;; in Text, HTML, and XML formats. This includes hyperlinking
+;;;; capability and sub-objects.
+;;;;
+;;;; This file is Copyright (c) 2000-2006 by Kevin M. Rosenberg
+;;;; *************************************************************************
+
+(in-package #:hyperobject)
+
+;; Main class
+
+(defclass hyperobject-class (standard-class)
+ ( ;; slots initialized in defclass
+ (user-name :initarg :user-name :initform nil
+ :accessor user-name
+ :documentation "User name for class")
+ (user-name-plural :initarg :user-name-plural :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")
+ (description :initarg :description :initform nil
+ :accessor description
+ :documentation "Class description")
+ (version :initarg :version :initform nil
+ :accessor version
+ :documentation "Version number for class")
+ (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.
+
+ (subobjects :initform nil :accessor subobjects
+ :documentation
+ "List of fields that contain a list of subobjects objects.")
+ (compute-cached-values :initform nil :accessor compute-cached-values
+ :documentation
+ "List of fields that contain a list of compute-cached-value objects.")
+ (hyperlinks :type list :initform nil :accessor hyperlinks
+ :documentation "List of fields that have hyperlinks")
+ (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 (+ (* 1000000 (get-universal-time)) (random 1000000))
+ :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)
+ (drop-table-cmd :initform nil :reader drop-table-cmd)
+
+ (views :type list :initform nil :initarg :views :accessor views
+ :documentation "List of views")
+ (rules :type list :initform nil :initarg :rules :accessor rules
+ :documentation "List of rules")
+ )
+ (:documentation "Metaclass for Markup Language classes."))
+
+(defclass subobject ()
+ ((name-class :type symbol :initarg :name-class :reader name-class)
+ (name-slot :type symbol :initarg :name-slot :reader name-slot)
+ (lazy-class :type symbol :initarg :lazy-class :reader lazy-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 :lazy-class nil
+ :lookup nil :lookup-keys nil))
+
+(defclass compute-cached-value ()
+ ((name-class :type symbol :initarg :name-class :reader name-class)
+ (name-slot :type symbol :initarg :name-slot :reader name-slot)
+ (lazy-class :type symbol :initarg :lazy-class
+ :reader lazy-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 :lazy-class nil
+ :lookup nil :lookup-keys nil))
+
+
+(defmethod print-object ((obj subobject) s)
+ (print-unreadable-object (obj s :type t)
+ (format s "~S" (name-slot obj))))
+
+(defclass hyperlink ()
+ ((name :type symbol :initform nil :initarg :name :reader name)
+ (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)))
+
+(defmethod print-object ((obj hyperlink) s)
+ (print-unreadable-object (obj s :type t :identity t)
+ (format s "~S" (name obj))))
+
+(defmethod validate-superclass ((class hyperobject-class) (superclass standard-class))
+ t)
+
+
+(declaim (inline delistify))
+(defun delistify (list)
+ "Some MOPs, like openmcl 0.14.2, cons attribute values in a list."
+ (if (listp list)
+ (car list)
+ list))
+
+(defun remove-keyword-arg (arglist akey)
+ (let ((mylist arglist)
+ (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)))))
+ (pop-arg mylist))
+ newlist))
+
+(defun remove-keyword-args (arglist akeys)
+ (let ((mylist arglist)
+ (newlist ()))
+ (labels ((pop-arg (alist)
+ (let ((arg (pop alist))
+ (val (pop alist)))
+ (unless (find arg akeys)
+ (setf newlist (append (list arg val) newlist)))
+ (when alist (pop-arg alist)))))
+ (pop-arg mylist))
+ newlist))
+
+
+(defmethod shared-initialize :around ((class hyperobject-class) slot-names
+ &rest initargs
+ &key direct-superclasses
+ user-name sql-name name description
+ &allow-other-keys)
+ ;(format t "ii ~S ~S ~S ~S ~S~%" initargs base-table direct-superclasses user-name sql-name)
+ (let ((root-class (find-class 'hyperobject nil))
+ (vmc 'hyperobject-class)
+ user-name-plural user-name-str sql-name-str)
+ ;; when does CLSQL pass :qualifier to initialize instance?
+ (setq user-name-str
+ (if user-name
+ (delistify user-name)
+ (and name (format nil "~:(~A~)" name))))
+
+ (setq sql-name-str
+ (if sql-name
+ (delistify sql-name)
+ (and name (lisp-name-to-sql-name name))))
+
+ (if sql-name
+ (delistify sql-name)
+ (and name (lisp-name-to-sql-name name)))
+
+ (setq description (delistify description))
+
+ (setq user-name-plural
+ (if (and (consp user-name) (second user-name))
+ (second user-name)
+ (and user-name-str (format nil "~A~P" user-name-str 2))))
+
+ (flet ((do-call-next-method (direct-superclasses)
+ (let ((fn-args (list class slot-names :direct-superclasses direct-superclasses))
+ (rm-args '(:direct-superclasses)))
+ (when user-name-str
+ (setq fn-args (nconc fn-args (list :user-name user-name-str)))
+ (push :user-name rm-args))
+ (when user-name-plural
+ (setq fn-args (nconc fn-args (list :user-name-plural user-name-plural)))
+ (push :user-name-plural rm-args))
+ (when sql-name-str
+ (setq fn-args (nconc fn-args (list :sql-name sql-name-str)))
+ (push :sql-name rm-args))
+ (when description
+ (setq fn-args (nconc fn-args (list :description description)))
+ (push :description rm-args))
+ (setq fn-args (nconc fn-args (remove-keyword-args initargs rm-args)))
+ (apply #'call-next-method fn-args))))
+ (if root-class
+ (if (some #'(lambda (super) (typep super vmc))
+ direct-superclasses)
+ (do-call-next-method direct-superclasses)
+ (do-call-next-method direct-superclasses #+nil (append (list root-class)
+ direct-superclasses)))
+ (do-call-next-method direct-superclasses)))))
+
+
+(defmethod finalize-inheritance :after ((cl hyperobject-class))
+ "Initialize a hyperobject class. Calculates all class slots"
+ (finalize-subobjects cl)
+ (finalize-compute-cached cl)
+ (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*)))
+
+(defmethod direct-slot-definition-class ((cl hyperobject-class)
+ #+ho-normal-dsdc &rest iargs)
+ (declare (ignore iargs))
+ (find-class 'hyperobject-dsd))
+
+(defmethod effective-slot-definition-class ((cl hyperobject-class)
+ #+ho-normal-esdc &rest iargs)
+ (declare (ignore iargs))
+ (find-class 'hyperobject-esd))
+
+;;; Slot definitions
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defmacro process-class-option (slot-name &optional required)
+ #+lispworks
+ `(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))
+ #+(or allegro sbcl cmu scl openmcl)
+ (declare (ignore slot-name required))
+ )
+
+ (defmacro process-slot-option (slot-name)
+ #+lispworks
+ `(defmethod clos:process-a-slot-option ((class hyperobject-class)
+ (option (eql ,slot-name))
+ value
+ already-processed-options
+ slot)
+ (list* option `',value already-processed-options))
+ #-lispworks
+ (declare (ignore slot-name))
+ )
+
+ (dolist (option *class-options*)
+ (eval `(process-class-option ,option)))
+ (dolist (option *slot-options*)
+ (eval `(process-slot-option ,option)))
+
+ (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*))))
+ (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*)))))
+ ) ;; eval-when
+
+(defun intern-in-keyword (obj)
+ (cond
+ ((null obj)
+ nil)
+ ((eq t obj)
+ t)
+ ((atom obj)
+ (intern (symbol-name obj) (find-package 'keyword)))
+ ((consp obj)
+ (cons (intern-in-keyword (car obj) ) (intern-in-keyword (cdr obj))))
+ (t
+ obj)))
+
+(defun canonicalize-value-type (vt)
+ (typecase vt
+ (atom
+ (ensure-keyword vt))
+ (cons
+ (list (ensure-keyword (car vt)) (cadr vt)))
+ (t
+ t)))
+
+
+(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)))
+ (multiple-value-bind (sql-type sql-length)
+ (value-type-to-sql-type (dsd-value-type dsd))
+ (setf (esd-sql-type esd) sql-type)
+ (setf (esd-sql-length esd) sql-length))
+ (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 '(value-type print-formatter subobject hyperlink
+ hyperlink-parameters unbound-lookup
+ description value-constraint indexed null-allowed
+ unique short-description void-text read-only-groups
+ hidden-groups unit disable-predicate view-type
+ list-of-values compute-cached-value 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*))
+#+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-is-a-string (type)
+ (or (eq type 'string)
+ (eq type 'cdata)
+ (and (listp type) (some #'(lambda (x) (or (eq x 'string)
+ (eq x 'cdata)))
+ 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 (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 :long-integer)
+ '(or null integer))
+ ((:float :single-float)
+ '(or null single-float))
+ (:double-float
+ '(or null double-float))
+ (otherwise
+ t)))
+
+(defun value-type-to-sql-type (value-type)
+ "Return two values, the sql type and field length."
+ (let ((type (base-value-type value-type))
+ (length (when (consp value-type)
+ (cadr value-type))))
+ (values
+ (case type
+ ((: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
+
+;; 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 lazy-class reader
+ &rest reader-keys)
+ (declare (ignore class-name))
+ (setf (getf (gethash cl *lazy-readers*) slot-name)
+ (aif lazy-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 store-lazily-computed-objects (cl slot esd-accessor obj-class)
+ (setf (slot-value cl slot)
+ (let ((objs '()))
+ (dolist (slot (class-slots cl))
+ (let-when
+ (def (funcall esd-accessor slot))
+ (let ((obj (make-instance obj-class
+ :name-class (class-name cl)
+ :name-slot (slot-definition-name slot)
+ :lazy-class (when (atom def)
+ def)
+ :lookup (when (listp def)
+ (car def))
+ :lookup-keys (when (listp def)
+ (cdr def)))))
+ (unless (eq (lookup obj) t)
+ (apply #'ensure-lazy-reader
+ cl
+ (name-class obj) (name-slot obj)
+ (lazy-class obj)
+ (lookup obj) (lookup-keys obj))
+ (push obj objs)))))
+ ;; sbcl/cmu reverse class-slots compared to the defclass form
+ ;; so re-reverse on cmu/sbcl
+ #+(or cmu sbcl) objs
+ #-(or cmu sbcl) (nreverse objs)
+ )))
+
+(defun finalize-subobjects (cl)
+ (store-lazily-computed-objects cl 'subobjects 'esd-subobject 'subobject))
+
+(defun finalize-compute-cached (cl)
+ (store-lazily-computed-objects cl 'compute-cached-values
+ 'esd-compute-cached-value 'compute-cached-value))
+
+
+(defun finalize-documentation (cl)
+ "Calculate class documentation slot"
+ (let ((*print-circle* nil))
+ (setf (documentation cl 'type)
+ (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)))
+ ;; 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)
+ "Initialize a hyperobject class. Calculates all class slots"
+ (finalize-views cl)
+ (finalize-hyperlinks cl)
+ (finalize-sql cl)
+ (finalize-rules cl)
+ (finalize-documentation cl))
+
+
+
+
+;;;; *************************************************************************
+;;;; Metaclass Slot Accessors
+;;;; *************************************************************************
+
+(defun find-slot-by-name (cl name)
+ (find name (class-slots cl) :key #'slot-definition-name))
+
+(defun hyperobject-class-user-name (obj)
+ (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-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 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)))))
projects / hyperobject.git / blobdiff