docstrings and g-type-designator

[cl-gtk2.git] / glib / gobject.gvalue-parser.lisp

diff --git a/glib/gobject.gvalue-parser.lisp b/glib/gobject.gvalue-parser.lisp
index 1443e34..f06ea41 100644 (file)
--- a/glib/gobject.gvalue-parser.lisp
+++ b/glib/gobject.gvalue-parser.lisp
@@ -16,10 +16,14 @@
                     `((equalp ,key ,value) ,@forms)))))))
 
 (defun parse-gvalue (gvalue)
-  (let* ((type (gvalue-type gvalue))
-         (fundamental-type (g-type-fundamental type)))
+  "Parses the GValue structure and returns the corresponding Lisp object.
+
+@arg[value]{a C pointer to the GValue structure}
+@return{value contained in the GValue structure. Type of value depends on GValue type}"
+  (let* ((type (ensure-g-type (gvalue-type gvalue)))
+         (fundamental-type (ensure-g-type (g-type-fundamental type))))
     (cond
-      ((= type (g-strv-get-type)) (convert-from-foreign (g-value-get-boxed gvalue) '(glib:gstrv :free-from-foreign nil)))
+      ((= type (ensure-g-type (g-strv-get-type))) (convert-from-foreign (g-value-get-boxed gvalue) '(glib:gstrv :free-from-foreign nil)))
       (t (ev-case fundamental-type
            (+g-type-invalid+ (error "GValue is of invalid type (~A)" (g-type-name type)))
            (+g-type-void+ nil)
@@ -44,14 +48,23 @@
            (+g-type-interface+ (parse-gvalue-object gvalue))
            (t (error "Unknown type: ~A (~A)" type (g-type-name type))))))))
 
-(defun set-g-value (gvalue value type &key zero-g-value)
-  (if zero-g-value
-    (g-value-zero gvalue)
-    (g-value-unset gvalue))
-  (g-value-init gvalue type)
-  (let ((fundamental-type (g-type-fundamental type)))
+(defun set-g-value (gvalue value type &key zero-g-value unset-g-value (g-value-init t))
+  "Assigns the GValue structure @code{gvalue} the value @code{value} of GType @code{type}.
+
+@arg[gvalue]{a C pointer to the GValue structure}
+@arg[value]{a Lisp object that is to be assigned}
+@arg[type]{a GType that is to be assigned}
+@arg[zero-g-value]{a boolean specifying whether GValue should be zero-initialized before assigning. See @fun{g-value-zero}}
+@arg[unset-g-value]{a boolean specifying whether GValue should be \"unset\" before assigning. See @fun{g-value-unset}. The \"true\" value should not be passed to both @code{zero-g-value} and @code{unset-g-value} arguments}
+@arg[g-value-init]{a boolean specifying where GValue should be initialized}"
+  (setf type (ensure-g-type type))
+  (cond
+    (zero-g-value (g-value-zero gvalue))
+    (unset-g-value (g-value-unset gvalue)))
+  (when g-value-init (g-value-init gvalue type))
+  (let ((fundamental-type (ensure-g-type (g-type-fundamental type))))
     (cond
-      ((= type (g-strv-get-type)) (g-value-set-boxed gvalue (convert-to-foreign value 'glib:gstrv)))
+      ((= type (ensure-g-type (g-strv-get-type))) (g-value-set-boxed gvalue (convert-to-foreign value 'glib:gstrv)))
       (t (ev-case fundamental-type
            (+g-type-invalid+ (error "Invalid type (~A)" type))
            (+g-type-void+ nil)