diff options
| author | Tomeu Vizoso <tomeu.vizoso@collabora.co.uk> | 2011-08-15 14:04:03 +0200 |
|---|---|---|
| committer | Tomeu Vizoso <tomeu.vizoso@collabora.co.uk> | 2011-08-15 14:07:28 +0200 |
| commit | 216c11ec554534913fcbcbe421b0f9e6a2f1028a (patch) | |
| tree | 833cedd59da4ab092acf9597ceea35ec69b49b03 | |
| parent | 57143d2bf01db4f9013193a2a2148b83b03c6722 (diff) | |
| download | gobject-introspection-216c11ec554534913fcbcbe421b0f9e6a2f1028a.tar.gz | |
tests/doctool: Switch to test the mallard formatter
| -rw-r--r-- | tests/doctool/GIRepository-2.0-C-expected.page | 19 | ||||
| -rw-r--r-- | tests/doctool/GIRepository-2.0-C-expected.xml | 1823 | ||||
| -rw-r--r-- | tests/doctool/GIRepository-2.0-Python-expected.page | 19 | ||||
| -rw-r--r-- | tests/doctool/GIRepository-2.0-Python-expected.xml | 1823 | ||||
| -rw-r--r-- | tests/doctool/Makefile.am | 28 |
5 files changed, 52 insertions, 3660 deletions
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 00000000..badacf05 --- /dev/null +++ b/tests/doctool/GIRepository-2.0-C-expected.page @@ -0,0 +1,19 @@ +<?xml version="1.0"?> +<page id="index" + type="guide" + style="namespace" + xmlns="http://projectmallard.org/1.0/" + xmlns:ui="http://projectmallard.org/experimental/ui/"> + <info> + </info> + <title>GIRepository Documentation</title> + <links type="topic" ui:expanded="yes" groups="class"> + <title>Classes</title> + </links> + <links type="topic" ui:expanded="yes" groups="function"> + <title>Functions</title> + </links> + <links type="topic" ui:expanded="yes" groups="#first #default #last"> + <title>Other</title> + </links> +</page> 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 50c8f732..00000000 --- a/tests/doctool/GIRepository-2.0-C-expected.xml +++ /dev/null @@ -1,1823 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -<!ENTITY version SYSTEM "version.xml"> -]> -<book xml:id="page_GIRepository" - xmlns="http://docbook.org/ns/docbook" - version="5.0"> - <title>GIRepository Documentation</title> - <chapter xml:id="ch_GIArgInfo"> - <title>GIArgInfo</title> - <refsynopsisdiv id="GIArgInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIArgInfo-struct">GIArgInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giarginfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIArgInfo" role="typedef"> - <title>GIArgInfo</title> - <indexterm zone="GIArgInfo"> - <primary sortas="ArgInfo">GIArgInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIArgInfo</programlisting> - <para>Represents an argument.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GICallableInfo"> - <title>GICallableInfo</title> - <refsynopsisdiv id="GICallableInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GICallableInfo-struct">GICallableInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gicallableinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GICallableInfo" role="typedef"> - <title>GICallableInfo</title> - <indexterm zone="GICallableInfo"> - <primary sortas="CallableInfo">GICallableInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GICallableInfo</programlisting> - <para>Represents a callable, either #GIFunctionInfo, #GICallbackInfo or -#GIVFuncInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GICallbackInfo"> - <title>GICallbackInfo</title> - <refsynopsisdiv id="GICallbackInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GICallbackInfo-struct">GICallbackInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gicallbackinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GICallbackInfo" role="typedef"> - <title>GICallbackInfo</title> - <indexterm zone="GICallbackInfo"> - <primary sortas="CallbackInfo">GICallbackInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GICallbackInfo</programlisting> - <para>Represents a callback, eg arguments and return value.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIConstantInfo"> - <title>GIConstantInfo</title> - <refsynopsisdiv id="GIConstantInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIConstantInfo-struct">GIConstantInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giconstantinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIConstantInfo" role="typedef"> - <title>GIConstantInfo</title> - <indexterm zone="GIConstantInfo"> - <primary sortas="ConstantInfo">GIConstantInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIConstantInfo</programlisting> - <para>Represents a constant.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIEnumInfo"> - <title>GIEnumInfo</title> - <refsynopsisdiv id="GIEnumInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIEnumInfo-struct">GIEnumInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gienuminfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIEnumInfo" role="typedef"> - <title>GIEnumInfo</title> - <indexterm zone="GIEnumInfo"> - <primary sortas="EnumInfo">GIEnumInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIEnumInfo</programlisting> - <para>Represents an enum or a flag.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIFieldInfo"> - <title>GIFieldInfo</title> - <refsynopsisdiv id="GIFieldInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIFieldInfo-struct">GIFieldInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gifieldinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIFieldInfo" role="typedef"> - <title>GIFieldInfo</title> - <indexterm zone="GIFieldInfo"> - <primary sortas="FieldInfo">GIFieldInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIFieldInfo</programlisting> - <para>Represents a field of a #GIStructInfo or a #GIUnionInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIFunctionInfo"> - <title>GIFunctionInfo</title> - <refsynopsisdiv id="GIFunctionInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIFunctionInfo-struct">GIFunctionInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gifunctioninfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIFunctionInfo" role="typedef"> - <title>GIFunctionInfo</title> - <indexterm zone="GIFunctionInfo"> - <primary sortas="FunctionInfo">GIFunctionInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIFunctionInfo</programlisting> - <para>Represents a function, eg arguments and return value.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIInterfaceInfo"> - <title>GIInterfaceInfo</title> - <refsynopsisdiv id="GIInterfaceInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIInterfaceInfo-struct">GIInterfaceInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giinterfaceinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIInterfaceInfo" role="typedef"> - <title>GIInterfaceInfo</title> - <indexterm zone="GIInterfaceInfo"> - <primary sortas="InterfaceInfo">GIInterfaceInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIInterfaceInfo</programlisting> - <para>Represents an interface.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIObjectInfo"> - <title>GIObjectInfo</title> - <refsynopsisdiv id="GIObjectInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIObjectInfo-struct">GIObjectInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giobjectinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIObjectInfo" role="typedef"> - <title>GIObjectInfo</title> - <indexterm zone="GIObjectInfo"> - <primary sortas="ObjectInfo">GIObjectInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIObjectInfo</programlisting> - <para>Represents an object.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIPropertyInfo"> - <title>GIPropertyInfo</title> - <refsynopsisdiv id="GIPropertyInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIPropertyInfo-struct">GIPropertyInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gipropertyinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIPropertyInfo" role="typedef"> - <title>GIPropertyInfo</title> - <indexterm zone="GIPropertyInfo"> - <primary sortas="PropertyInfo">GIPropertyInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIPropertyInfo</programlisting> - <para>Represents a property of a #GIObjectInfo or a #GIInterfaceInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIRegisteredTypeInfo"> - <title>GIRegisteredTypeInfo</title> - <refsynopsisdiv id="GIRegisteredTypeInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIRegisteredTypeInfo-struct">GIRegisteredTypeInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giregisteredtypeinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRegisteredTypeInfo" role="typedef"> - <title>GIRegisteredTypeInfo</title> - <indexterm zone="GIRegisteredTypeInfo"> - <primary sortas="RegisteredTypeInfo">GIRegisteredTypeInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIRegisteredTypeInfo</programlisting> - <para>Represent a registered type.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GISignalInfo"> - <title>GISignalInfo</title> - <refsynopsisdiv id="GISignalInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GISignalInfo-struct">GISignalInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gisignalinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GISignalInfo" role="typedef"> - <title>GISignalInfo</title> - <indexterm zone="GISignalInfo"> - <primary sortas="SignalInfo">GISignalInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GISignalInfo</programlisting> - <para>Represents a signal.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIStructInfo"> - <title>GIStructInfo</title> - <refsynopsisdiv id="GIStructInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIStructInfo-struct">GIStructInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gistructinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIStructInfo" role="typedef"> - <title>GIStructInfo</title> - <indexterm zone="GIStructInfo"> - <primary sortas="StructInfo">GIStructInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIStructInfo</programlisting> - <para>Represents a struct.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GITypeInfo"> - <title>GITypeInfo</title> - <refsynopsisdiv id="GITypeInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GITypeInfo-struct">GITypeInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="gitypeinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GITypeInfo" role="typedef"> - <title>GITypeInfo</title> - <indexterm zone="GITypeInfo"> - <primary sortas="TypeInfo">GITypeInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GITypeInfo</programlisting> - <para>Represents type information, direction, transfer etc.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIUnionInfo"> - <title>GIUnionInfo</title> - <refsynopsisdiv id="GIUnionInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIUnionInfo-struct">GIUnionInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giunioninfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIUnionInfo" role="typedef"> - <title>GIUnionInfo</title> - <indexterm zone="GIUnionInfo"> - <primary sortas="UnionInfo">GIUnionInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIUnionInfo</programlisting> - <para>Represents a union.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIVFuncInfo"> - <title>GIVFuncInfo</title> - <refsynopsisdiv id="GIVFuncInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIVFuncInfo-struct">GIVFuncInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="givfuncinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIVFuncInfo" role="typedef"> - <title>GIVFuncInfo</title> - <indexterm zone="GIVFuncInfo"> - <primary sortas="VFuncInfo">GIVFuncInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIVFuncInfo</programlisting> - <para>Represents a virtual function.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIValueInfo"> - <title>GIValueInfo</title> - <refsynopsisdiv id="GIValueInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -struct <link linkend="GIValueInfo-struct">GIValueInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="givalueinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIValueInfo" role="typedef"> - <title>GIValueInfo</title> - <indexterm zone="GIValueInfo"> - <primary sortas="ValueInfo">GIValueInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIValueInfo</programlisting> - <para>Represents a enum value of a #GIEnumInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIAttributeIter"> - <title>GIAttributeIter</title> - <refsynopsisdiv id="GIAttributeIter.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GIAttributeIter"/> - <synopsis> -struct <link linkend="GIAttributeIter-struct">GIAttributeIter</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giattributeiter-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIAttributeIter-struct" role="struct"> - <title>struct GIAttributeIter</title> - <indexterm zone="GIAttributeIter-struct"> - <primary sortas="AttributeIter">GIAttributeIter</primary> - </indexterm> - <programlisting>struct GIAttributeIter;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIBaseInfo"> - <title>GIBaseInfo</title> - <refsynopsisdiv id="GIBaseInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GIBaseInfo"/> - <synopsis> -struct <link linkend="GIBaseInfo-struct">GIBaseInfo</link>; -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-base-info-equal">g_base_info_equal</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *info2</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-base-info-get-attribute">g_base_info_get_attribute</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-base-info-get-container">g_base_info_get_container</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-base-info-get-name">g_base_info_get_name</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-base-info-get-namespace">g_base_info_get_namespace</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * <link linkend="g-base-info-get-typelib">g_base_info_get_typelib</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-base-info-is-deprecated">g_base_info_is_deprecated</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-base-info-iterate-attributes">g_base_info_iterate_attributes</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIAttributeIter"><type>GIAttributeIter</type></link> *iterator, </parameter> - <parameter><link linkend="char"><type>char</type></link> *name, </parameter> - <parameter><link linkend="char"><type>char</type></link> *value</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-base-info-ref">g_base_info_ref</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="g-base-info-unref">g_base_info_unref</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </synopsis> - </refsynopsisdiv> - <refsect1 id="gibaseinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIBaseInfo-struct" role="struct"> - <title>struct GIBaseInfo</title> - <indexterm zone="GIBaseInfo-struct"> - <primary sortas="BaseInfo">GIBaseInfo</primary> - </indexterm> - <programlisting>struct GIBaseInfo;</programlisting> - </refsect2> - <refsect2 id="g-base-info-equal" role="function"> - <title>g_base_info_equal ()</title> - <indexterm zone="g-base-info-equal"> - <primary>equal</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_base_info_equal (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *info2</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>info2</parameter> : </term> - <listitem> - <simpara> - a #GIBaseInfo - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if and only if @info1 equals @info2. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-attribute" role="function"> - <title>g_base_info_get_attribute ()</title> - <indexterm zone="g-base-info-get-attribute"> - <primary>get_attribute</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_base_info_get_attribute (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); - </programlisting> - <para>Retrieve an arbitrary attribute associated with this node.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>name</parameter> : </term> - <listitem> - <simpara> - a freeform string naming an attribute - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - The value of the attribute, or %NULL if no such attribute exists - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-container" role="function"> - <title>g_base_info_get_container ()</title> - <indexterm zone="g-base-info-get-container"> - <primary>get_container</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_base_info_get_container (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain the container of the @info. The container is the parent -GIBaseInfo. For instance, the parent of a #GIFunctionInfo is an -#GIObjectInfo or #GIInterfaceInfo.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the container - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-name" role="function"> - <title>g_base_info_get_name ()</title> - <indexterm zone="g-base-info-get-name"> - <primary>get_name</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_base_info_get_name (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the name of @info or %NULL if it lacks a name. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-namespace" role="function"> - <title>g_base_info_get_namespace ()</title> - <indexterm zone="g-base-info-get-namespace"> - <primary>get_namespace</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_base_info_get_namespace (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain the namespace of @info.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the namespace - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-typelib" role="function"> - <title>g_base_info_get_typelib ()</title> - <indexterm zone="g-base-info-get-typelib"> - <primary>get_typelib</primary> - </indexterm> - <programlisting> -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * g_base_info_get_typelib (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain the typelib this @info belongs to</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the typelib. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-is-deprecated" role="function"> - <title>g_base_info_is_deprecated ()</title> - <indexterm zone="g-base-info-is-deprecated"> - <primary>is_deprecated</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_base_info_is_deprecated (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain whether the @info is represents a metadata which is -deprecated or not.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if deprecated - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-iterate-attributes" role="function"> - <title>g_base_info_iterate_attributes ()</title> - <indexterm zone="g-base-info-iterate-attributes"> - <primary>iterate_attributes</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_base_info_iterate_attributes (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIAttributeIter"><type>GIAttributeIter</type></link> *iterator, </parameter> - <parameter><link linkend="char"><type>char</type></link> *name, </parameter> - <parameter><link linkend="char"><type>char</type></link> *value</parameter>); - </programlisting> - <para>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></para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>iterator</parameter> : </term> - <listitem> - <simpara> - a #GIAttributeIter structure, must be initialized; see below - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>name</parameter> : </term> - <listitem> - <simpara> - Returned name, must not be freed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>value</parameter> : </term> - <listitem> - <simpara> - Returned name, must not be freed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if there are more attributes - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-ref" role="function"> - <title>g_base_info_ref ()</title> - <indexterm zone="g-base-info-ref"> - <primary>ref</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_base_info_ref (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Increases the reference count of @info.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the same @info. - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-unref" role="function"> - <title>g_base_info_unref ()</title> - <indexterm zone="g-base-info-unref"> - <primary>unref</primary> - </indexterm> - <programlisting> -<link linkend="void"><returnvalue>void</returnvalue></link> g_base_info_unref (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Decreases the reference count of @info. When its reference count -drops to 0, the info is freed.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIRepository"> - <title>GIRepository</title> - <refsynopsisdiv id="GIRepository.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GIRepository"/> - <synopsis> -struct <link linkend="GIRepository-struct">GIRepository</link>; -<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="g-irepository-enumerate-versions">g_irepository_enumerate_versions</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="GIEnumInfo"><returnvalue>GIEnumInfo</returnvalue></link> * <link linkend="g-irepository-find-by-error-domain">g_irepository_find_by_error_domain</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GQuark"><type>GQuark</type></link> domain</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-irepository-find-by-gtype">g_irepository_find_by_gtype</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GType"><type>GType</type></link> gtype</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-irepository-find-by-name">g_irepository_find_by_name</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-c-prefix">g_irepository_get_c_prefix</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-dependencies">g_irepository_get_dependencies</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-irepository-get-info">g_irepository_get_info</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gint"><type>gint</type></link> index</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-loaded-namespaces">g_irepository_get_loaded_namespaces</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository</parameter>); -<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="g-irepository-get-n-infos">g_irepository_get_n_infos</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-shared-library">g_irepository_get_shared_library</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-typelib-path">g_irepository_get_typelib_path</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-version">g_irepository_get_version</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-irepository-is-registered">g_irepository_is_registered</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version</parameter>); -<link linkend="char"><returnvalue>char</returnvalue></link> * <link linkend="g-irepository-load-typelib">g_irepository_load_typelib</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * <link linkend="g-irepository-require">g_irepository_require</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * <link linkend="g-irepository-require-private">g_irepository_require_private</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *typelib_dir, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </synopsis> - </refsynopsisdiv> - <refsect1 id="GIRepository.object-hierarchy" role="object_hierarchy"> - <title role="object_hierarchy.title">Object Hierarchy</title> - <synopsis> - GObject - +----GIRepository </synopsis> - </refsect1> - <refsect1 id="girepository-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRepository-struct" role="struct"> - <title>struct GIRepository</title> - <indexterm zone="GIRepository-struct"> - <primary sortas="Repository">GIRepository</primary> - </indexterm> - <programlisting>struct GIRepository;</programlisting> - </refsect2> - <refsect2 id="g-irepository-enumerate-versions" role="function"> - <title>g_irepository_enumerate_versions ()</title> - <indexterm zone="g-irepository-enumerate-versions"> - <primary>enumerate_versions</primary> - </indexterm> - <programlisting> -<link linkend="GList"><returnvalue>GList</returnvalue></link> * g_irepository_enumerate_versions (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>Obtain an unordered list of versions (either currently loaded or -available) for @namespace_ in this @repository.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the array of versions. - <emphasis role="annotation"> -[element-type utf8][transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-find-by-error-domain" role="function"> - <title>g_irepository_find_by_error_domain ()</title> - <indexterm zone="g-irepository-find-by-error-domain"> - <primary>find_by_error_domain</primary> - </indexterm> - <programlisting> -<link linkend="GIEnumInfo"><returnvalue>GIEnumInfo</returnvalue></link> * g_irepository_find_by_error_domain (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GQuark"><type>GQuark</type></link> domain</parameter>); - </programlisting> - <para>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</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>domain</parameter> : </term> - <listitem> - <simpara> - a #GError domain - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIEnumInfo representing metadata about @domain's - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-find-by-gtype" role="function"> - <title>g_irepository_find_by_gtype ()</title> - <indexterm zone="g-irepository-find-by-gtype"> - <primary>find_by_gtype</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_irepository_find_by_gtype (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GType"><type>GType</type></link> gtype</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>gtype</parameter> : </term> - <listitem> - <simpara> - GType to search for - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIBaseInfo representing metadata about @type, or %NULL - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-find-by-name" role="function"> - <title>g_irepository_find_by_name ()</title> - <indexterm zone="g-irepository-find-by-name"> - <primary>find_by_name</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_irepository_find_by_name (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace which will be searched - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>name</parameter> : </term> - <listitem> - <simpara> - Entry name to find - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIBaseInfo representing metadata about @name, or %NULL - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-c-prefix" role="function"> - <title>g_irepository_get_c_prefix ()</title> - <indexterm zone="g-irepository-get-c-prefix"> - <primary>get_c_prefix</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_c_prefix (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - C namespace prefix, or %NULL if none associated - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-dependencies" role="function"> - <title>g_irepository_get_dependencies ()</title> - <indexterm zone="g-irepository-get-dependencies"> - <primary>get_dependencies</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_dependencies (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace of interest - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Zero-terminated string array of versioned dependencies - <emphasis role="annotation"> -[element-type utf8][transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-info" role="function"> - <title>g_irepository_get_info ()</title> - <indexterm zone="g-irepository-get-info"> - <primary>get_info</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_irepository_get_info (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gint"><type>gint</type></link> index</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>index</parameter> : </term> - <listitem> - <simpara> - 0-based offset into namespace metadata for entry - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIBaseInfo containing metadata - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-loaded-namespaces" role="function"> - <title>g_irepository_get_loaded_namespaces ()</title> - <indexterm zone="g-irepository-get-loaded-namespaces"> - <primary>get_loaded_namespaces</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_loaded_namespaces (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository</parameter>); - </programlisting> - <para>Return the list of currently loaded namespaces.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - List of namespaces - <emphasis role="annotation"> -[element-type utf8][transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-n-infos" role="function"> - <title>g_irepository_get_n_infos ()</title> - <indexterm zone="g-irepository-get-n-infos"> - <primary>get_n_infos</primary> - </indexterm> - <programlisting> -<link linkend="gint"><returnvalue>gint</returnvalue></link> g_irepository_get_n_infos (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>This function returns the number of metadata entries in -given namespace @namespace_. The namespace must have -already been loaded before calling this function.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - number of metadata entries - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-shared-library" role="function"> - <title>g_irepository_get_shared_library ()</title> - <indexterm zone="g-irepository-get-shared-library"> - <primary>get_shared_library</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_shared_library (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Full path to shared library, or %NULL if none associated - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-typelib-path" role="function"> - <title>g_irepository_get_typelib_path ()</title> - <indexterm zone="g-irepository-get-typelib-path"> - <primary>get_typelib_path</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_typelib_path (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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;".</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace to use, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Filesystem path (or $lt;builtin$gt;) if successful, %NULL if namespace is not loaded - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-version" role="function"> - <title>g_irepository_get_version ()</title> - <indexterm zone="g-irepository-get-version"> - <primary>get_version</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_version (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Loaded version - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-is-registered" role="function"> - <title>g_irepository_is_registered ()</title> - <indexterm zone="g-irepository-is-registered"> - <primary>is_registered</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_irepository_is_registered (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace of interest - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>version</parameter> : </term> - <listitem> - <simpara> - Required version, may be %NULL for latest - <emphasis role="annotation"> -[allow-none] </emphasis> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if namespace-version is loaded, %FALSE otherwise - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-load-typelib" role="function"> - <title>g_irepository_load_typelib ()</title> - <indexterm zone="g-irepository-load-typelib"> - <primary>load_typelib</primary> - </indexterm> - <programlisting> -<link linkend="char"><returnvalue>char</returnvalue></link> * g_irepository_load_typelib (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>typelib</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>flags</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-require" role="function"> - <title>g_irepository_require ()</title> - <indexterm zone="g-irepository-require"> - <primary>require</primary> - </indexterm> - <programlisting> -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * g_irepository_require (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace to use, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>version</parameter> : </term> - <listitem> - <simpara> - Version of namespace, may be %NULL for latest - <emphasis role="annotation"> -[allow-none] </emphasis> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>flags</parameter> : </term> - <listitem> - <simpara> - Set of %GIRepositoryLoadFlags, may be 0 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - a pointer to the #GITypelib if successful, %NULL otherwise - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-require-private" role="function"> - <title>g_irepository_require_private ()</title> - <indexterm zone="g-irepository-require-private"> - <primary>require_private</primary> - </indexterm> - <programlisting> -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * g_irepository_require_private (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *typelib_dir, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>typelib_dir</parameter> : </term> - <listitem> - <simpara> - Private directory where to find the requested typelib - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace to use, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>version</parameter> : </term> - <listitem> - <simpara> - Version of namespace, may be %NULL for latest - <emphasis role="annotation"> -[allow-none] </emphasis> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>flags</parameter> : </term> - <listitem> - <simpara> - Set of %GIRepositoryLoadFlags, may be 0 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - a pointer to the #GITypelib if successful, %NULL otherwise - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIRepositoryClass"> - <title>GIRepositoryClass</title> - <refsynopsisdiv id="GIRepositoryClass.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GIRepositoryClass"/> - <synopsis> -struct <link linkend="GIRepositoryClass-struct">GIRepositoryClass</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="girepositoryclass-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRepositoryClass-struct" role="struct"> - <title>struct GIRepositoryClass</title> - <indexterm zone="GIRepositoryClass-struct"> - <primary sortas="RepositoryClass">GIRepositoryClass</primary> - </indexterm> - <programlisting>struct GIRepositoryClass;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIRepositoryPrivate"> - <title>GIRepositoryPrivate</title> - <refsynopsisdiv id="GIRepositoryPrivate.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GIRepositoryPrivate"/> - <synopsis> -struct <link linkend="GIRepositoryPrivate-struct">GIRepositoryPrivate</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="girepositoryprivate-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRepositoryPrivate-struct" role="struct"> - <title>struct GIRepositoryPrivate</title> - <indexterm zone="GIRepositoryPrivate-struct"> - <primary sortas="RepositoryPrivate">GIRepositoryPrivate</primary> - </indexterm> - <programlisting>struct GIRepositoryPrivate;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GITypelib"> - <title>GITypelib</title> - <refsynopsisdiv id="GITypelib.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GITypelib"/> - <synopsis> -struct <link linkend="GITypelib-struct">GITypelib</link>; -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="g-typelib-free">g_typelib_free</link> (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-typelib-get-namespace">g_typelib_get_namespace</link> (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-typelib-symbol">g_typelib_symbol</link> (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *symbol_name, </parameter> - <parameter><link linkend="gpointer"><type>gpointer</type></link> *symbol</parameter>); - </synopsis> - </refsynopsisdiv> - <refsect1 id="gitypelib-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GITypelib-struct" role="struct"> - <title>struct GITypelib</title> - <indexterm zone="GITypelib-struct"> - <primary sortas="Typelib">GITypelib</primary> - </indexterm> - <programlisting>struct GITypelib;</programlisting> - </refsect2> - <refsect2 id="g-typelib-free" role="function"> - <title>g_typelib_free ()</title> - <indexterm zone="g-typelib-free"> - <primary>free</primary> - </indexterm> - <programlisting> -<link linkend="void"><returnvalue>void</returnvalue></link> g_typelib_free (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>typelib</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-typelib-get-namespace" role="function"> - <title>g_typelib_get_namespace ()</title> - <indexterm zone="g-typelib-get-namespace"> - <primary>get_namespace</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_typelib_get_namespace (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>typelib</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-typelib-symbol" role="function"> - <title>g_typelib_symbol ()</title> - <indexterm zone="g-typelib-symbol"> - <primary>symbol</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_typelib_symbol (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *symbol_name, </parameter> - <parameter><link linkend="gpointer"><type>gpointer</type></link> *symbol</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>typelib</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>symbol_name</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>symbol</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_GIUnresolvedInfo"> - <title>GIUnresolvedInfo</title> - <refsynopsisdiv id="GIUnresolvedInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="GIUnresolvedInfo"/> - <synopsis> -struct <link linkend="GIUnresolvedInfo-struct">GIUnresolvedInfo</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="giunresolvedinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIUnresolvedInfo-struct" role="struct"> - <title>struct GIUnresolvedInfo</title> - <indexterm zone="GIUnresolvedInfo-struct"> - <primary sortas="UnresolvedInfo">GIUnresolvedInfo</primary> - </indexterm> - <programlisting>struct GIUnresolvedInfo;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch__GIBaseInfoStub"> - <title>_GIBaseInfoStub</title> - <refsynopsisdiv id="_GIBaseInfoStub.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="_GIBaseInfoStub"/> - <synopsis> -struct <link linkend="_GIBaseInfoStub-struct">_GIBaseInfoStub</link>; - </synopsis> - </refsynopsisdiv> - <refsect1 id="_gibaseinfostub-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="_GIBaseInfoStub-struct" role="struct"> - <title>struct _GIBaseInfoStub</title> - <indexterm zone="_GIBaseInfoStub-struct"> - <primary sortas="_BaseInfoStub">_GIBaseInfoStub</primary> - </indexterm> - <programlisting>struct _GIBaseInfoStub;</programlisting> - </refsect2> - </refsect1> - </chapter> -</book> 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 00000000..badacf05 --- /dev/null +++ b/tests/doctool/GIRepository-2.0-Python-expected.page @@ -0,0 +1,19 @@ +<?xml version="1.0"?> +<page id="index" + type="guide" + style="namespace" + xmlns="http://projectmallard.org/1.0/" + xmlns:ui="http://projectmallard.org/experimental/ui/"> + <info> + </info> + <title>GIRepository Documentation</title> + <links type="topic" ui:expanded="yes" groups="class"> + <title>Classes</title> + </links> + <links type="topic" ui:expanded="yes" groups="function"> + <title>Functions</title> + </links> + <links type="topic" ui:expanded="yes" groups="#first #default #last"> + <title>Other</title> + </links> +</page> 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 af26d192..00000000 --- a/tests/doctool/GIRepository-2.0-Python-expected.xml +++ /dev/null @@ -1,1823 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -<!ENTITY version SYSTEM "version.xml"> -]> -<book xml:id="page_GIRepository" - xmlns="http://docbook.org/ns/docbook" - version="5.0"> - <title>GIRepository Documentation</title> - <chapter xml:id="ch_ArgInfo"> - <title>GIRepository.ArgInfo</title> - <refsynopsisdiv id="ArgInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.ArgInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giarginfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIArgInfo" role="typedef"> - <title>GIArgInfo</title> - <indexterm zone="GIArgInfo"> - <primary sortas="ArgInfo">GIArgInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIArgInfo</programlisting> - <para>Represents an argument.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_CallableInfo"> - <title>GIRepository.CallableInfo</title> - <refsynopsisdiv id="CallableInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.CallableInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gicallableinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GICallableInfo" role="typedef"> - <title>GICallableInfo</title> - <indexterm zone="GICallableInfo"> - <primary sortas="CallableInfo">GICallableInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GICallableInfo</programlisting> - <para>Represents a callable, either #GIFunctionInfo, #GICallbackInfo or -#GIVFuncInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_CallbackInfo"> - <title>GIRepository.CallbackInfo</title> - <refsynopsisdiv id="CallbackInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.CallbackInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gicallbackinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GICallbackInfo" role="typedef"> - <title>GICallbackInfo</title> - <indexterm zone="GICallbackInfo"> - <primary sortas="CallbackInfo">GICallbackInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GICallbackInfo</programlisting> - <para>Represents a callback, eg arguments and return value.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_ConstantInfo"> - <title>GIRepository.ConstantInfo</title> - <refsynopsisdiv id="ConstantInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.ConstantInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giconstantinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIConstantInfo" role="typedef"> - <title>GIConstantInfo</title> - <indexterm zone="GIConstantInfo"> - <primary sortas="ConstantInfo">GIConstantInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIConstantInfo</programlisting> - <para>Represents a constant.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_EnumInfo"> - <title>GIRepository.EnumInfo</title> - <refsynopsisdiv id="EnumInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.EnumInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gienuminfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIEnumInfo" role="typedef"> - <title>GIEnumInfo</title> - <indexterm zone="GIEnumInfo"> - <primary sortas="EnumInfo">GIEnumInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIEnumInfo</programlisting> - <para>Represents an enum or a flag.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_FieldInfo"> - <title>GIRepository.FieldInfo</title> - <refsynopsisdiv id="FieldInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.FieldInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gifieldinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIFieldInfo" role="typedef"> - <title>GIFieldInfo</title> - <indexterm zone="GIFieldInfo"> - <primary sortas="FieldInfo">GIFieldInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIFieldInfo</programlisting> - <para>Represents a field of a #GIStructInfo or a #GIUnionInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_FunctionInfo"> - <title>GIRepository.FunctionInfo</title> - <refsynopsisdiv id="FunctionInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.FunctionInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gifunctioninfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIFunctionInfo" role="typedef"> - <title>GIFunctionInfo</title> - <indexterm zone="GIFunctionInfo"> - <primary sortas="FunctionInfo">GIFunctionInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIFunctionInfo</programlisting> - <para>Represents a function, eg arguments and return value.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_InterfaceInfo"> - <title>GIRepository.InterfaceInfo</title> - <refsynopsisdiv id="InterfaceInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.InterfaceInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giinterfaceinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIInterfaceInfo" role="typedef"> - <title>GIInterfaceInfo</title> - <indexterm zone="GIInterfaceInfo"> - <primary sortas="InterfaceInfo">GIInterfaceInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIInterfaceInfo</programlisting> - <para>Represents an interface.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_ObjectInfo"> - <title>GIRepository.ObjectInfo</title> - <refsynopsisdiv id="ObjectInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.ObjectInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giobjectinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIObjectInfo" role="typedef"> - <title>GIObjectInfo</title> - <indexterm zone="GIObjectInfo"> - <primary sortas="ObjectInfo">GIObjectInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIObjectInfo</programlisting> - <para>Represents an object.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_PropertyInfo"> - <title>GIRepository.PropertyInfo</title> - <refsynopsisdiv id="PropertyInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.PropertyInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gipropertyinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIPropertyInfo" role="typedef"> - <title>GIPropertyInfo</title> - <indexterm zone="GIPropertyInfo"> - <primary sortas="PropertyInfo">GIPropertyInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIPropertyInfo</programlisting> - <para>Represents a property of a #GIObjectInfo or a #GIInterfaceInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_RegisteredTypeInfo"> - <title>GIRepository.RegisteredTypeInfo</title> - <refsynopsisdiv id="RegisteredTypeInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.RegisteredTypeInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giregisteredtypeinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRegisteredTypeInfo" role="typedef"> - <title>GIRegisteredTypeInfo</title> - <indexterm zone="GIRegisteredTypeInfo"> - <primary sortas="RegisteredTypeInfo">GIRegisteredTypeInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIRegisteredTypeInfo</programlisting> - <para>Represent a registered type.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_SignalInfo"> - <title>GIRepository.SignalInfo</title> - <refsynopsisdiv id="SignalInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.SignalInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gisignalinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GISignalInfo" role="typedef"> - <title>GISignalInfo</title> - <indexterm zone="GISignalInfo"> - <primary sortas="SignalInfo">GISignalInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GISignalInfo</programlisting> - <para>Represents a signal.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_StructInfo"> - <title>GIRepository.StructInfo</title> - <refsynopsisdiv id="StructInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.StructInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gistructinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIStructInfo" role="typedef"> - <title>GIStructInfo</title> - <indexterm zone="GIStructInfo"> - <primary sortas="StructInfo">GIStructInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIStructInfo</programlisting> - <para>Represents a struct.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_TypeInfo"> - <title>GIRepository.TypeInfo</title> - <refsynopsisdiv id="TypeInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.TypeInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="gitypeinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GITypeInfo" role="typedef"> - <title>GITypeInfo</title> - <indexterm zone="GITypeInfo"> - <primary sortas="TypeInfo">GITypeInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GITypeInfo</programlisting> - <para>Represents type information, direction, transfer etc.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_UnionInfo"> - <title>GIRepository.UnionInfo</title> - <refsynopsisdiv id="UnionInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.UnionInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giunioninfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIUnionInfo" role="typedef"> - <title>GIUnionInfo</title> - <indexterm zone="GIUnionInfo"> - <primary sortas="UnionInfo">GIUnionInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIUnionInfo</programlisting> - <para>Represents a union.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_VFuncInfo"> - <title>GIRepository.VFuncInfo</title> - <refsynopsisdiv id="VFuncInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.VFuncInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="givfuncinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIVFuncInfo" role="typedef"> - <title>GIVFuncInfo</title> - <indexterm zone="GIVFuncInfo"> - <primary sortas="VFuncInfo">GIVFuncInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIVFuncInfo</programlisting> - <para>Represents a virtual function.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_ValueInfo"> - <title>GIRepository.ValueInfo</title> - <refsynopsisdiv id="ValueInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> -class GIRepository.ValueInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="givalueinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIValueInfo" role="typedef"> - <title>GIValueInfo</title> - <indexterm zone="GIValueInfo"> - <primary sortas="ValueInfo">GIValueInfo</primary> - </indexterm> - <programlisting>typedef GIBaseInfo GIValueInfo</programlisting> - <para>Represents a enum value of a #GIEnumInfo.</para> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_AttributeIter"> - <title>GIRepository.AttributeIter</title> - <refsynopsisdiv id="AttributeIter.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="AttributeIter"/> - <synopsis> -class GIRepository.AttributeIter: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giattributeiter-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIAttributeIter-struct" role="struct"> - <title>struct GIAttributeIter</title> - <indexterm zone="GIAttributeIter-struct"> - <primary sortas="AttributeIter">GIAttributeIter</primary> - </indexterm> - <programlisting>struct GIAttributeIter;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_BaseInfo"> - <title>GIRepository.BaseInfo</title> - <refsynopsisdiv id="BaseInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="BaseInfo"/> - <synopsis> -class GIRepository.BaseInfo: -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-base-info-equal">g_base_info_equal</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *info2</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-base-info-get-attribute">g_base_info_get_attribute</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-base-info-get-container">g_base_info_get_container</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-base-info-get-name">g_base_info_get_name</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-base-info-get-namespace">g_base_info_get_namespace</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * <link linkend="g-base-info-get-typelib">g_base_info_get_typelib</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-base-info-is-deprecated">g_base_info_is_deprecated</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-base-info-iterate-attributes">g_base_info_iterate_attributes</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIAttributeIter"><type>GIAttributeIter</type></link> *iterator, </parameter> - <parameter><link linkend="char"><type>char</type></link> *name, </parameter> - <parameter><link linkend="char"><type>char</type></link> *value</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-base-info-ref">g_base_info_ref</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="g-base-info-unref">g_base_info_unref</link> (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </synopsis> - </refsynopsisdiv> - <refsect1 id="gibaseinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIBaseInfo-struct" role="struct"> - <title>struct GIBaseInfo</title> - <indexterm zone="GIBaseInfo-struct"> - <primary sortas="BaseInfo">GIBaseInfo</primary> - </indexterm> - <programlisting>struct GIBaseInfo;</programlisting> - </refsect2> - <refsect2 id="g-base-info-equal" role="function"> - <title>g_base_info_equal ()</title> - <indexterm zone="g-base-info-equal"> - <primary>equal</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_base_info_equal (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *info2</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>info2</parameter> : </term> - <listitem> - <simpara> - a #GIBaseInfo - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if and only if @info1 equals @info2. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-attribute" role="function"> - <title>g_base_info_get_attribute ()</title> - <indexterm zone="g-base-info-get-attribute"> - <primary>get_attribute</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_base_info_get_attribute (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); - </programlisting> - <para>Retrieve an arbitrary attribute associated with this node.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>name</parameter> : </term> - <listitem> - <simpara> - a freeform string naming an attribute - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - The value of the attribute, or %NULL if no such attribute exists - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-container" role="function"> - <title>g_base_info_get_container ()</title> - <indexterm zone="g-base-info-get-container"> - <primary>get_container</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_base_info_get_container (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain the container of the @info. The container is the parent -GIBaseInfo. For instance, the parent of a #GIFunctionInfo is an -#GIObjectInfo or #GIInterfaceInfo.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the container - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-name" role="function"> - <title>g_base_info_get_name ()</title> - <indexterm zone="g-base-info-get-name"> - <primary>get_name</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_base_info_get_name (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the name of @info or %NULL if it lacks a name. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-namespace" role="function"> - <title>g_base_info_get_namespace ()</title> - <indexterm zone="g-base-info-get-namespace"> - <primary>get_namespace</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_base_info_get_namespace (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain the namespace of @info.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the namespace - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-get-typelib" role="function"> - <title>g_base_info_get_typelib ()</title> - <indexterm zone="g-base-info-get-typelib"> - <primary>get_typelib</primary> - </indexterm> - <programlisting> -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * g_base_info_get_typelib (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain the typelib this @info belongs to</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the typelib. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-is-deprecated" role="function"> - <title>g_base_info_is_deprecated ()</title> - <indexterm zone="g-base-info-is-deprecated"> - <primary>is_deprecated</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_base_info_is_deprecated (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Obtain whether the @info is represents a metadata which is -deprecated or not.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if deprecated - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-iterate-attributes" role="function"> - <title>g_base_info_iterate_attributes ()</title> - <indexterm zone="g-base-info-iterate-attributes"> - <primary>iterate_attributes</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_base_info_iterate_attributes (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo, </parameter> - <parameter><link linkend="GIAttributeIter"><type>GIAttributeIter</type></link> *iterator, </parameter> - <parameter><link linkend="char"><type>char</type></link> *name, </parameter> - <parameter><link linkend="char"><type>char</type></link> *value</parameter>); - </programlisting> - <para>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></para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>iterator</parameter> : </term> - <listitem> - <simpara> - a #GIAttributeIter structure, must be initialized; see below - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>name</parameter> : </term> - <listitem> - <simpara> - Returned name, must not be freed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>value</parameter> : </term> - <listitem> - <simpara> - Returned name, must not be freed - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if there are more attributes - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-ref" role="function"> - <title>g_base_info_ref ()</title> - <indexterm zone="g-base-info-ref"> - <primary>ref</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_base_info_ref (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Increases the reference count of @info.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the same @info. - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-base-info-unref" role="function"> - <title>g_base_info_unref ()</title> - <indexterm zone="g-base-info-unref"> - <primary>unref</primary> - </indexterm> - <programlisting> -<link linkend="void"><returnvalue>void</returnvalue></link> g_base_info_unref (<parameter><link linkend="GIBaseInfo"><type>GIBaseInfo</type></link> *baseinfo</parameter>); - </programlisting> - <para>Decreases the reference count of @info. When its reference count -drops to 0, the info is freed.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>baseinfo</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_Repository"> - <title>GIRepository.Repository</title> - <refsynopsisdiv id="Repository.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="Repository"/> - <synopsis> -class GIRepository.Repository(GObject.Object): -<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="g-irepository-enumerate-versions">g_irepository_enumerate_versions</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="GIEnumInfo"><returnvalue>GIEnumInfo</returnvalue></link> * <link linkend="g-irepository-find-by-error-domain">g_irepository_find_by_error_domain</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GQuark"><type>GQuark</type></link> domain</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-irepository-find-by-gtype">g_irepository_find_by_gtype</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GType"><type>GType</type></link> gtype</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-irepository-find-by-name">g_irepository_find_by_name</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-c-prefix">g_irepository_get_c_prefix</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-dependencies">g_irepository_get_dependencies</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * <link linkend="g-irepository-get-info">g_irepository_get_info</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gint"><type>gint</type></link> index</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-loaded-namespaces">g_irepository_get_loaded_namespaces</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository</parameter>); -<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="g-irepository-get-n-infos">g_irepository_get_n_infos</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-shared-library">g_irepository_get_shared_library</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-typelib-path">g_irepository_get_typelib_path</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-irepository-get-version">g_irepository_get_version</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-irepository-is-registered">g_irepository_is_registered</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version</parameter>); -<link linkend="char"><returnvalue>char</returnvalue></link> * <link linkend="g-irepository-load-typelib">g_irepository_load_typelib</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * <link linkend="g-irepository-require">g_irepository_require</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * <link linkend="g-irepository-require-private">g_irepository_require_private</link> (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *typelib_dir, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </synopsis> - </refsynopsisdiv> - <refsect1 id="Repository.object-hierarchy" role="object_hierarchy"> - <title role="object_hierarchy.title">Object Hierarchy</title> - <synopsis> - GObject - +----GIRepository </synopsis> - </refsect1> - <refsect1 id="girepository-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRepository-struct" role="struct"> - <title>struct GIRepository</title> - <indexterm zone="GIRepository-struct"> - <primary sortas="Repository">GIRepository</primary> - </indexterm> - <programlisting>struct GIRepository;</programlisting> - </refsect2> - <refsect2 id="g-irepository-enumerate-versions" role="function"> - <title>g_irepository_enumerate_versions ()</title> - <indexterm zone="g-irepository-enumerate-versions"> - <primary>enumerate_versions</primary> - </indexterm> - <programlisting> -<link linkend="GList"><returnvalue>GList</returnvalue></link> * g_irepository_enumerate_versions (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>Obtain an unordered list of versions (either currently loaded or -available) for @namespace_ in this @repository.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - the array of versions. - <emphasis role="annotation"> -[element-type utf8][transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-find-by-error-domain" role="function"> - <title>g_irepository_find_by_error_domain ()</title> - <indexterm zone="g-irepository-find-by-error-domain"> - <primary>find_by_error_domain</primary> - </indexterm> - <programlisting> -<link linkend="GIEnumInfo"><returnvalue>GIEnumInfo</returnvalue></link> * g_irepository_find_by_error_domain (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GQuark"><type>GQuark</type></link> domain</parameter>); - </programlisting> - <para>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</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>domain</parameter> : </term> - <listitem> - <simpara> - a #GError domain - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIEnumInfo representing metadata about @domain's - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-find-by-gtype" role="function"> - <title>g_irepository_find_by_gtype ()</title> - <indexterm zone="g-irepository-find-by-gtype"> - <primary>find_by_gtype</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_irepository_find_by_gtype (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GType"><type>GType</type></link> gtype</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>gtype</parameter> : </term> - <listitem> - <simpara> - GType to search for - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIBaseInfo representing metadata about @type, or %NULL - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-find-by-name" role="function"> - <title>g_irepository_find_by_name ()</title> - <indexterm zone="g-irepository-find-by-name"> - <primary>find_by_name</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_irepository_find_by_name (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *name</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace which will be searched - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>name</parameter> : </term> - <listitem> - <simpara> - Entry name to find - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIBaseInfo representing metadata about @name, or %NULL - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-c-prefix" role="function"> - <title>g_irepository_get_c_prefix ()</title> - <indexterm zone="g-irepository-get-c-prefix"> - <primary>get_c_prefix</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_c_prefix (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - C namespace prefix, or %NULL if none associated - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-dependencies" role="function"> - <title>g_irepository_get_dependencies ()</title> - <indexterm zone="g-irepository-get-dependencies"> - <primary>get_dependencies</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_dependencies (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace of interest - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Zero-terminated string array of versioned dependencies - <emphasis role="annotation"> -[element-type utf8][transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-info" role="function"> - <title>g_irepository_get_info ()</title> - <indexterm zone="g-irepository-get-info"> - <primary>get_info</primary> - </indexterm> - <programlisting> -<link linkend="GIBaseInfo"><returnvalue>GIBaseInfo</returnvalue></link> * g_irepository_get_info (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gint"><type>gint</type></link> index</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>index</parameter> : </term> - <listitem> - <simpara> - 0-based offset into namespace metadata for entry - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - #GIBaseInfo containing metadata - <emphasis role="annotation"> -[transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-loaded-namespaces" role="function"> - <title>g_irepository_get_loaded_namespaces ()</title> - <indexterm zone="g-irepository-get-loaded-namespaces"> - <primary>get_loaded_namespaces</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_loaded_namespaces (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository</parameter>); - </programlisting> - <para>Return the list of currently loaded namespaces.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - List of namespaces - <emphasis role="annotation"> -[element-type utf8][transfer full] </emphasis> - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-n-infos" role="function"> - <title>g_irepository_get_n_infos ()</title> - <indexterm zone="g-irepository-get-n-infos"> - <primary>get_n_infos</primary> - </indexterm> - <programlisting> -<link linkend="gint"><returnvalue>gint</returnvalue></link> g_irepository_get_n_infos (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>This function returns the number of metadata entries in -given namespace @namespace_. The namespace must have -already been loaded before calling this function.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - number of metadata entries - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-shared-library" role="function"> - <title>g_irepository_get_shared_library ()</title> - <indexterm zone="g-irepository-get-shared-library"> - <primary>get_shared_library</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_shared_library (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Full path to shared library, or %NULL if none associated - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-typelib-path" role="function"> - <title>g_irepository_get_typelib_path ()</title> - <indexterm zone="g-irepository-get-typelib-path"> - <primary>get_typelib_path</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_typelib_path (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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;".</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace to use, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Filesystem path (or $lt;builtin$gt;) if successful, %NULL if namespace is not loaded - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-get-version" role="function"> - <title>g_irepository_get_version ()</title> - <indexterm zone="g-irepository-get-version"> - <primary>get_version</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_irepository_get_version (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace to inspect - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - Loaded version - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-is-registered" role="function"> - <title>g_irepository_is_registered ()</title> - <indexterm zone="g-irepository-is-registered"> - <primary>is_registered</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_irepository_is_registered (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - Namespace of interest - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>version</parameter> : </term> - <listitem> - <simpara> - Required version, may be %NULL for latest - <emphasis role="annotation"> -[allow-none] </emphasis> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - %TRUE if namespace-version is loaded, %FALSE otherwise - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-load-typelib" role="function"> - <title>g_irepository_load_typelib ()</title> - <indexterm zone="g-irepository-load-typelib"> - <primary>load_typelib</primary> - </indexterm> - <programlisting> -<link linkend="char"><returnvalue>char</returnvalue></link> * g_irepository_load_typelib (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>typelib</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>flags</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-require" role="function"> - <title>g_irepository_require ()</title> - <indexterm zone="g-irepository-require"> - <primary>require</primary> - </indexterm> - <programlisting> -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * g_irepository_require (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace to use, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>version</parameter> : </term> - <listitem> - <simpara> - Version of namespace, may be %NULL for latest - <emphasis role="annotation"> -[allow-none] </emphasis> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>flags</parameter> : </term> - <listitem> - <simpara> - Set of %GIRepositoryLoadFlags, may be 0 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - a pointer to the #GITypelib if successful, %NULL otherwise - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-irepository-require-private" role="function"> - <title>g_irepository_require_private ()</title> - <indexterm zone="g-irepository-require-private"> - <primary>require_private</primary> - </indexterm> - <programlisting> -<link linkend="GITypelib"><returnvalue>GITypelib</returnvalue></link> * g_irepository_require_private (<parameter><link linkend="GIRepository"><type>GIRepository</type></link> *repository, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *typelib_dir, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *namespace_, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *version, </parameter> - <parameter><link linkend="GIRepositoryLoadFlags"><type>GIRepositoryLoadFlags</type></link> flags</parameter>); - </programlisting> - <para>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.</para> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>repository</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>typelib_dir</parameter> : </term> - <listitem> - <simpara> - Private directory where to find the requested typelib - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>namespace_</parameter> : </term> - <listitem> - <simpara> - GI namespace to use, e.g. "Gtk" - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>version</parameter> : </term> - <listitem> - <simpara> - Version of namespace, may be %NULL for latest - <emphasis role="annotation"> -[allow-none] </emphasis> - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>flags</parameter> : </term> - <listitem> - <simpara> - Set of %GIRepositoryLoadFlags, may be 0 - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> : </term> - <listitem> - <simpara> - a pointer to the #GITypelib if successful, %NULL otherwise - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_RepositoryClass"> - <title>GIRepository.RepositoryClass</title> - <refsynopsisdiv id="RepositoryClass.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="RepositoryClass"/> - <synopsis> -class GIRepository.RepositoryClass: - </synopsis> - </refsynopsisdiv> - <refsect1 id="girepositoryclass-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRepositoryClass-struct" role="struct"> - <title>struct GIRepositoryClass</title> - <indexterm zone="GIRepositoryClass-struct"> - <primary sortas="RepositoryClass">GIRepositoryClass</primary> - </indexterm> - <programlisting>struct GIRepositoryClass;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_RepositoryPrivate"> - <title>GIRepository.RepositoryPrivate</title> - <refsynopsisdiv id="RepositoryPrivate.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="RepositoryPrivate"/> - <synopsis> -class GIRepository.RepositoryPrivate: - </synopsis> - </refsynopsisdiv> - <refsect1 id="girepositoryprivate-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIRepositoryPrivate-struct" role="struct"> - <title>struct GIRepositoryPrivate</title> - <indexterm zone="GIRepositoryPrivate-struct"> - <primary sortas="RepositoryPrivate">GIRepositoryPrivate</primary> - </indexterm> - <programlisting>struct GIRepositoryPrivate;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_Typelib"> - <title>GIRepository.Typelib</title> - <refsynopsisdiv id="Typelib.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="Typelib"/> - <synopsis> -class GIRepository.Typelib: -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="g-typelib-free">g_typelib_free</link> (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="g-typelib-get-namespace">g_typelib_get_namespace</link> (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="g-typelib-symbol">g_typelib_symbol</link> (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *symbol_name, </parameter> - <parameter><link linkend="gpointer"><type>gpointer</type></link> *symbol</parameter>); - </synopsis> - </refsynopsisdiv> - <refsect1 id="gitypelib-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GITypelib-struct" role="struct"> - <title>struct GITypelib</title> - <indexterm zone="GITypelib-struct"> - <primary sortas="Typelib">GITypelib</primary> - </indexterm> - <programlisting>struct GITypelib;</programlisting> - </refsect2> - <refsect2 id="g-typelib-free" role="function"> - <title>g_typelib_free ()</title> - <indexterm zone="g-typelib-free"> - <primary>free</primary> - </indexterm> - <programlisting> -<link linkend="void"><returnvalue>void</returnvalue></link> g_typelib_free (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>typelib</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-typelib-get-namespace" role="function"> - <title>g_typelib_get_namespace ()</title> - <indexterm zone="g-typelib-get-namespace"> - <primary>get_namespace</primary> - </indexterm> - <programlisting> -<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * g_typelib_get_namespace (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>typelib</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - <refsect2 id="g-typelib-symbol" role="function"> - <title>g_typelib_symbol ()</title> - <indexterm zone="g-typelib-symbol"> - <primary>symbol</primary> - </indexterm> - <programlisting> -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> g_typelib_symbol (<parameter><link linkend="GITypelib"><type>GITypelib</type></link> *typelib, </parameter> - <parameter><link linkend="gchar"><type>gchar</type></link> *symbol_name, </parameter> - <parameter><link linkend="gpointer"><type>gpointer</type></link> *symbol</parameter>); - </programlisting> - <para/> - <variablelist role="params"> - <varlistentry> - <term> -<parameter>typelib</parameter> : </term> - <listitem> - <simpara> - instance - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> -<parameter>symbol_name</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>symbol</parameter> </term> - </varlistentry> - <varlistentry> - <term> -<parameter>Returns</parameter> </term> - </varlistentry> - </variablelist> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch_UnresolvedInfo"> - <title>GIRepository.UnresolvedInfo</title> - <refsynopsisdiv id="UnresolvedInfo.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="UnresolvedInfo"/> - <synopsis> -class GIRepository.UnresolvedInfo: - </synopsis> - </refsynopsisdiv> - <refsect1 id="giunresolvedinfo-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="GIUnresolvedInfo-struct" role="struct"> - <title>struct GIUnresolvedInfo</title> - <indexterm zone="GIUnresolvedInfo-struct"> - <primary sortas="UnresolvedInfo">GIUnresolvedInfo</primary> - </indexterm> - <programlisting>struct GIUnresolvedInfo;</programlisting> - </refsect2> - </refsect1> - </chapter> - <chapter xml:id="ch__BaseInfoStub"> - <title>GIRepository._BaseInfoStub</title> - <refsynopsisdiv id="_BaseInfoStub.synopsis" role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <anchor id="_BaseInfoStub"/> - <synopsis> -class GIRepository._BaseInfoStub: - </synopsis> - </refsynopsisdiv> - <refsect1 id="_gibaseinfostub-details" role="details"> - <title role="details.title">Details</title> - <refsect2 id="_GIBaseInfoStub-struct" role="struct"> - <title>struct _GIBaseInfoStub</title> - <indexterm zone="_GIBaseInfoStub-struct"> - <primary sortas="_BaseInfoStub">_GIBaseInfoStub</primary> - </indexterm> - <programlisting>struct _GIBaseInfoStub;</programlisting> - </refsect2> - </refsect1> - </chapter> -</book> diff --git a/tests/doctool/Makefile.am b/tests/doctool/Makefile.am index 75ca4bc7..801eefb4 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) |