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
|
<refentry id="gsf-Text">
<refmeta>
<refentrytitle role="top_of_page">Text</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Text</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GsfInputTextline"/><anchor id="GsfOutputIconv"/><anchor id="GsfOutputCsv"/>
<synopsis>
<link linkend="GsfInputTextline-struct">GsfInputTextline</link>;
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-textline-new">gsf_input_textline_new</link> (<link linkend="GsfInput">GsfInput</link> *source);
unsigned <link linkend="char">char</link>* <link linkend="gsf-input-textline-ascii-gets">gsf_input_textline_ascii_gets</link> (<link linkend="GsfInputTextline">GsfInputTextline</link> *textline);
<link linkend="guint8">guint8</link>* <link linkend="gsf-input-textline-utf8-gets">gsf_input_textline_utf8_gets</link> (<link linkend="GsfInputTextline">GsfInputTextline</link> *textline);
<link linkend="GsfOutputIconv-struct">GsfOutputIconv</link>;
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-output-iconv-new">gsf_output_iconv_new</link> (<link linkend="GsfOutput">GsfOutput</link> *sink,
<link linkend="char">char</link> const *dst,
<link linkend="char">char</link> const *src);
<link linkend="GsfOutputCsv-struct">GsfOutputCsv</link>;
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-csv-write-eol">gsf_output_csv_write_eol</link> (<link linkend="GsfOutputCsv">GsfOutputCsv</link> *csv);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-csv-write-field">gsf_output_csv_write_field</link> (<link linkend="GsfOutputCsv">GsfOutputCsv</link> *csv,
<link linkend="char">char</link> const *field,
<link linkend="size-t">size_t</link> len);
enum <link linkend="GsfOutputCsvQuotingMode">GsfOutputCsvQuotingMode</link>;
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfInput">GsfInput</link>
+----GsfInputTextline
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfOutput">GsfOutput</link>
+----GsfOutputIconv
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfOutput">GsfOutput</link>
+----GsfOutputCsv
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GsfOutputIconv--fallback">fallback</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GsfOutputIconv--input-charset">input-charset</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
"<link linkend="GsfOutputIconv--output-charset">output-charset</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
"<link linkend="GsfOutputIconv--sink">sink</link>" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only
"<link linkend="GsfOutputCsv--eol">eol</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
"<link linkend="GsfOutputCsv--quote">quote</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
"<link linkend="GsfOutputCsv--quoting-mode">quoting-mode</link>" <link linkend="GsfOutputCsvQuotingMode">GsfOutputCsvQuotingMode</link> : Read / Write / Construct
"<link linkend="GsfOutputCsv--quoting-on-whitespace">quoting-on-whitespace</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="GsfOutputCsv--quoting-triggers">quoting-triggers</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GsfOutputCsv--separator">separator</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
"<link linkend="GsfOutputCsv--sink">sink</link>" <link linkend="GsfOutput">GsfOutput</link> : Read / Write
</synopsis>
</refsect1>
<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="GsfInputTextline-struct" role="struct"/>GsfInputTextline</title>
<indexterm><primary>GsfInputTextline</primary></indexterm><programlisting>typedef struct _GsfInputTextline GsfInputTextline;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-input-textline-new" role="function"/>gsf_input_textline_new ()</title>
<indexterm><primary>gsf_input_textline_new</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_textline_new (<link linkend="GsfInput">GsfInput</link> *source);</programlisting>
<para>
<note>This adds a reference to <parameter>source</parameter>.</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> in some combination of ascii and utf8
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new file or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-textline-ascii-gets" role="function"/>gsf_input_textline_ascii_gets ()</title>
<indexterm><primary>gsf_input_textline_ascii_gets</primary></indexterm><programlisting>unsigned <link linkend="char">char</link>* gsf_input_textline_ascii_gets (<link linkend="GsfInputTextline">GsfInputTextline</link> *textline);</programlisting>
<para>
A utility routine to read things line by line from the underlying source.
Trailing newlines and carriage returns are stripped, and the resultant buffer
can be edited.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>textline</parameter> :</term>
<listitem><simpara> <link linkend="GsfInputTextline"><type>GsfInputTextline</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string read, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on eof.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-textline-utf8-gets" role="function"/>gsf_input_textline_utf8_gets ()</title>
<indexterm><primary>gsf_input_textline_utf8_gets</primary></indexterm><programlisting><link linkend="guint8">guint8</link>* gsf_input_textline_utf8_gets (<link linkend="GsfInputTextline">GsfInputTextline</link> *textline);</programlisting>
<para>
A utility routine to read things line by line from the underlying source.
Trailing newlines and carriage returns are stripped, and the resultant buffer
can be edited.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>textline</parameter> :</term>
<listitem><simpara> <link linkend="GsfInputTextline"><type>GsfInputTextline</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string read, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on eof.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfOutputIconv-struct" role="struct"/>GsfOutputIconv</title>
<indexterm><primary>GsfOutputIconv</primary></indexterm><programlisting>typedef struct _GsfOutputIconv GsfOutputIconv;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-output-iconv-new" role="function"/>gsf_output_iconv_new ()</title>
<indexterm><primary>gsf_output_iconv_new</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_output_iconv_new (<link linkend="GsfOutput">GsfOutput</link> *sink,
<link linkend="char">char</link> const *dst,
<link linkend="char">char</link> const *src);</programlisting>
<para>
Adds a reference to <parameter>sink</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sink</parameter> :</term>
<listitem><simpara> The underlying data source.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dst</parameter> :</term>
<listitem><simpara> The target character set.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> The source character set.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new GsfOutput object or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfOutputCsv-struct" role="struct"/>GsfOutputCsv</title>
<indexterm><primary>GsfOutputCsv</primary></indexterm><programlisting>typedef struct _GsfOutputCsv GsfOutputCsv;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-output-csv-write-eol" role="function"/>gsf_output_csv_write_eol ()</title>
<indexterm><primary>gsf_output_csv_write_eol</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_csv_write_eol (<link linkend="GsfOutputCsv">GsfOutputCsv</link> *csv);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csv</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-csv-write-field" role="function"/>gsf_output_csv_write_field ()</title>
<indexterm><primary>gsf_output_csv_write_field</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_csv_write_field (<link linkend="GsfOutputCsv">GsfOutputCsv</link> *csv,
<link linkend="char">char</link> const *field,
<link linkend="size-t">size_t</link> len);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>csv</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>field</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfOutputCsvQuotingMode" role="enum"/>enum GsfOutputCsvQuotingMode</title>
<indexterm><primary>GsfOutputCsvQuotingMode</primary></indexterm><programlisting>typedef enum {
GSF_OUTPUT_CSV_QUOTING_MODE_NEVER,
GSF_OUTPUT_CSV_QUOTING_MODE_AUTO,
GSF_OUTPUT_CSV_QUOTING_MODE_ALWAYS
} GsfOutputCsvQuotingMode;
</programlisting>
<para>
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GsfOutputIconv--fallback"/>The "<literal>fallback</literal>" property</title>
<indexterm><primary>GsfOutputIconv:fallback</primary></indexterm><programlisting> "fallback" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>
Either NULL or a UTF-8 string (representable in the target encoding)
to convert and output in place of characters that cannot be represented
in the target encoding. NULL means use \u1234 or \U12345678 format.</para>
<para>
</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputIconv--input-charset"/>The "<literal>input-charset</literal>" property</title>
<indexterm><primary>GsfOutputIconv:input-charset</primary></indexterm><programlisting> "input-charset" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>The character set to convert from.</para><para>Default value: "UTF-8"</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputIconv--output-charset"/>The "<literal>output-charset</literal>" property</title>
<indexterm><primary>GsfOutputIconv:output-charset</primary></indexterm><programlisting> "output-charset" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>The character set to convert to.</para><para>Default value: "UTF-8"</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputIconv--sink"/>The "<literal>sink</literal>" property</title>
<indexterm><primary>GsfOutputIconv:sink</primary></indexterm><programlisting> "sink" <link linkend="GsfOutput">GsfOutput</link> : Read / Write / Construct Only</programlisting>
<para>Where the converted data is written.</para></refsect2>
<refsect2><title><anchor id="GsfOutputCsv--eol"/>The "<literal>eol</literal>" property</title>
<indexterm><primary>GsfOutputCsv:eol</primary></indexterm><programlisting> "eol" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>The end-of-line marker.</para><para>Default value: "\n"</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputCsv--quote"/>The "<literal>quote</literal>" property</title>
<indexterm><primary>GsfOutputCsv:quote</primary></indexterm><programlisting> "quote" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>The string used for quoting fields.</para><para>Default value: "\""</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputCsv--quoting-mode"/>The "<literal>quoting-mode</literal>" property</title>
<indexterm><primary>GsfOutputCsv:quoting-mode</primary></indexterm><programlisting> "quoting-mode" <link linkend="GsfOutputCsvQuotingMode">GsfOutputCsvQuotingMode</link> : Read / Write / Construct</programlisting>
<para>When to quote fields.</para><para>Default value: GSF_OUTPUT_CSV_QUOTING_MODE_NEVER</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputCsv--quoting-on-whitespace"/>The "<literal>quoting-on-whitespace</literal>" property</title>
<indexterm><primary>GsfOutputCsv:quoting-on-whitespace</primary></indexterm><programlisting> "quoting-on-whitespace" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Does initial or terminal whitespace force quoting?.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputCsv--quoting-triggers"/>The "<literal>quoting-triggers</literal>" property</title>
<indexterm><primary>GsfOutputCsv:quoting-triggers</primary></indexterm><programlisting> "quoting-triggers" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>Characters that cause field quoting.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputCsv--separator"/>The "<literal>separator</literal>" property</title>
<indexterm><primary>GsfOutputCsv:separator</primary></indexterm><programlisting> "separator" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>The field separator.</para><para>Default value: ","</para>
</refsect2>
<refsect2><title><anchor id="GsfOutputCsv--sink"/>The "<literal>sink</literal>" property</title>
<indexterm><primary>GsfOutputCsv:sink</primary></indexterm><programlisting> "sink" <link linkend="GsfOutput">GsfOutput</link> : Read / Write</programlisting>
<para>Where the compressed data is written.</para></refsect2>
</refsect1>
</refentry>
|
