-;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
+;; Common Lisp bindings for GTK+ v2.x
+;; Copyright 2000-2005 Espen S. Johnsen <espen@users.sf.net>
;;
-;; 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.15 2004-10-31 00:56:29 espen Exp $
+;; $Id: gobject.lisp,v 1.36 2005-04-23 16:48:51 espen Exp $
(in-package "GLIB")
+;;;; Metaclass used for subclasses of gobject
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defclass gobject-class (ginstance-class)
+ ())
+
+ (defmethod validate-superclass ((class gobject-class) (super standard-class))
+; (subtypep (class-name super) 'gobject)
+ t))
+
+(defclass direct-property-slot-definition (direct-virtual-slot-definition)
+ ((pname :reader slot-definition-pname :initarg :pname)
+ (readable :initform t :reader slot-readable-p :initarg :readable)
+ (writable :initform t :reader slot-writable-p :initarg :writable)
+ (construct :initform nil :initarg :construct)))
+
+(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)))
+
+(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))
+
+(defbinding %object-unref () nil
+ (location pointer))
+
+(defmethod reference-foreign ((class gobject-class) location)
+ (declare (ignore class))
+ (%object-ref location))
+
+(defmethod unreference-foreign ((class gobject-class) location)
+ (declare (ignore class))
+ (%object-unref location))
+
+
+; (defbinding object-class-install-param () nil
+; (class pointer)
+; (id unsigned-int)
+; (parameter parameter))
+
+; (defbinding object-class-find-param-spec () parameter
+; (class pointer)
+; (name string))
+
+(defun signal-name-to-string (name)
+ (substitute #\_ #\- (string-downcase (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)
+ (if (typep (first direct-slotds) 'direct-property-slot-definition)
+ (nconc
+ (list :pname (signal-name-to-string
+ (most-specific-slot-value direct-slotds 'pname))
+ :readable (most-specific-slot-value direct-slotds 'readable)
+ :writable (most-specific-slot-value direct-slotds 'writable)
+ :construct (most-specific-slot-value direct-slotds 'construct))
+ (call-next-method))
+ (call-next-method)))
+
+
+(defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition))
+ (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)))
+ (let ((gvalue (gvalue-new type)))
+ (%object-get-property object pname gvalue)
+ (unwind-protect
+ (funcall reader gvalue +gvalue-value-offset+)
+ (gvalue-free gvalue t)))))))
+
+ (when (and (not (slot-boundp slotd 'setter)) (slot-writable-p slotd))
+ (setf
+ (slot-value slotd 'setter)
+ (let ((writer nil))
+ #'(lambda (value object)
+ (unless writer
+ (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)
+ value))))))
+
+ (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))
+
+
+;;;; Super class for all classes in the GObject type hierarchy
+
(eval-when (:compile-toplevel :load-toplevel :execute)
(defclass gobject (ginstance)
()
- (:metaclass ginstance-class)
- (:alien-name "GObject")
- (:copy %object-ref)
- (:free %object-unref)))
+ (:metaclass gobject-class)
+ (:gtype "GObject")))
+
+
+(defun initial-add (object function initargs key pkey)
+ (loop
+ as (initarg value . rest) = initargs then rest
+ do (cond
+ ((eq initarg key) (funcall function object value))
+ ((eq initarg pkey) (mapc #'(lambda (value)
+ (funcall function object value))
+ value)))
+ while rest))
+
+(defun initial-apply-add (object function initargs key pkey)
+ (initial-add object #'(lambda (object value)
+ (apply function object (mklist value)))
+ initargs key pkey))
(defmethod initialize-instance ((object gobject) &rest initargs)
- (let ((slotds (class-slots (class-of object)))
- (names (make-array 0 :adjustable t :fill-pointer t))
- (values (make-array 0 :adjustable t :fill-pointer t)))
-
- (loop
- as tmp = initargs then (cddr tmp) while tmp
- as key = (first tmp)
- as value = (second tmp)
- as slotd = (find-if
- #'(lambda (slotd)
- (member key (slot-definition-initargs slotd)))
- slotds)
- when (and (typep slotd 'effective-property-slot-definition)
- (slot-value slotd 'construct))
- do (let ((type (find-type-number (slot-definition-type slotd))))
- (vector-push-extend (slot-definition-pname slotd) names)
- (vector-push-extend (gvalue-new type value) values)
- (remf initargs key)))
-
- (setf
- (slot-value object 'location)
- (if (zerop (length names))
- (%gobject-new (type-number-of object))
- (%gobject-newvv (type-number-of object) (length names) names values)))
-
-; (map 'nil #'gvalue-free values)
- )
-
+ (unless (slot-boundp object 'location)
+ ;; Extract initargs which we should pass directly to the GObeject
+ ;; constructor
+ (let* ((slotds (class-slots (class-of object)))
+ (args (when initargs
+ (loop
+ as (key value . rest) = initargs then rest
+ as slotd = (find-if
+ #'(lambda (slotd)
+ (member key (slot-definition-initargs slotd)))
+ slotds)
+ when (and (typep slotd 'effective-property-slot-definition)
+ (slot-value slotd 'construct))
+ collect (progn
+ (remf initargs key)
+ (list
+ (slot-definition-pname slotd)
+ (slot-definition-type slotd)
+ value))
+ while rest))))
+ (if args
+ (let* ((string-size (size-of 'string))
+ (string-writer (writer-function 'string))
+ (string-destroy (destroy-function 'string))
+ (params (allocate-memory
+ (* (length args) (+ string-size +gvalue-size+)))))
+ (loop
+ for (pname type value) in args
+ as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
+ do (funcall string-writer pname tmp)
+ (gvalue-init (sap+ tmp string-size) type value))
+ (unwind-protect
+ (setf
+ (slot-value object 'location)
+ (%gobject-newv (type-number-of object) (length args) params))
+ (loop
+ repeat (length args)
+ as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
+ do (funcall string-destroy tmp)
+ (gvalue-unset (sap+ tmp string-size)))
+ (deallocate-memory params)))
+ (setf
+ (slot-value object 'location)
+ (%gobject-new (type-number-of object))))))
+
(apply #'call-next-method object initargs))
+(defmethod instance-finalizer ((instance gobject))
+ (let ((location (proxy-location instance)))
+ #'(lambda ()
+ (remove-cached-instance location)
+ (%object-unref location))))
+
(defbinding (%gobject-new "g_object_new") () pointer
(type type-number)
(nil null))
-(defbinding (%gobject-newvv "g_object_newvv") () pointer
+(defbinding (%gobject-newv "g_object_newv") () pointer
(type type-number)
(n-parameters unsigned-int)
- (names (vector string))
- (values (vector gvalue)))
-
-
-(defbinding %object-ref (type location) pointer
- (location pointer))
-
- (defbinding %object-unref (type location) nil
- (location pointer))
-
-(defun object-ref (object)
- (%object-ref nil (proxy-location object)))
-
-(defun object-unref (object)
- (%object-unref nil (proxy-location object)))
+ (params pointer))
(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) *destroy-notify*)
+(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 object-data (object key &key (test #'eq))
- (find-user-data
- (%object-get-qdata object (quark-from-object key :test test))))
-
-
-
-;;;; Metaclass used for subclasses of gobject
-
-(eval-when (:compile-toplevel :load-toplevel :execute)
- (defclass gobject-class (ginstance-class)
- ())
-
- (defclass direct-property-slot-definition (direct-virtual-slot-definition)
- ((pname :reader slot-definition-pname :initarg :pname)
- (readable :initform t :reader slot-readable-p :initarg :readable)
- (writable :initform t :reader slot-writable-p :initarg :writable)
- (construct :initform nil :initarg :construct)))
-
- (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))))
-
-
-
-; (defbinding object-class-install-param () nil
-; (class pointer)
-; (id unsigned-int)
-; (parameter parameter))
-
-; (defbinding object-class-find-param-spec () parameter
-; (class pointer)
-; (name string))
-
-(defun signal-name-to-string (name)
- (substitute #\_ #\- (string-downcase (string name))))
-
-
-(defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
- (case (getf initargs :allocation)
- (:property (find-class 'direct-property-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))
- (t (call-next-method))))
-
-(defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
- (if (eq (most-specific-slot-value direct-slotds 'allocation) :property)
- (nconc
- (list :pname (signal-name-to-string
- (most-specific-slot-value direct-slotds 'pname))
- :readable (most-specific-slot-value direct-slotds 'readable)
- :writable (most-specific-slot-value direct-slotds 'writable)
- :construct (most-specific-slot-value direct-slotds 'construct))
- (call-next-method))
- (call-next-method)))
-
+(defun user-data (object key)
+ (find-user-data (%object-get-qdata object (quark-intern key))))
-(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)))
- (unless (slot-boundp slotd 'reader-function)
- (setf
- (slot-value slotd 'reader-function)
- (if (slot-readable-p slotd)
- #'(lambda (object)
- (with-gc-disabled
- (let ((gvalue (gvalue-new type-number)))
- (%object-get-property object pname gvalue)
- (unwind-protect
- (funcall
- (intern-reader-function (type-from-number type-number)) gvalue +gvalue-value-offset+) ; temporary workaround for wrong topological sorting of types
- (gvalue-free gvalue t)))))
- #'(lambda (value object)
- (error "Slot is not readable: ~A" (slot-definition-name slotd))))))
-
- (unless (slot-boundp slotd 'writer-function)
- (setf
- (slot-value slotd 'writer-function)
- (if (slot-writable-p slotd)
- #'(lambda (value object)
- (with-gc-disabled
- (let ((gvalue (gvalue-new type-number)))
- (funcall
- (intern-writer-function (type-from-number type-number)) ; temporary
- value gvalue +gvalue-value-offset+)
- (%object-set-property object pname gvalue)
- (funcall
- (intern-destroy-function (type-from-number type-number)) ; temporary
- gvalue +gvalue-value-offset+)
- (gvalue-free gvalue nil)
- value)))
- #'(lambda (value object)
- (error "Slot is not writable: ~A" (slot-definition-name slotd))))))
-
- (unless (slot-boundp slotd 'boundp-function)
- (setf
- (slot-value slotd 'boundp-function)
- #'(lambda (object)
- (declare (ignore object))
- t))))
- (call-next-method))
+;; deprecated
+(defun object-data (object key &key (test #'eq))
+ (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))))
-(defmethod validate-superclass ((class gobject-class)
- (super pcl::standard-class))
-; (subtypep (class-name super) 'gobject)
- t)
+(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))))
;;;;
(defun %map-params (params length type inherited-p)
(if inherited-p
- (map-c-array 'list #'identity params 'param length)
+ (map-c-vector 'list #'identity params 'param length)
(let ((properties ()))
- (map-c-array 'list
+ (map-c-vector 'list
#'(lambda (param)
(when (eql (param-owner-type param) type)
(push param properties)))
(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)
)))
(if (eq type 'boolean) "-P" ""))))
-(defun slot-definition-from-property (class property)
+(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 (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
+
+ ,@(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
'(: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))))
(defun slot-definitions (class properties slots)
(loop
- with manual-slots = slots
for property in properties
- unless (find-if
- #'(lambda (slot)
- (destructuring-bind (name &rest args) slot
- (or
- (equal (param-name property) (getf args :pname))
- (eq (default-slot-name (param-name property)) name))))
- manual-slots)
- do (push (slot-definition-from-property class property) slots))
+ as slot = (or
+ (find (param-name property) slots
+ :key #'(lambda (slot) (getf (rest slot) :pname))
+ :test #'string=)
+ (find (param-name property) slots
+ :key #'first :test #'string-equal))
+ do (cond
+ ((not slot)
+ (push (slot-definition-from-property class property) slots))
+ ((getf (rest slot) :merge)
+ (setf
+ (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)
~mdw / clg / blobdiff