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
|
<refentry id="xmlroff-fo-utils">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-fo-utils.top_of_page">fo-utils</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>fo-utils</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-fo-utils.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="GETTEXT-PACKAGE:CAPS">GETTEXT_PACKAGE</link>
#define <link linkend="fo-propagate-and-return-if-error">fo_propagate_and_return_if_error</link> (src, dest)
#define <link linkend="fo-propagate-and-return-val-if-error">fo_propagate_and_return_val_if_error</link>(src, dest, val)
enum <link linkend="FoDebugFlag">FoDebugFlag</link>;
enum <link linkend="FoWarningFlag">FoWarningFlag</link>;
enum <link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link>;
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-fo-utils.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-fo-utils.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GETTEXT-PACKAGE:CAPS" role="macro">
<title>GETTEXT_PACKAGE</title>
<indexterm zone="GETTEXT-PACKAGE:CAPS"><primary>GETTEXT_PACKAGE</primary></indexterm><programlisting>#define GETTEXT_PACKAGE "libfo"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-propagate-and-return-if-error" role="macro">
<title>fo_propagate_and_return_if_error()</title>
<indexterm zone="fo-propagate-and-return-if-error"><primary>fo_propagate_and_return_if_error</primary></indexterm><programlisting>#define fo_propagate_and_return_if_error(src, dest)</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-propagate-and-return-val-if-error" role="macro">
<title>fo_propagate_and_return_val_if_error()</title>
<indexterm zone="fo-propagate-and-return-val-if-error"><primary>fo_propagate_and_return_val_if_error</primary></indexterm><programlisting>#define fo_propagate_and_return_val_if_error(src, dest, val)</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoDebugFlag" role="enum">
<title>enum FoDebugFlag</title>
<indexterm zone="FoDebugFlag"><primary>FoDebugFlag</primary></indexterm><programlisting>typedef enum {
FO_DEBUG_NONE = 0,
FO_DEBUG_RESULT = 1 << 0,
FO_DEBUG_FO = 1 << 1,
FO_DEBUG_AREA = 1 << 2,
FO_DEBUG_PANGO = 1 << 3,
FO_DEBUG_MAX = ((1 << 4) - 1)
} FoDebugFlag;
</programlisting>
<para>
Debugging flags.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="FO-DEBUG-NONE:CAPS" role="constant">
<term><literal>FO_DEBUG_NONE</literal></term>
<listitem><simpara> No debugging enabled
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-DEBUG-RESULT:CAPS" role="constant">
<term><literal>FO_DEBUG_RESULT</literal></term>
<listitem><simpara> Debug result tree
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-DEBUG-FO:CAPS" role="constant">
<term><literal>FO_DEBUG_FO</literal></term>
<listitem><simpara> Debug FO tree
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-DEBUG-AREA:CAPS" role="constant">
<term><literal>FO_DEBUG_AREA</literal></term>
<listitem><simpara> Debug area tree
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-DEBUG-PANGO:CAPS" role="constant">
<term><literal>FO_DEBUG_PANGO</literal></term>
<listitem><simpara> Debug Pango layouts
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-DEBUG-MAX:CAPS" role="constant">
<term><literal>FO_DEBUG_MAX</literal></term>
<listitem><simpara> Maximum possible value
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="FoWarningFlag" role="enum">
<title>enum FoWarningFlag</title>
<indexterm zone="FoWarningFlag"><primary>FoWarningFlag</primary></indexterm><programlisting>typedef enum {
FO_WARNING_NONE = 0,
FO_WARNING_FO = 1 << 0,
FO_WARNING_PROPERTY = 1 << 1,
FO_WARNING_UNSUPPORTED_PROPERTY = 1 << 2,
FO_WARNING_MAX = ((1 << 3) - 1)
} FoWarningFlag;
</programlisting>
<para>
Warning flags.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="FO-WARNING-NONE:CAPS" role="constant">
<term><literal>FO_WARNING_NONE</literal></term>
<listitem><simpara> No explicit control over warning message output
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-WARNING-FO:CAPS" role="constant">
<term><literal>FO_WARNING_FO</literal></term>
<listitem><simpara> Do not warn about FO errors
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-WARNING-PROPERTY:CAPS" role="constant">
<term><literal>FO_WARNING_PROPERTY</literal></term>
<listitem><simpara> Do not warn about property errors
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-WARNING-UNSUPPORTED-PROPERTY:CAPS" role="constant">
<term><literal>FO_WARNING_UNSUPPORTED_PROPERTY</literal></term>
<listitem><simpara> Do not warn about unsupported properties
</simpara></listitem>
</varlistentry>
<varlistentry id="FO-WARNING-MAX:CAPS" role="constant">
<term><literal>FO_WARNING_MAX</literal></term>
<listitem><simpara> Maximum possible value
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="FoEnumAreaDirection" role="enum">
<title>enum FoEnumAreaDirection</title>
<indexterm zone="FoEnumAreaDirection"><primary>FoEnumAreaDirection</primary></indexterm><programlisting>typedef enum {
FO_ENUM_AREA_DIRECTION_UNKNOWN,
FO_ENUM_AREA_DIRECTION_LR,
FO_ENUM_AREA_DIRECTION_RL,
FO_ENUM_AREA_DIRECTION_TB,
FO_ENUM_AREA_DIRECTION_BT
} FoEnumAreaDirection;
</programlisting>
<para>
</para></refsect2>
</refsect1>
</refentry>
|
