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
|
<refentry id="xmlroff-fo-libfo-basic">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-fo-libfo-basic.top_of_page">fo-libfo-basic</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>fo-libfo-basic</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-fo-libfo-basic.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="FoLibfoBasicError">FoLibfoBasicError</link>;
#define <link linkend="FO-LIBFO-BASIC-ERROR:CAPS">FO_LIBFO_BASIC_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-libfo-basic-error-quark">fo_libfo_basic_error_quark</link> (void);
<link linkend="FoLibfoContext">FoLibfoContext</link>;
<link linkend="gboolean">gboolean</link> <link linkend="fo-libfo-init">fo_libfo_init</link> (void);
<link linkend="gpointer">gpointer</link> (<link linkend="FoMalloc">*FoMalloc</link>) (<link linkend="gsize">gsize</link> n_bytes);
<link linkend="gpointer">gpointer</link> (<link linkend="FoRealloc">*FoRealloc</link>) (<link linkend="gpointer">gpointer</link> mem,
<link linkend="gsize">gsize</link> n_bytes);
<link linkend="void">void</link> (<link linkend="FoFree">*FoFree</link>) (<link linkend="gpointer">gpointer</link> mem);
<link linkend="gboolean">gboolean</link> <link linkend="fo-libfo-init2">fo_libfo_init2</link> (<link linkend="FoMalloc">FoMalloc</link> fo_malloc,
<link linkend="FoRealloc">FoRealloc</link> fo_realloc,
<link linkend="FoFree">FoFree</link> fo_free);
<link linkend="gboolean">gboolean</link> <link linkend="fo-libfo-shutdown">fo_libfo_shutdown</link> (void);
<link linkend="FoLibfoContext">FoLibfoContext</link>* <link linkend="fo-libfo-context-new">fo_libfo_context_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="fo-libfo-format">fo_libfo_format</link> (const <link linkend="gchar">gchar</link> *xml,
const <link linkend="gchar">gchar</link> *xslt,
const <link linkend="gchar">gchar</link> *out,
<link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-fo-libfo-basic.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-fo-libfo-basic.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoLibfoBasicError" role="enum">
<title>enum FoLibfoBasicError</title>
<indexterm zone="FoLibfoBasicError"><primary>FoLibfoBasicError</primary></indexterm><programlisting>typedef enum
{
FO_LIBFO_BASIC_ERROR_FAILED, /* Generic error code */
FO_LIBFO_BASIC_ERROR_UNKNOWN_FORMAT,
FO_LIBFO_BASIC_ERROR_WARNING, /* Non-fatal error */
FO_LIBFO_BASIC_ERROR_LAST
} FoLibfoBasicError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FO-LIBFO-BASIC-ERROR:CAPS" role="macro">
<title>FO_LIBFO_BASIC_ERROR</title>
<indexterm zone="FO-LIBFO-BASIC-ERROR:CAPS"><primary>FO_LIBFO_BASIC_ERROR</primary></indexterm><programlisting>#define FO_LIBFO_BASIC_ERROR (fo_libfo_basic_error_quark ())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-libfo-basic-error-quark" role="function">
<title>fo_libfo_basic_error_quark ()</title>
<indexterm zone="fo-libfo-basic-error-quark"><primary>fo_libfo_basic_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_libfo_basic_error_quark (void);</programlisting>
<para>
Get the error quark for <link linkend="FoLibfo"><type>FoLibfo</type></link>.
</para>
<para>
If the quark does not yet exist, create it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Quark associated with <link linkend="FoLibfo"><type>FoLibfo</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoLibfoContext" role="struct">
<title>FoLibfoContext</title>
<indexterm zone="FoLibfoContext"><primary>FoLibfoContext</primary></indexterm><programlisting>typedef struct _FoLibfoContext FoLibfoContext;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-libfo-init" role="function">
<title>fo_libfo_init ()</title>
<indexterm zone="fo-libfo-init"><primary>fo_libfo_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_libfo_init (void);</programlisting>
<para>
Initialise the libfo formatter.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoMalloc" role="function">
<title>FoMalloc ()</title>
<indexterm zone="FoMalloc"><primary>FoMalloc</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> (*FoMalloc) (<link linkend="gsize">gsize</link> n_bytes);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>n_bytes</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoRealloc" role="function">
<title>FoRealloc ()</title>
<indexterm zone="FoRealloc"><primary>FoRealloc</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> (*FoRealloc) (<link linkend="gpointer">gpointer</link> mem,
<link linkend="gsize">gsize</link> n_bytes);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mem</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_bytes</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoFree" role="function">
<title>FoFree ()</title>
<indexterm zone="FoFree"><primary>FoFree</primary></indexterm><programlisting><link linkend="void">void</link> (*FoFree) (<link linkend="gpointer">gpointer</link> mem);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mem</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-libfo-init2" role="function">
<title>fo_libfo_init2 ()</title>
<indexterm zone="fo-libfo-init2"><primary>fo_libfo_init2</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_libfo_init2 (<link linkend="FoMalloc">FoMalloc</link> fo_malloc,
<link linkend="FoRealloc">FoRealloc</link> fo_realloc,
<link linkend="FoFree">FoFree</link> fo_free);</programlisting>
<para>
Initialise the libfo formatter and provide functions for
allocating, reallocating, and freeing memory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_malloc</parameter> :</term>
<listitem><simpara> Function that allocates memory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_realloc</parameter> :</term>
<listitem><simpara> Function that reallocates memory.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_free</parameter> :</term>
<listitem><simpara> Function that frees memory.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-libfo-shutdown" role="function">
<title>fo_libfo_shutdown ()</title>
<indexterm zone="fo-libfo-shutdown"><primary>fo_libfo_shutdown</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_libfo_shutdown (void);</programlisting>
<para>
Shutdown the libfo formatter.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-libfo-context-new" role="function">
<title>fo_libfo_context_new ()</title>
<indexterm zone="fo-libfo-context-new"><primary>fo_libfo_context_new</primary></indexterm><programlisting><link linkend="FoLibfoContext">FoLibfoContext</link>* fo_libfo_context_new (void);</programlisting>
<para>
Creates a new <link linkend="FoLibfoContext"><type>FoLibfoContext</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoLibfoContext"><type>FoLibfoContext</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-libfo-format" role="function">
<title>fo_libfo_format ()</title>
<indexterm zone="fo-libfo-format"><primary>fo_libfo_format</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_libfo_format (const <link linkend="gchar">gchar</link> *xml,
const <link linkend="gchar">gchar</link> *xslt,
const <link linkend="gchar">gchar</link> *out,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xml</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xslt</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
