917f09e047c7c1ed43cacbca8580d49b2f01cb88
[claws.git] / src / common / utils.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws team
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 <glib-object.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include <unistd.h>
33 #include <sys/types.h>
34 #include <dirent.h>
35 #include <time.h>
36 #if HAVE_ALLOCA_H
37 #  include <alloca.h>
38 #endif
39 #if HAVE_WCHAR_H
40 #  include <wchar.h>
41 #endif
42
43 /* Wrappers for C library function that take pathname arguments. */
44 #if GLIB_CHECK_VERSION(2, 6, 0)
45 #  include <glib/gstdio.h>
46 #else
47
48 #define g_open          open
49 #define g_rename        rename
50 #define g_mkdir         mkdir
51 #define g_stat          stat
52 #define g_lstat         lstat
53 #define g_unlink        unlink
54 #define g_remove        remove
55 #define g_rmdir         rmdir
56 #define g_fopen         fopen
57 #define g_freopen       freopen
58
59 #endif /* GLIB_CHECK_VERSION */
60
61 #if !GLIB_CHECK_VERSION(2, 7, 0)
62
63 #ifdef G_OS_UNIX
64 #define g_chdir         chdir
65 #define g_chmod         chmod
66 #else
67 gint g_chdir    (const gchar    *path);
68 gint g_chmod    (const gchar    *path,
69                  gint            mode);
70 #endif /* G_OS_UNIX */
71
72 #endif /* !GLIB_CHECK_VERSION */
73
74 /* The AC_CHECK_SIZEOF() in configure fails for some machines.
75  * we provide some fallback values here */
76 #if !SIZEOF_UNSIGNED_SHORT
77   #undef SIZEOF_UNSIGNED_SHORT
78   #define SIZEOF_UNSIGNED_SHORT 2
79 #endif
80 #if !SIZEOF_UNSIGNED_INT
81   #undef SIZEOF_UNSIGNED_INT
82   #define SIZEOF_UNSIGNED_INT 4
83 #endif
84 #if !SIZEOF_UNSIGNED_LONG
85   #undef SIZEOF_UNSIGNED_LONG
86   #define SIZEOF_UNSIGNED_LONG 4
87 #endif
88
89 #ifndef HAVE_U32_TYPEDEF
90   #undef u32        /* maybe there is a macro with this name */
91   typedef guint32 u32;
92   #define HAVE_U32_TYPEDEF
93 #endif
94
95 #ifndef BIG_ENDIAN_HOST
96   #if (G_BYTE_ORDER == G_BIG_ENDIAN)
97     #define BIG_ENDIAN_HOST 1
98   #endif
99 #endif
100
101 #define CHDIR_RETURN_IF_FAIL(dir) \
102 { \
103         if (change_dir(dir) < 0) return; \
104 }
105
106 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
107 { \
108         if (change_dir(dir) < 0) return val; \
109 }
110
111 #define Xalloca(ptr, size, iffail) \
112 { \
113         if ((ptr = alloca(size)) == NULL) { \
114                 g_warning("can't allocate memory\n"); \
115                 iffail; \
116         } \
117 }
118
119 #define Xstrdup_a(ptr, str, iffail) \
120 { \
121         gchar *__tmp; \
122  \
123         if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
124                 g_warning("can't allocate memory\n"); \
125                 iffail; \
126         } else \
127                 strcpy(__tmp, str); \
128  \
129         ptr = __tmp; \
130 }
131
132 #define Xstrndup_a(ptr, str, len, iffail) \
133 { \
134         gchar *__tmp; \
135  \
136         if ((__tmp = alloca(len + 1)) == NULL) { \
137                 g_warning("can't allocate memory\n"); \
138                 iffail; \
139         } else { \
140                 strncpy(__tmp, str, len); \
141                 __tmp[len] = '\0'; \
142         } \
143  \
144         ptr = __tmp; \
145 }
146
147 #define Xstrcat_a(ptr, str1, str2, iffail) \
148 { \
149         gchar *__tmp; \
150         gint len1, len2; \
151  \
152         len1 = strlen(str1); \
153         len2 = strlen(str2); \
154         if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
155                 g_warning("can't allocate memory\n"); \
156                 iffail; \
157         } else { \
158                 memcpy(__tmp, str1, len1); \
159                 memcpy(__tmp + len1, str2, len2 + 1); \
160         } \
161  \
162         ptr = __tmp; \
163 }
164
165 #define AUTORELEASE_STR(str, iffail) \
166 { \
167         gchar *__str; \
168         Xstrdup_a(__str, str, iffail); \
169         g_free(str); \
170         str = __str; \
171 }
172
173 #define FILE_OP_ERROR(file, func) \
174 { \
175         fprintf(stderr, "%s: ", file); \
176         fflush(stderr); \
177         perror(func); \
178 }
179
180 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
181
182 #ifdef __cplusplus
183 extern "C" {
184 #endif
185
186 typedef gpointer (*GNodeMapFunc)        (gpointer nodedata, gpointer data);
187
188 /* debug functions */
189 void debug_set_mode             (gboolean mode);
190 gboolean debug_get_mode         (void);
191
192 #ifndef __CYGWIN__
193 #define debug_print \
194         debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
195         debug_print_real
196 #else
197   /* FIXME: cygwin: why debug_srcname couldn't be resolved in library? */
198 #define debug_print \
199         debug_print_real("%s:%d:", __FILE__, __LINE__), \
200         debug_print_real
201 #endif
202
203 /* for macro expansion */
204 #define Str(x)  #x
205 #define Xstr(x) Str(x)
206
207 void list_free_strings          (GList          *list);
208 void slist_free_strings         (GSList         *list);
209
210 void hash_free_strings          (GHashTable     *table);
211 void hash_free_value_mem        (GHashTable     *table);
212
213 gint str_case_equal             (gconstpointer   v,
214                                  gconstpointer   v2);
215 guint str_case_hash             (gconstpointer   key);
216
217 void ptr_array_free_strings     (GPtrArray      *array);
218
219 typedef gboolean (*StrFindFunc) (const gchar    *haystack,
220                                  const gchar    *needle);
221
222 gboolean str_find               (const gchar    *haystack,
223                                  const gchar    *needle);
224 gboolean str_case_find          (const gchar    *haystack,
225                                  const gchar    *needle);
226 gboolean str_find_equal         (const gchar    *haystack,
227                                  const gchar    *needle);
228 gboolean str_case_find_equal    (const gchar    *haystack,
229                                  const gchar    *needle);
230
231 /* number-string conversion */
232 gint to_number                  (const gchar *nstr);
233 gchar *itos_buf                 (gchar       *nstr,
234                                  gint         n);
235 gchar *itos                     (gint         n);
236 gchar *to_human_readable        (off_t        size);
237
238 /* alternative string functions */
239 gint strcmp2            (const gchar    *s1,
240                          const gchar    *s2);
241 gchar *strstr2          (const gchar    *s1,
242                          const gchar    *s2);
243 gint path_cmp           (const gchar    *s1,
244                          const gchar    *s2);
245 gchar *strretchomp      (gchar          *str);
246 gchar *strtailchomp     (gchar          *str,
247                          gchar           tail_char);
248 gchar *strcrchomp       (gchar          *str);
249 void file_strip_crs     (const gchar    *file);
250 gchar *strcasestr       (const gchar    *haystack,
251                          const gchar    *needle);
252 gpointer my_memmem      (gconstpointer   haystack,
253                          size_t          haystacklen,
254                          gconstpointer   needle,
255                          size_t          needlelen);
256 gchar *strncpy2         (gchar          *dest,
257                          const gchar    *src,
258                          size_t          n);
259
260 /* wide-character functions */
261 #if !HAVE_ISWALNUM
262 int iswalnum            (wint_t wc);
263 #endif
264 #if !HAVE_ISWSPACE
265 int iswspace            (wint_t wc);
266 #endif
267 #if !HAVE_TOWLOWER
268 wint_t towlower         (wint_t wc);
269 #endif
270
271 #if !HAVE_WCSLEN
272 size_t wcslen           (const wchar_t *s);
273 #endif
274 #if !HAVE_WCSCPY
275 wchar_t *wcscpy         (wchar_t       *dest,
276                          const wchar_t *src);
277 #endif
278 #if !HAVE_WCSNCPY
279 wchar_t *wcsncpy        (wchar_t       *dest,
280                          const wchar_t *src,
281                          size_t         n);
282 #endif
283
284 wchar_t *wcsdup                 (const wchar_t *s);
285 wchar_t *wcsndup                (const wchar_t *s,
286                                  size_t         n);
287 wchar_t *strdup_mbstowcs        (const gchar   *s);
288 gchar *strdup_wcstombs          (const wchar_t *s);
289 gint wcsncasecmp                (const wchar_t *s1,
290                                  const wchar_t *s2,
291                                  size_t         n);
292 wchar_t *wcscasestr             (const wchar_t *haystack,
293                                  const wchar_t *needle);
294 gint get_mbs_len                (const gchar    *s);
295
296 gboolean is_next_nonascii       (const gchar *s);
297 gint get_next_word_len          (const gchar *s);
298
299 /* functions for string parsing */
300 gint subject_compare                    (const gchar    *s1,
301                                          const gchar    *s2);
302 gint subject_compare_for_sort           (const gchar    *s1,
303                                          const gchar    *s2);
304 void trim_subject_for_compare           (gchar          *str);
305 void trim_subject_for_sort              (gchar          *str);
306 void trim_subject                       (gchar          *str);
307 void eliminate_parenthesis              (gchar          *str,
308                                          gchar           op,
309                                          gchar           cl);
310 void extract_parenthesis                (gchar          *str,
311                                          gchar           op,
312                                          gchar           cl);
313
314 void extract_parenthesis_with_skip_quote        (gchar          *str,
315                                                  gchar           quote_chr,
316                                                  gchar           op,
317                                                  gchar           cl);
318
319 void eliminate_quote                    (gchar          *str,
320                                          gchar           quote_chr);
321 void extract_quote                      (gchar          *str,
322                                          gchar           quote_chr);
323 void eliminate_address_comment          (gchar          *str);
324 gchar *strchr_with_skip_quote           (const gchar    *str,
325                                          gint            quote_chr,
326                                          gint            c);
327 gchar *strrchr_with_skip_quote          (const gchar    *str,
328                                          gint            quote_chr,
329                                          gint            c);
330 void extract_address                    (gchar          *str);
331 void extract_list_id_str                (gchar          *str);
332
333 GSList *slist_concat_unique             (GSList         *first,
334                                          GSList         *second);
335 GSList *address_list_append             (GSList         *addr_list,
336                                          const gchar    *str);
337 GSList *address_list_append_with_comments(GSList        *addr_list,
338                                          const gchar    *str);
339 GSList *references_list_prepend         (GSList         *msgid_list,
340                                          const gchar    *str);
341 GSList *references_list_append          (GSList         *msgid_list,
342                                          const gchar    *str);
343 GSList *newsgroup_list_append           (GSList         *group_list,
344                                          const gchar    *str);
345
346 GList *add_history                      (GList          *list,
347                                          const gchar    *str);
348
349 void remove_return                      (gchar          *str);
350 void remove_space                       (gchar          *str);
351 void unfold_line                        (gchar          *str);
352 void subst_char                         (gchar          *str,
353                                          gchar           orig,
354                                          gchar           subst);
355 void subst_chars                        (gchar          *str,
356                                          gchar          *orig,
357                                          gchar           subst);
358 void subst_for_filename                 (gchar          *str);
359 void subst_for_shellsafe_filename       (gchar          *str);
360 gboolean is_header_line                 (const gchar    *str);
361 gboolean is_ascii_str                   (const gchar    *str);
362 gint get_quote_level                    (const gchar    *str,
363                                          const gchar    *quote_chars);
364 gint check_line_length                  (const gchar    *str,
365                                          gint            max_chars,
366                                          gint           *line);
367
368 gchar *strstr_with_skip_quote           (const gchar    *haystack,
369                                          const gchar    *needle);
370 gchar *strchr_parenthesis_close         (const gchar    *str,
371                                          gchar           op,
372                                          gchar           cl);
373
374 gchar **strsplit_parenthesis            (const gchar    *str,
375                                          gchar           op,
376                                          gchar           cl,
377                                          gint            max_tokens);
378 gchar **strsplit_with_quote             (const gchar    *str,
379                                          const gchar    *delim,
380                                          gint            max_tokens);
381
382 gchar *get_abbrev_newsgroup_name        (const gchar    *group,
383                                          gint            len);
384 gchar *trim_string                      (const gchar    *str,
385                                          gint            len);
386
387 GList *uri_list_extract_filenames       (const gchar    *uri_list);
388 gboolean is_uri_string                  (const gchar    *str);
389 gchar *get_uri_path                     (const gchar    *uri);
390 gint get_uri_len                        (const gchar    *str);
391 void decode_uri                         (gchar          *decoded_uri,
392                                          const gchar    *encoded_uri);
393 gint scan_mailto_url                    (const gchar    *mailto,
394                                          gchar         **to,
395                                          gchar         **cc,
396                                          gchar         **bcc,
397                                          gchar         **subject,
398                                          gchar         **body);
399
400 /* return static strings */
401 const gchar *get_home_dir               (void);
402 const gchar *get_rc_dir                 (void);
403 const gchar *get_mail_base_dir          (void);
404 const gchar *get_news_cache_dir         (void);
405 const gchar *get_imap_cache_dir         (void);
406 const gchar *get_mbox_cache_dir         (void);
407 const gchar *get_mime_tmp_dir           (void);
408 const gchar *get_template_dir           (void);
409 const gchar *get_header_cache_dir       (void);
410 const gchar *get_plugin_dir             (void);
411 const gchar *get_tmp_dir                (void);
412 const gchar *get_locale_dir             (void);
413 gchar *get_tmp_file                     (void);
414 const gchar *get_domain_name            (void);
415
416 /* file / directory handling */
417 off_t get_file_size             (const gchar    *file);
418 off_t get_file_size_as_crlf     (const gchar    *file);
419 off_t get_left_file_size        (FILE           *fp);
420
421 gboolean file_exist             (const gchar    *file,
422                                  gboolean        allow_fifo);
423 gboolean is_relative_filename   (const gchar *file);
424 gboolean is_dir_exist           (const gchar    *dir);
425 gboolean is_file_entry_exist    (const gchar    *file);
426 gboolean dirent_is_regular_file (struct dirent  *d);
427 gboolean dirent_is_directory    (struct dirent  *d);
428
429 #define is_file_exist(file)             file_exist(file, FALSE)
430 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
431
432 gint change_dir                 (const gchar    *dir);
433 gint make_dir                   (const gchar    *dir);
434 gint make_dir_hier              (const gchar    *dir);
435 gint remove_all_files           (const gchar    *dir);
436 gint remove_numbered_files      (const gchar    *dir,
437                                  guint           first,
438                                  guint           last);
439 gint remove_numbered_files_not_in_list(const gchar *dir,
440                                        GSList *numberlist);
441 gint remove_all_numbered_files  (const gchar    *dir);
442 gint remove_expired_files       (const gchar    *dir,
443                                  guint           hours);
444 gint remove_dir_recursive       (const gchar    *dir);
445 gint append_file                (const gchar    *src,
446                                  const gchar    *dest,
447                                  gboolean        keep_backup);
448 gint rename_force               (const gchar    *oldpath,
449                                  const gchar    *newpath);
450 gint copy_file                  (const gchar    *src,
451                                  const gchar    *dest,
452                                  gboolean        keep_backup);
453 gint move_file                  (const gchar    *src,
454                                  const gchar    *dest,
455                                  gboolean        overwrite);
456 gint copy_dir                   (const gchar    *src,
457                                  const gchar    *dest);
458 gint copy_file_part_to_fp       (FILE           *fp,
459                                  off_t           offset,
460                                  size_t          length,
461                                  FILE           *dest_fp);
462 gint copy_file_part             (FILE           *fp,
463                                  off_t           offset,
464                                  size_t          length,
465                                  const gchar    *dest);
466
467 gchar *canonicalize_str         (const gchar    *str);
468 gint canonicalize_file          (const gchar    *src,
469                                  const gchar    *dest);
470 gint canonicalize_file_replace  (const gchar    *file);
471 gint uncanonicalize_file        (const gchar    *src,
472                                  const gchar    *dest);
473 gint uncanonicalize_file_replace(const gchar    *file);
474
475 gchar *normalize_newlines       (const gchar    *str);
476
477 gchar *get_outgoing_rfc2822_str (FILE           *fp);
478
479 gint change_file_mode_rw        (FILE           *fp,
480                                  const gchar    *file);
481 FILE *my_tmpfile                (void);
482 FILE *get_tmpfile_in_dir        (const gchar    *dir,
483                                  gchar         **filename);
484 FILE *str_open_as_stream        (const gchar    *str);
485 gint str_write_to_file          (const gchar    *str,
486                                  const gchar    *file);
487 gchar *file_read_to_str         (const gchar    *file);
488 gchar *file_read_stream_to_str  (FILE           *fp);
489
490 /* process execution */
491 gint execute_async              (gchar *const    argv[]);
492 gint execute_sync               (gchar *const    argv[]);
493 gint execute_command_line       (const gchar    *cmdline,
494                                  gboolean        async);
495 gchar *get_command_output       (const gchar    *cmdline);
496
497 /* open URI with external browser */
498 gint open_uri(const gchar *uri, const gchar *cmdline);
499 /* open file with text editor */
500 gint open_txt_editor(const gchar *filepath, const gchar *cmdline);
501
502 /* time functions */
503 time_t remote_tzoffset_sec      (const gchar    *zone);
504 time_t tzoffset_sec             (time_t         *now);
505 gchar *tzoffset                 (time_t         *now);
506 void get_rfc822_date            (gchar          *buf,
507                                  gint            len);
508
509 size_t my_strftime              (gchar                  *s,
510                                  size_t                  max,
511                                  const gchar            *format,
512                                  const struct tm        *tm);
513
514 /* debugging */
515 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
516 const char * debug_srcname (const char *file);
517
518 /* subject threading */
519 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
520 void subject_table_insert(GHashTable *subject_table, gchar * subject,
521                           void * data);
522 void subject_table_remove(GHashTable *subject_table, gchar * subject);
523 gint subject_get_prefix_length (const gchar *subject);
524
525 /* quoting recognition */
526 const gchar * line_has_quote_char       (const gchar *str,
527                                          const gchar *quote_chars);
528 const gchar * line_has_quote_char_last  (const gchar *str,
529                                          const gchar *quote_chars);
530
531 guint g_stricase_hash   (gconstpointer gptr);
532 gint g_stricase_equal   (gconstpointer gptr1, gconstpointer gptr2);
533 gint g_int_compare      (gconstpointer a, gconstpointer b);
534
535 gchar *generate_msgid           (gchar *buf, gint len);
536 gchar *generate_mime_boundary   (const gchar *prefix);
537
538 gint quote_cmd_argument(gchar * result, guint size,
539                         const gchar * path);
540 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
541
542 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
543 void get_hex_str(gchar *out, guchar ch);
544
545 /* auto pointer for containers that support GType system */
546
547 #define G_TYPE_AUTO_POINTER     g_auto_pointer_register()
548 typedef struct AutoPointer      GAuto;
549 GType g_auto_pointer_register           (void);
550 GAuto *g_auto_pointer_new               (gpointer pointer);
551 GAuto *g_auto_pointer_new_with_free     (gpointer p, 
552                                          GFreeFunc free);
553 gpointer g_auto_pointer_get_ptr         (GAuto *auto_ptr);
554 GAuto *g_auto_pointer_copy              (GAuto *auto_ptr);
555 void g_auto_pointer_free                (GAuto *auto_ptr);
556 void replace_returns                    (gchar *str);
557
558 gboolean get_uri_part(const gchar *start, const gchar *scanpos,
559                              const gchar **bp, const gchar **ep, gboolean hdr);
560 gchar *make_uri_string(const gchar *bp, const gchar *ep);
561 gboolean get_email_part(const gchar *start, const gchar *scanpos,
562                                const gchar **bp, const gchar **ep, gboolean hdr);
563 gchar *make_email_string(const gchar *bp, const gchar *ep);
564 gchar *make_http_string(const gchar *bp, const gchar *ep);
565 gchar *mailcap_get_command_for_type(const gchar *type);
566 gboolean file_is_email (const gchar *filename);
567
568 #ifdef __cplusplus
569 }
570 #endif
571
572 #endif /* __UTILS_H__ */