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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/*
* Copyright 2014-2015 James Geboski <jgeboski@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _FACEBOOK_UTIL_H_
#define _FACEBOOK_UTIL_H_
/**
* SECTION:util
* @section_id: facebook-util
* @short_description: <filename>facebook-util.h</filename>
* @title: General Utilities
*
* The general utilities.
*/
#include <glib.h>
#include <glib-object.h>
/**
* FB_UTIL_ERROR:
*
* The #GQuark of the domain of utility errors.
*/
#define FB_UTIL_ERROR fb_util_error_quark()
typedef enum
{
FB_UTIL_DEBUG_LEVEL_MISC,
FB_UTIL_DEBUG_LEVEL_INFO,
FB_UTIL_DEBUG_LEVEL_WARN,
FB_UTIL_DEBUG_LEVEL_ERROR,
FB_UTIL_DEBUG_LEVEL_FATAL
} FbDebugLevel;
/**
* FbUtilError:
* @FB_UTIL_ERROR_GENERAL: General failure.
*
* The error codes for the #FB_UTIL_ERROR domain.
*/
typedef enum
{
FB_UTIL_ERROR_GENERAL
} FbUtilError;
/**
* fb_util_error_quark:
*
* Gets the #GQuark of the domain of utility errors.
*
* Returns: The #GQuark of the domain.
*/
GQuark
fb_util_error_quark(void);
/**
* fb_util_debug:
* @level: The #FbDebugLevel.
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a debugging message.
*/
void
fb_util_debug(FbDebugLevel level, const gchar *format, ...)
G_GNUC_PRINTF(2, 3);
/**
* fb_util_vdebug:
* @level: The #FbDebugLevel.
* @format: The format string literal.
* @ap: The #va_list.
*
* Logs a debugging message.
*/
void
fb_util_vdebug(FbDebugLevel level, const gchar *format, va_list ap);
/**
* fb_util_debug_misc:
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a debugging message with the level of
* #FB_UTIL_DEBUG_LEVEL_MISC.
*/
void
fb_util_debug_misc(const gchar *format, ...)
G_GNUC_PRINTF(1, 2);
/**
* fb_util_debug_info:
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a debugging message with the level of
* #FB_UTIL_DEBUG_LEVEL_INFO.
*/
void
fb_util_debug_info(const gchar *format, ...)
G_GNUC_PRINTF(1, 2);
/**
* fb_util_debug_warn:
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a debugging message with the level of
* #FB_UTIL_DEBUG_LEVEL_WARN.
*/
void
fb_util_debug_warn(const gchar *format, ...)
G_GNUC_PRINTF(1, 2);
/**
* fb_util_debug_error:
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a debugging message with the level of
* #FB_UTIL_DEBUG_LEVEL_ERROR.
*/
void
fb_util_debug_error(const gchar *format, ...)
G_GNUC_PRINTF(1, 2);
/**
* fb_util_debug_fatal:
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a debugging message with the level of
* #FB_UTIL_DEBUG_LEVEL_FATAL.
*/
void
fb_util_debug_fatal(const gchar *format, ...)
G_GNUC_PRINTF(1, 2);
/**
* fb_util_debug_hexdump:
* @level: The #FbDebugLevel.
* @bytes: The #GByteArray.
* @format: The format string literal.
* @...: The arguments for @format.
*
* Logs a hexdump of a #GByteArray.
*/
void
fb_util_debug_hexdump(FbDebugLevel level, const GByteArray *bytes,
const gchar *format, ...)
G_GNUC_PRINTF(3, 4);
/**
* fb_util_locale_str:
*
* Gets the locale string (ex: en_US) from the system. The returned
* string should be freed with #g_free() when no longer needed.
*
* Returns: The locale string.
*/
gchar *
fb_util_locale_str(void);
/**
* fb_util_randstr:
* @size: The size of the string.
*
* Gets a random alphanumeric string. The returned string should be
* freed with #g_free() when no longer needed.
*
* Returns: The random string.
*/
gchar *
fb_util_randstr(gsize size);
/**
* fb_util_str_is:
* @str: The string.
* @type: The #GAsciiType.
*
* Determines if @str abides to the #GAsciiType.
*
* Returns: #TRUE if the string abides to @type, otherwise #FALSE.
*/
gboolean
fb_util_str_is(const gchar *str, GAsciiType type);
/**
* fb_util_uuid:
*
* Gets a random UUID string. The returned string should be freed with
* #g_free() when no longer needed.
*
* Returns: The UUID string.
*/
gchar *
fb_util_uuid(void);
/**
* fb_util_zcompressed:
* @bytes: The #GByteArray.
*
* Determines if the #GByteArray is zlib compressed.
*
* Returns: #TRUE if the #GByteArray is compressed, otherwise #FALSE.
*/
gboolean
fb_util_zcompressed(const GByteArray *bytes);
/**
* fb_util_zcompress:
* @bytes: The #GByteArray.
*
* Compresses a #GByteArray with zlib. The returned #GByteArray should
* be freed with #g_byte_array_free() when no longer needed.
*
* Returns: The compressed #GByteArray.
*/
GByteArray *
fb_util_zcompress(const GByteArray *bytes);
/**
* fb_util_zuncompress:
* @bytes: The #GByteArray.
*
* Uncompresses a #GByteArray with zlib. The returned #GByteArray
* should be freed with #g_byte_array_free() when no longer needed.
*
* Returns: The uncompressed #GByteArray, or #NULL on error.
*/
GByteArray *
fb_util_zuncompress(const GByteArray *bytes);
#endif /* _FACEBOOK_UTIL_H_ */
|
