src/common/utils.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2004 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 typedef gboolean (*StrFindFunc) (const gchar    *haystack,
 179                                  const gchar    *needle);
 180
 181 gboolean str_find               (const gchar    *haystack,
 182                                  const gchar    *needle);
 183 gboolean str_case_find          (const gchar    *haystack,
 184                                  const gchar    *needle);
 185 gboolean str_find_equal         (const gchar    *haystack,
 186                                  const gchar    *needle);
 187 gboolean str_case_find_equal    (const gchar    *haystack,
 188                                  const gchar    *needle);
 189
 190 /* number-string conversion */
 191 gint to_number                  (const gchar *nstr);
 192 gchar *itos_buf                 (gchar       *nstr,
 193                                  gint         n);
 194 gchar *itos                     (gint         n);
 195 gchar *to_human_readable        (off_t        size);
 196
 197 /* alternative string functions */
 198 gint strcmp2            (const gchar    *s1,
 199                          const gchar    *s2);
 200 gchar *strstr2          (const gchar    *s1,
 201                          const gchar    *s2);
 202 gint path_cmp           (const gchar    *s1,
 203                          const gchar    *s2);
 204 gchar *strretchomp      (gchar          *str);
 205 gchar *strtailchomp     (gchar          *str,
 206                          gchar           tail_char);
 207 gchar *strcrchomp       (gchar          *str);
 208 gchar *strcasestr       (const gchar    *haystack,
 209                          const gchar    *needle);
 210 gchar *strncpy2         (gchar          *dest,
 211                          const gchar    *src,
 212                          size_t          n);
 213
 214 /* wide-character functions */
 215 #if !HAVE_ISWALNUM
 216 int iswalnum            (wint_t wc);
 217 #endif
 218 #if !HAVE_ISWSPACE
 219 int iswspace            (wint_t wc);
 220 #endif
 221 #if !HAVE_TOWLOWER
 222 wint_t towlower         (wint_t wc);
 223 #endif
 224
 225 #if !HAVE_WCSLEN
 226 size_t wcslen           (const wchar_t *s);
 227 #endif
 228 #if !HAVE_WCSCPY
 229 wchar_t *wcscpy         (wchar_t       *dest,
 230                          const wchar_t *src);
 231 #endif
 232 #if !HAVE_WCSNCPY
 233 wchar_t *wcsncpy        (wchar_t       *dest,
 234                          const wchar_t *src,
 235                          size_t         n);
 236 #endif
 237
 238 wchar_t *wcsdup                 (const wchar_t *s);
 239 wchar_t *wcsndup                (const wchar_t *s,
 240                                  size_t         n);
 241 wchar_t *strdup_mbstowcs        (const gchar   *s);
 242 gchar *strdup_wcstombs          (const wchar_t *s);
 243 gint wcsncasecmp                (const wchar_t *s1,
 244                                  const wchar_t *s2,
 245                                  size_t         n);
 246 wchar_t *wcscasestr             (const wchar_t *haystack,
 247                                  const wchar_t *needle);
 248 gint get_mbs_len                (const gchar    *s);
 249
 250 gboolean is_next_nonascii       (const guchar *s);
 251 gint get_next_word_len          (const guchar *s);
 252
 253 /* functions for string parsing */
 254 gint subject_compare                    (const gchar    *s1,
 255                                          const gchar    *s2);
 256 gint subject_compare_for_sort           (const gchar    *s1,
 257                                          const gchar    *s2);
 258 void trim_subject_for_compare           (gchar          *str);
 259 void trim_subject_for_sort              (gchar          *str);
 260 void trim_subject                       (gchar          *str);
 261 void eliminate_parenthesis              (gchar          *str,
 262                                          gchar           op,
 263                                          gchar           cl);
 264 void extract_parenthesis                (gchar          *str,
 265                                          gchar           op,
 266                                          gchar           cl);
 267
 268 void extract_parenthesis_with_skip_quote        (gchar          *str,
 269                                                  gchar           quote_chr,
 270                                                  gchar           op,
 271                                                  gchar           cl);
 272
 273 void eliminate_quote                    (gchar          *str,
 274                                          gchar           quote_chr);
 275 void extract_quote                      (gchar          *str,
 276                                          gchar           quote_chr);
 277 void eliminate_address_comment          (gchar          *str);
 278 gchar *strchr_with_skip_quote           (const gchar    *str,
 279                                          gint            quote_chr,
 280                                          gint            c);
 281 gchar *strrchr_with_skip_quote          (const gchar    *str,
 282                                          gint            quote_chr,
 283                                          gint            c);
 284 void extract_address                    (gchar          *str);
 285 void extract_list_id_str                (gchar          *str);
 286
 287 GSList *slist_concat_unique             (GSList         *first,
 288                                          GSList         *second);
 289 GSList *address_list_append             (GSList         *addr_list,
 290                                          const gchar    *str);
 291 GSList *address_list_append_with_comments(GSList        *addr_list,
 292                                          const gchar    *str);
 293 GSList *references_list_append          (GSList         *msgid_list,
 294                                          const gchar    *str);
 295 GSList *newsgroup_list_append           (GSList         *group_list,
 296                                          const gchar    *str);
 297
 298 GList *add_history                      (GList          *list,
 299                                          const gchar    *str);
 300
 301 void remove_return                      (gchar          *str);
 302 void remove_space                       (gchar          *str);
 303 void unfold_line                        (gchar          *str);
 304 void subst_char                         (gchar          *str,
 305                                          gchar           orig,
 306                                          gchar           subst);
 307 void subst_chars                        (gchar          *str,
 308                                          gchar          *orig,
 309                                          gchar           subst);
 310 void subst_for_filename                 (gchar          *str);
 311 void subst_for_shellsafe_filename       (gchar          *str);
 312 gboolean is_header_line                 (const gchar    *str);
 313 gboolean is_ascii_str                   (const guchar   *str);
 314 gint get_quote_level                    (const gchar    *str,
 315                                          const gchar    *quote_chars);
 316 gchar *strstr_with_skip_quote           (const gchar    *haystack,
 317                                          const gchar    *needle);
 318 gchar *strchr_parenthesis_close         (const gchar    *str,
 319                                          gchar           op,
 320                                          gchar           cl);
 321
 322 gchar **strsplit_parenthesis            (const gchar    *str,
 323                                          gchar           op,
 324                                          gchar           cl,
 325                                          gint            max_tokens);
 326 gchar **strsplit_with_quote             (const gchar    *str,
 327                                          const gchar    *delim,
 328                                          gint            max_tokens);
 329
 330 gchar *get_abbrev_newsgroup_name        (const gchar    *group,
 331                                          gint            len);
 332 gchar *trim_string                      (const gchar    *str,
 333                                          gint            len);
 334
 335 GList *uri_list_extract_filenames       (const gchar    *uri_list);
 336 gboolean is_uri_string                  (const gchar    *str);
 337 gchar *get_uri_path                     (const gchar    *uri);
 338 void decode_uri                         (gchar          *decoded_uri,
 339                                          const gchar    *encoded_uri);
 340 gint scan_mailto_url                    (const gchar    *mailto,
 341                                          gchar         **to,
 342                                          gchar         **cc,
 343                                          gchar         **bcc,
 344                                          gchar         **subject,
 345                                          gchar         **body);
 346
 347 /* return static strings */
 348 const gchar *get_home_dir               (void);
 349 const gchar *get_rc_dir                 (void);
 350 const gchar *get_news_cache_dir         (void);
 351 const gchar *get_imap_cache_dir         (void);
 352 const gchar *get_mbox_cache_dir         (void);
 353 const gchar *get_mime_tmp_dir           (void);
 354 const gchar *get_template_dir           (void);
 355 const gchar *get_header_cache_dir       (void);
 356 const gchar *get_tmp_dir                (void);
 357 gchar *get_tmp_file                     (void);
 358 const gchar *get_domain_name            (void);
 359
 360 /* file / directory handling */
 361 off_t get_file_size             (const gchar    *file);
 362 off_t get_file_size_as_crlf     (const gchar    *file);
 363 off_t get_left_file_size        (FILE           *fp);
 364
 365 gboolean file_exist             (const gchar    *file,
 366                                  gboolean        allow_fifo);
 367 gboolean is_dir_exist           (const gchar    *dir);
 368 gboolean is_file_entry_exist    (const gchar    *file);
 369 gboolean dirent_is_regular_file (struct dirent  *d);
 370 gboolean dirent_is_directory    (struct dirent  *d);
 371
 372 #define is_file_exist(file)             file_exist(file, FALSE)
 373 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
 374
 375 gint change_dir                 (const gchar    *dir);
 376 gint make_dir                   (const gchar    *dir);
 377 gint make_dir_hier              (const gchar    *dir);
 378 gint remove_all_files           (const gchar    *dir);
 379 gint remove_numbered_files      (const gchar    *dir,
 380                                  guint           first,
 381                                  guint           last);
 382 gint remove_numbered_files_not_in_list(const gchar *dir,
 383                                        GSList *numberlist);
 384 gint remove_all_numbered_files  (const gchar    *dir);
 385 gint remove_expired_files       (const gchar    *dir,
 386                                  guint           hours);
 387 gint remove_dir_recursive       (const gchar    *dir);
 388 gint append_file                (const gchar    *src,
 389                                  const gchar    *dest,
 390                                  gboolean        keep_backup);
 391 gint copy_file                  (const gchar    *src,
 392                                  const gchar    *dest,
 393                                  gboolean        keep_backup);
 394 gint move_file                  (const gchar    *src,
 395                                  const gchar    *dest,
 396                                  gboolean        overwrite);
 397 gint copy_file_part_to_fp       (FILE           *fp,
 398                                  off_t           offset,
 399                                  size_t          length,
 400                                  FILE           *dest_fp);
 401 gint copy_file_part             (FILE           *fp,
 402                                  off_t           offset,
 403                                  size_t          length,
 404                                  const gchar    *dest);
 405
 406 gchar *canonicalize_str         (const gchar    *str);
 407 gint canonicalize_file          (const gchar    *src,
 408                                  const gchar    *dest);
 409 gint canonicalize_file_replace  (const gchar    *file);
 410 gint uncanonicalize_file        (const gchar    *src,
 411                                  const gchar    *dest);
 412 gint uncanonicalize_file_replace(const gchar    *file);
 413
 414 gchar *normalize_newlines       (const gchar    *str);
 415
 416 gchar *get_outgoing_rfc2822_str (FILE           *fp);
 417
 418 gint change_file_mode_rw        (FILE           *fp,
 419                                  const gchar    *file);
 420 FILE *my_tmpfile                (void);
 421 FILE *get_tmpfile_in_dir        (const gchar    *dir,
 422                                  gchar         **filename);
 423 FILE *str_open_as_stream        (const gchar    *str);
 424 gint str_write_to_file          (const gchar    *str,
 425                                  const gchar    *file);
 426 gchar *file_read_to_str         (const gchar    *file);
 427 gchar *file_read_stream_to_str  (FILE           *fp);
 428
 429 /* process execution */
 430 gint execute_async              (gchar *const    argv[]);
 431 gint execute_sync               (gchar *const    argv[]);
 432 gint execute_command_line       (const gchar    *cmdline,
 433                                  gboolean        async);
 434 gchar *get_command_output       (const gchar    *cmdline);
 435
 436 /* open URI with external browser */
 437 gint open_uri(const gchar *uri, const gchar *cmdline);
 438
 439 /* time functions */
 440 time_t remote_tzoffset_sec      (const gchar    *zone);
 441 time_t tzoffset_sec             (time_t         *now);
 442 gchar *tzoffset                 (time_t         *now);
 443 void get_rfc822_date            (gchar          *buf,
 444                                  gint            len);
 445
 446 /* debugging */
 447 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
 448
 449 /* subject threading */
 450 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
 451 void subject_table_insert(GHashTable *subject_table, gchar * subject,
 452                           void * data);
 453 void subject_table_remove(GHashTable *subject_table, gchar * subject);
 454 gint subject_get_prefix_length (const gchar *subject);
 455
 456 /* quoting recognition */
 457 const gchar * line_has_quote_char       (const gchar *str,
 458                                          const gchar *quote_chars);
 459 const gchar * line_has_quote_char_last  (const gchar *str,
 460                                          const gchar *quote_chars);
 461
 462 guint g_stricase_hash   (gconstpointer gptr);
 463 gint g_stricase_equal   (gconstpointer gptr1, gconstpointer gptr2);
 464 gint g_int_compare      (gconstpointer a, gconstpointer b);
 465
 466 gchar *generate_msgid           (gchar *buf, gint len);
 467 gchar *generate_mime_boundary   (const gchar *prefix);
 468
 469 gint quote_cmd_argument(gchar * result, guint size,
 470                         const gchar * path);
 471 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
 472
 473 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
 474 void get_hex_str(gchar *out, guchar ch);
 475
 476 #ifdef __cplusplus
 477 }
 478 #endif
 479
 480 #endif /* __UTILS_H__ */