glib/gobject.foreign-gobject.lisp

   1 (in-package :gobject)
   2
   3 (defclass g-object ()
   4   ((pointer
   5     :type cffi:foreign-pointer
   6     :initarg :pointer
   7     :accessor pointer
   8     :initform nil)
   9    (has-reference
  10     :type boolean
  11     :accessor g-object-has-reference
  12     :initform nil)))
  13
  14 (defvar *foreign-gobjects* (make-weak-hash-table :test 'equal :weakness :value))
  15 (defvar *foreign-gobjects-ref-count* (make-hash-table :test 'equal))
  16
  17 (defcstruct g-object-struct
  18   (type-instance g-type-instance)
  19   (ref-count :uint)
  20   (qdata :pointer))
  21
  22 (defun ref-count (pointer)
  23   (foreign-slot-value (if (pointerp pointer) pointer (pointer pointer)) 'g-object-struct 'ref-count))
  24
  25 (defmethod initialize-instance :after ((obj g-object) &key &allow-other-keys)
  26   (unless (slot-boundp obj 'pointer)
  27     (error "Pointer slot is not initialized for ~A" obj))
  28   (let ((pointer (pointer obj)))
  29     #+ (or) (finalize obj
  30               (lambda ()
  31                 (g-object-dispose pointer))))
  32   (register-g-object obj))
  33
  34 (defcallback weak-notify-print :void ((data :pointer) (object-pointer :pointer))
  35   (debugf "g-object has disposed ~A ~A~%" (g-type-name (g-type-from-object object-pointer)) object-pointer))
  36
  37 (defun register-g-object (obj)
  38   (debugf "registered GObject ~A with ref-count ~A~%" (pointer obj) (ref-count obj))
  39   (when (or t ;; Do not understand
  40             (not (g-object-has-reference obj))
  41             (g-object-is-floating (pointer obj)))
  42     (debugf "g_object_ref_sink(~A)~%" (pointer obj))
  43     (g-object-ref-sink (pointer obj)))
  44   (g-object-weak-ref (pointer obj) (callback weak-notify-print) (null-pointer))
  45   (setf (g-object-has-reference obj) t)
  46   (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects*)
  47         obj)
  48   (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects-ref-count*) 1))
  49
  50 (defun g-object-dispose (pointer)
  51   (debugf "g_object_unref(~A) (of type ~A, lisp-value ~A) (lisp ref-count ~A, gobject ref-count ~A)~%"
  52           pointer
  53           (g-type-name (g-type-from-object pointer))
  54           (gethash (pointer-address pointer) *foreign-gobjects*)
  55           (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
  56           (ref-count pointer))
  57   (awhen (gethash (pointer-address pointer) *foreign-gobjects*)
  58     (setf (pointer it) nil)
  59     (cancel-finalization it))
  60   (remhash (pointer-address pointer) *foreign-gobjects*)
  61   (remhash (pointer-address pointer) *foreign-gobjects-ref-count*)
  62   (g-object-unref pointer))
  63
  64 (defmethod release ((object g-object))
  65   (debugf "Releasing object ~A (type ~A, lisp-value ~A)~%" (pointer object) (when (pointer object) (g-type-name (g-type-from-object (pointer object)))) object)
  66   (unless (and (pointer object) (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
  67     (error "Object ~A already disposed of from lisp side" object))
  68   (decf (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
  69   (when (zerop (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
  70     (g-object-dispose (pointer object))))
  71
  72 (defvar *registered-object-types* (make-hash-table :test 'equal))
  73 (defun register-object-type (name type)
  74   (setf (gethash name *registered-object-types*) type))
  75 (defun get-g-object-lisp-type (g-type)
  76   (loop
  77      while (not (zerop g-type))
  78      for lisp-type = (gethash (g-type-name g-type) *registered-object-types*)
  79      when lisp-type do (return lisp-type)
  80      do (setf g-type (g-type-parent g-type))))
  81
  82 (defun make-g-object-from-pointer (pointer)
  83   (let* ((g-type (g-type-from-instance pointer))
  84          (lisp-type (get-g-object-lisp-type g-type)))
  85     (unless lisp-type
  86       (error "Type ~A is not registered with REGISTER-OBJECT-TYPE"
  87              (g-type-name g-type)))
  88     (make-instance lisp-type :pointer pointer)))
  89
  90 (define-foreign-type foreign-g-object-type ()
  91   ((sub-type :reader sub-type :initarg :sub-type :initform 'g-object))
  92   (:actual-type :pointer))
  93
  94 (define-parse-method g-object (&optional (sub-type 'g-object))
  95   (make-instance 'foreign-g-object-type :sub-type sub-type))
  96
  97 (defmethod translate-to-foreign (object (type foreign-g-object-type))
  98   (cond
  99     ((null (pointer object))
 100      (error "Object ~A has been disposed" object))
 101     ((typep object 'g-object)
 102      (assert (typep object (sub-type type))
 103              nil
 104              "Object ~A is not a subtype of ~A" object (sub-type type))
 105      (pointer object))
 106     ((pointerp object) object)
 107     (t (error "Object ~A is not translatable as GObject*" object))))
 108
 109 (defun get-g-object-for-pointer (pointer)
 110   (unless (null-pointer-p pointer)
 111     (aif (gethash (pointer-address pointer) *foreign-gobjects*)
 112          (prog1 it
 113            (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
 114            (debugf "increfering object ~A~%" pointer))
 115          (make-g-object-from-pointer pointer))))
 116
 117 (defmethod translate-from-foreign (pointer (type foreign-g-object-type))
 118   (get-g-object-for-pointer pointer))
 119
 120 (register-object-type "GObject" 'g-object)
 121
 122 (defun ensure-g-type (type)
 123   (etypecase type
 124     (integer type)
 125     (string (or (g-type-from-name type)
 126                 (error "Type ~A is invalid" type)))))
 127
 128 (defun ensure-object-pointer (object)
 129   (if (pointerp object)
 130       object
 131       (etypecase object
 132         (g-object (pointer object)))))
 133
 134 (defun g-object-type-property-type (object-type property-name
 135                                     &key assert-readable assert-writable)
 136   (let* ((object-class (g-type-class-ref object-type))
 137          (param-spec (g-object-class-find-property object-class property-name)))
 138     (unwind-protect
 139          (progn
 140            (when (null-pointer-p param-spec)
 141              (error "Property ~A on type ~A is not found"
 142                     property-name
 143                     (g-type-name object-type)))
 144            (when (and assert-readable
 145                       (not (member :readable
 146                                    (foreign-slot-value param-spec
 147                                                        'g-param-spec
 148                                                        'flags))))
 149              (error "Property ~A on type ~A is not readable"
 150                     property-name
 151                     (g-type-name object-type)))
 152            (when (and assert-writable
 153                       (not (member :writable
 154                                    (foreign-slot-value param-spec
 155                                                        'g-param-spec
 156                                                        'flags))))
 157              (error "Property ~A on type ~A is not writable"
 158                     property-name
 159                     (g-type-name object-type)))
 160            (foreign-slot-value param-spec 'g-param-spec 'value-type))
 161       (g-type-class-unref object-class))))
 162
 163 (defun g-object-property-type (object property-name
 164                                &key assert-readable assert-writable)
 165   (g-object-type-property-type (g-type-from-object (ensure-object-pointer object))
 166                                property-name
 167                                :assert-readable assert-readable
 168                                :assert-writable assert-writable))
 169
 170 (defun g-object-call-constructor (object-type args-names args-values
 171                                   &optional args-types)
 172   (setf object-type (ensure-g-type object-type))
 173   (unless args-types
 174     (setf args-types
 175           (mapcar (lambda (name)
 176                     (g-object-type-property-type object-type name))
 177                   args-names)))
 178   (let ((args-count (length args-names)))
 179     (with-foreign-object (parameters 'g-parameter args-count)
 180       (loop
 181          for i from 0 below args-count
 182          for arg-name in args-names
 183          for arg-value in args-values
 184          for arg-type in args-types
 185          for arg-g-type = (ensure-g-type arg-type)
 186          for parameter = (mem-aref parameters 'g-parameter i)
 187          do (setf (foreign-slot-value parameter 'g-parameter 'name) arg-name)
 188          do (set-g-value (foreign-slot-value parameter 'g-parameter 'value)
 189                          arg-value arg-g-type
 190                          :zero-g-value t))
 191       (unwind-protect
 192            (g-object-newv object-type args-count parameters)
 193         (loop
 194            for i from 0 below args-count
 195            for parameter = (mem-aref parameters 'g-parameter i)
 196            do (foreign-free
 197                (mem-ref (foreign-slot-pointer parameter 'g-parameter 'name)
 198                         :pointer))
 199            do (g-value-unset
 200                (foreign-slot-pointer parameter 'g-parameter 'value)))))))
 201
 202 (defun g-object-call-get-property (object property-name &optional property-type)
 203   (unless property-type
 204     (setf property-type
 205           (g-object-property-type object property-name :assert-readable t)))
 206   (setf property-type (ensure-g-type property-type))
 207   (with-foreign-object (value 'g-value)
 208     (g-value-zero value)
 209     (g-value-init value property-type)
 210     (g-object-get-property (ensure-object-pointer object)
 211                            property-name value)
 212     (unwind-protect
 213          (parse-gvalue value)
 214       (g-value-unset value))))
 215
 216 (defun g-object-call-set-property (object property-name new-value
 217                                    &optional property-type)
 218   (unless property-type
 219     (setf property-type
 220           (g-object-property-type object property-name :assert-writable t)))
 221   (setf property-type (ensure-g-type property-type))
 222   (with-foreign-object (value 'g-value)
 223     (set-g-value value new-value property-type :zero-g-value t)
 224     (unwind-protect
 225          (g-object-set-property (ensure-object-pointer object)
 226                                 property-name value)
 227       (g-value-unset value))))