views.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          views.lisp
   6 ;;;; Purpose:       View methods for Hyperobjects
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Apr 2000
   9 ;;;;
  10 ;;;; $Id: views.lisp,v 1.57 2003/06/20 08:35:21 kevin Exp $
  11 ;;;;
  12 ;;;; This file is Copyright (c) 2000-2003 by Kevin M. Rosenberg
  13 ;;;; *************************************************************************
  14
  15 (in-package #:hyperobject)
  16
  17
  18 (defclass object-view ()
  19   ((object-class-name :initform nil :initarg :object-class-name
  20                       :accessor object-class-name
  21                  :documentation "Name of class of object to be viewed.")
  22    (object-class :initform nil :initarg :object-class
  23                  :accessor object-class
  24                  :documentation "Class of object to be viewed.")
  25    (slots :initform nil :initarg :slots :accessor slots
  26           :documentation "List of effective slots for object to be viewed.")
  27    (name :initform nil :initarg :name :accessor name
  28          :documentation "Name for this view.")
  29    (category :initform nil :initarg :category :accessor category
  30              :documentation "Category for view. Helpful when want to find a view corresponding to a particular category.")
  31    (source-code :initform nil :initarg :source-code :accessor source-code
  32                 :documentation "Source code for generating view.")
  33    (country-language :initform :en :initarg :country-language
  34                      :documentation "Country's Language for this view.")
  35    ;;
  36    (file-start-str :type (or string null) :initform nil :initarg :file-start-str
  37                    :accessor file-start-str)
  38    (file-end-str :type (or string null) :initform nil :initarg :file-end-str
  39                  :accessor file-end-str)
  40    (list-start-printer :type (or string function null) :initform nil
  41                            :initarg :list-start-printer
  42                       :accessor list-start-printer)
  43    (list-start-indent :initform nil :initarg :list-start-indent
  44                       :accessor list-start-indent)
  45    (list-end-printer :type (or string function null) :initform nil
  46                          :initarg :list-end-printer
  47                     :accessor list-end-printer)
  48    (list-end-indent :initform nil :initarg :list-end-indent
  49                     :accessor list-end-indent)
  50    (obj-start-printer :type (or string function null) :initform nil :initarg :obj-start-printer
  51                      :accessor obj-start-printer)
  52    (obj-start-indent :initform nil :initarg :obj-start-indent
  53                      :accessor obj-start-indent)
  54    (obj-end-printer :type (or string function null) :initform nil :initarg :obj-end-printer
  55                    :accessor obj-end-printer)
  56    (obj-end-indent :initform nil :initarg :obj-end-indent
  57                    :accessor obj-end-indent)
  58    (subobj-start-printer :type (or string function null) :initform nil :initarg :subobj-start-printer
  59                      :accessor subobj-start-printer)
  60    (subobj-start-indent :initform nil :initarg :subobj-start-indent
  61                      :accessor subobj-start-indent)
  62    (subobj-end-printer :type (or string function null) :initform nil :initarg :subobj-end-printer
  63                    :accessor subobj-end-printer)
  64    (subobj-end-indent :initform nil :initarg :subobj-end-indent
  65                    :accessor subobj-end-indent)
  66    (obj-data-indent :initform nil :initarg :obj-data-indent
  67                     :accessor obj-data-indent)
  68    (obj-data-printer :type (or function null) :initform nil
  69                         :initarg :obj-data-printer
  70                         :accessor obj-data-printer)
  71    (obj-data-print-code :type (or function null) :initform nil
  72                   :initarg :obj-data-print-code
  73                   :accessor obj-data-print-code)
  74    (obj-data-start-printer :type (or function string null) :initform nil
  75                      :initarg :obj-data-start-printer
  76                      :accessor obj-data-start-printer)
  77    (obj-data-end-printer :type (or string null) :initform nil
  78                         :initarg :obj-data-end-printer
  79                         :accessor obj-data-end-printer)
  80    (indenter :type (or function null) :initform nil
  81              :accessor indenter
  82              :documentation "Function that performs hierarchical indenting")
  83    (link-slots :type list :initform nil
  84                :documentation "List of slot names that have hyperlinks"
  85                :accessor link-slots)
  86    (link-page :type (or string null) :initform nil
  87                       :initarg :link-page
  88                       :accessor link-page)
  89    (link-href-start :type (or string null) :initform nil :initarg :link-href-start
  90                     :accessor link-href-start)
  91    (link-href-end :type (or string null) :initform nil :initarg :link-href-end
  92                   :accessor link-href-end)
  93    (link-ampersand :type (or string null) :initform nil :initarg :link-ampersand
  94                    :accessor link-ampersand))
  95   (:default-initargs :link-page "disp-func1")
  96   (:documentation "View class for a hyperobject"))
  97
  98
  99 (defun get-category-view (obj category &optional slots)
 100   "Find or make a category view for an object"
 101   (let ((obj-class (class-of obj)))
 102     (if (null category)
 103         (default-view obj-class)
 104         (aif (find category (views obj-class) :key #'category)
 105              it
 106              (let ((view
 107                     (make-instance 'object-view
 108                                    :object-class-name (class-name obj-class)
 109                                    :object-class obj-class
 110                                    :category category
 111                                    :slots slots)))
 112                (push view (views obj-class))
 113                view)))))
 114
 115 ;;;; *************************************************************************
 116 ;;;;  Metaclass Intialization
 117 ;;;; *************************************************************************
 118
 119 (defun finalize-views (cl)
 120   "Finalize all views that are given on a objects initialization"
 121   (unless (default-print-slots cl)
 122     (setf (default-print-slots cl)
 123           (mapcar #'slot-definition-name (class-slots cl))))
 124   (let ((views '()))
 125     (dolist (view-def (views cl))
 126       (push (make-object-view cl view-def) views))
 127     (setf (views cl) (nreverse views)))
 128   (cond
 129     ((default-view cl)
 130      (setf (default-view cl) (make-object-view cl (default-view cl))))
 131     ((car (views cl))
 132      (setf (default-view cl) (make-object-view cl (car (views cl)))))
 133     (t
 134      (setf (default-view cl) (make-object-view cl :default)))))
 135
 136 (defun make-object-view (cl view-def)
 137   "Make an object view from a definition. Do nothing if a class is passed so that reinitialization will be a no-op"
 138   (cond
 139     ((typep view-def 'object-view)
 140      view-def)
 141     ((eq view-def :default)
 142      (let* ((name (class-name cl))
 143             (view (make-instance 'object-view :name "automatic"
 144                                  :object-class-name name
 145                                  :object-class cl
 146                                  :category :compact-text)))
 147        view))
 148     ((consp view-def)
 149      (apply #'make-instance 'object-view view-def))
 150     (t
 151      (error "Invalid parameter to make-object-view: ~S" view-def))))
 152
 153 (defmethod initialize-instance :after ((view object-view)
 154                                        &rest initargs &key &allow-other-keys)
 155   (initialize-view (object-class view) view))
 156
 157 (defun initialize-view (obj-cl view)
 158   "Calculate all view slots for a hyperobject class"
 159   (cond
 160     ((category view)
 161      (initialize-view-by-category obj-cl view))
 162     ((source-code view)
 163      (initialize-view-by-source-code obj-cl view))
 164     (t
 165      (setf (category view) :compact-text)
 166      (initialize-view-by-category obj-cl view))))
 167
 168 (defun initialize-view-by-source-code (obj-cl view)
 169   "Initialize a view based upon a source code"
 170   (let ((source-code (source-code view)))
 171     (error "not implemented")
 172     )
 173   )
 174
 175 (defmacro write-simple (v s)
 176   `(typecase ,v
 177     (string
 178      (write-string ,v ,s))
 179     (fixnum
 180      (write-fixnum ,v ,s))
 181     (symbol
 182      (write-string (symbol-name ,v) ,s))
 183     (t
 184      (write-string (write-to-string ,v) ,s))))
 185
 186 (defun write-ho-value (obj name type formatter cdata strm)
 187   (declare (ignorable type))
 188   (let* ((slot-data (slot-value obj name))
 189          (fmt-data (if formatter
 190                        (funcall formatter slot-data)
 191                        slot-data)))
 192     (if cdata
 193         (write-xml-cdata fmt-data strm)
 194         (write-simple fmt-data strm))))
 195
 196 (defun ppfc-html (title name type formatter cdata print-func)
 197   (vector-push-extend '(write-string "<span class=\"" s) print-func)
 198   (vector-push-extend `(write-string ,title s) print-func)
 199   (vector-push-extend '(write-string "\">" s) print-func)
 200   (vector-push-extend `(write-ho-value x ',name ',type ',formatter ,cdata s) print-func)
 201   (vector-push-extend '(write-string "</span>" s) print-func))
 202
 203 (defun ppfc-xml (tag name type formatter cdata print-func)
 204   (vector-push-extend '(write-char #\< s) print-func)
 205   (vector-push-extend `(write-string ,tag s) print-func)
 206   (vector-push-extend '(write-char #\> s) print-func)
 207   (vector-push-extend `(write-ho-value x ',name ',type ',formatter ,cdata s) print-func)
 208   (vector-push-extend '(write-string "</" s) print-func)
 209   (vector-push-extend `(write-string ,tag s) print-func)
 210   (vector-push-extend '(write-char #\> s) print-func))
 211
 212 (defun ppfc-html-labels (label name type formatter cdata print-func)
 213   (vector-push-extend '(write-string "<span class=\"label\">" s) print-func)
 214   (vector-push-extend `(write-string ,label s) print-func)
 215   (vector-push-extend '(write-string "</span> " s) print-func)
 216   (ppfc-html label name type formatter cdata print-func))
 217
 218 (defun ppfc-xhtml-labels (label tag name type formatter cdata print-func)
 219   (vector-push-extend '(write-string "<span class=\"label\">" s) print-func)
 220   (vector-push-extend `(write-string ,label s) print-func)
 221   (vector-push-extend '(write-string "</span> " s) print-func)
 222   (ppfc-html tag name type formatter cdata print-func))
 223
 224 (defun ppfc-xml-labels (label tag name type formatter cdata print-func)
 225   (vector-push-extend '(write-string "<label>" s) print-func)
 226   (vector-push-extend `(write-string ,label s) print-func)
 227   (vector-push-extend '(write-string "</label> " s) print-func)
 228   (ppfc-xml tag name type formatter cdata print-func))
 229
 230 (defun ppfc-html-link (name type formatter cdata nlink print-func)
 231   (declare (fixnum nlink))
 232   (vector-push-extend '(write-char #\< s) print-func)
 233   (vector-push-extend `(write-string (nth ,(+ nlink nlink) links) s) print-func)
 234   (vector-push-extend '(write-char #\> s) print-func)
 235   (vector-push-extend `(write-ho-value x ',name ',type ',formatter ,cdata s) print-func)
 236   (vector-push-extend '(write-string "</" s) print-func)
 237   (vector-push-extend `(write-string (nth ,(+ nlink nlink 1) links) s) print-func)
 238   (vector-push-extend '(write-char #\> s) print-func))
 239
 240 (defun ppfc-html-link-labels (label name type formatter cdata nlink print-func)
 241   (vector-push-extend '(write-string "<span class=\"label\">" s) print-func)
 242   (vector-push-extend `(write-string ,label s) print-func)
 243   (vector-push-extend '(write-string "</span> " s) print-func)
 244   (ppfc-html-link name type formatter cdata nlink print-func))
 245
 246 (defun push-print-fun-code (category slot nlink print-func)
 247   (let* ((formatter (esd-print-formatter slot))
 248          (name (slot-definition-name slot))
 249          (user-name (esd-user-name slot))
 250          (xml-user-name (escape-xml-string user-name))
 251          (xml-tag (escape-xml-string user-name))
 252          (type (slot-value slot 'type))
 253          (cdata (not (null
 254                       (and (in category :xml :xhtml :xml-link :xhtml-link
 255                                :xml-labels :ie-xml-labels
 256                                :xhtml-link-labels :xml-link-labels :ie-xml-link
 257                                :ie-xml-link-labels)
 258                            (or formatter
 259                                (lisp-type-is-a-string type))))))
 260          (hyperlink (esd-hyperlink slot)))
 261
 262     (case category
 263       (:compact-text
 264        (vector-push-extend
 265         `(write-ho-value x ',name ',type ',formatter ,cdata s) print-func))
 266       (:compact-text-labels
 267        (vector-push-extend `(write-string ,user-name s) print-func)
 268        (vector-push-extend '(write-char #\space s) print-func)
 269        (vector-push-extend
 270         `(write-ho-value x ',name ',type ',formatter ,cdata s) print-func))
 271       ((or :html :xhtml)
 272        (ppfc-html user-name name type formatter cdata print-func))
 273       (:xml
 274        (ppfc-xml xml-tag name type formatter cdata print-func))
 275       (:html-labels
 276        (ppfc-html-labels user-name name type formatter cdata print-func))
 277       (:xhtml-labels
 278        (ppfc-xhtml-labels xml-user-name user-name name type formatter cdata print-func))
 279       (:xml-labels
 280        (ppfc-xml-labels xml-user-name xml-tag name type formatter cdata print-func))
 281       ((or :html-link :xhtml-link)
 282        (if hyperlink
 283            (ppfc-html-link name type formatter cdata nlink print-func)
 284            (ppfc-html user-name name type formatter cdata print-func)))
 285       ((or :xml-link :ie-xml-link)
 286        (if hyperlink
 287            (ppfc-html-link name type formatter cdata nlink print-func)
 288            (ppfc-xml xml-tag name type formatter cdata print-func)))
 289       (:html-link-labels
 290        (if hyperlink
 291            (ppfc-html-link-labels user-name name type formatter cdata nlink
 292                                   print-func)
 293            (ppfc-html-labels user-name name type formatter cdata print-func)))
 294       (:xhtml-link-labels
 295        (if hyperlink
 296            (ppfc-html-link-labels xml-user-name name type formatter cdata nlink
 297                                   print-func)
 298            (ppfc-xhtml-labels xml-tag user-name name type formatter cdata
 299                               print-func)))
 300       ((or :xml-link-labels :ie-xml-link-labels)
 301        (if hyperlink
 302            (ppfc-html-link-labels xml-user-name name type formatter cdata nlink
 303                                   print-func)
 304            (ppfc-xml-labels xml-tag user-name name type formatter cdata
 305                             print-func))))))
 306
 307
 308 (defun view-has-links-p (view)
 309   (in (category view) :html-link :xhtml-link :xml-link :ie-xml-link
 310       :html-link-labels :xhtml-link-labels :xml-link-labels
 311       :ie-xml-link-labels))
 312
 313 (defun initialize-view-by-category (obj-cl view)
 314   "Initialize a view based upon a preset category"
 315   (unless (in (category view) :compact-text :compact-text-labels
 316               :html :html-labels :html-link-labels
 317               :xhtml :xhtml-labels :xhtml-link-labels
 318               :xhtml-link :html-link
 319               :xml :xml-labels :xml-link :ie-xml-link
 320               :xml-link-labels :ie-xml-link-labels)
 321     (error "Unknown view category ~A" (category view)))
 322
 323   (unless (slots view) (setf (slots view) (default-print-slots obj-cl)))
 324
 325   (let ((links '())
 326         (print-func (make-array 10 :fill-pointer 0 :adjustable t)))
 327
 328     (do* ((slots (slots view) (cdr slots))
 329           (slot-name (car slots) (car slots))
 330           (slot (find-slot-by-name obj-cl slot-name)
 331                 (find-slot-by-name obj-cl slot-name)))
 332          ((null slots))
 333       (unless slot
 334         (error "Slot ~A is not found in class ~S" slot-name obj-cl))
 335
 336       (push-print-fun-code (category view) slot (length links) print-func)
 337       (when (> (length slots) 1)
 338         (vector-push-extend '(write-char #\space s) print-func))
 339
 340       (when (and (view-has-links-p view) (esd-hyperlink slot))
 341         (push (slot-definition-name slot) links)))
 342
 343     (vector-push-extend 'x print-func) ;; return object
 344     (setf (obj-data-print-code view) `(lambda (x s links)
 345                                        (declare (ignorable s links))
 346                                        ,@(map 'list #'identity print-func)))
 347     (setf (obj-data-printer view)
 348           (compile nil (eval (obj-data-print-code view))))
 349
 350     (setf (link-slots view) (nreverse links)))
 351
 352   (finalize-view-by-category view)
 353   view)
 354
 355 (defun finalize-view-by-category (view)
 356   (case (category view)
 357     ((or :compact-text :compact-text-labels)
 358      (initialize-text-view view))
 359     ((or :html :html-labels)
 360      (initialize-html-view view))
 361     ((or :xhtml :xhtml-labels)
 362      (initialize-xhtml-view view))
 363     ((or :xml :xml-labels)
 364      (initialize-xml-view view))
 365     ((or :html-link :html-link-labels)
 366      (initialize-html-view view)
 367      (setf (link-href-start view) "a href=")
 368      (setf (link-href-end view) "a")
 369      (setf (link-ampersand view) "&"))
 370     ((or :xhtml-link :xhtml-link-labels)
 371      (initialize-xhtml-view view)
 372      (setf (link-href-start view) "a href=")
 373      (setf (link-href-end view) "a")
 374      (setf (link-ampersand view) "&amp;"))
 375     ((or :xml-link :xml-link-labels)
 376      (initialize-xml-view view)
 377      (setf (link-href-start view)
 378            "xmllink xlink:type=\"simple\" xlink:href=")
 379      (setf (link-href-end view) "xmllink")
 380      (setf (link-ampersand view) "&amp;"))
 381     ((or :ie-xml-link :ie-xml-link-labels)
 382      (initialize-xml-view view)
 383      (setf (link-href-start view) "html:a href=")
 384      (setf (link-href-end view) "html:a")
 385      (setf (link-ampersand view) "&amp;"))))
 386
 387
 388 ;;;; *************************************************************************
 389 ;;;;  View Data Format Section
 390 ;;;; *************************************************************************
 391
 392 (defun class-name-of (obj)
 393   (string-downcase (class-name (class-of obj))))
 394
 395 (defvar +newline-string+ (format nil "~%"))
 396
 397 (defun write-user-name-maybe-plural (obj nitems strm)
 398   (write-string
 399    (if (> nitems 1)
 400        (hyperobject-class-user-name-plural obj)
 401        (hyperobject-class-user-name obj))
 402    strm))
 403
 404 (defun initialize-text-view (view)
 405   (setf (list-start-printer view)
 406         (compile nil
 407                  (eval '(lambda (obj nitems indent strm)
 408                          (declare (ignore indent))
 409                          (write-user-name-maybe-plural obj nitems strm)
 410                          (write-char #\: strm)
 411                          (write-char #\Newline strm)))))
 412   (setf (list-start-indent view) t)
 413   (setf (obj-data-indent view) t)
 414   (setf (obj-data-end-printer view) +newline-string+)
 415   (setf (indenter view) #'indent-spaces))
 416
 417 (defun html-list-start-func (obj nitems indent strm)
 418   (write-string "<div class=\"ho-username\" :style=\"margin-left:" strm)
 419   (write-fixnum (+ indent indent) strm)
 420   (write-string "em;\">" strm)
 421   (write-user-name-maybe-plural obj nitems strm)
 422   (write-string "</div>" strm)
 423   (write-char #\newline strm)
 424   (write-string "<ul>" strm)
 425   (write-char #\newline strm))
 426
 427 (defun initialize-html-view (view)
 428   (initialize-text-view view)
 429   (setf (indenter view) #'indent-spaces)
 430   (setf (file-start-str view) (format nil "<html><body>~%"))
 431   (setf (file-end-str view) (format nil "</body><html>~%"))
 432   (setf (list-start-indent view) t)
 433   (setf (list-start-printer view) #'html-list-start-func)
 434   (setf (list-end-printer view) (format nil "</ul>~%"))
 435   (setf (list-end-indent view) t)
 436   (setf (obj-start-indent view) nil)
 437   (setf (obj-start-printer view) "<li>")
 438   (setf (obj-end-indent view)  nil)
 439   (setf (obj-end-printer view)  (format nil "</li>~%"))
 440   (setf (obj-data-end-printer view) nil)
 441   (setf (obj-data-indent view) nil))
 442
 443 (defun xhtml-list-start-func (obj nitems indent strm)
 444   (write-string "<div class=\"ho-username\" :style=\"margin-left:" strm)
 445   (write-fixnum (+ indent indent) strm)
 446   (write-string "em;\">" strm)
 447   (write-user-name-maybe-plural obj nitems strm)
 448   (write-string "</div>" strm)
 449   (write-string "<div :style=\"margin-left:" strm)
 450   (write-fixnum (+ indent indent) strm)
 451   (write-string "em;\">" strm)
 452   (write-char #\newline strm))
 453
 454 (defun html-obj-start (obj indent strm)
 455   (declare (ignore obj indent))
 456   (write-string "<div style=\"margin-left:2em;" strm))
 457
 458 (defun initialize-xhtml-view (view)
 459   (initialize-text-view view)
 460   (setf (indenter view) #'indent-spaces)
 461   (setf (file-start-str view) (format nil "<html><body>~%"))
 462   (setf (file-end-str view) (format nil "</body><html>~%"))
 463   (setf (list-start-indent view) nil)
 464   (setf (list-start-printer view) #'xhtml-list-start-func)
 465   (setf (list-end-printer view) (format nil "</div>~%"))
 466   (setf (list-end-indent view) nil)
 467   (setf (obj-start-indent view) nil)
 468   (setf (obj-start-printer view) #'html-obj-start)
 469   (setf (obj-end-printer view) (format nil "</div>~%"))
 470   (setf (obj-data-indent view) nil))
 471
 472 (defun xmlformat-list-end-func (x strm)
 473   (write-string "</" strm)
 474   (write-string (class-name-of x) strm)
 475   (write-string "list" strm)
 476   (write-string ">" strm)
 477   (write-char #\newline strm))
 478
 479 (defun xmlformat-list-start-func (x nitems indent strm)
 480   (declare (ignore indent))
 481   (write-char #\< strm)
 482   (write-string (class-name-of x) strm)
 483   (write-string "list><title>" strm)
 484   (write-user-name-maybe-plural x nitems strm)
 485   (write-string ":</title>" strm)
 486   (write-char #\newline strm))
 487
 488 (defun initialize-xml-view (view)
 489   (initialize-text-view view)
 490   (setf (file-start-str view) "") ; (std-xml-header)
 491   (setf (list-start-indent view)  t)
 492   (setf (list-start-printer view) #'xmlformat-list-start-func)
 493   (setf (list-end-indent view) t)
 494   (setf (list-end-printer view) #'xmlformat-list-end-func)
 495   (setf (obj-start-printer view) (format nil "<~(~a~)>" (object-class-name view)))
 496   (setf (obj-start-indent view) t)
 497   (setf (subobj-end-printer view) (format nil "</~(~a~)>~%" (object-class-name view)))
 498   (setf (subobj-end-indent view) nil)
 499   (setf (obj-data-indent view) nil))
 500
 501
 502 ;;; File Start and Ends
 503
 504 (defun fmt-file-start (view strm)
 505   (awhen (file-start-str view)
 506          (write-string it strm)))
 507
 508 (defun fmt-file-end (view strm)
 509   (awhen (file-end-str view)
 510          (write-string it strm)))
 511
 512 ;;; List Start and Ends
 513
 514 (defun fmt-list-start (obj view strm indent num-items)
 515   (when (list-start-indent view)
 516     (awhen (indenter view)
 517            (funcall it indent strm)))
 518   (awhen (list-start-printer view)
 519          (if (stringp it)
 520              (write-string it strm)
 521              (funcall it obj num-items indent strm))))
 522
 523 (defun fmt-list-end (obj view strm indent num-items)
 524   (declare (ignore num-items))
 525   (when (list-end-indent view)
 526     (awhen (indenter view)
 527            (funcall it indent strm)))
 528   (awhen (list-end-printer view)
 529          (if (stringp it)
 530              (write-string it strm)
 531              (funcall it obj strm))))
 532
 533 ;;; Object Start and Ends
 534
 535
 536 (defun fmt-obj-start (obj view strm indent)
 537   (when (obj-start-indent view)
 538     (awhen (indenter view)
 539            (funcall it indent strm)))
 540   (awhen (obj-start-printer view)
 541          (if (stringp it)
 542              (write-string it strm)
 543              (funcall it obj indent strm))))
 544
 545 (defun fmt-obj-end (obj view strm indent)
 546   (when (obj-end-indent view)
 547     (awhen (indenter view)
 548            (funcall it indent strm)))
 549   (awhen (obj-end-printer view)
 550          (if (stringp it)
 551              (write-string it strm)
 552              (funcall it obj strm))))
 553
 554 (defun fmt-subobj-start (obj view strm indent)
 555   (when (subobj-start-indent view)
 556     (awhen (indenter view)
 557            (funcall it indent strm)))
 558   (awhen (subobj-start-printer view)
 559          (if (stringp it)
 560              (write-string it strm)
 561              (funcall it obj indent strm))))
 562
 563 (defun fmt-subobj-end (obj view strm indent)
 564   (when (subobj-end-indent view)
 565     (awhen (indenter view)
 566            (funcall it indent strm)))
 567   (awhen (subobj-end-printer view)
 568          (if (stringp it)
 569              (write-string it strm)
 570              (funcall it obj strm))))
 571
 572 ;;; Object Data
 573
 574
 575 (defun make-link-start (view fieldfunc fieldvalue refvars link-printer)
 576   (with-output-to-string (s)
 577     (write-string (link-href-start view) s)
 578     (write-char #\" s)
 579     (let ((link-page (link-page view)))
 580       (cond
 581         ((null link-printer)
 582          (write-string (make-url link-page) s)
 583          (write-string "?func=" s)
 584          (write-simple fieldfunc s)
 585          (write-string (link-ampersand view) s)
 586          (write-string "key=" s)
 587          (write-simple fieldvalue s)
 588          (dolist (var refvars)
 589            (write-string (link-ampersand view) s)
 590            (write-simple (car var) s)
 591            (write-char #\= s)
 592            (write-simple (cdr var) s)))
 593         (link-printer
 594          (funcall link-printer link-page fieldfunc fieldvalue refvars s))))
 595     (write-char #\" s)))
 596
 597 (defun make-link-end (obj view fieldname)
 598   (declare (ignore obj fieldname))
 599   (link-href-end view))
 600
 601 (defun fmt-obj-data (obj view strm indent refvars link-printer)
 602   (awhen (obj-data-start-printer view)
 603          (if (stringp it)
 604              (write-string it strm)
 605              (funcall it obj strm)))
 606   (when (obj-data-indent view)
 607     (awhen (indenter view)
 608            (funcall it indent strm)))
 609   (if (link-slots view)
 610       (fmt-obj-data-with-link obj view strm refvars link-printer)
 611       (fmt-obj-data-plain obj view strm))
 612   (awhen (obj-data-end-printer view)
 613          (if (stringp it)
 614              (write-string it strm)
 615              (funcall it obj strm))))
 616
 617 (defun fmt-obj-data-plain (obj view strm)
 618   (awhen (obj-data-printer view)
 619          (funcall it obj strm nil)))
 620
 621 (defun fmt-obj-data-with-link (obj view strm refvars link-printer)
 622   (let ((refvalues '()))
 623     (declare (dynamic-extent refvalues))
 624     ;; make list of hyperlink link fields for printing to refstr template
 625     (dolist (name (link-slots view))
 626       (awhen (find name (hyperobject-class-hyperlinks obj) :key #'name)
 627              (push (make-link-start view (lookup it) (slot-value obj name)
 628                                     (append (link-parameters it) refvars)
 629                                     link-printer)
 630                    refvalues)
 631              (push (make-link-end obj view name) refvalues)))
 632     (funcall (obj-data-printer view) obj strm (nreverse refvalues))))
 633
 634 (defun obj-data (obj view)
 635   "Returns the objects data as a string. Used by common-graphics outline function"
 636   (with-output-to-string (s) (fmt-obj-data-plain obj view s)))
 637
 638 ;;; Display method for objects
 639
 640
 641 (defun load-all-subobjects (objs)
 642   "Load all subobjects if they have not already been loaded."
 643   (dolist (obj (mklist objs))
 644     (dolist (subobj (hyperobject-class-subobjects obj))
 645       (awhen (slot-value obj (name-slot subobj))
 646              (load-all-subobjects it))))
 647   objs)
 648
 649 (defun view-hyperobject (objs view category strm &optional (indent 0) filter
 650                          subobjects refvars link-printer)
 651   "Display a single or list of hyperobject-class instances and their subobjects"
 652   (let-when (objlist (mklist objs))
 653     (let ((nobjs (length objlist))
 654           (*print-pretty* nil)
 655           (*print-circle* nil)
 656           (*print-escape* nil)
 657           (*print-readably* nil)
 658           (*print-length* nil)
 659           (*print-level* nil))
 660       (fmt-list-start (car objlist) view strm indent nobjs)
 661       (dolist (obj objlist)
 662         (unless (and filter (not (funcall filter obj)))
 663           (fmt-obj-start obj view strm indent)
 664           (fmt-obj-data obj view strm (1+ indent) refvars link-printer)
 665           (fmt-obj-end obj view strm indent)
 666           (fmt-subobj-start obj view strm indent)
 667           (when (and subobjects (hyperobject-class-subobjects obj))
 668             (dolist (subobj (hyperobject-class-subobjects obj))
 669               (aif (slot-value obj (name-slot subobj))
 670                    (view-hyperobject it
 671                                      (get-category-view (car (mklist it))
 672                                                         category)
 673                                      category strm (1+ indent) filter
 674                                      subobjects refvars link-printer))))
 675           (fmt-subobj-end obj view strm indent)))
 676       (fmt-list-end (car objlist) view strm indent nobjs)))
 677   objs)
 678
 679
 680 (defun view (objs &key (stream *standard-output*) category view
 681              filter subobjects refvars file-wrapper link-printer)
 682   "EXPORTED Function: prints hyperobject-class objects. Calls view-hyperobject"
 683   (let-when (objlist (mklist objs))
 684     (when category
 685       (setq view (get-category-view (car objlist) category)))
 686     (unless view
 687       (setq view (default-view (class-of (car objlist)))))
 688     (when file-wrapper
 689       (fmt-file-start view stream))
 690     (view-hyperobject objlist view category stream 0 filter subobjects refvars
 691                       link-printer)
 692     (when file-wrapper
 693       (fmt-file-end view stream)))
 694   objs)
 695
 696
 697 ;;; Misc formatting
 698
 699 (defun fmt-comma-integer (i)
 700   (format nil "~:d" i))