src/mewa/mewa.lisp

   1 (in-package :mewa)
   2
   3 (defparameter *default-type* :ucw)
   4
   5 ;;; maps meta-model slot-types to slot-presentation
   6 (defparameter *slot-type-map*
   7   '(boolean   ucw::mewa-boolean
   8     string    ucw::mewa-string
   9     number    ucw::mewa-currency
  10     integer   ucw::mewa-integer
  11     currency  ucw::mewa-currency
  12     ))
  13
  14 ;;; an alist of model-class-name . attributes
  15 ;;; should really be a hash-table.
  16 (defvar *attribute-map* (list))
  17
  18 ;;; some utilities for merging plists
  19
  20 (defun plist-nunion (new-props plist)
  21   (loop for cons on new-props by #'cddr
  22         do (setf (getf plist (first cons)) (second cons))
  23         finally (return plist)))
  24
  25 (defun plist-union (new-props plist)
  26   "Non-destructive version of plist-nunion"
  27                    (plist-nunion new-props (copy-list plist)))
  28
  29 (defun gen-ptype (type)
  30   (or (getf *slot-type-map* type) type))
  31
  32 (defun gen-presentation-slots (instance)
  33   (mapcar #'(lambda (x) (gen-pslot (cadr x)
  34                                    (string (car x))
  35                                    (car x)))
  36           (meta-model:list-slot-types instance)))
  37
  38
  39 (defun gen-pslot (type label slot-name)
  40   (copy-list `(,(gen-ptype type)
  41                :label ,label
  42                :slot-name ,slot-name)))
  43
  44 (defun gen-presentation-args (instance args)
  45   (declare (ignore instance))
  46   (if args args nil))
  47
  48
  49 (defun find-or-create-attributes (class-name)
  50   "return an exisiting class attribute map or create one.
  51
  52 A map is a cons of class-name . attributes.
  53 attributes is an alist keyed on the attribute name."
  54   (or (assoc class-name *attribute-map*)
  55       (progn
  56         (setf *attribute-map* (acons class-name (list (list)) *attribute-map*))
  57         (assoc class-name *attribute-map*))))
  58
  59 (defgeneric find-class-attributes (class))
  60
  61 (defmethod find-class-attributes ((model t))
  62   (find-or-create-attributes (class-name (class-of model))))
  63
  64 (defmethod find-class-attributes ((model symbol))
  65   (find-or-create-attributes model))
  66
  67 (defmethod clear-class-attributes ((model t))
  68   (setf (cdr (find-class-attributes model)) nil))
  69
  70 (defmethod add-attribute ((model t) name def)
  71   (let ((map (find-class-attributes model)))
  72     (setf (cdr map) (acons name def (cdr map)))))
  73
  74 (defmethod find-attribute ((model t) name)
  75   (assoc name (cdr (find-class-attributes model))))
  76
  77 (defmethod (setf find-attribute) ((def list) (model t) name)
  78   (let ((attr (find-attribute model name)))
  79     (if attr
  80         (prog2
  81             (setf (cdr attr) def)
  82             attr)
  83         (prog2
  84             (add-attribute model name def)
  85             (find-attribute model name)))))
  86
  87 (defmethod set-attribute ((model t) name definition &key (inherit t))
  88   (setf (find-attribute model name)
  89         (if inherit
  90             (cons (car definition)
  91                   (plist-union (cdr definition)
  92                          (cddr (find-attribute model name))))
  93             definition)))
  94
  95 (defmethod perform-set-attributes ((model t) definitions)
  96   (dolist (def definitions)
  97     (funcall #'set-attribute model (first def) (rest def))))
  98
  99 (defmethod set-attribute-properties ((model t) attribute properties)
 100   (let ((a (find-attribute model attribute)))
 101     (if a
 102         (setf (cddr a) (plist-nunion properties (cddr a)))
 103         (error "Attribute ~A does not exist" attribute) )))
 104
 105 (defmethod perform-set-attribute-properties ((model t) definitions)
 106   (dolist (def definitions)
 107     (funcall #'set-attribute-properties model (car def) (cdr def))))
 108
 109
 110 (defmethod default-attributes ((model t))
 111   "return the default attributes for a given model using the meta-model's meta-data"
 112   (append (mapcar #'(lambda (s)
 113                       (cons (car s)
 114                             (gen-pslot
 115                              (if (meta-model:foreign-key-p model (car s))
 116                                  'ucw::foreign-key
 117                                  (cadr s))
 118                              (string (car s)) (car s))))
 119                   (meta-model:list-slot-types model))
 120           (mapcar #'(lambda (s)
 121                       (cons s (append (gen-pslot 'ucw::has-many (string s) s)
 122                                       `(:presentation
 123                                         (make-presentation
 124                                          ,model
 125                                          :type :one-line)))))
 126                   (meta-model:list-has-many model))))
 127
 128 (defmethod set-default-attributes ((model t))
 129   "Set the default attributes for MODEL"
 130   (clear-class-attributes model)
 131   (mapcar #'(lambda (x)
 132               (setf (find-attribute model (car x)) (cdr x)))
 133           (default-attributes model)))
 134
 135
 136 (defgeneric attributes-getter (model))
 137
 138 ;;;presentations
 139
 140
 141
 142 (defcomponent mewa ()
 143   ((ucw::instance :accessor instance :initarg :instance)
 144    (attributes
 145     :initarg :attributes
 146     :accessor attributes
 147     :initform nil)
 148    (attributes-getter
 149     :accessor attributes-getter
 150     :initform #'get-attributes
 151     :initarg :attributes-getter)
 152    (attribute-slot-map
 153     :accessor attribute-slot-map
 154     :initform nil)
 155    (global-properties
 156     :initarg :global-properties
 157     :accessor global-properties
 158     :initform nil)
 159    (classes
 160     :initarg :classes
 161     :accessor classes
 162     :initform nil)
 163    (use-instance-class-p
 164     :initarg :use-instance-class-p
 165     :accessor use-instance-class-p
 166     :initform t)
 167    (initializedp :initform nil)
 168    (modifiedp :accessor modifiedp :initform nil :initarg :modifiedp)
 169    (modifications :accessor modifications :initform nil)))
 170
 171
 172 (defmethod attributes :around ((self mewa))
 173   (let ((a (call-next-method)))
 174     (or a (funcall (attributes-getter self) self))))
 175
 176 (defgeneric get-attributes (mewa))
 177
 178 (defmethod get-attributes ((self mewa))
 179   (if (instance self)
 180   (append (meta-model:list-slots (instance self))
 181           (meta-model:list-has-many (instance self)))
 182   nil))
 183
 184 (defmethod find-instance-classes ((self mewa))
 185   (mapcar #'class-name
 186           (it.bese.arnesi.mopp:compute-class-precedence-list (class-of (instance self)))))
 187
 188 (defmethod find-all-attributes ((self mewa))
 189   (reduce #'append
 190           (mapcar #'(lambda (x)
 191                       (cdr (find-class-attributes x)))
 192                   (classes self))))
 193
 194 (defun make-attribute (&rest props &key type &allow-other-keys)
 195         (remf props :type)
 196         (cons (gensym) (cons type props)))
 197
 198
 199 (defmethod find-applicable-attributes ((self mewa))
 200   (let ((all-attributes (find-all-attributes self)))
 201     (flet ((gen-att (x) (let ((att (assoc x all-attributes)))
 202                                      (when att
 203                                        (setf (cddr att) (plist-union (global-properties self) (cddr att)))
 204                                        att))))
 205     (if (attributes self)
 206         (remove 'nil
 207                 (mapcar #'(lambda (x)
 208                             (cond
 209                              ;;simple casee
 210                              ((symbolp x)
 211                               (gen-att x))
 212                              ;;if the car is a keyword then this is an inline def
 213                              ((and (listp x) (keywordp (car x)))
 214                               (let ((att (apply #'make-attribute x)))
 215                                 (setf (cddr att)
 216                                       (plist-union (cddr att) (global-properties self)))
 217                                 att))
 218                              ;; if the plist has a :type
 219                              ((and (listp x) (getf (cdr x) :type))
 220                               (let ((new (cdr (apply #'make-attribute (cdr x))))
 221                                     (def (gen-att (car x))))
 222                                 (setf (cdr new) (plist-union (cdr new) (cddr def)))
 223                                 (cons (car def) new)))
 224                              ;;finally if we are just overiding the props
 225                              ((and (listp x) (symbolp (car x)))
 226                               (let ((new (cdr (apply #'make-attribute (cdr x))))
 227                                     (def (gen-att (car x))))
 228                                 (setf (cdr new) (plist-union (cdr new) (cddr def)))
 229                                 (cons (car def) (cons (second def) (cdr new)))))
 230
 231                               )
 232                              )
 233
 234                         (attributes self)))
 235       all-attributes))))
 236
 237 (defmethod find-slot-presentation-for-attribute ((self mewa) attribute)
 238   (let ((class-name
 239          (or (gethash (second attribute) ucw::*slot-type-mapping*)
 240              (error  "Can't find slot type for ~A" (second attribute)))))
 241
 242           (cons (first attribute) (apply #'make-instance
 243            class-name
 244            (append (cddr attribute) (list :parent self :size 30))))))
 245
 246 (defmethod find-slot-presentations ((self mewa))
 247   (mapcar #'(lambda (a) (find-slot-presentation-for-attribute self a))
 248           (find-applicable-attributes self)))
 249
 250 (defmethod find-attribute-slot ((self mewa) (attribute symbol))
 251   (cdr (assoc attribute (attribute-slot-map self))))
 252
 253 (defmethod initialize-slots ((self mewa))
 254   (when (instance self)
 255     (when (use-instance-class-p self)
 256       (setf (classes self)
 257             (append (find-instance-classes self)
 258                     (classes self))))
 259     (setf (attribute-slot-map self) (find-slot-presentations self))
 260     (setf (slots self) (mapcar #'(lambda (x)(cdr x)) (attribute-slot-map self )))))
 261
 262 (defmethod make-presentation ((object t) &key (type :viewer) (initargs nil))
 263   (let* ((p (make-instance 'mewa-object-presentation))
 264          (a (progn (setf (slot-value p 'ucw::instance) object)
 265                    (initialize-slots p)
 266                    (assoc type (find-all-attributes p))))
 267          ;;;; TODO: this can be cleaned up, probably CHANGE-CLASS is better here
 268          (i (apply #'change-class p (or (second a)
 269                                       ;; if we didnt find the type,
 270                                       ;; use the symbol as a class.
 271                                       (if (eql (symbol-package type)
 272                                                (find-package 'keyword))
 273                                           (symbol-name type)
 274                                           type))
 275                    (plist-union initargs (cddr a)))))
 276     (setf (slot-value i 'instance) object)
 277     (initialize-slots i)
 278     (setf (slot-value i 'initializedp) t)
 279     i))
 280
 281
 282 (defmethod initialize-slots-place ((place ucw::place) (mewa mewa))
 283   (setf (slots mewa) (mapcar #'(lambda (x)
 284                                (prog1 x
 285                                  (setf (component.place x) place)))
 286                             (slots mewa))))
 287
 288 (arnesi:defmethod/cc call-component :before ((from standard-component) (to mewa))
 289   (unless (slot-value to 'initializedp)
 290     (initialize-slots to))
 291   (setf (slot-value to 'initializedp) t)
 292   (initialize-slots-place (component.place from) to)
 293   to)
 294
 295
 296
 297 (defmacro call-presentation (object &rest args)
 298   `(present-object ,object :presentation (make-presentation ,object ,@args)))
 299
 300
 301 (defcomponent about-dialog (option-dialog)
 302   ((body :initarg :body)))
 303
 304 (defmethod render-on ((res response) (self about-dialog))
 305   (call-next-method)
 306   (render-on res (slot-value self 'body)))
 307
 308
 309 (defmethod instance-is-stored-p ((instance clsql:standard-db-object))
 310   (slot-value instance 'clsql-sys::view-database))
 311
 312 (defmethod instance-is-stored-p ((mewa mewa))
 313   (instance-is-stored-p (instance mewa)))
 314
 315 (defaction cancel-save-instance ((self mewa))
 316   (cond
 317     ((instance-is-stored-p (instance self))
 318       (meta-model::update-instance-from-records (instance self))
 319       (answer self))
 320     (t (answer nil))))
 321
 322 (defaction save-instance ((self mewa))
 323   (meta-model:sync-instance (instance self))
 324   (setf (modifiedp self) nil)
 325   (answer self))
 326
 327
 328 (defaction ensure-instance-sync ((self mewa))
 329   (when (modifiedp self)
 330     (let ((message (format nil "Record has been modified, Do you wish to save the changes?")))
 331       (case (call 'about-dialog
 332                   :body (make-presentation (instance self)
 333                                            :type :viewer)
 334                   :message message
 335                   :options '((:save . "Save changes to Database")
 336                              (:cancel . "Cancel all changes")))
 337         (:cancel
 338          (cancel-save-instance self))
 339         (:save
 340          (save-instance self))))))
 341
 342 (defaction ok ((self mewa) &optional arg)
 343   "Returns the component if it has not been modified. if it has been, prompt user to save or cancel"
 344   ;(declare (ignore arg))
 345   (meta-model::sync-instance (instance self))
 346   (answer (instance self)))
 347
 348 (defmethod (setf presentation-slot-value) :around (value (slot slot-presentation) instance)
 349   (let* ((old (prog1
 350                  (presentation-slot-value slot instance)
 351                (call-next-method)))
 352         (new (presentation-slot-value slot instance)))
 353
 354   (unless (equal new old )
 355     (let ((self (ucw::parent slot)))
 356       (setf (modifiedp self) instance
 357             (modifications self)  (append (list new old value slot instance) (modifications self)))))))
 358
 359 ;;;; * Finally set up some defaults
 360
 361 (setf (find-attribute t :viewer)
 362       '(mewa-object-presentation :global-properties (:editablep nil))
 363       (find-attribute t :editor)
 364       '(mewa-object-presentation :global-properties (:editablep t))
 365       (find-attribute t :creator)
 366       '(mewa-object-presentation :global-properties (:editablep t))
 367       (find-attribute t :one-line)
 368       '(mewa-one-line-presentation)
 369       (find-attribute t :listing)
 370       '(mewa-list-presentation :global-properties (:editablep nil) :editablep t)
 371       (find-attribute t :search-model)
 372       '(mewa-object-presentation))
 373
 374
 375
 376
 377
 378 ;; This software is Copyright (c) Drew Crampsie, 2004-2005.
 379 ;; You are granted the rights to distribute
 380 ;; and use this software as governed by the terms
 381 ;; of the Lisp Lesser GNU Public License
 382 ;; (http://opensource.franz.com/preamble.html),
 383 ;; known as the LLGPL.