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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GObject Serialization</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="JSON-GLib Reference Manual">
<link rel="up" href="json-advanced.html" title="Part IV. JSON-GLib Advanced API">
<link rel="prev" href="json-advanced.html" title="Part IV. JSON-GLib Advanced API">
<link rel="next" href="json-glib-Serializable-Interface.html" title="Serializable Interface">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="json-glib.html" title="Part I. JSON-GLib Overview">
<link rel="part" href="json-base.html" title="Part II. JSON-GLib Reference">
<link rel="chapter" href="ch01.html" title="Data Types">
<link rel="part" href="json-streams.html" title="Part III. Reading and writing">
<link rel="chapter" href="ch02.html" title="Parser">
<link rel="chapter" href="ch03.html" title="Generator">
<link rel="part" href="json-advanced.html" title="Part IV. JSON-GLib Advanced API">
<link rel="part" href="json-tools.html" title="Part V. JSON-GLib Additional Reference">
<link rel="chapter" href="ch04.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 0.4">
<link rel="index" href="ix04.html" title="Index of new symbols in 0.6">
<link rel="index" href="ix05.html" title="Index of new symbols in 0.8">
<link rel="index" href="ix06.html" title="Index of new symbols in 0.10">
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
<link rel="appendix" href="license.html" title="Appendix A. License">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="json-advanced.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="json-advanced.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">JSON-GLib Reference Manual</th>
<td><a accesskey="n" href="json-glib-Serializable-Interface.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#json-glib-GObject-Serialization.synopsis" class="shortcut">Top</a>
|
<a href="#json-glib-GObject-Serialization.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="GObject Serialization">
<a name="json-glib-GObject-Serialization"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="json-glib-GObject-Serialization.top_of_page"></a>GObject Serialization</span></h2>
<p>GObject Serialization — Serialize and deserialize GObjects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="json-glib-GObject-Serialization.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode">JsonNode</a> * <a class="link" href="json-glib-GObject-Serialization.html#json-gobject-serialize" title="json_gobject_serialize ()">json_gobject_serialize</a> (<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *gobject);
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * <a class="link" href="json-glib-GObject-Serialization.html#json-gobject-deserialize" title="json_gobject_deserialize ()">json_gobject_deserialize</a> (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> gtype,
<a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode">JsonNode</a> *node);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="json-glib-GObject-Serialization.html#json-gobject-to-data" title="json_gobject_to_data ()">json_gobject_to_data</a> (<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *gobject,
<a
href="../glib/glib-Basic-Types.html#gsize"
>gsize</a> *length);
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * <a class="link" href="json-glib-GObject-Serialization.html#json-gobject-from-data" title="json_gobject_from_data ()">json_gobject_from_data</a> (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> gtype,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *data,
<a
href="../glib/glib-Basic-Types.html#gssize"
>gssize</a> length,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * <a class="link" href="json-glib-GObject-Serialization.html#json-construct-gobject" title="json_construct_gobject ()">json_construct_gobject</a> (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> gtype,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *data,
<a
href="../glib/glib-Basic-Types.html#gsize"
>gsize</a> length,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="json-glib-GObject-Serialization.html#json-serialize-gobject" title="json_serialize_gobject ()">json_serialize_gobject</a> (<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *gobject,
<a
href="../glib/glib-Basic-Types.html#gsize"
>gsize</a> *length);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="json-glib-GObject-Serialization.description"></a><h2>Description</h2>
<p>
JSON-GLib provides API for serializing and deserializing <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>s
to and from JSON data streams.
</p>
<p>
Simple <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> classes can be (de)serialized into JSON objects, if the
properties have compatible types with the native JSON types (integers,
booleans, strings, string vectors). If the class to be (de)serialized has
complex data types for properties (like boxed types or other objects)
then the class should implement the provided <span class="type">JsonSerializable</span> interface
and its virtual functions.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="json-glib-GObject-Serialization.details"></a><h2>Details</h2>
<div class="refsect2" title="json_gobject_serialize ()">
<a name="json-gobject-serialize"></a><h3>json_gobject_serialize ()</h3>
<pre class="programlisting"><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode">JsonNode</a> * json_gobject_serialize (<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *gobject);</pre>
<p>
Creates a <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> representing the passed <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
instance. Each member of the returned JSON object will
map to a property of the <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gobject</code></em> :</span></p></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>transfer full. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> full. </td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="json_gobject_deserialize ()">
<a name="json-gobject-deserialize"></a><h3>json_gobject_deserialize ()</h3>
<pre class="programlisting"><a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * json_gobject_deserialize (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> gtype,
<a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode">JsonNode</a> *node);</pre>
<p>
Creates a new <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> of type <em class="parameter"><code>gtype</code></em>, and constructs it
using the members of the passed <a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="type">JsonObject</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gtype</code></em> :</span></p></td>
<td> the type of the <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> to create
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td> a <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> of type <a class="link" href="json-glib-JSON-Node.html#JSON-NODE-OBJECT--CAPS"><code class="literal">JSON_NODE_OBJECT</code></a> describing the
instance of type <em class="parameter"><code>gtype</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>transfer full. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> full. </td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="json_gobject_to_data ()">
<a name="json-gobject-to-data"></a><h3>json_gobject_to_data ()</h3>
<pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> * json_gobject_to_data (<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *gobject,
<a
href="../glib/glib-Basic-Types.html#gsize"
>gsize</a> *length);</pre>
<p>
Serializes a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> into a JSON data stream, iterating recursively
over each property.
</p>
<p>
If <em class="parameter"><code>gobject</code></em> implements the <a class="link" href="json-glib-Serializable-Interface.html#JsonSerializableIface" title="JsonSerializableIface"><span class="type">JsonSerializableIface</span></a> interface, it will
be asked to serialize all its properties; otherwise, the default
implementation will be use to translate the compatible types into
JSON native types.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gobject</code></em> :</span></p></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td> return value for the length of the buffer, or <code class="literal">NULL</code>. <acronym title="Parameter for returning results. Default is transfer-full."><span class="acronym">out</span></acronym>. </td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a JSON data stream representing the passed <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="json_gobject_from_data ()">
<a name="json-gobject-from-data"></a><h3>json_gobject_from_data ()</h3>
<pre class="programlisting"><a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * json_gobject_from_data (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> gtype,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *data,
<a
href="../glib/glib-Basic-Types.html#gssize"
>gssize</a> length,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Deserializes a JSON data stream and creates the corresponding
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> class. If <em class="parameter"><code>gtype</code></em> implements the <a class="link" href="json-glib-Serializable-Interface.html#JsonSerializableIface" title="JsonSerializableIface"><span class="type">JsonSerializableIface</span></a>
interface, it will be asked to deserialize all the JSON members
into the respective properties; otherwise, the default implementation
will be used to translate the compatible JSON native types.
</p>
<p>
Note: the JSON data stream must be an object declaration.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gtype</code></em> :</span></p></td>
<td> the <a
href="../gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of object to construct
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> a JSON data stream
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td> length of the data stream, or -1 if it is NUL-terminated
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> return location for a <a
href="../glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="json_construct_gobject ()">
<a name="json-construct-gobject"></a><h3>json_construct_gobject ()</h3>
<pre class="programlisting"><a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> * json_construct_gobject (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> gtype,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *data,
<a
href="../glib/glib-Basic-Types.html#gsize"
>gsize</a> length,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">json_construct_gobject</code> has been deprecated since version 0.10 and should not be used in newly-written code. Use <a class="link" href="json-glib-GObject-Serialization.html#json-gobject-from-data" title="json_gobject_from_data ()"><code class="function">json_gobject_from_data()</code></a> instead</p>
</div>
<p>
Deserializes a JSON data stream and creates the corresponding
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> class. If <em class="parameter"><code>gtype</code></em> implements the <a class="link" href="json-glib-Serializable-Interface.html#JsonSerializableIface" title="JsonSerializableIface"><span class="type">JsonSerializableIface</span></a>
interface, it will be asked to deserialize all the JSON members
into the respective properties; otherwise, the default implementation
will be used to translate the compatible JSON native types.
</p>
<p>
Note: the JSON data stream must be an object declaration.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gtype</code></em> :</span></p></td>
<td> the <a
href="../gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of object to construct
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> a JSON data stream
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td> length of the data stream
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> return location for a <a
href="../glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2" title="json_serialize_gobject ()">
<a name="json-serialize-gobject"></a><h3>json_serialize_gobject ()</h3>
<pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> * json_serialize_gobject (<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *gobject,
<a
href="../glib/glib-Basic-Types.html#gsize"
>gsize</a> *length);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">json_serialize_gobject</code> has been deprecated since version 0.10 and should not be used in newly-written code. Use <a class="link" href="json-glib-GObject-Serialization.html#json-gobject-to-data" title="json_gobject_to_data ()"><code class="function">json_gobject_to_data()</code></a> instead</p>
</div>
<p>
Serializes a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> into a JSON data stream. If <em class="parameter"><code>gobject</code></em> implements
the <a class="link" href="json-glib-Serializable-Interface.html#JsonSerializableIface" title="JsonSerializableIface"><span class="type">JsonSerializableIface</span></a> interface, it will be asked to serizalize all
its properties; otherwise, the default implementation will be use to
translate the compatible types into JSON native types.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gobject</code></em> :</span></p></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td> return value for the length of the buffer, or <code class="literal">NULL</code>. <acronym title="Parameter for returning results. Default is transfer-full."><span class="acronym">out</span></acronym>. </td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a JSON data stream representing the passed <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|
