[clg] / glib / gobject.lisp

;; Common Lisp bindings for GTK+ v2.x
;; Copyright 2000-2005 Espen S. Johnsen <espen@users.sf.net>
;;
;; 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:
;;
;; The above copyright notice and this permission notice shall be
;; included in all copies or substantial portions of the Software.
;;
;; 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.41 2006-02-03 12:44:32 espen Exp $

(in-package "GLIB")


;;;; Metaclass used for subclasses of gobject

(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 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))

#+glib2.8
(progn
  (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))

(defmethod unreference-foreign ((class gobject-class) location)
  (declare (ignore class))
  (%object-unref location))

#+debug-ref-counting
(progn
  (defcallback weak-ref-callback (nil (data pointer) (location pointer))
    (format t "Object at 0x~8,'0X being finalized~%" (sap-int location)))
  
  (defbinding %object-weak-ref () pointer
    (location pointer)
    ((callback weak-ref-callback) pointer)
    (nil null)))


; (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))

(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

(eval-when (:compile-toplevel :load-toplevel :execute)
  (defclass gobject (ginstance)
    ()
    (: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 :around ((object gobject) &rest initargs)
  (declare (ignore initargs))
  (call-next-method)
  #+debug-ref-counting(%object-weak-ref (proxy-location object))
  #+glib2.8
  (when (slot-value (class-of object) 'instance-slots-p)
    (with-slots (location) object
      (%object-add-toggle-ref location)
      (%object-unref location))))


(defmethod initialize-instance ((object gobject) &rest initargs)
  (unless (slot-boundp object 'location)
    ;; Extract initargs which we should pass directly to the GObject
    ;; 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)))
    #+glib2.8
    (if (slot-value (class-of instance) 'instance-slots-p)
	#'(lambda ()
	    #+debug-ref-counting
	    (format t "Finalizing proxy for 0x~8,'0X~%" (sap-int location))
	    (remove-cached-instance location)
	    (%object-remove-toggle-ref location))
      #'(lambda ()
	  #+debug-ref-counting
	  (format t "Finalizing proxy for 0x~8,'0X~%" (sap-int location))
	  (remove-cached-instance location)
	  (%object-unref location)))
    #-glib2.8
    #'(lambda ()
	(remove-cached-instance location)
	  (%object-unref location))))


(defbinding (%gobject-new "g_object_new") () pointer
  (type type-number)
  (nil null))

(defbinding (%gobject-newv "g_object_newv") () pointer
  (type type-number)
  (n-parameters unsigned-int)
  (params pointer))


;;;; Property stuff

(defbinding %object-set-property () nil
  (object gobject)
  (name string)
  (value gvalue))

(defbinding %object-get-property () nil
  (object gobject)
  (name string)
  (value gvalue))

(defbinding %object-notify () nil
  (object gobject)
  (name string))

(defbinding object-freeze-notify () nil
  (object gobject))

(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))

(export 'user-data-destroy-func)

(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))
  (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))))


;;;;

(defbinding %object-class-list-properties () pointer
  (class pointer)
  (n-properties unsigned-int :out))


(defun %map-params (params length type inherited-p)
  (if inherited-p
      (map-c-vector 'list #'identity params 'param length)
    (let ((properties ()))
      (map-c-vector 'list 
       #'(lambda (param)
	   (when (eql (param-owner-type param) type)
	     (push param properties)))
       params 'param length)
      (nreverse properties))))

(defun query-object-class-properties (type &optional inherited-p)
  (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)
	   (unless (null-pointer-p array)
	     (unwind-protect
		 (%map-params array length type-number inherited-p)
	       (deallocate-memory array))))
;      (type-class-unref type-number)
      )))


