1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
6 ;;;; Purpose: View methods for Hyperobjects
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Apr 2000
10 ;;;; $Id: views.lisp,v 1.7 2002/12/05 18:31:36 kevin Exp $
12 ;;;; This file is Copyright (c) 2000-2002 by Kevin M. Rosenberg
14 ;;;; *************************************************************************
16 (in-package :hyperobject)
18 (eval-when (:compile-toplevel :execute)
19 (declaim (optimize (speed 2) (safety 2) (compilation-speed 0) (debug 2))))
22 ;;;; *************************************************************************
23 ;;;; Metaclass Intialization
24 ;;;; *************************************************************************
26 (defun finalize-hyperlinks (cl)
27 (let ((hyperlinks '()))
28 (dolist (esd (class-slots cl))
29 (awhen (slot-value esd 'hyperlink)
31 (make-instance 'hyperlink
32 :name (slot-definition-name esd)
34 :link-parameters (slot-value esd 'hyperlink-parameters))
36 (setf (slot-value cl 'hyperlinks) hyperlinks)))
39 (defun finalize-views (cl)
40 "Calculate all view slots for a hyperobject class"
41 (let ((fmtstr-text "")
44 (fmtstr-text-labels "")
45 (fmtstr-html-labels "")
46 (fmtstr-xml-labels "")
49 (fmtstr-html-ref-labels "")
50 (fmtstr-xml-ref-labels "")
54 (classname (class-name cl))
55 (package (symbol-package (class-name cl)))
57 (declare (ignore classname))
58 (check-type (slot-value cl 'print-slots) list)
59 (dolist (slot-name (slot-value cl 'print-slots))
60 (let ((slot (find-slot-by-name cl slot-name)))
62 (error "Slot ~A is not found in class ~S" slot-name cl))
63 (let ((name (slot-definition-name slot))
64 (namestr (symbol-name (slot-definition-name slot)))
65 (namestr-lower (string-downcase (symbol-name (slot-definition-name slot))))
66 (type (slot-value slot 'ho-type))
67 (print-formatter (slot-value slot 'print-formatter))
69 (plain-value-func nil)
70 html-str xml-str html-label-str xml-label-str)
72 (when (or (eql type :integer) (eql type :fixnum))
73 (setq value-fmt "~d"))
75 (when (eql type :boolean)
76 (setq value-fmt "~a"))
79 (setq first-field nil)
81 (string-append fmtstr-text " ")
82 (string-append fmtstr-html " ")
83 (string-append fmtstr-xml " ")
84 (string-append fmtstr-text-labels " ")
85 (string-append fmtstr-html-labels " ")
86 (string-append fmtstr-xml-labels " ")
87 (string-append fmtstr-html-ref " ")
88 (string-append fmtstr-xml-ref " ")
89 (string-append fmtstr-html-ref-labels " ")
90 (string-append fmtstr-xml-ref-labels " ")))
92 (setq html-str (concatenate 'string "<span class=\"" namestr-lower "\">" value-fmt "</span>"))
93 (setq xml-str (concatenate 'string "<" namestr-lower ">" value-fmt "</" namestr-lower ">"))
94 (setq html-label-str (concatenate 'string "<span class=\"label\">" namestr-lower "</span> <span class=\"" namestr-lower "\">" value-fmt "</span>"))
95 (setq xml-label-str (concatenate 'string "<label>" namestr-lower "</label> <" namestr-lower ">" value-fmt "</" namestr-lower ">"))
97 (string-append fmtstr-text value-fmt)
98 (string-append fmtstr-html html-str)
99 (string-append fmtstr-xml xml-str)
100 (string-append fmtstr-text-labels namestr-lower " " value-fmt)
101 (string-append fmtstr-html-labels html-label-str)
102 (string-append fmtstr-xml-labels xml-label-str)
104 (if (slot-value slot 'hyperlink)
106 (string-append fmtstr-html-ref "<~~a>" value-fmt "</~~a>")
107 (string-append fmtstr-xml-ref "<~~a>" value-fmt "</~~a>")
108 (string-append fmtstr-html-ref-labels "<span class=\"label\">" namestr-lower "</span> <~~a>" value-fmt "</~~a>")
109 (string-append fmtstr-xml-ref-labels "<label>" namestr-lower "</label> <~~a>" value-fmt "</~~a>")
110 (push (make-instance 'hyperlink :name name
111 :lookup (slot-value slot 'hyperlink))
114 (string-append fmtstr-html-ref html-str)
115 (string-append fmtstr-xml-ref xml-str)
116 (string-append fmtstr-html-ref-labels html-label-str)
117 (string-append fmtstr-xml-ref-labels xml-label-str)))
120 (setq plain-value-func
121 (list `(,print-formatter (slot-value x ',(intern namestr package)))))
122 (setq plain-value-func
123 (list `(slot-value x ',(intern namestr package)))))
124 (setq value-func (append value-func plain-value-func))
126 (if (eql type :cdata)
127 (setq xmlvalue-func (append xmlvalue-func (list `(xml-cdata ,@plain-value-func))))
128 (setq xmlvalue-func (append xmlvalue-func plain-value-func)))
131 (setf (slot-value cl 'hyperlinks) hyperlinks)
134 (setq value-func `(lambda (x) (values ,@value-func)))
135 (setq value-func `(lambda () (values))))
136 (setq value-func (compile nil (eval value-func)))
139 (setq xmlvalue-func `(lambda (x) (values ,@xmlvalue-func)))
140 (setq xmlvalue-func `(lambda () (values))))
141 (setq xmlvalue-func (compile nil (eval xmlvalue-func)))
143 (setf (slot-value cl 'fmtstr-text) fmtstr-text)
144 (setf (slot-value cl 'fmtstr-html) fmtstr-html)
145 (setf (slot-value cl 'fmtstr-xml) fmtstr-xml)
146 (setf (slot-value cl 'fmtstr-text-labels) fmtstr-text-labels)
147 (setf (slot-value cl 'fmtstr-html-labels) fmtstr-html-labels)
148 (setf (slot-value cl 'fmtstr-xml-labels) fmtstr-xml-labels)
149 (setf (slot-value cl 'fmtstr-html-ref) fmtstr-html-ref)
150 (setf (slot-value cl 'fmtstr-xml-ref) fmtstr-xml-ref)
151 (setf (slot-value cl 'fmtstr-html-ref-labels) fmtstr-html-ref-labels)
152 (setf (slot-value cl 'fmtstr-xml-ref-labels) fmtstr-xml-ref-labels)
153 (setf (slot-value cl 'value-func) value-func)
154 (setf (slot-value cl 'xmlvalue-func) xmlvalue-func))
158 ;;;; *************************************************************************
159 ;;;; View Data Format Section
160 ;;;; *************************************************************************
162 (defparameter *default-textformat* nil)
163 (defparameter *default-htmlformat* nil)
164 (defparameter *default-htmlrefformat* nil)
165 (defparameter *default-xhtmlformat* nil)
166 (defparameter *default-xhtmlrefformat* nil)
167 (defparameter *default-xmlformat* nil)
168 (defparameter *default-xmlrefformat* nil)
169 (defparameter *default-ie-xmlrefformat* nil)
170 (defparameter *default-nullformat* nil)
171 (defparameter *default-init-format?* nil)
173 (defun make-format-instance (fmt)
174 (unless *default-init-format?*
175 (setq *default-textformat* (make-instance 'textformat))
176 (setq *default-htmlformat* (make-instance 'htmlformat))
177 (setq *default-htmlrefformat* (make-instance 'htmlrefformat))
178 (setq *default-xhtmlformat* (make-instance 'xhtmlformat))
179 (setq *default-xhtmlrefformat* (make-instance 'xhtmlrefformat))
180 (setq *default-xmlformat* (make-instance 'xmlformat))
181 (setq *default-xmlrefformat* (make-instance 'xmlrefformat))
182 (setq *default-ie-xmlrefformat* (make-instance 'ie-xmlrefformat))
183 (setq *default-nullformat* (make-instance 'nullformat))
184 (setq *default-init-format?* t))
187 (:text *default-textformat*)
188 (:html *default-htmlformat*)
189 (:htmlref *default-htmlrefformat*)
190 (:xhtml *default-xhtmlformat*)
191 (:xhtmlref *default-xhtmlrefformat*)
192 (:xml *default-xmlformat*)
193 (:xmlref *default-xmlrefformat*)
194 (:ie-xmlref *default-ie-xmlrefformat*)
195 (:null *default-nullformat*)
196 (otherwise *default-textformat*)))
198 ;;;; Output format classes for print hyperobject-classes
200 (defclass dataformat ()
201 ((file-start-str :type string :initarg :file-start-str :reader file-start-str)
202 (file-end-str :type string :initarg :file-end-str :reader file-end-str)
203 (list-start-fmtstr :type string :initarg :list-start-fmtstr :reader list-start-fmtstr)
204 (list-start-value-func :type function :initarg :list-start-value-func :reader list-start-value-func)
205 (list-start-indent :initarg :list-start-indent :reader list-start-indent)
206 (list-end-fmtstr :type string :initarg :list-end-fmtstr :reader list-end-fmtstr)
207 (list-end-value-func :type function :initarg :list-end-value-func :reader list-end-value-func)
208 (list-end-indent :initarg :list-end-indent :reader list-end-indent)
209 (obj-start-fmtstr :type string :initarg :obj-start-fmtstr :reader obj-start-fmtstr)
210 (obj-start-value-func :initarg :obj-start-value-func :reader obj-start-value-func)
211 (obj-start-indent :initarg :obj-start-indent :reader obj-start-indent)
212 (obj-end-fmtstr :type string :initarg :obj-end-fmtstr :reader obj-end-fmtstr)
213 (obj-end-value-func :initarg :obj-end-value-func :reader obj-end-value-func)
214 (obj-end-indent :initarg :obj-end-indent :reader obj-end-indent)
215 (obj-data-indent :initarg :obj-data-indent :reader obj-data-indent)
216 (obj-data-fmtstr :initarg :obj-data-fmtstr :reader obj-data-fmtstr)
217 (obj-data-fmtstr-labels :initarg :obj-data-fmtstr-labels :reader obj-data-fmtstr-labels)
218 (obj-data-end-fmtstr :initarg :obj-data-end-fmtstr :reader obj-data-end-fmtstr)
219 (obj-data-value-func :initarg :obj-data-value-func :reader obj-data-value-func)
220 (link-ref :initarg :link-ref :reader link-ref))
221 (:default-initargs :file-start-str nil :file-end-str nil :list-start-fmtstr nil :list-start-value-func nil
222 :list-start-indent nil :list-end-fmtstr nil :list-end-value-func nil :list-end-indent nil
223 :obj-start-fmtstr nil :obj-start-value-func nil :obj-start-indent nil
224 :obj-end-fmtstr nil :obj-end-value-func nil :obj-end-indent nil
225 :obj-data-indent nil :obj-data-fmtstr nil :obj-data-fmtstr-labels nil :obj-data-end-fmtstr nil
226 :obj-data-value-func nil :link-ref nil)
227 (:documentation "Parent for all dataformat objects"))
229 (defclass binaryformat (dataformat)
232 (defclass nullformat (dataformat)
235 (defun text-list-start-value-func (obj nitems)
236 (values (hyperobject-class-title obj) nitems))
238 (defclass textformat (dataformat)
240 (:default-initargs :list-start-fmtstr "~a~P:~%"
241 :list-start-value-func #'text-list-start-value-func
244 :obj-data-fmtstr #'hyperobject-class-fmtstr-text
245 :obj-data-fmtstr-labels #'hyperobject-class-fmtstr-text-labels
246 :obj-data-end-fmtstr "~%"
247 :obj-data-value-func #'hyperobject-class-value-func))
250 (defun class-name-of (obj)
251 (string-downcase (class-name (class-of obj))))
253 (defun htmlformat-list-start-value-func (x nitems)
254 (values (hyperobject-class-title x) nitems (class-name-of x)))
256 (defclass htmlformat (textformat)
258 (:default-initargs :file-start-str "<html><body>~%"
259 :file-end-str "</body><html>~%"
261 :list-start-fmtstr "<p><b>~a~p:</b></p><div class=\"~A\"><ul>~%"
262 :list-start-value-func #'htmlformat-list-start-value-func
263 :list-end-fmtstr "</ul></div>~%"
265 :list-end-value-func #'identity
267 :obj-start-fmtstr "<li>"
268 :obj-start-value-func #'identity
270 :obj-end-fmtstr "</li>~%"
271 :obj-end-value-func #'identity
273 :obj-data-fmtstr #'hyperobject-class-fmtstr-html-labels
274 :obj-data-fmtstr-labels #'hyperobject-class-fmtstr-html-labels
275 :obj-data-value-func #'hyperobject-class-value-func))
277 (defclass xhtmlformat (textformat)
279 (:default-initargs :file-start-str "<html><body>~%"
280 :file-end-str "</body><html>~%"
282 :list-start-fmtstr "<p><b>~a~p:</b></p><div class=\"~A\"><ul>~%"
283 :list-start-value-func #'htmlformat-list-start-value-func
284 :list-end-fmtstr "</ul></div>~%"
286 :list-end-value-func #'identity
288 :obj-start-fmtstr "<li>"
289 :obj-start-value-func #'identity
291 :obj-end-fmtstr "</li>~%"
292 :obj-end-value-func #'identity
294 :obj-data-fmtstr #'hyperobject-class-fmtstr-html-labels
295 :obj-data-fmtstr-labels #'hyperobject-class-fmtstr-html-labels
296 :obj-data-value-func #'hyperobject-class-xmlvalue-func))
299 (defun xmlformat-list-end-value-func (x)
300 (format nil "~alist" (class-name-of x)))
302 (defun xmlformat-list-start-value-func (x nitems)
303 (values (format nil "~alist" (class-name-of x)) (hyperobject-class-title x) nitems))
305 (defclass xmlformat (textformat)
307 (:default-initargs :file-start-str "" ; (std-xml-header)
309 :list-start-fmtstr "<~a><title>~a~p:</title> ~%"
310 :list-start-value-func #'xmlformat-list-start-value-func
312 :list-end-fmtstr "</~a>~%"
313 :list-end-value-func #'xmlformat-list-end-value-func
314 :obj-start-fmtstr "<~a>"
315 :obj-start-value-func #'class-name-of
317 :obj-end-fmtstr "</~a>~%"
318 :obj-end-value-func #'class-name-of
321 :obj-data-fmtstr #'hyperobject-class-fmtstr-xml
322 :obj-data-fmtstr-labels #'hyperobject-class-fmtstr-xml-labels
323 :obj-data-value-func #'hyperobject-class-xmlvalue-func))
325 (defclass link-ref ()
326 ((fmtstr :type function :initarg :fmtstr :accessor fmtstr)
327 (fmtstr-labels :type function :initarg :fmtstr-labels :accessor fmtstr-labels)
328 (page-name :type string :initarg :page-name :accessor page-name)
329 (href-head :type string :initarg :href-head :accessor href-head)
330 (href-end :type string :initarg :href-end :accessor href-end)
331 (ampersand :type string :initarg :ampersand :accessor ampersand))
332 (:default-initargs :fmtstr nil
334 :page-name "disp-func1"
335 :href-head nil :href-end nil :ampersand nil)
336 (:documentation "Formatting for a linked hyperlink"))
338 (defclass html-link-ref (link-ref)
340 (:default-initargs :fmtstr #'hyperobject-class-fmtstr-html-ref
341 :fmtstr-labels #'hyperobject-class-fmtstr-html-ref-labels
346 (defclass xhtml-link-ref (link-ref)
348 (:default-initargs :fmtstr #'hyperobject-class-fmtstr-html-ref
349 :fmtstr-labels #'hyperobject-class-fmtstr-html-ref-labels
354 (defclass xml-link-ref (link-ref)
356 (:default-initargs :fmtstr #'hyperobject-class-fmtstr-xml-ref
357 :fmtstr-labels #'hyperobject-class-fmtstr-xml-ref-labels
358 :href-head "xmllink xlink:type=\"simple\" xlink:href="
361 (:documentation "Mozilla's and W3's idea of a link with XML"))
363 (defclass ie-xml-link-ref (xml-link-ref)
365 (:default-initargs :href-head "html:a href="
367 (:documentation "Internet Explorer's idea of a link with XML"))
370 (defclass htmlrefformat (htmlformat)
372 (:default-initargs :link-ref (make-instance 'html-link-ref)))
374 (defclass xhtmlrefformat (xhtmlformat)
376 (:default-initargs :link-ref (make-instance 'xhtml-link-ref)))
378 (defclass xmlrefformat (xmlformat)
380 (:default-initargs :link-ref (make-instance 'xml-link-ref)))
382 (defclass ie-xmlrefformat (xmlformat)
384 (:default-initargs :link-ref (make-instance 'ie-xml-link-ref)))
387 ;;; File Start and Ends
389 (defgeneric fmt-file-start (fmt s))
390 (defmethod fmt-file-start ((fmt dataformat) (s stream)))
392 (defmethod fmt-file-start ((fmt textformat) (s stream))
393 (aif (file-start-str fmt)
396 (defgeneric fmt-file-end (fmt s))
397 (defmethod fmt-file-end ((fmt textformat) (s stream))
398 (aif (file-end-str fmt)
401 ;;; List Start and Ends
403 (defgeneric fmt-list-start (obj fmt s &optional indent num-items))
404 (defmethod fmt-list-start (x (fmt textformat) (s stream) &optional (indent 0) (num-items 1))
405 (if (list-start-indent fmt)
406 (indent-spaces indent s))
407 (aif (list-start-fmtstr fmt)
410 (funcall (list-start-value-func fmt) x num-items)))))
412 (defgeneric fmt-list-end (obj fmt s &optional indent num-items))
413 (defmethod fmt-list-end (x (fmt textformat) (s stream) &optional (indent 0) (num-items 1))
414 (declare (ignore num-items))
415 (if (list-end-indent fmt)
416 (indent-spaces indent s))
417 (aif (list-end-fmtstr fmt)
420 (funcall (list-end-value-func fmt) x)))))
422 ;;; Object Start and Ends
424 (defgeneric fmt-obj-start (obj fmt s &optional indent))
425 (defmethod fmt-obj-start (x (fmt textformat) (s stream) &optional (indent 0))
426 (if (obj-start-indent fmt)
427 (indent-spaces indent s))
428 (aif (obj-start-fmtstr fmt)
431 (funcall (obj-start-value-func fmt) x)))))
433 (defgeneric fmt-obj-end (obj fmt s &optional indent))
434 (defmethod fmt-obj-end (x (fmt textformat) (s stream) &optional (indent 0))
435 (if (obj-end-indent fmt)
436 (indent-spaces indent s))
437 (aif (obj-end-fmtstr fmt)
440 (funcall (obj-end-value-func fmt) x)))))
444 (defgeneric make-link-start (obj ref fieldname fieldfunc fieldvalue refvars))
445 (defmethod make-link-start (obj (ref link-ref) fieldname fieldfunc fieldvalue refvars)
446 (declare (ignore obj fieldname))
447 (format nil "~a\"~a?func=~a~akey=~a~a\""
448 (href-head ref) (make-url (page-name ref)) fieldfunc
449 (ampersand ref) fieldvalue
452 (dolist (var refvars)
453 (string-append varstr (format nil "~a~a=~a"
454 (ampersand ref) (car var) (cadr var))))
458 (defgeneric make-link-end (obj ref fieldname))
459 (defmethod make-link-end (obj (ref link-ref) fieldname)
460 (declare (ignore obj fieldname))
461 (format nil "~a" (href-end ref))
464 (defgeneric fmt-obj-data (obj fmt s &optional indent label refvars))
465 (defmethod fmt-obj-data (x (fmt textformat) s
466 &optional (indent 0) (label nil) (refvars nil))
467 (if (obj-data-indent fmt)
468 (indent-spaces indent s))
470 (fmt-obj-data-with-ref x fmt s label refvars)
471 (fmt-obj-data-plain x fmt s label))
472 (aif (obj-data-end-fmtstr fmt)
475 (defgeneric fmt-obj-data-plain (obj fmt s label))
476 (defmethod fmt-obj-data-plain (x (fmt textformat) s label)
479 (funcall (obj-data-fmtstr-labels fmt) x)
481 (funcall (funcall (obj-data-value-func fmt) x) x)))
482 (apply #'format s (funcall (obj-data-fmtstr fmt) x)
484 (funcall (funcall (obj-data-value-func fmt) x) x)))))
486 (defgeneric fmt-obj-data-with-ref (obj fmt s label refvars))
487 (defmethod fmt-obj-data-with-ref (x (fmt textformat) s label refvars)
488 (let ((refstr (make-ref-data-str x fmt label))
492 (funcall (funcall (obj-data-value-func fmt) x) x))))
494 ;; make list of hyperlink link fields for printing to refstr template
495 (dolist (ref (hyperobject-class-hyperlinks x))
497 (make-link-start x (link-ref fmt) (name ref) (lookup ref)
498 (nth (position (name ref)
499 (slot-value x 'print-slots))
501 (append (link-parameters ref) refvars)))
502 (link-end (make-link-end x (link-ref fmt) (name ref))))
503 (push link-start refvalues)
504 (push link-end refvalues)))
505 (setq refvalues (nreverse refvalues))
507 (apply #'format s refstr refvalues)))
509 (defgeneric obj-data (obj))
510 (defmethod obj-data (x)
511 "Returns the objects data as a string. Used by common-graphics outline function"
512 (let ((fmt (make-format-instance :text)))
513 (apply #'format nil (funcall (obj-data-fmtstr fmt) x)
515 (funcall (funcall (obj-data-value-func fmt) x) x)))))
517 (defgeneric make-ref-data-str (obj fmt &optional label))
518 (defmethod make-ref-data-str (x (fmt textformat) &optional (label nil))
519 "Return fmt string for that contains ~a slots for hyperlink link start and end"
520 (unless (link-ref fmt)
521 (error "fmt does not contain a link-ref"))
524 (apply #'format nil (funcall (fmtstr-labels (link-ref fmt)) x)
526 (funcall (funcall (obj-data-value-func fmt) x) x)))
527 (apply #'format nil (funcall (fmtstr (link-ref fmt)) x)
528 (multiple-value-list (funcall (funcall (obj-data-value-func fmt) x) x))))))
531 ;;; Display method for objects
534 (defgeneric load-all-subobjects (objs))
535 (defmethod load-all-subobjects (objs)
536 "Load all subobjects if they have not already been loaded."
538 (let ((objlist (mklist objs)))
539 (dolist (obj objlist)
540 (awhen (hyperobject-class-subobjects obj) ;; access list of functions
541 (dolist (child-obj it) ;; for each child function
542 (awhen (funcall (reader child-obj) obj)
543 (load-all-subobjects it))))))
546 (defgeneric view-hyperobject (objs fmt strm
547 &optional label english-only-function
548 indent subobjects refvars))
550 (defmethod view-hyperobject (objs (fmt dataformat) (strm stream)
551 &optional (label nil) (indent 0)
552 (english-only-function nil)
553 (subobjects nil) (refvars nil))
554 "Display a single or list of hyperobject-class instances and their subobjects"
556 (setq objs (mklist objs))
557 (let ((nobjs (length objs)))
558 (fmt-list-start (car objs) fmt strm indent nobjs)
560 (unless (and english-only-function
561 (multiple-value-bind (eng term) (funcall english-only-function obj)
562 (and term (not eng))))
563 (fmt-obj-start obj fmt strm indent)
564 (fmt-obj-data obj fmt strm (1+ indent) label refvars)
566 (awhen (hyperobject-class-subobjects obj) ;; access list of functions
567 (dolist (child-obj it) ;; for each child function
568 (awhen (funcall (reader child-obj) obj) ;; access set of child objects
569 (view-hyperobject it fmt strm label
570 (1+ indent) english-only-function
571 subobjects refvars)))))
572 (fmt-obj-end obj fmt strm indent)))
573 (fmt-list-end (car objs) fmt strm indent nobjs))
577 (defun view (objs &key (os *standard-output*) (format :text)
578 (label nil) (english-only-function nil)
579 (subobjects nil) (file-wrapper t) (refvars nil))
580 "EXPORTED Function: prints hyperobject-class objects. Simplies call to view-hyperobject"
581 (let ((fmt (make-format-instance format)))
583 (fmt-file-start fmt os))
585 (view-hyperobject objs fmt os label 0 english-only-function subobjects refvars))
587 (fmt-file-end fmt os)))
593 (defun fmt-comma-integer (i)
594 (format nil "~:d" i))