glib-genmarshal(1) User Commands glib-genmarshal(1)
NAME
glib-genmarshal - generates C code marshallers for GLib closures
SYNOPSIS
glib-genmarshal [--body] [--g-fatal-warnings] [--header] [--help] [--nostdinc] [--prefix=dir] [--skip-source] [--version] [file...]
DESCRIPTION
glib-genmarshal generates C code marshallers for callback functions of the GClosure mechanism in the GObject sublibrary of GLib. The mar-
shaller functions have a standard signature. The following are passed to the marshaller functions: the invoking closure, an array of value
structures holding the callback function parameters, and a value structure for the return value of the callback. The marshaller then calls
the C code function of the closure with all of the parameters on the stack, and collects the return value.
glib-genmarshal generates the specified list of marshallers. The marshaller list is either read from standard input or from files passed
as additional arguments on the command line.
EXTENDED DESCRIPTION
The marshaller lists are processed line by line. A line can contain a comment in the following format:
# this is a comment
A marshaller list can contain a marshaller specification in the following format:
RTYPE:PTYPE
RTYPE:PTYPE,PTYPE
RTYPE:PTYPE,PTYPE,PTYPE
# up to 16 PTYPEs may be present
RTYPE specifies the callback return type. PTYPE specifies the callback parameter list, except for the first and the last arguments which
are always pointers.
Parameter Types
Currently, the following parameter types are supported:
BOOL Deprecated alias for BOOLEAN.
BOOLEAN Boolean type (gboolean).
BOXED Boxed, anonymous but reference counted, type (GBoxed*).
CHAR Signed char type (gchar).
DOUBLE Double-precision float type (gdouble).
ENUM Enumeration type (gint).
FLAGS Flag enumeration type (guint).
FLOAT Single-precision float type (gfloat).
INT Signed integer type (gint).
LONG Signed long integer type (glong).
NONE Deprecated alias for VOID.
OBJECT GObject or derived type (GObject*).
PARAM GParamSpec or derived type (GParamSpec*).
POINTER Anonymous pointer type (gpointer).
STRING String type (gchar*).
UCHAR Unsigned char type (guchar).
UINT Unsigned integer type (guint).
ULONG Unsigned long integer type (gulong).
VOID No return type, or no extra parameters. If VOID is used as the parameter list, no additional parameters may be
present.
OPTIONS
The following options are supported:
--body Generate the C code file contents of the marshallers.
--g-fatal-warninMake warnings fatal, that is, exit immediately once a warning occurs.
--header Generate the header file contents of the marshallers.
--help Show usage and basic help information.
--nostdinc Do not use the standard marshallers of the GObject library, and skip the gmarshal.h include directive in generated header
files.
--prefix=dir Specify the marshaller prefix. The default prefix is g_cclosure_marshal.
--skip-source Skip source location remarks in generated comments.
--version Show version information.
OPERANDS
The following operands are supported:
file Specifies the marshaller to be generated.
EXAMPLES
Example 1: Generating Marshallers
This example shows how to generate marshallers for the following callback functions:
void foo (gpointer data1,
gpointer data2);
void bar (gpointer data1,
gint param1,
gpointer data2);
gfloat baz (gpointer data1,
gboolean param1,
guchar param2,
gpointer data2);
The marshaller list is as follows:
VOID:VOID
VOID:INT
FLOAT:BOOLEAN,UCHAR
The generated marshallers have the arguments encoded in their function name. For this particular list, they are as follows:
g_cclosure_marshal_VOID__VOID()
g_cclosure_marshal_VOID__INT()
g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR()
The generated marshallers can be used directly for GClosures or can be passed in as the GSignalCMarshaller c_marshaller; argument upon cre-
ation of signals:
GClosure *cc_foo, *cc_bar, *cc_baz;
cc_foo = g_cclosure_new (NULL, foo, NULL);
g_closure_set_marshal (cc_foo, g_cclosure_marshal_VOID__VOID);
cc_bar = g_cclosure_new (NULL, bar, NULL);
g_closure_set_marshal (cc_bar, g_cclosure_marshal_VOID__INT);
cc_baz = g_cclosure_new (NULL, baz, NULL);
g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR);
EXIT STATUS
The following exit values are returned:
0 Application exited successfully
>0 Application exited with failure
FILES
The following files are used by this application:
/usr/bin/glib-genmarshalThe command-line executable for the application.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Availability |SUNWgnome-base-libs-devel |
+-----------------------------+-----------------------------+
|Interface stability |External |
+-----------------------------+-----------------------------+
SEE ALSO
glib-mkenums(1), libglib-2.0(3)
NOTES
Updated by Brian Cameron, Sun Microsystems Inc., 2003. Written by Tim Janik.
SunOS 5.10 7 Apr 2003 glib-genmarshal(1)