[clg] / glib / gobject.lisp

;; Common Lisp bindings for GTK+ v2.0
;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
;;
;; 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.
;;
;; 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.
;;
;; 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

;; $Id: gobject.lisp,v 1.33 2005-02-27 15:14:38 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))
	 (type-number (find-type-number type)))
    (when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
      (setf 
       (slot-value slotd 'getter)
       (let ((reader nil)) ;(reader-function type)))
	 #'(lambda (object)
	     (unless reader
	       (setq reader (reader-function type)))
	     (let ((gvalue (gvalue-new type-number)))
	       (%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)) ;(writer-function type)))
	 #'(lambda (value object)
	     (unless writer
	       (setq writer (writer-function type)))
	     (let ((gvalue (gvalue-new type-number)))
	       (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 gobject-class)
    (:alien-name "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)
  (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-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))
	 (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

	,@(cond
	   ((find :unbound args) (list :unbound (getf args :unbound))))
	
	;; 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)
      (:alien-name ,(find-type-name 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
560af5c5	1	;; Common Lisp bindings for GTK+ v2.0
82747bbd	2	;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
560af5c5	3	;;
	4	;; This library is free software; you can redistribute it and/or
	5	;; modify it under the terms of the GNU Lesser General Public
	6	;; License as published by the Free Software Foundation; either
	7	;; version 2 of the License, or (at your option) any later version.
	8	;;
	9	;; This library is distributed in the hope that it will be useful,
	10	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	;; Lesser General Public License for more details.
	13	;;
	14	;; You should have received a copy of the GNU Lesser General Public
	15	;; License along with this library; if not, write to the Free Software
	16	;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	17
e5c7586b	18	;; $Id: gobject.lisp,v 1.33 2005-02-27 15:14:38 espen Exp $
560af5c5	19
	20	(in-package "GLIB")
	21
	22
2176a9c7	23	;;;; Metaclass used for subclasses of gobject
	24
	25	(eval-when (:compile-toplevel :load-toplevel :execute)
	26	(defclass gobject-class (ginstance-class)
	27	())
	28
73572c12	29	(defmethod validate-superclass ((class gobject-class) (super standard-class))
2176a9c7	30	; (subtypep (class-name super) 'gobject)
	31	t))
	32
	33	(defclass direct-property-slot-definition (direct-virtual-slot-definition)
	34	((pname :reader slot-definition-pname :initarg :pname)
	35	(readable :initform t :reader slot-readable-p :initarg :readable)
	36	(writable :initform t :reader slot-writable-p :initarg :writable)
	37	(construct :initform nil :initarg :construct)))
	38
	39	(defclass effective-property-slot-definition (effective-virtual-slot-definition)
	40	((pname :reader slot-definition-pname :initarg :pname)
	41	(readable :reader slot-readable-p :initarg :readable)
	42	(writable :reader slot-writable-p :initarg :writable)
174e8a5c	43	(construct :initarg :construct)))
	44
	45	(defclass direct-user-data-slot-definition (direct-virtual-slot-definition)
	46	())
	47
	48	(defclass effective-user-data-slot-definition (effective-virtual-slot-definition)
	49	())
	50
2176a9c7	51
	52	(defbinding %object-ref () pointer
	53	(location pointer))
	54
	55	(defbinding %object-unref () nil
	56	(location pointer))
	57
	58	(defmethod reference-foreign ((class gobject-class) location)
	59	(declare (ignore class))
	60	(%object-ref location))
	61
	62	(defmethod unreference-foreign ((class gobject-class) location)
	63	(declare (ignore class))
	64	(%object-unref location))
	65
	66
	67	; (defbinding object-class-install-param () nil
	68	; (class pointer)
	69	; (id unsigned-int)
	70	; (parameter parameter))
	71
	72	; (defbinding object-class-find-param-spec () parameter
	73	; (class pointer)
	74	; (name string))
	75
	76	(defun signal-name-to-string (name)
	77	(substitute #\_ #\- (string-downcase (string name))))
	78
	79
	80	(defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
	81	(case (getf initargs :allocation)
	82	(:property (find-class 'direct-property-slot-definition))
174e8a5c	83	(:user-data (find-class 'direct-user-data-slot-definition))
2176a9c7	84	(t (call-next-method))))
	85
	86	(defmethod effective-slot-definition-class ((class gobject-class) &rest initargs)
	87	(case (getf initargs :allocation)
	88	(:property (find-class 'effective-property-slot-definition))
174e8a5c	89	(:user-data (find-class 'effective-user-data-slot-definition))
2176a9c7	90	(t (call-next-method))))
	91
	92	(defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
eeda1c2d	93	(if (typep (first direct-slotds) 'direct-property-slot-definition)
2176a9c7	94	(nconc
	95	(list :pname (signal-name-to-string
	96	(most-specific-slot-value direct-slotds 'pname))
	97	:readable (most-specific-slot-value direct-slotds 'readable)
	98	:writable (most-specific-slot-value direct-slotds 'writable)
	99	:construct (most-specific-slot-value direct-slotds 'construct))
	100	(call-next-method))
	101	(call-next-method)))
	102
	103
	104	(defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition))
	105	(let* ((type (slot-definition-type slotd))
	106	(pname (slot-definition-pname slotd))
	107	(type-number (find-type-number type)))
eeda1c2d	108	(when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
2176a9c7	109	(setf
eeda1c2d	110	(slot-value slotd 'getter)
21299acf	111	(let ((reader nil)) ;(reader-function type)))
eeda1c2d	112	#'(lambda (object)
21299acf	113	(unless reader
21299acf	114	(setq reader (reader-function type)))
eeda1c2d	115	(let ((gvalue (gvalue-new type-number)))
	116	(%object-get-property object pname gvalue)
	117	(unwind-protect
	118	(funcall reader gvalue +gvalue-value-offset+)
	119	(gvalue-free gvalue t)))))))
2176a9c7	120
eeda1c2d	121	(when (and (not (slot-boundp slotd 'setter)) (slot-writable-p slotd))
2176a9c7	122	(setf
eeda1c2d	123	(slot-value slotd 'setter)
21299acf	124	(let ((writer nil)) ;(writer-function type)))
eeda1c2d	125	#'(lambda (value object)
21299acf	126	(unless writer
21299acf	127	(setq writer (writer-function type)))
eeda1c2d	128	(let ((gvalue (gvalue-new type-number)))
	129	(funcall writer value gvalue +gvalue-value-offset+)
	130	(%object-set-property object pname gvalue)
	131	(gvalue-free gvalue t)
	132	value))))))
	133
2176a9c7	134	(call-next-method))
2176a9c7	135
174e8a5c	136	(defmethod initialize-internal-slot-functions ((slotd effective-user-data-slot-definition))
174e8a5c	137	(let ((slot-name (slot-definition-name slotd)))
56870989	138	(unless (slot-boundp slotd 'getter)
	139	(setf
	140	(slot-value slotd 'getter)
	141	#'(lambda (object)
	142	(prog1 (user-data object slot-name)))))
	143	(unless (slot-boundp slotd 'setter)
	144	(setf
	145	(slot-value slotd 'setter)
	146	#'(lambda (value object)
	147	(setf (user-data object slot-name) value))))
	148	(unless (slot-boundp slotd 'boundp)
	149	(setf
	150	(slot-value slotd 'boundp)
	151	#'(lambda (object)
	152	(user-data-p object slot-name)))))
174e8a5c	153	(call-next-method))
174e8a5c	154
2176a9c7	155
	156	;;;; Super class for all classes in the GObject type hierarchy
	157
560af5c5	158	(eval-when (:compile-toplevel :load-toplevel :execute)
c8c48a4c	159	(defclass gobject (ginstance)
560af5c5	160	()
2176a9c7	161	(:metaclass gobject-class)
9adccb27	162	(:alien-name "GObject")))
9adccb27	163
eeda1c2d	164
	165	(defun initial-add (object function initargs key pkey)
	166	(loop
	167	as (initarg value . rest) = initargs then rest
	168	do (cond
	169	((eq initarg key) (funcall function object value))
	170	((eq initarg pkey) (mapc #'(lambda (value)
	171	(funcall function object value))
	172	value)))
	173	while rest))
	174
	175	(defun initial-apply-add (object function initargs key pkey)
	176	(initial-add object #'(lambda (object value)
	177	(apply function object (mklist value)))
	178	initargs key pkey))
	179
	180
82747bbd	181	(defmethod initialize-instance ((object gobject) &rest initargs)
040579dd	182	(unless (slot-boundp object 'location)
	183	;; Extract initargs which we should pass directly to the GObeject
	184	;; constructor
	185	(let* ((slotds (class-slots (class-of object)))
	186	(args (when initargs
	187	(loop
	188	as (key value . rest) = initargs then rest
	189	as slotd = (find-if
	190	#'(lambda (slotd)
	191	(member key (slot-definition-initargs slotd)))
	192	slotds)
	193	when (and (typep slotd 'effective-property-slot-definition)
	194	(slot-value slotd 'construct))
	195	collect (progn
	196	(remf initargs key)
	197	(list
	198	(slot-definition-pname slotd)
	199	(slot-definition-type slotd)
	200	value))
	201	while rest))))
	202	(if args
	203	(let* ((string-size (size-of 'string))
	204	(string-writer (writer-function 'string))
	205	(string-destroy (destroy-function 'string))
	206	(params (allocate-memory
	207	(* (length args) (+ string-size +gvalue-size+)))))
9adccb27	208	(loop
040579dd	209	for (pname type value) in args
9adccb27	210	as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
040579dd	211	do (funcall string-writer pname tmp)
	212	(gvalue-init (sap+ tmp string-size) type value))
	213	(unwind-protect
	214	(setf
	215	(slot-value object 'location)
	216	(%gobject-newv (type-number-of object) (length args) params))
	217	(loop
	218	repeat (length args)
	219	as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
	220	do (funcall string-destroy tmp)
	221	(gvalue-unset (sap+ tmp string-size)))
	222	(deallocate-memory params)))
8755b1a5	223	(setf
8755b1a5	224	(slot-value object 'location)
040579dd	225	(%gobject-new (type-number-of object))))))
8755b1a5	226
4d83a8a6	227	(apply #'call-next-method object initargs))
	228
	229
1dbf4216	230	(defmethod instance-finalizer ((instance gobject))
	231	(let ((location (proxy-location instance)))
	232	#'(lambda ()
	233	(remove-cached-instance location)
1dbf4216	234	(%object-unref location))))
1dbf4216	235
9adccb27	236
d4b21b08	237	(defbinding (%gobject-new "g_object_new") () pointer
a9044181	238	(type type-number)
a9044181	239	(nil null))
560af5c5	240
9adccb27	241	(defbinding (%gobject-newv "g_object_newv") () pointer
4d83a8a6	242	(type type-number)
4d83a8a6	243	(n-parameters unsigned-int)
9adccb27	244	(params pointer))
de8516ca	245
de8516ca	246
d4b21b08	247
323d4265	248	;;;; Property stuff
560af5c5	249
26b133ed	250	(defbinding %object-set-property () nil
c8c48a4c	251	(object gobject)
	252	(name string)
	253	(value gvalue))
86d9d6ab	254
26b133ed	255	(defbinding %object-get-property () nil
c8c48a4c	256	(object gobject)
c8c48a4c	257	(name string)
a9044181	258	(value gvalue))
86d9d6ab	259
26b133ed	260	(defbinding %object-notify () nil
c8c48a4c	261	(object gobject)
c8c48a4c	262	(name string))
86d9d6ab	263
26b133ed	264	(defbinding object-freeze-notify () nil
a9044181	265	(object gobject))
86d9d6ab	266
26b133ed	267	(defbinding object-thaw-notify () nil
a9044181	268	(object gobject))
86d9d6ab	269
a00ba56a	270
	271	;;;; User data
	272
26b133ed	273	(defbinding %object-set-qdata-full () nil
86d9d6ab	274	(object gobject)
	275	(id quark)
	276	(data unsigned-long)
	277	(destroy-marshal pointer))
	278
73572c12	279	(defcallback user-data-destroy-func (nil (id unsigned-int))
	280	(destroy-user-data id))
	281
	282	(export 'user-data-destroy-func)
	283
174e8a5c	284	(defun (setf user-data) (data object key)
a00ba56a	285	(%object-set-qdata-full object (quark-intern key)
73572c12	286	(register-user-data data) (callback user-data-destroy-func))
86d9d6ab	287	data)
86d9d6ab	288
a00ba56a	289	;; deprecated
174e8a5c	290	(defun (setf object-data) (data object key &key (test #'eq))
	291	(assert (eq test #'eq))
	292	(setf (user-data object key) data))
	293
26b133ed	294	(defbinding %object-get-qdata () unsigned-long
86d9d6ab	295	(object gobject)
	296	(id quark))
	297
174e8a5c	298	(defun user-data (object key)
a00ba56a	299	(find-user-data (%object-get-qdata object (quark-intern key))))
174e8a5c	300
a00ba56a	301	;; deprecated
86d9d6ab	302	(defun object-data (object key &key (test #'eq))
174e8a5c	303	(assert (eq test #'eq))
	304	(user-data object key))
	305
	306	(defun user-data-p (object key)
a00ba56a	307	(user-data-exists-p (%object-get-qdata object (quark-intern key))))
	308
	309	(defbinding %object-steal-qdata () unsigned-long
	310	(object gobject)
	311	(id quark))
	312
	313	(defun unset-user-data (object key)
	314	(destroy-user-data (%object-steal-qdata object (quark-intern key))))
86d9d6ab	315
86d9d6ab	316
d4b21b08	317	;;;;
d4b21b08	318
323d4265	319	(defbinding %object-class-list-properties () pointer
d4b21b08	320	(class pointer)
	321	(n-properties unsigned-int :out))
	322
9c03a07c	323
	324	(defun %map-params (params length type inherited-p)
	325	(if inherited-p
9adccb27	326	(map-c-vector 'list #'identity params 'param length)
9c03a07c	327	(let ((properties ()))
9adccb27	328	(map-c-vector 'list
9c03a07c	329	#'(lambda (param)
	330	(when (eql (param-owner-type param) type)
	331	(push param properties)))
	332	params 'param length)
	333	(nreverse properties))))
	334
	335	(defun query-object-class-properties (type &optional inherited-p)
	336	(let* ((type-number (find-type-number type))
	337	(class (type-class-ref type-number)))
	338	(unwind-protect
	339	(multiple-value-bind (array length)
	340	(%object-class-list-properties class)
21299acf	341	(unless (null-pointer-p array)
	342	(unwind-protect
	343	(%map-params array length type-number inherited-p)
	344	(deallocate-memory array))))
9c03a07c	345	; (type-class-unref type-number)
9c03a07c	346	)))
d4b21b08	347
	348
	349	(defun default-slot-name (name)
	350	(intern (substitute #\- #\_ (string-upcase (string-upcase name)))))
	351
	352	(defun default-slot-accessor (class-name slot-name type)
	353	(intern
	354	(format
	355	nil "~A-~A~A" class-name slot-name
4d83a8a6	356	(if (eq type 'boolean) "-P" ""))))
d4b21b08	357
323d4265	358
646466b0	359	(defun slot-definition-from-property (class property &optional slot-name args)
9c03a07c	360	(with-slots (name flags value-type documentation) property
646466b0	361	(let* ((slot-name (or slot-name (default-slot-name name)))
62f12808	362	(slot-type (or (getf args :type) (type-from-number value-type) 'pointer))
9c03a07c	363	(accessor (default-slot-accessor class slot-name slot-type)))
	364
	365	`(,slot-name
	366	:allocation :property :pname ,name
eeda1c2d	367
eeda1c2d	368	,@(cond
ae37d096	369	((find :unbound args) (list :unbound (getf args :unbound))))
9c03a07c	370
	371	;; accessors
	372	,@(cond
	373	((and
	374	(member :writable flags) (member :readable flags)
	375	(not (member :construct-only flags)))
	376	(list :accessor accessor))
	377	((and (member :writable flags) (not (member :construct-only flags)))
	378	(list :writer `(setf ,accessor)))
	379	((member :readable flags)
	380	(list :reader accessor)))
	381
	382	;; readable/writable/construct
	383	,@(when (or (not (member :writable flags))
	384	(member :construct-only flags))
	385	'(:writable nil))
	386	,@(when (not (member :readable flags))
	387	'(:readable nil))
	388	,@(when (or (member :construct flags)
	389	(member :construct-only flags))
	390	'(:construct t))
	391
	392	;; initargs
e5c7586b	393	,@(if (find :initarg args)
	394	(let ((initarg (getf args :initarg)))
	395	(etypecase initarg
	396	(null ())
	397	(symbol `(:initarg ,initarg))))
	398	(when (or (member :construct flags)
	399	(member :construct-only flags)
	400	(member :writable flags))
	401	(list :initarg (intern (string slot-name) "KEYWORD"))))
9c03a07c	402
	403	:type ,slot-type
	404	:documentation ,documentation))))
	405
	406
	407	(defun slot-definitions (class properties slots)
	408	(loop
9c03a07c	409	for property in properties
eeda1c2d	410	as slot = (or
	411	(find (param-name property) slots
	412	:key #'(lambda (slot) (getf (rest slot) :pname))
	413	:test #'string=)
	414	(find (param-name property) slots
	415	:key #'first :test #'string-equal))
	416	do (cond
	417	((not slot)
	418	(push (slot-definition-from-property class property) slots))
	419	((getf (rest slot) :merge)
	420	(setf
	421	(rest slot)
646466b0	422	(rest (slot-definition-from-property class property (first slot) (rest slot)))))))
9c03a07c	423	(delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
	424
	425
62f12808	426	(defun expand-gobject-type (type forward-p options &optional (metaclass 'gobject-class))
9c03a07c	427	(let ((supers (cons (supertype type) (implements type)))
	428	(class (type-from-number type))
	429	(slots (getf options :slots)))
	430	`(defclass ,class ,supers
62f12808	431	,(unless forward-p
62f12808	432	(slot-definitions class (query-object-class-properties type) slots))
9c03a07c	433	(:metaclass ,metaclass)
9c03a07c	434	(:alien-name ,(find-type-name type)))))
323d4265	435
62f12808	436	(defun gobject-dependencies (type)
21299acf	437	(delete-duplicates
	438	(cons
	439	(supertype type)
	440	(append
	441	(type-interfaces type)
	442	(mapcar #'param-value-type (query-object-class-properties type))))))
d4b21b08	443
62f12808	444
62f12808	445	(register-derivable-type 'gobject "GObject" 'expand-gobject-type 'gobject-dependencies)
ae37d096	446
	447
	448	;;; Pseudo type for gobject instances which have their reference count
	449	;;; increased by the returning function
	450
	451	(defmethod alien-type ((type (eql 'referenced)) &rest args)
	452	(declare (ignore type args))
	453	(alien-type 'gobject))
	454
	455	(defmethod from-alien-form (form (type (eql 'referenced)) &rest args)
	456	(declare (ignore type))
	457	(destructuring-bind (type) args
	458	(if (subtypep type 'gobject)
	459	(let ((instance (make-symbol "INSTANCE")))
	460	`(let ((,instance ,(from-alien-form form type)))
	461	(when ,instance
	462	(%object-unref (proxy-location ,instance)))
	463	,instance))
	464	(error "~A is not a subclass of GOBJECT" type))))
	465
	466	(export 'referenced)