glib/gobject.foreign-gobject.lisp

   1 (in-package :gobject)
   2
   3 (defun g-type-from-object (object)
   4   "Returns the GType of an @code{object}
   5
   6 @arg[object]{C pointer to an object}
   7 @return{GType designator (see @class{g-type-designator})}"
   8   (g-type-from-instance object))
   9
  10 (defun g-type-from-class (g-class)
  11   (g-type-name (foreign-slot-value g-class 'g-type-class :type)))
  12
  13 (defun g-type-from-instance (type-instance)
  14   (g-type-from-class (foreign-slot-value type-instance 'g-type-instance :class)))
  15
  16 (defun g-type-from-interface (type-interface)
  17   (g-type-name (foreign-slot-value type-interface 'g-type-interface :type)))
  18
  19 (defclass g-object ()
  20   ((pointer
  21     :type cffi:foreign-pointer
  22     :initarg :pointer
  23     :accessor pointer
  24     :initform nil)
  25    (has-reference
  26     :type boolean
  27     :accessor g-object-has-reference
  28     :initform nil))
  29   (:documentation
  30    "Base class for GObject classes hierarchy."))
  31
  32 (defvar *foreign-gobjects* (make-weak-hash-table :test 'equal :weakness :value))
  33 (defvar *foreign-gobjects-ref-count* (make-hash-table :test 'equal))
  34 (defvar *lisp-objects-pointers* (make-hash-table :test 'equal))
  35 (defvar *current-creating-object* nil)
  36
  37 (defun ref-count (pointer)
  38   (foreign-slot-value (if (pointerp pointer) pointer (pointer pointer)) 'g-object-struct :ref-count))
  39
  40 (defmethod initialize-instance :around ((obj g-object) &key)
  41   (let ((*current-creating-object* obj))
  42     (call-next-method)))
  43
  44 (defmethod initialize-instance :after ((obj g-object) &key &allow-other-keys)
  45   (unless (slot-boundp obj 'pointer)
  46     (error "Pointer slot is not initialized for ~A" obj))
  47   (let* ((pointer (pointer obj))
  48          (s (format nil "~A" obj)))
  49     (finalize obj
  50               (lambda ()
  51                 (handler-case
  52                     (g-object-dispose-carefully pointer)
  53                   (error (e) (format t "Error in finalizer for ~A: ~A~%" s e))))))
  54   (register-g-object obj)
  55   (activate-gc-hooks))
  56
  57 (defvar *gobject-gc-hooks-lock* (make-recursive-lock "gobject-gc-hooks-lock"))
  58 (defvar *gobject-gc-hooks* nil);;pointers to objects to be freed
  59
  60 (defun activate-gc-hooks ()
  61   (with-recursive-lock-held (*gobject-gc-hooks-lock*)
  62     (when *gobject-gc-hooks*
  63       (debugf "activating gc hooks for objects: ~A~%" *gobject-gc-hooks*)
  64       (loop
  65          for pointer in *gobject-gc-hooks*
  66          do (g-object-unref pointer))
  67       (setf *gobject-gc-hooks* nil))))
  68
  69 (defcallback g-idle-gc-hook :boolean ((data :pointer))
  70   (declare (ignore data))
  71   (activate-gc-hooks)
  72   nil)
  73
  74 (defun register-gobject-for-gc (pointer)
  75   (with-recursive-lock-held (*gobject-gc-hooks-lock*)
  76     (let ((locks-were-present (not (null *gobject-gc-hooks*))))
  77       (push pointer *gobject-gc-hooks*)
  78       (unless locks-were-present
  79         (debugf "adding idle-gc-hook to main loop~%")
  80         (glib::g-idle-add (callback g-idle-gc-hook) (null-pointer))))))
  81
  82 (defun g-object-dispose-carefully (pointer)
  83   (handler-case
  84       (register-gobject-for-gc pointer)
  85     (error (e) (format t "Error in dispose: ~A~%" e))))
  86
  87 (defcallback weak-notify-print :void ((data :pointer) (object-pointer :pointer))
  88   (declare (ignore data))
  89   (debugf "g-object has finalized ~A ~A~%" (g-type-name (g-type-from-object object-pointer)) object-pointer))
  90
  91 (defun erase-pointer (data object-pointer)
  92   (declare (ignore data))
  93   (remhash (pointer-address object-pointer) *lisp-objects-pointers*))
  94
  95 (defcallback weak-notify-erase-pointer :void ((data :pointer) (object-pointer :pointer))
  96   (erase-pointer data object-pointer))
  97
  98 (defun should-ref-sink-at-creation (object)
  99 ;;If object was not created from lisp-side, we should ref it
 100 ;;If an object is regular g-object, we should not ref-sink it
 101 ;;If an object is GInitiallyUnowned, then it is created with a floating reference, we should ref-sink it
 102 ;;A special case is GtkWindow: we should ref-sink it anyway
 103   (if (g-object-has-reference object)
 104       (let ((object-type (g-type-from-object (pointer object)))
 105             (initially-unowned-type (g-type-from-name "GInitiallyUnowned")))
 106         (g-type-is-a object-type initially-unowned-type))
 107       t))
 108
 109 (defun register-g-object (obj)
 110   (debugf "registered GObject ~A with gobject ref-count ~A ~A~%" (pointer obj) (ref-count obj) (if (g-object-is-floating (pointer obj)) "(floating)" ""))
 111   (when (should-ref-sink-at-creation obj)
 112     (debugf "g_object_ref_sink(~A)~%" (pointer obj))
 113     (g-object-ref-sink (pointer obj)))
 114   (g-object-weak-ref (pointer obj) (callback weak-notify-print) (null-pointer))
 115   (g-object-weak-ref (pointer obj) (callback weak-notify-erase-pointer) (null-pointer))
 116   (setf (g-object-has-reference obj) t)
 117   (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects*)
 118         obj)
 119   (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects-ref-count*) 1))
 120
 121 (defun g-object-dispose (pointer)
 122   (unless (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
 123     (debugf "GObject ~A is already disposed, signalling error~%" pointer)
 124     (error "GObject ~A is already disposed" pointer))
 125   (debugf "g_object_unref(~A) (of type ~A, lisp-value ~A) (lisp ref-count ~A, gobject ref-count ~A)~%"
 126           pointer
 127           (g-type-name (g-type-from-object pointer))
 128           (gethash (pointer-address pointer) *foreign-gobjects*)
 129           (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
 130           (ref-count pointer))
 131   (let ((object (gethash (pointer-address pointer) *foreign-gobjects*)))
 132     (when object
 133       (setf (pointer object) nil)
 134       (cancel-finalization object)))
 135   (remhash (pointer-address pointer) *foreign-gobjects*)
 136   (remhash (pointer-address pointer) *foreign-gobjects-ref-count*)
 137   (g-object-unref pointer))
 138
 139 (defmethod release ((object g-object))
 140   (debugf "Releasing object ~A (type ~A, lisp-value ~A)~%" (pointer object) (when (pointer object) (g-type-name (g-type-from-object (pointer object)))) object)
 141   (unless (and (pointer object) (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
 142     (error "Object ~A already disposed of from lisp side" object))
 143   (decf (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
 144   (when (zerop (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
 145     (g-object-dispose (pointer object)))
 146   (activate-gc-hooks))
 147
 148 (defvar *registered-object-types* (make-hash-table :test 'equal))
 149 (defun register-object-type (name type)
 150   (setf (gethash name *registered-object-types*) type))
 151 (defun registered-object-type-by-name (name)
 152   (gethash name *registered-object-types*))
 153 (defun get-g-object-lisp-type (g-type)
 154   (setf g-type (ensure-g-type g-type))
 155   (loop
 156      while (not (zerop g-type))
 157      for lisp-type = (gethash (g-type-name g-type) *registered-object-types*)
 158      when lisp-type do (return lisp-type)
 159      do (setf g-type (ensure-g-type (g-type-parent g-type)))))
 160
 161 (defun make-g-object-from-pointer (pointer)
 162   (let* ((g-type (g-type-from-instance pointer))
 163          (lisp-type (get-g-object-lisp-type g-type)))
 164     (unless lisp-type
 165       (error "Type ~A is not registered with REGISTER-OBJECT-TYPE"
 166              (g-type-name g-type)))
 167     (g-object-ref pointer)
 168     (make-instance lisp-type :pointer pointer)))
 169
 170 (define-foreign-type foreign-g-object-type ()
 171   ((sub-type :reader sub-type :initarg :sub-type :initform 'g-object))
 172   (:actual-type :pointer))
 173
 174 (define-parse-method g-object (&optional (sub-type 'g-object))
 175   (make-instance 'foreign-g-object-type :sub-type sub-type))
 176
 177 (defmethod translate-to-foreign (object (type foreign-g-object-type))
 178   (cond
 179     ((null object)
 180      (null-pointer))
 181     ((pointerp object) object)
 182     ((null (pointer object))
 183      (error "Object ~A has been disposed" object))
 184     ((typep object 'g-object)
 185      (assert (typep object (sub-type type))
 186              nil
 187              "Object ~A is not a subtype of ~A" object (sub-type type))
 188      (pointer object))
 189     (t (error "Object ~A is not translatable as GObject*" object))))
 190
 191 (defun get-g-object-for-pointer (pointer)
 192   (unless (null-pointer-p pointer)
 193     (let ((object (gethash (pointer-address pointer) *foreign-gobjects*)))
 194       (if object
 195           (prog1 object
 196             (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
 197             (debugf "increfering object ~A~%" pointer))
 198           (make-g-object-from-pointer pointer)))))
 199
 200 (defmethod translate-from-foreign (pointer (type foreign-g-object-type))
 201   (get-g-object-for-pointer pointer))
 202
 203 (register-object-type "GObject" 'g-object)
 204
 205 (defun ensure-g-type (type)
 206   "Returns the GType value for a given type. If type is an integer, it is returned. If type is a string, GType corresponding to this type name is looked up and returned.
 207 @arg[type]{a string or and integer}
 208 @return{integer equal to GType of @code{type}}"
 209   (etypecase type
 210     (integer type)
 211     (string (or (g-type-from-name type)
 212                 (error "Type ~A is invalid" type)))))
 213
 214 (defun ensure-object-pointer (object)
 215   (if (pointerp object)
 216       object
 217       (etypecase object
 218         (g-object (pointer object)))))
 219
 220 (define-condition property-access-error (error)
 221   ((property-name :initarg :property-name :reader property-access-error-property-name)
 222    (class-name :initarg :class-name :reader property-access-error-class-name)
 223    (message :initarg :message :reader property-access-error-message))
 224   (:report (lambda (condition stream)
 225              (format stream "Error accessing property '~A' on class '~A': ~A"
 226                      (property-access-error-property-name condition)
 227                      (property-access-error-class-name condition)
 228                      (property-access-error-message condition)))))
 229
 230 (define-condition property-unreadable-error (property-access-error)
 231   ()
 232   (:default-initargs :message "property is not readable"))
 233
 234 (define-condition property-unwritable-error (property-access-error)
 235   ()
 236   (:default-initargs :message "property is not writable"))
 237
 238 (defun g-param-spec-property-type (param-spec property-name object-type assert-readable assert-writable)
 239   (when (null-pointer-p param-spec)
 240            (error "Property ~A on type ~A is not found"
 241                   property-name
 242                   (g-type-name object-type)))
 243   (when (and assert-readable
 244              (not (member :readable
 245                           (foreign-slot-value param-spec
 246                                               'g-param-spec
 247                                               :flags))))
 248     (error 'property-unreadable-error
 249            :property-name property-name
 250            :class-name (g-type-name object-type)))
 251   (when (and assert-writable
 252              (not (member :writable
 253                           (foreign-slot-value param-spec
 254                                               'g-param-spec
 255                                               :flags))))
 256     (error 'property-unwritable-error
 257            :property-name property-name
 258            :class-name (g-type-name object-type)))
 259   (foreign-slot-value param-spec 'g-param-spec :value-type))
 260
 261 (defun g-object-type-property-type (object-type property-name
 262                                     &key assert-readable assert-writable)
 263   (let* ((object-class (g-type-class-ref object-type))
 264          (param-spec (g-object-class-find-property object-class property-name)))
 265     (unwind-protect
 266          (g-param-spec-property-type param-spec property-name object-type assert-readable assert-writable)
 267       (g-type-class-unref object-class))))
 268
 269 (defun g-object-property-type (object property-name
 270                                &key assert-readable assert-writable)
 271   (g-object-type-property-type (g-type-from-object (ensure-object-pointer object))
 272                                property-name
 273                                :assert-readable assert-readable
 274                                :assert-writable assert-writable))
 275
 276 (defun g-object-call-constructor (object-type args-names args-values
 277                                   &optional args-types)
 278   (unless args-types
 279     (setf args-types
 280           (mapcar (lambda (name)
 281                     (g-object-type-property-type object-type name))
 282                   args-names)))
 283   (let ((args-count (length args-names)))
 284     (with-foreign-object (parameters 'g-parameter args-count)
 285       (loop
 286          for i from 0 below args-count
 287          for arg-name in args-names
 288          for arg-value in args-values
 289          for arg-type in args-types
 290          for arg-g-type = (if arg-type (ensure-g-type arg-type) (g-object-type-property-type object-type arg-name))
 291          for parameter = (mem-aref parameters 'g-parameter i)
 292          do (setf (foreign-slot-value parameter 'g-parameter :name) arg-name)
 293          do (set-g-value (foreign-slot-value parameter 'g-parameter :value)
 294                          arg-value arg-g-type
 295                          :zero-g-value t))
 296       (unwind-protect
 297            (g-object-newv object-type args-count parameters)
 298         (loop
 299            for i from 0 below args-count
 300            for parameter = (mem-aref parameters 'g-parameter i)
 301            do (foreign-free (mem-ref (foreign-slot-pointer parameter 'g-parameter :name) :pointer))
 302            do (g-value-unset (foreign-slot-pointer parameter 'g-parameter :value)))))))
 303
 304 (defun g-object-call-get-property (object property-name &optional property-type)
 305   (restart-case
 306       (unless property-type
 307         (setf property-type
 308               (g-object-property-type object property-name :assert-readable t)))
 309     (return-nil () (return-from g-object-call-get-property nil)))
 310   (setf property-type (ensure-g-type property-type))
 311   (with-foreign-object (value 'g-value)
 312     (g-value-zero value)
 313     (g-value-init value property-type)
 314     (g-object-get-property (ensure-object-pointer object)
 315                            property-name value)
 316     (unwind-protect
 317          (parse-gvalue value)
 318       (g-value-unset value))))
 319
 320 (defun g-object-call-set-property (object property-name new-value
 321                                    &optional property-type)
 322   (unless property-type
 323     (setf property-type
 324           (g-object-property-type object property-name :assert-writable t)))
 325   (setf property-type (ensure-g-type property-type))
 326   (with-foreign-object (value 'g-value)
 327     (set-g-value value new-value property-type :zero-g-value t)
 328     (unwind-protect
 329          (g-object-set-property (ensure-object-pointer object)
 330                                 property-name value)
 331       (g-value-unset value))))
 332
 333 (defmethod parse-gvalue-for-type (gvalue-ptr (type-numeric (eql +g-type-object+)))
 334   (parse-gvalue-object gvalue-ptr))
 335
 336 (defmethod parse-gvalue-for-type (gvalue-ptr (type-numeric (eql +g-type-interface+)))
 337   (parse-gvalue-object gvalue-ptr))
 338
 339 (defmethod set-gvalue-for-type (gvalue-ptr (type-numeric (eql +g-type-object+)) value)
 340   (set-gvalue-object gvalue-ptr value))
 341
 342 (defmethod set-gvalue-for-type (gvalue-ptr (type-numeric (eql +g-type-interface+)) value)
 343   (set-gvalue-object gvalue-ptr value))
 344
 345 (defun g-signal-connect (object signal handler &key after)
 346   "Deprecated alias for @fun{connect-signal}"
 347   (connect-signal object signal handler :after after))
 348
 349 (defun connect-signal (object signal handler &key after)
 350   "Connects the function to a signal for a particular object.
 351 If @code{after} is true, then the function will be called after the default handler of the signal.
 352
 353 @arg[object]{an instance of @class{gobject}}
 354 @arg[signal]{a string; names the signal}
 355 @arg[handler]{a function; handles the signal. Number (and type) of arguments and return value type depends on the signal}
 356 @arg[after]{a boolean}"
 357   (g-signal-connect-closure (ensure-object-pointer object)
 358                             signal
 359                             (create-g-closure handler)
 360                             after))
 361
 362 (defun emit-signal (object signal-name &rest args)
 363   "Emits the signal.
 364 @arg[object]{an instance of @class{g-object}. Signal is emitted on this object}
 365 @arg[signal-name]{a string specifying the signal}
 366 @arg[args]{arguments for the signal}
 367 @return{none}"
 368   (let* ((object-type (g-type-from-object (pointer object)))
 369          (signal-info (parse-signal-name object-type signal-name)))
 370     (unless signal-info
 371       (error "Signal ~A not found on object ~A" signal-name object))
 372     (let ((params-count (length (signal-info-param-types signal-info))))
 373       (with-foreign-object (params 'g-value (1+ params-count))
 374         (set-g-value (mem-aref params 'g-value 0) object object-type :zero-g-value t)
 375         (iter (for i from 0 below params-count)
 376               (for arg in args)
 377               (for type in (signal-info-param-types signal-info))
 378               (set-g-value (mem-aref params 'g-value (1+ i)) arg type :zero-g-value t))
 379         (prog1
 380             (if (= (g-type-numeric (signal-info-return-type signal-info)) +g-type-void+)
 381                 (g-signal-emitv params (signal-info-id signal-info) signal-name (null-pointer))
 382                 (with-foreign-object (return-value 'g-value)
 383                   (g-value-zero return-value)
 384                   (g-value-init return-value (signal-info-return-type signal-info))
 385                   (prog1 (parse-gvalue return-value)
 386                     (g-value-unset return-value))))
 387           (iter (for i from 0 below (1+ params-count))
 388                 (g-value-unset (mem-aref params 'g-value i))))))))