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
|
<?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="JsonGenerator">
<refmeta>
<refentrytitle role="top_of_page" id="JsonGenerator.top_of_page">JsonGenerator</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>JsonGenerator</refname>
<refpurpose>Generates JSON data streams</refpurpose>
</refnamediv>
<refsynopsisdiv id="JsonGenerator.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="JsonGenerator-struct">JsonGenerator</link>;
<link linkend="JsonGeneratorClass">JsonGeneratorClass</link>;
<link linkend="JsonGenerator">JsonGenerator</link> * <link linkend="json-generator-new">json_generator_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="json-generator-to-file">json_generator_to_file</link> (<link linkend="JsonGenerator">JsonGenerator</link> *generator,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);
<link linkend="gchar">gchar</link> * <link linkend="json-generator-to-data">json_generator_to_data</link> (<link linkend="JsonGenerator">JsonGenerator</link> *generator,
<link linkend="gsize">gsize</link> *length);
<link linkend="void">void</link> <link linkend="json-generator-set-root">json_generator_set_root</link> (<link linkend="JsonGenerator">JsonGenerator</link> *generator,
<link linkend="JsonNode">JsonNode</link> *node);
</synopsis>
</refsynopsisdiv>
<refsect1 id="JsonGenerator.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----JsonGenerator
</synopsis>
</refsect1>
<refsect1 id="JsonGenerator.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="JsonGenerator--indent">indent</link>" <link linkend="guint">guint</link> : Read / Write
"<link linkend="JsonGenerator--indent-char">indent-char</link>" <link linkend="guint">guint</link> : Read / Write
"<link linkend="JsonGenerator--pretty">pretty</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="JsonGenerator--root">root</link>" <link linkend="JsonNode">JsonNode</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="JsonGenerator.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="JsonGenerator"><type>JsonGenerator</type></link> provides an object for generating a JSON data stream and
put it into a buffer or a file.</para>
<para>
</para>
</refsect1>
<refsect1 id="JsonGenerator.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JsonGenerator-struct" role="struct">
<title>JsonGenerator</title>
<indexterm zone="JsonGenerator-struct"><primary sortas="Generator">JsonGenerator</primary></indexterm><programlisting>typedef struct _JsonGenerator JsonGenerator;</programlisting>
<para>
JSON data streams generator. The contents of the <link linkend="JsonGenerator"><type>JsonGenerator</type></link> structure
are private and should only be accessed via the provided API.</para>
<para>
</para></refsect2>
<refsect2 id="JsonGeneratorClass" role="struct">
<title>JsonGeneratorClass</title>
<indexterm zone="JsonGeneratorClass"><primary sortas="GeneratorClass">JsonGeneratorClass</primary></indexterm><programlisting>typedef struct {
} JsonGeneratorClass;
</programlisting>
<para>
<link linkend="JsonGenerator"><type>JsonGenerator</type></link> class</para>
<para>
</para></refsect2>
<refsect2 id="json-generator-new" role="function">
<title>json_generator_new ()</title>
<indexterm zone="json-generator-new"><primary sortas="generator_new">json_generator_new</primary></indexterm><programlisting><link linkend="JsonGenerator">JsonGenerator</link> * json_generator_new (void);</programlisting>
<para>
Creates a new <link linkend="JsonGenerator"><type>JsonGenerator</type></link>. You can use this object to generate a
JSON data stream starting from a data object model composed by
<link linkend="JsonNode"><type>JsonNode</type></link><!-- -->s.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="JsonGenerator"><type>JsonGenerator</type></link> instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-generator-to-file" role="function">
<title>json_generator_to_file ()</title>
<indexterm zone="json-generator-to-file"><primary sortas="generator_to_file">json_generator_to_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_generator_to_file (<link linkend="JsonGenerator">JsonGenerator</link> *generator,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a JSON data stream and puts it inside <parameter>filename</parameter>, overwriting the
current file contents. This operation is atomic.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>generator</parameter> :</term>
<listitem><simpara> a <link linkend="JsonGenerator"><type>JsonGenerator</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> path to the target file
</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 saving was successful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-generator-to-data" role="function">
<title>json_generator_to_data ()</title>
<indexterm zone="json-generator-to-data"><primary sortas="generator_to_data">json_generator_to_data</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * json_generator_to_data (<link linkend="JsonGenerator">JsonGenerator</link> *generator,
<link linkend="gsize">gsize</link> *length);</programlisting>
<para>
Generates a JSON data stream from <parameter>generator</parameter> and returns it as a
buffer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>generator</parameter> :</term>
<listitem><simpara> a <link linkend="JsonGenerator"><type>JsonGenerator</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara>out. <acronym>out</acronym>. </simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated buffer holding a JSON data stream.
Use <link linkend="g-free"><function>g_free()</function></link> to free the allocated resources.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-generator-set-root" role="function">
<title>json_generator_set_root ()</title>
<indexterm zone="json-generator-set-root"><primary sortas="generator_set_root">json_generator_set_root</primary></indexterm><programlisting><link linkend="void">void</link> json_generator_set_root (<link linkend="JsonGenerator">JsonGenerator</link> *generator,
<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Sets <parameter>node</parameter> as the root of the JSON data stream to be serialized by
the <link linkend="JsonGenerator"><type>JsonGenerator</type></link>.
</para>
<para>
<note>The node is copied by the generator object, so it can be safely
freed after calling this function.</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>generator</parameter> :</term>
<listitem><simpara> a <link linkend="JsonGenerator"><type>JsonGenerator</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="JsonGenerator.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="JsonGenerator--indent" role="property"><title>The <literal>"indent"</literal> property</title>
<indexterm zone="JsonGenerator--indent"><primary sortas="Generator:indent">JsonGenerator:indent</primary></indexterm><programlisting> "indent" <link linkend="guint">guint</link> : Read / Write</programlisting>
<para>
Number of spaces to be used to indent when pretty printing.</para>
<para>
</para><para>Default value: 2</para>
</refsect2>
<refsect2 id="JsonGenerator--indent-char" role="property"><title>The <literal>"indent-char"</literal> property</title>
<indexterm zone="JsonGenerator--indent-char" role="0.6"><primary sortas="Generator:indent-char">JsonGenerator:indent-char</primary></indexterm><programlisting> "indent-char" <link linkend="guint">guint</link> : Read / Write</programlisting>
<para>
The character that should be used when indenting in pretty print.</para>
<para>
</para><para>Default value: ' '</para>
<para>Since 0.6</para>
</refsect2>
<refsect2 id="JsonGenerator--pretty" role="property"><title>The <literal>"pretty"</literal> property</title>
<indexterm zone="JsonGenerator--pretty"><primary sortas="Generator:pretty">JsonGenerator:pretty</primary></indexterm><programlisting> "pretty" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether the output should be "pretty-printed", with indentation and
newlines. The indentation level can be controlled by using the
JsonGenerator:indent property</para>
<para>
</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="JsonGenerator--root" role="property"><title>The <literal>"root"</literal> property</title>
<indexterm zone="JsonGenerator--root" role="0.4"><primary sortas="Generator:root">JsonGenerator:root</primary></indexterm><programlisting> "root" <link linkend="JsonNode">JsonNode</link>* : Read / Write</programlisting>
<para>
The root <link linkend="JsonNode"><type>JsonNode</type></link> to be used when constructing a JSON data
stream.</para>
<para>
</para><para>Since 0.4</para>
</refsect2>
</refsect1>
</refentry>
|
