1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="appstream-as-metadata-private">
<refmeta>
<refentrytitle role="top_of_page" id="appstream-as-metadata-private.top_of_page">as-metadata-private</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>as-metadata-private</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1 id="appstream-as-metadata-private.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsComponent"><returnvalue>AsComponent</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-metadata-parse-component-node">as_metadata_parse_component_node</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-metadata-set-parser-mode">as_metadata_set_parser_mode</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsParserMode"><returnvalue>AsParserMode</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-metadata-get-parser-mode">as_metadata_get_parser_mode</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-metadata-set-origin-id">as_metadata_set_origin_id</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="appstream-as-metadata-private.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsParserMode">AsParserMode</link></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="appstream-as-metadata-private.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="appstream-as-metadata-private.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-metadata-parse-component-node" role="function">
<title>as_metadata_parse_component_node ()</title>
<indexterm zone="as-metadata-parse-component-node"><primary>as_metadata_parse_component_node</primary></indexterm>
<programlisting language="C"><link linkend="AsComponent"><returnvalue>AsComponent</returnvalue></link> *
as_metadata_parse_component_node (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>,
<parameter><link linkend="xmlNode"><type>xmlNode</type></link> *node</parameter>,
<parameter><link linkend="gboolean"><type>gboolean</type></link> allow_invalid</parameter>,
<parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<refsect3 role="returns">
<title>Returns</title>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-metadata-set-parser-mode" role="function">
<title>as_metadata_set_parser_mode ()</title>
<indexterm zone="as-metadata-set-parser-mode"><primary>as_metadata_set_parser_mode</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_metadata_set_parser_mode (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>,
<parameter><link linkend="AsParserMode"><type>AsParserMode</type></link> mode</parameter>);</programlisting>
<para>Sets the current metadata parsing mode.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsMetadata"><type>AsMetadata</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>mode</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsParserMode"><type>AsParserMode</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-metadata-get-parser-mode" role="function">
<title>as_metadata_get_parser_mode ()</title>
<indexterm zone="as-metadata-get-parser-mode"><primary>as_metadata_get_parser_mode</primary></indexterm>
<programlisting language="C"><link linkend="AsParserMode"><returnvalue>AsParserMode</returnvalue></link>
as_metadata_get_parser_mode (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>);</programlisting>
<para>Gets the current parser mode</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsMetadata"><type>AsMetadata</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> an <link linkend="AsParserMode"><type>AsParserMode</type></link></para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-metadata-set-origin-id" role="function">
<title>as_metadata_set_origin_id ()</title>
<indexterm zone="as-metadata-set-origin-id"><primary>as_metadata_set_origin_id</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_metadata_set_origin_id (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *origin</parameter>);</programlisting>
<para>Internal method to set the origin of AppStream distro metadata</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsMetadata"><type>AsMetadata</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>origin</para></entry>
<entry role="parameter_description"><para>the origin of AppStream distro metadata.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
<refsect1 id="appstream-as-metadata-private.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AsParserMode" role="enum">
<title>enum AsParserMode</title>
<indexterm zone="AsParserMode"><primary>AsParserMode</primary></indexterm>
<para>There are a few differences between Appstream's upstream metadata
and the distribution metadata.
The parser mode indicates which style we should process.
Usually you don't want to change this.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-PARSER-MODE-UPSTREAM:CAPS">AS_PARSER_MODE_UPSTREAM</para></entry>
<entry role="enum_member_description"><para>Parse Appstream upstream metadata</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-PARSER-MODE-DISTRO:CAPS">AS_PARSER_MODE_DISTRO</para></entry>
<entry role="enum_member_description"><para>Parse Appstream distribution metadata</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-PARSER-MODE-LAST:CAPS">AS_PARSER_MODE_LAST</para></entry>
<entry role="enum_member_description"></entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
</refentry>
|
