X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=ml-class.lisp;h=c3d20406c47b2c816bee4473e7e0db5d601170c1;hb=c15cf85d501d4787024dfbd01af69ce1ba836e36;hp=cfe2ab7455d26a3f12bcba792d63de393ffaf2a1;hpb=5e5cc3c20a925d8af5de153a118fdaf0792dd7e2;p=kmrcl.git diff --git a/ml-class.lisp b/ml-class.lisp index cfe2ab7..c3d2040 100644 --- a/ml-class.lisp +++ b/ml-class.lisp @@ -11,20 +11,32 @@ ;;;; in Text, HTML, and XML formats. This includes hyperlinking ;;;; capability and sub-objects. ;;;; -;;;; $Id: ml-class.lisp,v 1.1 2002/10/06 13:21:47 kevin Exp $ +;;;; $Id: ml-class.lisp,v 1.13 2002/10/16 05:57:12 kevin Exp $ ;;;; -;;;; This file, part of Webutils, is Copyright (c) 2002 by Kevin M. Rosenberg +;;;; This file, part of KMRCL, is Copyright (c) 2002 by Kevin M. Rosenberg ;;;; -;;;; Webutils users are granted the rights to distribute and use this software -;;;; as governed by the terms of the GNU General Public License. +;;;; KMRCL users are granted the rights to distribute and use this software +;;;; as governed by the terms of the Lisp Lesser GNU Public License +;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL. ;;;; ************************************************************************* -(in-package :webutils) +(in-package :kmrcl) (declaim (optimize (speed 3) (safety 1))) +(defun ml-class-of (obj) + #-(or cmu sbcl) (class-of obj) + #+sbcl (sb-pcl:class-of obj) + #+cmu (pcl:class-of obj)) -(defclass ml-class (standard-class) +(defun ml-class-name (obj) + #-(or cmu sbcl) (class-name obj) + #+sbcl (sb-pcl:class-name obj) + #+cmu (pcl:class-name obj)) + +(defclass ml-class (#-(or cmu sbcl) standard-class + #+cmu pcl::standard-class + #+sbcl sb-pcl::standard-class) ((title :initarg :title :type string :reader ml-std-title :documentation "Print Title for class") @@ -60,6 +72,23 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (:default-initargs :title nil :fields nil :subobjects-lists nil :ref-fields nil) (:documentation "Metaclass for Markup Language classes.")) +#+cmu +(defmethod pcl:finalize-inheritance :after ((cl ml-class)) + (init-ml-class cl)) + + +#+sbcl +(defmethod sb-pcl:finalize-inheritance :after ((cl ml-class)) + (init-ml-class cl)) + + +#+cmu +(defmethod pcl:validate-superclass ((class ml-class) (superclass pcl::standard-class)) + t) + +#+sbcl +(defmethod sb-pcl:validate-superclass ((class ml-class) (superclass sb-pcl::standard-class)) + t) #+allegro (defmethod mop:finalize-inheritance :after ((cl ml-class)) @@ -69,9 +98,15 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (defmethod clos:finalize-inheritance :after ((cl ml-class)) (init-ml-class cl)) -#+cmu -(defmethod pcl:finalize-inheritance :after ((cl ml-class)) - (init-ml-class cl)) +;;#+cmu +;;(defmethod pcl::class-finalized-p ((cl ml-class)) +;; (and (not (null (slot-value cl 'pcl::wrapper))) +;; (not (null (slot-value cl 'fmtstr-text))))) + +;;#+sbcl +;;(defmethod sb-pcl::class-finalized-p ((cl ml-class)) +;; (and (not (null (slot-value cl 'sb-pcl::wrapper))) +;; (not (null (slot-value cl 'fmtstr-text))))) #+lispworks (defmethod clos:process-a-class-option ((class ml-class) @@ -124,6 +159,7 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (value-func '()) (xmlvalue-func '()) (classname (class-name cl)) + (package (symbol-package (ml-class-name cl))) (ref-fields (slot-value cl 'ref-fields))) (declare (ignore classname)) (dolist (f (slot-value cl 'fields)) @@ -148,48 +184,46 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (if first-field (setq first-field nil) (progn - (gu:string-append fmtstr-text " ") - (gu:string-append fmtstr-html " ") - (gu:string-append fmtstr-xml " ") - (gu:string-append fmtstr-text-labels " ") - (gu:string-append fmtstr-html-labels " ") - (gu:string-append fmtstr-xml-labels " ") - (gu:string-append fmtstr-html-ref " ") - (gu:string-append fmtstr-xml-ref " ") - (gu:string-append fmtstr-html-ref-labels " ") - (gu:string-append fmtstr-xml-ref-labels " "))) + (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 value-fmt) (setq xml-str (concatenate 'string "<" namestr-lower ">" value-fmt "")) (setq html-label-str (concatenate 'string "" namestr-lower " " value-fmt)) (setq xml-label-str (concatenate 'string " <" namestr-lower ">" value-fmt "")) - (gu:string-append fmtstr-text value-fmt) - (gu:string-append fmtstr-html html-str) - (gu:string-append fmtstr-xml xml-str) - (gu:string-append fmtstr-text-labels namestr-lower " " value-fmt) - (gu:string-append fmtstr-html-labels html-label-str) - (gu:string-append fmtstr-xml-labels xml-label-str) + (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 (find name ref-fields :key #'car) (progn - (gu:string-append fmtstr-html-ref "<~~a>" value-fmt "") - (gu:string-append fmtstr-xml-ref "<~~a>" value-fmt "") - (gu:string-append fmtstr-html-ref-labels "" namestr-lower " <~~a>" value-fmt "") - (gu:string-append fmtstr-xml-ref-labels " <~~a>" value-fmt "")) + (string-append fmtstr-html-ref "<~~a>" value-fmt "") + (string-append fmtstr-xml-ref "<~~a>" value-fmt "") + (string-append fmtstr-html-ref-labels "" namestr-lower " <~~a>" value-fmt "") + (string-append fmtstr-xml-ref-labels " <~~a>" value-fmt "")) (progn - (gu:string-append fmtstr-html-ref html-str) - (gu:string-append fmtstr-xml-ref xml-str) - (gu:string-append fmtstr-html-ref-labels html-label-str) - (gu:string-append fmtstr-xml-ref-labels xml-label-str))) + (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 (,(gu:concat-symbol-pkg - :umlisp namestr) x)))) + (list `(,formatter (,(intern namestr package) x)))) (setq plain-value-func - (list `(,(gu:concat-symbol-pkg - :umlisp namestr) x)))) + (list `(,(intern namestr package) x)))) (setq value-func (append value-func plain-value-func)) (if (eql type :cdata) @@ -197,9 +231,14 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (setq xmlvalue-func (append xmlvalue-func plain-value-func))) )) - (setq value-func `(lambda (x) (values ,@value-func))) + (if value-func + (setq value-func `(lambda (x) (values ,@value-func))) + (setq value-func `(lambda () (values)))) (setq value-func (compile nil (eval value-func))) - (setq xmlvalue-func `(lambda (x) (values ,@xmlvalue-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) @@ -218,64 +257,65 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (defun ml-class-fmtstr-text (obj) - (slot-value (class-of obj) 'fmtstr-text)) + (slot-value (ml-class-of obj) 'fmtstr-text)) (defun ml-class-fmtstr-html (obj) - (slot-value (class-of obj) 'fmtstr-html)) + (slot-value (ml-class-of obj) 'fmtstr-html)) (defun ml-class-fmtstr-xml (obj) - (slot-value (class-of obj) 'fmtstr-xml)) + (slot-value (ml-class-of obj) 'fmtstr-xml)) (defun ml-class-fmtstr-text-labels (obj) - (slot-value (class-of obj) 'fmtstr-text-labels)) + (slot-value (ml-class-of obj) 'fmtstr-text-labels)) (defun ml-class-fmtstr-html-labels (obj) - (slot-value (class-of obj) 'fmtstr-html-labels)) + (slot-value (ml-class-of obj) 'fmtstr-html-labels)) (defun ml-class-fmtstr-xml-labels (obj) - (slot-value (class-of obj) 'fmtstr-xml-labels)) + (slot-value (ml-class-of obj) 'fmtstr-xml-labels)) (defun ml-class-value-func (obj) - (slot-value (class-of obj) 'value-func)) + (slot-value (ml-class-of obj) 'value-func)) (defun ml-class-xmlvalue-func (obj) - (slot-value (class-of obj) 'xmlvalue-func)) + (slot-value (ml-class-of obj) 'xmlvalue-func)) (eval-when (:compile-toplevel :load-toplevel :execute) (defun ml-class-title (obj) - (gu:awhen (slot-value (class-of obj) 'title) - (if (consp gu:it) - (car gu:it) - gu:it)))) + (awhen (slot-value (ml-class-of obj) 'title) + (if (consp it) + (car it) + it)))) (defun ml-class-subobjects-lists (obj) - (slot-value (class-of obj) 'subobjects-lists)) + (slot-value (ml-class-of obj) 'subobjects-lists)) (defun ml-class-ref-fields (obj) - (slot-value (class-of obj) 'ref-fields)) + (slot-value (ml-class-of obj) 'ref-fields)) (defun ml-class-fields (obj) - (slot-value (class-of obj) 'fields)) + (slot-value (ml-class-of obj) 'fields)) (defun ml-class-fmtstr-html-ref (obj) - (slot-value (class-of obj) 'fmtstr-html-ref)) + (slot-value (ml-class-of obj) 'fmtstr-html-ref)) (defun ml-class-fmtstr-xml-ref (obj) - (slot-value (class-of obj) 'fmtstr-xml-ref)) + (slot-value (ml-class-of obj) 'fmtstr-xml-ref)) (defun ml-class-fmtstr-html-ref-labels (obj) - (slot-value (class-of obj) 'fmtstr-html-ref-labels)) + (slot-value (ml-class-of obj) 'fmtstr-html-ref-labels)) (defun ml-class-fmtstr-xml-ref-labels (obj) - (slot-value (class-of obj) 'fmtstr-xml-ref-labels)) + (slot-value (ml-class-of obj) 'fmtstr-xml-ref-labels)) ;;; Class name functions +(defgeneric ml-class-stdname (x)) (defmethod ml-class-stdname ((name string)) - (string-downcase (subseq name :start 1))) + (string-downcase (subseq name 1))) (defmethod ml-class-stdname ((cl standard-object)) - (string-downcase (subseq (class-name (class-of cl)) :start 1))) + (string-downcase (subseq (ml-class-name (ml-class-of cl)) 1))) ;;;; Generic Print functions @@ -284,6 +324,7 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (defparameter *default-htmlrefformat* nil) (defparameter *default-xmlformat* nil) (defparameter *default-xmlrefformat* nil) +(defparameter *default-ie-xmlrefformat* nil) (defparameter *default-nullformat* nil) (defparameter *default-init-format?* nil) @@ -294,6 +335,7 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (setq *default-htmlrefformat* (make-instance 'htmlrefformat)) (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)) @@ -302,7 +344,9 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (:html *default-htmlformat*) (:htmlref *default-htmlrefformat*) (:xml *default-xmlformat*) + (:xml *default-xmlformat*) (:xmlref *default-xmlrefformat*) + (:ie-xmlref *default-ie-xmlrefformat*) (:null *default-nullformat*) (otherwise *default-textformat*))) @@ -378,22 +422,19 @@ Format is ((field-name field-lookup-func other-link-params) ...)") :obj-data-fmtstr-labels #'ml-class-fmtstr-html-labels :obj-data-value-func #'ml-class-value-func)) -(defclass htmlrefformat (htmlformat) - () - (:default-initargs :link-ref (make-instance 'html-link-ref))) (defun class-name-of (obj) - (string-downcase (class-name (class-of obj)))) + (string-downcase (ml-class-name (ml-class-of obj)))) (defun xmlformat-list-end-value-func (x) - (format nil "~alist" (string-downcase (class-name (class-of x))))) + (format nil "~alist" (string-downcase (ml-class-name (ml-class-of x))))) (defun xmlformat-list-start-value-func (x nitems) - (values (format nil "~alist" (string-downcase (class-name (class-of x)))) (ml-class-title x) nitems)) + (values (format nil "~alist" (string-downcase (ml-class-name (ml-class-of x)))) (ml-class-title x) nitems)) (defclass xmlformat (textformat) () - (:default-initargs :file-start-str "" ; (gu:std-xml-header) + (:default-initargs :file-start-str "" ; (std-xml-header) :list-start-indent t :list-start-fmtstr "<~a>~a~p: ~%" :list-start-value-func #'xmlformat-list-start-value-func @@ -411,10 +452,6 @@ Format is ((field-name field-lookup-func other-link-params) ...)") :obj-data-fmtstr-labels #'ml-class-fmtstr-xml-labels :obj-data-value-func #'ml-class-xmlvalue-func)) -(defclass xmlrefformat (xmlformat) - () - (:default-initargs :link-ref (make-instance 'xml-link-ref))) - (defclass link-ref () ((fmtstr :type function :initarg :fmtstr :accessor fmtstr) (fmtstr-labels :type function :initarg :fmtstr-labels :accessor fmtstr-labels) @@ -439,63 +476,90 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (defclass xml-link-ref (link-ref) () (:default-initargs :fmtstr #'ml-class-fmtstr-xml-ref - :fmtstr-labels #'ml-class-fmtstr-xml-ref-labels - :href-head "xmllink xlink:type=\"simple\" xlink:href=" - :href-end "xmllink" - :ampersand "&")) + :fmtstr-labels #'ml-class-fmtstr-xml-ref-labels + :href-head "xmllink xlink:type=\"simple\" xlink:href=" + :href-end "xmllink" + :ampersand "&") + (:documentation "Mozilla's and W3's idea of a link with XML")) + +(defclass ie-xml-link-ref (xml-link-ref) + () + (:default-initargs :href-head "html:a href=" + :href-end "html:a" ) + (:documentation "Internet Explorer's idea of a link with XML")) + + +(defclass htmlrefformat (htmlformat) + () + (:default-initargs :link-ref (make-instance 'html-link-ref))) + +(defclass xmlrefformat (xmlformat) + () + (:default-initargs :link-ref (make-instance 'xml-link-ref))) + +(defclass ie-xmlrefformat (xmlformat) + () + (:default-initargs :link-ref (make-instance 'ie-xml-link-ref))) ;;; File Start and Ends +(defgeneric fmt-file-start (fmt s)) (defmethod fmt-file-start ((fmt dataformat) (s stream))) (defmethod fmt-file-start ((fmt textformat) (s stream)) - (gu:aif (file-start-str fmt) - (format s gu::it))) + (aif (file-start-str fmt) + (format s it))) +(defgeneric fmt-file-end (fmt s)) (defmethod fmt-file-end ((fmt textformat) (s stream)) - (gu:aif (file-end-str fmt) - (format s gu::it))) + (aif (file-end-str fmt) + (format s it))) ;;; List Start and Ends +(defgeneric fmt-list-start (obj fmt s &optional indent num-items)) (defmethod fmt-list-start (x (fmt textformat) (s stream) &optional (indent 0) (num-items 1)) (if (list-start-indent fmt) - (gu:indent-spaces indent s)) - (gu:aif (list-start-fmtstr fmt) - (apply #'format s gu::it + (indent-spaces indent s)) + (aif (list-start-fmtstr fmt) + (apply #'format s it (multiple-value-list (funcall (list-start-value-func fmt) x num-items))))) +(defgeneric fmt-list-end (obj fmt s &optional indent num-items)) (defmethod fmt-list-end (x (fmt textformat) (s stream) &optional (indent 0) (num-items 1)) (declare (ignore num-items)) (if (list-end-indent fmt) - (gu:indent-spaces indent s)) - (gu:aif (list-end-fmtstr fmt) - (apply #'format s gu::it + (indent-spaces indent s)) + (aif (list-end-fmtstr fmt) + (apply #'format s it (multiple-value-list (funcall (list-end-value-func fmt) x))))) ;;; Object Start and Ends +(defgeneric fmt-obj-start (obj fmt s &optional indent)) (defmethod fmt-obj-start (x (fmt textformat) (s stream) &optional (indent 0)) (if (obj-start-indent fmt) - (gu:indent-spaces indent s)) - (gu:aif (obj-start-fmtstr fmt) - (apply #'format s gu::it + (indent-spaces indent s)) + (aif (obj-start-fmtstr fmt) + (apply #'format s it (multiple-value-list (funcall (obj-start-value-func fmt) x))))) +(defgeneric fmt-obj-end (obj fmt s &optional indent)) (defmethod fmt-obj-end (x (fmt textformat) (s stream) &optional (indent 0)) (if (obj-end-indent fmt) - (gu:indent-spaces indent s)) - (gu:aif (obj-end-fmtstr fmt) - (apply #'format s gu::it + (indent-spaces indent s)) + (aif (obj-end-fmtstr fmt) + (apply #'format s it (multiple-value-list (funcall (obj-end-value-func fmt) x))))) ;;; Object Data +(defgeneric make-link-start (obj ref fieldname fieldfunc fieldvalue refvars)) (defmethod make-link-start (obj (ref link-ref) fieldname fieldfunc fieldvalue refvars) (declare (ignore obj fieldname)) (format nil "~a\"~a?func=~a~akey=~a~a\"" @@ -504,26 +568,29 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (if refvars (let ((varstr "")) (dolist (var refvars) - (gu:string-append varstr (format nil "~a~a=~a" + (string-append varstr (format nil "~a~a=~a" (ampersand ref) (car var) (cadr var)))) varstr) ""))) +(defgeneric make-link-end (obj ref fieldname)) (defmethod make-link-end (obj (ref link-ref) fieldname) (declare (ignore obj fieldname)) (format nil "~a" (href-end ref)) ) +(defgeneric fmt-obj-data (obj fmt s &optional indent label refvars)) (defmethod fmt-obj-data (x (fmt textformat) s &optional (indent 0) (label nil) (refvars nil)) (if (obj-data-indent fmt) - (gu:indent-spaces indent s)) + (indent-spaces indent s)) (if (link-ref fmt) (fmt-obj-data-with-ref x fmt s label refvars) (fmt-obj-data-plain x fmt s label)) - (gu:aif (obj-data-end-fmtstr fmt) - (format s gu::it))) + (aif (obj-data-end-fmtstr fmt) + (format s it))) +(defgeneric fmt-obj-data-plain (obj fmt s label)) (defmethod fmt-obj-data-plain (x (fmt textformat) s label) (if label (apply #'format s @@ -534,6 +601,7 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (multiple-value-list (funcall (funcall (obj-data-value-func fmt) x) x))))) +(defgeneric fmt-obj-data-with-ref (obj fmt s label refvars)) (defmethod fmt-obj-data-with-ref (x (fmt textformat) s label refvars) (let ((refstr (make-ref-data-str x fmt label)) (refvalues nil) @@ -553,7 +621,8 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (setq refvalues (nreverse refvalues)) (apply #'format s refstr refvalues))) - + +(defgeneric obj-data (obj)) (defmethod obj-data (x) "Returns the objects data as a string. Used by common-graphics outline function" (let ((fmt (make-format-instance :text))) @@ -561,6 +630,7 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (multiple-value-list (funcall (funcall (obj-data-value-func fmt) x) x))))) +(defgeneric make-ref-data-str (obj fmt &optional label)) (defmethod make-ref-data-str (x (fmt textformat) &optional (label nil)) "Return fmt string for that contains ~a slots for reference link start and end" (unless (link-ref fmt) @@ -577,23 +647,25 @@ Format is ((field-name field-lookup-func other-link-params) ...)") ;;; Display method for objects +(defgeneric load-all-subobjects (objs)) (defmethod load-all-subobjects (objs) "Load all subobjects if they have not already been loaded." (when objs - (let ((objlist (gu:mklist objs))) + (let ((objlist (mklist objs))) (dolist (obj objlist) - (gu:awhen (ml-class-subobjects-lists obj) ;; access list of functions - (dolist (child-obj gu::it) ;; for each child function - (gu:awhen (funcall (car child-obj) obj) - (load-all-subobjects gu:it)))))) + (awhen (ml-class-subobjects-lists obj) ;; access list of functions + (dolist (child-obj it) ;; for each child function + (awhen (funcall (car child-obj) obj) + (load-all-subobjects it)))))) objs)) +(defgeneric output-ml-class (objs fmt strm &optional label english-only-function indent subobjects refvars)) (defmethod output-ml-class (objs (fmt dataformat) (strm stream) &optional (label nil) (english-only-function nil) (indent 0) (subobjects nil) (refvars nil)) "Display a single or list of ml-class instances and their subobjects" (when objs - (setq objs (gu:mklist objs)) + (setq objs (mklist objs)) (let ((nobjs (length objs))) (fmt-list-start (car objs) fmt strm indent nobjs) (dolist (obj objs) @@ -601,10 +673,10 @@ Format is ((field-name field-lookup-func other-link-params) ...)") (fmt-obj-start obj fmt strm indent) (fmt-obj-data obj fmt strm (1+ indent) label refvars) (if subobjects - (gu:awhen (ml-class-subobjects-lists obj) ;; access list of functions - (dolist (child-obj gu::it) ;; for each child function - (gu:awhen (funcall (car child-obj) obj) ;; access set of child objects - (output-ml-class gu::it fmt strm label + (awhen (ml-class-subobjects-lists obj) ;; access list of functions + (dolist (child-obj it) ;; for each child function + (awhen (funcall (car child-obj) obj) ;; access set of child objects + (output-ml-class it fmt strm label english-only-function (1+ indent) subobjects refvars))))) (fmt-obj-end obj fmt strm indent)))