GICallableInfo

GICallableInfo — Struct representing a callable

Functions

#define	GI_IS_CALLABLE_INFO()
GITypeInfo *	g_callable_info_get_return_type ()
GITransfer	g_callable_info_get_caller_owns ()
gboolean	g_callable_info_may_return_null ()
const gchar *	g_callable_info_get_return_attribute ()
gboolean	g_callable_info_iterate_return_attributes ()
gint	g_callable_info_get_n_args ()
GIArgInfo *	g_callable_info_get_arg ()
void	g_callable_info_load_arg ()
void	g_callable_info_load_return_type ()

Types and Values

typedef

GICallableInfo

Description

GICallableInfo represents an entity which is callable. Currently a function (GIFunctionInfo), virtual function, (GIVFuncInfo) or callback (GICallbackInfo).

A callable has a list of arguments (GIArgInfo), a return type, direction and a flag which decides if it returns null.

Struct hierarchy

  GIBaseInfo
   +----GICallableInfo
         +----GIFunctionInfo
         +----GISignalInfo
         +----GIVFuncInfo

Functions

GI_IS_CALLABLE_INFO()

#define             GI_IS_CALLABLE_INFO(info)

g_callable_info_get_return_type ()

GITypeInfo *
g_callable_info_get_return_type (GICallableInfo *info);

Obtain the return type of a callable item as a GITypeInfo.

Parameters

info

a GICallableInfo

Returns

the GITypeInfo. Free the struct by calling g_base_info_unref() when done.

[transfer full]

g_callable_info_get_caller_owns ()

GITransfer
g_callable_info_get_caller_owns (GICallableInfo *info);

See whether the caller owns the return value of this callable. GITransfer contains a list of possible transfer values.

Parameters

info

a GICallableInfo

Returns

TRUE if the caller owns the return value, FALSE otherwise.

g_callable_info_may_return_null ()

gboolean
g_callable_info_may_return_null (GICallableInfo *info);

See if a callable could return NULL.

Parameters

info

a GICallableInfo

Returns

TRUE if callable could return NULL

g_callable_info_get_return_attribute ()

const gchar *
g_callable_info_get_return_attribute (GICallableInfo *info,
                                      const gchar *name);

Retrieve an arbitrary attribute associated with the return value.

Parameters

info	a GICallableInfo
name	a freeform string naming an attribute

Returns

The value of the attribute, or NULL if no such attribute exists

g_callable_info_iterate_return_attributes ()

gboolean
g_callable_info_iterate_return_attributes
                               (GICallableInfo *info,
                                GIAttributeIter *iterator,
                                char **name,
                                char **value);

Iterate over all attributes associated with the return value. The iterator structure is typically stack allocated, and must have its first member initialized to NULL.

Both the name and value should be treated as constants and must not be freed.

See g_base_info_iterate_attributes() for an example of how to use a similar API.

Parameters

info	a GICallableInfo
iterator	a GIAttributeIter structure, must be initialized; see below
name	Returned name, must not be freed.	[out][transfer none]
value	Returned name, must not be freed.	[out][transfer none]

Returns

TRUE if there are more attributes

g_callable_info_get_n_args ()

gint
g_callable_info_get_n_args (GICallableInfo *info);

Obtain the number of arguments (both IN and OUT) for this callable.

Parameters

info

a GICallableInfo

Returns

The number of arguments this callable expects.

g_callable_info_get_arg ()

GIArgInfo *
g_callable_info_get_arg (GICallableInfo *info,
                         gint n);

Obtain information about a particular argument of this callable.

Parameters

info	a GICallableInfo
n	the argument index to fetch

Returns

the GIArgInfo. Free it with g_base_info_unref() when done.

[transfer full]

g_callable_info_load_arg ()

void
g_callable_info_load_arg (GICallableInfo *info,
                          gint n,
                          GIArgInfo *arg);

Obtain information about a particular argument of this callable; this function is a variant of g_callable_info_get_arg() designed for stack allocation.

The initialized arg must not be referenced after info is deallocated.

Parameters

info	a GICallableInfo
n	the argument index to fetch
arg	Initialize with argument number `n` .	[out caller-allocates]

g_callable_info_load_return_type ()

void
g_callable_info_load_return_type (GICallableInfo *info,
                                  GITypeInfo *type);

Obtain information about a return value of callable; this function is a variant of g_callable_info_get_return_type() designed for stack allocation.

The initialized type must not be referenced after info is deallocated.

Parameters

info	a GICallableInfo
type	Initialized with return type of `info` .	[out caller-allocates]

Types and Values

GICallableInfo

typedef GIBaseInfo GICallableInfo;

Represents a callable, either GIFunctionInfo, GICallbackInfo or GIVFuncInfo.