;;;; in Text, HTML, and XML formats. This includes hyperlinking
;;;; capability and sub-objects.
;;;;
-;;;; $Id: hyperobject.lisp,v 1.7 2002/11/22 16:05:08 kevin Exp $
+;;;; $Id: hyperobject.lisp,v 1.13 2002/11/25 02:10:38 kevin Exp $
;;;;
;;;; This file is Copyright (c) 2000-2002 by Kevin M. Rosenberg
;;;;
;;;; *************************************************************************
-(in-package :hyperobject-mop)
+(in-package :hyperobject)
(eval-when (:compile-toplevel :execute)
(declaim (optimize (speed 3) (safety 1) (compilation-speed 0) (debug 3))))
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (shadowing-import
+ #+allegro
+ `(mop::class-slots mop::slot-definition-name mop:finalize-inheritance
+ mop::standard-direct-slot-definition mop::standard-effective-slot-definition
+ mop:direct-slot-definition-class mop:compute-effective-slot-definition
+ excl::compute-effective-slot-definition-initargs)
+ #+lispworks
+ `(clos:class-slots clos::slot-definition-name clos:finalize-inheritance
+ clos::standard-direct-slot-definition clos::standard-effective-slot-definition
+ clos:direct-slot-definition-class clos:compute-effective-slot-definition
+ clos::compute-effective-slot-definition-initargs)
+ #+sbcl
+ `(sb-pcl:class-of sb-pcl:class-name sb-pcl:class-slots sb-pcl::standard-class
+ sb-pcl::slot-definition-name sb-pcl:finalize-inheritance
+ sb-pcl::standard-direct-slot-definition
+ sb-pcl::standard-effective-slot-definition sb-pcl::validate-superclass
+ sb-pcl:direct-slot-definition-class sb-pcl:compute-effective-slot-definition
+ sb-pcl::compute-effective-slot-definition-initargs)
+ #+cmu
+ `(pcl:class-of pcl:class-name pcl:class-slots pcl::standard-class
+ pcl::slot-definition-name pcl:finalize-inheritance
+ pcl::standard-direct-slot-definition pcl::standard-effective-slot-definition
+ pcl::validate-superclass pcl:direct-slot-definition-class
+ pcl:compute-effective-slot-definition
+ pcl::compute-effective-slot-definition-initargs)
+
+ :hyperobject))
-#+allegro
-(shadowing-import
- mop:class-slots mop::slot-definition-name mop:finalize-inheritance
- mop::standard-direct-slot-definition mop::standard-effective-slot-definition
- mop:direct-slot-definition-class mop:compute-effective-slot-definition
- excl::compute-effective-slot-definition-initargs
-)
-
-#+lispworks
-(shadowing-import
- clos:class-slots clos::slot-definition-name clos:finalize-inheritance
- clos::standard-direct-slot-definition clos::standard-effective-slot-definition
- clos:direct-slot-definition-class clos:compute-effective-slot-definition
- clos::compute-effective-slot-definition-initargs
- )
-
-#+(or cmu scl)
-(shadowing-import
- pcl:class-of pcl:class-name pcl:class-slots pcl::standard-class
- pcl::slot-definition-name pcl:finalize-inheritance
- pcl::standard-direct-slot-definition pcl::standard-effective-slot-definition
- pcl::validate-superclass pcl:direct-slot-definition-class
- pcl:compute-effective-slot-definition
- pcl::compute-effective-slot-definition-initargs
-)
-
-#+sbcl
-(shadowing-import
- sb-pcl:class-of sb-pcl:class-name sb-pcl:class-slots sb-pcl::standard-class
- sb-pcl::slot-definition-name sb-pcl:finalize-inheritance
- sb-pcl::standard-direct-slot-definition
- sb-pcl::standard-effective-slot-definition sb-pcl::validate-superclass
- sb-pcl:direct-slot-definition-class sb-pcl:compute-effective-slot-definition
- sb-pcl::compute-effective-slot-definition-initargs
- )
;; Slot definitions
(defclass hyperobject-dsd (standard-direct-slot-definition)
- ((ho-type :initarg :ho-type :initform nil :accessor dsd-ho-type)
- (format-func :initarg :format-func :initform nil :accessor dsd-format-func)
- (subobject :initarg :subobject :initform nil :accessor dsd-subobject)
- (reference :initarg :reference :initform nil :accessor dsd-reference)
+ ((ho-type :initarg :ho-type :initform nil)
+ (print-formatter :initarg :print-formatter :initform nil)
+ (subobject :initarg :subobject :initform nil)
+ (reference :initarg :reference :initform nil)
+ (description :initarg :description :initform nil)
))
(defclass hyperobject-esd (standard-effective-slot-definition)
((ho-type :initarg :ho-type :initform nil :accessor esd-ho-type)
- (format-func :initarg :format-func :initform nil :accessor esd-format-func)
+ (print-formatter :initarg :print-formatter :initform nil :accessor esd-print-formatter)
(subobject :initarg :subobject :initform nil :accessor esd-subobject)
(reference :initarg :reference :initform nil :accessor esd-reference)
+ (description :initarg :description :initform nil :accessor esd-description)
))
;; Main class
(defclass hyperobject-class (standard-class)
- ((title :initarg :title :type string :reader ml-std-title
- :documentation
-"Print Title for class")
- (subobjects
- :initarg :subobjects
- :documentation
-"List of fields that contain a list of subobjects objects.")
- (references
- :initarg :references :type list :reader ml-std-references
- :documentation
- "List of fields that can be referred to by browsers.
-Format is ((field-name field-lookup-func other-link-params) ...)")
-
+ ( ;; slots initialized in defclass
+ (title :initarg :title :type string :initform nil
+ :documentation "Print Title for class")
+ (print-slots :initarg :print-slots :type list :initform nil
+ :documentation "List of slots to print")
+ (description :initarg :description :initform nil
+ :documentation "Class description")
+
;;; The remainder of these fields are calculated one time
;;; in finalize-inheritence.
- (value-func :initform nil :type function :reader ml-std-value-func)
- (xmlvalue-func :initform nil :type function :reader ml-std-xmlvalue-func)
- (fmtstr-text :initform nil :type string :reader ml-std-fmtstr-text)
- (fmtstr-html :initform nil :type string :reader ml-std-fmtstr-html)
- (fmtstr-xml :initform nil :type string :reader ml-std-fmtstr-xml)
- (fmtstr-text-labels :initform nil :type string :reader ml-std-fmtstr-text-labels)
- (fmtstr-html-labels :initform nil :type string :reader ml-std-fmtstr-html-labels)
- (fmtstr-xml-labels :initform nil :type string :reader ml-std-fmtstr-xml-labels)
- (fmtstr-html-ref :initform nil :type string :reader ml-std-fmtstr-html-ref)
- (fmtstr-xml-ref :initform nil :type string :reader ml-std-fmtstr-xml-ref)
- (fmtstr-html-ref-labels :initform nil :type string :reader ml-std-fmtstr-html-ref-labels)
- (fmtstr-xml-ref-labels :initform nil :type string :reader ml-std-fmtstr-xml-ref-labels)
+
+ (subobjects :initform nil :documentation
+ "List of fields that contain a list of subobjects objects.")
+ (references :type list :initform nil :documentation
+ "List of fields that have references")
+
+ (value-func :initform nil :type function)
+ (xmlvalue-func :initform nil :type function)
+ (fmtstr-text :initform nil :type string)
+ (fmtstr-html :initform nil :type string)
+ (fmtstr-xml :initform nil :type string)
+ (fmtstr-text-labels :initform nil :type string)
+ (fmtstr-html-labels :initform nil :type string)
+ (fmtstr-xml-labels :initform nil :type string)
+ (fmtstr-html-ref :initform nil :type string)
+ (fmtstr-xml-ref :initform nil :type string)
+ (fmtstr-html-ref-labels :initform nil :type string)
+ (fmtstr-xml-ref-labels :initform nil :type string)
)
- (:default-initargs :title nil :subobjects nil :references nil)
(:documentation "Metaclass for Markup Language classes."))
(defclass subobject ()
;; Slot definitions
(defmethod direct-slot-definition-class ((cl hyperobject-class)
- &rest iargs)
+ #+allegro &rest
+ iargs)
(find-class 'hyperobject-dsd))
+(defmacro define-class-slot (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))
+ (if (null (cdr value))
+ (list name (car value))
+ (list name `',value)))
+ #+(or allegro sbcl cmu scl)
+ (declare (ignore slot-name required))
+ )
+(define-class-slot :title)
+(define-class-slot :print-slots)
+(define-class-slot :description)
-#+lispworks
-(defmethod clos:process-a-class-option ((class hyperobject-class)
- (name (eql :title))
- value)
- (unless value
- (error "hyperobject-class title must have a value"))
- (if (null (cdr value))
- (list name (car value))
- (list name `',value)))
-(defmethod (compute-effective-slot-definition) :around
- ((cl hyperobject-class) #+(or allegro lispworks) slot dsds)
- (declare (ignorable slot))
+(defmethod compute-effective-slot-definition :around
+ ((cl hyperobject-class) #+(or allegro lispworks) name dsds)
+ #+allergo (declare (ignore name))
(let* ((dsd (car dsds))
(ho-type (slot-value dsd 'type)))
(setf (slot-value dsd 'ho-type) ho-type)
(setf (slot-value dsd 'type) (convert-ho-type ho-type))
- (let ((ia (computer-effective-slot-definition-initargs
- cl #+lispworks slot dsds)))
+ (let ((ia (compute-effective-slot-definition-initargs
+ cl #+lispworks name dsds)))
(apply
#'make-instance 'hyperobject-esd
:ho-type ho-type
- :format-func (slot-value dsd 'format-func)
+ :print-formatter (slot-value dsd 'print-formatter)
:subobject (slot-value dsd 'subobject)
:reference (slot-value dsd 'reference)
+ :description (slot-value dsd 'description)
ia)))
)
ho-type)))
;;;; Class initialization function
-
-(defun init-hyperobject-class (cl)
- (let ((fmtstr-text "")
- (fmtstr-html "")
- (fmtstr-xml "")
- (fmtstr-text-labels "")
- (fmtstr-html-labels "")
- (fmtstr-xml-labels "")
- (fmtstr-html-ref "")
- (fmtstr-xml-ref "")
- (fmtstr-html-ref-labels "")
- (fmtstr-xml-ref-labels "")
- (first-field t)
- (value-func '())
- (xmlvalue-func '())
- (classname (class-name cl))
- (package (symbol-package (class-name cl)))
- (references nil)
- (subobjects nil))
- (declare (ignore classname))
- (dolist (f (class-slots cl))
- (if (slot-value f 'subobject)
- (push (make-instance 'subobject :name (slot-definition-name f)
- :reader (if (eq t (esd-subobject f))
- (slot-definition-name f)
- (esd-subobject f)))
- subobjects)
- (let ((name (slot-definition-name f))
- (namestr (symbol-name (slot-definition-name f)))
- (namestr-lower (string-downcase (symbol-name (slot-definition-name f))))
- (type (slot-value f 'ho-type))
- (formatter (slot-value f 'format-func))
- (value-fmt "~a")
- (plain-value-func nil)
- html-str xml-str html-label-str xml-label-str)
-
- (when (or (eql type :integer) (eql type :fixnum))
- (setq value-fmt "~d"))
-
- (when (eql type :commainteger)
- (setq value-fmt "~:d"))
-
- (when (eql type :boolean)
- (setq value-fmt "~a"))
-
- (if first-field
- (setq first-field nil)
- (progn
- (string-append fmtstr-text " ")
- (string-append fmtstr-html " ")
- (string-append fmtstr-xml " ")
- (string-append fmtstr-text-labels " ")
- (string-append fmtstr-html-labels " ")
- (string-append fmtstr-xml-labels " ")
- (string-append fmtstr-html-ref " ")
- (string-append fmtstr-xml-ref " ")
- (string-append fmtstr-html-ref-labels " ")
- (string-append fmtstr-xml-ref-labels " ")))
-
- (setq html-str (concatenate 'string "<span class=\"" namestr-lower "\">" value-fmt "</span>"))
- (setq xml-str (concatenate 'string "<" namestr-lower ">" value-fmt "</" namestr-lower ">"))
- (setq html-label-str (concatenate 'string "<span class=\"label\">" namestr-lower "</span> <span class=\"" namestr-lower "\">" value-fmt "</span>"))
- (setq xml-label-str (concatenate 'string "<label>" namestr-lower "</label> <" namestr-lower ">" value-fmt "</" namestr-lower ">"))
-
+
+(defun find-slot-by-name (cl name)
+ (find name (class-slots cl) :key #'slot-definition-name))
+
+
+(defun process-subobjects (cl)
+ "Process class subobjects slot"
+ (setf (slot-value cl 'subobjects)
+ (let ((subobjects '()))
+ (dolist (slot (class-slots cl))
+ (when (slot-value slot 'subobject)
+ (push (make-instance 'subobject :name (slot-definition-name slot)
+ :reader (if (eq t (esd-subobject slot))
+ (slot-definition-name slot)
+ (esd-subobject slot)))
+ subobjects)))
+ subobjects)))
+
+(defun process-documentation (cl)
+ "Calculate class documentation slot"
+ (awhen (slot-value cl 'title)
+ (setf (slot-value cl 'title) (car it)))
+ (awhen (slot-value cl 'description)
+ (setf (slot-value cl 'description) (car it)))
+
+ (let ((*print-circle* nil))
+ (setf (documentation (class-name cl) 'class)
+ (format nil "Hyperobject~A~A~A~A"
+ (aif (slot-value cl 'title)
+ (format nil ": ~A" it ""))
+ (aif (slot-value cl 'description)
+ (format nil "~%Class description: ~A" it) "")
+ (aif (slot-value cl 'subobjects)
+ (format nil "~%Subobjects:~{ ~A~}" (mapcar #'name it)) "")
+ (aif (slot-value cl 'print-slots)
+ (format nil "~%Print-slots:~{ ~A~}" it) "")
+ ))))
+
+(defun process-views (cl)
+ "Calculate all view slots for a hyperobject class"
+ (let ((fmtstr-text "")
+ (fmtstr-html "")
+ (fmtstr-xml "")
+ (fmtstr-text-labels "")
+ (fmtstr-html-labels "")
+ (fmtstr-xml-labels "")
+ (fmtstr-html-ref "")
+ (fmtstr-xml-ref "")
+ (fmtstr-html-ref-labels "")
+ (fmtstr-xml-ref-labels "")
+ (first-field t)
+ (value-func '())
+ (xmlvalue-func '())
+ (classname (class-name cl))
+ (package (symbol-package (class-name cl)))
+ (references nil))
+ (declare (ignore classname))
+ (dolist (slot-name (slot-value cl 'print-slots))
+ (let ((slot (find-slot-by-name cl slot-name)))
+ (unless slot
+ (error "Slot ~A is not found in class ~S" slot-name cl))
+ (let ((name (slot-definition-name slot))
+ (namestr (symbol-name (slot-definition-name slot)))
+ (namestr-lower (string-downcase (symbol-name (slot-definition-name slot))))
+ (type (slot-value slot 'ho-type))
+ (print-formatter (slot-value slot 'print-formatter))
+ (value-fmt "~a")
+ (plain-value-func nil)
+ html-str xml-str html-label-str xml-label-str)
+
+ (when (or (eql type :integer) (eql type :fixnum))
+ (setq value-fmt "~d"))
+
+ (when (eql type :boolean)
+ (setq value-fmt "~a"))
+
+ (if first-field
+ (setq first-field nil)
+ (progn
+ (string-append fmtstr-text " ")
+ (string-append fmtstr-html " ")
+ (string-append fmtstr-xml " ")
+ (string-append fmtstr-text-labels " ")
+ (string-append fmtstr-html-labels " ")
+ (string-append fmtstr-xml-labels " ")
+ (string-append fmtstr-html-ref " ")
+ (string-append fmtstr-xml-ref " ")
+ (string-append fmtstr-html-ref-labels " ")
+ (string-append fmtstr-xml-ref-labels " ")))
+
+ (setq html-str (concatenate 'string "<span class=\"" namestr-lower "\">" value-fmt "</span>"))
+ (setq xml-str (concatenate 'string "<" namestr-lower ">" value-fmt "</" namestr-lower ">"))
+ (setq html-label-str (concatenate 'string "<span class=\"label\">" namestr-lower "</span> <span class=\"" namestr-lower "\">" value-fmt "</span>"))
+ (setq xml-label-str (concatenate 'string "<label>" namestr-lower "</label> <" namestr-lower ">" value-fmt "</" namestr-lower ">"))
+
(string-append fmtstr-text value-fmt)
(string-append fmtstr-html html-str)
(string-append fmtstr-xml xml-str)
(string-append fmtstr-html-labels html-label-str)
(string-append fmtstr-xml-labels xml-label-str)
- (if (esd-reference f)
+ (if (esd-reference slot)
(progn
(string-append fmtstr-html-ref "<~~a>" value-fmt "</~~a>")
(string-append fmtstr-xml-ref "<~~a>" value-fmt "</~~a>")
(string-append fmtstr-html-ref-labels "<span class=\"label\">" namestr-lower "</span> <~~a>" value-fmt "</~~a>")
(string-append fmtstr-xml-ref-labels "<label>" namestr-lower "</label> <~~a>" value-fmt "</~~a>")
- (push (make-instance 'reference :name name :lookup (esd-reference f))
+ (push (make-instance 'reference :name name :lookup (esd-reference slot))
references))
(progn
(string-append fmtstr-html-ref html-str)
(string-append fmtstr-html-ref-labels html-label-str)
(string-append fmtstr-xml-ref-labels xml-label-str)))
- (if formatter
+ (if print-formatter
(setq plain-value-func
- (list `(,formatter (,(intern namestr package) x))))
+ (list `(,print-formatter (,(intern namestr package) x))))
(setq plain-value-func
(list `(,(intern namestr package) x))))
(setq value-func (append value-func plain-value-func))
(setq xmlvalue-func (append xmlvalue-func (list `(xml-cdata ,@plain-value-func))))
(setq xmlvalue-func (append xmlvalue-func plain-value-func)))
)))
-
- (setf (slot-value cl 'references) references)
- (setf (slot-value cl 'subobjects) subobjects)
-
- (if value-func
- (setq value-func `(lambda (x) (values ,@value-func)))
+
+ (setf (slot-value cl 'references) references)
+
+ (if value-func
+ (setq value-func `(lambda (x) (values ,@value-func)))
(setq value-func `(lambda () (values))))
- (setq value-func (compile nil (eval value-func)))
-
- (if xmlvalue-func
- (setq xmlvalue-func `(lambda (x) (values ,@xmlvalue-func)))
+ (setq value-func (compile nil (eval value-func)))
+
+ (if xmlvalue-func
+ (setq xmlvalue-func `(lambda (x) (values ,@xmlvalue-func)))
(setq xmlvalue-func `(lambda () (values))))
- (setq xmlvalue-func (compile nil (eval xmlvalue-func)))
-
- (setf (slot-value cl 'fmtstr-text) fmtstr-text)
- (setf (slot-value cl 'fmtstr-html) fmtstr-html)
- (setf (slot-value cl 'fmtstr-xml) fmtstr-xml)
- (setf (slot-value cl 'fmtstr-text-labels) fmtstr-text-labels)
- (setf (slot-value cl 'fmtstr-html-labels) fmtstr-html-labels)
- (setf (slot-value cl 'fmtstr-xml-labels) fmtstr-xml-labels)
- (setf (slot-value cl 'fmtstr-html-ref) fmtstr-html-ref)
- (setf (slot-value cl 'fmtstr-xml-ref) fmtstr-xml-ref)
- (setf (slot-value cl 'fmtstr-html-ref-labels) fmtstr-html-ref-labels)
- (setf (slot-value cl 'fmtstr-xml-ref-labels) fmtstr-xml-ref-labels)
- (setf (slot-value cl 'value-func) value-func)
- (setf (slot-value cl 'xmlvalue-func) xmlvalue-func))
- (values))
+ (setq xmlvalue-func (compile nil (eval xmlvalue-func)))
+
+ (setf (slot-value cl 'fmtstr-text) fmtstr-text)
+ (setf (slot-value cl 'fmtstr-html) fmtstr-html)
+ (setf (slot-value cl 'fmtstr-xml) fmtstr-xml)
+ (setf (slot-value cl 'fmtstr-text-labels) fmtstr-text-labels)
+ (setf (slot-value cl 'fmtstr-html-labels) fmtstr-html-labels)
+ (setf (slot-value cl 'fmtstr-xml-labels) fmtstr-xml-labels)
+ (setf (slot-value cl 'fmtstr-html-ref) fmtstr-html-ref)
+ (setf (slot-value cl 'fmtstr-xml-ref) fmtstr-xml-ref)
+ (setf (slot-value cl 'fmtstr-html-ref-labels) fmtstr-html-ref-labels)
+ (setf (slot-value cl 'fmtstr-xml-ref-labels) fmtstr-xml-ref-labels)
+ (setf (slot-value cl 'value-func) value-func)
+ (setf (slot-value cl 'xmlvalue-func) xmlvalue-func))
+ (values))
+(defun init-hyperobject-class (cl)
+ "Initialize a hyperobject class. Calculates all class slots"
+ (process-subobjects cl)
+ (process-views cl)
+ (process-documentation cl))
(defun hyperobject-class-fmtstr-text (obj)
(slot-value (class-of obj) 'fmtstr-text))
(fmt-file-end fmt os)))
objs)
-
-(defclass hyperobject ()
- ()
- (:metaclass hyperobject-class))
-
-
-(defmethod print-object ((obj hyperobject) (s stream))
- (print-unreadable-object (obj s :type t :identity t)
- (let ((fmt (make-instance 'hyperobject::textformat)))
- (apply #'format
- s (funcall (hyperobject-mop::obj-data-fmtstr fmt) obj)
- (multiple-value-list
- (funcall (funcall (hyperobject-mop::obj-data-value-func fmt) obj) obj))))))
-
projects / hyperobject.git / blobdiff