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 GRuntime marshallers, and skip gmarshal.h include
40 directive in generated header files.
43 Make warnings fatal, that is, exit immediately once a warning occours.
46 Print brief help and exit.
49 Print version and exit.
52 .SS Marshaller list format
54 The marshaller lists are processed line by line, a line can contain a
55 comment in the form of
61 or a marshaller specification of the form
64 \fIRTYPE\fP:\fBPTYPE\fP
66 \fIRTYPE\fP:\fBPTYPE\fP,\fBPTYPE\fP
68 \fIRTYPE\fP:\fBPTYPE\fP,\fBPTYPE\fP,\fBPTYPE\fP
70 # up to 16 \fBPTYPE\fPs may be present
73 The \fIRTYPE\fP part specifies the callback's return type and
74 the \fBPTYPE\fPs right to the colon specify the callback's
75 parameter list, except for the first and the last arguments which
80 Currently, the following types are supported:
83 indicates no return type, or no extra parameters. if \fIVOID\fP is used as
84 the parameter list, no additional parameters may be present.
87 for boolean types (gboolean)
90 for signed char types (gchar)
93 for unsigned char types (guchar)
96 for signed integer types (gint)
99 for unsigned integer types (guint)
102 for signed long integer types (glong)
105 for unsigned long integer types (gulong)
108 for enumeration types (gint)
111 for flag enumeration types (guint)
114 for single-precision float types (gfloat)
117 for double-precision float types (gdouble)
120 for string types (gchar*)
123 for boxed (anonymous but reference counted) types (GBoxed*)
126 for GParamSpec or derived types (GParamSpec*)
128 for anonymous pointer types (gpointer)
131 for GObject or derived types (GObject*)
134 deprecated alias for \fIVOID\fP
137 deprecated alias for \fIBOOLEAN\fP
140 To generate marshallers for the following callback functions:
144 void foo (gpointer data1,
146 void bar (gpointer data1,
149 gfloat baz (gpointer data1,
156 The marshaller list has to look like this:
166 The generated marshallers have the arguments encoded
167 in their function name. For this particular list, they
169 g_cclosure_marshal_VOID__VOID(),
170 g_cclosure_marshal_VOID__INT(),
171 g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR().
173 They can be used directly for GClosures or be passed in as
174 the GSignalCMarshaller c_marshaller; argument upon creation
178 GClosure *cc_foo, *cc_bar, *cc_baz;
180 cc_foo = g_cclosure_new (NULL, foo, NULL);
181 g_closure_set_marshal (cc_foo, g_cclosure_marshal_VOID__VOID);
182 cc_bar = g_cclosure_new (NULL, bar, NULL);
183 g_closure_set_marshal (cc_bar, g_cclosure_marshal_VOID__INT);
184 cc_baz = g_cclosure_new (NULL, baz, NULL);
185 g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR);
200 has been written by Tim Janik <timj@gtk.org>.
202 This manual page was provided by Tim Janik <timj@gtk.org>.