Mercurial > pidgin
annotate src/util.h @ 5042:20b4b0328a3e
[gaim-migrate @ 5388]
gtkpounce.c added
committer: Tailor Script <tailor@pidgin.im>
author | Herman Bloggs <hermanator12002@yahoo.com> |
---|---|
date | Sat, 05 Apr 2003 19:09:53 +0000 |
parents | 4691c5936c01 |
children | 381da05cb5ed |
rev | line source |
---|---|
4890 | 1 /** |
2 * @file util.h Utility Functions | |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4890
diff
changeset
|
3 * @ingroup core |
4890 | 4 * |
5 * gaim | |
6 * | |
7 * Copyright (C) 2002-2003, Christian Hammond <chipx86@gnupdate.org> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 * | |
23 * @todo Rename the functions so that they live somewhere in the gaim | |
24 * namespace. | |
25 */ | |
26 #ifndef _GAIM_UTIL_H_ | |
27 #define _GAIM_UTIL_H_ | |
28 | |
29 /** | |
30 * Normalizes a string, so that it is suitable for comparison. | |
31 * | |
32 * The returned string will point to a static buffer, so if the | |
33 * string is intended to be kept long-term, you <i>must</i> | |
34 * g_strdup() it. Also, calling normalize() twice in the same line | |
35 * will lead to problems. | |
36 * | |
37 * @param str The string to normalize. | |
38 * | |
39 * @return A pointer to the normalized version stored in a static buffer. | |
40 */ | |
41 char *normalize(const char *str); | |
42 | |
43 /** | |
44 * Converts a string to its base-64 equivalent. | |
45 * | |
46 * @param str The string to convert. | |
47 * | |
48 * @return The base-64 version of @a str. | |
49 * | |
50 * @see frombase64() | |
51 */ | |
52 char *tobase64(const char *str); | |
53 | |
54 /** | |
55 * Converts a string back from its base-64 equivalent. | |
56 * | |
57 * @param str The string to convert back. | |
58 * @param ret_str The returned, non-base-64 string. | |
59 * @param ret_len The returned string length. | |
60 * | |
61 * @see tobase64() | |
62 */ | |
63 void frombase64(const char *str, char **ret_str, int *ret_len); | |
64 | |
65 /** | |
66 * Converts a string to its base-16 equivalent. | |
67 * | |
68 * @param str The string to convert. | |
69 * @param len The length of the string. | |
70 * | |
71 * @return The base-16 string. | |
72 * | |
73 * @see frombase16() | |
74 */ | |
75 char *tobase16(const char *str, int len); | |
76 | |
77 /** | |
78 * Converts a string back from its base-16 equivalent. | |
79 * | |
80 * @param str The string to convert back. | |
81 * @param ret_str The returned, non-base-16 string. | |
82 * | |
83 * @return The length of the returned string. | |
84 * | |
85 * @see tobase16() | |
86 */ | |
87 int frombase16(const char *str, char **ret_str); | |
88 | |
89 /** | |
90 * Waits for all child processes to terminate. | |
91 */ | |
92 void clean_pid(void); | |
93 | |
94 /** | |
95 * Returns the current local time in hour:minute:second form. | |
96 * | |
97 * The returned string is stored in a static buffer, so the result | |
98 * should be g_strdup()'d if it's intended to be used for long. | |
99 * | |
100 * @return The current local time. | |
101 * | |
102 * @see full_date() | |
103 */ | |
104 char *date(void); | |
105 | |
106 /** | |
107 * Adds the necessary HTML code to turn URIs into HTML links in a string. | |
108 * | |
109 * The string passed must be able to store at least BUF_LEN * 2 bytes. | |
110 * | |
111 * @param str The string to linkify. | |
112 * | |
113 * @return The length of the new string. | |
114 */ | |
115 gint linkify_text(char *str); | |
116 | |
117 /** | |
118 * Converts seconds into a human-readable form. | |
119 * | |
120 * @param sec The seconds. | |
121 * | |
122 * @return A human-readable form, containing days, hours, minutes, and | |
123 * seconds. | |
124 */ | |
125 char *sec_to_text(guint sec); | |
126 | |
127 /** | |
128 * Finds a gaim_account with the specified name and protocol ID. | |
129 * | |
130 * @param name The name of the account. | |
131 * @param protocol The protocol type. | |
132 * | |
133 * @return The gaim_account, if found, or @c NULL otherwise. | |
134 */ | |
135 struct gaim_account *gaim_account_find(const char *name, | |
136 int protocol) G_GNUC_PURE; | |
137 | |
138 /** | |
139 * Returns the date and time in human-readable form. | |
140 * | |
141 * The returned string is stored in a static buffer, so the result | |
142 * should be g_strdup()'d if it's intended to be used for long. | |
143 * | |
144 * @return The date and time in human-readable form. | |
145 * | |
146 * @see date() | |
147 */ | |
148 char *full_date(void) G_GNUC_PURE; | |
149 | |
150 /** | |
151 * Looks for %n, %d, or %t in a string, and replaces them with the | |
152 * specified name, date, and time, respectively. | |
153 * | |
154 * The returned string is stored in a static buffer, so the result | |
155 * should be g_strdup()'d if it's intended to be used for long. | |
156 * | |
157 * @param str The string that may contain the special variables. | |
158 * @param name The sender name. | |
159 * | |
160 * @return A new string where the special variables are expanded. | |
161 */ | |
162 char *away_subs(const char *str, const char *name); | |
163 | |
164 /** | |
165 * Stylizes the specified text using HTML, according to the current | |
166 * font options. | |
167 * | |
168 * @param text The text to stylize. | |
169 * @param len The intended length of the new buffer. | |
170 * | |
171 * @return A newly allocated string of length @a len, containing the | |
172 * stylized version of @a text. | |
173 * | |
174 * @todo Move this to a UI-specific file. | |
175 */ | |
176 char *stylize(const gchar *text, int len); | |
177 | |
178 /** | |
179 * Shows the usage options for the gaim binary. | |
180 * | |
181 * @param mode @c 0 for full options, or @c 1 for a short summary. | |
182 * @param name The name of the binary. | |
183 * | |
184 * @todo Move this to the binary, when a library is formed. | |
185 */ | |
186 void show_usage(int mode, const char *name); | |
187 | |
188 /**` | |
189 * Returns the user's home directory. | |
190 * | |
191 * @return The user's home directory. | |
192 * | |
193 * @see gaim_user_dir() | |
194 */ | |
195 const gchar *gaim_home_dir(void); | |
196 | |
197 /** | |
198 * Returns the gaim settings directory in the user's home directory. | |
199 * | |
200 * @return The gaim settings directory. | |
201 * | |
202 * @see gaim_home_dir() | |
203 */ | |
204 char *gaim_user_dir(void); | |
205 | |
206 /** | |
207 * Copies a string and replaces all HTML linebreaks with newline characters. | |
208 * | |
209 * @param dest The destination string. | |
210 * @param src The source string. | |
211 * @param dest_len The destination string length. | |
212 * | |
213 * @see strncpy_withhtml() | |
214 * @see strdup_withhtml() | |
215 */ | |
216 void strncpy_nohtml(gchar *dest, const gchar *src, size_t dest_len); | |
217 | |
218 /** | |
219 * Copies a string and replaces all newline characters with HTML linebreaks. | |
220 * | |
221 * @param dest The destination string. | |
222 * @param src The source string. | |
223 * @param dest_len The destination string length. | |
224 * | |
225 * @see strncpy_nohtml() | |
226 * @see strdup_withhtml() | |
227 */ | |
228 void strncpy_withhtml(gchar *dest, const gchar *src, size_t dest_len); | |
229 | |
230 /** | |
231 * Duplicates a string and replaces all newline characters from the | |
232 * source string with HTML linebreaks. | |
233 * | |
234 * @param src The source string. | |
235 * | |
236 * @return The new string. | |
237 * | |
238 * @see strncpy_nohtml() | |
239 * @see strncpy_withhtml() | |
240 */ | |
241 gchar *strdup_withhtml(const gchar *src); | |
242 | |
243 /** | |
244 * Ensures that all linefeeds have a matching carriage return. | |
245 * | |
246 * @param str The source string. | |
247 * | |
248 * @return The string with carriage returns. | |
249 */ | |
250 char *add_cr(char *); | |
251 | |
252 /** | |
253 * Strips all linefeeds from a string. | |
254 * | |
255 * @param str The string to strip linefeeds from. | |
256 */ | |
257 void strip_linefeed(char *str); | |
258 | |
259 /** | |
260 * Builds a time_t from the supplied information. | |
261 * | |
262 * @param year The year. | |
263 * @param month The month. | |
264 * @param day The day. | |
265 * @param hour The hour. | |
266 * @param min The minute. | |
267 * @param sec The second. | |
268 * | |
269 * @return A time_t. | |
270 */ | |
271 time_t get_time(int year, int month, int day, | |
272 int hour, int min, int sec) G_GNUC_CONST; | |
273 | |
274 /** | |
275 * Creates a temporary file and returns a file pointer to it. | |
276 * | |
277 * This is like mkstemp(), but returns a file pointer and uses a | |
278 * pre-set template. It uses the semantics of tempnam() for the | |
279 * directory to use and allocates the space for the file path. | |
280 * | |
281 * The caller is responsible for closing the file and removing it when | |
282 * done, as well as freeing the space pointed to by @a path with | |
283 * g_free(). | |
284 * | |
285 * @param path The returned path to the temp file. | |
286 * | |
287 * @return A file pointer to the temporary file, or @c NULL on failure. | |
288 */ | |
289 FILE *gaim_mkstemp(gchar **path); | |
290 | |
291 /** | |
292 * Acts upon an aim: URI. | |
293 * | |
294 * @param uri The URI. | |
295 * | |
296 * @return The response based off the action in the URI. | |
297 */ | |
298 const char *handle_uri(char *uri); | |
299 | |
300 /* This guy does its best to convert a string to UTF-8 from an unknown | |
301 * encoding by checking the locale and trying some sane defaults ... | |
302 * if everything fails it returns NULL. */ | |
303 | |
304 /** | |
305 * Attempts to convert a string to UTF-8 from an unknown encoding. | |
306 * | |
307 * This function checks the locale and tries sane defaults. | |
308 * | |
309 * @param str The source string. | |
310 * | |
311 * @return The UTF-8 string, or @c NULL if it could not be converted. | |
312 */ | |
313 char *gaim_try_conv_to_utf8(const char *str); | |
314 | |
315 /** | |
316 * Returns the IP address from a socket file descriptor. | |
317 * | |
318 * @param fd The socket file descriptor. | |
319 * | |
320 * @return The IP address, or @c NULL on error. | |
321 */ | |
322 char *gaim_getip_from_fd(int fd); | |
323 | |
324 /** | |
325 * Compares two UTF-8 strings. | |
326 * | |
327 * @param a The first string. | |
328 * @param b The second string. | |
329 * | |
330 * @return -1 if @a is less than @a b. | |
331 * 0 if @a is equal to @a b. | |
332 * 1 if @a is greater than @a b. | |
333 */ | |
334 gint gaim_utf8_strcasecmp(const gchar *a, const gchar *b); | |
335 | |
336 #endif /* _GAIM_UTIL_H_ */ |