;;;; in Text, HTML, and XML formats. This includes hyperlinking
;;;; capability and sub-objects.
;;;;
-;;;; $Id: ml-class.lisp,v 1.8 2002/10/14 07:07:30 kevin Exp $
+;;;; $Id: ml-class.lisp,v 1.21 2002/10/18 07:28:57 kevin Exp $
;;;;
;;;; This file, part of KMRCL, is Copyright (c) 2002 by Kevin M. Rosenberg
;;;;
#+sbcl (sb-pcl:class-of obj)
#+cmu (pcl:class-of obj))
+(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)
(defmethod pcl:finalize-inheritance :after ((cl ml-class))
(init-ml-class cl))
+#+scl
+(defmethod clos:finalize-inheritance :after ((cl ml-class))
+ (init-ml-class cl))
+
#+sbcl
(defmethod sb-pcl:finalize-inheritance :after ((cl ml-class))
(defmethod pcl:validate-superclass ((class ml-class) (superclass pcl::standard-class))
t)
+#+scl
+(defmethod clos:validate-superclass ((class ml-class) (superclass standard-class))
+ t)
+
#+sbcl
(defmethod sb-pcl:validate-superclass ((class ml-class) (superclass sb-pcl::standard-class))
t)
(defmethod clos: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)
(name (eql :title))
(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))
(string-append fmtstr-html-ref-labels " ")
(string-append fmtstr-xml-ref-labels " ")))
- (setq html-str value-fmt)
+ (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 "<i>" namestr-lower "</i> " value-fmt))
+ (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)
(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 "<i>" namestr-lower "</i> <~~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>"))
(progn
(string-append fmtstr-html-ref html-str)
(if formatter
(setq plain-value-func
- (list `(,formatter (,(concat-symbol-pkg
- :umlisp namestr) x))))
+ (list `(,formatter (,(intern namestr package) x))))
(setq plain-value-func
- (list `(,(concat-symbol-pkg
- :umlisp namestr) x))))
+ (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)))
))
-
- (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)
;;; Class name functions
+(defgeneric ml-class-stdname (x))
(defmethod ml-class-stdname ((name string))
(string-downcase (subseq name 1)))
(defmethod ml-class-stdname ((cl standard-object))
- (string-downcase (subseq (class-name (ml-class-of cl)) 1)))
+ (string-downcase (subseq (ml-class-name (ml-class-of cl)) 1)))
;;;; 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)
(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))
(: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*)))
:obj-data-end-fmtstr "~%"
:obj-data-value-func #'ml-class-value-func))
+
+(defun class-name-of (obj)
+ (string-downcase (ml-class-name (ml-class-of obj))))
+
+(defun htmlformat-list-start-value-func (x nitems)
+ (values (ml-class-title x) nitems (class-name-of x)))
+
(defclass htmlformat (textformat)
()
(:default-initargs :file-start-str "<html><body>~%"
:file-end-str "</body><html>~%"
:list-start-indent t
- :list-start-fmtstr "<p><b>~a~P:</b></p><ul>~%"
- :list-start-value-func #'text-list-start-value-func
- :list-end-fmtstr "</ul>~%"
+ :list-start-fmtstr "<p><b>~a~p:</b></p><div class=\"~A\"><ul>~%"
+ :list-start-value-func #'htmlformat-list-start-value-func
+ :list-end-fmtstr "</ul></div>~%"
:list-end-indent t
:list-end-value-func #'identity
:obj-start-indent t
:obj-data-fmtstr-labels #'ml-class-fmtstr-html-labels
:obj-data-value-func #'ml-class-value-func))
+(defclass xhtmlformat (textformat)
+ ()
+ (:default-initargs :file-start-str "<html><body>~%"
+ :file-end-str "</body><html>~%"
+ :list-start-indent t
+ :list-start-fmtstr "<p><b>~a~p:</b></p><div class=\"~A\"><ul>~%"
+ :list-start-value-func #'htmlformat-list-start-value-func
+ :list-end-fmtstr "</ul></div>~%"
+ :list-end-indent t
+ :list-end-value-func #'identity
+ :obj-start-indent t
+ :obj-start-fmtstr "<li>"
+ :obj-start-value-func #'identity
+ :obj-end-indent t
+ :obj-end-fmtstr "</li>~%"
+ :obj-end-value-func #'identity
+ :obj-data-indent t
+ :obj-data-fmtstr #'ml-class-fmtstr-html-labels
+ :obj-data-fmtstr-labels #'ml-class-fmtstr-html-labels
+ :obj-data-value-func #'ml-class-xmlvalue-func))
-(defun class-name-of (obj)
- (string-downcase (class-name (ml-class-of obj))))
(defun xmlformat-list-end-value-func (x)
- (format nil "~alist" (string-downcase (class-name (ml-class-of x)))))
+ (format nil "~alist" (class-name-of x)))
(defun xmlformat-list-start-value-func (x nitems)
- (values (format nil "~alist" (string-downcase (class-name (ml-class-of x)))) (ml-class-title x) nitems))
+ (values (format nil "~alist" (class-name-of x)) (ml-class-title x) nitems))
(defclass xmlformat (textformat)
()
:href-end "a"
:ampersand "&"))
+(defclass xhtml-link-ref (link-ref)
+ ()
+ (:default-initargs :fmtstr #'ml-class-fmtstr-html-ref
+ :fmtstr-labels #'ml-class-fmtstr-html-ref-labels
+ :href-head "a href="
+ :href-end "a"
+ :ampersand "&"))
+
(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 xhtmlrefformat (xhtmlformat)
+ ()
+ (:default-initargs :link-ref (make-instance 'xhtml-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))
(aif (file-start-str fmt)
(format s it)))
+(defgeneric fmt-file-end (fmt s))
(defmethod fmt-file-end ((fmt textformat) (s stream))
(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)
(indent-spaces indent s))
(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)
;;; 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)
(indent-spaces indent s))
(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)
(indent-spaces indent s))
;;; 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\""
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)
(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
(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)
(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)))
(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)
;;; 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
(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))
(let ((nobjs (length objs)))
(fmt-list-start (car objs) fmt strm indent nobjs)
(dolist (obj objs)
- (unless (and english-only-function (not (funcall english-only-function obj)))
+ (unless (and english-only-function
+ (multiple-value-bind (eng term) (funcall english-only-function obj)
+ (and term (not eng))))
(fmt-obj-start obj fmt strm indent)
(fmt-obj-data obj fmt strm (1+ indent) label refvars)
(if subobjects