2007-01-21 [colin] 2.7.1cvs44
[claws.git] / src / common / utils.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail 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 gboolean is_next_nonascii       (const gchar *s);
261 gint get_next_word_len          (const gchar *s);
262
263 /* functions for string parsing */
264 gint subject_compare                    (const gchar    *s1,
265                                          const gchar    *s2);
266 gint subject_compare_for_sort           (const gchar    *s1,
267                                          const gchar    *s2);
268 void trim_subject_for_compare           (gchar          *str);
269 void trim_subject_for_sort              (gchar          *str);
270 void trim_subject                       (gchar          *str);
271 void eliminate_parenthesis              (gchar          *str,
272                                          gchar           op,
273                                          gchar           cl);
274 void extract_parenthesis                (gchar          *str,
275                                          gchar           op,
276                                          gchar           cl);
277
278 void extract_parenthesis_with_skip_quote        (gchar          *str,
279                                                  gchar           quote_chr,
280                                                  gchar           op,
281                                                  gchar           cl);
282
283 void eliminate_quote                    (gchar          *str,
284                                          gchar           quote_chr);
285 void extract_quote                      (gchar          *str,
286                                          gchar           quote_chr);
287 void eliminate_address_comment          (gchar          *str);
288 gchar *strchr_with_skip_quote           (const gchar    *str,
289                                          gint            quote_chr,
290                                          gint            c);
291 gchar *strrchr_with_skip_quote          (const gchar    *str,
292                                          gint            quote_chr,
293                                          gint            c);
294 void extract_address                    (gchar          *str);
295 void extract_list_id_str                (gchar          *str);
296
297 GSList *slist_concat_unique             (GSList         *first,
298                                          GSList         *second);
299 GSList *address_list_append             (GSList         *addr_list,
300                                          const gchar    *str);
301 GSList *address_list_append_with_comments(GSList        *addr_list,
302                                          const gchar    *str);
303 GSList *references_list_prepend         (GSList         *msgid_list,
304                                          const gchar    *str);
305 GSList *references_list_append          (GSList         *msgid_list,
306                                          const gchar    *str);
307 GSList *newsgroup_list_append           (GSList         *group_list,
308                                          const gchar    *str);
309
310 GList *add_history                      (GList          *list,
311                                          const gchar    *str);
312
313 void remove_return                      (gchar          *str);
314 void remove_space                       (gchar          *str);
315 void unfold_line                        (gchar          *str);
316 void subst_char                         (gchar          *str,
317                                          gchar           orig,
318                                          gchar           subst);
319 void subst_chars                        (gchar          *str,
320                                          gchar          *orig,
321                                          gchar           subst);
322 void subst_for_filename                 (gchar          *str);
323 void subst_for_shellsafe_filename       (gchar          *str);
324 gboolean is_header_line                 (const gchar    *str);
325 gboolean is_ascii_str                   (const gchar    *str);
326 gint get_quote_level                    (const gchar    *str,
327                                          const gchar    *quote_chars);
328 gint check_line_length                  (const gchar    *str,
329                                          gint            max_chars,
330                                          gint           *line);
331
332 gchar *strstr_with_skip_quote           (const gchar    *haystack,
333                                          const gchar    *needle);
334 gchar *strchr_parenthesis_close         (const gchar    *str,
335                                          gchar           op,
336                                          gchar           cl);
337
338 gchar **strsplit_parenthesis            (const gchar    *str,
339                                          gchar           op,
340                                          gchar           cl,
341                                          gint            max_tokens);
342 gchar **strsplit_with_quote             (const gchar    *str,
343                                          const gchar    *delim,
344                                          gint            max_tokens);
345
346 gchar *get_abbrev_newsgroup_name        (const gchar    *group,
347                                          gint            len);
348 gchar *trim_string                      (const gchar    *str,
349                                          gint            len);
350
351 GList *uri_list_extract_filenames       (const gchar    *uri_list);
352 gboolean is_uri_string                  (const gchar    *str);
353 gchar *get_uri_path                     (const gchar    *uri);
354 gint get_uri_len                        (const gchar    *str);
355 void decode_uri                         (gchar          *decoded_uri,
356                                          const gchar    *encoded_uri);
357 gint scan_mailto_url                    (const gchar    *mailto,
358                                          gchar         **to,
359                                          gchar         **cc,
360                                          gchar         **bcc,
361                                          gchar         **subject,
362                                          gchar         **body,
363                                          gchar         **attach);
364
365 /* return static strings */
366 const gchar *get_home_dir               (void);
367 const gchar *get_rc_dir                 (void);
368 const gchar *get_mail_base_dir          (void);
369 const gchar *get_news_cache_dir         (void);
370 const gchar *get_imap_cache_dir         (void);
371 const gchar *get_mbox_cache_dir         (void);
372 const gchar *get_mime_tmp_dir           (void);
373 const gchar *get_template_dir           (void);
374 const gchar *get_header_cache_dir       (void);
375 const gchar *get_plugin_dir             (void);
376 const gchar *get_tmp_dir                (void);
377 const gchar *get_locale_dir             (void);
378 gchar *get_tmp_file                     (void);
379 const gchar *get_domain_name            (void);
380
381 /* file / directory handling */
382 off_t get_file_size             (const gchar    *file);
383 off_t get_file_size_as_crlf     (const gchar    *file);
384 off_t get_left_file_size        (FILE           *fp);
385
386 time_t get_file_mtime           (const gchar *file);
387
388 gboolean file_exist             (const gchar    *file,
389                                  gboolean        allow_fifo);
390 gboolean is_relative_filename   (const gchar *file);
391 gboolean is_dir_exist           (const gchar    *dir);
392 gboolean is_file_entry_exist    (const gchar    *file);
393 gboolean dirent_is_regular_file (struct dirent  *d);
394 gboolean dirent_is_directory    (struct dirent  *d);
395
396 #define is_file_exist(file)             file_exist(file, FALSE)
397 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
398
399 gint change_dir                 (const gchar    *dir);
400 gint make_dir                   (const gchar    *dir);
401 gint make_dir_hier              (const gchar    *dir);
402 gint remove_all_files           (const gchar    *dir);
403 gint remove_numbered_files      (const gchar    *dir,
404                                  guint           first,
405                                  guint           last);
406 gint remove_numbered_files_not_in_list(const gchar *dir,
407                                        GSList *numberlist);
408 gint remove_all_numbered_files  (const gchar    *dir);
409 gint remove_expired_files       (const gchar    *dir,
410                                  guint           hours);
411 gint remove_dir_recursive       (const gchar    *dir);
412 gint append_file                (const gchar    *src,
413                                  const gchar    *dest,
414                                  gboolean        keep_backup);
415 gint rename_force               (const gchar    *oldpath,
416                                  const gchar    *newpath);
417 gint copy_file                  (const gchar    *src,
418                                  const gchar    *dest,
419                                  gboolean        keep_backup);
420 gint move_file                  (const gchar    *src,
421                                  const gchar    *dest,
422                                  gboolean        overwrite);
423 gint copy_dir                   (const gchar    *src,
424                                  const gchar    *dest);
425 gint copy_file_part_to_fp       (FILE           *fp,
426                                  off_t           offset,
427                                  size_t          length,
428                                  FILE           *dest_fp);
429 gint copy_file_part             (FILE           *fp,
430                                  off_t           offset,
431                                  size_t          length,
432                                  const gchar    *dest);
433
434 gchar *canonicalize_str         (const gchar    *str);
435 gint canonicalize_file          (const gchar    *src,
436                                  const gchar    *dest);
437 gint canonicalize_file_replace  (const gchar    *file);
438 gint uncanonicalize_file        (const gchar    *src,
439                                  const gchar    *dest);
440 gint uncanonicalize_file_replace(const gchar    *file);
441
442 gchar *normalize_newlines       (const gchar    *str);
443
444 gchar *get_outgoing_rfc2822_str (FILE           *fp);
445
446 gint change_file_mode_rw        (FILE           *fp,
447                                  const gchar    *file);
448 FILE *my_tmpfile                (void);
449 FILE *get_tmpfile_in_dir        (const gchar    *dir,
450                                  gchar         **filename);
451 FILE *str_open_as_stream        (const gchar    *str);
452 gint str_write_to_file          (const gchar    *str,
453                                  const gchar    *file);
454 gchar *file_read_to_str         (const gchar    *file);
455 gchar *file_read_stream_to_str  (FILE           *fp);
456
457 /* process execution */
458 gint execute_command_line       (const gchar    *cmdline,
459                                  gboolean        async);
460 gchar *get_command_output       (const gchar    *cmdline);
461
462 /* open URI with external browser */
463 gint open_uri(const gchar *uri, const gchar *cmdline);
464 /* open file with text editor */
465 gint open_txt_editor(const gchar *filepath, const gchar *cmdline);
466
467 /* time functions */
468 time_t remote_tzoffset_sec      (const gchar    *zone);
469 time_t tzoffset_sec             (time_t         *now);
470 gchar *tzoffset                 (time_t         *now);
471 void get_rfc822_date            (gchar          *buf,
472                                  gint            len);
473
474 size_t my_strftime              (gchar                  *s,
475                                  size_t                  max,
476                                  const gchar            *format,
477                                  const struct tm        *tm);
478 size_t fast_strftime            (gchar                  *buf, 
479                                  gint                    buflen, 
480                                  const gchar            *format, 
481                                  struct tm              *lt);
482
483 /* debugging */
484 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
485 const char * debug_srcname (const char *file);
486
487 /* subject threading */
488 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
489 void subject_table_insert(GHashTable *subject_table, gchar * subject,
490                           void * data);
491 void subject_table_remove(GHashTable *subject_table, gchar * subject);
492 gint subject_get_prefix_length (const gchar *subject);
493
494 /* quoting recognition */
495 const gchar * line_has_quote_char       (const gchar *str,
496                                          const gchar *quote_chars);
497 const gchar * line_has_quote_char_last  (const gchar *str,
498                                          const gchar *quote_chars);
499
500 guint g_stricase_hash   (gconstpointer gptr);
501 gint g_stricase_equal   (gconstpointer gptr1, gconstpointer gptr2);
502 gint g_int_compare      (gconstpointer a, gconstpointer b);
503
504 gchar *generate_msgid           (gchar *buf, gint len);
505 gchar *generate_mime_boundary   (const gchar *prefix);
506
507 gint quote_cmd_argument(gchar * result, guint size,
508                         const gchar * path);
509 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
510
511 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
512 void get_hex_str(gchar *out, guchar ch);
513
514 /* auto pointer for containers that support GType system */
515
516 #define G_TYPE_AUTO_POINTER     g_auto_pointer_register()
517 typedef struct AutoPointer      GAuto;
518 GType g_auto_pointer_register           (void);
519 GAuto *g_auto_pointer_new               (gpointer pointer);
520 GAuto *g_auto_pointer_new_with_free     (gpointer p, 
521                                          GFreeFunc free);
522 gpointer g_auto_pointer_get_ptr         (GAuto *auto_ptr);
523 GAuto *g_auto_pointer_copy              (GAuto *auto_ptr);
524 void g_auto_pointer_free                (GAuto *auto_ptr);
525 void replace_returns                    (gchar *str);
526 gboolean get_uri_part   (const gchar *start,
527                          const gchar *scanpos,
528                          const gchar **bp,
529                          const gchar **ep,
530                          gboolean hdr);
531 gchar *make_uri_string  (const gchar *bp,
532                          const gchar *ep);
533 gboolean get_email_part (const gchar *start, 
534                          const gchar *scanpos,
535                          const gchar **bp, 
536                          const gchar **ep,
537                          gboolean hdr);
538 gchar *make_email_string(const gchar *bp,
539                          const gchar *ep);
540 gchar *make_http_string (const gchar *bp,
541                          const gchar *ep);
542
543 gchar *mailcap_get_command_for_type(const gchar *type, 
544                                     const gchar *file_to_open);
545 void mailcap_update_default        (const gchar *type,
546                                     const gchar *command);
547
548 gboolean file_is_email(const gchar *filename);
549 gboolean sc_g_list_bigger(GList *list, gint max);
550 gboolean sc_g_slist_bigger(GSList *list, gint max);
551 #ifdef __cplusplus
552 }
553 #endif
554
555 #endif /* __UTILS_H__ */