Added some docstrings and changed exports

[cl-gtk2.git] / glib / gobject.foreign-gobject.lisp

diff --git a/glib/gobject.foreign-gobject.lisp b/glib/gobject.foreign-gobject.lisp
index d02bea8..2e64dd1 100644 (file)
--- a/glib/gobject.foreign-gobject.lisp
+++ b/glib/gobject.foreign-gobject.lisp
@@ -9,7 +9,9 @@
    (has-reference
     :type boolean
     :accessor g-object-has-reference
-    :initform nil)))
+    :initform nil))
+  (:documentation
+   "Base class for GObject classes hierarchy."))
 
 (defvar *foreign-gobjects* (make-weak-hash-table :test 'equal :weakness :value))
 (defvar *foreign-gobjects-ref-count* (make-hash-table :test 'equal))
@@ -115,9 +117,10 @@
           (gethash (pointer-address pointer) *foreign-gobjects*)
           (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
           (ref-count pointer))
-  (awhen (gethash (pointer-address pointer) *foreign-gobjects*)
-    (setf (pointer it) nil)
-    (cancel-finalization it))
+  (let ((object (gethash (pointer-address pointer) *foreign-gobjects*)))
+    (when object
+      (setf (pointer object) nil)
+      (cancel-finalization object)))
   (remhash (pointer-address pointer) *foreign-gobjects*)
   (remhash (pointer-address pointer) *foreign-gobjects-ref-count*)
   (g-object-unref pointer))
@@ -175,11 +178,12 @@
 
 (defun get-g-object-for-pointer (pointer)
   (unless (null-pointer-p pointer)
-    (aif (gethash (pointer-address pointer) *foreign-gobjects*)
-         (prog1 it
-           (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
-           (debugf "increfering object ~A~%" pointer))
-         (make-g-object-from-pointer pointer))))
+    (let ((object (gethash (pointer-address pointer) *foreign-gobjects*)))
+      (if object
+          (prog1 object
+            (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
+            (debugf "increfering object ~A~%" pointer))
+          (make-g-object-from-pointer pointer)))))
 
 (defmethod translate-from-foreign (pointer (type foreign-g-object-type))
   (get-g-object-for-pointer pointer))
@@ -187,6 +191,9 @@
 (register-object-type "GObject" 'g-object)
 
 (defun ensure-g-type (type)
+  "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.
+@arg[type]{a string or and integer}
+@return{integer equal to GType of @code{type}}"
   (etypecase type
     (integer type)
     (string (or (g-type-from-name type)
@@ -198,6 +205,24 @@
       (etypecase object
         (g-object (pointer object)))))
 
+(define-condition property-access-error (error)
+  ((property-name :initarg :property-name :reader property-access-error-property-name)
+   (class-name :initarg :class-name :reader property-access-error-class-name)
+   (message :initarg :message :reader property-access-error-message))
+  (:report (lambda (condition stream)
+             (format stream "Error accessing property '~A' on class '~A': ~A"
+                     (property-access-error-property-name condition)
+                     (property-access-error-class-name condition)
+                     (property-access-error-message condition)))))
+
+(define-condition property-unreadable-error (property-access-error)
+  ()
+  (:default-initargs :message "property is not readable"))
+
+(define-condition property-unwritable-error (property-access-error)
+  ()
+  (:default-initargs :message "property is not writable"))
+
 (defun g-param-spec-property-type (param-spec property-name object-type assert-readable assert-writable)
   (when (null-pointer-p param-spec)
            (error "Property ~A on type ~A is not found"
@@ -208,17 +233,17 @@
                           (foreign-slot-value param-spec
                                               'g-param-spec
                                               'flags))))
-    (error "Property ~A on type ~A is not readable"
-           property-name
-           (g-type-name object-type)))
+    (error 'property-unreadable-error
+           :property-name property-name
+           :class-name (g-type-name object-type)))
   (when (and assert-writable
              (not (member :writable
                           (foreign-slot-value param-spec
                                               'g-param-spec
                                               'flags))))
-    (error "Property ~A on type ~A is not writable"
-           property-name
-           (g-type-name object-type)))
+    (error 'property-unwritable-error
+           :property-name property-name
+           :class-name (g-type-name object-type)))
   (foreign-slot-value param-spec 'g-param-spec 'value-type))
 
 (defun g-object-type-property-type (object-type property-name
@@ -269,9 +294,11 @@
                (foreign-slot-pointer parameter 'g-parameter 'value)))))))
 
 (defun g-object-call-get-property (object property-name &optional property-type)
-  (unless property-type
-    (setf property-type
-          (g-object-property-type object property-name :assert-readable t)))
+  (restart-case
+      (unless property-type
+        (setf property-type
+              (g-object-property-type object property-name :assert-readable t)))
+    (return-nil () (return-from g-object-call-get-property nil)))
   (setf property-type (ensure-g-type property-type))
   (with-foreign-object (value 'g-value)
     (g-value-zero value)