2 (:use :cl :glib :cffi :tg :bordeaux-threads :iter :closer-mop :gobject.ffi)
14 #:g-type-interface-prerequisites
17 #:g-class-property-definition
18 #:g-class-property-definition-name
19 #:g-class-property-definition-type
20 #:g-class-property-definition-readable
21 #:g-class-property-definition-writable
22 #:g-class-property-definition-constructor
23 #:g-class-property-definition-constructor-only
24 #:g-class-property-definition-owner-type
27 #:interface-properties
41 #:signal-info-owner-type
43 #:signal-info-return-type
44 #:signal-info-param-types
77 #:define-g-object-class
90 #:allocate-stable-pointer
92 #:get-stable-pointer-value
98 #:register-object-type-implementation
114 #:registered-object-type-by-name
119 #:boxed-c-structure-name
126 #:g-type-interface-prerequisites
138 #:g-type-interface-prerequisites
141 #:g-class-property-definition
142 #:g-class-property-definition-name
143 #:g-class-property-definition-type
144 #:g-class-property-definition-readable
145 #:g-class-property-definition-writable
146 #:g-class-property-definition-constructor
147 #:g-class-property-definition-constructor-only
148 #:g-class-property-definition-owner-type
151 #:interface-properties
162 #:stable-pointer-value
165 #:g-object-call-constructor
166 #:g-object-call-get-property
167 #:g-object-call-set-property
169 #:register-flags-type
170 #:register-object-type
171 #:generate-types-hierarchy-to-file
172 #:get-g-flags-definition
173 #:get-g-enum-definition
174 #:get-g-interface-definition
175 #:get-g-class-definition
177 #:*lisp-name-exceptions*
178 #:*additional-properties*
181 #:define-g-boxed-cstruct
182 #:define-g-boxed-opaque
184 #:g-boxed-opaque-pointer
185 #:define-g-boxed-variant-cstruct
187 #:boxed-related-symbols
188 #:define-boxed-opaque-accessor
191 "CL-GTK2-GOBJECT is a binding to GObject type system.
192 For information on GObject, see its @a[http://library.gnome.org/devel/gobject/stable/]{documentation}.
194 CL-GTK2-GOBJECT is structured as follows:
196 @item{Binding to GObject API, providing low-level means to use functionality of GObject. This includes introspection facilities and means to invoke functionality of GObject.}
197 @item{GObject wrapper that bridges Lisp language with GObject API.}
200 @begin[GObject instrospection API]{section}
201 The base of GObject type system is GType. GType is a numerical value that is the unique identifier of a registered type.
202 Each GType has a name that is retrieved with @fun{g-type-name}. Conversely, GType can be retrieved from its name via @fun{g-type-from-name}.
204 There are several predefined GType values that correspond to fundamental or base types.
206 @item{@variable{+g-type-invalid+}}
207 @item{@variable{+g-type-void+}}
208 @item{@variable{+g-type-interface+}}
209 @item{@variable{+g-type-char+}}
210 @item{@variable{+g-type-uchar+}}
211 @item{@variable{+g-type-boolean+}}
212 @item{@variable{+g-type-int+}}
213 @item{@variable{+g-type-uint+}}
214 @item{@variable{+g-type-long+}}
215 @item{@variable{+g-type-ulong+}}
216 @item{@variable{+g-type-int64+}}
217 @item{@variable{+g-type-uint64+}}
218 @item{@variable{+g-type-enum+}}
219 @item{@variable{+g-type-flags+}}
220 @item{@variable{+g-type-float+}}
221 @item{@variable{+g-type-double+}}
222 @item{@variable{+g-type-string+}}
223 @item{@variable{+g-type-pointer+}}
224 @item{@variable{+g-type-boxed+}}
225 @item{@variable{+g-type-param+}}
226 @item{@variable{+g-type-object+}}
229 GType values form type hierarchies via signle inheritance. Functions @fun{g-type-parent} and @fun{g-type-children} enable to traverse through the type hierarchy.
231 For some types, additional information is available. Functions @fun{class-properties} and @fun{interface-properties} return properties of classes and interfaces. Functions @fun{get-enum-items} and @fun{get-flags-items} return members of enum and flags types.
233 //TODO: document and refactor signals
237 @begin[GValue]{section}
238 GObject uses GValues as a generic way to pass values. It is used when calling closures, emitting signals, setting and getting properties' values, passing values to object constructors. @class{g-value} foreign structure is used for holding GValue. It used like all foreign structures: either with @code{cffi:foreign-alloc} or with @code{cffi:with-foreign-object}. Before first use, @class{g-value} should be zeroed with @fun{g-value-zero}. Zeroed @class{g-value} may be configured to hold a GValue of a given type with @fun{g-value-init}. @fun{parse-g-value} retrieves the Lisp object corresponding to the value stored in GValue. @fun{set-g-value} sets the GValue from Lisp object.
241 (in-package :gobject)
243 (defvar *gobject-debug* nil)
245 (defmacro debugf (&rest args)
246 (when *gobject-debug*
247 (apply 'format t args)))