1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
6 ;;;; Purpose: Metaobject Protocol Interface
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Apr 2000
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.
14 ;;;; $Id: mop.lisp,v 1.17 2002/12/26 23:18:16 kevin Exp $
16 ;;;; This file is Copyright (c) 2000-2002 by Kevin M. Rosenberg
18 ;;;; *************************************************************************
20 (in-package :hyperobject)
22 (eval-when (:compile-toplevel :execute)
23 (declaim (optimize (speed 2) (safety 2) (compilation-speed 0) (debug 2))))
27 (defclass hyperobject-class (standard-class)
28 ( ;; slots initialized in defclass
29 (user-name :initarg :user-name :type string :initform nil
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
37 :documentation "Class description")
38 (version :initarg :version :initform nil
40 :documentation "Version number for class")
41 (sql-name :initarg :sql-name :initform nil)
43 ;;; The remainder of these fields are calculated one time
44 ;;; in finalize-inheritence.
46 (subobjects :initform nil :accessor subobjects
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
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")
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)
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")
70 (:documentation "Metaclass for Markup Language classes."))
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 symbol :initform nil :initarg :lookup :reader lookup)
76 (lookup-keys :type list :initform nil :initarg :lookup-keys
78 (:documentation "Contains subobject information"))
81 (defmethod print-object ((obj subobject) (s stream))
82 (print-unreadable-object (obj s :type t :identity t)
83 (format s "~S" (name obj))))
85 (defclass hyperlink ()
86 ((name :type symbol :initform nil :initarg :name :reader name)
87 (lookup :type function :initform nil :initarg :lookup :reader lookup)
88 (link-parameters :type list :initform nil :initarg :link-parameters
89 :reader link-parameters)))
91 (defmethod print-object ((obj hyperlink) (s stream))
92 (print-unreadable-object (obj s :type t :identity t)
93 (format s "~S" (name obj))))
96 (defmethod validate-superclass ((class hyperobject-class) (superclass standard-class))
99 (defmethod finalize-inheritance :after ((cl hyperobject-class))
100 (init-hyperobject-class cl)
104 (defmethod direct-slot-definition-class ((cl hyperobject-class)
107 (find-class 'hyperobject-dsd))
112 (eval-when (:compile-toplevel :load-toplevel :execute)
113 (defmacro process-class-option (slot-name &optional required)
115 `(defmethod clos:process-a-class-option ((class hyperobject-class)
116 (name (eql ,slot-name))
118 (when (and ,required (null value))
119 (error "hyperobject class slot ~A must have a value" name))
120 (list name `',value))
121 #+(or allegro sbcl cmu scl)
122 (declare (ignore slot-name required))
125 (defmacro process-slot-option (slot-name)
127 `(defmethod clos:process-a-slot-option ((class hyperobject-class)
128 (option (eql ,slot-name))
130 already-processed-other-options
132 (list option `',value))
134 (declare (ignore slot-name))
137 (dolist (option *class-options*)
138 (eval `(process-class-option ,option)))
139 (dolist (option *slot-options*)
140 (eval `(process-slot-option ,option)))
143 `(defclass hyperobject-dsd (standard-direct-slot-definition)
144 (,@(mapcar #'(lambda (x)
145 `(,(intern (symbol-name x))
147 *slot-options-no-initarg*)
148 ,@(mapcar #'(lambda (x)
149 `(,(intern (symbol-name x))
151 ,(intern (symbol-name x) (symbol-name :keyword))
154 ,(intern (concatenate 'string
159 `(defclass hyperobject-esd (standard-effective-slot-definition)
160 (,@(mapcar #'(lambda (x)
161 `(,(intern (symbol-name x))
163 ,(intern (symbol-name x) (symbol-name :keyword))
166 ,(intern (concatenate 'string
169 (append *slot-options* *slot-options-no-initarg*)))))
172 (defun intern-in-keyword (obj)
179 (intern (symbol-name obj) (find-package 'keyword)))
181 (cons (intern-in-keyword (car obj) ) (intern-in-keyword (cdr obj))))
185 (defun canonicalize-value-type (vt)
190 (cons (ensure-keyword (car vt)) (cdr vt)))
194 (defmethod compute-effective-slot-definition :around ((cl hyperobject-class)
195 #+(or allegro lispworks) name
197 #+allergo (declare (ignore name))
198 (let* ((dsd (car dsds))
199 (value-type (canonicalize-value-type (slot-value dsd 'value-type))))
200 (multiple-value-bind (sql-type length) (value-type-to-sql-type value-type)
201 (setf (slot-value dsd 'sql-type) sql-type)
202 (setf (slot-value dsd 'type) (value-type-to-lisp-type value-type))
203 (let ((ia (compute-effective-slot-definition-initargs
204 cl #+lispworks name dsds)))
206 #'make-instance 'hyperobject-esd
207 :value-type value-type
210 :print-formatter (slot-value dsd 'print-formatter)
211 :subobject (slot-value dsd 'subobject)
212 :hyperlink (slot-value dsd 'hyperlink)
213 :hyperlink-parameters (slot-value dsd 'hyperlink-parameters)
214 :description (slot-value dsd 'description)
215 :user-name (slot-value dsd 'user-name)
216 :index (slot-value dsd 'index)
217 :value-constraint (slot-value dsd 'value-constraint)
218 :null-allowed (slot-value dsd 'null-allowed)
221 (defun value-type-to-lisp-type (value-type)
222 (case (if (atom value-type)
225 ((:string :cdata :varchar :char)
235 ((:float :single-float)
242 (defun value-type-to-sql-type (value-type)
243 "Return two values, the sql type and field length."
244 (let ((type (if (atom value-type)
247 (length (when (consp value-type)
257 ((:float :single-float)
265 ;;;; Class initialization function
267 ;; defines a slot-unbound method for class and slot-name, fills
268 ;; the slot by calling reader function with the slot values of
269 ;; the instance's reader-keys
270 (defmacro def-lazy-reader (class slot-name reader &rest reader-keys)
271 (let* ((the-slot-name (gensym))
273 (the-instance (gensym))
275 (dolist (key reader-keys)
276 (push (list 'slot-value the-instance (list 'quote key)) keys))
277 (setq keys (nreverse keys))
278 `(defmethod slot-unbound (,the-class (,the-instance ,class)
279 (,the-slot-name (eql ',slot-name)))
280 (declare (ignore ,the-class))
281 (setf (slot-value ,the-instance ,the-slot-name)
284 (defun finalize-subobjects (cl)
285 "Process class subobjects slot"
286 (setf (subobjects cl)
287 (let ((subobjects '()))
288 (dolist (slot (class-slots cl))
289 (let-when (subobj-def (esd-subobject slot))
290 (let ((subobject (make-instance 'subobject
291 :name-class (class-name cl)
292 :name-slot (slot-definition-name slot)
293 :lookup (if (atom subobj-def)
296 :lookup-keys (if (atom subobj-def)
299 (unless (eq (lookup subobject) t)
300 (eval `(def-lazy-reader ,(name-class subobject)
301 ,(name-slot subobject) ,(lookup subobject)
302 ,@(lookup-keys subobject))))
303 (push subobject subobjects))))
306 (defun finalize-documentation (cl)
307 "Calculate class documentation slot"
308 (awhen (slot-value cl 'user-name)
309 (setf (slot-value cl 'user-name)
310 (etypecase (slot-value cl 'user-name)
312 ((or string symbol) it))))
313 (awhen (slot-value cl 'description)
314 (setf (slot-value cl 'description)
315 (etypecase (slot-value cl 'description)
317 ((or string symbol) it))))
319 (let ((*print-circle* nil))
320 (setf (documentation (class-name cl) 'class)
321 (format nil "Hyperobject~A~A~A~A"
323 (format nil ": ~A" it ""))
324 (aif (description cl)
325 (format nil "~%Class description: ~A" it) "")
327 (format nil "~%Subobjects:~{ ~A~}" (mapcar #'name-slot it)) "")
328 (aif (default-print-slots cl)
329 (format nil "~%Default print slots:~{ ~A~}" it) "")
332 (defun finalize-hyperlinks (cl)
333 (let ((hyperlinks '()))
334 (dolist (esd (class-slots cl))
335 (awhen (slot-value esd 'hyperlink)
337 (make-instance 'hyperlink
338 :name (slot-definition-name esd)
340 :link-parameters (slot-value esd 'hyperlink-parameters))
342 (setf (slot-value cl 'hyperlinks) hyperlinks)))
344 (defun init-hyperobject-class (cl)
345 "Initialize a hyperobject class. Calculates all class slots"
346 (finalize-subobjects cl)
348 (finalize-hyperlinks cl)
351 (finalize-documentation cl))
354 ;;;; *************************************************************************
355 ;;;; Metaclass Slot Accessors
356 ;;;; *************************************************************************
358 (defun find-slot-by-name (cl name)
359 (find name (class-slots cl) :key #'slot-definition-name))
361 (defun hyperobject-class-user-name (obj)
362 (awhen (user-name (class-of obj))
367 (defun hyperobject-class-subobjects (obj)
368 (subobjects (class-of obj)))
370 (defun hyperobject-class-hyperlinks (obj)
371 (hyperlinks (class-of obj)))
373 (defun hyperobject-class-fields (obj)
374 (class-slots (class-of obj)))