From 216c11ec554534913fcbcbe421b0f9e6a2f1028a Mon Sep 17 00:00:00 2001 From: Tomeu Vizoso Date: Mon, 15 Aug 2011 14:04:03 +0200 Subject: [PATCH] tests/doctool: Switch to test the mallard formatter --- tests/doctool/GIRepository-2.0-C-expected.page | 19 + tests/doctool/GIRepository-2.0-C-expected.xml | 1823 -------------------- .../doctool/GIRepository-2.0-Python-expected.page | 19 + tests/doctool/GIRepository-2.0-Python-expected.xml | 1823 -------------------- tests/doctool/Makefile.am | 28 +- 5 files changed, 52 insertions(+), 3660 deletions(-) create mode 100644 tests/doctool/GIRepository-2.0-C-expected.page delete mode 100644 tests/doctool/GIRepository-2.0-C-expected.xml create mode 100644 tests/doctool/GIRepository-2.0-Python-expected.page delete mode 100644 tests/doctool/GIRepository-2.0-Python-expected.xml diff --git a/tests/doctool/GIRepository-2.0-C-expected.page b/tests/doctool/GIRepository-2.0-C-expected.page new file mode 100644 index 0000000..badacf0 --- /dev/null +++ b/tests/doctool/GIRepository-2.0-C-expected.page @@ -0,0 +1,19 @@ + + + + + GIRepository Documentation + + Classes + + + Functions + + + Other + + diff --git a/tests/doctool/GIRepository-2.0-C-expected.xml b/tests/doctool/GIRepository-2.0-C-expected.xml deleted file mode 100644 index 50c8f73..0000000 --- a/tests/doctool/GIRepository-2.0-C-expected.xml +++ /dev/null @@ -1,1823 +0,0 @@ - - - -]> - - GIRepository Documentation - - GIArgInfo - - Synopsis - -struct GIArgInfo; - - - - Details - - GIArgInfo - - GIArgInfo - - typedef GIBaseInfo GIArgInfo - Represents an argument. - - - - - GICallableInfo - - Synopsis - -struct GICallableInfo; - - - - Details - - GICallableInfo - - GICallableInfo - - typedef GIBaseInfo GICallableInfo - Represents a callable, either #GIFunctionInfo, #GICallbackInfo or -#GIVFuncInfo. - - - - - GICallbackInfo - - Synopsis - -struct GICallbackInfo; - - - - Details - - GICallbackInfo - - GICallbackInfo - - typedef GIBaseInfo GICallbackInfo - Represents a callback, eg arguments and return value. - - - - - GIConstantInfo - - Synopsis - -struct GIConstantInfo; - - - - Details - - GIConstantInfo - - GIConstantInfo - - typedef GIBaseInfo GIConstantInfo - Represents a constant. - - - - - GIEnumInfo - - Synopsis - -struct GIEnumInfo; - - - - Details - - GIEnumInfo - - GIEnumInfo - - typedef GIBaseInfo GIEnumInfo - Represents an enum or a flag. - - - - - GIFieldInfo - - Synopsis - -struct GIFieldInfo; - - - - Details - - GIFieldInfo - - GIFieldInfo - - typedef GIBaseInfo GIFieldInfo - Represents a field of a #GIStructInfo or a #GIUnionInfo. - - - - - GIFunctionInfo - - Synopsis - -struct GIFunctionInfo; - - - - Details - - GIFunctionInfo - - GIFunctionInfo - - typedef GIBaseInfo GIFunctionInfo - Represents a function, eg arguments and return value. - - - - - GIInterfaceInfo - - Synopsis - -struct GIInterfaceInfo; - - - - Details - - GIInterfaceInfo - - GIInterfaceInfo - - typedef GIBaseInfo GIInterfaceInfo - Represents an interface. - - - - - GIObjectInfo - - Synopsis - -struct GIObjectInfo; - - - - Details - - GIObjectInfo - - GIObjectInfo - - typedef GIBaseInfo GIObjectInfo - Represents an object. - - - - - GIPropertyInfo - - Synopsis - -struct GIPropertyInfo; - - - - Details - - GIPropertyInfo - - GIPropertyInfo - - typedef GIBaseInfo GIPropertyInfo - Represents a property of a #GIObjectInfo or a #GIInterfaceInfo. - - - - - GIRegisteredTypeInfo - - Synopsis - -struct GIRegisteredTypeInfo; - - - - Details - - GIRegisteredTypeInfo - - GIRegisteredTypeInfo - - typedef GIBaseInfo GIRegisteredTypeInfo - Represent a registered type. - - - - - GISignalInfo - - Synopsis - -struct GISignalInfo; - - - - Details - - GISignalInfo - - GISignalInfo - - typedef GIBaseInfo GISignalInfo - Represents a signal. - - - - - GIStructInfo - - Synopsis - -struct GIStructInfo; - - - - Details - - GIStructInfo - - GIStructInfo - - typedef GIBaseInfo GIStructInfo - Represents a struct. - - - - - GITypeInfo - - Synopsis - -struct GITypeInfo; - - - - Details - - GITypeInfo - - GITypeInfo - - typedef GIBaseInfo GITypeInfo - Represents type information, direction, transfer etc. - - - - - GIUnionInfo - - Synopsis - -struct GIUnionInfo; - - - - Details - - GIUnionInfo - - GIUnionInfo - - typedef GIBaseInfo GIUnionInfo - Represents a union. - - - - - GIVFuncInfo - - Synopsis - -struct GIVFuncInfo; - - - - Details - - GIVFuncInfo - - GIVFuncInfo - - typedef GIBaseInfo GIVFuncInfo - Represents a virtual function. - - - - - GIValueInfo - - Synopsis - -struct GIValueInfo; - - - - Details - - GIValueInfo - - GIValueInfo - - typedef GIBaseInfo GIValueInfo - Represents a enum value of a #GIEnumInfo. - - - - - GIAttributeIter - - Synopsis - - -struct GIAttributeIter; - - - - Details - - struct GIAttributeIter - - GIAttributeIter - - struct GIAttributeIter; - - - - - GIBaseInfo - - Synopsis - - -struct GIBaseInfo; -gboolean g_base_info_equal (GIBaseInfo *baseinfo, - GIBaseInfo *info2); -gchar * g_base_info_get_attribute (GIBaseInfo *baseinfo, - gchar *name); -GIBaseInfo * g_base_info_get_container (GIBaseInfo *baseinfo); -gchar * g_base_info_get_name (GIBaseInfo *baseinfo); -gchar * g_base_info_get_namespace (GIBaseInfo *baseinfo); -GITypelib * g_base_info_get_typelib (GIBaseInfo *baseinfo); -gboolean g_base_info_is_deprecated (GIBaseInfo *baseinfo); -gboolean g_base_info_iterate_attributes (GIBaseInfo *baseinfo, - GIAttributeIter *iterator, - char *name, - char *value); -GIBaseInfo * g_base_info_ref (GIBaseInfo *baseinfo); -void g_base_info_unref (GIBaseInfo *baseinfo); - - - - Details - - struct GIBaseInfo - - GIBaseInfo - - struct GIBaseInfo; - - - g_base_info_equal () - - equal - - -gboolean g_base_info_equal (GIBaseInfo *baseinfo, - GIBaseInfo *info2); - - Compare two #GIBaseInfo. - -Using pointer comparison is not practical since many functions return -different instances of #GIBaseInfo that refers to the same part of the -TypeLib; use this function instead to do #GIBaseInfo comparisons. - - - -baseinfo : - - - instance - - - - - -info2 : - - - a #GIBaseInfo - - - - - -Returns : - - - %TRUE if and only if @info1 equals @info2. - - - - - - - g_base_info_get_attribute () - - get_attribute - - -gchar * g_base_info_get_attribute (GIBaseInfo *baseinfo, - gchar *name); - - Retrieve an arbitrary attribute associated with this node. - - - -baseinfo : - - - instance - - - - - -name : - - - a freeform string naming an attribute - - - - - -Returns : - - - The value of the attribute, or %NULL if no such attribute exists - - - - - - - g_base_info_get_container () - - get_container - - -GIBaseInfo * g_base_info_get_container (GIBaseInfo *baseinfo); - - Obtain the container of the @info. The container is the parent -GIBaseInfo. For instance, the parent of a #GIFunctionInfo is an -#GIObjectInfo or #GIInterfaceInfo. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the container - - - - - - - g_base_info_get_name () - - get_name - - -gchar * g_base_info_get_name (GIBaseInfo *baseinfo); - - Obtain the name of the @info. What the name represents depends on -the #GIInfoType of the @info. For instance for #GIFunctionInfo it is -the name of the function. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the name of @info or %NULL if it lacks a name. - - - - - - - g_base_info_get_namespace () - - get_namespace - - -gchar * g_base_info_get_namespace (GIBaseInfo *baseinfo); - - Obtain the namespace of @info. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the namespace - - - - - - - g_base_info_get_typelib () - - get_typelib - - -GITypelib * g_base_info_get_typelib (GIBaseInfo *baseinfo); - - Obtain the typelib this @info belongs to - - - -baseinfo : - - - instance - - - - - -Returns : - - - the typelib. - - - - - - - g_base_info_is_deprecated () - - is_deprecated - - -gboolean g_base_info_is_deprecated (GIBaseInfo *baseinfo); - - Obtain whether the @info is represents a metadata which is -deprecated or not. - - - -baseinfo : - - - instance - - - - - -Returns : - - - %TRUE if deprecated - - - - - - - g_base_info_iterate_attributes () - - iterate_attributes - - -gboolean g_base_info_iterate_attributes (GIBaseInfo *baseinfo, - GIAttributeIter *iterator, - char *name, - char *value); - - Iterate over all attributes associated with this node. 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. - -<example> -<title>Iterating over attributes</title> -<programlisting> -void -print_attributes (GIBaseInfo *info) -{ -GIAttributeIter iter = { 0, }; -char *name; -char *value; -while (g_base_info_iterate_attributes (info, &iter, &name, &value)) -{ -g_print ("attribute name: %s value: %s", name, value); -} -} -</programlisting> -</example> - - - -baseinfo : - - - instance - - - - - -iterator : - - - a #GIAttributeIter structure, must be initialized; see below - - - - - -name : - - - Returned name, must not be freed - - - - - -value : - - - Returned name, must not be freed - - - - - -Returns : - - - %TRUE if there are more attributes - - - - - - - g_base_info_ref () - - ref - - -GIBaseInfo * g_base_info_ref (GIBaseInfo *baseinfo); - - Increases the reference count of @info. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the same @info. - -[transfer full] - - - - - - - g_base_info_unref () - - unref - - -void g_base_info_unref (GIBaseInfo *baseinfo); - - Decreases the reference count of @info. When its reference count -drops to 0, the info is freed. - - - -baseinfo : - - - instance - - - - - -Returns - - - - - - - GIRepository - - Synopsis - - -struct GIRepository; -GList * g_irepository_enumerate_versions (GIRepository *repository, - gchar *namespace_); -GIEnumInfo * g_irepository_find_by_error_domain (GIRepository *repository, - GQuark domain); -GIBaseInfo * g_irepository_find_by_gtype (GIRepository *repository, - GType gtype); -GIBaseInfo * g_irepository_find_by_name (GIRepository *repository, - gchar *namespace_, - gchar *name); -gchar * g_irepository_get_c_prefix (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_dependencies (GIRepository *repository, - gchar *namespace_); -GIBaseInfo * g_irepository_get_info (GIRepository *repository, - gchar *namespace_, - gint index); -gchar * g_irepository_get_loaded_namespaces (GIRepository *repository); -gint g_irepository_get_n_infos (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_shared_library (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_typelib_path (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_version (GIRepository *repository, - gchar *namespace_); -gboolean g_irepository_is_registered (GIRepository *repository, - gchar *namespace_, - gchar *version); -char * g_irepository_load_typelib (GIRepository *repository, - GITypelib *typelib, - GIRepositoryLoadFlags flags); -GITypelib * g_irepository_require (GIRepository *repository, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); -GITypelib * g_irepository_require_private (GIRepository *repository, - gchar *typelib_dir, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); - - - - Object Hierarchy - - GObject - +----GIRepository - - - Details - - struct GIRepository - - GIRepository - - struct GIRepository; - - - g_irepository_enumerate_versions () - - enumerate_versions - - -GList * g_irepository_enumerate_versions (GIRepository *repository, - gchar *namespace_); - - Obtain an unordered list of versions (either currently loaded or -available) for @namespace_ in this @repository. - - - -repository : - - - instance - - - - - -namespace_ : - - - GI namespace, e.g. "Gtk" - - - - - -Returns : - - - the array of versions. - -[element-type utf8][transfer full] - - - - - - - g_irepository_find_by_error_domain () - - find_by_error_domain - - -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. - -enum type, or %NULL - - - -repository : - - - instance - - - - - -domain : - - - a #GError domain - - - - - -Returns : - - - #GIEnumInfo representing metadata about @domain's - -[transfer full] - - - - - - - g_irepository_find_by_gtype () - - find_by_gtype - - -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. - - - -repository : - - - instance - - - - - -gtype : - - - GType to search for - - - - - -Returns : - - - #GIBaseInfo representing metadata about @type, or %NULL - -[transfer full] - - - - - - - g_irepository_find_by_name () - - find_by_name - - -GIBaseInfo * g_irepository_find_by_name (GIRepository *repository, - gchar *namespace_, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace which will be searched - - - - - -name : - - - Entry name to find - - - - - -Returns : - - - #GIBaseInfo representing metadata about @name, or %NULL - -[transfer full] - - - - - - - g_irepository_get_c_prefix () - - get_c_prefix - - -gchar * g_irepository_get_c_prefix (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - C namespace prefix, or %NULL if none associated - - - - - - - g_irepository_get_dependencies () - - get_dependencies - - -gchar * g_irepository_get_dependencies (GIRepository *repository, - gchar *namespace_); - - Return an array of all (transitive) dependencies for namespace -@namespace_, including version. The returned strings are of the -form <code>namespace-version</code>. - -Note: The namespace must have already been loaded using a function -such as g_irepository_require() before calling this function. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace of interest - - - - - -Returns : - - - Zero-terminated string array of versioned dependencies - -[element-type utf8][transfer full] - - - - - - - g_irepository_get_info () - - get_info - - -GIBaseInfo * g_irepository_get_info (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -index : - - - 0-based offset into namespace metadata for entry - - - - - -Returns : - - - #GIBaseInfo containing metadata - -[transfer full] - - - - - - - g_irepository_get_loaded_namespaces () - - get_loaded_namespaces - - -gchar * g_irepository_get_loaded_namespaces (GIRepository *repository); - - Return the list of currently loaded namespaces. - - - -repository : - - - instance - - - - - -Returns : - - - List of namespaces - -[element-type utf8][transfer full] - - - - - - - g_irepository_get_n_infos () - - get_n_infos - - -gint g_irepository_get_n_infos (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - number of metadata entries - - - - - - - g_irepository_get_shared_library () - - get_shared_library - - -gchar * g_irepository_get_shared_library (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - Full path to shared library, or %NULL if none associated - - - - - - - g_irepository_get_typelib_path () - - get_typelib_path - - -gchar * g_irepository_get_typelib_path (GIRepository *repository, - 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 "$lt;builtin$gt;". - - - -repository : - - - instance - - - - - -namespace_ : - - - GI namespace to use, e.g. "Gtk" - - - - - -Returns : - - - Filesystem path (or $lt;builtin$gt;) if successful, %NULL if namespace is not loaded - - - - - - - g_irepository_get_version () - - get_version - - -gchar * g_irepository_get_version (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - Loaded version - - - - - - - g_irepository_is_registered () - - is_registered - - -gboolean g_irepository_is_registered (GIRepository *repository, - gchar *namespace_, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace of interest - - - - - -version : - - - Required version, may be %NULL for latest - -[allow-none] - - - - - -Returns : - - - %TRUE if namespace-version is loaded, %FALSE otherwise - - - - - - - g_irepository_load_typelib () - - load_typelib - - -char * g_irepository_load_typelib (GIRepository *repository, - GITypelib *typelib, - GIRepositoryLoadFlags flags); - - - - - -repository : - - - instance - - - - - -typelib - - - -flags - - - -Returns - - - - - g_irepository_require () - - require - - -GITypelib * g_irepository_require (GIRepository *repository, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); - - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - GI namespace to use, e.g. "Gtk" - - - - - -version : - - - Version of namespace, may be %NULL for latest - -[allow-none] - - - - - -flags : - - - Set of %GIRepositoryLoadFlags, may be 0 - - - - - -Returns : - - - a pointer to the #GITypelib if successful, %NULL otherwise - - - - - - - g_irepository_require_private () - - require_private - - -GITypelib * g_irepository_require_private (GIRepository *repository, - gchar *typelib_dir, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); - - 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. - - - -repository : - - - instance - - - - - -typelib_dir : - - - Private directory where to find the requested typelib - - - - - -namespace_ : - - - GI namespace to use, e.g. "Gtk" - - - - - -version : - - - Version of namespace, may be %NULL for latest - -[allow-none] - - - - - -flags : - - - Set of %GIRepositoryLoadFlags, may be 0 - - - - - -Returns : - - - a pointer to the #GITypelib if successful, %NULL otherwise - - - - - - - - - GIRepositoryClass - - Synopsis - - -struct GIRepositoryClass; - - - - Details - - struct GIRepositoryClass - - GIRepositoryClass - - struct GIRepositoryClass; - - - - - GIRepositoryPrivate - - Synopsis - - -struct GIRepositoryPrivate; - - - - Details - - struct GIRepositoryPrivate - - GIRepositoryPrivate - - struct GIRepositoryPrivate; - - - - - GITypelib - - Synopsis - - -struct GITypelib; -void g_typelib_free (GITypelib *typelib); -gchar * g_typelib_get_namespace (GITypelib *typelib); -gboolean g_typelib_symbol (GITypelib *typelib, - gchar *symbol_name, - gpointer *symbol); - - - - Details - - struct GITypelib - - GITypelib - - struct GITypelib; - - - g_typelib_free () - - free - - -void g_typelib_free (GITypelib *typelib); - - - - - -typelib : - - - instance - - - - - -Returns - - - - - g_typelib_get_namespace () - - get_namespace - - -gchar * g_typelib_get_namespace (GITypelib *typelib); - - - - - -typelib : - - - instance - - - - - -Returns - - - - - g_typelib_symbol () - - symbol - - -gboolean g_typelib_symbol (GITypelib *typelib, - gchar *symbol_name, - gpointer *symbol); - - - - - -typelib : - - - instance - - - - - -symbol_name - - - -symbol - - - -Returns - - - - - - - GIUnresolvedInfo - - Synopsis - - -struct GIUnresolvedInfo; - - - - Details - - struct GIUnresolvedInfo - - GIUnresolvedInfo - - struct GIUnresolvedInfo; - - - - - _GIBaseInfoStub - - Synopsis - - -struct _GIBaseInfoStub; - - - - Details - - struct _GIBaseInfoStub - - _GIBaseInfoStub - - struct _GIBaseInfoStub; - - - - diff --git a/tests/doctool/GIRepository-2.0-Python-expected.page b/tests/doctool/GIRepository-2.0-Python-expected.page new file mode 100644 index 0000000..badacf0 --- /dev/null +++ b/tests/doctool/GIRepository-2.0-Python-expected.page @@ -0,0 +1,19 @@ + + + + + GIRepository Documentation + + Classes + + + Functions + + + Other + + diff --git a/tests/doctool/GIRepository-2.0-Python-expected.xml b/tests/doctool/GIRepository-2.0-Python-expected.xml deleted file mode 100644 index af26d19..0000000 --- a/tests/doctool/GIRepository-2.0-Python-expected.xml +++ /dev/null @@ -1,1823 +0,0 @@ - - - -]> - - GIRepository Documentation - - GIRepository.ArgInfo - - Synopsis - -class GIRepository.ArgInfo: - - - - Details - - GIArgInfo - - GIArgInfo - - typedef GIBaseInfo GIArgInfo - Represents an argument. - - - - - GIRepository.CallableInfo - - Synopsis - -class GIRepository.CallableInfo: - - - - Details - - GICallableInfo - - GICallableInfo - - typedef GIBaseInfo GICallableInfo - Represents a callable, either #GIFunctionInfo, #GICallbackInfo or -#GIVFuncInfo. - - - - - GIRepository.CallbackInfo - - Synopsis - -class GIRepository.CallbackInfo: - - - - Details - - GICallbackInfo - - GICallbackInfo - - typedef GIBaseInfo GICallbackInfo - Represents a callback, eg arguments and return value. - - - - - GIRepository.ConstantInfo - - Synopsis - -class GIRepository.ConstantInfo: - - - - Details - - GIConstantInfo - - GIConstantInfo - - typedef GIBaseInfo GIConstantInfo - Represents a constant. - - - - - GIRepository.EnumInfo - - Synopsis - -class GIRepository.EnumInfo: - - - - Details - - GIEnumInfo - - GIEnumInfo - - typedef GIBaseInfo GIEnumInfo - Represents an enum or a flag. - - - - - GIRepository.FieldInfo - - Synopsis - -class GIRepository.FieldInfo: - - - - Details - - GIFieldInfo - - GIFieldInfo - - typedef GIBaseInfo GIFieldInfo - Represents a field of a #GIStructInfo or a #GIUnionInfo. - - - - - GIRepository.FunctionInfo - - Synopsis - -class GIRepository.FunctionInfo: - - - - Details - - GIFunctionInfo - - GIFunctionInfo - - typedef GIBaseInfo GIFunctionInfo - Represents a function, eg arguments and return value. - - - - - GIRepository.InterfaceInfo - - Synopsis - -class GIRepository.InterfaceInfo: - - - - Details - - GIInterfaceInfo - - GIInterfaceInfo - - typedef GIBaseInfo GIInterfaceInfo - Represents an interface. - - - - - GIRepository.ObjectInfo - - Synopsis - -class GIRepository.ObjectInfo: - - - - Details - - GIObjectInfo - - GIObjectInfo - - typedef GIBaseInfo GIObjectInfo - Represents an object. - - - - - GIRepository.PropertyInfo - - Synopsis - -class GIRepository.PropertyInfo: - - - - Details - - GIPropertyInfo - - GIPropertyInfo - - typedef GIBaseInfo GIPropertyInfo - Represents a property of a #GIObjectInfo or a #GIInterfaceInfo. - - - - - GIRepository.RegisteredTypeInfo - - Synopsis - -class GIRepository.RegisteredTypeInfo: - - - - Details - - GIRegisteredTypeInfo - - GIRegisteredTypeInfo - - typedef GIBaseInfo GIRegisteredTypeInfo - Represent a registered type. - - - - - GIRepository.SignalInfo - - Synopsis - -class GIRepository.SignalInfo: - - - - Details - - GISignalInfo - - GISignalInfo - - typedef GIBaseInfo GISignalInfo - Represents a signal. - - - - - GIRepository.StructInfo - - Synopsis - -class GIRepository.StructInfo: - - - - Details - - GIStructInfo - - GIStructInfo - - typedef GIBaseInfo GIStructInfo - Represents a struct. - - - - - GIRepository.TypeInfo - - Synopsis - -class GIRepository.TypeInfo: - - - - Details - - GITypeInfo - - GITypeInfo - - typedef GIBaseInfo GITypeInfo - Represents type information, direction, transfer etc. - - - - - GIRepository.UnionInfo - - Synopsis - -class GIRepository.UnionInfo: - - - - Details - - GIUnionInfo - - GIUnionInfo - - typedef GIBaseInfo GIUnionInfo - Represents a union. - - - - - GIRepository.VFuncInfo - - Synopsis - -class GIRepository.VFuncInfo: - - - - Details - - GIVFuncInfo - - GIVFuncInfo - - typedef GIBaseInfo GIVFuncInfo - Represents a virtual function. - - - - - GIRepository.ValueInfo - - Synopsis - -class GIRepository.ValueInfo: - - - - Details - - GIValueInfo - - GIValueInfo - - typedef GIBaseInfo GIValueInfo - Represents a enum value of a #GIEnumInfo. - - - - - GIRepository.AttributeIter - - Synopsis - - -class GIRepository.AttributeIter: - - - - Details - - struct GIAttributeIter - - GIAttributeIter - - struct GIAttributeIter; - - - - - GIRepository.BaseInfo - - Synopsis - - -class GIRepository.BaseInfo: -gboolean g_base_info_equal (GIBaseInfo *baseinfo, - GIBaseInfo *info2); -gchar * g_base_info_get_attribute (GIBaseInfo *baseinfo, - gchar *name); -GIBaseInfo * g_base_info_get_container (GIBaseInfo *baseinfo); -gchar * g_base_info_get_name (GIBaseInfo *baseinfo); -gchar * g_base_info_get_namespace (GIBaseInfo *baseinfo); -GITypelib * g_base_info_get_typelib (GIBaseInfo *baseinfo); -gboolean g_base_info_is_deprecated (GIBaseInfo *baseinfo); -gboolean g_base_info_iterate_attributes (GIBaseInfo *baseinfo, - GIAttributeIter *iterator, - char *name, - char *value); -GIBaseInfo * g_base_info_ref (GIBaseInfo *baseinfo); -void g_base_info_unref (GIBaseInfo *baseinfo); - - - - Details - - struct GIBaseInfo - - GIBaseInfo - - struct GIBaseInfo; - - - g_base_info_equal () - - equal - - -gboolean g_base_info_equal (GIBaseInfo *baseinfo, - GIBaseInfo *info2); - - Compare two #GIBaseInfo. - -Using pointer comparison is not practical since many functions return -different instances of #GIBaseInfo that refers to the same part of the -TypeLib; use this function instead to do #GIBaseInfo comparisons. - - - -baseinfo : - - - instance - - - - - -info2 : - - - a #GIBaseInfo - - - - - -Returns : - - - %TRUE if and only if @info1 equals @info2. - - - - - - - g_base_info_get_attribute () - - get_attribute - - -gchar * g_base_info_get_attribute (GIBaseInfo *baseinfo, - gchar *name); - - Retrieve an arbitrary attribute associated with this node. - - - -baseinfo : - - - instance - - - - - -name : - - - a freeform string naming an attribute - - - - - -Returns : - - - The value of the attribute, or %NULL if no such attribute exists - - - - - - - g_base_info_get_container () - - get_container - - -GIBaseInfo * g_base_info_get_container (GIBaseInfo *baseinfo); - - Obtain the container of the @info. The container is the parent -GIBaseInfo. For instance, the parent of a #GIFunctionInfo is an -#GIObjectInfo or #GIInterfaceInfo. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the container - - - - - - - g_base_info_get_name () - - get_name - - -gchar * g_base_info_get_name (GIBaseInfo *baseinfo); - - Obtain the name of the @info. What the name represents depends on -the #GIInfoType of the @info. For instance for #GIFunctionInfo it is -the name of the function. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the name of @info or %NULL if it lacks a name. - - - - - - - g_base_info_get_namespace () - - get_namespace - - -gchar * g_base_info_get_namespace (GIBaseInfo *baseinfo); - - Obtain the namespace of @info. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the namespace - - - - - - - g_base_info_get_typelib () - - get_typelib - - -GITypelib * g_base_info_get_typelib (GIBaseInfo *baseinfo); - - Obtain the typelib this @info belongs to - - - -baseinfo : - - - instance - - - - - -Returns : - - - the typelib. - - - - - - - g_base_info_is_deprecated () - - is_deprecated - - -gboolean g_base_info_is_deprecated (GIBaseInfo *baseinfo); - - Obtain whether the @info is represents a metadata which is -deprecated or not. - - - -baseinfo : - - - instance - - - - - -Returns : - - - %TRUE if deprecated - - - - - - - g_base_info_iterate_attributes () - - iterate_attributes - - -gboolean g_base_info_iterate_attributes (GIBaseInfo *baseinfo, - GIAttributeIter *iterator, - char *name, - char *value); - - Iterate over all attributes associated with this node. 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. - -<example> -<title>Iterating over attributes</title> -<programlisting> -void -print_attributes (GIBaseInfo *info) -{ -GIAttributeIter iter = { 0, }; -char *name; -char *value; -while (g_base_info_iterate_attributes (info, &iter, &name, &value)) -{ -g_print ("attribute name: %s value: %s", name, value); -} -} -</programlisting> -</example> - - - -baseinfo : - - - instance - - - - - -iterator : - - - a #GIAttributeIter structure, must be initialized; see below - - - - - -name : - - - Returned name, must not be freed - - - - - -value : - - - Returned name, must not be freed - - - - - -Returns : - - - %TRUE if there are more attributes - - - - - - - g_base_info_ref () - - ref - - -GIBaseInfo * g_base_info_ref (GIBaseInfo *baseinfo); - - Increases the reference count of @info. - - - -baseinfo : - - - instance - - - - - -Returns : - - - the same @info. - -[transfer full] - - - - - - - g_base_info_unref () - - unref - - -void g_base_info_unref (GIBaseInfo *baseinfo); - - Decreases the reference count of @info. When its reference count -drops to 0, the info is freed. - - - -baseinfo : - - - instance - - - - - -Returns - - - - - - - GIRepository.Repository - - Synopsis - - -class GIRepository.Repository(GObject.Object): -GList * g_irepository_enumerate_versions (GIRepository *repository, - gchar *namespace_); -GIEnumInfo * g_irepository_find_by_error_domain (GIRepository *repository, - GQuark domain); -GIBaseInfo * g_irepository_find_by_gtype (GIRepository *repository, - GType gtype); -GIBaseInfo * g_irepository_find_by_name (GIRepository *repository, - gchar *namespace_, - gchar *name); -gchar * g_irepository_get_c_prefix (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_dependencies (GIRepository *repository, - gchar *namespace_); -GIBaseInfo * g_irepository_get_info (GIRepository *repository, - gchar *namespace_, - gint index); -gchar * g_irepository_get_loaded_namespaces (GIRepository *repository); -gint g_irepository_get_n_infos (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_shared_library (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_typelib_path (GIRepository *repository, - gchar *namespace_); -gchar * g_irepository_get_version (GIRepository *repository, - gchar *namespace_); -gboolean g_irepository_is_registered (GIRepository *repository, - gchar *namespace_, - gchar *version); -char * g_irepository_load_typelib (GIRepository *repository, - GITypelib *typelib, - GIRepositoryLoadFlags flags); -GITypelib * g_irepository_require (GIRepository *repository, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); -GITypelib * g_irepository_require_private (GIRepository *repository, - gchar *typelib_dir, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); - - - - Object Hierarchy - - GObject - +----GIRepository - - - Details - - struct GIRepository - - GIRepository - - struct GIRepository; - - - g_irepository_enumerate_versions () - - enumerate_versions - - -GList * g_irepository_enumerate_versions (GIRepository *repository, - gchar *namespace_); - - Obtain an unordered list of versions (either currently loaded or -available) for @namespace_ in this @repository. - - - -repository : - - - instance - - - - - -namespace_ : - - - GI namespace, e.g. "Gtk" - - - - - -Returns : - - - the array of versions. - -[element-type utf8][transfer full] - - - - - - - g_irepository_find_by_error_domain () - - find_by_error_domain - - -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. - -enum type, or %NULL - - - -repository : - - - instance - - - - - -domain : - - - a #GError domain - - - - - -Returns : - - - #GIEnumInfo representing metadata about @domain's - -[transfer full] - - - - - - - g_irepository_find_by_gtype () - - find_by_gtype - - -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. - - - -repository : - - - instance - - - - - -gtype : - - - GType to search for - - - - - -Returns : - - - #GIBaseInfo representing metadata about @type, or %NULL - -[transfer full] - - - - - - - g_irepository_find_by_name () - - find_by_name - - -GIBaseInfo * g_irepository_find_by_name (GIRepository *repository, - gchar *namespace_, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace which will be searched - - - - - -name : - - - Entry name to find - - - - - -Returns : - - - #GIBaseInfo representing metadata about @name, or %NULL - -[transfer full] - - - - - - - g_irepository_get_c_prefix () - - get_c_prefix - - -gchar * g_irepository_get_c_prefix (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - C namespace prefix, or %NULL if none associated - - - - - - - g_irepository_get_dependencies () - - get_dependencies - - -gchar * g_irepository_get_dependencies (GIRepository *repository, - gchar *namespace_); - - Return an array of all (transitive) dependencies for namespace -@namespace_, including version. The returned strings are of the -form <code>namespace-version</code>. - -Note: The namespace must have already been loaded using a function -such as g_irepository_require() before calling this function. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace of interest - - - - - -Returns : - - - Zero-terminated string array of versioned dependencies - -[element-type utf8][transfer full] - - - - - - - g_irepository_get_info () - - get_info - - -GIBaseInfo * g_irepository_get_info (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -index : - - - 0-based offset into namespace metadata for entry - - - - - -Returns : - - - #GIBaseInfo containing metadata - -[transfer full] - - - - - - - g_irepository_get_loaded_namespaces () - - get_loaded_namespaces - - -gchar * g_irepository_get_loaded_namespaces (GIRepository *repository); - - Return the list of currently loaded namespaces. - - - -repository : - - - instance - - - - - -Returns : - - - List of namespaces - -[element-type utf8][transfer full] - - - - - - - g_irepository_get_n_infos () - - get_n_infos - - -gint g_irepository_get_n_infos (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - number of metadata entries - - - - - - - g_irepository_get_shared_library () - - get_shared_library - - -gchar * g_irepository_get_shared_library (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - Full path to shared library, or %NULL if none associated - - - - - - - g_irepository_get_typelib_path () - - get_typelib_path - - -gchar * g_irepository_get_typelib_path (GIRepository *repository, - 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 "$lt;builtin$gt;". - - - -repository : - - - instance - - - - - -namespace_ : - - - GI namespace to use, e.g. "Gtk" - - - - - -Returns : - - - Filesystem path (or $lt;builtin$gt;) if successful, %NULL if namespace is not loaded - - - - - - - g_irepository_get_version () - - get_version - - -gchar * g_irepository_get_version (GIRepository *repository, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace to inspect - - - - - -Returns : - - - Loaded version - - - - - - - g_irepository_is_registered () - - is_registered - - -gboolean g_irepository_is_registered (GIRepository *repository, - gchar *namespace_, - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - Namespace of interest - - - - - -version : - - - Required version, may be %NULL for latest - -[allow-none] - - - - - -Returns : - - - %TRUE if namespace-version is loaded, %FALSE otherwise - - - - - - - g_irepository_load_typelib () - - load_typelib - - -char * g_irepository_load_typelib (GIRepository *repository, - GITypelib *typelib, - GIRepositoryLoadFlags flags); - - - - - -repository : - - - instance - - - - - -typelib - - - -flags - - - -Returns - - - - - g_irepository_require () - - require - - -GITypelib * g_irepository_require (GIRepository *repository, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); - - 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. - - - -repository : - - - instance - - - - - -namespace_ : - - - GI namespace to use, e.g. "Gtk" - - - - - -version : - - - Version of namespace, may be %NULL for latest - -[allow-none] - - - - - -flags : - - - Set of %GIRepositoryLoadFlags, may be 0 - - - - - -Returns : - - - a pointer to the #GITypelib if successful, %NULL otherwise - - - - - - - g_irepository_require_private () - - require_private - - -GITypelib * g_irepository_require_private (GIRepository *repository, - gchar *typelib_dir, - gchar *namespace_, - gchar *version, - GIRepositoryLoadFlags flags); - - 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. - - - -repository : - - - instance - - - - - -typelib_dir : - - - Private directory where to find the requested typelib - - - - - -namespace_ : - - - GI namespace to use, e.g. "Gtk" - - - - - -version : - - - Version of namespace, may be %NULL for latest - -[allow-none] - - - - - -flags : - - - Set of %GIRepositoryLoadFlags, may be 0 - - - - - -Returns : - - - a pointer to the #GITypelib if successful, %NULL otherwise - - - - - - - - - GIRepository.RepositoryClass - - Synopsis - - -class GIRepository.RepositoryClass: - - - - Details - - struct GIRepositoryClass - - GIRepositoryClass - - struct GIRepositoryClass; - - - - - GIRepository.RepositoryPrivate - - Synopsis - - -class GIRepository.RepositoryPrivate: - - - - Details - - struct GIRepositoryPrivate - - GIRepositoryPrivate - - struct GIRepositoryPrivate; - - - - - GIRepository.Typelib - - Synopsis - - -class GIRepository.Typelib: -void g_typelib_free (GITypelib *typelib); -gchar * g_typelib_get_namespace (GITypelib *typelib); -gboolean g_typelib_symbol (GITypelib *typelib, - gchar *symbol_name, - gpointer *symbol); - - - - Details - - struct GITypelib - - GITypelib - - struct GITypelib; - - - g_typelib_free () - - free - - -void g_typelib_free (GITypelib *typelib); - - - - - -typelib : - - - instance - - - - - -Returns - - - - - g_typelib_get_namespace () - - get_namespace - - -gchar * g_typelib_get_namespace (GITypelib *typelib); - - - - - -typelib : - - - instance - - - - - -Returns - - - - - g_typelib_symbol () - - symbol - - -gboolean g_typelib_symbol (GITypelib *typelib, - gchar *symbol_name, - gpointer *symbol); - - - - - -typelib : - - - instance - - - - - -symbol_name - - - -symbol - - - -Returns - - - - - - - GIRepository.UnresolvedInfo - - Synopsis - - -class GIRepository.UnresolvedInfo: - - - - Details - - struct GIUnresolvedInfo - - GIUnresolvedInfo - - struct GIUnresolvedInfo; - - - - - GIRepository._BaseInfoStub - - Synopsis - - -class GIRepository._BaseInfoStub: - - - - Details - - struct _GIBaseInfoStub - - _GIBaseInfoStub - - struct _GIBaseInfoStub; - - - - diff --git a/tests/doctool/Makefile.am b/tests/doctool/Makefile.am index 75ca4bc..801eefb 100644 --- a/tests/doctool/Makefile.am +++ b/tests/doctool/Makefile.am @@ -4,23 +4,23 @@ GIRepository-2.0.gir: cp ../../GIRepository-2.0.gir . GIRS = GIRepository-2.0.gir -CHECKXML = $(GIRS:.gir=-C.xml.check) $(GIRS:.gir=-Python.xml.check) -DOCBOOKFILES = $(GIRS:.gir=-C.xml) $(GIRS:.gir=-Python.xml) -EXPECTEDDOCBOOKFILES = $(DOCBOOKFILES:.xml=-expected.xml) -CLEANFILES = $(DOCBOOK_FILES) -BUILT_SOURCES = $(DOCBOOK_FILES) -EXTRA_DIST = $(EXPECTEDDOCBOOKFILES) +CHECKXML = $(GIRS:.gir=-C.page.check) $(GIRS:.gir=-Python.page.check) +MALLARDFILES = $(GIRS:.gir=-C.page) $(GIRS:.gir=-Python.page) +EXPECTEDMALLARDFILES = $(MALLARDFILES:.page=-expected.page) +CLEANFILES = $(MALLARD_FILES) +BUILT_SOURCES = $(MALLARD_FILES) +EXTRA_DIST = $(EXPECTEDMALLARDFILES) -%-C.xml: %.gir - $(INTROSPECTION_DOCTOOL) --language C $*.gir -o $*-C.xml && echo " GEN $*-C.xml" +%-C.page: %.gir + $(INTROSPECTION_DOCTOOL) --language C --format mallard $*.gir -o $*-C.page && echo " GEN $*-C.page" -%-Python.xml: %.gir - $(INTROSPECTION_DOCTOOL) --language Python $*.gir -o $*-Python.xml && echo " GEN $*-Python.xml" +%-Python.page: %.gir + $(INTROSPECTION_DOCTOOL) --language Python --format mallard $*.gir -o $*-Python.page && echo " GEN $*-Python.page" -%-C.xml.check: %-C.xml - @diff -u -U 10 $(srcdir)/$*-C-expected.xml $*-C.xml && echo " TEST $*-C.xml" +%-C.page.check: %-C.page + @diff -u -U 10 $(srcdir)/$*-C-expected.page $*-C.page && echo " TEST $*-C.page" -%-Python.xml.check: %-Python.xml - @diff -u -U 10 $(srcdir)/$*-Python-expected.xml $*-Python.xml && echo " TEST $*-Python.xml" +%-Python.page.check: %-Python.page + @diff -u -U 10 $(srcdir)/$*-Python-expected.page $*-Python.page && echo " TEST $*-Python.page" check-local: $(CHECKXML) -- 2.7.4