mirror of https://github.com/Gnucash/gnucash
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
223 lines
9.0 KiB
223 lines
9.0 KiB
<refentry id="gsf-Text">
|
|
<refmeta>
|
|
<refentrytitle>Text</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>GSF Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>Text</refname><refpurpose></refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
<anchor id="GsfInputTextline"/>
|
|
<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> *input);
|
|
<link linkend="guint8">guint8</link>* <link linkend="gsf-input-textline-utf8-gets">gsf_input_textline_utf8_gets</link> (<link linkend="GsfInputTextline">GsfInputTextline</link> *input);
|
|
<link linkend="GsfOutputIconv">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">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>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfInput">GsfInput</link>
|
|
+----GsfInputTextline
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GsfInputTextline-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"/>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 : adds a reference to <parameter>source</parameter></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 NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-input-textline-ascii-gets"/>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> *input);</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>input</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the string read, or NULL on eof.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-input-textline-utf8-gets"/>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> *input);</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>input</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the string read, or NULL on eof.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfOutputIconv"/>GsfOutputIconv</title>
|
|
<indexterm><primary>GsfOutputIconv</primary></indexterm><programlisting>typedef struct _GsfOutputIconv GsfOutputIconv;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-output-iconv-new"/>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 NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfOutputCsv"/>GsfOutputCsv</title>
|
|
<indexterm><primary>GsfOutputCsv</primary></indexterm><programlisting>typedef struct {
|
|
GsfOutput output;
|
|
|
|
GsfOutput *sink;
|
|
|
|
char *quote;
|
|
size_t quote_len;
|
|
GsfOutputCsvQuotingMode quoting_mode;
|
|
char *quoting_triggers;
|
|
|
|
char *eol;
|
|
size_t eol_len;
|
|
char *separator;
|
|
size_t separator_len;
|
|
gboolean fields_on_line;
|
|
|
|
GString *buf;
|
|
} GsfOutputCsv;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-output-csv-write-eol"/>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"/>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"/>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>
|
|
|
|
|
|
|
|
|
|
</refentry>
|