mop.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          mop.lisp
   6 ;;;; Purpose:       Metaobject Protocol Interface
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Apr 2000
   9 ;;;;
  10 ;;;; This metaclass as functions to classes to allow display
  11 ;;;; in Text, HTML, and XML formats. This includes hyperlinking
  12 ;;;; capability and sub-objects.
  13 ;;;;
  14 ;;;; $Id: mop.lisp,v 1.67 2003/04/29 09:39:45 kevin Exp $
  15 ;;;;
  16 ;;;; This file is Copyright (c) 2000-2002 by Kevin M. Rosenberg
  17 ;;;;
  18 ;;;; *************************************************************************
  19
  20 (in-package :hyperobject)
  21
  22 (eval-when (:compile-toplevel :execute)
  23   (declaim (optimize (speed 2) (safety 2) (compilation-speed 0) (debug 2))))
  24
  25 ;; Main class
  26
  27 (defclass hyperobject-class (standard-class)
  28   ( ;; slots initialized in defclass
  29    (user-name :initarg :user-name :type string :initform nil
  30               :accessor user-name
  31               :documentation "User name for class")
  32    (default-print-slots :initarg :default-print-slots :type list :initform nil
  33                         :accessor default-print-slots
  34                         :documentation "Defaults slots for a view")
  35    (description :initarg :description :initform nil
  36                 :accessor description
  37                 :documentation "Class description")
  38    (version :initarg :version :initform nil
  39             :accessor version
  40             :documentation "Version number for class")
  41    (sql-name :initarg :sql-name :initform nil)
  42
  43    ;;; The remainder of these fields are calculated one time
  44    ;;; in finalize-inheritence.
  45
  46    (subobjects :initform nil :accessor subobjects
  47                :documentation
  48                "List of fields that contain a list of subobjects objects.")
  49    (hyperlinks :type list :initform nil :accessor hyperlinks
  50                :documentation "List of fields that have hyperlinks")
  51    (direct-rules :type list :initform nil :initarg :direct-rules
  52                  :accessor direct-rules
  53                  :documentation "List of rules to fire on slot changes.")
  54    (class-id :type integer :initform nil
  55              :accessor class-id
  56              :documentation "Unique ID for the class")
  57    (default-view :initform nil :initarg :default-view :accessor default-view
  58                  :documentation "The default view for a class")
  59
  60    ;; SQL commands
  61    (create-table-cmd :initform nil :reader create-table-cmd)
  62    (create-indices-cmds :initform nil :reader create-index-cmds)
  63    (drop-table-cmd :initform nil :reader drop-table-cmd)
  64
  65    (views :type list :initform nil :initarg :views :accessor views
  66           :documentation "List of views")
  67    (rules :type list :initform nil :initarg :rules :accessor rules
  68           :documentation "List of rules")
  69    )
  70   (:documentation "Metaclass for Markup Language classes."))
  71
  72 (defclass subobject ()
  73   ((name-class :type symbol :initform nil :initarg :name-class :reader name-class)
  74    (name-slot :type symbol :initform nil :initarg :name-slot :reader name-slot)
  75    (lookup :type (or function symbol) :initform nil :initarg :lookup :reader lookup)
  76    (lookup-keys :type list :initform nil :initarg :lookup-keys
  77                 :reader lookup-keys))
  78   (:documentation "Contains subobject information"))
  79
  80
  81 (defmethod print-object ((obj subobject) (s stream))
  82   (print-unreadable-object (obj s :type t :identity t)
  83     (format s "~S" (name obj))))
  84
  85 (defclass hyperlink ()
  86   ((name :type symbol :initform nil :initarg :name :reader name)
  87    (lookup
  88     ;; The type specifier seems to break sbcl
  89     :type (or function symbol)
  90     ;;    :type t
  91     :initform nil :initarg :lookup :reader lookup)
  92    (link-parameters :type list :initform nil :initarg :link-parameters
  93                     :reader link-parameters)))
  94
  95 (defmethod print-object ((obj hyperlink) (s stream))
  96   (print-unreadable-object (obj s :type t :identity t)
  97     (format s "~S" (name obj))))
  98
  99 #+(or cmu scl sbcl)
 100 (defmethod validate-superclass ((class hyperobject-class) (superclass standard-class))
 101   t)
 102
 103 (defmethod finalize-inheritance :after ((cl hyperobject-class))
 104   (init-hyperobject-class cl)
 105   )
 106
 107 (eval-when (:compile-toplevel :load-toplevel :execute)
 108   (when (>= (length (generic-function-lambda-list
 109                      (ensure-generic-function
 110                       'compute-effective-slot-definition)))
 111             3)
 112     (pushnew :ho-normal-cesd cl:*features*))
 113
 114     (when (>= (length (generic-function-lambda-list
 115                        (ensure-generic-function
 116                         'direct-slot-definition-class)))
 117             3)
 118       (pushnew :ho-normal-dsdc cl:*features*))
 119
 120     (when (>= (length (generic-function-lambda-list
 121                        (ensure-generic-function
 122                         'effective-slot-definition-class)))
 123               3)
 124       (pushnew :ho-normal-esdc cl:*features*)))
 125
 126 ;; Slot definitions
 127 (defmethod direct-slot-definition-class ((cl hyperobject-class)
 128                                          #+ho-normal-dsdc &rest iargs)
 129   (find-class 'hyperobject-dsd))
 130
 131 (defmethod effective-slot-definition-class ((cl hyperobject-class)
 132                                             #+ho-normal-esdc &rest iargs)
 133   (find-class 'hyperobject-esd))
 134
 135
 136 ;;; Slot definitions
 137
 138 (eval-when (:compile-toplevel :load-toplevel :execute)
 139   (defmacro process-class-option (slot-name &optional required)
 140     #+lispworks
 141     `(defmethod clos:process-a-class-option ((class hyperobject-class)
 142                                              (name (eql ,slot-name))
 143                                              value)
 144       (when (and ,required (null value))
 145         (error "hyperobject class slot ~A must have a value" name))
 146       (list name `',value))
 147     #+(or allegro sbcl cmu scl)
 148     (declare (ignore slot-name required))
 149     )
 150
 151   (defmacro process-slot-option (slot-name)
 152     #+lispworks
 153     `(defmethod clos:process-a-slot-option ((class hyperobject-class)
 154                                             (option (eql ,slot-name))
 155                                             value
 156                                             already-processed-options
 157                                             slot)
 158       (list* option `',value already-processed-options))
 159     #-lispworks
 160     (declare (ignore slot-name))
 161     )
 162
 163   (dolist (option *class-options*)
 164     (eval `(process-class-option ,option)))
 165   (dolist (option *slot-options*)
 166     (eval `(process-slot-option ,option)))
 167
 168   (eval
 169    `(defclass hyperobject-dsd (standard-direct-slot-definition)
 170      (,@(mapcar #'(lambda (x)
 171                     `(,(intern (symbol-name x))
 172                       :initform nil))
 173                 *slot-options-no-initarg*)
 174       ,@(mapcar #'(lambda (x)
 175                     `(,(intern (symbol-name x))
 176                       :initarg
 177                       ,(intern (symbol-name x) (symbol-name :keyword))
 178                       :initform nil
 179                       :accessor
 180                       ,(intern (concatenate 'string
 181                                             (symbol-name :dsd-)
 182                                             (symbol-name x)))))
 183                 *slot-options*))))
 184   (eval
 185    `(defclass hyperobject-esd (standard-effective-slot-definition)
 186      (,@(mapcar #'(lambda (x)
 187                     `(,(intern (symbol-name x))
 188                       :initarg
 189                       ,(intern (symbol-name x) (symbol-name :keyword))
 190                       :initform nil
 191                       :accessor
 192                       ,(intern (concatenate 'string
 193                                             (symbol-name :esd-)
 194                                             (symbol-name x)))))
 195                 (append *slot-options* *slot-options-no-initarg*)))))
 196   ) ;; eval-when
 197
 198 (defun intern-in-keyword (obj)
 199   (cond
 200     ((null obj)
 201      nil)
 202     ((eq t obj)
 203      t)
 204     ((atom obj)
 205      (intern (symbol-name obj) (find-package 'keyword)))
 206     ((consp obj)
 207      (cons (intern-in-keyword (car obj) ) (intern-in-keyword (cdr obj))))
 208     (t
 209      obj)))
 210
 211 (defun canonicalize-value-type (vt)
 212   (typecase vt
 213     (atom
 214      (ensure-keyword vt))
 215     (cons
 216      (cons (ensure-keyword (car vt)) (cdr vt)))
 217     (t
 218      t)))
 219
 220 #+ignore
 221 (defmethod compute-effective-slot-definition :around ((cl hyperobject-class) #+ho-normal-cesd name dsds)
 222   #+allegro (declare (ignore name))
 223   (let* ((dsd (car dsds))
 224          (value-type (canonicalize-value-type (slot-value dsd 'value-type))))
 225     (multiple-value-bind (sql-type length) (value-type-to-sql-type value-type)
 226       (setf (slot-value dsd 'sql-type) sql-type)
 227       (setf (slot-value dsd 'type) (value-type-to-lisp-type value-type))
 228       (let ((ia (compute-effective-slot-definition-initargs cl #+lispworks name dsds)))
 229         (apply
 230          #'make-instance 'hyperobject-esd
 231          :value-type value-type
 232          :sql-type sql-type
 233          :length length
 234          :print-formatter (slot-value dsd 'print-formatter)
 235          :subobject (slot-value dsd 'subobject)
 236          :hyperlink (slot-value dsd 'hyperlink)
 237          :hyperlink-parameters (slot-value dsd 'hyperlink-parameters)
 238          :description (slot-value dsd 'description)
 239          :user-name (slot-value dsd 'user-name)
 240          :index (slot-value dsd 'index)
 241          :value-constraint (slot-value dsd 'value-constraint)
 242          :null-allowed (slot-value dsd 'null-allowed)
 243          ia)))))
 244
 245 (defmethod compute-effective-slot-definition :around ((cl hyperobject-class) #+ho-normal-cesd name dsds)
 246   #+ho-normal-cesd (declare (ignore name))
 247   (let* ((esd (call-next-method))
 248          (dsd (car dsds))
 249          (value-type (canonicalize-value-type (slot-value dsd 'value-type))))
 250     (multiple-value-bind (sql-type length) (value-type-to-sql-type value-type)
 251       (setf (slot-value esd 'sql-type) sql-type)
 252       (setf (slot-value esd 'length) length)
 253       (setf (slot-value esd 'type) (value-type-to-lisp-type value-type))
 254       (setf (slot-value esd 'value-type) value-type)
 255       (dolist (name '(print-formatter subobject hyperlink hyperlink-parameters description user-name
 256                       value-constraint index null-allowed))
 257         (setf (slot-value esd name) (slot-value dsd name)))
 258       esd)))
 259
 260
 261 #+ho-normal-cesd
 262 (setq cl:*features* (delete :ho-normal-cesd cl:*features*))
 263 #+ho-normal-dsdc
 264 (setq cl:*features* (delete :ho-normal-dsdc cl:*features*))
 265 #+ho-normal-esdc
 266 (setq cl:*features* (delete :ho-normal-esdc cl:*features*))
 267
 268 (defun value-type-to-lisp-type (value-type)
 269   (case (if (atom value-type)
 270             value-type
 271             (car value-type))
 272     ((:string :cdata :varchar :char)
 273      '(or null string))
 274     (:character
 275      '(or null character))
 276     (:fixnum
 277      '(or null fixnum))
 278     (:boolean
 279      '(or null boolean))
 280     (:integer
 281      '(or null integer))
 282     ((:float :single-float)
 283      '(or null single-float))
 284     (:double-float
 285      '(or null double-float))
 286     (otherwise
 287      t)))
 288
 289 (defun value-type-to-sql-type (value-type)
 290   "Return two values, the sql type and field length."
 291   (let ((type (if (atom value-type)
 292                   value-type
 293                   (car value-type)))
 294         (length (when (consp value-type)
 295                   (cadr value-type))))
 296     (values
 297      (case type
 298        ((:string :cdata)
 299         :string)
 300        ((:fixnum :integer)
 301         :integer)
 302        (:boolean
 303         :boolean)
 304        ((:float :single-float)
 305         :single-float)
 306        (:double-float
 307         :double-float)
 308        (otherwise
 309         :text))
 310      length)))
 311
 312 ;;;; Class initialization function
 313
 314 ;; defines a slot-unbound method for class and slot-name, fills
 315 ;; the slot by calling reader function with the slot values of
 316 ;; the instance's reader-keys
 317 (defmacro def-lazy-reader (class slot-name reader &rest reader-keys)
 318   (let* ((the-slot-name (gensym))
 319          (the-class (gensym))
 320          (the-instance (gensym))
 321          (keys '()))
 322     (dolist (key reader-keys)
 323       (push (list 'slot-value the-instance (list 'quote key)) keys))
 324     (setq keys (nreverse keys))
 325     `(defmethod slot-unbound (,the-class (,the-instance ,class)
 326                               (,the-slot-name (eql ',slot-name)))
 327       (declare (ignore ,the-class))
 328       (setf (slot-value ,the-instance ,the-slot-name) (,reader ,@keys)))))
 329
 330
 331 #+lispworks
 332 (defun intern-eql-specializer (slot)
 333   `(eql ,slot))
 334
 335 #+(or sbcl cmu lispworks)
 336 (defun ensure-lazy-reader (class-name slot-name reader &rest reader-keys)
 337   (let ((keys nil)
 338         (gf (ensure-generic-function 'slot-unbound)))
 339     (dolist (key reader-keys)
 340       (push (list 'slot-value 'the-instance (list 'quote key)) keys))
 341     (setq keys (nreverse keys))
 342     (multiple-value-bind (method-lambda init-args-values)
 343         (make-method-lambda
 344          gf
 345          (class-prototype (generic-function-method-class gf))
 346          #-lispworks
 347          `(lambda (the-class the-instance the-slot-name)
 348            (declare (ignore the-class))
 349            (setf (slot-value the-instance the-slot-name) (,reader ,@keys)))
 350          #+lispworks
 351          '(the-class the-instance the-slot-name)
 352          #+lispworks
 353          nil
 354          #+lispworks
 355          `(setf (slot-value the-instance the-slot-name) (,reader ,@keys))
 356          nil)
 357       (add-method gf
 358                   (apply
 359                    #'make-instance (generic-function-method-class gf)
 360                    ':specializers (list (class-of (find-class class-name))
 361                                         (find-class class-name)
 362                                         (intern-eql-specializer slot-name))
 363                    ':lambda-list '(the-class the-instance the-slot-name)
 364                    ':function (compile nil method-lambda)
 365                    init-args-values)))))
 366
 367 (defun finalize-subobjects (cl)
 368   "Process class subobjects slot"
 369   (setf (subobjects cl)
 370         (let ((subobjects '()))
 371           (dolist (slot (class-slots cl))
 372             (let-when
 373              (subobj-def (esd-subobject slot))
 374              (let ((subobject
 375                     (make-instance 'subobject
 376                                    :name-class (class-name cl)
 377                                    :name-slot (slot-definition-name slot)
 378                                    :lookup (if (atom subobj-def)
 379                                                subobj-def
 380                                                (car subobj-def))
 381                                    :lookup-keys (if (atom subobj-def)
 382                                                     nil
 383                                                     (cdr subobj-def)))))
 384                (unless (eq (lookup subobject) t)
 385                  #-(or sbcl cmu lispworks)
 386                  (eval
 387                   `(hyperobject::def-lazy-reader ,(name-class subobject)
 388                     ,(name-slot subobject) ,(lookup subobject)
 389                     ,@(lookup-keys subobject)))
 390                  #+(or sbcl cmu lispworks)
 391                  (apply #'ensure-lazy-reader
 392                         (name-class subobject) (name-slot subobject)
 393                         (lookup subobject) (lookup-keys subobject)))
 394                (push subobject subobjects))))
 395           ;; sbcl/cmu reverse class-slots compared to the defclass form
 396           ;; so re-reverse on cmu/sbcl
 397           #+(or cmu sbcl) subobjects
 398           #-(or cmu sbcl) (nreverse subobjects)
 399           )))
 400
 401 (defun finalize-documentation (cl)
 402   "Calculate class documentation slot"
 403   (awhen (slot-value cl 'user-name)
 404          (setf (slot-value cl 'user-name)
 405                (etypecase (slot-value cl 'user-name)
 406                  (cons (car it))
 407                  ((or string symbol) it))))
 408   (awhen (slot-value cl 'description)
 409          (setf (slot-value cl 'description)
 410                (etypecase (slot-value cl 'description)
 411                  (cons (car it))
 412                  ((or string symbol) it))))
 413
 414   (let ((*print-circle* nil))
 415     (setf (documentation (class-name cl) 'class)
 416           (format nil "Hyperobject~A~A~A~A"
 417                   (aif (user-name cl)
 418                        (format nil ": ~A" it ""))
 419                   (aif (description cl)
 420                        (format nil "~%Class description: ~A" it) "")
 421                   (aif (subobjects cl)
 422                        (format nil "~%Subobjects:~{ ~A~}" (mapcar #'name-slot it)) "")
 423                   (aif (default-print-slots cl)
 424                        (format nil "~%Default print slots:~{ ~A~}" it) "")
 425                   ))))
 426
 427 (defun finalize-hyperlinks (cl)
 428   (let ((hyperlinks '()))
 429     (dolist (esd (class-slots cl))
 430       (awhen (slot-value esd 'hyperlink)
 431              (push
 432               (make-instance 'hyperlink
 433                              :name (slot-definition-name esd)
 434                              :lookup it
 435                              :link-parameters (slot-value esd 'hyperlink-parameters))
 436               hyperlinks)))
 437     ;; cmu/sbcl reverse class-slots compared to the defclass form
 438     ;; hyperlinks is already reversed from the dolist/push loop, so re-reverse on sbcl/cmu
 439     #-(or cmu sbcl) (setq hyperlinks (nreverse hyperlinks))
 440     (setf (slot-value cl 'hyperlinks) hyperlinks)))
 441
 442 (defun init-hyperobject-class (cl)
 443   "Initialize a hyperobject class. Calculates all class slots"
 444   (finalize-subobjects cl)
 445   (finalize-views cl)
 446   (finalize-hyperlinks cl)
 447   (finalize-sql cl)
 448   (finalize-rules cl)
 449   (finalize-documentation cl))
 450
 451
 452 ;;;; *************************************************************************
 453 ;;;;  Metaclass Slot Accessors
 454 ;;;; *************************************************************************
 455
 456 (defun find-slot-by-name (cl name)
 457   (find name (class-slots cl) :key #'slot-definition-name))
 458
 459 (defun hyperobject-class-user-name (obj)
 460   (awhen (user-name (class-of obj))
 461          (if (consp it)
 462              (car it)
 463              it)))
 464
 465 (defun hyperobject-class-subobjects (obj)
 466   (subobjects (class-of obj)))
 467
 468 (defun hyperobject-class-hyperlinks (obj)
 469   (hyperlinks (class-of obj)))
 470
 471 (defun hyperobject-class-slots (obj)
 472   ;; cmucl/sbcl reverse class-slots
 473   #+(or cmu sbcl) (reverse (class-slots (class-of obj)))
 474   #-(or cmu sbcl) (class-slots (class-of obj)))
 475