File: as-utils-private.xml

package info (click to toggle)
appstream 0.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,660 kB
  • ctags: 2,618
  • sloc: xml: 10,142; ansic: 8,362; cpp: 1,905; python: 236; sh: 58; makefile: 13
file content (234 lines) | stat: -rw-r--r-- 13,179 bytes parent folder | download
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?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-utils-private">
<refmeta>
<refentrytitle role="top_of_page" id="appstream-as-utils-private.top_of_page">as-utils-private</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>as-utils-private</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsect1 id="appstream-as-utils-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="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-utils-touch-dir">as_utils_touch_dir</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-utils-delete-dir-recursive">as_utils_delete_dir_recursive</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-string-strip">as_string_strip</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-utils-categories-from-strv">as_utils_categories_from_strv</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-utils-categories-from-str">as_utils_categories_from_str</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-utils-find-files-matching">as_utils_find_files_matching</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-utils-find-files">as_utils_find_files</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-utils-is-root">as_utils_is_root</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-str-replace">as_str_replace</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-get-locale">as_get_locale</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>


<refsect1 id="appstream-as-utils-private.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>

</refsect1>
<refsect1 id="appstream-as-utils-private.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-utils-touch-dir" role="function">
<title>as_utils_touch_dir&#160;()</title>
<indexterm zone="as-utils-touch-dir"><primary>as_utils_touch_dir</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
as_utils_touch_dir (<parameter>const <link linkend="gchar"><type>gchar</type></link> *dirname</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para></para>
</refsect3></refsect2>
<refsect2 id="as-utils-delete-dir-recursive" role="function">
<title>as_utils_delete_dir_recursive&#160;()</title>
<indexterm zone="as-utils-delete-dir-recursive"><primary>as_utils_delete_dir_recursive</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
as_utils_delete_dir_recursive (<parameter>const <link linkend="gchar"><type>gchar</type></link> *dirname</parameter>);</programlisting>
<para>Remove folder like rm -r does</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>dirname</para></entry>
<entry role="parameter_description"><para>Directory to remove</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> TRUE if operation was successful</para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-string-strip" role="function">
<title>as_string_strip&#160;()</title>
<indexterm zone="as-string-strip"><primary>as_string_strip</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_string_strip (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para></para>
</refsect3></refsect2>
<refsect2 id="as-utils-categories-from-strv" role="function">
<title>as_utils_categories_from_strv&#160;()</title>
<indexterm zone="as-utils-categories-from-strv"><primary>as_utils_categories_from_strv</primary></indexterm>
<programlisting language="C"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
as_utils_categories_from_strv (<parameter><link linkend="gchar"><type>gchar</type></link> **categories_strv</parameter>,
                               <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *system_categories</parameter>);</programlisting>
<para>Create a list of categories from string array</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>categories_strv</para></entry>
<entry role="parameter_description"><para>a string array</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>system_categories</para></entry>
<entry role="parameter_description"><para>list of <link linkend="AsCategory"><type>AsCategory</type></link> objects available on this system</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> <link linkend="GPtrArray"><type>GPtrArray</type></link> of <link linkend="AsCategory"><type>AsCategory</type></link> objcts matching the strings in the array. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> AsCategory][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-utils-categories-from-str" role="function">
<title>as_utils_categories_from_str&#160;()</title>
<indexterm zone="as-utils-categories-from-str"><primary>as_utils_categories_from_str</primary></indexterm>
<programlisting language="C"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
as_utils_categories_from_str (<parameter>const <link linkend="gchar"><type>gchar</type></link> *categories_str</parameter>,
                              <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *system_categories</parameter>);</programlisting>
<para>Create a list of categories from semicolon-separated string</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>categories_str</para></entry>
<entry role="parameter_description"><para>string with semicolon-separated categories</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>system_categories</para></entry>
<entry role="parameter_description"><para>list of <link linkend="AsCategory"><type>AsCategory</type></link> objects available on this system</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> <link linkend="GPtrArray"><type>GPtrArray</type></link> of <link linkend="AsCategory"><type>AsCategory</type></link> objcts matching the strings in the array. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> AsCategory][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-utils-find-files-matching" role="function">
<title>as_utils_find_files_matching&#160;()</title>
<indexterm zone="as-utils-find-files-matching"><primary>as_utils_find_files_matching</primary></indexterm>
<programlisting language="C"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
as_utils_find_files_matching (<parameter>const <link linkend="gchar"><type>gchar</type></link> *dir</parameter>,
                              <parameter>const <link linkend="gchar"><type>gchar</type></link> *pattern</parameter>,
                              <parameter><link linkend="gboolean"><type>gboolean</type></link> recursive</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para></para>
</refsect3></refsect2>
<refsect2 id="as-utils-find-files" role="function">
<title>as_utils_find_files&#160;()</title>
<indexterm zone="as-utils-find-files"><primary>as_utils_find_files</primary></indexterm>
<programlisting language="C"><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link>&#160;*
as_utils_find_files (<parameter>const <link linkend="gchar"><type>gchar</type></link> *dir</parameter>,
                     <parameter><link linkend="gboolean"><type>gboolean</type></link> recursive</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para></para>
</refsect3></refsect2>
<refsect2 id="as-utils-is-root" role="function">
<title>as_utils_is_root&#160;()</title>
<indexterm zone="as-utils-is-root"><primary>as_utils_is_root</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
as_utils_is_root (<parameter><type>void</type></parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para></para>
</refsect3></refsect2>
<refsect2 id="as-str-replace" role="function">
<title>as_str_replace&#160;()</title>
<indexterm zone="as-str-replace"><primary>as_str_replace</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_str_replace (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>,
                <parameter>const <link linkend="gchar"><type>gchar</type></link> *old_str</parameter>,
                <parameter>const <link linkend="gchar"><type>gchar</type></link> *new_str</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>

<para></para>
</refsect3></refsect2>
<refsect2 id="as-get-locale" role="function">
<title>as_get_locale&#160;()</title>
<indexterm zone="as-get-locale"><primary>as_get_locale</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_get_locale (<parameter><type>void</type></parameter>);</programlisting>
<para>Returns a locale string as used in the AppStream specification.</para>
<refsect3 role="returns">
<title>Returns</title>
<para> A locale string, free with <link linkend="g-free"><function>g_free()</function></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="appstream-as-utils-private.other_details" role="details">
<title role="details.title">Types and Values</title>

</refsect1>

</refentry>