[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.43 2006-02-05 15:38:57 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))
    #+debug-ref-counting
    (if last-ref-p
	(format t "Object at 0x~8,'0X has no foreign references~%" (sap-int location))
      (format t "Foreign reference added to object at 0x~8,'0X~%" (sap-int location)))
    (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 make-proxy-instance ((class gobject-class) location &rest initargs)
  (declare (ignore location initargs))
  (if (slot-value class 'instance-slots-p)
      (error "An object of class ~A has instance slots and should only be created with MAKE-INSTANCE" class)
    (call-next-method)))

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