1 ;; Common Lisp bindings for GTK+ v2.0
2 ;; Copyright (C) 2000 Espen S. Johnsen <espejohn@online.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: gtype.lisp,v 1.2 2000-08-15 14:42:34 espen Exp $
27 (deftype type-number () '(unsigned 32))
29 (define-foreign ("g_type_name" alien-type-name) (type) (static string)
30 ((find-type-number type) type-number))
32 (define-foreign %type-from-name () type-number
35 ;(define-foreign type-parent () type-number
38 (define-foreign type-instance-size (type) int
39 ((find-type-number type) type-number))
41 (define-foreign type-create-instance (type) pointer
42 ((find-type-number type) type-number))
44 (define-foreign type-free-instance () nil
48 (defvar *type-to-number-hash* (make-hash-table))
49 (defvar *number-to-type-hash* (make-hash-table))
51 (defun type-number-from-alien-name (name &optional (error t))
52 (if (string= name "invalid")
54 (let ((type-number (%type-from-name name)))
56 ((and (zerop type-number) error)
57 (error "Invalid alien type name: ~A" name))
58 ((zerop type-number) nil)
61 (defun (setf alien-type-name) (alien-name type)
62 (let ((type-name (ensure-type-name type))
63 (type-number (type-number-from-alien-name alien-name)))
64 (setf (gethash type-number *number-to-type-hash*) type-name)
65 (setf (gethash type-name *type-to-number-hash*) type-number)))
67 (defun (setf find-type-number) (type-number type)
68 (setf (gethash (ensure-type-name type) *type-to-number-hash*) type-number))
70 (defun find-type-number (type)
73 (symbol (gethash type *type-to-number-hash*))
74 (pcl::class (gethash (class-name type) *type-to-number-hash*))))
76 (defun type-from-number (type-number)
77 (gethash type-number *number-to-type-hash*))
79 (defun type-number-of (object)
80 (find-type-number (type-of object)))
84 ;;;; Superclass for all metaclasses implementing some sort of virtual slots
86 (eval-when (:compile-toplevel :load-toplevel :execute)
87 (defclass virtual-class (pcl::standard-class))
89 (defclass direct-virtual-slot-definition (standard-direct-slot-definition)
91 :reader slot-definition-location
94 (defclass effective-virtual-slot-definition
95 (standard-effective-slot-definition)))
98 (defmethod direct-slot-definition-class ((class virtual-class) initargs)
99 (if (eq (getf initargs :allocation) :virtual)
100 (find-class 'direct-virtual-slot-definition)
104 (defmethod effective-slot-definition-class ((class virtual-class) initargs)
105 (if (eq (getf initargs :allocation) :virtual)
106 (find-class 'effective-virtual-slot-definition)
110 (defun %direct-slot-definitions-slot-value (slotds slot &optional default)
115 (slot-exists-p slotd slot)
116 (slot-boundp slotd slot)))
119 (slot-value slotd slot)
123 (defgeneric compute-virtual-slot-location (class slotd direct-slotds))
125 (defmethod compute-virtual-slot-location
126 ((class virtual-class)
127 (slotd effective-virtual-slot-definition)
130 (%direct-slot-definitions-slot-value direct-slotds 'location)))
131 (if (and location (symbolp location))
132 (list location `(setf ,location))
136 (defmethod compute-effective-slot-definition
137 ((class virtual-class) direct-slotds)
138 (let ((slotd (call-next-method)))
139 (when (typep slotd 'effective-virtual-slot-definition)
141 (slot-value slotd 'pcl::location)
142 (compute-virtual-slot-location class slotd direct-slotds)))
146 (defmethod slot-value-using-class
147 ((class virtual-class) (object standard-object)
148 (slotd effective-virtual-slot-definition))
149 (let ((reader (first (slot-definition-location slotd))))
151 (funcall reader object)
152 (slot-unbound class object (slot-definition-name slotd)))))
155 (defmethod slot-boundp-using-class
156 ((class virtual-class) (object standard-object)
157 (slotd effective-virtual-slot-definition))
158 (and (first (slot-definition-location slotd)) t))
162 (defmethod (setf slot-value-using-class)
163 (value (class virtual-class) (object standard-object)
164 (slotd effective-virtual-slot-definition))
165 (let ((writer (second (slot-definition-location slotd))))
169 "Can't set read-only slot ~A in ~A"
170 (slot-definition-name slotd)
172 ((or (functionp writer) (symbolp writer))
173 (funcall writer value object)
176 (funcall (fdefinition writer) value object)
180 (defmethod validate-superclass
181 ((class virtual-class) (super pcl::standard-class))
186 ;;;; Superclass for wrapping of C structures
188 (eval-when (:compile-toplevel :load-toplevel :execute)
189 (defclass alien-instance ()
191 :reader alien-instance-location
192 :type system-area-pointer)))
194 (defgeneric allocate-alien-storage (class))
195 (defgeneric reference-instance (object))
196 (defgeneric unreference-instance (object))
197 (defgeneric from-alien-initialize-instance (object &rest initargs))
198 (defgeneric instance-finalizer (object)))
201 (internal *instance-cache*)
202 (defvar *instance-cache* (make-hash-table :test #'eql))
204 (defun cache-instance (object)
206 (gethash (system:sap-int (alien-instance-location object)) *instance-cache*)
207 (ext:make-weak-pointer object)))
209 (defun find-cached-instance (location)
210 (let ((ref (gethash (system:sap-int location) *instance-cache*)))
212 (ext:weak-pointer-value ref))))
214 (defun remove-cached-instance (location)
215 (remhash (system:sap-int location) *instance-cache*))
218 (defmethod initialize-instance :before ((instance alien-instance)
220 (declare (ignore initargs))
222 (slot-value instance 'location)
223 (allocate-alien-storage (class-of instance)))
224 (cache-instance instance)
225 (ext:finalize instance (instance-finalizer instance)))
228 (defmethod from-alien-initialize-instance ((instance alien-instance)
229 &rest initargs &key location)
230 (declare (ignore initargs))
231 (setf (slot-value instance 'location) location)
232 (cache-instance instance))
235 (deftype-method translate-type-spec alien-instance (type-spec)
236 (declare (ignore type-spec))
237 'system-area-pointer)
241 ;;;; Metaclass used for subclasses of alien-instance
243 (eval-when (:compile-toplevel :load-toplevel :execute)
244 (defclass alien-class (virtual-class)
246 :reader alien-class-size)))
248 (defclass direct-alien-slot-definition (direct-virtual-slot-definition)
252 :reader slot-definition-offset
256 (defclass effective-alien-slot-definition (effective-virtual-slot-definition)
258 :reader slot-definition-offset)))
260 (defclass effective-virtual-alien-slot-definition
261 (effective-virtual-slot-definition))
264 (defmethod alien-class-superclass ((class alien-class))
267 (subtypep (class-name class) 'alien-instance))
268 (pcl::class-direct-superclasses class)))
271 (defmethod shared-initialize ((class alien-class) names
272 &rest initargs &key size alien-name name)
273 (declare (ignore initargs))
277 (setf (alien-type-name (or name (class-name class))) (first alien-name)))
279 (setf (slot-value class 'size) (first size))))
282 (defmethod shared-initialize :after ((class alien-class) names
284 (declare (ignore initargs names))
285 (let* ((super (alien-class-superclass class))
287 (if (eq (class-name super) 'alien-instance)
289 (alien-class-size super))))
290 (dolist (slotd (class-slots class))
291 (when (eq (slot-definition-allocation slotd) :alien)
292 (with-slots (offset type) slotd
293 (setq actual-size (max actual-size (+ offset (size-of type)))))))
295 ((not (slot-boundp class 'size))
296 (setf (slot-value class 'size) actual-size))
297 ((> actual-size (slot-value class 'size))
298 (warn "The actual size of class ~A is lager than specified" class)))))
301 (defmethod direct-slot-definition-class ((class alien-class) initargs)
302 (case (getf initargs :allocation)
303 ((nil :alien) (find-class 'direct-alien-slot-definition))
304 ; (:instance (error "Allocation :instance not allowed in class ~A" class))
305 (t (call-next-method))))
308 (defmethod effective-slot-definition-class ((class alien-class) initargs)
309 (case (getf initargs :allocation)
310 (:alien (find-class 'effective-alien-slot-definition))
311 (:virtual (find-class 'effective-virtual-alien-slot-definition))
312 (t (call-next-method))))
315 (defmethod compute-virtual-slot-location
316 ((class alien-class) (slotd effective-alien-slot-definition)
318 (with-slots (offset type) slotd
319 (setf offset (%direct-slot-definitions-slot-value direct-slotds 'offset))
320 (let ((reader (get-reader-function type))
321 (writer (get-writer-function type))
322 (destroy (get-destroy-function type)))
325 (funcall reader (alien-instance-location object) offset))
326 #'(lambda (value object)
327 (let ((location (alien-instance-location object)))
328 (funcall destroy location offset)
329 (funcall writer value location offset)))))))
332 (defmethod compute-virtual-slot-location
334 (slotd effective-virtual-alien-slot-definition)
336 (let ((location (call-next-method)))
337 (if (or (stringp location) (consp location))
338 (destructuring-bind (reader &optional writer) (mklist location)
339 (with-slots (type) slotd
342 (let* ((alien-type (translate-type-spec type))
345 (alien::make-heap-alien-info
346 :type (alien::parse-alien-type
347 `(function ,alien-type system-area-pointer))
348 :sap-form (system:foreign-symbol-address reader))))
349 (from-alien (get-from-alien-function type)))
354 alien (alien-instance-location object)))))
357 (let* ((alien-type (translate-type-spec type))
360 (alien::make-heap-alien-info
361 :type (alien::parse-alien-type
363 void ,alien-type system-area-pointer))
364 :sap-form (system:foreign-symbol-address writer))))
365 (to-alien (get-to-alien-function type))
366 (cleanup (get-cleanup-function type)))
367 #'(lambda (value object)
368 (let ((alien-value (funcall to-alien value))
369 (location (alien-instance-location object)))
370 (alien-funcall alien location alien-value)
371 (funcall cleanup alien-value))))
376 (defmethod compute-slots ((class alien-class))
377 ;; Translating the user supplied relative (to previous slot) offsets
378 ;; to absolute offsets.
379 ;; This code is broken and have to be fixed for real use.
380 (with-slots (direct-slots) class
381 (let* ((super (alien-class-superclass class))
383 (if (eq (class-name super) 'alien-instance)
385 (alien-class-size super))))
386 (dolist (slotd direct-slots)
387 (when (eq (slot-definition-allocation slotd) :alien)
388 (with-slots (offset type) slotd
390 offset (+ slot-offset offset)
391 slot-offset (+ offset (size-of type)))))))
393 ;; Reverse the direct slot definitions so the effective slots
394 ;; will be in correct order.
395 (setf direct-slots (reverse direct-slots))
396 ;; This nreverse caused me so much frustration that I leave it
397 ;; here just as a reminder of what not to do.
398 ; (setf direct-slots (nreverse direct-slots))
403 (defmethod validate-superclass ((class alien-class)
404 (super pcl::standard-class))
405 (subtypep (class-name super) 'alien-instance))
407 (defgeneric make-instance-from-alien (class location &rest initargs &key)))
409 (defmethod make-instance-from-alien ((class symbol) location
411 (apply #'make-instance-from-alien (find-class class) location initargs))
413 (defmethod make-instance-from-alien ((class alien-class) location
415 (let ((instance (allocate-instance class)))
417 #'from-alien-initialize-instance
418 instance :location location initargs)
421 (defun ensure-alien-instance (class location &rest initargs)
423 (find-cached-instance location)
424 (apply #'make-instance-from-alien class location initargs)))
426 (defmethod allocate-alien-storage ((class alien-class))
427 (allocate-memory (alien-class-size class)))
431 ;;;; Superclass for wrapping structures with reference counting
433 (eval-when (:compile-toplevel :load-toplevel :execute)
434 (defclass alien-object (alien-instance)
436 (:metaclass alien-class)
439 (define-type-method-fun alien-ref (type-spec))
440 (define-type-method-fun alien-unref (type-spec))
442 (defmethod from-alien-initialize-instance ((object alien-object)
444 (declare (ignore initargs))
446 (reference-instance object))
448 (defmethod instance-finalizer ((object alien-object))
449 (let ((location (alien-instance-location object))
450 (unref (fdefinition (alien-unref (class-of object)))))
451 (declare (type system-area-pointer location) (type function unref))
453 (remove-cached-instance location)
454 (funcall unref location))))
456 (defmethod reference-instance ((object alien-object))
457 (funcall (alien-ref (class-of object)) object)
460 (defmethod unreference-instance ((object alien-object))
461 (funcall (alien-unref (class-of object)) object)
464 (deftype-method translate-to-alien
465 alien-object (type-spec object &optional copy)
467 `(,(alien-ref type-spec) ,object)
468 `(alien-instance-location ,object)))
470 (deftype-method translate-from-alien
471 alien-object (type-spec location &optional alloc)
472 (declare (ignore alloc))
473 `(let ((location ,location))
474 (unless (null-pointer-p location)
475 (ensure-alien-instance ',type-spec location))))
478 cleanup-alien alien-object (type-spec sap &optional copied)
481 (unless (null-pointer-p sap)
482 (,(alien-unref type-spec) sap)))))
486 ;;;; Superclass for wrapping of non-refcounted structures
488 (eval-when (:compile-toplevel :load-toplevel :execute)
489 (defclass alien-structure (alien-instance)
491 :allocation :instance
492 :reader alien-structure-static-p
495 (:metaclass alien-class)
498 (define-type-method-fun alien-copier (type-spec))
499 (define-type-method-fun alien-deallocator (type-spec))
501 (defmethod from-alien-initialize-instance ((structure alien-structure)
502 &rest initargs &key static)
503 (declare (ignore initargs))
505 (setf (slot-value structure 'static) static))
507 (defmethod instance-finalizer ((structure alien-structure))
508 (let ((location (alien-instance-location structure)))
509 (declare (type system-area-pointer location))
510 (if (alien-structure-static-p structure)
512 (remove-cached-instance location))
514 (fdefinition (alien-deallocator (class-of structure)))))
515 (declare (type function deallocator))
517 (remove-cached-instance location)
518 (funcall deallocator location))))))
521 (deftype-method alien-copier alien-structure (type-spec)
522 (declare (ignore type-spec))
525 (deftype-method alien-deallocator alien-structure (type-spec)
526 (declare (ignore type-spec))
529 (deftype-method translate-to-alien
530 alien-structure (type-spec object &optional copy)
531 `(let ((object ,object))
532 (if (and ,copy (not (alien-structure-static-p object)))
533 (,(alien-copier type-spec)
534 `(alien-instance-location object)
535 ,(alien-class-size (find-class type-spec)))
536 (alien-instance-location object))))
538 (deftype-method translate-from-alien
539 alien-structure (type-spec location &optional (alloc :dynamic))
540 `(let ((location ,location))
541 (unless (null-pointer-p location)
543 (:dynamic `(ensure-alien-instance ',type-spec location))
544 (:static `(ensure-alien-instance ',type-spec location :static t))
545 (:copy `(ensure-alien-instance
547 `(,(alien-copier type-spec)
548 location ,(alien-class-size (find-class type-spec)))))))))
550 (deftype-method cleanup-alien alien-structure (type-spec sap &optional copied)
555 (alien-structure-static-p (find-cached-instance sap)))
556 (,(alien-deallocator type-spec) sap)))))
560 ;;;; Superclass for static structures such as gdk:visual
562 (defclass static-structure (alien-structure)
564 (:metaclass alien-class)
568 (defmethod from-alien-initialize-instance ((structure alien-structure)
570 (declare (ignore initargs))
572 (setf (slot-value structure 'static) t))
576 ;;;; Superclass wrapping types in the glib type system
578 (eval-when (:compile-toplevel :load-toplevel :execute)
579 (defclass gtype (alien-object)
581 (:metaclass alien-class)
582 (:size 4 #|(size-of 'pointer)|#)))
585 (defun %alien-instance-type-number (location)
586 (let ((class (sap-ref-sap location 0)))
587 (sap-ref-unsigned class 0)))
590 (deftype-method translate-from-alien gtype (type-spec location &optional alloc)
591 (declare (ignore type-spec alloc))
592 `(let ((location ,location))
593 (unless (null-pointer-p location)
594 (ensure-alien-instance
595 (type-from-number (%alien-instance-type-number location))
600 ;;;; Metaclass for subclasses of gtype-class
602 (eval-when (:compile-toplevel :load-toplevel :execute)
603 (defclass gtype-class (alien-class)))
606 (defmethod shared-initialize ((class gtype-class) names
607 &rest initargs &key name)
608 (declare (ignore initargs names))
611 (slot-value class 'size)
612 (type-instance-size (find-type-number (or name (class-name class))))))
615 (defmethod validate-superclass
616 ((class gtype-class) (super pcl::standard-class))
617 (subtypep (class-name super) 'gtype))
620 (defmethod allocate-alien-storage ((class gtype-class))
621 (type-create-instance (find-type-number class)))
624 ;;;; Initializing type numbers
626 (setf (alien-type-name 'invalid) "invalid")
627 (setf (alien-type-name 'char) "gchar")
628 (setf (alien-type-name 'unsigned-char) "guchar")
629 (setf (alien-type-name 'boolean) "gboolean")
630 (setf (alien-type-name 'int) "gint")
631 (setf (alien-type-name 'unsigned-int) "guint")
632 (setf (alien-type-name 'long) "glong")
633 (setf (alien-type-name 'unsigned-long) "gulong")
634 (setf (alien-type-name 'enum) "GEnum")
635 (setf (alien-type-name 'flags) "GFlags")
636 (setf (alien-type-name 'single-float) "gfloat")
637 (setf (alien-type-name 'double-float) "gdouble")
638 (setf (alien-type-name 'string) "gstring")
639 (setf (find-type-number 'fixnum) (find-type-number 'int))