glib/gobject.package.lisp

   1 (defpackage :gobject
   2   (:use :cl :glib :cffi :tg :bordeaux-threads :iter :closer-mop :gobject.ffi)
   3   (:export #:g-type
   4            #:g-type-string
   5            #:g-type-numeric
   6            #:g-type-children
   7            #:g-type-parent
   8            #:g-type-designator
   9            #:g-type-fundamental
  10            #:g-type-depth
  11            #:g-type-next-base
  12            #:g-type-is-a
  13            #:g-type-interfaces
  14            #:g-type-interface-prerequisites
  15            #:g-strv-get-type
  16            #:g-closure-get-type
  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
  25            #:parse-g-param-spec
  26            #:class-properties
  27            #:interface-properties
  28            #:enum-item
  29            #:enum-item-name
  30            #:enum-item-value
  31            #:enum-item-nick
  32            #:get-enum-items
  33            #:flags-item
  34            #:flags-item-name
  35            #:flags-item-value
  36            #:flags-item-nick
  37            #:get-flags-items
  38            #:signal-info
  39            #:signal-info-id
  40            #:signal-info-name
  41            #:signal-info-owner-type
  42            #:signal-info-flags
  43            #:signal-info-return-type
  44            #:signal-info-param-types
  45            #:signal-info-detail
  46            #:query-signal-info
  47            #:type-signals
  48            #:parse-signal-name
  49            #:class-property-info
  50            #:+g-type-invalid+
  51            #:+g-type-void+
  52            #:+g-type-interface+
  53            #:+g-type-char+
  54            #:+g-type-uchar+
  55            #:+g-type-boolean+
  56            #:+g-type-int+
  57            #:+g-type-uint+
  58            #:+g-type-long+
  59            #:+g-type-ulong+
  60            #:+g-type-int64+
  61            #:+g-type-uint64+
  62            #:+g-type-enum+
  63            #:+g-type-flags+
  64            #:+g-type-float+
  65            #:+g-type-double+
  66            #:+g-type-string+
  67            #:+g-type-pointer+
  68            #:+g-type-boxed+
  69            #:+g-type-param+
  70            #:+g-type-object+
  71            #:g-object
  72            #:pointer
  73            #:g-type-from-object
  74            #:g-type-name
  75            #:g-type-from-name
  76            #:g-signal-connect
  77            #:define-g-object-class
  78            #:g-initially-unowned
  79            #:define-g-enum
  80            #:*lisp-name-package*
  81            #:define-g-flags
  82            #:fixed-array
  83            #:g-boxed-inline
  84            #:g-boxed-ptr
  85            #:define-g-interface
  86            #:release
  87            #:using
  88            #:using*
  89            #:g-boxed-ref
  90            #:allocate-stable-pointer
  91            #:free-stable-pointer
  92            #:get-stable-pointer-value
  93            #:with-stable-pointer
  94            #:release*
  95            #:disown-boxed-ref
  96            #:g-type-interface
  97            #:g-value
  98            #:register-object-type-implementation
  99            #:ensure-g-type
 100            #:define-vtable
 101            #:g-type
 102            #:set-g-value
 103            #:parse-g-value
 104            #:emit-signal
 105            #:g-value-unset
 106            #:g-value-zero
 107            #:g-value-init
 108            #:g-type-class-ref
 109            #:g-object-class
 110            #:gobject-class
 111            #:g-param-spec
 112            #:type-instance
 113            #:g-type-class-unref
 114            #:registered-object-type-by-name
 115            #:g-type-children
 116            #:g-signal-lookup
 117            #:g-type-parent
 118            #:connect-signal
 119            #:boxed-c-structure-name
 120            #:g-type-designator
 121            #:g-type-fundamental
 122            #:g-type-depth
 123            #:g-type-next-base
 124            #:g-type-is-a
 125            #:g-type-interfaces
 126            #:g-type-interface-prerequisites
 127            #:g-type-name
 128            #:g-type-from-name
 129            #:g-type
 130            #:g-type-children
 131            #:g-type-parent
 132            #:g-type-designator
 133            #:g-type-fundamental
 134            #:g-type-depth
 135            #:g-type-next-base
 136            #:g-type-is-a
 137            #:g-type-interfaces
 138            #:g-type-interface-prerequisites
 139            #:g-strv-get-type
 140            #:g-closure-get-type
 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
 149            #:parse-g-param-spec
 150            #:class-properties
 151            #:interface-properties
 152            #:enum-item
 153            #:enum-item-name
 154            #:enum-item-value
 155            #:enum-item-nick
 156            #:get-enum-items
 157            #:flags-item
 158            #:flags-item-name
 159            #:flags-item-value
 160            #:flags-item-nick
 161            #:get-flags-items
 162            #:stable-pointer-value
 163            #:g-value-type
 164            #:create-g-closure
 165            #:g-object-call-constructor
 166            #:g-object-call-get-property
 167            #:g-object-call-set-property
 168            #:register-enum-type
 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
 176            #:*strip-prefix*
 177            #:*lisp-name-exceptions*
 178            #:*additional-properties*
 179            #:g-type=
 180            #:g-type/=
 181            #:define-g-boxed-cstruct
 182            #:define-g-boxed-opaque
 183            #:g-boxed-opaque
 184            #:g-boxed-opaque-pointer
 185            #:define-g-boxed-variant-cstruct
 186            #:g-boxed-foreign
 187            #:boxed-related-symbols
 188            #:define-boxed-opaque-accessor)
 189   (:documentation
 190    "CL-GTK2-GOBJECT is a binding to GObject type system.
 191 For information on GObject, see its @a[http://library.gnome.org/devel/gobject/stable/]{documentation}.
 192
 193 CL-GTK2-GOBJECT is structured as follows:
 194 @itemize{
 195 @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.}
 196 @item{GObject wrapper that bridges Lisp language with GObject API.}
 197 }
 198
 199 @begin[GObject instrospection API]{section}
 200 The base of GObject type system is GType. GType is a numerical value that is the unique identifier of a registered type.
 201 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}.
 202
 203 There are several predefined GType values that correspond to fundamental or base types.
 204 @begin{itemize}
 205 @item{@variable{+g-type-invalid+}}
 206 @item{@variable{+g-type-void+}}
 207 @item{@variable{+g-type-interface+}}
 208 @item{@variable{+g-type-char+}}
 209 @item{@variable{+g-type-uchar+}}
 210 @item{@variable{+g-type-boolean+}}
 211 @item{@variable{+g-type-int+}}
 212 @item{@variable{+g-type-uint+}}
 213 @item{@variable{+g-type-long+}}
 214 @item{@variable{+g-type-ulong+}}
 215 @item{@variable{+g-type-int64+}}
 216 @item{@variable{+g-type-uint64+}}
 217 @item{@variable{+g-type-enum+}}
 218 @item{@variable{+g-type-flags+}}
 219 @item{@variable{+g-type-float+}}
 220 @item{@variable{+g-type-double+}}
 221 @item{@variable{+g-type-string+}}
 222 @item{@variable{+g-type-pointer+}}
 223 @item{@variable{+g-type-boxed+}}
 224 @item{@variable{+g-type-param+}}
 225 @item{@variable{+g-type-object+}}
 226 @end{itemize}
 227
 228 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.
 229
 230 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.
 231
 232 //TODO: document and refactor signals
 233
 234 @end{section}
 235
 236 @begin[GValue]{section}
 237 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.
 238 @end{section}"))
 239
 240 (in-package :gobject)
 241
 242 (defvar *gobject-debug* nil)
 243
 244 (defmacro debugf (&rest args)
 245   (when *gobject-debug*
 246     (apply 'format t args)))