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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
<?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">
<refentry id="libedataserver-e-xml-hash-utils">
<refmeta>
<refentrytitle role="top_of_page">EXMLHash</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EXMLHash</refname>
<refpurpose>Functions for manipulating xml as a hash table.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="EXmlHashType">EXmlHashType</link>;
<link linkend="GHashTable">GHashTable</link>* <link linkend="e-xml-to-hash">e_xml_to_hash</link> (<link linkend="xmlDoc">xmlDoc</link> *doc,
<link linkend="EXmlHashType">EXmlHashType</link> type);
<link linkend="xmlDoc">xmlDoc</link>* <link linkend="e-xml-from-hash">e_xml_from_hash</link> (<link linkend="GHashTable">GHashTable</link> *hash,
<link linkend="EXmlHashType">EXmlHashType</link> type,
const <link linkend="char">char</link> *root_node);
<link linkend="void">void</link> <link linkend="e-xml-destroy-hash">e_xml_destroy_hash</link> (<link linkend="GHashTable">GHashTable</link> *hash);
enum <link linkend="EXmlHashStatus">EXmlHashStatus</link>;
<link linkend="void">void</link> (<link linkend="EXmlHashFunc">*EXmlHashFunc</link>) (const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *value,
<link linkend="gpointer">gpointer</link> user_data);
typedef <link linkend="EXmlHash">EXmlHash</link>;
<link linkend="EXmlHash">EXmlHash</link>* <link linkend="e-xmlhash-new">e_xmlhash_new</link> (const <link linkend="char">char</link> *filename);
<link linkend="void">void</link> <link linkend="e-xmlhash-add">e_xmlhash_add</link> (<link linkend="EXmlHash">EXmlHash</link> *hash,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *data);
<link linkend="void">void</link> <link linkend="e-xmlhash-remove">e_xmlhash_remove</link> (<link linkend="EXmlHash">EXmlHash</link> *hash,
const <link linkend="char">char</link> *key);
<link linkend="EXmlHashStatus">EXmlHashStatus</link> <link linkend="e-xmlhash-compare">e_xmlhash_compare</link> (<link linkend="EXmlHash">EXmlHash</link> *hash,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *compare_data);
<link linkend="void">void</link> <link linkend="e-xmlhash-foreach-key">e_xmlhash_foreach_key</link> (<link linkend="EXmlHash">EXmlHash</link> *hash,
<link linkend="EXmlHashFunc">EXmlHashFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="e-xmlhash-write">e_xmlhash_write</link> (<link linkend="EXmlHash">EXmlHash</link> *hash);
<link linkend="void">void</link> <link linkend="e-xmlhash-destroy">e_xmlhash_destroy</link> (<link linkend="EXmlHash">EXmlHash</link> *hash);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EXmlHashType" role="enum"/>enum EXmlHashType</title>
<indexterm><primary>EXmlHashType</primary></indexterm><programlisting>typedef enum {
E_XML_HASH_TYPE_OBJECT_UID,
E_XML_HASH_TYPE_PROPERTY
} EXmlHashType;
</programlisting>
<para>
</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="E-XML-HASH-TYPE-OBJECT-UID:CAPS" role="constant"/><literal>E_XML_HASH_TYPE_OBJECT_UID</literal></term>
<listitem><simpara> Use the object UID as the hash key.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="E-XML-HASH-TYPE-PROPERTY:CAPS" role="constant"/><literal>E_XML_HASH_TYPE_PROPERTY</literal></term>
<listitem><simpara> Use the property name as the hash key.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xml-to-hash" role="function"/>e_xml_to_hash ()</title>
<indexterm><primary>e_xml_to_hash</primary></indexterm><programlisting><link linkend="GHashTable">GHashTable</link>* e_xml_to_hash (<link linkend="xmlDoc">xmlDoc</link> *doc,
<link linkend="EXmlHashType">EXmlHashType</link> type);</programlisting>
<para>
Creates a <link linkend="GHashTable"><type>GHashTable</type></link> representation of the <link linkend="xmlDoc"><type>xmlDoc</type></link> <parameter>doc</parameter>.
If <parameter>type</parameter> is * <parameter>E_XML_HASH_TYPE_PROPERTY</parameter>, all XML nodes will be
indexed in the <link linkend="GHashTable"><type>GHashTable</type></link> by name. If <parameter>type</parameter> is
<link linkend="E-XML-HASH-TYPE-OBJECT-UID:CAPS"><literal>E_XML_HASH_TYPE_OBJECT_UID</literal></link>, then XML objects will be indexed in
the hash by their UID (other nodes will still be indexed by name).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>doc</parameter> :</term>
<listitem><simpara> The <link linkend="xmlDoc"><type>xmlDoc</type></link> to store in a hash table.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> The value type to use as a key in the hash table.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly-created <link linkend="GHashTable"><type>GHashTable</type></link> representation of <parameter>doc</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xml-from-hash" role="function"/>e_xml_from_hash ()</title>
<indexterm><primary>e_xml_from_hash</primary></indexterm><programlisting><link linkend="xmlDoc">xmlDoc</link>* e_xml_from_hash (<link linkend="GHashTable">GHashTable</link> *hash,
<link linkend="EXmlHashType">EXmlHashType</link> type,
const <link linkend="char">char</link> *root_node);</programlisting>
<para>
Uses the key/value pair representation of an XML structure in <parameter>hash</parameter>
to build an equivalent <link linkend="xmlDoc"><type>xmlDoc</type></link>. This is the reverse of
<link linkend="e-xml-to-hash"><function>e_xml_to_hash()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="GHashTable"><type>GHashTable</type></link> to extract the XML from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHashType"><type>EXmlHashType</type></link> used to store the XML.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_node</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="xmlDoc"><type>xmlDoc</type></link> created from the data in <parameter>hash</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xml-destroy-hash" role="function"/>e_xml_destroy_hash ()</title>
<indexterm><primary>e_xml_destroy_hash</primary></indexterm><programlisting><link linkend="void">void</link> e_xml_destroy_hash (<link linkend="GHashTable">GHashTable</link> *hash);</programlisting>
<para>
Frees the memory used by <parameter>hash</parameter> and its contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="GHashTable"><type>GHashTable</type></link> to destroy.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="EXmlHashStatus" role="enum"/>enum EXmlHashStatus</title>
<indexterm><primary>EXmlHashStatus</primary></indexterm><programlisting>typedef enum {
E_XMLHASH_STATUS_SAME,
E_XMLHASH_STATUS_DIFFERENT,
E_XMLHASH_STATUS_NOT_FOUND
} EXmlHashStatus;
</programlisting>
<para>
</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="E-XMLHASH-STATUS-SAME:CAPS" role="constant"/><literal>E_XMLHASH_STATUS_SAME</literal></term>
<listitem><simpara> The compared values are the same.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="E-XMLHASH-STATUS-DIFFERENT:CAPS" role="constant"/><literal>E_XMLHASH_STATUS_DIFFERENT</literal></term>
<listitem><simpara> The compared values are different.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="E-XMLHASH-STATUS-NOT-FOUND:CAPS" role="constant"/><literal>E_XMLHASH_STATUS_NOT_FOUND</literal></term>
<listitem><simpara> The key to compare against was not found.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="EXmlHashFunc" role="function"/>EXmlHashFunc ()</title>
<indexterm><primary>EXmlHashFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*EXmlHashFunc) (const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *value,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="EXmlHash" role="typedef"/>EXmlHash</title>
<indexterm><primary>EXmlHash</primary></indexterm><programlisting>typedef struct EXmlHash EXmlHash;
</programlisting>
<para>
A hash table representation of an XML file.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-new" role="function"/>e_xmlhash_new ()</title>
<indexterm><primary>e_xmlhash_new</primary></indexterm><programlisting><link linkend="EXmlHash">EXmlHash</link>* e_xmlhash_new (const <link linkend="char">char</link> *filename);</programlisting>
<para>
Creates a new <link linkend="EXmlHash"><type>EXmlHash</type></link> from the file <parameter>filename</parameter>. If <parameter>filename</parameter> does
not already exist, an empty <link linkend="EXmlHash"><type>EXmlHash</type></link> will be created.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> The name of an XML file.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="EXmlHash"><type>EXmlHash</type></link> structure, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if unable to parse
<parameter>filename</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-add" role="function"/>e_xmlhash_add ()</title>
<indexterm><primary>e_xmlhash_add</primary></indexterm><programlisting><link linkend="void">void</link> e_xmlhash_add (<link linkend="EXmlHash">EXmlHash</link> *hash,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *data);</programlisting>
<para>
Adds a new key/value pair to the <link linkend="EXmlHash"><type>EXmlHash</type></link> <parameter>hash</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHash"><type>EXmlHash</type></link> to add an entry to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> The key to use for the entry.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> The value of the new entry.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-remove" role="function"/>e_xmlhash_remove ()</title>
<indexterm><primary>e_xmlhash_remove</primary></indexterm><programlisting><link linkend="void">void</link> e_xmlhash_remove (<link linkend="EXmlHash">EXmlHash</link> *hash,
const <link linkend="char">char</link> *key);</programlisting>
<para>
Remove the entry in <parameter>hash</parameter> with key equal to <parameter>key</parameter>, if it exists.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHash"><type>EXmlHash</type></link> to remove an entry from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> The key of the entry to remove.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-compare" role="function"/>e_xmlhash_compare ()</title>
<indexterm><primary>e_xmlhash_compare</primary></indexterm><programlisting><link linkend="EXmlHashStatus">EXmlHashStatus</link> e_xmlhash_compare (<link linkend="EXmlHash">EXmlHash</link> *hash,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *compare_data);</programlisting>
<para>
Compares the value with key equal to <parameter>key</parameter> in <parameter>hash</parameter> against
<parameter>compare_data</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHash"><type>EXmlHash</type></link> to compare against.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> The key of the hash entry to compare with.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>compare_data</parameter> :</term>
<listitem><simpara> The data to compare against the hash entry.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> E_XMLHASH_STATUS_SAME if the value and <parameter>compare_data</parameter> are
equal,E_XMLHASH_STATUS_DIFFERENT if they are different, or
E_XMLHASH_STATUS_NOT_FOUND if there is no entry in <parameter>hash</parameter> with
its key equal to <parameter>key</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-foreach-key" role="function"/>e_xmlhash_foreach_key ()</title>
<indexterm><primary>e_xmlhash_foreach_key</primary></indexterm><programlisting><link linkend="void">void</link> e_xmlhash_foreach_key (<link linkend="EXmlHash">EXmlHash</link> *hash,
<link linkend="EXmlHashFunc">EXmlHashFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Executes <parameter>func</parameter> against each key/value pair in <parameter>hash</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> An <link linkend="EXmlHash"><type>EXmlHash</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHashFunc"><type>EXmlHashFunc</type></link> to execute on the data in <parameter>hash</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> The data to pass to <parameter>func</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-write" role="function"/>e_xmlhash_write ()</title>
<indexterm><primary>e_xmlhash_write</primary></indexterm><programlisting><link linkend="void">void</link> e_xmlhash_write (<link linkend="EXmlHash">EXmlHash</link> *hash);</programlisting>
<para>
Writes the XML represented by <parameter>hash</parameter> to the file originally passed
to <link linkend="e-xmlhash-new"><function>e_xmlhash_new()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHash"><type>EXmlHash</type></link> to write.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-xmlhash-destroy" role="function"/>e_xmlhash_destroy ()</title>
<indexterm><primary>e_xmlhash_destroy</primary></indexterm><programlisting><link linkend="void">void</link> e_xmlhash_destroy (<link linkend="EXmlHash">EXmlHash</link> *hash);</programlisting>
<para>
Frees the memory associated with <parameter>hash</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hash</parameter> :</term>
<listitem><simpara> The <link linkend="EXmlHash"><type>EXmlHash</type></link> to destroy.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