(defun default-slot-name (name)
  (intern (substitute #\- #\_ (string-upcase (string-upcase name)))))

(defun default-slot-accessor (class-name slot-name type)
  (intern
   (format
    nil "~A-~A~A" class-name slot-name
    (if (eq type 'boolean) "-P" ""))))


(defun slot-definition-from-property (class property &optional slot-name args)
  (with-slots (name flags value-type documentation) property
    (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
	   ((and
	     (member :writable flags) (member :readable flags)
	     (not (member :construct-only flags)))
	    (list :accessor accessor))
	   ((and (member :writable flags) (not (member :construct-only flags)))
	    (list :writer `(setf ,accessor)))
	   ((member :readable flags)
	    (list :reader accessor)))

	;; readable/writable/construct
	,@(when (or (not (member :writable flags))
		    (member :construct-only flags))
	    '(:writable nil))
	,@(when (not (member :readable flags))
	    '(:readable nil))
	,@(when (or (member :construct flags) 
		    (member :construct-only flags))
	    '(:construct t))
	
	;; initargs
	,@(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 
   for property in properties
   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 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
	 ,(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)
Commit	Line	Data
112ac1d3	1	;; Common Lisp bindings for GTK+ v2.x
112ac1d3	2	;; Copyright 2000-2005 Espen S. Johnsen <espen@users.sf.net>
560af5c5	3	;;
112ac1d3	4	;; Permission is hereby granted, free of charge, to any person obtaining
	5	;; a copy of this software and associated documentation files (the
	6	;; "Software"), to deal in the Software without restriction, including
	7	;; without limitation the rights to use, copy, modify, merge, publish,
	8	;; distribute, sublicense, and/or sell copies of the Software, and to
	9	;; permit persons to whom the Software is furnished to do so, subject to
	10	;; the following conditions:
560af5c5	11	;;
112ac1d3	12	;; The above copyright notice and this permission notice shall be
112ac1d3	13	;; included in all copies or substantial portions of the Software.
560af5c5	14	;;
112ac1d3	15	;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	16	;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	17	;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
	18	;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
	19	;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
	20	;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
	21	;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
560af5c5	22
008c81d9	23	;; $Id: gobject.lisp,v 1.41 2006-02-03 12:44:32 espen Exp $
560af5c5	24
	25	(in-package "GLIB")
	26
	27
2176a9c7	28	;;;; Metaclass used for subclasses of gobject
	29
	30	(eval-when (:compile-toplevel :load-toplevel :execute)
	31	(defclass gobject-class (ginstance-class)
b036d261	32	((instance-slots-p :initform nil
b036d261	33	:documentation "Non NIL if the class has slots with instance allocation")))
2176a9c7	34
73572c12	35	(defmethod validate-superclass ((class gobject-class) (super standard-class))
2176a9c7	36	; (subtypep (class-name super) 'gobject)
	37	t))
	38
	39	(defclass direct-property-slot-definition (direct-virtual-slot-definition)
	40	((pname :reader slot-definition-pname :initarg :pname)
	41	(readable :initform t :reader slot-readable-p :initarg :readable)
	42	(writable :initform t :reader slot-writable-p :initarg :writable)
	43	(construct :initform nil :initarg :construct)))
	44
	45	(defclass effective-property-slot-definition (effective-virtual-slot-definition)
	46	((pname :reader slot-definition-pname :initarg :pname)
	47	(readable :reader slot-readable-p :initarg :readable)
	48	(writable :reader slot-writable-p :initarg :writable)
174e8a5c	49	(construct :initarg :construct)))
	50
	51	(defclass direct-user-data-slot-definition (direct-virtual-slot-definition)
	52	())
	53
	54	(defclass effective-user-data-slot-definition (effective-virtual-slot-definition)
	55	())
	56
2176a9c7	57
	58	(defbinding %object-ref () pointer
	59	(location pointer))
	60
	61	(defbinding %object-unref () nil
	62	(location pointer))
	63
0090bb5e	64	#+glib2.8
008c81d9	65	(progn
	66	(defcallback toggle-ref-callback (nil (data pointer) (location pointer) (last-ref-p boolean))
	67	(if last-ref-p
	68	(cache-instance (find-cached-instance location) t)
	69	(cache-instance (find-cached-instance location) nil)))
	70
	71	(defbinding %object-add-toggle-ref () pointer
	72	(location pointer)
	73	((callback toggle-ref-callback) pointer)
	74	(nil null))
	75
	76	(defbinding %object-remove-toggle-ref () pointer
	77	(location pointer)
	78	((callback toggle-ref-callback) pointer)
	79	(nil null)))
b036d261	80
2176a9c7	81	(defmethod reference-foreign ((class gobject-class) location)
2176a9c7	82	(declare (ignore class))
5eb27832	83	(%object-ref location))
2176a9c7	84
	85	(defmethod unreference-foreign ((class gobject-class) location)
	86	(declare (ignore class))
008c81d9	87	(%object-unref location))
b036d261	88
008c81d9	89	#+debug-ref-counting
	90	(progn
	91	(defcallback weak-ref-callback (nil (data pointer) (location pointer))
	92	(format t "Object at 0x~8,'0X being finalized~%" (sap-int location)))
	93
	94	(defbinding %object-weak-ref () pointer
	95	(location pointer)
	96	((callback weak-ref-callback) pointer)
	97	(nil null)))
2176a9c7	98
	99
	100	; (defbinding object-class-install-param () nil
	101	; (class pointer)
	102	; (id unsigned-int)
	103	; (parameter parameter))
	104
	105	; (defbinding object-class-find-param-spec () parameter
	106	; (class pointer)
	107	; (name string))
	108
	109	(defun signal-name-to-string (name)
	110	(substitute #\_ #\- (string-downcase (string name))))
	111
	112
	113	(defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
	114	(case (getf initargs :allocation)
	115	(:property (find-class 'direct-property-slot-definition))
174e8a5c	116	(:user-data (find-class 'direct-user-data-slot-definition))
2176a9c7	117	(t (call-next-method))))
	118
	119	(defmethod effective-slot-definition-class ((class gobject-class) &rest initargs)
	120	(case (getf initargs :allocation)
	121	(:property (find-class 'effective-property-slot-definition))
174e8a5c	122	(:user-data (find-class 'effective-user-data-slot-definition))
2176a9c7	123	(t (call-next-method))))
	124
	125	(defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
eeda1c2d	126	(if (typep (first direct-slotds) 'direct-property-slot-definition)
2176a9c7	127	(nconc
	128	(list :pname (signal-name-to-string
	129	(most-specific-slot-value direct-slotds 'pname))
	130	:readable (most-specific-slot-value direct-slotds 'readable)
	131	:writable (most-specific-slot-value direct-slotds 'writable)
	132	:construct (most-specific-slot-value direct-slotds 'construct))
	133	(call-next-method))
	134	(call-next-method)))
	135
	136
	137	(defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition))
dfa4f314	138	(let ((type (slot-definition-type slotd))
dfa4f314	139	(pname (slot-definition-pname slotd)))
eeda1c2d	140	(when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
2176a9c7	141	(setf
eeda1c2d	142	(slot-value slotd 'getter)
dfa4f314	143	(let ((reader nil))
eeda1c2d	144	#'(lambda (object)
21299acf	145	(unless reader
21299acf	146	(setq reader (reader-function type)))
dfa4f314	147	(let ((gvalue (gvalue-new type)))
eeda1c2d	148	(%object-get-property object pname gvalue)
	149	(unwind-protect
	150	(funcall reader gvalue +gvalue-value-offset+)
	151	(gvalue-free gvalue t)))))))
2176a9c7	152
eeda1c2d	153	(when (and (not (slot-boundp slotd 'setter)) (slot-writable-p slotd))
2176a9c7	154	(setf
eeda1c2d	155	(slot-value slotd 'setter)
dfa4f314	156	(let ((writer nil))
eeda1c2d	157	#'(lambda (value object)
21299acf	158	(unless writer
21299acf	159	(setq writer (writer-function type)))
dfa4f314	160	(let ((gvalue (gvalue-new type)))
eeda1c2d	161	(funcall writer value gvalue +gvalue-value-offset+)
	162	(%object-set-property object pname gvalue)
	163	(gvalue-free gvalue t)
	164	value))))))
	165
2176a9c7	166	(call-next-method))
2176a9c7	167
174e8a5c	168	(defmethod initialize-internal-slot-functions ((slotd effective-user-data-slot-definition))
174e8a5c	169	(let ((slot-name (slot-definition-name slotd)))
56870989	170	(unless (slot-boundp slotd 'getter)
	171	(setf
	172	(slot-value slotd 'getter)
	173	#'(lambda (object)
	174	(prog1 (user-data object slot-name)))))
	175	(unless (slot-boundp slotd 'setter)
	176	(setf
	177	(slot-value slotd 'setter)
	178	#'(lambda (value object)
	179	(setf (user-data object slot-name) value))))
	180	(unless (slot-boundp slotd 'boundp)
	181	(setf
	182	(slot-value slotd 'boundp)
	183	#'(lambda (object)
	184	(user-data-p object slot-name)))))
174e8a5c	185	(call-next-method))
174e8a5c	186
b036d261	187	(defmethod shared-initialize :after ((class gobject-class) names &rest initargs)
	188	(declare (ignore initargs))
	189	(when (some #'(lambda (slotd)
	190	(and
	191	(eq (slot-definition-allocation slotd) :instance)
e2ebafb1	192	(not (typep slotd 'effective-special-slot-definition))))
b036d261	193	(class-slots class))
	194	(setf (slot-value class 'instance-slots-p) t)))
	195
	196
2176a9c7	197
	198	;;;; Super class for all classes in the GObject type hierarchy
	199
560af5c5	200	(eval-when (:compile-toplevel :load-toplevel :execute)
c8c48a4c	201	(defclass gobject (ginstance)
560af5c5	202	()
2176a9c7	203	(:metaclass gobject-class)
dfa4f314	204	(:gtype "GObject")))
9adccb27	205
eeda1c2d	206
	207	(defun initial-add (object function initargs key pkey)
	208	(loop
	209	as (initarg value . rest) = initargs then rest
	210	do (cond
	211	((eq initarg key) (funcall function object value))
	212	((eq initarg pkey) (mapc #'(lambda (value)
	213	(funcall function object value))
	214	value)))
	215	while rest))
	216
	217	(defun initial-apply-add (object function initargs key pkey)
	218	(initial-add object #'(lambda (object value)
	219	(apply function object (mklist value)))
	220	initargs key pkey))
	221
	222
008c81d9	223	(defmethod initialize-instance :around ((object gobject) &rest initargs)
	224	(declare (ignore initargs))
	225	(call-next-method)
	226	#+debug-ref-counting(%object-weak-ref (proxy-location object))
	227	#+glib2.8
	228	(when (slot-value (class-of object) 'instance-slots-p)
	229	(with-slots (location) object
	230	(%object-add-toggle-ref location)
	231	(%object-unref location))))
	232
	233
82747bbd	234	(defmethod initialize-instance ((object gobject) &rest initargs)
040579dd	235	(unless (slot-boundp object 'location)
b036d261	236	;; Extract initargs which we should pass directly to the GObject
040579dd	237	;; constructor
	238	(let* ((slotds (class-slots (class-of object)))
	239	(args (when initargs
	240	(loop
	241	as (key value . rest) = initargs then rest
	242	as slotd = (find-if
	243	#'(lambda (slotd)
	244	(member key (slot-definition-initargs slotd)))
	245	slotds)
	246	when (and (typep slotd 'effective-property-slot-definition)
	247	(slot-value slotd 'construct))
	248	collect (progn
	249	(remf initargs key)
	250	(list
	251	(slot-definition-pname slotd)
	252	(slot-definition-type slotd)
	253	value))
	254	while rest))))
	255	(if args
	256	(let* ((string-size (size-of 'string))
	257	(string-writer (writer-function 'string))
	258	(string-destroy (destroy-function 'string))
	259	(params (allocate-memory
	260	(* (length args) (+ string-size +gvalue-size+)))))
9adccb27	261	(loop
040579dd	262	for (pname type value) in args
9adccb27	263	as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
040579dd	264	do (funcall string-writer pname tmp)
	265	(gvalue-init (sap+ tmp string-size) type value))
	266	(unwind-protect
	267	(setf
	268	(slot-value object 'location)
	269	(%gobject-newv (type-number-of object) (length args) params))
	270	(loop
	271	repeat (length args)
	272	as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
	273	do (funcall string-destroy tmp)
	274	(gvalue-unset (sap+ tmp string-size)))
	275	(deallocate-memory params)))
8755b1a5	276	(setf
8755b1a5	277	(slot-value object 'location)
040579dd	278	(%gobject-new (type-number-of object))))))
8755b1a5	279
4d83a8a6	280	(apply #'call-next-method object initargs))
	281
	282
1dbf4216	283	(defmethod instance-finalizer ((instance gobject))
1dbf4216	284	(let ((location (proxy-location instance)))
0090bb5e	285	#+glib2.8
b036d261	286	(if (slot-value (class-of instance) 'instance-slots-p)
b036d261	287	#'(lambda ()
008c81d9	288	#+debug-ref-counting
008c81d9	289	(format t "Finalizing proxy for 0x~8,'0X~%" (sap-int location))
b036d261	290	(remove-cached-instance location)
	291	(%object-remove-toggle-ref location))
	292	#'(lambda ()
008c81d9	293	#+debug-ref-counting
008c81d9	294	(format t "Finalizing proxy for 0x~8,'0X~%" (sap-int location))
b036d261	295	(remove-cached-instance location)
5eb27832	296	(%object-unref location)))
0090bb5e	297	#-glib2.8
5eb27832	298	#'(lambda ()
	299	(remove-cached-instance location)
	300	(%object-unref location))))
1dbf4216	301
9adccb27	302
d4b21b08	303	(defbinding (%gobject-new "g_object_new") () pointer
a9044181	304	(type type-number)
a9044181	305	(nil null))
560af5c5	306
9adccb27	307	(defbinding (%gobject-newv "g_object_newv") () pointer
4d83a8a6	308	(type type-number)
4d83a8a6	309	(n-parameters unsigned-int)
9adccb27	310	(params pointer))
de8516ca	311
de8516ca	312
d4b21b08	313
323d4265	314	;;;; Property stuff
560af5c5	315
26b133ed	316	(defbinding %object-set-property () nil
c8c48a4c	317	(object gobject)
	318	(name string)
	319	(value gvalue))
86d9d6ab	320
26b133ed	321	(defbinding %object-get-property () nil
c8c48a4c	322	(object gobject)
c8c48a4c	323	(name string)
a9044181	324	(value gvalue))
86d9d6ab	325
26b133ed	326	(defbinding %object-notify () nil
c8c48a4c	327	(object gobject)
c8c48a4c	328	(name string))
86d9d6ab	329
26b133ed	330	(defbinding object-freeze-notify () nil
a9044181	331	(object gobject))
86d9d6ab	332
26b133ed	333	(defbinding object-thaw-notify () nil
a9044181	334	(object gobject))
86d9d6ab	335
a00ba56a	336
	337	;;;; User data
	338
26b133ed	339	(defbinding %object-set-qdata-full () nil
86d9d6ab	340	(object gobject)
	341	(id quark)
	342	(data unsigned-long)
	343	(destroy-marshal pointer))
	344
73572c12	345	(defcallback user-data-destroy-func (nil (id unsigned-int))
	346	(destroy-user-data id))
	347
	348	(export 'user-data-destroy-func)
	349
174e8a5c	350	(defun (setf user-data) (data object key)
a00ba56a	351	(%object-set-qdata-full object (quark-intern key)
73572c12	352	(register-user-data data) (callback user-data-destroy-func))
86d9d6ab	353	data)
86d9d6ab	354
a00ba56a	355	;; deprecated
174e8a5c	356	(defun (setf object-data) (data object key &key (test #'eq))
	357	(assert (eq test #'eq))
	358	(setf (user-data object key) data))
	359
26b133ed	360	(defbinding %object-get-qdata () unsigned-long
86d9d6ab	361	(object gobject)
	362	(id quark))
	363
174e8a5c	364	(defun user-data (object key)
a00ba56a	365	(find-user-data (%object-get-qdata object (quark-intern key))))
174e8a5c	366
a00ba56a	367	;; deprecated
86d9d6ab	368	(defun object-data (object key &key (test #'eq))
174e8a5c	369	(assert (eq test #'eq))
	370	(user-data object key))
	371
	372	(defun user-data-p (object key)
a00ba56a	373	(user-data-exists-p (%object-get-qdata object (quark-intern key))))
	374
	375	(defbinding %object-steal-qdata () unsigned-long
	376	(object gobject)
	377	(id quark))
	378
	379	(defun unset-user-data (object key)
	380	(destroy-user-data (%object-steal-qdata object (quark-intern key))))
86d9d6ab	381
86d9d6ab	382
d4b21b08	383	;;;;
d4b21b08	384
323d4265	385	(defbinding %object-class-list-properties () pointer
d4b21b08	386	(class pointer)
	387	(n-properties unsigned-int :out))
	388
9c03a07c	389
	390	(defun %map-params (params length type inherited-p)
	391	(if inherited-p
9adccb27	392	(map-c-vector 'list #'identity params 'param length)
9c03a07c	393	(let ((properties ()))
9adccb27	394	(map-c-vector 'list
9c03a07c	395	#'(lambda (param)
	396	(when (eql (param-owner-type param) type)
	397	(push param properties)))
	398	params 'param length)
	399	(nreverse properties))))
	400
	401	(defun query-object-class-properties (type &optional inherited-p)
735a29da	402	(let* ((type-number (find-type-number type t))
9c03a07c	403	(class (type-class-ref type-number)))
	404	(unwind-protect
	405	(multiple-value-bind (array length)
	406	(%object-class-list-properties class)
21299acf	407	(unless (null-pointer-p array)
	408	(unwind-protect
	409	(%map-params array length type-number inherited-p)
	410	(deallocate-memory array))))
9c03a07c	411	; (type-class-unref type-number)
9c03a07c	412	)))
d4b21b08	413
	414
	415	(defun default-slot-name (name)
	416	(intern (substitute #\- #\_ (string-upcase (string-upcase name)))))
	417
	418	(defun default-slot-accessor (class-name slot-name type)
	419	(intern
	420	(format
	421	nil "~A-~A~A" class-name slot-name
4d83a8a6	422	(if (eq type 'boolean) "-P" ""))))
d4b21b08	423
323d4265	424
646466b0	425	(defun slot-definition-from-property (class property &optional slot-name args)
9c03a07c	426	(with-slots (name flags value-type documentation) property
646466b0	427	(let* ((slot-name (or slot-name (default-slot-name name)))
62f12808	428	(slot-type (or (getf args :type) (type-from-number value-type) 'pointer))
9c03a07c	429	(accessor (default-slot-accessor class slot-name slot-type)))
	430
	431	`(,slot-name
	432	:allocation :property :pname ,name
eeda1c2d	433
735a29da	434	,@(when (find :unbound args) (list :unbound (getf args :unbound)))
	435	,@(when (find :getter args) (list :getter (getf args :getter)))
	436	,@(when (find :setter args) (list :setter (getf args :setter)))
9c03a07c	437
	438	;; accessors
	439	,@(cond
	440	((and
	441	(member :writable flags) (member :readable flags)
	442	(not (member :construct-only flags)))
	443	(list :accessor accessor))
	444	((and (member :writable flags) (not (member :construct-only flags)))
	445	(list :writer `(setf ,accessor)))
	446	((member :readable flags)
	447	(list :reader accessor)))
	448
	449	;; readable/writable/construct
	450	,@(when (or (not (member :writable flags))
	451	(member :construct-only flags))
	452	'(:writable nil))
	453	,@(when (not (member :readable flags))
	454	'(:readable nil))
	455	,@(when (or (member :construct flags)
	456	(member :construct-only flags))
	457	'(:construct t))
	458
	459	;; initargs
e5c7586b	460	,@(if (find :initarg args)
	461	(let ((initarg (getf args :initarg)))
	462	(etypecase initarg
	463	(null ())
	464	(symbol `(:initarg ,initarg))))
	465	(when (or (member :construct flags)
	466	(member :construct-only flags)
	467	(member :writable flags))
	468	(list :initarg (intern (string slot-name) "KEYWORD"))))
9c03a07c	469
	470	:type ,slot-type
	471	:documentation ,documentation))))
	472
	473
	474	(defun slot-definitions (class properties slots)
	475	(loop
9c03a07c	476	for property in properties
eeda1c2d	477	as slot = (or
	478	(find (param-name property) slots
	479	:key #'(lambda (slot) (getf (rest slot) :pname))
	480	:test #'string=)
	481	(find (param-name property) slots
	482	:key #'first :test #'string-equal))
	483	do (cond
	484	((not slot)
	485	(push (slot-definition-from-property class property) slots))
	486	((getf (rest slot) :merge)
	487	(setf
	488	(rest slot)
646466b0	489	(rest (slot-definition-from-property class property (first slot) (rest slot)))))))
9c03a07c	490	(delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
	491
	492
62f12808	493	(defun expand-gobject-type (type forward-p options &optional (metaclass 'gobject-class))
9c03a07c	494	(let ((supers (cons (supertype type) (implements type)))
	495	(class (type-from-number type))
	496	(slots (getf options :slots)))
	497	`(defclass ,class ,supers
735a29da	498	,(unless forward-p
	499	(slot-definitions class (query-object-class-properties type) slots))
	500	(:metaclass ,metaclass)
	501	(:gtype ,(register-type-as type)))))
323d4265	502
62f12808	503	(defun gobject-dependencies (type)
21299acf	504	(delete-duplicates
	505	(cons
	506	(supertype type)
	507	(append
	508	(type-interfaces type)
	509	(mapcar #'param-value-type (query-object-class-properties type))))))
d4b21b08	510
62f12808	511
62f12808	512	(register-derivable-type 'gobject "GObject" 'expand-gobject-type 'gobject-dependencies)
ae37d096	513
	514
	515	;;; Pseudo type for gobject instances which have their reference count
	516	;;; increased by the returning function
	517
	518	(defmethod alien-type ((type (eql 'referenced)) &rest args)
	519	(declare (ignore type args))
	520	(alien-type 'gobject))
	521
	522	(defmethod from-alien-form (form (type (eql 'referenced)) &rest args)
	523	(declare (ignore type))
	524	(destructuring-bind (type) args
	525	(if (subtypep type 'gobject)
	526	(let ((instance (make-symbol "INSTANCE")))
	527	`(let ((,instance ,(from-alien-form form type)))
	528	(when ,instance
	529	(%object-unref (proxy-location ,instance)))
	530	,instance))
	531	(error "~A is not a subclass of GOBJECT" type))))
	532
	533	(export 'referenced)