59560aeff017d0db8a007a84c45748e0b83c1b6e
[claws.git] / src / common / utils.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2003 Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __UTILS_H__
21 #define __UTILS_H__
22
23 #ifdef HAVE_CONFIG_H
24 #  include "config.h"
25 #endif
26
27 #include <glib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <sys/types.h>
33 #include <dirent.h>
34 #include <time.h>
35 #if HAVE_ALLOCA_H
36 #  include <alloca.h>
37 #endif
38 #if HAVE_WCHAR_H
39 #  include <wchar.h>
40 #endif
41
42 /* The AC_CHECK_SIZEOF() in configure fails for some machines.
43  * we provide some fallback values here */
44 #if !SIZEOF_UNSIGNED_SHORT
45   #undef SIZEOF_UNSIGNED_SHORT
46   #define SIZEOF_UNSIGNED_SHORT 2
47 #endif
48 #if !SIZEOF_UNSIGNED_INT
49   #undef SIZEOF_UNSIGNED_INT
50   #define SIZEOF_UNSIGNED_INT 4
51 #endif
52 #if !SIZEOF_UNSIGNED_LONG
53   #undef SIZEOF_UNSIGNED_LONG
54   #define SIZEOF_UNSIGNED_LONG 4
55 #endif
56
57 #ifndef HAVE_U32_TYPEDEF
58   #undef u32        /* maybe there is a macro with this name */
59   typedef guint32 u32;
60   #define HAVE_U32_TYPEDEF
61 #endif
62
63 #ifndef BIG_ENDIAN_HOST
64   #if (G_BYTE_ORDER == G_BIG_ENDIAN)
65     #define BIG_ENDIAN_HOST 1
66   #endif
67 #endif
68
69 #define CHDIR_RETURN_IF_FAIL(dir) \
70 { \
71         if (change_dir(dir) < 0) return; \
72 }
73
74 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
75 { \
76         if (change_dir(dir) < 0) return val; \
77 }
78
79 #define Xalloca(ptr, size, iffail) \
80 { \
81         if ((ptr = alloca(size)) == NULL) { \
82                 g_warning("can't allocate memory\n"); \
83                 iffail; \
84         } \
85 }
86
87 #define Xstrdup_a(ptr, str, iffail) \
88 { \
89         gchar *__tmp; \
90  \
91         if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
92                 g_warning("can't allocate memory\n"); \
93                 iffail; \
94         } else \
95                 strcpy(__tmp, str); \
96  \
97         ptr = __tmp; \
98 }
99
100 #define Xstrndup_a(ptr, str, len, iffail) \
101 { \
102         gchar *__tmp; \
103  \
104         if ((__tmp = alloca(len + 1)) == NULL) { \
105                 g_warning("can't allocate memory\n"); \
106                 iffail; \
107         } else { \
108                 strncpy(__tmp, str, len); \
109                 __tmp[len] = '\0'; \
110         } \
111  \
112         ptr = __tmp; \
113 }
114
115 #define Xstrcat_a(ptr, str1, str2, iffail) \
116 { \
117         gchar *__tmp; \
118         gint len1, len2; \
119  \
120         len1 = strlen(str1); \
121         len2 = strlen(str2); \
122         if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
123                 g_warning("can't allocate memory\n"); \
124                 iffail; \
125         } else { \
126                 memcpy(__tmp, str1, len1); \
127                 memcpy(__tmp + len1, str2, len2 + 1); \
128         } \
129  \
130         ptr = __tmp; \
131 }
132
133 #define AUTORELEASE_STR(str, iffail) \
134 { \
135         gchar *__str; \
136         Xstrdup_a(__str, str, iffail); \
137         g_free(str); \
138         str = __str; \
139 }
140
141 #define FILE_OP_ERROR(file, func) \
142 { \
143         fprintf(stderr, "%s: ", file); \
144         perror(func); \
145 }
146
147 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
148
149 #ifdef __cplusplus
150 extern "C" {
151 #endif
152
153 typedef gpointer (*GNodeMapFunc)        (gpointer nodedata, gpointer data);
154
155 /* debug functions */
156 void debug_set_mode             (gboolean mode);
157 gboolean debug_get_mode         (void);
158 #define debug_print \
159         debug_print_real(__FILE__ ":%d:", __LINE__), \
160         debug_print_real
161
162 /* for macro expansion */
163 #define Str(x)  #x
164 #define Xstr(x) Str(x)
165
166 void list_free_strings          (GList          *list);
167 void slist_free_strings         (GSList         *list);
168
169 void hash_free_strings          (GHashTable     *table);
170 void hash_free_value_mem        (GHashTable     *table);
171
172 gint str_case_equal             (gconstpointer   v,
173                                  gconstpointer   v2);
174 guint str_case_hash             (gconstpointer   key);
175
176 void ptr_array_free_strings     (GPtrArray      *array);
177
178 /* number-string conversion */
179 gint to_number                  (const gchar *nstr);
180 gchar *itos_buf                 (gchar       *nstr,
181                                  gint         n);
182 gchar *itos                     (gint         n);
183 gchar *to_human_readable        (off_t        size);
184
185 /* alternative string functions */
186 gint strcmp2            (const gchar    *s1,
187                          const gchar    *s2);
188 gchar *strstr2          (const gchar    *s1,
189                          const gchar    *s2);
190 gint path_cmp           (const gchar    *s1,
191                          const gchar    *s2);
192 gchar *strretchomp      (gchar          *str);
193 gchar *strtailchomp     (gchar          *str,
194                          gchar           tail_char);
195 gchar *strcrchomp       (gchar          *str);
196 gchar *strcasestr       (const gchar    *haystack,
197                          const gchar    *needle);
198 gchar *strncpy2         (gchar          *dest,
199                          const gchar    *src,
200                          size_t          n);
201
202 /* wide-character functions */
203 #if !HAVE_ISWALNUM
204 int iswalnum            (wint_t wc);
205 #endif
206 #if !HAVE_ISWSPACE
207 int iswspace            (wint_t wc);
208 #endif
209 #if !HAVE_TOWLOWER
210 wint_t towlower         (wint_t wc);
211 #endif
212
213 #if !HAVE_WCSLEN
214 size_t wcslen           (const wchar_t *s);
215 #endif
216 #if !HAVE_WCSCPY
217 wchar_t *wcscpy         (wchar_t       *dest,
218                          const wchar_t *src);
219 #endif
220 #if !HAVE_WCSNCPY
221 wchar_t *wcsncpy        (wchar_t       *dest,
222                          const wchar_t *src,
223                          size_t         n);
224 #endif
225
226 wchar_t *wcsdup                 (const wchar_t *s);
227 wchar_t *wcsndup                (const wchar_t *s,
228                                  size_t         n);
229 wchar_t *strdup_mbstowcs        (const gchar   *s);
230 gchar *strdup_wcstombs          (const wchar_t *s);
231 gint wcsncasecmp                (const wchar_t *s1,
232                                  const wchar_t *s2,
233                                  size_t         n);
234 wchar_t *wcscasestr             (const wchar_t *haystack,
235                                  const wchar_t *needle);
236 gint get_mbs_len                (const gchar    *s);
237
238 gboolean is_next_nonascii       (const guchar *s);
239 gint get_next_word_len          (const guchar *s);
240
241 /* functions for string parsing */
242 gint subject_compare                    (const gchar    *s1,
243                                          const gchar    *s2);
244 gint subject_compare_for_sort           (const gchar    *s1,
245                                          const gchar    *s2);
246 void trim_subject_for_compare           (gchar          *str);
247 void trim_subject_for_sort              (gchar          *str);
248 void trim_subject                       (gchar          *str);
249 void eliminate_parenthesis              (gchar          *str,
250                                          gchar           op,
251                                          gchar           cl);
252 void extract_parenthesis                (gchar          *str,
253                                          gchar           op,
254                                          gchar           cl);
255
256 void extract_parenthesis_with_skip_quote        (gchar          *str,
257                                                  gchar           quote_chr,
258                                                  gchar           op,
259                                                  gchar           cl);
260
261 void eliminate_quote                    (gchar          *str,
262                                          gchar           quote_chr);
263 void extract_quote                      (gchar          *str,
264                                          gchar           quote_chr);
265 void eliminate_address_comment          (gchar          *str);
266 gchar *strchr_with_skip_quote           (const gchar    *str,
267                                          gint            quote_chr,
268                                          gint            c);
269 gchar *strrchr_with_skip_quote          (const gchar    *str,
270                                          gint            quote_chr,
271                                          gint            c);
272 void extract_address                    (gchar          *str);
273 void extract_list_id_str                (gchar          *str);
274
275 GSList *slist_concat_unique             (GSList         *first,
276                                          GSList         *second);
277 GSList *address_list_append             (GSList         *addr_list,
278                                          const gchar    *str);
279 GSList *address_list_append_with_comments(GSList        *addr_list,
280                                          const gchar    *str);
281 GSList *references_list_append          (GSList         *msgid_list,
282                                          const gchar    *str);
283 GSList *newsgroup_list_append           (GSList         *group_list,
284                                          const gchar    *str);
285
286 GList *add_history                      (GList          *list,
287                                          const gchar    *str);
288
289 void remove_return                      (gchar          *str);
290 void remove_space                       (gchar          *str);
291 void unfold_line                        (gchar          *str);
292 void subst_char                         (gchar          *str,
293                                          gchar           orig,
294                                          gchar           subst);
295 void subst_chars                        (gchar          *str,
296                                          gchar          *orig,
297                                          gchar           subst);
298 void subst_for_filename                 (gchar          *str);
299 void subst_for_shellsafe_filename       (gchar          *str);
300 gboolean is_header_line                 (const gchar    *str);
301 gboolean is_ascii_str                   (const guchar   *str);
302 gint get_quote_level                    (const gchar    *str,
303                                          const gchar    *quote_chars);
304 gchar *strstr_with_skip_quote           (const gchar    *haystack,
305                                          const gchar    *needle);
306 gchar *strchr_parenthesis_close         (const gchar    *str,
307                                          gchar           op,
308                                          gchar           cl);
309
310 gchar **strsplit_parenthesis            (const gchar    *str,
311                                          gchar           op,
312                                          gchar           cl,
313                                          gint            max_tokens);
314 gchar **strsplit_with_quote             (const gchar    *str,
315                                          const gchar    *delim,
316                                          gint            max_tokens);
317
318 gchar *get_abbrev_newsgroup_name        (const gchar    *group,
319                                          gint            len);
320 gchar *trim_string                      (const gchar    *str,
321                                          gint            len);
322
323 GList *uri_list_extract_filenames       (const gchar    *uri_list);
324 gboolean is_uri_string                  (const gchar    *str);
325 gchar *get_uri_path                     (const gchar    *uri);
326 void decode_uri                         (gchar          *decoded_uri,
327                                          const gchar    *encoded_uri);
328 gint scan_mailto_url                    (const gchar    *mailto,
329                                          gchar         **to,
330                                          gchar         **cc,
331                                          gchar         **bcc,
332                                          gchar         **subject,
333                                          gchar         **body);
334
335 /* return static strings */
336 const gchar *get_home_dir               (void);
337 const gchar *get_rc_dir                 (void);
338 const gchar *get_news_cache_dir         (void);
339 const gchar *get_imap_cache_dir         (void);
340 const gchar *get_mbox_cache_dir         (void);
341 const gchar *get_mime_tmp_dir           (void);
342 const gchar *get_template_dir           (void);
343 const gchar *get_header_cache_dir       (void);
344 const gchar *get_tmp_dir                (void);
345 gchar *get_tmp_file                     (void);
346 const gchar *get_domain_name            (void);
347
348 /* file / directory handling */
349 off_t get_file_size             (const gchar    *file);
350 off_t get_file_size_as_crlf     (const gchar    *file);
351 off_t get_left_file_size        (FILE           *fp);
352
353 gboolean file_exist             (const gchar    *file,
354                                  gboolean        allow_fifo);
355 gboolean is_dir_exist           (const gchar    *dir);
356 gboolean is_file_entry_exist    (const gchar    *file);
357 gboolean dirent_is_regular_file (struct dirent  *d);
358 gboolean dirent_is_directory    (struct dirent  *d);
359
360 #define is_file_exist(file)             file_exist(file, FALSE)
361 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
362
363 gint change_dir                 (const gchar    *dir);
364 gint make_dir                   (const gchar    *dir);
365 gint make_dir_hier              (const gchar    *dir);
366 gint remove_all_files           (const gchar    *dir);
367 gint remove_numbered_files      (const gchar    *dir,
368                                  guint           first,
369                                  guint           last);
370 gint remove_numbered_files_not_in_list(const gchar *dir,
371                                        GSList *numberlist);
372 gint remove_all_numbered_files  (const gchar    *dir);
373 gint remove_expired_files       (const gchar    *dir,
374                                  guint           hours);
375 gint remove_dir_recursive       (const gchar    *dir);
376 gint append_file                (const gchar    *src,
377                                  const gchar    *dest,
378                                  gboolean        keep_backup);
379 gint copy_file                  (const gchar    *src,
380                                  const gchar    *dest,
381                                  gboolean        keep_backup);
382 gint move_file                  (const gchar    *src,
383                                  const gchar    *dest,
384                                  gboolean        overwrite);
385 gint copy_file_part_to_fp       (FILE           *fp,
386                                  off_t           offset,
387                                  size_t          length,
388                                  FILE           *dest_fp);
389 gint copy_file_part             (FILE           *fp,
390                                  off_t           offset,
391                                  size_t          length,
392                                  const gchar    *dest);
393
394 gchar *canonicalize_str         (const gchar    *str);
395 gint canonicalize_file          (const gchar    *src,
396                                  const gchar    *dest);
397 gint canonicalize_file_replace  (const gchar    *file);
398 gint uncanonicalize_file        (const gchar    *src,
399                                  const gchar    *dest);
400 gint uncanonicalize_file_replace(const gchar    *file);
401
402 gchar *normalize_newlines       (const gchar    *str);
403
404 gchar *get_outgoing_rfc2822_str (FILE           *fp);
405
406 gint change_file_mode_rw        (FILE           *fp,
407                                  const gchar    *file);
408 FILE *my_tmpfile                (void);
409 FILE *get_tmpfile_in_dir        (const gchar    *dir,
410                                  gchar         **filename);
411 FILE *str_open_as_stream        (const gchar    *str);
412 gint str_write_to_file          (const gchar    *str,
413                                  const gchar    *file);
414 gchar *file_read_to_str         (const gchar    *file);
415 gchar *file_read_stream_to_str  (FILE           *fp);
416
417 /* process execution */
418 gint execute_async              (gchar *const    argv[]);
419 gint execute_sync               (gchar *const    argv[]);
420 gint execute_command_line       (const gchar    *cmdline,
421                                  gboolean        async);
422 gchar *get_command_output       (const gchar    *cmdline);
423
424 /* open URI with external browser */
425 gint open_uri(const gchar *uri, const gchar *cmdline);
426
427 /* time functions */
428 time_t remote_tzoffset_sec      (const gchar    *zone);
429 time_t tzoffset_sec             (time_t         *now);
430 gchar *tzoffset                 (time_t         *now);
431 void get_rfc822_date            (gchar          *buf,
432                                  gint            len);
433
434 /* debugging */
435 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
436
437 /* subject threading */
438 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
439 void subject_table_insert(GHashTable *subject_table, gchar * subject,
440                           void * data);
441 void subject_table_remove(GHashTable *subject_table, gchar * subject);
442 gint subject_get_prefix_length (const gchar *subject);
443
444 /* quoting recognition */
445 const gchar * line_has_quote_char       (const gchar *str,
446                                          const gchar *quote_chars);
447 const gchar * line_has_quote_char_last  (const gchar *str,
448                                          const gchar *quote_chars);
449
450 guint g_stricase_hash   (gconstpointer gptr);
451 gint g_stricase_equal   (gconstpointer gptr1, gconstpointer gptr2);
452 gint g_int_compare      (gconstpointer a, gconstpointer b);
453
454 gchar *generate_msgid           (const gchar *address, gchar *buf, gint len);
455 gchar *generate_mime_boundary   (const gchar *prefix);
456
457 gint quote_cmd_argument(gchar * result, guint size,
458                         const gchar * path);
459 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
460
461 #ifdef __cplusplus
462 }
463 #endif
464
465 #endif /* __UTILS_H__ */