1 ;; Common Lisp bindings for GTK+ v2.0
2 ;; Copyright (C) 2000 Espen S. Johnsen <esj@stud.cs.uit.no>
4 ;; This library is free software; you can redistribute it and/or
5 ;; modify it under the terms of the GNU Lesser General Public
6 ;; License as published by the Free Software Foundation; either
7 ;; version 2 of the License, or (at your option) any later version.
9 ;; This library is distributed in the hope that it will be useful,
10 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
11 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 ;; Lesser General Public License for more details.
14 ;; You should have received a copy of the GNU Lesser General Public
15 ;; License along with this library; if not, write to the Free Software
16 ;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ;; $Id: proxy.lisp,v 1.19 2005-02-03 23:09:04 espen Exp $
22 ;;;; Superclass for all metaclasses implementing some sort of virtual slots
24 (eval-when (:compile-toplevel :load-toplevel :execute)
25 (defclass virtual-slots-class (standard-class)
28 (defclass direct-virtual-slot-definition (standard-direct-slot-definition)
29 ((setter :reader slot-definition-setter :initarg :setter)
30 (getter :reader slot-definition-getter :initarg :getter)
31 (unbound :reader slot-definition-unbound :initarg :unbound)
32 (boundp :reader slot-definition-boundp :initarg :boundp)))
34 (defclass effective-virtual-slot-definition (standard-effective-slot-definition)
35 ((setter :reader slot-definition-setter :initarg :setter)
36 (getter :reader slot-definition-getter :initarg :getter)
37 (unbound :reader slot-definition-unbound :initarg :unbound)
38 (boundp :reader slot-definition-boundp :initarg :boundp))))
40 (defvar *unbound-marker* (gensym "UNBOUND-MARKER-"))
42 (defun most-specific-slot-value (instances slot &optional
43 (default *unbound-marker*))
44 (let ((object (find-if
46 (and (slot-exists-p ob slot) (slot-boundp ob slot)))
49 (slot-value object slot)
54 (defmethod direct-slot-definition-class ((class virtual-slots-class) &rest initargs)
55 (if (eq (getf initargs :allocation) :virtual)
56 (find-class 'direct-virtual-slot-definition)
59 (defmethod effective-slot-definition-class ((class virtual-slots-class) &rest initargs)
60 (if (eq (getf initargs :allocation) :virtual)
61 (find-class 'effective-virtual-slot-definition)
65 (defmethod initialize-internal-slot-functions ((slotd effective-virtual-slot-definition))
66 (if (not (slot-boundp slotd 'getter))
68 (slot-value slotd 'reader-function)
70 (declare (ignore object))
71 (error "Can't read slot: ~A" (slot-definition-name slotd)))
72 (slot-value slotd 'boundp-function)
73 #'(lambda (object) (declare (ignore object)) nil))
75 (let ((getter-function
76 (let ((getter (slot-value slotd 'getter)))
81 (funcall getter object)))
84 (setf (slot-value slotd 'reader-function)
89 (slot-definition-type slotd) 'pointer)))
90 (funcall reader (proxy-location object))))))))))
93 (slot-value slotd 'boundp-function)
95 ((slot-boundp slotd 'unbound)
96 (let ((unbound-value (slot-value slotd 'unbound)))
98 (not (eq (funcall getter-function object) unbound-value)))))
99 ((slot-boundp slotd 'boundp)
100 (let ((boundp (slot-value slotd 'boundp)))
103 (symbol #'(lambda (object)
104 (funcall boundp object)))
105 (string (let ((reader ()))
110 (slot-definition-type slotd) 'pointer)))
111 (funcall reader (proxy-location object))))))))
112 ((multiple-value-bind (unbound-p unbound-value)
113 (unbound-value (slot-definition-type slotd))
116 (not (eq (funcall getter-function object) unbound-value))))))
117 (#'(lambda (object) (declare (ignore object)) t))))
120 (slot-value slotd 'reader-function)
122 ((slot-boundp slotd 'unbound)
123 (let ((unbound (slot-value slotd 'unbound))
124 (slot-name (slot-definition-name slotd)))
126 (let ((value (funcall getter-function object)))
127 (if (eq value unbound)
128 (slot-unbound (class-of object) object slot-name)
130 ((slot-boundp slotd 'boundp)
131 (let ((boundp-function (slot-value slotd 'boundp-function)))
134 (funcall boundp-function object)
135 (funcall getter-function object)))))
136 ((multiple-value-bind (unbound-p unbound-value)
137 (unbound-value (slot-definition-type slotd))
138 (let ((slot-name (slot-definition-name slotd)))
141 (let ((value (funcall getter-function object)))
142 (if (eq value unbound-value)
143 (slot-unbound (class-of object) object slot-name)
145 (getter-function)))))
148 (slot-value slotd 'writer-function)
149 (if (not (slot-boundp slotd 'setter))
151 (declare (ignore object))
152 (error "Can't set slot: ~A" (slot-definition-name slotd)))
153 (with-slots (setter) slotd
157 #'(lambda (value object)
158 (funcall (fdefinition setter) value object)))
162 (slot-value slotd 'writer-function)
163 #'(lambda (value object)
166 (mkbinding setter 'nil 'pointer
167 (slot-definition-type slotd))))
168 (funcall writer (proxy-location object) value)))))))))
170 (initialize-internal-slot-gfs (slot-definition-name slotd)))
174 (defmethod compute-slot-accessor-info ((slotd effective-virtual-slot-definition) type gf)
177 (defmethod compute-effective-slot-definition-initargs ((class virtual-slots-class) direct-slotds)
178 (if (typep (first direct-slotds) 'direct-virtual-slot-definition)
180 (let ((getter (most-specific-slot-value direct-slotds 'getter)))
181 (unless (eq getter *unbound-marker*)
182 (setf (getf initargs :getter) getter)))
183 (let ((setter (most-specific-slot-value direct-slotds 'setter)))
184 (unless (eq setter *unbound-marker*)
185 (setf (getf initargs :setter) setter)))
186 (let ((unbound (most-specific-slot-value direct-slotds 'unbound)))
187 (unless (eq unbound *unbound-marker*)
188 (setf (getf initargs :unbound) unbound)))
189 (let ((boundp (most-specific-slot-value direct-slotds 'boundp)))
190 (unless (eq boundp *unbound-marker*)
191 (setf (getf initargs :boundp) boundp)))
192 (nconc initargs (call-next-method)))
196 (defmethod slot-value-using-class
197 ((class virtual-slots-class) (object standard-object)
198 (slotd effective-virtual-slot-definition))
199 (if (funcall (slot-value slotd 'boundp-function) object)
200 (funcall (slot-value slotd 'reader-function) object)
201 (slot-unbound class object (slot-definition-name slotd))))
203 (defmethod slot-boundp-using-class
204 ((class virtual-slots-class) (object standard-object)
205 (slotd effective-virtual-slot-definition))
206 (funcall (slot-value slotd 'boundp-function) object))
208 (defmethod (setf slot-value-using-class)
209 (value (class virtual-slots-class) (object standard-object)
210 (slotd effective-virtual-slot-definition))
211 (funcall (slot-value slotd 'writer-function) value object))
214 (defmethod validate-superclass
215 ((class virtual-slots-class) (super standard-class))
221 (internal *instance-cache*)
222 (defvar *instance-cache* (make-hash-table :test #'eql))
224 (defun cache-instance (instance)
226 (gethash (sap-int (proxy-location instance)) *instance-cache*)
227 (make-weak-pointer instance)))
229 (defun find-cached-instance (location)
230 (let ((ref (gethash (sap-int location) *instance-cache*)))
232 (weak-pointer-value ref))))
234 (defun instance-cached-p (location)
235 (gethash (sap-int location) *instance-cache*))
237 (defun remove-cached-instance (location)
238 (remhash (sap-int location) *instance-cache*))
241 (defun cached-instances ()
242 (let ((instances ()))
243 (maphash #'(lambda (location ref)
244 (declare (ignore location))
245 (push (weak-pointer-value ref) instances))
251 ;;;; Proxy for alien instances
254 ((location :reader proxy-location :type system-area-pointer)))
256 (defgeneric initialize-proxy (object &rest initargs))
257 (defgeneric instance-finalizer (object))
258 (defgeneric reference-foreign (class location))
259 (defgeneric unreference-foreign (class location))
261 (defmethod reference-foreign ((name symbol) location)
262 (reference-foreign (find-class name) location))
264 (defmethod unreference-foreign ((name symbol) location)
265 (unreference-foreign (find-class name) location))
267 (defmethod unreference-foreign :around ((class class) location)
268 (unless (null-pointer-p location)
269 ;; (format t "Unreferencing ~A at ~A" (class-name class) location)
270 ;; (finish-output *standard-output*)
272 ;; (write-line " done")
273 ;; (finish-output *standard-output*)
276 (defmethod print-object ((instance proxy) stream)
277 (print-unreadable-object (instance stream :type t :identity nil)
278 (when (slot-boundp instance 'location)
279 (format stream "at 0x~X" (sap-int (proxy-location instance))))))
281 (defmethod initialize-instance :around ((instance proxy) &key location)
283 (setf (slot-value instance 'location) location)
285 (cache-instance instance)
286 (finalize instance (instance-finalizer instance))
289 (defmethod instance-finalizer ((instance proxy))
290 (let ((location (proxy-location instance))
291 (class (class-of instance)))
292 ;; (unless (find-method #'unreference-foreign nil (list (class-of class) t) nil)
293 ;; (error "No matching method for UNREFERENCE-INSTANCE when called with class ~A" class))
295 (remove-cached-instance location)
296 (unreference-foreign class location))))
299 ;;;; Metaclass used for subclasses of proxy
301 (defgeneric most-specific-proxy-superclass (class))
302 (defgeneric direct-proxy-superclass (class))
305 (eval-when (:compile-toplevel :load-toplevel :execute)
306 (defclass proxy-class (virtual-slots-class)
307 ((size :reader proxy-instance-size)))
309 (defclass direct-alien-slot-definition (direct-virtual-slot-definition)
310 ((allocation :initform :alien)
311 (offset :reader slot-definition-offset :initarg :offset)))
313 (defclass effective-alien-slot-definition (effective-virtual-slot-definition)
314 ((offset :reader slot-definition-offset :initarg :offset)))
316 (defmethod most-specific-proxy-superclass ((class proxy-class))
319 (subtypep (class-name class) 'proxy))
320 (cdr (compute-class-precedence-list class))))
322 (defmethod direct-proxy-superclass ((class proxy-class))
325 (subtypep (class-name class) 'proxy))
326 (class-direct-superclasses class)))
328 (defmethod shared-initialize ((class proxy-class) names &key size)
331 (size (setf (slot-value class 'size) (first size)))
332 ((slot-boundp class 'size) (slot-makunbound class 'size))))
334 (defmethod direct-slot-definition-class ((class proxy-class) &rest initargs)
335 (case (getf initargs :allocation)
336 ((nil :alien) (find-class 'direct-alien-slot-definition))
337 (t (call-next-method))))
339 (defmethod effective-slot-definition-class ((class proxy-class) &rest initargs)
340 (case (getf initargs :allocation)
341 (:alien (find-class 'effective-alien-slot-definition))
342 (t (call-next-method))))
345 (defmethod compute-effective-slot-definition-initargs ((class proxy-class) direct-slotds)
346 (if (eq (most-specific-slot-value direct-slotds 'allocation) :alien)
348 (list :offset (most-specific-slot-value direct-slotds 'offset))
353 (defmethod initialize-internal-slot-functions ((slotd effective-alien-slot-definition))
354 (with-slots (offset) slotd
355 (let ((type (slot-definition-type slotd)))
356 (unless (slot-boundp slotd 'getter)
357 (let ((reader (reader-function type)))
359 (slot-value slotd 'getter)
361 (funcall reader (proxy-location object) offset)))))
363 (unless (slot-boundp slotd 'setter)
364 (let ((writer (writer-function type))
365 (destroy (destroy-function type)))
367 (slot-value slotd 'setter)
368 #'(lambda (value object)
369 (let ((location (proxy-location object)))
370 (funcall destroy location offset) ; destroy old value
371 (funcall writer value location offset))))))))
376 ;; TODO: call some C code to detect this a compile time
377 (defconstant +struct-alignmen+ 4)
379 (defmethod compute-slots ((class proxy-class))
381 with offset = (let ((size-of-super-classes
383 (most-specific-proxy-superclass class))))
384 (+ size-of-super-classes
385 (mod size-of-super-classes +struct-alignmen+)))
387 for slotd in (class-direct-slots class)
388 when (eq (slot-definition-allocation slotd) :alien)
389 do (if (not (slot-boundp slotd 'offset))
390 (setf (slot-value slotd 'offset) offset)
391 (setq offset (slot-value slotd 'offset)))
393 (incf offset (size-of (slot-definition-type slotd)))
394 (incf offset (mod offset +struct-alignmen+))
395 (setq size (max size offset))
397 finally (unless (slot-boundp class 'size)
398 (setf (slot-value class 'size) size)))
402 (defmethod validate-superclass ((class proxy-class) (super standard-class))
403 (subtypep (class-name super) 'proxy))
405 (defmethod proxy-instance-size (class)
406 (declare (ignore class))
409 (defmethod proxy-instance-size ((class-name symbol))
410 (proxy-instance-size (find-class class-name)))
413 (defmethod alien-type ((class proxy-class) &rest args)
414 (declare (ignore class args))
415 (alien-type 'pointer))
417 (defmethod size-of ((class proxy-class) &rest args)
418 (declare (ignore class args))
421 (defmethod from-alien-form (location (class proxy-class) &rest args)
422 (declare (ignore args))
423 `(ensure-proxy-instance ',(class-name class) ,location))
425 (defmethod from-alien-function ((class proxy-class) &rest args)
426 (declare (ignore args))
428 (ensure-proxy-instance class location)))
430 (defmethod to-alien-form (instance (class proxy-class) &rest args)
431 (declare (ignore class args))
432 `(proxy-location ,instance))
434 (defmethod to-alien-function ((class proxy-class) &rest args)
435 (declare (ignore class args))
438 (defmethod copy-from-alien-form (location (class proxy-class) &rest args)
439 (declare (ignore args))
440 (let ((class-name (class-name class)))
441 `(ensure-proxy-instance ',class-name
442 (reference-foreign ',class-name ,location))))
444 (defmethod copy-from-alien-function ((class proxy-class) &rest args)
445 (declare (ignore args))
447 (ensure-proxy-instance class (reference-foreign class location))))
449 (defmethod copy-to-alien-form (instance (class proxy-class) &rest args)
450 (declare (ignore args))
451 `(reference-foreign ',(class-name class) (proxy-location ,instance)))
453 (defmethod copy-to-alien-function ((class proxy-class) &rest args)
454 (declare (ignore args))
456 (reference-foreign class (proxy-location instance))))
458 (defmethod writer-function ((class proxy-class) &rest args)
459 (declare (ignore args))
460 #'(lambda (instance location &optional (offset 0))
461 (assert (null-pointer-p (sap-ref-sap location offset)))
463 (sap-ref-sap location offset)
464 (reference-foreign class (proxy-location instance)))))
466 (defmethod reader-function ((class proxy-class) &rest args)
467 (declare (ignore args))
468 #'(lambda (location &optional (offset 0))
469 (let ((instance (sap-ref-sap location offset)))
470 (unless (null-pointer-p instance)
471 (ensure-proxy-instance class (reference-foreign class instance))))))
473 (defmethod destroy-function ((class proxy-class) &rest args)
474 (declare (ignore args))
475 #'(lambda (location &optional (offset 0))
476 (unreference-foreign class (sap-ref-sap location offset))))
478 (defmethod unbound-value ((class proxy-class) &rest args)
479 (declare (ignore args))
482 (defgeneric ensure-proxy-instance (class location)
483 (:documentation "Returns a proxy object representing the foreign object at the give location."))
485 (defmethod ensure-proxy-instance :around (class location)
486 (unless (null-pointer-p location)
488 (find-cached-instance location)
489 (call-next-method))))
491 (defmethod ensure-proxy-instance ((class symbol) location)
492 (ensure-proxy-instance (find-class class) location))
494 (defmethod ensure-proxy-instance ((class proxy-class) location)
495 (make-instance class :location location))
498 ;;;; Superclasses for wrapping of C structures
500 (defclass struct (proxy)
502 (:metaclass proxy-class))
504 (defmethod initialize-instance ((struct struct) &rest initargs)
505 (declare (ignore initargs))
506 (unless (slot-boundp struct 'location)
507 (let ((size (proxy-instance-size (class-of struct))))
509 (error "~A has zero size" (class-of struct))
510 (setf (slot-value struct 'location) (allocate-memory size)))))
514 ;;;; Metaclasses used for subclasses of struct
516 (defclass struct-class (proxy-class)
519 (defmethod reference-foreign ((class struct-class) location)
520 (copy-memory location (proxy-instance-size class)))
522 (defmethod unreference-foreign ((class struct-class) location)
523 (deallocate-memory location))
526 (defclass static-struct-class (struct-class)
529 (defmethod reference-foreign ((class static-struct-class) location)
530 (declare (ignore class))
533 (defmethod unreference-foreign ((class static-struct-class) location)
534 (declare (ignore class location))