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
|
<?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 version SYSTEM "version.xml">
]>
<refentry id="json-glib-Boxed-Types-Serialization">
<refmeta>
<refentrytitle role="top_of_page" id="json-glib-Boxed-Types-Serialization.top_of_page">Boxed Types Serialization</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Boxed Types Serialization</refname>
<refpurpose>Serialize and deserialize GBoxed types</refpurpose>
</refnamediv>
<refsynopsisdiv id="json-glib-Boxed-Types-Serialization.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="JsonNode">JsonNode</link> * (<link linkend="JsonBoxedSerializeFunc">*JsonBoxedSerializeFunc</link>) (<link linkend="gconstpointer">gconstpointer</link> boxed);
<link linkend="gpointer">gpointer</link> (<link linkend="JsonBoxedDeserializeFunc">*JsonBoxedDeserializeFunc</link>) (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="void">void</link> <link linkend="json-boxed-register-serialize-func">json_boxed_register_serialize_func</link> (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> node_type,
<link linkend="JsonBoxedSerializeFunc">JsonBoxedSerializeFunc</link> serialize_func);
<link linkend="void">void</link> <link linkend="json-boxed-register-deserialize-func">json_boxed_register_deserialize_func</link>
(<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> node_type,
<link linkend="JsonBoxedDeserializeFunc">JsonBoxedDeserializeFunc</link> deserialize_func);
<link linkend="gboolean">gboolean</link> <link linkend="json-boxed-can-serialize">json_boxed_can_serialize</link> (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> *node_type);
<link linkend="gboolean">gboolean</link> <link linkend="json-boxed-can-deserialize">json_boxed_can_deserialize</link> (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> node_type);
<link linkend="JsonNode">JsonNode</link> * <link linkend="json-boxed-serialize">json_boxed_serialize</link> (<link linkend="GType">GType</link> gboxed_type,
<link linkend="gconstpointer">gconstpointer</link> boxed);
<link linkend="gpointer">gpointer</link> <link linkend="json-boxed-deserialize">json_boxed_deserialize</link> (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNode">JsonNode</link> *node);
</synopsis>
</refsynopsisdiv>
<refsect1 id="json-glib-Boxed-Types-Serialization.description" role="desc">
<title role="desc.title">Description</title>
<para>
GLib's <link linkend="GBoxed"><type>GBoxed</type></link> type is a generic wrapper for arbitrary C structures.
</para>
<para>
JSON-GLib allows serialization and deserialization of a <link linkend="GBoxed"><type>GBoxed</type></link> type
by registering functions mapping a <link linkend="JsonNodeType"><type>JsonNodeType</type></link> to a specific
<link linkend="GType"><type>GType</type></link>.
</para>
<para>
When registering a <link linkend="GBoxed"><type>GBoxed</type></link> type you should also register the
corresponding transformation functions, e.g.:
</para>
<para>
<informalexample><programlisting>
GType
my_struct_get_type (void)
{
static GType boxed_type = 0;
if (boxed_type == 0)
{
boxed_type =
g_boxed_type_register_static (g_intern_static_string ("MyStruct"),
(GBoxedCopyFunc) my_struct_copy,
(GBoxedFreeFunc) my_struct_free);
json_boxed_register_serialize_func (boxed_type, JSON_NODE_OBJECT,
my_struct_serialize);
json_boxed_register_deserialize_func (boxed_type, JSON_NODE_OBJECT,
my_struct_deserialize);
}
return boxed_type;
}
</programlisting></informalexample>
</para>
<para>
The serialization function will be invoked by <link linkend="json-boxed-serialize"><function>json_boxed_serialize()</function></link>:
it will be passed a pointer to the C structure and it must return a
<link linkend="JsonNode"><type>JsonNode</type></link>. The deserialization function will be invoked by
<link linkend="json-boxed-deserialize"><function>json_boxed_deserialize()</function></link>: it will be passed a <link linkend="JsonNode"><type>JsonNode</type></link> for the
declared type and it must return a newly allocated C structure.
</para>
<para>
It is possible to check whether a <link linkend="GBoxed"><type>GBoxed</type></link> type can be deserialized
from a specific <link linkend="JsonNodeType"><type>JsonNodeType</type></link>, and whether a <link linkend="GBoxed"><type>GBoxed</type></link> can be serialized
and to which specific <link linkend="JsonNodeType"><type>JsonNodeType</type></link>.</para>
<para>
</para>
</refsect1>
<refsect1 id="json-glib-Boxed-Types-Serialization.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JsonBoxedSerializeFunc" role="function" condition="since:0.10">
<title>JsonBoxedSerializeFunc ()</title>
<indexterm zone="JsonBoxedSerializeFunc" role="0.10"><primary sortas="BoxedSerializeFunc">JsonBoxedSerializeFunc</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * (*JsonBoxedSerializeFunc) (<link linkend="gconstpointer">gconstpointer</link> boxed);</programlisting>
<para>
Serializes the passed <link linkend="GBoxed"><type>GBoxed</type></link> and stores it inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>boxed</parameter> :</term>
<listitem><simpara> a <link linkend="GBoxed"><type>GBoxed</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="JsonBoxedDeserializeFunc" role="function" condition="since:0.10">
<title>JsonBoxedDeserializeFunc ()</title>
<indexterm zone="JsonBoxedDeserializeFunc" role="0.10"><primary sortas="BoxedDeserializeFunc">JsonBoxedDeserializeFunc</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> (*JsonBoxedDeserializeFunc) (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Deserializes the contents of the passed <link linkend="JsonNode"><type>JsonNode</type></link> into a <link linkend="GBoxed"><type>GBoxed</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created boxed type
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-boxed-register-serialize-func" role="function" condition="since:0.10">
<title>json_boxed_register_serialize_func ()</title>
<indexterm zone="json-boxed-register-serialize-func" role="0.10"><primary sortas="boxed_register_serialize_func">json_boxed_register_serialize_func</primary></indexterm><programlisting><link linkend="void">void</link> json_boxed_register_serialize_func (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> node_type,
<link linkend="JsonBoxedSerializeFunc">JsonBoxedSerializeFunc</link> serialize_func);</programlisting>
<para>
Registers a serialization function for a <link linkend="GBoxed"><type>GBoxed</type></link> of type <parameter>gboxed_type</parameter>
to a <link linkend="JsonNode"><type>JsonNode</type></link> of type <parameter>node_type</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gboxed_type</parameter> :</term>
<listitem><simpara> a boxed type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node_type</parameter> :</term>
<listitem><simpara> a node type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>serialize_func</parameter> :</term>
<listitem><simpara> serialization function for <parameter>boxed_type</parameter> into
a <link linkend="JsonNode"><type>JsonNode</type></link> of type <parameter>node_type</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-boxed-register-deserialize-func" role="function" condition="since:0.10">
<title>json_boxed_register_deserialize_func ()</title>
<indexterm zone="json-boxed-register-deserialize-func" role="0.10"><primary sortas="boxed_register_deserialize_func">json_boxed_register_deserialize_func</primary></indexterm><programlisting><link linkend="void">void</link> json_boxed_register_deserialize_func
(<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> node_type,
<link linkend="JsonBoxedDeserializeFunc">JsonBoxedDeserializeFunc</link> deserialize_func);</programlisting>
<para>
Registers a deserialization function for a <link linkend="GBoxed"><type>GBoxed</type></link> of type <parameter>gboxed_type</parameter>
from a <link linkend="JsonNode"><type>JsonNode</type></link> of type <parameter>node_type</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gboxed_type</parameter> :</term>
<listitem><simpara> a boxed type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node_type</parameter> :</term>
<listitem><simpara> a node type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>deserialize_func</parameter> :</term>
<listitem><simpara> deserialization function for <parameter>boxed_type</parameter> from
a <link linkend="JsonNode"><type>JsonNode</type></link> of type <parameter>node_type</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-boxed-can-serialize" role="function" condition="since:0.10">
<title>json_boxed_can_serialize ()</title>
<indexterm zone="json-boxed-can-serialize" role="0.10"><primary sortas="boxed_can_serialize">json_boxed_can_serialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_boxed_can_serialize (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> *node_type);</programlisting>
<para>
Checks whether it is possible to serialize a <link linkend="GBoxed"><type>GBoxed</type></link> of
type <parameter>gboxed_type</parameter> into a <link linkend="JsonNode"><type>JsonNode</type></link>. The type of the
<link linkend="JsonNode"><type>JsonNode</type></link> is placed inside <parameter>node_type</parameter> if the function
returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> and it's undefined otherwise.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gboxed_type</parameter> :</term>
<listitem><simpara> a boxed type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node_type</parameter> :</term>
<listitem><simpara>out. <acronym>out</acronym>. </simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the type can be serialized,
and <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-boxed-can-deserialize" role="function" condition="since:0.10">
<title>json_boxed_can_deserialize ()</title>
<indexterm zone="json-boxed-can-deserialize" role="0.10"><primary sortas="boxed_can_deserialize">json_boxed_can_deserialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_boxed_can_deserialize (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNodeType">JsonNodeType</link> node_type);</programlisting>
<para>
Checks whether it is possible to deserialize a <link linkend="GBoxed"><type>GBoxed</type></link> of
type <parameter>gboxed_type</parameter> from a <link linkend="JsonNode"><type>JsonNode</type></link> of type <parameter>node_type</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gboxed_type</parameter> :</term>
<listitem><simpara> a boxed type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node_type</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> type
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the type can be deserialized, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-boxed-serialize" role="function" condition="since:0.10">
<title>json_boxed_serialize ()</title>
<indexterm zone="json-boxed-serialize" role="0.10"><primary sortas="boxed_serialize">json_boxed_serialize</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * json_boxed_serialize (<link linkend="GType">GType</link> gboxed_type,
<link linkend="gconstpointer">gconstpointer</link> boxed);</programlisting>
<para>
Serializes <parameter>boxed</parameter>, a pointer to a <link linkend="GBoxed"><type>GBoxed</type></link> of type <parameter>gboxed_type</parameter>,
into a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gboxed_type</parameter> :</term>
<listitem><simpara> a boxed type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>boxed</parameter> :</term>
<listitem><simpara> a pointer to a <link linkend="GBoxed"><type>GBoxed</type></link> of type <parameter>gboxed_type</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> with the serialization of the boxed
type, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if serialization either failed or was not
possible
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-boxed-deserialize" role="function" condition="since:0.10">
<title>json_boxed_deserialize ()</title>
<indexterm zone="json-boxed-deserialize" role="0.10"><primary sortas="boxed_deserialize">json_boxed_deserialize</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> json_boxed_deserialize (<link linkend="GType">GType</link> gboxed_type,
<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Deserializes <parameter>node</parameter> into a <link linkend="GBoxed"><type>GBoxed</type></link> of <parameter>gboxed_type</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gboxed_type</parameter> :</term>
<listitem><simpara> a boxed type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly allocated <link linkend="GBoxed"><type>GBoxed</type></link>. Use <link linkend="g-boxed-free"><function>g_boxed_free()</function></link> to
release the resources allocated by this function
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
</refsect1>
</refentry>
|
