1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-e-util">
<refmeta>
<refentrytitle role="top_of_page">Utility Functions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Utility Functions</refname>
<refpurpose>Miscellaneous utility functions for evolution-data-server.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="tm">tm</link>;
<link linkend="int">int</link> <link linkend="e-util-mkdir-hier">e_util_mkdir_hier</link> (const <link linkend="char">char</link> *path,
<link linkend="mode-t">mode_t</link> mode);
<link linkend="gchar">gchar</link>* <link linkend="e-util-strstrcase">e_util_strstrcase</link> (const <link linkend="gchar">gchar</link> *haystack,
const <link linkend="gchar">gchar</link> *needle);
<link linkend="gchar">gchar</link>* <link linkend="e-util-unicode-get-utf8">e_util_unicode_get_utf8</link> (const <link linkend="gchar">gchar</link> *text,
<link linkend="gunichar">gunichar</link> *out);
const <link linkend="gchar">gchar</link>* <link linkend="e-util-utf8-strstrcase">e_util_utf8_strstrcase</link> (const <link linkend="gchar">gchar</link> *haystack,
const <link linkend="gchar">gchar</link> *needle);
const <link linkend="gchar">gchar</link>* <link linkend="e-util-utf8-strstrcasedecomp">e_util_utf8_strstrcasedecomp</link> (const <link linkend="gchar">gchar</link> *haystack,
const <link linkend="gchar">gchar</link> *needle);
<link linkend="size-t">size_t</link> <link linkend="e-utf8-strftime">e_utf8_strftime</link> (<link linkend="char">char</link> *s,
<link linkend="size-t">size_t</link> max,
const <link linkend="char">char</link> *fmt,
const <link linkend="struct-tm">struct tm</link> *tm);
<link linkend="size-t">size_t</link> <link linkend="e-strftime">e_strftime</link> (<link linkend="char">char</link> *s,
<link linkend="size-t">size_t</link> max,
const <link linkend="char">char</link> *fmt,
const <link linkend="struct-tm">struct tm</link> *tm);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="tm" role="struct"/>struct tm</title>
<indexterm><primary>tm</primary></indexterm><programlisting>struct tm;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-util-mkdir-hier" role="function"/>e_util_mkdir_hier ()</title>
<indexterm><primary>e_util_mkdir_hier</primary></indexterm><programlisting><link linkend="int">int</link> e_util_mkdir_hier (const <link linkend="char">char</link> *path,
<link linkend="mode-t">mode_t</link> mode);</programlisting>
<para>
Creates a directory hierarchy based on the string <parameter>path</parameter>. If <parameter>path</parameter>
is an absolute path, the directories will be created relative to
the root of the file system; otherwise, the directories will be
created relative to the current directory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> The directory hierarchy to create.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> The permissions to use for the directories.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success; -1 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-util-strstrcase" role="function"/>e_util_strstrcase ()</title>
<indexterm><primary>e_util_strstrcase</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* e_util_strstrcase (const <link linkend="gchar">gchar</link> *haystack,
const <link linkend="gchar">gchar</link> *needle);</programlisting>
<para>
Find the first instance of <parameter>needle</parameter> in <parameter>haystack</parameter>, ignoring case for
bytes that are ASCII characters.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>haystack</parameter> :</term>
<listitem><simpara> The string to search in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>needle</parameter> :</term>
<listitem><simpara> The string to search for.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the start of <parameter>needle</parameter> in <parameter>haystack</parameter>, or NULL if
<parameter>needle</parameter> is not found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-util-unicode-get-utf8" role="function"/>e_util_unicode_get_utf8 ()</title>
<indexterm><primary>e_util_unicode_get_utf8</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* e_util_unicode_get_utf8 (const <link linkend="gchar">gchar</link> *text,
<link linkend="gunichar">gunichar</link> *out);</programlisting>
<para>
Get a UTF-8 character from the beginning of <parameter>text</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> The string to take the UTF-8 character from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> The location to store the UTF-8 character in.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the next character in <parameter>text</parameter> after <parameter>out</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-util-utf8-strstrcase" role="function"/>e_util_utf8_strstrcase ()</title>
<indexterm><primary>e_util_utf8_strstrcase</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* e_util_utf8_strstrcase (const <link linkend="gchar">gchar</link> *haystack,
const <link linkend="gchar">gchar</link> *needle);</programlisting>
<para>
Find the first instance of <parameter>needle</parameter> in <parameter>haystack</parameter>, ignoring case. (No
proper case folding or decomposing is done.) Both <parameter>needle</parameter> and
<parameter>haystack</parameter> are UTF-8 strings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>haystack</parameter> :</term>
<listitem><simpara> The string to search in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>needle</parameter> :</term>
<listitem><simpara> The string to search for.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the first instance of <parameter>needle</parameter> in <parameter>haystack</parameter>, or
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if no match is found, or if either of the strings are
not legal UTF-8 strings.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-util-utf8-strstrcasedecomp" role="function"/>e_util_utf8_strstrcasedecomp ()</title>
<indexterm><primary>e_util_utf8_strstrcasedecomp</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* e_util_utf8_strstrcasedecomp (const <link linkend="gchar">gchar</link> *haystack,
const <link linkend="gchar">gchar</link> *needle);</programlisting>
<para>
Find the first instance of <parameter>needle</parameter> in <parameter>haystack</parameter>, where both <parameter>needle</parameter>
and <parameter>haystack</parameter> are UTF-8 strings. Both strings are stripped and
decomposed for comparison, and case is ignored.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>haystack</parameter> :</term>
<listitem><simpara> The string to search in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>needle</parameter> :</term>
<listitem><simpara> The string to search for.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the first instance of <parameter>needle</parameter> in <parameter>haystack</parameter>, or
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if either of the strings are not legal UTF-8 strings.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-utf8-strftime" role="function"/>e_utf8_strftime ()</title>
<indexterm><primary>e_utf8_strftime</primary></indexterm><programlisting><link linkend="size-t">size_t</link> e_utf8_strftime (<link linkend="char">char</link> *s,
<link linkend="size-t">size_t</link> max,
const <link linkend="char">char</link> *fmt,
const <link linkend="struct-tm">struct tm</link> *tm);</programlisting>
<para>
The UTF-8 equivalent of <link linkend="e-strftime"><function>e_strftime()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> The string array to store the result in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max</parameter> :</term>
<listitem><simpara> The size of array <parameter>s</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fmt</parameter> :</term>
<listitem><simpara> The formatting to use on <parameter>tm</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tm</parameter> :</term>
<listitem><simpara> The time value to format.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of characters placed in <parameter>s</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-strftime" role="function"/>e_strftime ()</title>
<indexterm><primary>e_strftime</primary></indexterm><programlisting><link linkend="size-t">size_t</link> e_strftime (<link linkend="char">char</link> *s,
<link linkend="size-t">size_t</link> max,
const <link linkend="char">char</link> *fmt,
const <link linkend="struct-tm">struct tm</link> *tm);</programlisting>
<para>
This function is a wrapper around the strftime(3) function, which
converts the &percnt;l and &percnt;k (12h and 24h) format variables if necessary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> The string array to store the result in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max</parameter> :</term>
<listitem><simpara> The size of array <parameter>s</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fmt</parameter> :</term>
<listitem><simpara> The formatting to use on <parameter>tm</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tm</parameter> :</term>
<listitem><simpara> The time value to format.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of characters placed in <parameter>s</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
