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.
1908 lines
68 KiB
1908 lines
68 KiB
<refentry id="gsf-utils">
|
|
<refmeta>
|
|
<refentrytitle>utils</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>GSF Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>utils</refname><refpurpose></refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
|
|
<link linkend="void">void</link> <link linkend="gsf-init">gsf_init</link> (void);
|
|
<link linkend="void">void</link> <link linkend="gsf-shutdown">gsf_shutdown</link> (void);
|
|
<link linkend="void">void</link> <link linkend="gsf-init-dynamic">gsf_init_dynamic</link> (<link linkend="GTypeModule">GTypeModule</link> *module);
|
|
<link linkend="void">void</link> <link linkend="gsf-shutdown-dynamic">gsf_shutdown_dynamic</link> (<link linkend="GTypeModule">GTypeModule</link> *module);
|
|
extern int <link linkend="libgsf-major-version">libgsf_major_version</link>;
|
|
extern int <link linkend="libgsf-minor-version">libgsf_minor_version</link>;
|
|
extern int <link linkend="libgsf-micro-version">libgsf_micro_version</link>;
|
|
|
|
#define <link linkend="GSF-CLASS:CAPS">GSF_CLASS</link> (name, prefix, class_init, instance_init, parent)
|
|
#define <link linkend="GSF-CLASS-FULL:CAPS">GSF_CLASS_FULL</link> (name, prefix, base_init, base_finalize, \
|
|
class_init, class_finalize, instance_init, parent_type, \
|
|
abstract, interface_decl)
|
|
#define <link linkend="GSF-CLASS-ABSTRACT:CAPS">GSF_CLASS_ABSTRACT</link> (name, prefix, class_init, instance_init, parent)
|
|
#define <link linkend="GSF-INTERFACE:CAPS">GSF_INTERFACE</link> (init_func, iface_type)
|
|
#define <link linkend="GSF-INTERFACE-FULL:CAPS">GSF_INTERFACE_FULL</link> (type, init_func, iface_type)
|
|
#define <link linkend="GSF-DYNAMIC-CLASS:CAPS">GSF_DYNAMIC_CLASS</link> (name, prefix, class_init, instance_init, parent)
|
|
#define <link linkend="GSF-DYNAMIC-CLASS-FULL:CAPS">GSF_DYNAMIC_CLASS_FULL</link> (name, prefix, base_init, base_finalize, \
|
|
class_init, class_finalize, instance_init, parent_type, \
|
|
abstract, interface_decl)
|
|
#define <link linkend="GSF-DYNAMIC-CLASS-ABSTRACT:CAPS">GSF_DYNAMIC_CLASS_ABSTRACT</link> (name, prefix, class_init, instance_init, parent)
|
|
#define <link linkend="GSF-DYNAMIC-INTERFACE:CAPS">GSF_DYNAMIC_INTERFACE</link> (init_func, iface_type, module)
|
|
#define <link linkend="GSF-DYNAMIC-INTERFACE-FULL:CAPS">GSF_DYNAMIC_INTERFACE_FULL</link> (type, init_func, iface_type, module)
|
|
#define <link linkend="GSF-PARAM-STATIC:CAPS">GSF_PARAM_STATIC</link>
|
|
|
|
#define <link linkend="GSF-ERROR:CAPS">GSF_ERROR</link>
|
|
enum <link linkend="GsfError">GsfError</link>;
|
|
<link linkend="GQuark">GQuark</link> <link linkend="gsf-error-quark">gsf_error_quark</link> (void);
|
|
|
|
<link linkend="void">void</link> <link linkend="gsf-mem-dump">gsf_mem_dump</link> (<link linkend="guint8">guint8</link> const *ptr,
|
|
<link linkend="size-t">size_t</link> len);
|
|
<link linkend="void">void</link> <link linkend="gsf-input-dump">gsf_input_dump</link> (<link linkend="GsfInput">GsfInput</link> *input,
|
|
<link linkend="gboolean">gboolean</link> dump_as_hex);
|
|
|
|
#define <link linkend="GSF-OFF-T-FORMAT:CAPS">GSF_OFF_T_FORMAT</link>
|
|
typedef <link linkend="gsf-off-t">gsf_off_t</link>;
|
|
<link linkend="char">char</link>* <link linkend="gsf-filename-to-utf8">gsf_filename_to_utf8</link> (<link linkend="char">char</link> const *filename,
|
|
<link linkend="gboolean">gboolean</link> quoted);
|
|
<link linkend="void">void</link> <link linkend="gsf-iconv-close">gsf_iconv_close</link> (<link linkend="GIConv">GIConv</link> handle);
|
|
<link linkend="char">char</link>const * <link linkend="gsf-extension-pointer">gsf_extension_pointer</link> (<link linkend="char">char</link> const *path);
|
|
|
|
<link linkend="guint8">guint8</link>* <link linkend="gsf-base64-encode-simple">gsf_base64_encode_simple</link> (<link linkend="guint8">guint8</link> const *data,
|
|
<link linkend="size-t">size_t</link> len);
|
|
<link linkend="size-t">size_t</link> <link linkend="gsf-base64-encode-close">gsf_base64_encode_close</link> (<link linkend="guint8">guint8</link> const *in,
|
|
<link linkend="size-t">size_t</link> inlen,
|
|
<link linkend="gboolean">gboolean</link> break_lines,
|
|
<link linkend="guint8">guint8</link> *out,
|
|
<link linkend="int">int</link> *state,
|
|
<link linkend="guint">guint</link> *save);
|
|
<link linkend="size-t">size_t</link> <link linkend="gsf-base64-encode-step">gsf_base64_encode_step</link> (<link linkend="guint8">guint8</link> const *in,
|
|
<link linkend="size-t">size_t</link> len,
|
|
<link linkend="gboolean">gboolean</link> break_lines,
|
|
<link linkend="guint8">guint8</link> *out,
|
|
<link linkend="int">int</link> *state,
|
|
<link linkend="guint">guint</link> *save);
|
|
<link linkend="size-t">size_t</link> <link linkend="gsf-base64-decode-simple">gsf_base64_decode_simple</link> (<link linkend="guint8">guint8</link> *data,
|
|
<link linkend="size-t">size_t</link> len);
|
|
<link linkend="size-t">size_t</link> <link linkend="gsf-base64-decode-step">gsf_base64_decode_step</link> (<link linkend="guint8">guint8</link> const *in,
|
|
<link linkend="size-t">size_t</link> len,
|
|
<link linkend="guint8">guint8</link> *out,
|
|
<link linkend="int">int</link> *state,
|
|
<link linkend="guint">guint</link> *save);
|
|
#define <link linkend="GSF-LE-GET-GINT8:CAPS">GSF_LE_GET_GINT8</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GUINT64:CAPS">GSF_LE_GET_GUINT64</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GINT16:CAPS">GSF_LE_GET_GINT16</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GUINT8:CAPS">GSF_LE_GET_GUINT8</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GINT32:CAPS">GSF_LE_GET_GINT32</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GUINT16:CAPS">GSF_LE_GET_GUINT16</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GUINT32:CAPS">GSF_LE_GET_GUINT32</link> (p)
|
|
#define <link linkend="GSF-LE-GET-GINT64:CAPS">GSF_LE_GET_GINT64</link> (p)
|
|
<link linkend="guint64">guint64</link> <link linkend="gsf-le-get-guint64">gsf_le_get_guint64</link> (<link linkend="void">void</link> const *p);
|
|
#define <link linkend="GSF-LE-GET-FLOAT:CAPS">GSF_LE_GET_FLOAT</link> (p)
|
|
<link linkend="float">float</link> <link linkend="gsf-le-get-float">gsf_le_get_float</link> (<link linkend="void">void</link> const *p);
|
|
#define <link linkend="GSF-LE-GET-DOUBLE:CAPS">GSF_LE_GET_DOUBLE</link> (p)
|
|
<link linkend="double">double</link> <link linkend="gsf-le-get-double">gsf_le_get_double</link> (<link linkend="void">void</link> const *p);
|
|
#define <link linkend="GSF-LE-SET-GUINT8:CAPS">GSF_LE_SET_GUINT8</link> (p, dat)
|
|
#define <link linkend="GSF-LE-SET-GUINT16:CAPS">GSF_LE_SET_GUINT16</link> (p, dat)
|
|
#define <link linkend="GSF-LE-SET-GUINT32:CAPS">GSF_LE_SET_GUINT32</link> (p, dat)
|
|
#define <link linkend="GSF-LE-SET-GINT8:CAPS">GSF_LE_SET_GINT8</link> (p,dat)
|
|
#define <link linkend="GSF-LE-SET-GINT16:CAPS">GSF_LE_SET_GINT16</link> (p,dat)
|
|
#define <link linkend="GSF-LE-SET-GINT32:CAPS">GSF_LE_SET_GINT32</link> (p,dat)
|
|
#define <link linkend="GSF-LE-SET-GINT64:CAPS">GSF_LE_SET_GINT64</link> (p,dat)
|
|
#define <link linkend="GSF-LE-SET-GUINT64:CAPS">GSF_LE_SET_GUINT64</link> (p, dat)
|
|
#define <link linkend="GSF-LE-SET-FLOAT:CAPS">GSF_LE_SET_FLOAT</link> (p,dat)
|
|
#define <link linkend="GSF-LE-SET-DOUBLE:CAPS">GSF_LE_SET_DOUBLE</link> (p,dat)
|
|
<link linkend="void">void</link> <link linkend="gsf-le-set-float">gsf_le_set_float</link> (<link linkend="void">void</link> *p,
|
|
<link linkend="float">float</link> f);
|
|
<link linkend="void">void</link> <link linkend="gsf-le-set-double">gsf_le_set_double</link> (<link linkend="void">void</link> *p,
|
|
<link linkend="double">double</link> d);
|
|
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link>;
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link>* <link linkend="gsf-timestamp-new">gsf_timestamp_new</link> (<link linkend="GDate">GDate</link> const *date,
|
|
<link linkend="glong">glong</link> seconds,
|
|
<link linkend="char">char</link> const *tz);
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link>* <link linkend="gsf-timestamp-new-now">gsf_timestamp_new_now</link> (void);
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link>* <link linkend="gsf-timestamp-copy">gsf_timestamp_copy</link> (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);
|
|
<link linkend="void">void</link> <link linkend="gsf-timestamp-free">gsf_timestamp_free</link> (<link linkend="GsfTimestamp">GsfTimestamp</link> *stamp);
|
|
<link linkend="char">char</link>* <link linkend="gsf-timestamp-as-string">gsf_timestamp_as_string</link> (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);
|
|
<link linkend="int">int</link> <link linkend="gsf-timestamp-parse">gsf_timestamp_parse</link> (<link linkend="char">char</link> const *spec,
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link> *stamp);
|
|
<link linkend="guint">guint</link> <link linkend="gsf-timestamp-hash">gsf_timestamp_hash</link> (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gsf-timestamp-equal">gsf_timestamp_equal</link> (<link linkend="GsfTimestamp">GsfTimestamp</link> const *a,
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link> const *b);
|
|
<link linkend="void">void</link> <link linkend="gsf-value-set-timestamp">gsf_value_set_timestamp</link> (<link linkend="GValue">GValue</link> *value,
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);
|
|
#define <link linkend="VAL-IS-GSF-TIMESTAMP:CAPS">VAL_IS_GSF_TIMESTAMP</link> (v)
|
|
|
|
|
|
<link linkend="GValue">GValue</link>* <link linkend="gsf-doc-prop-swap-val">gsf_doc_prop_swap_val</link> (<link linkend="GsfDocProp">GsfDocProp</link> *prop,
|
|
<link linkend="GValue">GValue</link> *val);
|
|
<link linkend="void">void</link> <link linkend="gsf-property-settings-collect">gsf_property_settings_collect</link> (<link linkend="GType">GType</link> object_type,
|
|
<link linkend="GParameter">GParameter</link> **p_params,
|
|
<link linkend="size-t">size_t</link> *p_n_params,
|
|
const <link linkend="gchar">gchar</link> *first_property_name,
|
|
...);
|
|
<link linkend="void">void</link> <link linkend="gsf-property-settings-collect-valist">gsf_property_settings_collect_valist</link>
|
|
(<link linkend="GType">GType</link> object_type,
|
|
<link linkend="GParameter">GParameter</link> **p_params,
|
|
<link linkend="size-t">size_t</link> *p_n_params,
|
|
const <link linkend="gchar">gchar</link> *first_property_name,
|
|
<link linkend="va-list">va_list</link> var_args);
|
|
<link linkend="void">void</link> <link linkend="gsf-property-settings-free">gsf_property_settings_free</link> (<link linkend="GParameter">GParameter</link> *params,
|
|
<link linkend="size-t">size_t</link> n_params);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gsf-init"/>gsf_init ()</title>
|
|
<indexterm><primary>gsf_init</primary></indexterm><programlisting><link linkend="void">void</link> gsf_init (void);</programlisting>
|
|
<para>
|
|
Initializes the GSF library</para>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-shutdown"/>gsf_shutdown ()</title>
|
|
<indexterm><primary>gsf_shutdown</primary></indexterm><programlisting><link linkend="void">void</link> gsf_shutdown (void);</programlisting>
|
|
<para>
|
|
De-intializes the GSF library</para>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-init-dynamic"/>gsf_init_dynamic ()</title>
|
|
<indexterm><primary>gsf_init_dynamic</primary></indexterm><programlisting><link linkend="void">void</link> gsf_init_dynamic (<link linkend="GTypeModule">GTypeModule</link> *module);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>module</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-shutdown-dynamic"/>gsf_shutdown_dynamic ()</title>
|
|
<indexterm><primary>gsf_shutdown_dynamic</primary></indexterm><programlisting><link linkend="void">void</link> gsf_shutdown_dynamic (<link linkend="GTypeModule">GTypeModule</link> *module);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>module</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="libgsf-major-version"/>libgsf_major_version</title>
|
|
<indexterm><primary>libgsf_major_version</primary></indexterm><programlisting>extern int libgsf_major_version;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="libgsf-minor-version"/>libgsf_minor_version</title>
|
|
<indexterm><primary>libgsf_minor_version</primary></indexterm><programlisting>extern int libgsf_minor_version;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="libgsf-micro-version"/>libgsf_micro_version</title>
|
|
<indexterm><primary>libgsf_micro_version</primary></indexterm><programlisting>extern int libgsf_micro_version;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-CLASS:CAPS"/>GSF_CLASS()</title>
|
|
<indexterm><primary>GSF_CLASS</primary></indexterm><programlisting>#define GSF_CLASS(name, prefix, class_init, instance_init, parent)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>prefix</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>class_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>instance_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>parent</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-CLASS-FULL:CAPS"/>GSF_CLASS_FULL()</title>
|
|
<indexterm><primary>GSF_CLASS_FULL</primary></indexterm><programlisting>#define GSF_CLASS_FULL(name, prefix, base_init, base_finalize, \
|
|
class_init, class_finalize, instance_init, parent_type, \
|
|
abstract, interface_decl)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>prefix</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>base_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>base_finalize</parameter> :</term>
|
|
<listitem><simpara>
|
|
@\
|
|
class_init:
|
|
@\
|
|
class_init:
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>class_finalize</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>instance_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>parent_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>interface_decl</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-CLASS-ABSTRACT:CAPS"/>GSF_CLASS_ABSTRACT()</title>
|
|
<indexterm><primary>GSF_CLASS_ABSTRACT</primary></indexterm><programlisting>#define GSF_CLASS_ABSTRACT(name, prefix, class_init, instance_init, parent)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>prefix</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>class_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>instance_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>parent</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-INTERFACE:CAPS"/>GSF_INTERFACE()</title>
|
|
<indexterm><primary>GSF_INTERFACE</primary></indexterm><programlisting>#define GSF_INTERFACE(init_func, iface_type)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>init_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>iface_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-INTERFACE-FULL:CAPS"/>GSF_INTERFACE_FULL()</title>
|
|
<indexterm><primary>GSF_INTERFACE_FULL</primary></indexterm><programlisting>#define GSF_INTERFACE_FULL(type, init_func, iface_type)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>init_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>iface_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-DYNAMIC-CLASS:CAPS"/>GSF_DYNAMIC_CLASS()</title>
|
|
<indexterm><primary>GSF_DYNAMIC_CLASS</primary></indexterm><programlisting>#define GSF_DYNAMIC_CLASS(name, prefix, class_init, instance_init, parent)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>prefix</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>class_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>instance_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>parent</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-DYNAMIC-CLASS-FULL:CAPS"/>GSF_DYNAMIC_CLASS_FULL()</title>
|
|
<indexterm><primary>GSF_DYNAMIC_CLASS_FULL</primary></indexterm><programlisting>#define GSF_DYNAMIC_CLASS_FULL(name, prefix, base_init, base_finalize, \
|
|
class_init, class_finalize, instance_init, parent_type, \
|
|
abstract, interface_decl)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>prefix</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>base_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>base_finalize</parameter> :</term>
|
|
<listitem><simpara>
|
|
@\
|
|
class_init:
|
|
@\
|
|
class_init:
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>class_finalize</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>instance_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>parent_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
@\
|
|
abstract:
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>interface_decl</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-DYNAMIC-CLASS-ABSTRACT:CAPS"/>GSF_DYNAMIC_CLASS_ABSTRACT()</title>
|
|
<indexterm><primary>GSF_DYNAMIC_CLASS_ABSTRACT</primary></indexterm><programlisting>#define GSF_DYNAMIC_CLASS_ABSTRACT(name, prefix, class_init, instance_init, parent)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>prefix</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>class_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>instance_init</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>parent</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-DYNAMIC-INTERFACE:CAPS"/>GSF_DYNAMIC_INTERFACE()</title>
|
|
<indexterm><primary>GSF_DYNAMIC_INTERFACE</primary></indexterm><programlisting>#define GSF_DYNAMIC_INTERFACE(init_func, iface_type, module)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>init_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>iface_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>module</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-DYNAMIC-INTERFACE-FULL:CAPS"/>GSF_DYNAMIC_INTERFACE_FULL()</title>
|
|
<indexterm><primary>GSF_DYNAMIC_INTERFACE_FULL</primary></indexterm><programlisting>#define GSF_DYNAMIC_INTERFACE_FULL(type, init_func, iface_type, module)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>init_func</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>iface_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>module</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-PARAM-STATIC:CAPS"/>GSF_PARAM_STATIC</title>
|
|
<indexterm><primary>GSF_PARAM_STATIC</primary></indexterm><programlisting>#define GSF_PARAM_STATIC</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-ERROR:CAPS"/>GSF_ERROR</title>
|
|
<indexterm><primary>GSF_ERROR</primary></indexterm><programlisting>#define GSF_ERROR (gsf_error_quark ())
|
|
</programlisting>
|
|
<para>
|
|
This convenience macro simply calls <link linkend="gsf-error-quark"><function>gsf_error_quark()</function></link>. You can use
|
|
it in calls to <link linkend="g-error-matches"><function>g_error_matches()</function></link>, for example. The macro returns
|
|
the <link linkend="GQuark"><type>GQuark</type></link> that is used to identify errors from libgsf functions.
|
|
Specific error codes come from the <link linkend="GsfError"><type>GsfError</type></link> enumeration.
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfError"/>enum GsfError</title>
|
|
<indexterm><primary>GsfError</primary></indexterm><programlisting>typedef enum {
|
|
GSF_ERROR_OUT_OF_MEMORY,
|
|
GSF_ERROR_INVALID_DATA
|
|
} GsfError;
|
|
</programlisting>
|
|
<para>
|
|
Error codes that can be returned from libgsf functions in <link linkend="GError"><type>GError</type></link> structures.
|
|
</para><variablelist role="enum">
|
|
<varlistentry>
|
|
<term><literal>GSF_ERROR_OUT_OF_MEMORY</literal></term>
|
|
<listitem><simpara>Not enough memory could be allocated to hold
|
|
a structure or object.
|
|
</simpara></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>GSF_ERROR_INVALID_DATA</literal></term>
|
|
<listitem><simpara>A file being read contained invalid or
|
|
inconsistent data.
|
|
|
|
</simpara></listitem>
|
|
</varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-error-quark"/>gsf_error_quark ()</title>
|
|
<indexterm><primary>gsf_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> gsf_error_quark (void);</programlisting>
|
|
<para>
|
|
Returns the <link linkend="GQuark"><type>GQuark</type></link> used to identify libgsf errors in <link linkend="GError"><type>GError</type></link> structures.
|
|
Specific error codes come from the <link linkend="GsfError"><type>GsfError</type></link> enumeration.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GQuark"><type>GQuark</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-mem-dump"/>gsf_mem_dump ()</title>
|
|
<indexterm><primary>gsf_mem_dump</primary></indexterm><programlisting><link linkend="void">void</link> gsf_mem_dump (<link linkend="guint8">guint8</link> const *ptr,
|
|
<link linkend="size-t">size_t</link> len);</programlisting>
|
|
<para>
|
|
Dump <parameter>len</parameter> bytes from the memory location given by <parameter>ptr</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>ptr</parameter> :</term>
|
|
<listitem><simpara> memory area to be dumped.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>len</parameter> :</term>
|
|
<listitem><simpara> how many bytes will be dumped.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-input-dump"/>gsf_input_dump ()</title>
|
|
<indexterm><primary>gsf_input_dump</primary></indexterm><programlisting><link linkend="void">void</link> gsf_input_dump (<link linkend="GsfInput">GsfInput</link> *input,
|
|
<link linkend="gboolean">gboolean</link> dump_as_hex);</programlisting>
|
|
<para>
|
|
Dumps <parameter>input</parameter>'s contents to STDOUT, optionally in hex format.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>input</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GsfInput"><type>GsfInput</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dump_as_hex</parameter> :</term>
|
|
<listitem><simpara> If TRUE, dump in hexidecmal format
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-OFF-T-FORMAT:CAPS"/>GSF_OFF_T_FORMAT</title>
|
|
<indexterm><primary>GSF_OFF_T_FORMAT</primary></indexterm><programlisting>#define GSF_OFF_T_FORMAT G_GINT64_FORMAT
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-off-t"/>gsf_off_t</title>
|
|
<indexterm><primary>gsf_off_t</primary></indexterm><programlisting>typedef gint64 gsf_off_t;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-filename-to-utf8"/>gsf_filename_to_utf8 ()</title>
|
|
<indexterm><primary>gsf_filename_to_utf8</primary></indexterm><programlisting><link linkend="char">char</link>* gsf_filename_to_utf8 (<link linkend="char">char</link> const *filename,
|
|
<link linkend="gboolean">gboolean</link> quoted);</programlisting>
|
|
<para>
|
|
A utility wrapper to make sure filenames are valid utf8.
|
|
Caller must g_free the result.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>filename</parameter> :</term>
|
|
<listitem><simpara> file name suitable for open(2).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>quoted</parameter> :</term>
|
|
<listitem><simpara> if TRUE, the resulting utf8 file name will be quoted
|
|
(unless it is invalid).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><parameter>filename</parameter> using utf-8 encoding for display
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-iconv-close"/>gsf_iconv_close ()</title>
|
|
<indexterm><primary>gsf_iconv_close</primary></indexterm><programlisting><link linkend="void">void</link> gsf_iconv_close (<link linkend="GIConv">GIConv</link> handle);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>handle</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-extension-pointer"/>gsf_extension_pointer ()</title>
|
|
<indexterm><primary>gsf_extension_pointer</primary></indexterm><programlisting><link linkend="char">char</link>const * gsf_extension_pointer (<link linkend="char">char</link> const *path);</programlisting>
|
|
<para>
|
|
Extracts the extension from the end of a filename (the part after the final
|
|
'.' in the filename).</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>path</parameter> :</term>
|
|
<listitem><simpara> A filename or file path.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the extension part of the filename, or a
|
|
pointer to the end of the string if the filename does not
|
|
have an extension.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-base64-encode-simple"/>gsf_base64_encode_simple ()</title>
|
|
<indexterm><primary>gsf_base64_encode_simple</primary></indexterm><programlisting><link linkend="guint8">guint8</link>* gsf_base64_encode_simple (<link linkend="guint8">guint8</link> const *data,
|
|
<link linkend="size-t">size_t</link> len);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>data</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="gsf-base64-encode-close"/>gsf_base64_encode_close ()</title>
|
|
<indexterm><primary>gsf_base64_encode_close</primary></indexterm><programlisting><link linkend="size-t">size_t</link> gsf_base64_encode_close (<link linkend="guint8">guint8</link> const *in,
|
|
<link linkend="size-t">size_t</link> inlen,
|
|
<link linkend="gboolean">gboolean</link> break_lines,
|
|
<link linkend="guint8">guint8</link> *out,
|
|
<link linkend="int">int</link> *state,
|
|
<link linkend="guint">guint</link> *save);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>in</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>inlen</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>break_lines</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>out</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>state</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>save</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-base64-encode-step"/>gsf_base64_encode_step ()</title>
|
|
<indexterm><primary>gsf_base64_encode_step</primary></indexterm><programlisting><link linkend="size-t">size_t</link> gsf_base64_encode_step (<link linkend="guint8">guint8</link> const *in,
|
|
<link linkend="size-t">size_t</link> len,
|
|
<link linkend="gboolean">gboolean</link> break_lines,
|
|
<link linkend="guint8">guint8</link> *out,
|
|
<link linkend="int">int</link> *state,
|
|
<link linkend="guint">guint</link> *save);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>in</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>len</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>break_lines</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>out</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>state</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>save</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-base64-decode-simple"/>gsf_base64_decode_simple ()</title>
|
|
<indexterm><primary>gsf_base64_decode_simple</primary></indexterm><programlisting><link linkend="size-t">size_t</link> gsf_base64_decode_simple (<link linkend="guint8">guint8</link> *data,
|
|
<link linkend="size-t">size_t</link> len);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>data</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="gsf-base64-decode-step"/>gsf_base64_decode_step ()</title>
|
|
<indexterm><primary>gsf_base64_decode_step</primary></indexterm><programlisting><link linkend="size-t">size_t</link> gsf_base64_decode_step (<link linkend="guint8">guint8</link> const *in,
|
|
<link linkend="size-t">size_t</link> len,
|
|
<link linkend="guint8">guint8</link> *out,
|
|
<link linkend="int">int</link> *state,
|
|
<link linkend="guint">guint</link> *save);</programlisting>
|
|
<para>
|
|
Decodes a chunk of base64 encoded data</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>in</parameter> :</term>
|
|
<listitem><simpara> input stream
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>len</parameter> :</term>
|
|
<listitem><simpara> max length of data to decode
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>out</parameter> :</term>
|
|
<listitem><simpara> output stream
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>state</parameter> :</term>
|
|
<listitem><simpara> holds the number of bits that are stored in <parameter>save</parameter>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>save</parameter> :</term>
|
|
<listitem><simpara> leftover bits that have not yet been decoded
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the number of bytes converted
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GINT8:CAPS"/>GSF_LE_GET_GINT8()</title>
|
|
<indexterm><primary>GSF_LE_GET_GINT8</primary></indexterm><programlisting>#define GSF_LE_GET_GINT8(p) ((gint8)GSF_LE_GET_GUINT8(p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GUINT64:CAPS"/>GSF_LE_GET_GUINT64()</title>
|
|
<indexterm><primary>GSF_LE_GET_GUINT64</primary></indexterm><programlisting>#define GSF_LE_GET_GUINT64(p) (gsf_le_get_guint64 (p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GINT16:CAPS"/>GSF_LE_GET_GINT16()</title>
|
|
<indexterm><primary>GSF_LE_GET_GINT16</primary></indexterm><programlisting>#define GSF_LE_GET_GINT16(p) ((gint16)GSF_LE_GET_GUINT16(p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GUINT8:CAPS"/>GSF_LE_GET_GUINT8()</title>
|
|
<indexterm><primary>GSF_LE_GET_GUINT8</primary></indexterm><programlisting>#define GSF_LE_GET_GUINT8(p) (*(guint8 const *)(p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GINT32:CAPS"/>GSF_LE_GET_GINT32()</title>
|
|
<indexterm><primary>GSF_LE_GET_GINT32</primary></indexterm><programlisting>#define GSF_LE_GET_GINT32(p) ((gint32)GSF_LE_GET_GUINT32(p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GUINT16:CAPS"/>GSF_LE_GET_GUINT16()</title>
|
|
<indexterm><primary>GSF_LE_GET_GUINT16</primary></indexterm><programlisting>#define GSF_LE_GET_GUINT16(p)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GUINT32:CAPS"/>GSF_LE_GET_GUINT32()</title>
|
|
<indexterm><primary>GSF_LE_GET_GUINT32</primary></indexterm><programlisting>#define GSF_LE_GET_GUINT32(p)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-GET-GINT64:CAPS"/>GSF_LE_GET_GINT64()</title>
|
|
<indexterm><primary>GSF_LE_GET_GINT64</primary></indexterm><programlisting>#define GSF_LE_GET_GINT64(p) ((gint64)GSF_LE_GET_GUINT64(p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-le-get-guint64"/>gsf_le_get_guint64 ()</title>
|
|
<indexterm><primary>gsf_le_get_guint64</primary></indexterm><programlisting><link linkend="guint64">guint64</link> gsf_le_get_guint64 (<link linkend="void">void</link> const *p);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</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-LE-GET-FLOAT:CAPS"/>GSF_LE_GET_FLOAT()</title>
|
|
<indexterm><primary>GSF_LE_GET_FLOAT</primary></indexterm><programlisting>#define GSF_LE_GET_FLOAT(p) (gsf_le_get_float (p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-le-get-float"/>gsf_le_get_float ()</title>
|
|
<indexterm><primary>gsf_le_get_float</primary></indexterm><programlisting><link linkend="float">float</link> gsf_le_get_float (<link linkend="void">void</link> const *p);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</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-LE-GET-DOUBLE:CAPS"/>GSF_LE_GET_DOUBLE()</title>
|
|
<indexterm><primary>GSF_LE_GET_DOUBLE</primary></indexterm><programlisting>#define GSF_LE_GET_DOUBLE(p) (gsf_le_get_double (p))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-le-get-double"/>gsf_le_get_double ()</title>
|
|
<indexterm><primary>gsf_le_get_double</primary></indexterm><programlisting><link linkend="double">double</link> gsf_le_get_double (<link linkend="void">void</link> const *p);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</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-LE-SET-GUINT8:CAPS"/>GSF_LE_SET_GUINT8()</title>
|
|
<indexterm><primary>GSF_LE_SET_GUINT8</primary></indexterm><programlisting>#define GSF_LE_SET_GUINT8(p, dat)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GUINT16:CAPS"/>GSF_LE_SET_GUINT16()</title>
|
|
<indexterm><primary>GSF_LE_SET_GUINT16</primary></indexterm><programlisting>#define GSF_LE_SET_GUINT16(p, dat)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GUINT32:CAPS"/>GSF_LE_SET_GUINT32()</title>
|
|
<indexterm><primary>GSF_LE_SET_GUINT32</primary></indexterm><programlisting>#define GSF_LE_SET_GUINT32(p, dat)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GINT8:CAPS"/>GSF_LE_SET_GINT8()</title>
|
|
<indexterm><primary>GSF_LE_SET_GINT8</primary></indexterm><programlisting>#define GSF_LE_SET_GINT8(p,dat) GSF_LE_SET_GUINT8((p),(dat))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GINT16:CAPS"/>GSF_LE_SET_GINT16()</title>
|
|
<indexterm><primary>GSF_LE_SET_GINT16</primary></indexterm><programlisting>#define GSF_LE_SET_GINT16(p,dat) GSF_LE_SET_GUINT16((p),(dat))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GINT32:CAPS"/>GSF_LE_SET_GINT32()</title>
|
|
<indexterm><primary>GSF_LE_SET_GINT32</primary></indexterm><programlisting>#define GSF_LE_SET_GINT32(p,dat) GSF_LE_SET_GUINT32((p),(dat))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GINT64:CAPS"/>GSF_LE_SET_GINT64()</title>
|
|
<indexterm><primary>GSF_LE_SET_GINT64</primary></indexterm><programlisting>#define GSF_LE_SET_GINT64(p,dat) GSF_LE_SET_GUINT64((p),(dat))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-GUINT64:CAPS"/>GSF_LE_SET_GUINT64()</title>
|
|
<indexterm><primary>GSF_LE_SET_GUINT64</primary></indexterm><programlisting>#define GSF_LE_SET_GUINT64(p, dat)</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-FLOAT:CAPS"/>GSF_LE_SET_FLOAT()</title>
|
|
<indexterm><primary>GSF_LE_SET_FLOAT</primary></indexterm><programlisting>#define GSF_LE_SET_FLOAT(p,dat) gsf_le_set_float((p),(dat))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GSF-LE-SET-DOUBLE:CAPS"/>GSF_LE_SET_DOUBLE()</title>
|
|
<indexterm><primary>GSF_LE_SET_DOUBLE</primary></indexterm><programlisting>#define GSF_LE_SET_DOUBLE(p,dat) gsf_le_set_double((p),(dat))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dat</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-le-set-float"/>gsf_le_set_float ()</title>
|
|
<indexterm><primary>gsf_le_set_float</primary></indexterm><programlisting><link linkend="void">void</link> gsf_le_set_float (<link linkend="void">void</link> *p,
|
|
<link linkend="float">float</link> f);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>f</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-le-set-double"/>gsf_le_set_double ()</title>
|
|
<indexterm><primary>gsf_le_set_double</primary></indexterm><programlisting><link linkend="void">void</link> gsf_le_set_double (<link linkend="void">void</link> *p,
|
|
<link linkend="double">double</link> d);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>p</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>d</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GsfTimestamp"/>GsfTimestamp</title>
|
|
<indexterm><primary>GsfTimestamp</primary></indexterm><programlisting>typedef struct {
|
|
GDate date; /* In local timezone */
|
|
glong seconds; /* time of day */
|
|
GString time_zone; /* possibly blank */
|
|
|
|
guint32 timet;
|
|
} GsfTimestamp;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-timestamp-new"/>gsf_timestamp_new ()</title>
|
|
<indexterm><primary>gsf_timestamp_new</primary></indexterm><programlisting><link linkend="GsfTimestamp">GsfTimestamp</link>* gsf_timestamp_new (<link linkend="GDate">GDate</link> const *date,
|
|
<link linkend="glong">glong</link> seconds,
|
|
<link linkend="char">char</link> const *tz);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>date</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>seconds</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>tz</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-timestamp-new-now"/>gsf_timestamp_new_now ()</title>
|
|
<indexterm><primary>gsf_timestamp_new_now</primary></indexterm><programlisting><link linkend="GsfTimestamp">GsfTimestamp</link>* gsf_timestamp_new_now (void);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-timestamp-copy"/>gsf_timestamp_copy ()</title>
|
|
<indexterm><primary>gsf_timestamp_copy</primary></indexterm><programlisting><link linkend="GsfTimestamp">GsfTimestamp</link>* gsf_timestamp_copy (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>stamp</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-timestamp-free"/>gsf_timestamp_free ()</title>
|
|
<indexterm><primary>gsf_timestamp_free</primary></indexterm><programlisting><link linkend="void">void</link> gsf_timestamp_free (<link linkend="GsfTimestamp">GsfTimestamp</link> *stamp);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>stamp</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-timestamp-as-string"/>gsf_timestamp_as_string ()</title>
|
|
<indexterm><primary>gsf_timestamp_as_string</primary></indexterm><programlisting><link linkend="char">char</link>* gsf_timestamp_as_string (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>stamp</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-timestamp-parse"/>gsf_timestamp_parse ()</title>
|
|
<indexterm><primary>gsf_timestamp_parse</primary></indexterm><programlisting><link linkend="int">int</link> gsf_timestamp_parse (<link linkend="char">char</link> const *spec,
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link> *stamp);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>spec</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>stamp</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-timestamp-hash"/>gsf_timestamp_hash ()</title>
|
|
<indexterm><primary>gsf_timestamp_hash</primary></indexterm><programlisting><link linkend="guint">guint</link> gsf_timestamp_hash (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>stamp</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-timestamp-equal"/>gsf_timestamp_equal ()</title>
|
|
<indexterm><primary>gsf_timestamp_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_timestamp_equal (<link linkend="GsfTimestamp">GsfTimestamp</link> const *a,
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link> const *b);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>a</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>b</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-value-set-timestamp"/>gsf_value_set_timestamp ()</title>
|
|
<indexterm><primary>gsf_value_set_timestamp</primary></indexterm><programlisting><link linkend="void">void</link> gsf_value_set_timestamp (<link linkend="GValue">GValue</link> *value,
|
|
<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>value</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>stamp</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="VAL-IS-GSF-TIMESTAMP:CAPS"/>VAL_IS_GSF_TIMESTAMP()</title>
|
|
<indexterm><primary>VAL_IS_GSF_TIMESTAMP</primary></indexterm><programlisting>#define VAL_IS_GSF_TIMESTAMP(v) (G_TYPE_CHECK_VALUE_TYPE((v), GSF_TIMESTAMP_TYPE))
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>v</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-doc-prop-swap-val"/>gsf_doc_prop_swap_val ()</title>
|
|
<indexterm><primary>gsf_doc_prop_swap_val</primary></indexterm><programlisting><link linkend="GValue">GValue</link>* gsf_doc_prop_swap_val (<link linkend="GsfDocProp">GsfDocProp</link> *prop,
|
|
<link linkend="GValue">GValue</link> *val);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>prop</parameter> :</term>
|
|
<listitem><simpara> <link linkend="GsfDocProp"><type>GsfDocProp</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>val</parameter> :</term>
|
|
<listitem><simpara> <link linkend="GValue"><type>GValue</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the current value of <parameter>prop</parameter>, and replaces it with <parameter>val</parameter>
|
|
Caller is responsible for unsetting and freeing the result.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-property-settings-collect"/>gsf_property_settings_collect ()</title>
|
|
<indexterm><primary>gsf_property_settings_collect</primary></indexterm><programlisting><link linkend="void">void</link> gsf_property_settings_collect (<link linkend="GType">GType</link> object_type,
|
|
<link linkend="GParameter">GParameter</link> **p_params,
|
|
<link linkend="size-t">size_t</link> *p_n_params,
|
|
const <link linkend="gchar">gchar</link> *first_property_name,
|
|
...);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>object_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>p_params</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>p_n_params</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>first_property_name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>...</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-property-settings-collect-valist"/>gsf_property_settings_collect_valist ()</title>
|
|
<indexterm><primary>gsf_property_settings_collect_valist</primary></indexterm><programlisting><link linkend="void">void</link> gsf_property_settings_collect_valist
|
|
(<link linkend="GType">GType</link> object_type,
|
|
<link linkend="GParameter">GParameter</link> **p_params,
|
|
<link linkend="size-t">size_t</link> *p_n_params,
|
|
const <link linkend="gchar">gchar</link> *first_property_name,
|
|
<link linkend="va-list">va_list</link> var_args);</programlisting>
|
|
<para>
|
|
This function builds a GParameter array suitable for g_object_newv.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>object_type</parameter> :</term>
|
|
<listitem><simpara> the GType for which the properties are being set.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>p_params</parameter> :</term>
|
|
<listitem><simpara> a pointer to the GParameter array that holds the properties.
|
|
(Used for both input and output. This may point to a NULL pointer if
|
|
there are no properties collected yet.)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>p_n_params</parameter> :</term>
|
|
<listitem><simpara> a pointer to the number of properties collected. (Used for
|
|
both input and output.)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>first_property_name</parameter> :</term>
|
|
<listitem><simpara> the name of the first property being set, or NULL.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>var_args</parameter> :</term>
|
|
<listitem><simpara> a va_list holding the remainder of the property names and
|
|
values, terminated by a NULL.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-property-settings-free"/>gsf_property_settings_free ()</title>
|
|
<indexterm><primary>gsf_property_settings_free</primary></indexterm><programlisting><link linkend="void">void</link> gsf_property_settings_free (<link linkend="GParameter">GParameter</link> *params,
|
|
<link linkend="size-t">size_t</link> n_params);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>params</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>n_params</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
|
|
<!--
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-parent-document: ("../gsf-docs.sgml" "book" "refsect1")
|
|
End:
|
|
-->
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|