;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*- ;;;; ************************************************************************* ;;;; FILE IDENTIFICATION ;;;; ;;;; Name: hyperobject.lisp ;;;; Purpose: Hyper Object Metaclass ;;;; 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. ;;;; ;;;; $Id: hyperobject.lisp,v 1.7 2002/11/22 16:05:08 kevin Exp $ ;;;; ;;;; This file is Copyright (c) 2000-2002 by Kevin M. Rosenberg ;;;; ;;;; ************************************************************************* (in-package :hyperobject-mop) (eval-when (:compile-toplevel :execute) (declaim (optimize (speed 3) (safety 1) (compilation-speed 0) (debug 3)))) #+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) )) (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) (subobject :initarg :subobject :initform nil :accessor esd-subobject) (reference :initarg :reference :initform nil :accessor esd-reference) )) ;; 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) ...)") ;;; 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) ) (:default-initargs :title nil :subobjects nil :references nil) (:documentation "Metaclass for Markup Language classes.")) (defclass subobject () ((name :type symbol :initform nil :initarg :name :reader name) (reader :type function :initform nil :initarg :reader :reader reader))) (defmethod print-object ((obj subobject) (s stream)) (print-unreadable-object (obj s :type t :identity t) (format s "~S" (name obj)))) (defclass reference () ((name :type symbol :initform nil :initarg :name :reader name) (lookup :type function :initform nil :initarg :lookup :reader lookup) (link-parameters :type list :initform nil :initarg :link-parameters :reader link-parameters))) (defmethod print-object ((obj reference) (s stream)) (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)) (init-hyperobject-class cl)) ;; Slot definitions (defmethod direct-slot-definition-class ((cl hyperobject-class) &rest iargs) (find-class 'hyperobject-dsd)) #+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)) (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))) (apply #'make-instance 'hyperobject-esd :ho-type ho-type :format-func (slot-value dsd 'format-func) :subobject (slot-value dsd 'subobject) :reference (slot-value dsd 'reference) ia))) ) (defun convert-ho-type (ho-type) (check-type ho-type symbol) (case (intern (symbol-name ho-type) (symbol-name :keyword)) (:string 'string) (:fixnum 'fixnum) (:boolean 'boolean) (:integer 'integer) (:cdata 'string) (:float 'float) (otherwise 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 "" value-fmt "")) (setq xml-str (concatenate 'string "<" namestr-lower ">" value-fmt "" namestr-lower ">")) (setq html-label-str (concatenate 'string "" namestr-lower " " value-fmt "")) (setq xml-label-str (concatenate 'string " <" 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-text-labels namestr-lower " " value-fmt) (string-append fmtstr-html-labels html-label-str) (string-append fmtstr-xml-labels xml-label-str) (if (esd-reference f) (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 "" namestr-lower " <~~a>" value-fmt "~~a>") (string-append fmtstr-xml-ref-labels " <~~a>" value-fmt "~~a>") (push (make-instance 'reference :name name :lookup (esd-reference f)) references)) (progn (string-append fmtstr-html-ref html-str) (string-append fmtstr-xml-ref xml-str) (string-append fmtstr-html-ref-labels html-label-str) (string-append fmtstr-xml-ref-labels xml-label-str))) (if formatter (setq plain-value-func (list `(,formatter (,(intern namestr package) x)))) (setq plain-value-func (list `(,(intern namestr package) x)))) (setq value-func (append value-func plain-value-func)) (if (eql type :cdata) (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))) (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 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)) (defun hyperobject-class-fmtstr-text (obj) (slot-value (class-of obj) 'fmtstr-text)) (defun hyperobject-class-fmtstr-html (obj) (slot-value (class-of obj) 'fmtstr-html)) (defun hyperobject-class-fmtstr-xml (obj) (slot-value (class-of obj) 'fmtstr-xml)) (defun hyperobject-class-fmtstr-text-labels (obj) (slot-value (class-of obj) 'fmtstr-text-labels)) (defun hyperobject-class-fmtstr-html-labels (obj) (slot-value (class-of obj) 'fmtstr-html-labels)) (defun hyperobject-class-fmtstr-xml-labels (obj) (slot-value (class-of obj) 'fmtstr-xml-labels)) (defun hyperobject-class-value-func (obj) (slot-value (class-of obj) 'value-func)) (defun hyperobject-class-xmlvalue-func (obj) (slot-value (class-of obj) 'xmlvalue-func)) (eval-when (:compile-toplevel :load-toplevel :execute) (defun hyperobject-class-title (obj) (awhen (slot-value (class-of obj) 'title) (if (consp it) (car it) it)))) (defun hyperobject-class-subobjects (obj) (slot-value (class-of obj) 'subobjects)) (defun hyperobject-class-references (obj) (slot-value (class-of obj) 'references)) (defun hyperobject-class-fields (obj) (class-slots (class-of obj))) (defun hyperobject-class-fmtstr-html-ref (obj) (slot-value (class-of obj) 'fmtstr-html-ref)) (defun hyperobject-class-fmtstr-xml-ref (obj) (slot-value (class-of obj) 'fmtstr-xml-ref)) (defun hyperobject-class-fmtstr-html-ref-labels (obj) (slot-value (class-of obj) 'fmtstr-html-ref-labels)) (defun hyperobject-class-fmtstr-xml-ref-labels (obj) (slot-value (class-of obj) 'fmtstr-xml-ref-labels)) ;;;; Generic Print functions (defparameter *default-textformat* nil) (defparameter *default-htmlformat* nil) (defparameter *default-htmlrefformat* nil) (defparameter *default-xhtmlformat* nil) (defparameter *default-xhtmlrefformat* nil) (defparameter *default-xmlformat* nil) (defparameter *default-xmlrefformat* nil) (defparameter *default-ie-xmlrefformat* nil) (defparameter *default-nullformat* nil) (defparameter *default-init-format?* nil) (defun make-format-instance (fmt) (unless *default-init-format?* (setq *default-textformat* (make-instance 'textformat)) (setq *default-htmlformat* (make-instance 'htmlformat)) (setq *default-htmlrefformat* (make-instance 'htmlrefformat)) (setq *default-xhtmlformat* (make-instance 'xhtmlformat)) (setq *default-xhtmlrefformat* (make-instance 'xhtmlrefformat)) (setq *default-xmlformat* (make-instance 'xmlformat)) (setq *default-xmlrefformat* (make-instance 'xmlrefformat)) (setq *default-ie-xmlrefformat* (make-instance 'ie-xmlrefformat)) (setq *default-nullformat* (make-instance 'nullformat)) (setq *default-init-format?* t)) (case fmt (:text *default-textformat*) (:html *default-htmlformat*) (:htmlref *default-htmlrefformat*) (:xhtml *default-xhtmlformat*) (:xhtmlref *default-xhtmlrefformat*) (:xml *default-xmlformat*) (:xmlref *default-xmlrefformat*) (:ie-xmlref *default-ie-xmlrefformat*) (:null *default-nullformat*) (otherwise *default-textformat*))) ;;;; Output format classes for print hyperobject-classes (defclass dataformat () ((file-start-str :type string :initarg :file-start-str :reader file-start-str) (file-end-str :type string :initarg :file-end-str :reader file-end-str) (list-start-fmtstr :type string :initarg :list-start-fmtstr :reader list-start-fmtstr) (list-start-value-func :type function :initarg :list-start-value-func :reader list-start-value-func) (list-start-indent :initarg :list-start-indent :reader list-start-indent) (list-end-fmtstr :type string :initarg :list-end-fmtstr :reader list-end-fmtstr) (list-end-value-func :type function :initarg :list-end-value-func :reader list-end-value-func) (list-end-indent :initarg :list-end-indent :reader list-end-indent) (obj-start-fmtstr :type string :initarg :obj-start-fmtstr :reader obj-start-fmtstr) (obj-start-value-func :initarg :obj-start-value-func :reader obj-start-value-func) (obj-start-indent :initarg :obj-start-indent :reader obj-start-indent) (obj-end-fmtstr :type string :initarg :obj-end-fmtstr :reader obj-end-fmtstr) (obj-end-value-func :initarg :obj-end-value-func :reader obj-end-value-func) (obj-end-indent :initarg :obj-end-indent :reader obj-end-indent) (obj-data-indent :initarg :obj-data-indent :reader obj-data-indent) (obj-data-fmtstr :initarg :obj-data-fmtstr :reader obj-data-fmtstr) (obj-data-fmtstr-labels :initarg :obj-data-fmtstr-labels :reader obj-data-fmtstr-labels) (obj-data-end-fmtstr :initarg :obj-data-end-fmtstr :reader obj-data-end-fmtstr) (obj-data-value-func :initarg :obj-data-value-func :reader obj-data-value-func) (link-ref :initarg :link-ref :reader link-ref)) (:default-initargs :file-start-str nil :file-end-str nil :list-start-fmtstr nil :list-start-value-func nil :list-start-indent nil :list-end-fmtstr nil :list-end-value-func nil :list-end-indent nil :obj-start-fmtstr nil :obj-start-value-func nil :obj-start-indent nil :obj-end-fmtstr nil :obj-end-value-func nil :obj-end-indent nil :obj-data-indent nil :obj-data-fmtstr nil :obj-data-fmtstr-labels nil :obj-data-end-fmtstr nil :obj-data-value-func nil :link-ref nil) (:documentation "Parent for all dataformat objects")) (defclass binaryformat (dataformat) ()) (defclass nullformat (dataformat) ()) (defun text-list-start-value-func (obj nitems) (values (hyperobject-class-title obj) nitems)) (defclass textformat (dataformat) () (:default-initargs :list-start-fmtstr "~a~P:~%" :list-start-value-func #'text-list-start-value-func :list-start-indent t :obj-data-indent t :obj-data-fmtstr #'hyperobject-class-fmtstr-text :obj-data-fmtstr-labels #'hyperobject-class-fmtstr-text-labels :obj-data-end-fmtstr "~%" :obj-data-value-func #'hyperobject-class-value-func)) (defun class-name-of (obj) (string-downcase (class-name (class-of obj)))) (defun htmlformat-list-start-value-func (x nitems) (values (hyperobject-class-title x) nitems (class-name-of x))) (defclass htmlformat (textformat) () (:default-initargs :file-start-str "
~%" :file-end-str "~%" :list-start-indent t :list-start-fmtstr "~a~p:
~a~p: