![]() |
![]() |
![]() |
GObject Introspection Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
#include <girepository.h> struct GIRepository; enum GIRepositoryLoadFlags; GIRepository * g_irepository_get_default (void
); gchar ** g_irepository_get_dependencies (GIRepository *repository
,const gchar *namespace_
); gchar ** g_irepository_get_loaded_namespaces (GIRepository *repository
); gint g_irepository_get_n_infos (GIRepository *repository
,const gchar *namespace_
); GIBaseInfo * g_irepository_get_info (GIRepository *repository
,const gchar *namespace_
,gint index
); GOptionGroup * g_irepository_get_option_group (void
); GList * g_irepository_enumerate_versions (GIRepository *repository
,const gchar *namespace_
); void g_irepository_prepend_library_path (const char *directory
); void g_irepository_prepend_search_path (const char *directory
); GSList * g_irepository_get_search_path (void
); const char * g_irepository_load_typelib (GIRepository *repository
,GITypelib *typelib
,GIRepositoryLoadFlags flags
,GError **error
); const gchar * g_irepository_get_typelib_path (GIRepository *repository
,const gchar *namespace_
); gboolean g_irepository_is_registered (GIRepository *repository
,const gchar *namespace_
,const gchar *version
); GITypelib * g_irepository_require (GIRepository *repository
,const gchar *namespace_
,const gchar *version
,GIRepositoryLoadFlags flags
,GError **error
); GITypelib * g_irepository_require_private (GIRepository *repository
,const gchar *typelib_dir
,const gchar *namespace_
,const gchar *version
,GIRepositoryLoadFlags flags
,GError **error
); const gchar * g_irepository_get_c_prefix (GIRepository *repository
,const gchar *namespace_
); const gchar * g_irepository_get_shared_library (GIRepository *repository
,const gchar *namespace_
); const gchar * g_irepository_get_version (GIRepository *repository
,const gchar *namespace_
); GIBaseInfo * g_irepository_find_by_gtype (GIRepository *repository
,GType gtype
); GIEnumInfo * g_irepository_find_by_error_domain (GIRepository *repository
,GQuark domain
); GIBaseInfo * g_irepository_find_by_name (GIRepository *repository
,const gchar *namespace_
,const gchar *name
); gboolean g_irepository_dump (const char *arg
,GError **error
); void gi_cclosure_marshal_generic (GClosure *closure
,GValue *return_gvalue
,guint n_param_values
,const GValue *param_values
,gpointer invocation_hint
,gpointer marshal_data
); #define G_IREPOSITORY_ERROR enum GIRepositoryError;
GIRepository is used to manage repositories of namespaces. Namespaces are represented on disk by type libraries (.typelib files).
struct GIRepository;
The GIRepository structure contains private data and should only be accessed using the provided API.
typedef enum { G_IREPOSITORY_LOAD_FLAG_LAZY = 1 << 0 } GIRepositoryLoadFlags;
Flags that control how a typelib is loaded.
GIRepository * g_irepository_get_default (void
);
Returns the singleton process-global default GIRepository. It is not currently supported to have multiple repositories in a particular process, but this function is provided in the unlikely eventuality that it would become possible, and as a convenience for higher level language bindings to conform to the GObject method call conventions.
All methods on GIRepository also accept NULL
as an instance
parameter to mean this default repository, which is usually more
convenient for C.
Returns : |
The global singleton GIRepository. [transfer none] |
gchar ** g_irepository_get_dependencies (GIRepository *repository
,const gchar *namespace_
);
Return an array of all (transitive) versioned dependencies for
namespace_
. Returned strings are of the form
namespace-version
.
Note: namespace_
must have already been loaded using a function
such as g_irepository_require()
before calling this function.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace of interest |
Returns : |
Zero-terminated string array of versioned dependencies. [transfer full] |
gchar ** g_irepository_get_loaded_namespaces (GIRepository *repository
);
Return the list of currently loaded namespaces.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
Returns : |
List of namespaces. [element-type utf8][transfer full] |
gint g_irepository_get_n_infos (GIRepository *repository
,const gchar *namespace_
);
This function returns the number of metadata entries in
given namespace namespace_
. The namespace must have
already been loaded before calling this function.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace to inspect |
Returns : |
number of metadata entries |
GIBaseInfo * g_irepository_get_info (GIRepository *repository
,const gchar *namespace_
,gint index
);
This function returns a particular metadata entry in the
given namespace namespace_
. The namespace must have
already been loaded before calling this function.
See g_irepository_get_n_infos()
to find the maximum number of
entries.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace to inspect |
|
0-based offset into namespace metadata for entry |
Returns : |
GIBaseInfo containing metadata. [transfer full] |
GOptionGroup * g_irepository_get_option_group (void
);
Obtain the option group for girepository, it's used by the dumper and for programs that wants to provide introspection information
Returns : |
the option group. [transfer full] |
GList * g_irepository_enumerate_versions (GIRepository *repository
,const gchar *namespace_
);
Obtain an unordered list of versions (either currently loaded or
available) for namespace_
in this repository
.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
GI namespace, e.g. "Gtk" |
Returns : |
the array of versions. [element-type utf8][transfer full] |
void g_irepository_prepend_library_path (const char *directory
);
Prepends directory
to the search path that is used to
search shared libraries referenced by imported namespaces.
Multiple calls to this function all contribute to the final
list of paths.
The list of paths is unique and shared for all GIRepository
instances across the process, but it doesn't affect namespaces
imported before the call.
If the library is not found in the directories configured in this way, loading will fall back to the system library path (ie. LD_LIBRARY_PATH and DT_RPATH in ELF systems). See the documentation of your dynamic linker for full details.
|
a single directory to scan for shared libraries. [type filename] |
Since 1.35.8
void g_irepository_prepend_search_path (const char *directory
);
Prepends directory
to the typelib search path.
See g_irepository_get_search_path()
.
|
directory name to prepend to the typelib search path. [type filename] |
GSList * g_irepository_get_search_path (void
);
Returns the current search path GIRepository will use when loading typelib files. The list is internal to GIRespository and should not be freed, nor should its string elements.
Returns : |
GSList of strings. [element-type filename][transfer none] |
const char * g_irepository_load_typelib (GIRepository *repository
,GITypelib *typelib
,GIRepositoryLoadFlags flags
,GError **error
);
TODO
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
TODO |
|
TODO |
|
TODO |
const gchar * g_irepository_get_typelib_path (GIRepository *repository
,const gchar *namespace_
);
If namespace namespace_
is loaded, return the full path to the
.typelib file it was loaded from. If the typelib for
namespace namespace_
was included in a shared library, return
the special string "<builtin>".
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
GI namespace to use, e.g. "Gtk" |
Returns : |
Filesystem path (or $lt;builtin$gt;) if successful, NULL if namespace is not loaded |
gboolean g_irepository_is_registered (GIRepository *repository
,const gchar *namespace_
,const gchar *version
);
Check whether a particular namespace (and optionally, a specific
version thereof) is currently loaded. This function is likely to
only be useful in unusual circumstances; in order to act upon
metadata in the namespace, you should call g_irepository_require()
instead which will ensure the namespace is loaded, and return as
quickly as this function will if it has already been loaded.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace of interest |
|
Required version, may be NULL for latest. [allow-none]
|
Returns : |
TRUE if namespace-version is loaded, FALSE otherwise |
GITypelib * g_irepository_require (GIRepository *repository
,const gchar *namespace_
,const gchar *version
,GIRepositoryLoadFlags flags
,GError **error
);
Force the namespace namespace_
to be loaded if it isn't already.
If namespace_
is not loaded, this function will search for a
".typelib" file using the repository search path. In addition, a
version version
of namespace may be specified. If version
is
not specified, the latest will be used.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
GI namespace to use, e.g. "Gtk" |
|
Version of namespace, may be NULL for latest. [allow-none]
|
|
Set of GIRepositoryLoadFlags , may be 0 |
|
a GError. |
Returns : |
a pointer to the GITypelib if successful, NULL otherwise. [transfer none]
|
GITypelib * g_irepository_require_private (GIRepository *repository
,const gchar *typelib_dir
,const gchar *namespace_
,const gchar *version
,GIRepositoryLoadFlags flags
,GError **error
);
Force the namespace namespace_
to be loaded if it isn't already.
If namespace_
is not loaded, this function will search for a
".typelib" file within the private directory only. In addition, a
version version
of namespace should be specified. If version
is
not specified, the latest will be used.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Private directory where to find the requested typelib |
|
GI namespace to use, e.g. "Gtk" |
|
Version of namespace, may be NULL for latest. [allow-none]
|
|
Set of GIRepositoryLoadFlags , may be 0 |
|
a GError. |
Returns : |
a pointer to the GITypelib if successful, NULL otherwise. [transfer none]
|
const gchar * g_irepository_get_c_prefix (GIRepository *repository
,const gchar *namespace_
);
This function returns the "C prefix", or the C level namespace associated with the given introspection namespace. Each C symbol starts with this prefix, as well each GType in the library.
Note: The namespace must have already been loaded using a function
such as g_irepository_require()
before calling this function.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace to inspect |
Returns : |
C namespace prefix, or NULL if none associated |
const gchar * g_irepository_get_shared_library (GIRepository *repository
,const gchar *namespace_
);
This function returns the full path to the shared C library
associated with the given namespace namespace_
. There may be no
shared library path associated, in which case this function will
return NULL
.
Note: The namespace must have already been loaded using a function
such as g_irepository_require()
before calling this function.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace to inspect |
Returns : |
Full path to shared library, or NULL if none associated |
const gchar * g_irepository_get_version (GIRepository *repository
,const gchar *namespace_
);
This function returns the loaded version associated with the given
namespace namespace_
.
Note: The namespace must have already been loaded using a function
such as g_irepository_require()
before calling this function.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace to inspect |
Returns : |
Loaded version |
GIBaseInfo * g_irepository_find_by_gtype (GIRepository *repository
,GType gtype
);
Searches all loaded namespaces for a particular GType. Note that in order to locate the metadata, the namespace corresponding to the type must first have been loaded. There is currently no mechanism for determining the namespace which corresponds to an arbitrary GType - thus, this function will operate most reliably when you know the GType to originate from be from a loaded namespace.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
GType to search for |
Returns : |
GIBaseInfo representing metadata about type , or NULL . [transfer full]
|
GIEnumInfo * g_irepository_find_by_error_domain (GIRepository *repository
,GQuark domain
);
Searches for the enum type corresponding to the given GError
domain. Before calling this function for a particular namespace,
you must call g_irepository_require()
once to load the namespace, or
otherwise ensure the namespace has already been loaded.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
a GError domain |
Returns : |
GIEnumInfo representing metadata about domain 's
enum type, or NULL . [transfer full]
|
Since 1.29.17
GIBaseInfo * g_irepository_find_by_name (GIRepository *repository
,const gchar *namespace_
,const gchar *name
);
Searches for a particular entry in a namespace. Before calling
this function for a particular namespace, you must call
g_irepository_require()
once to load the namespace, or otherwise
ensure the namespace has already been loaded.
|
A GIRepository or NULL for the singleton
process-global default GIRepository. [allow-none]
|
|
Namespace which will be searched |
|
Entry name to find |
Returns : |
GIBaseInfo representing metadata about name , or NULL . [transfer full]
|
gboolean g_irepository_dump (const char *arg
,GError **error
);
Argument specified is a comma-separated pair of filenames; i.e. of the form "input.txt,output.xml". The input file should be a UTF-8 Unix-line-ending text file, with each line containing either "get-type:" followed by the name of a GType _get_type function, or "error-quark:" followed by the name of an error quark function. No extra whitespace is allowed.
The output file should already exist, but be empty. This function will overwrite its contents.
|
Comma-separated pair of input and output filenames |
|
a GError
|
Returns : |
TRUE on success, FALSE on error |
void gi_cclosure_marshal_generic (GClosure *closure
,GValue *return_gvalue
,guint n_param_values
,const GValue *param_values
,gpointer invocation_hint
,gpointer marshal_data
);
TODO
|
TODO |
|
TODO |
|
TODO |
|
TODO |
|
TODO |
|
TODO |
#define G_IREPOSITORY_ERROR (g_irepository_error_quark ())
Error domain for GIRepository. Errors in this domain will be from the GIRepositoryError enumeration. See GError for more information on error domains.
typedef enum { G_IREPOSITORY_ERROR_TYPELIB_NOT_FOUND, G_IREPOSITORY_ERROR_NAMESPACE_MISMATCH, G_IREPOSITORY_ERROR_NAMESPACE_VERSION_CONFLICT, G_IREPOSITORY_ERROR_LIBRARY_NOT_FOUND } GIRepositoryError;
An error code used with G_IREPOSITORY_ERROR in a GError returned from a GIRepository routine.
the typelib could not be found. | |
the namespace does not match the requested namespace. | |
the version of the typelib does not match the requested version. | |
the library used by the typelib could not be found. |