X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/clg/blobdiff_plain/040579dd743ad0bb0b4fcd1b763864f15ff4308d..e2ebafb115b201d38b16f2ee7064b8514ea6b2e3:/glib/gobject.lisp diff --git a/glib/gobject.lisp b/glib/gobject.lisp index 50c2958..43a8da7 100644 --- a/glib/gobject.lisp +++ b/glib/gobject.lisp @@ -1,21 +1,26 @@ -;; Common Lisp bindings for GTK+ v2.0 -;; Copyright (C) 2000-2001 Espen S. Johnsen +;; Common Lisp bindings for GTK+ v2.x +;; Copyright 2000-2005 Espen S. Johnsen ;; -;; This library is free software; you can redistribute it and/or -;; modify it under the terms of the GNU Lesser General Public -;; License as published by the Free Software Foundation; either -;; version 2 of the License, or (at your option) any later version. +;; Permission is hereby granted, free of charge, to any person obtaining +;; a copy of this software and associated documentation files (the +;; "Software"), to deal in the Software without restriction, including +;; without limitation the rights to use, copy, modify, merge, publish, +;; distribute, sublicense, and/or sell copies of the Software, and to +;; permit persons to whom the Software is furnished to do so, subject to +;; the following conditions: ;; -;; This library is distributed in the hope that it will be useful, -;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -;; Lesser General Public License for more details. +;; The above copyright notice and this permission notice shall be +;; included in all copies or substantial portions of the Software. ;; -;; You should have received a copy of the GNU Lesser General Public -;; License along with this library; if not, write to the Free Software -;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -;; $Id: gobject.lisp,v 1.24 2004-12-21 00:04:48 espen Exp $ +;; $Id: gobject.lisp,v 1.38 2006-02-02 22:35:12 espen Exp $ (in-package "GLIB") @@ -24,10 +29,10 @@ (in-package "GLIB") (eval-when (:compile-toplevel :load-toplevel :execute) (defclass gobject-class (ginstance-class) - ()) + ((instance-slots-p :initform nil + :documentation "Non NIL if the class has slots with instance allocation"))) - (defmethod validate-superclass ((class gobject-class) - (super pcl::standard-class)) + (defmethod validate-superclass ((class gobject-class) (super standard-class)) ; (subtypep (class-name super) 'gobject) t)) @@ -41,7 +46,14 @@ (defclass effective-property-slot-definition (effective-virtual-slot-definition) ((pname :reader slot-definition-pname :initarg :pname) (readable :reader slot-readable-p :initarg :readable) (writable :reader slot-writable-p :initarg :writable) - (construct :initarg :construct)));) + (construct :initarg :construct))) + +(defclass direct-user-data-slot-definition (direct-virtual-slot-definition) + ()) + +(defclass effective-user-data-slot-definition (effective-virtual-slot-definition) + ()) + (defbinding %object-ref () pointer (location pointer)) @@ -49,13 +61,33 @@ (defbinding %object-ref () pointer (defbinding %object-unref () nil (location pointer)) +(defcallback toggle-ref-callback (nil (data pointer) (location pointer) (last-ref-p boolean)) + (if last-ref-p + (cache-instance (find-cached-instance location) t) + (cache-instance (find-cached-instance location) nil))) + +(defbinding %object-add-toggle-ref () pointer + (location pointer) + ((callback toggle-ref-callback) pointer) + (nil null)) + +(defbinding %object-remove-toggle-ref () pointer + (location pointer) + ((callback toggle-ref-callback) pointer) + (nil null)) + (defmethod reference-foreign ((class gobject-class) location) (declare (ignore class)) - (%object-ref location)) + (if (slot-value class 'instance-slots-p) + (%object-add-toggle-ref location) + (%object-ref location))) (defmethod unreference-foreign ((class gobject-class) location) (declare (ignore class)) - (%object-unref location)) + (error "Should never be called on a GOBJECT-CLASS (if this is ever needed some redesigning would have to be done)") +; (%object-unref location) +) + ; (defbinding object-class-install-param () nil @@ -74,11 +106,13 @@ (defun signal-name-to-string (name) (defmethod direct-slot-definition-class ((class gobject-class) &rest initargs) (case (getf initargs :allocation) (:property (find-class 'direct-property-slot-definition)) + (:user-data (find-class 'direct-user-data-slot-definition)) (t (call-next-method)))) (defmethod effective-slot-definition-class ((class gobject-class) &rest initargs) (case (getf initargs :allocation) (:property (find-class 'effective-property-slot-definition)) + (:user-data (find-class 'effective-user-data-slot-definition)) (t (call-next-method)))) (defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds) @@ -94,17 +128,16 @@ (defmethod compute-effective-slot-definition-initargs ((class gobject-class) dir (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition)) - (let* ((type (slot-definition-type slotd)) - (pname (slot-definition-pname slotd)) - (type-number (find-type-number type))) + (let ((type (slot-definition-type slotd)) + (pname (slot-definition-pname slotd))) (when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd)) (setf (slot-value slotd 'getter) (let ((reader nil)) #'(lambda (object) (unless reader - (setq reader (reader-function (type-from-number type-number)))) - (let ((gvalue (gvalue-new type-number))) + (setq reader (reader-function type))) + (let ((gvalue (gvalue-new type))) (%object-get-property object pname gvalue) (unwind-protect (funcall reader gvalue +gvalue-value-offset+) @@ -116,8 +149,8 @@ (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-de (let ((writer nil)) #'(lambda (value object) (unless writer - (setq writer (writer-function (type-from-number type-number)))) - (let ((gvalue (gvalue-new type-number))) + (setq writer (writer-function type))) + (let ((gvalue (gvalue-new type))) (funcall writer value gvalue +gvalue-value-offset+) (%object-set-property object pname gvalue) (gvalue-free gvalue t) @@ -125,6 +158,35 @@ (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-de (call-next-method)) +(defmethod initialize-internal-slot-functions ((slotd effective-user-data-slot-definition)) + (let ((slot-name (slot-definition-name slotd))) + (unless (slot-boundp slotd 'getter) + (setf + (slot-value slotd 'getter) + #'(lambda (object) + (prog1 (user-data object slot-name))))) + (unless (slot-boundp slotd 'setter) + (setf + (slot-value slotd 'setter) + #'(lambda (value object) + (setf (user-data object slot-name) value)))) + (unless (slot-boundp slotd 'boundp) + (setf + (slot-value slotd 'boundp) + #'(lambda (object) + (user-data-p object slot-name))))) + (call-next-method)) + +(defmethod shared-initialize :after ((class gobject-class) names &rest initargs) + (declare (ignore initargs)) + (when (some #'(lambda (slotd) + (and + (eq (slot-definition-allocation slotd) :instance) + (not (typep slotd 'effective-special-slot-definition)))) + (class-slots class)) + (setf (slot-value class 'instance-slots-p) t))) + + ;;;; Super class for all classes in the GObject type hierarchy @@ -132,7 +194,7 @@ (eval-when (:compile-toplevel :load-toplevel :execute) (defclass gobject (ginstance) () (:metaclass gobject-class) - (:alien-name "GObject"))) + (:gtype "GObject"))) (defun initial-add (object function initargs key pkey) @@ -153,7 +215,7 @@ (defun initial-apply-add (object function initargs key pkey) (defmethod initialize-instance ((object gobject) &rest initargs) (unless (slot-boundp object 'location) - ;; Extract initargs which we should pass directly to the GObeject + ;; Extract initargs which we should pass directly to the GObject ;; constructor (let* ((slotds (class-slots (class-of object))) (args (when initargs @@ -202,9 +264,13 @@ (defmethod initialize-instance ((object gobject) &rest initargs) (defmethod instance-finalizer ((instance gobject)) (let ((location (proxy-location instance))) - #'(lambda () - (remove-cached-instance location) - (%object-unref location)))) + (if (slot-value (class-of instance) 'instance-slots-p) + #'(lambda () + (remove-cached-instance location) + (%object-remove-toggle-ref location)) + #'(lambda () + (remove-cached-instance location) + (%object-unref location))))) (defbinding (%gobject-new "g_object_new") () pointer @@ -240,28 +306,51 @@ (defbinding object-freeze-notify () nil (defbinding object-thaw-notify () nil (object gobject)) + +;;;; User data + (defbinding %object-set-qdata-full () nil (object gobject) (id quark) (data unsigned-long) (destroy-marshal pointer)) +(defcallback user-data-destroy-func (nil (id unsigned-int)) + (destroy-user-data id)) -;;;; User data +(export 'user-data-destroy-func) -(defun (setf object-data) (data object key &key (test #'eq)) - (%object-set-qdata-full - object (quark-from-object key :test test) - (register-user-data data) (callback %destroy-user-data)) +(defun (setf user-data) (data object key) + (%object-set-qdata-full object (quark-intern key) + (register-user-data data) (callback user-data-destroy-func)) data) +;; deprecated +(defun (setf object-data) (data object key &key (test #'eq)) + (assert (eq test #'eq)) + (setf (user-data object key) data)) + (defbinding %object-get-qdata () unsigned-long (object gobject) (id quark)) +(defun user-data (object key) + (find-user-data (%object-get-qdata object (quark-intern key)))) + +;; deprecated (defun object-data (object key &key (test #'eq)) - (find-user-data - (%object-get-qdata object (quark-from-object key :test test)))) + (assert (eq test #'eq)) + (user-data object key)) + +(defun user-data-p (object key) + (user-data-exists-p (%object-get-qdata object (quark-intern key)))) + +(defbinding %object-steal-qdata () unsigned-long + (object gobject) + (id quark)) + +(defun unset-user-data (object key) + (destroy-user-data (%object-steal-qdata object (quark-intern key)))) ;;;; @@ -283,14 +372,15 @@ (defun %map-params (params length type inherited-p) (nreverse properties)))) (defun query-object-class-properties (type &optional inherited-p) - (let* ((type-number (find-type-number type)) + (let* ((type-number (find-type-number type t)) (class (type-class-ref type-number))) (unwind-protect (multiple-value-bind (array length) (%object-class-list-properties class) - (unwind-protect - (%map-params array length type-number inherited-p) - (deallocate-memory array))) + (unless (null-pointer-p array) + (unwind-protect + (%map-params array length type-number inherited-p) + (deallocate-memory array)))) ; (type-class-unref type-number) ))) @@ -305,19 +395,18 @@ (defun default-slot-accessor (class-name slot-name type) (if (eq type 'boolean) "-P" "")))) -(defun slot-definition-from-property (class property &optional args) +(defun slot-definition-from-property (class property &optional slot-name args) (with-slots (name flags value-type documentation) property - (let* ((slot-name (default-slot-name name)) - (slot-type (or (getf args :type) (type-from-number value-type) value-type)) + (let* ((slot-name (or slot-name (default-slot-name name))) + (slot-type (or (getf args :type) (type-from-number value-type) 'pointer)) (accessor (default-slot-accessor class slot-name slot-type))) `(,slot-name :allocation :property :pname ,name - ;; temporary hack - ,@(cond - ((find :unbound args) (list :unbound (getf args :unbound))) - ((type-is-p slot-type 'gobject) (list :unbound nil))) + ,@(when (find :unbound args) (list :unbound (getf args :unbound))) + ,@(when (find :getter args) (list :getter (getf args :getter))) + ,@(when (find :setter args) (list :setter (getf args :setter))) ;; accessors ,@(cond @@ -341,10 +430,15 @@ (defun slot-definition-from-property (class property &optional args) '(:construct t)) ;; initargs - ,@(when (or (member :construct flags) - (member :construct-only flags) - (member :writable flags)) - (list :initarg (intern (string slot-name) "KEYWORD"))) + ,@(if (find :initarg args) + (let ((initarg (getf args :initarg))) + (etypecase initarg + (null ()) + (symbol `(:initarg ,initarg)))) + (when (or (member :construct flags) + (member :construct-only flags) + (member :writable flags)) + (list :initarg (intern (string slot-name) "KEYWORD")))) :type ,slot-type :documentation ,documentation)))) @@ -365,18 +459,48 @@ (defun slot-definitions (class properties slots) ((getf (rest slot) :merge) (setf (rest slot) - (rest (slot-definition-from-property class property (rest slot))))))) + (rest (slot-definition-from-property class property (first slot) (rest slot))))))) (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots)) -(defun expand-gobject-type (type &optional options (metaclass 'gobject-class)) +(defun expand-gobject-type (type forward-p options &optional (metaclass 'gobject-class)) (let ((supers (cons (supertype type) (implements type))) (class (type-from-number type)) (slots (getf options :slots))) `(defclass ,class ,supers - ,(slot-definitions class (query-object-class-properties type) slots) - (:metaclass ,metaclass) - (:alien-name ,(find-type-name type))))) - - -(register-derivable-type 'gobject "GObject" 'expand-gobject-type) + ,(unless forward-p + (slot-definitions class (query-object-class-properties type) slots)) + (:metaclass ,metaclass) + (:gtype ,(register-type-as type))))) + +(defun gobject-dependencies (type) + (delete-duplicates + (cons + (supertype type) + (append + (type-interfaces type) + (mapcar #'param-value-type (query-object-class-properties type)))))) + + +(register-derivable-type 'gobject "GObject" 'expand-gobject-type 'gobject-dependencies) + + +;;; Pseudo type for gobject instances which have their reference count +;;; increased by the returning function + +(defmethod alien-type ((type (eql 'referenced)) &rest args) + (declare (ignore type args)) + (alien-type 'gobject)) + +(defmethod from-alien-form (form (type (eql 'referenced)) &rest args) + (declare (ignore type)) + (destructuring-bind (type) args + (if (subtypep type 'gobject) + (let ((instance (make-symbol "INSTANCE"))) + `(let ((,instance ,(from-alien-form form type))) + (when ,instance + (%object-unref (proxy-location ,instance))) + ,instance)) + (error "~A is not a subclass of GOBJECT" type)))) + +(export 'referenced)