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 (defvar *current-creating-object* nil)
  17
  18 (defcstruct g-object-struct
  19   (type-instance g-type-instance)
  20   (ref-count :uint)
  21   (qdata :pointer))
  22
  23 (defun ref-count (pointer)
  24   (foreign-slot-value (if (pointerp pointer) pointer (pointer pointer)) 'g-object-struct 'ref-count))
  25
  26 (defmethod initialize-instance :around ((obj g-object) &key)
  27   (let ((*current-creating-object* obj))
  28     (call-next-method)))
  29
  30 (defmethod initialize-instance :after ((obj g-object) &key &allow-other-keys)
  31   (unless (slot-boundp obj 'pointer)
  32     (error "Pointer slot is not initialized for ~A" obj))
  33   (let* ((pointer (pointer obj))
  34          (s (format nil "~A" obj)))
  35     (finalize obj
  36               (lambda ()
  37                 (handler-case
  38                     (g-object-dispose-carefully pointer)
  39                   (error (e) (format t "Error in finalizer for ~A: ~A~%" s e))))))
  40   (register-g-object obj)
  41   (activate-gc-hooks))
  42
  43 (defvar *gobject-gc-hooks-lock* (make-recursive-lock "gobject-gc-hooks-lock"))
  44 (defvar *gobject-gc-hooks* nil);;pointers to objects to be freed
  45
  46 (defun activate-gc-hooks ()
  47   (with-recursive-lock-held (*gobject-gc-hooks-lock*)
  48     (when *gobject-gc-hooks*
  49       (debugf "activating gc hooks for objects: ~A~%" *gobject-gc-hooks*)
  50       (loop
  51          for pointer in *gobject-gc-hooks*
  52          do (g-object-unref pointer))
  53       (setf *gobject-gc-hooks* nil))))
  54
  55 (defcallback g-idle-gc-hook :boolean ((data :pointer))
  56   (declare (ignore data))
  57   (activate-gc-hooks)
  58   nil)
  59
  60 (defun register-gobject-for-gc (pointer)
  61   (with-recursive-lock-held (*gobject-gc-hooks-lock*)
  62     (let ((locks-were-present (not (null *gobject-gc-hooks*))))
  63       (push pointer *gobject-gc-hooks*)
  64       (unless locks-were-present
  65         (debugf "adding idle-gc-hook to main loop~%")
  66         (glib::g-idle-add (callback g-idle-gc-hook) (null-pointer))))))
  67
  68 (defun g-object-dispose-carefully (pointer)
  69   (handler-case
  70       (register-gobject-for-gc pointer)
  71     (error (e) (format t "Error in dispose: ~A~%" e))))
  72
  73 (defcallback weak-notify-print :void ((data :pointer) (object-pointer :pointer))
  74   (declare (ignore data))
  75   (debugf "g-object has finalized ~A ~A~%" (g-type-name (g-type-from-object object-pointer)) object-pointer))
  76
  77 (defun should-ref-sink-at-creation (object)
  78 ;;If object was not created from lisp-side, we should ref it
  79 ;;If an object is regular g-object, we should not ref-sink it
  80 ;;If an object is GInitiallyUnowned, then it is created with a floating reference, we should ref-sink it
  81 ;;A special case is GtkWindow: we should ref-sink it anyway
  82   (if (g-object-has-reference object)
  83       (let ((object-type (g-type-from-object (pointer object)))
  84             (initially-unowned-type (g-type-from-name "GInitiallyUnowned")))
  85         (g-type-is-a object-type initially-unowned-type))
  86       t))
  87
  88 (defun register-g-object (obj)
  89   (debugf "registered GObject ~A with gobject ref-count ~A ~A~%" (pointer obj) (ref-count obj) (if (g-object-is-floating (pointer obj)) "(floating)" ""))
  90   (when (should-ref-sink-at-creation obj)
  91     (debugf "g_object_ref_sink(~A)~%" (pointer obj))
  92     (g-object-ref-sink (pointer obj)))
  93   (g-object-weak-ref (pointer obj) (callback weak-notify-print) (null-pointer))
  94   (setf (g-object-has-reference obj) t)
  95   (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects*)
  96         obj)
  97   (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects-ref-count*) 1))
  98
  99 (defun g-object-dispose (pointer)
 100   (unless (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
 101     (format t "GObject ~A is already disposed, signalling error~%" pointer)
 102     (error "GObject ~A is already disposed" pointer))
 103   (debugf "g_object_unref(~A) (of type ~A, lisp-value ~A) (lisp ref-count ~A, gobject ref-count ~A)~%"
 104           pointer
 105           (g-type-name (g-type-from-object pointer))
 106           (gethash (pointer-address pointer) *foreign-gobjects*)
 107           (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
 108           (ref-count pointer))
 109   (awhen (gethash (pointer-address pointer) *foreign-gobjects*)
 110     (setf (pointer it) nil)
 111     (cancel-finalization it))
 112   (remhash (pointer-address pointer) *foreign-gobjects*)
 113   (remhash (pointer-address pointer) *foreign-gobjects-ref-count*)
 114   (g-object-unref pointer))
 115
 116 (defmethod release ((object g-object))
 117   (debugf "Releasing object ~A (type ~A, lisp-value ~A)~%" (pointer object) (when (pointer object) (g-type-name (g-type-from-object (pointer object)))) object)
 118   (unless (and (pointer object) (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
 119     (error "Object ~A already disposed of from lisp side" object))
 120   (decf (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
 121   (when (zerop (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
 122     (g-object-dispose (pointer object)))
 123   (activate-gc-hooks))
 124
 125 (defvar *registered-object-types* (make-hash-table :test 'equal))
 126 (defun register-object-type (name type)
 127   (setf (gethash name *registered-object-types*) type))
 128 (defun get-g-object-lisp-type (g-type)
 129   (loop
 130      while (not (zerop g-type))
 131      for lisp-type = (gethash (g-type-name g-type) *registered-object-types*)
 132      when lisp-type do (return lisp-type)
 133      do (setf g-type (g-type-parent g-type))))
 134
 135 (defun make-g-object-from-pointer (pointer)
 136   (let* ((g-type (g-type-from-instance pointer))
 137          (lisp-type (get-g-object-lisp-type g-type)))
 138     (unless lisp-type
 139       (error "Type ~A is not registered with REGISTER-OBJECT-TYPE"
 140              (g-type-name g-type)))
 141     (make-instance lisp-type :pointer pointer)))
 142
 143 (define-foreign-type foreign-g-object-type ()
 144   ((sub-type :reader sub-type :initarg :sub-type :initform 'g-object))
 145   (:actual-type :pointer))
 146
 147 (define-parse-method g-object (&optional (sub-type 'g-object))
 148   (make-instance 'foreign-g-object-type :sub-type sub-type))
 149
 150 (defmethod translate-to-foreign (object (type foreign-g-object-type))
 151   (cond
 152     ((null (pointer object))
 153      (error "Object ~A has been disposed" object))
 154     ((typep object 'g-object)
 155      (assert (typep object (sub-type type))
 156              nil
 157              "Object ~A is not a subtype of ~A" object (sub-type type))
 158      (pointer object))
 159     ((pointerp object) object)
 160     (t (error "Object ~A is not translatable as GObject*" object))))
 161
 162 (defun get-g-object-for-pointer (pointer)
 163   (unless (null-pointer-p pointer)
 164     (aif (gethash (pointer-address pointer) *foreign-gobjects*)
 165          (prog1 it
 166            (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
 167            (debugf "increfering object ~A~%" pointer))
 168          (make-g-object-from-pointer pointer))))
 169
 170 (defmethod translate-from-foreign (pointer (type foreign-g-object-type))
 171   (get-g-object-for-pointer pointer))
 172
 173 (register-object-type "GObject" 'g-object)
 174
 175 (defun ensure-g-type (type)
 176   (etypecase type
 177     (integer type)
 178     (string (or (g-type-from-name type)
 179                 (error "Type ~A is invalid" type)))))
 180
 181 (defun ensure-object-pointer (object)
 182   (if (pointerp object)
 183       object
 184       (etypecase object
 185         (g-object (pointer object)))))
 186
 187 (defun g-object-type-property-type (object-type property-name
 188                                     &key assert-readable assert-writable)
 189   (let* ((object-class (g-type-class-ref object-type))
 190          (param-spec (g-object-class-find-property object-class property-name)))
 191     (unwind-protect
 192          (progn
 193            (when (null-pointer-p param-spec)
 194              (error "Property ~A on type ~A is not found"
 195                     property-name
 196                     (g-type-name object-type)))
 197            (when (and assert-readable
 198                       (not (member :readable
 199                                    (foreign-slot-value param-spec
 200                                                        'g-param-spec
 201                                                        'flags))))
 202              (error "Property ~A on type ~A is not readable"
 203                     property-name
 204                     (g-type-name object-type)))
 205            (when (and assert-writable
 206                       (not (member :writable
 207                                    (foreign-slot-value param-spec
 208                                                        'g-param-spec
 209                                                        'flags))))
 210              (error "Property ~A on type ~A is not writable"
 211                     property-name
 212                     (g-type-name object-type)))
 213            (foreign-slot-value param-spec 'g-param-spec 'value-type))
 214       (g-type-class-unref object-class))))
 215
 216 (defun g-object-property-type (object property-name
 217                                &key assert-readable assert-writable)
 218   (g-object-type-property-type (g-type-from-object (ensure-object-pointer object))
 219                                property-name
 220                                :assert-readable assert-readable
 221                                :assert-writable assert-writable))
 222
 223 (defun g-object-call-constructor (object-type args-names args-values
 224                                   &optional args-types)
 225   (setf object-type (ensure-g-type object-type))
 226   (unless args-types
 227     (setf args-types
 228           (mapcar (lambda (name)
 229                     (g-object-type-property-type object-type name))
 230                   args-names)))
 231   (let ((args-count (length args-names)))
 232     (with-foreign-object (parameters 'g-parameter args-count)
 233       (loop
 234          for i from 0 below args-count
 235          for arg-name in args-names
 236          for arg-value in args-values
 237          for arg-type in args-types
 238          for arg-g-type = (ensure-g-type arg-type)
 239          for parameter = (mem-aref parameters 'g-parameter i)
 240          do (setf (foreign-slot-value parameter 'g-parameter 'name) arg-name)
 241          do (set-g-value (foreign-slot-value parameter 'g-parameter 'value)
 242                          arg-value arg-g-type
 243                          :zero-g-value t))
 244       (unwind-protect
 245            (g-object-newv object-type args-count parameters)
 246         (loop
 247            for i from 0 below args-count
 248            for parameter = (mem-aref parameters 'g-parameter i)
 249            do (foreign-free
 250                (mem-ref (foreign-slot-pointer parameter 'g-parameter 'name)
 251                         :pointer))
 252            do (g-value-unset
 253                (foreign-slot-pointer parameter 'g-parameter 'value)))))))
 254
 255 (defun g-object-call-get-property (object property-name &optional property-type)
 256   (unless property-type
 257     (setf property-type
 258           (g-object-property-type object property-name :assert-readable t)))
 259   (setf property-type (ensure-g-type property-type))
 260   (with-foreign-object (value 'g-value)
 261     (g-value-zero value)
 262     (g-value-init value property-type)
 263     (g-object-get-property (ensure-object-pointer object)
 264                            property-name value)
 265     (unwind-protect
 266          (parse-gvalue value)
 267       (g-value-unset value))))
 268
 269 (defun g-object-call-set-property (object property-name new-value
 270                                    &optional property-type)
 271   (unless property-type
 272     (setf property-type
 273           (g-object-property-type object property-name :assert-writable t)))
 274   (setf property-type (ensure-g-type property-type))
 275   (with-foreign-object (value 'g-value)
 276     (set-g-value value new-value property-type :zero-g-value t)
 277     (unwind-protect
 278          (g-object-set-property (ensure-object-pointer object)
 279                                 property-name value)
 280       (g-value-unset value))))