1 .TH GLIB-GENMARSHAL 1 "18 Oct 2000"
3 glib-genmarshal \- C code marshaller generation utility for GLib closures
6 \fBglib-genmarshal\fP [\fIoptions\fP] [\fIfiles...\fP]
9 \fBglib-genmarshal\fP is a small utility that generates C code marshallers
10 for callback functions of the GClosure mechanism in the GObject sublibrary
11 of GLib. The marshaller functions have a standard signature, they get passed
12 in the invoking closure, an array of value structures holding the callback
13 function parameters and a value structure for the return value of the
14 callback. The marshaller is then responsible to call the respective C code
15 function of the closure with all the parameters on the stack and to collect
20 \fBglib-genmarshal\fP takes a list of marshallers to generate as input.
21 The marshaller list is either read from standard input or from files
22 passed as additional arguments on the command line.
27 Generate header file contents of the marshallers.
30 Generate C code file contents of the marshallers.
32 \fI--prefix=string, --prefix string
33 Specify marshaller prefix. The default prefix is `\fIg_cclosure_marshal\fP'.
36 Skip source location remarks in generated comments.
39 Do not use the standard marshallers of the GObject library, and skip
40 gmarshal.h include directive in generated header files.
43 Mark generated function as internal by using the G_GNUC_INTERNAL macro.
46 Make warnings fatal, that is, exit immediately once a warning occurs.
49 Print brief help and exit.
52 Print version and exit.
55 .SS Marshaller list format
57 The marshaller lists are processed line by line, a line can contain a
58 comment in the form of
64 or a marshaller specification of the form
67 \fIRTYPE\fP:\fBPTYPE\fP
69 \fIRTYPE\fP:\fBPTYPE\fP,\fBPTYPE\fP
71 \fIRTYPE\fP:\fBPTYPE\fP,\fBPTYPE\fP,\fBPTYPE\fP
73 # up to 16 \fBPTYPE\fPs may be present
76 The \fIRTYPE\fP part specifies the callback's return type and
77 the \fBPTYPE\fPs right to the colon specify the callback's
78 parameter list, except for the first and the last arguments which
83 Currently, the following types are supported:
86 indicates no return type, or no extra parameters. if \fIVOID\fP is used as
87 the parameter list, no additional parameters may be present.
90 for boolean types (gboolean)
93 for signed char types (gchar)
96 for unsigned char types (guchar)
99 for signed integer types (gint)
102 for unsigned integer types (guint)
105 for signed long integer types (glong)
108 for unsigned long integer types (gulong)
111 for signed 64bit integer types (gint64)
114 for unsigned 64bit integer types (guint64)
117 for enumeration types (gint)
120 for flag enumeration types (guint)
123 for single-precision float types (gfloat)
126 for double-precision float types (gdouble)
129 for string types (gchar*)
132 for boxed (anonymous but reference counted) types (GBoxed*)
135 for GParamSpec or derived types (GParamSpec*)
138 for anonymous pointer types (gpointer)
141 for GObject or derived types (GObject*)
144 deprecated alias for \fIVOID\fP
147 deprecated alias for \fIBOOLEAN\fP
150 To generate marshallers for the following callback functions:
154 void foo (gpointer data1,
156 void bar (gpointer data1,
159 gfloat baz (gpointer data1,
166 The marshaller list has to look like this:
176 The generated marshallers have the arguments encoded
177 in their function name. For this particular list, they
179 g_cclosure_marshal_VOID__VOID(),
180 g_cclosure_marshal_VOID__INT(),
181 g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR().
183 They can be used directly for GClosures or be passed in as
184 the GSignalCMarshaller c_marshaller; argument upon creation
188 GClosure *cc_foo, *cc_bar, *cc_baz;
190 cc_foo = g_cclosure_new (NULL, foo, NULL);
191 g_closure_set_marshal (cc_foo, g_cclosure_marshal_VOID__VOID);
192 cc_bar = g_cclosure_new (NULL, bar, NULL);
193 g_closure_set_marshal (cc_bar, g_cclosure_marshal_VOID__INT);
194 cc_baz = g_cclosure_new (NULL, baz, NULL);
195 g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR);
210 has been written by Tim Janik <timj@gtk.org>.
212 This manual page was provided by Tim Janik <timj@gtk.org>.