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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
|
<?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="JsonParser">
<refmeta>
<refentrytitle role="top_of_page" id="JsonParser.top_of_page">JsonParser</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>JsonParser</refname>
<refpurpose>Parse JSON data streams</refpurpose>
</refnamediv>
<refsynopsisdiv id="JsonParser.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="JsonParserError">JsonParserError</link>;
<link linkend="JsonParser-struct">JsonParser</link>;
<link linkend="JsonParserClass">JsonParserClass</link>;
<link linkend="JsonParser">JsonParser</link> * <link linkend="json-parser-new">json_parser_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="json-parser-load-from-file">json_parser_load_from_file</link> (<link linkend="JsonParser">JsonParser</link> *parser,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="json-parser-load-from-data">json_parser_load_from_data</link> (<link linkend="JsonParser">JsonParser</link> *parser,
const <link linkend="gchar">gchar</link> *data,
<link linkend="gssize">gssize</link> length,
<link linkend="GError">GError</link> **error);
<link linkend="JsonNode">JsonNode</link> * <link linkend="json-parser-get-root">json_parser_get_root</link> (<link linkend="JsonParser">JsonParser</link> *parser);
<link linkend="guint">guint</link> <link linkend="json-parser-get-current-line">json_parser_get_current_line</link> (<link linkend="JsonParser">JsonParser</link> *parser);
<link linkend="guint">guint</link> <link linkend="json-parser-get-current-pos">json_parser_get_current_pos</link> (<link linkend="JsonParser">JsonParser</link> *parser);
<link linkend="gboolean">gboolean</link> <link linkend="json-parser-has-assignment">json_parser_has_assignment</link> (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gchar">gchar</link> **variable_name);
</synopsis>
</refsynopsisdiv>
<refsect1 id="JsonParser.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----JsonParser
</synopsis>
</refsect1>
<refsect1 id="JsonParser.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="JsonParser-array-element">array-element</link>" : Run Last
"<link linkend="JsonParser-array-end">array-end</link>" : Run Last
"<link linkend="JsonParser-array-start">array-start</link>" : Run Last
"<link linkend="JsonParser-error">error</link>" : Run Last
"<link linkend="JsonParser-object-end">object-end</link>" : Run Last
"<link linkend="JsonParser-object-member">object-member</link>" : Run Last
"<link linkend="JsonParser-object-start">object-start</link>" : Run Last
"<link linkend="JsonParser-parse-end">parse-end</link>" : Run Last
"<link linkend="JsonParser-parse-start">parse-start</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="JsonParser.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="JsonParser"><type>JsonParser</type></link> provides an object for parsing a JSON data stream, either
inside a file or inside a static buffer.</para>
<para>
</para>
</refsect1>
<refsect1 id="JsonParser.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JsonParserError" role="enum">
<title>enum JsonParserError</title>
<indexterm zone="JsonParserError"><primary sortas="ParserError">JsonParserError</primary></indexterm><programlisting>typedef enum {
JSON_PARSER_ERROR_PARSE,
JSON_PARSER_ERROR_UNKNOWN
} JsonParserError;
</programlisting>
<para>
Error enumeration for <link linkend="JsonParser"><type>JsonParser</type></link></para>
<para>
</para><variablelist role="enum">
<varlistentry id="JSON-PARSER-ERROR-PARSE--CAPS" role="constant">
<term><literal>JSON_PARSER_ERROR_PARSE</literal></term>
<listitem><simpara> parse error
</simpara></listitem>
</varlistentry>
<varlistentry id="JSON-PARSER-ERROR-UNKNOWN--CAPS" role="constant">
<term><literal>JSON_PARSER_ERROR_UNKNOWN</literal></term>
<listitem><simpara> unknown error
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="JsonParser-struct" role="struct">
<title>JsonParser</title>
<indexterm zone="JsonParser-struct"><primary sortas="Parser">JsonParser</primary></indexterm><programlisting>typedef struct _JsonParser JsonParser;</programlisting>
<para>
JSON data streams parser. The contents of the <link linkend="JsonParser"><type>JsonParser</type></link> structure are
private and should only be accessed via the provided API.</para>
<para>
</para></refsect2>
<refsect2 id="JsonParserClass" role="struct">
<title>JsonParserClass</title>
<indexterm zone="JsonParserClass"><primary sortas="ParserClass">JsonParserClass</primary></indexterm><programlisting>typedef struct {
void (* parse_start) (JsonParser *parser);
void (* object_start) (JsonParser *parser);
void (* object_member) (JsonParser *parser,
JsonObject *object,
const gchar *member_name);
void (* object_end) (JsonParser *parser,
JsonObject *object);
void (* array_start) (JsonParser *parser);
void (* array_element) (JsonParser *parser,
JsonArray *array,
gint index_);
void (* array_end) (JsonParser *parser,
JsonArray *array);
void (* parse_end) (JsonParser *parser);
void (* error) (JsonParser *parser,
const GError *error);
} JsonParserClass;
</programlisting>
<para>
<link linkend="JsonParser"><type>JsonParser</type></link> class.</para>
<para>
</para><variablelist role="struct">
<varlistentry>
<term><structfield>parse_start</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::parse-start signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>object_start</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::object-start signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>object_member</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::object-member signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>object_end</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::object-end signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>array_start</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::array-start signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>array_element</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::array-element signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>array_end</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::array-end signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>parse_end</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::parse-end signal
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>error</structfield> ()</term>
<listitem><simpara> class handler for the JsonParser::error signal
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-new" role="function">
<title>json_parser_new ()</title>
<indexterm zone="json-parser-new"><primary sortas="parser_new">json_parser_new</primary></indexterm><programlisting><link linkend="JsonParser">JsonParser</link> * json_parser_new (void);</programlisting>
<para>
Creates a new <link linkend="JsonParser"><type>JsonParser</type></link> instance. You can use the <link linkend="JsonParser"><type>JsonParser</type></link> to
load a JSON stream from either a file or a buffer and then walk the
hierarchy using the data types API.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="JsonParser"><type>JsonParser</type></link>. Use <link linkend="g-object-unref"><function>g_object_unref()</function></link>
to release all the memory it allocates.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-load-from-file" role="function">
<title>json_parser_load_from_file ()</title>
<indexterm zone="json-parser-load-from-file"><primary sortas="parser_load_from_file">json_parser_load_from_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_parser_load_from_file (<link linkend="JsonParser">JsonParser</link> *parser,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Loads a JSON stream from the content of <parameter>filename</parameter> and parses it. See
<link linkend="json-parser-load-from-data"><function>json_parser_load_from_data()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="JsonParser"><type>JsonParser</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> the path for the file to parse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the file was successfully loaded and parsed.
In case of error, <parameter>error</parameter> is set accordingly and <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> is returned
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-load-from-data" role="function">
<title>json_parser_load_from_data ()</title>
<indexterm zone="json-parser-load-from-data"><primary sortas="parser_load_from_data">json_parser_load_from_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_parser_load_from_data (<link linkend="JsonParser">JsonParser</link> *parser,
const <link linkend="gchar">gchar</link> *data,
<link linkend="gssize">gssize</link> length,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Loads a JSON stream from a buffer and parses it. You can call this function
multiple times with the same <link linkend="JsonParser"><type>JsonParser</type></link> object, but the contents of the
parser will be destroyed each time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="JsonParser"><type>JsonParser</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> the buffer to parse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> the length of the buffer, or -1
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the buffer was succesfully parser. In case
of error, <parameter>error</parameter> is set accordingly and <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> is returned
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-get-root" role="function">
<title>json_parser_get_root ()</title>
<indexterm zone="json-parser-get-root"><primary sortas="parser_get_root">json_parser_get_root</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * json_parser_get_root (<link linkend="JsonParser">JsonParser</link> *parser);</programlisting>
<para>
Retrieves the top level node from the parsed JSON stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="JsonParser"><type>JsonParser</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>transfer none. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-get-current-line" role="function">
<title>json_parser_get_current_line ()</title>
<indexterm zone="json-parser-get-current-line"><primary sortas="parser_get_current_line">json_parser_get_current_line</primary></indexterm><programlisting><link linkend="guint">guint</link> json_parser_get_current_line (<link linkend="JsonParser">JsonParser</link> *parser);</programlisting>
<para>
Retrieves the line currently parsed, starting from 1.
</para>
<para>
This function has defined behaviour only while parsing; calling this
function from outside the signal handlers emitted by <link linkend="JsonParser"><type>JsonParser</type></link> will
yield 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="JsonParser"><type>JsonParser</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the currently parsed line, or 0.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-get-current-pos" role="function">
<title>json_parser_get_current_pos ()</title>
<indexterm zone="json-parser-get-current-pos"><primary sortas="parser_get_current_pos">json_parser_get_current_pos</primary></indexterm><programlisting><link linkend="guint">guint</link> json_parser_get_current_pos (<link linkend="JsonParser">JsonParser</link> *parser);</programlisting>
<para>
Retrieves the current position inside the current line, starting
from 0.
</para>
<para>
This function has defined behaviour only while parsing; calling this
function from outside the signal handlers emitted by <link linkend="JsonParser"><type>JsonParser</type></link> will
yield 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="JsonParser"><type>JsonParser</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the position in the current line, or 0.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-parser-has-assignment" role="function" condition="since:0.4">
<title>json_parser_has_assignment ()</title>
<indexterm zone="json-parser-has-assignment" role="0.4"><primary sortas="parser_has_assignment">json_parser_has_assignment</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_parser_has_assignment (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gchar">gchar</link> **variable_name);</programlisting>
<para>
A JSON data stream might sometimes contain an assignment, like:
</para>
<para>
<informalexample><programlisting>
var _json_data = { "member_name" : [ ...
</programlisting></informalexample>
</para>
<para>
even though it would technically constitute a violation of the RFC.
</para>
<para>
<link linkend="JsonParser"><type>JsonParser</type></link> will ignore the left hand identifier and parse the right
hand value of the assignment. <link linkend="JsonParser"><type>JsonParser</type></link> will record, though, the
existence of the assignment in the data stream and the variable name
used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="JsonParser"><type>JsonParser</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variable_name</parameter> :</term>
<listitem><simpara>out) (allow-none. <acronym>out</acronym>. <acronym>allow-none</acronym>. </simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if there was an assignment, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise. If
<parameter>variable_name</parameter> is not <link linkend="NULL--CAPS"><literal>NULL</literal></link> it will be set to the name of the variable
used in the assignment. The string is owned by <link linkend="JsonParser"><type>JsonParser</type></link> and should
never be modified or freed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.4</para></refsect2>
</refsect1>
<refsect1 id="JsonParser.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="JsonParser-array-element" role="signal"><title>The <literal>"array-element"</literal> signal</title>
<indexterm zone="JsonParser-array-element"><primary sortas="Parser::array-element">JsonParser::array-element</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gint">gint</link> index_,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::array-element signal is emitted each time the <link linkend="JsonParser"><type>JsonParser</type></link>
has successfully parsed a single element of a <link linkend="JsonArray"><type>JsonArray</type></link>. The
array and element index are passed to the signal handlers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the newly parsed element
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-array-end" role="signal"><title>The <literal>"array-end"</literal> signal</title>
<indexterm zone="JsonParser-array-end"><primary sortas="Parser::array-end">JsonParser::array-end</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::array-end signal is emitted each time the <link linkend="JsonParser"><type>JsonParser</type></link>
has successfully parsed an entire <link linkend="JsonArray"><type>JsonArray</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> the parsed <link linkend="JsonArrary"><type>JsonArrary</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-array-start" role="signal"><title>The <literal>"array-start"</literal> signal</title>
<indexterm zone="JsonParser-array-start"><primary sortas="Parser::array-start">JsonParser::array-start</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::array-start signal is emitted each time the <link linkend="JsonParser"><type>JsonParser</type></link>
starts parsing a <link linkend="JsonArray"><type>JsonArray</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-error" role="signal"><title>The <literal>"error"</literal> signal</title>
<indexterm zone="JsonParser-error"><primary sortas="Parser::error">JsonParser::error</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gpointer">gpointer</link> error,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::error signal is emitted each time a <link linkend="JsonParser"><type>JsonParser</type></link> encounters
an error in a JSON stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the parser instance that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a pointer to the <link linkend="GError"><type>GError</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-object-end" role="signal"><title>The <literal>"object-end"</literal> signal</title>
<indexterm zone="JsonParser-object-end"><primary sortas="Parser::object-end">JsonParser::object-end</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="JsonObject">JsonObject</link> *object,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::object-end signal is emitted each time the <link linkend="JsonParser"><type>JsonParser</type></link>
has successfully parsed an entire <link linkend="JsonObject"><type>JsonObject</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> the parsed <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-object-member" role="signal"><title>The <literal>"object-member"</literal> signal</title>
<indexterm zone="JsonParser-object-member"><primary sortas="Parser::object-member">JsonParser::object-member</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="JsonObject">JsonObject</link> *object,
<link linkend="gchar">gchar</link> *member_name,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::object-member signal is emitted each time the <link linkend="JsonParser"><type>JsonParser</type></link>
has successfully parsed a single member of a <link linkend="JsonObject"><type>JsonObject</type></link>. The
object and member are passed to the signal handlers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the newly parsed member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-object-start" role="signal"><title>The <literal>"object-start"</literal> signal</title>
<indexterm zone="JsonParser-object-start"><primary sortas="Parser::object-start">JsonParser::object-start</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::object-start signal is emitted each time the <link linkend="JsonParser"><type>JsonParser</type></link>
starts parsing a <link linkend="JsonObject"><type>JsonObject</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-parse-end" role="signal"><title>The <literal>"parse-end"</literal> signal</title>
<indexterm zone="JsonParser-parse-end"><primary sortas="Parser::parse-end">JsonParser::parse-end</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::parse-end signal is emitted when the parser successfully
finished parsing a JSON data stream</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="JsonParser-parse-start" role="signal"><title>The <literal>"parse-start"</literal> signal</title>
<indexterm zone="JsonParser-parse-start"><primary sortas="Parser::parse-start">JsonParser::parse-start</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="JsonParser">JsonParser</link> *parser,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The ::parse-start signal is emitted when the parser began parsing
a JSON data stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> the <link linkend="JsonParser"><type>JsonParser</type></link> that received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
