src/utils.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2001 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 <time.h>
  34 #if HAVE_ALLOCA_H
  35 #  include <alloca.h>
  36 #endif
  37 #if HAVE_WCHAR_H
  38 #  include <wchar.h>
  39 #endif
  40
  41 /* The AC_CHECK_SIZEOF() in configure fails for some machines.
  42  * we provide some fallback values here */
  43 #if !SIZEOF_UNSIGNED_SHORT
  44   #undef SIZEOF_UNSIGNED_SHORT
  45   #define SIZEOF_UNSIGNED_SHORT 2
  46 #endif
  47 #if !SIZEOF_UNSIGNED_INT
  48   #undef SIZEOF_UNSIGNED_INT
  49   #define SIZEOF_UNSIGNED_INT 4
  50 #endif
  51 #if !SIZEOF_UNSIGNED_LONG
  52   #undef SIZEOF_UNSIGNED_LONG
  53   #define SIZEOF_UNSIGNED_LONG 4
  54 #endif
  55
  56 #ifndef HAVE_U32_TYPEDEF
  57   #undef u32        /* maybe there is a macro with this name */
  58   typedef guint32 u32;
  59   #define HAVE_U32_TYPEDEF
  60 #endif
  61
  62 #ifndef BIG_ENDIAN_HOST
  63   #if (G_BYTE_ORDER == G_BIG_ENDIAN)
  64     #define BIG_ENDIAN_HOST 1
  65   #endif
  66 #endif
  67
  68 #define CHDIR_RETURN_IF_FAIL(dir) \
  69 { \
  70         if (change_dir(dir) < 0) return; \
  71 }
  72
  73 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
  74 { \
  75         if (change_dir(dir) < 0) return val; \
  76 }
  77
  78 #define Xalloca(ptr, size, iffail) \
  79 { \
  80         if ((ptr = alloca(size)) == NULL) { \
  81                 g_warning("can't allocate memory\n"); \
  82                 iffail; \
  83         } \
  84 }
  85
  86 #define Xstrdup_a(ptr, str, iffail) \
  87 { \
  88         gchar *__tmp; \
  89  \
  90         if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
  91                 g_warning("can't allocate memory\n"); \
  92                 iffail; \
  93         } else \
  94                 strcpy(__tmp, str); \
  95  \
  96         ptr = __tmp; \
  97 }
  98
  99 #define Xstrndup_a(ptr, str, len, iffail) \
 100 { \
 101         gchar *__tmp; \
 102  \
 103         if ((__tmp = alloca(len + 1)) == NULL) { \
 104                 g_warning("can't allocate memory\n"); \
 105                 iffail; \
 106         } else { \
 107                 strncpy(__tmp, str, len); \
 108                 __tmp[len] = '\0'; \
 109         } \
 110  \
 111         ptr = __tmp; \
 112 }
 113
 114 #define FILE_OP_ERROR(file, func) \
 115 { \
 116         fprintf(stderr, "%s: ", file); \
 117         perror(func); \
 118 }
 119
 120 #define debug_print \
 121         debug_print_real(__FILE__ ":%d:", __LINE__), \
 122         debug_print_real
 123
 124 /* for macro expansion */
 125 #define Str(x)  #x
 126 #define Xstr(x) Str(x)
 127
 128 void list_free_strings          (GList          *list);
 129 void slist_free_strings         (GSList         *list);
 130
 131 void hash_free_strings          (GHashTable     *table);
 132 void hash_free_value_mem        (GHashTable     *table);
 133
 134 void ptr_array_free_strings     (GPtrArray      *array);
 135
 136 /* number-string conversion */
 137 gint to_number                  (const gchar *nstr);
 138 gchar *itos_buf                 (gchar       *nstr,
 139                                  gint         n);
 140 gchar *itos                     (gint         n);
 141 gchar *to_human_readable        (off_t        size);
 142
 143 /* alternative string functions */
 144 gint strcmp2            (const gchar    *s1,
 145                          const gchar    *s2);
 146 gint strstr2            (const gchar    *s1,
 147                          const gchar    *s2);
 148 gint path_cmp           (const gchar    *s1,
 149                          const gchar    *s2);
 150 gchar *strretchomp      (gchar          *str);
 151 gchar *strtailchomp     (gchar          *str,
 152                          gchar           tail_char);
 153 gchar *strcasestr       (const gchar    *haystack,
 154                          const gchar    *needle);
 155 gchar *strncpy2         (gchar          *dest,
 156                          const gchar    *src,
 157                          size_t          n);
 158
 159 /* wide-character functions */
 160 #if !HAVE_ISWALNUM
 161 int iswalnum            (wint_t wc);
 162 #endif
 163 #if !HAVE_ISWSPACE
 164 int iswspace            (wint_t wc);
 165 #endif
 166 #if !HAVE_TOWLOWER
 167 wint_t towlower         (wint_t wc);
 168 #endif
 169
 170 #if !HAVE_WCSLEN
 171 size_t wcslen           (const wchar_t *s);
 172 #endif
 173 #if !HAVE_WCSCPY
 174 wchar_t *wcscpy         (wchar_t       *dest,
 175                          const wchar_t *src);
 176 #endif
 177 #if !HAVE_WCSNCPY
 178 wchar_t *wcsncpy        (wchar_t       *dest,
 179                          const wchar_t *src,
 180                          size_t         n);
 181 #endif
 182
 183 wchar_t *wcsdup                 (const wchar_t *s);
 184 wchar_t *wcsndup                (const wchar_t *s,
 185                                  size_t         n);
 186 wchar_t *strdup_mbstowcs        (const gchar   *s);
 187 gchar *strdup_wcstombs          (const wchar_t *s);
 188 gint wcsncasecmp                (const wchar_t *s1,
 189                                  const wchar_t *s2,
 190                                  size_t         n);
 191 wchar_t *wcscasestr             (const wchar_t *haystack,
 192                                  const wchar_t *needle);
 193
 194 gboolean is_next_nonascii       (const wchar_t *s);
 195 gboolean is_next_mbs            (const wchar_t *s);
 196 wchar_t *find_wspace            (const wchar_t *s);
 197
 198 /* functions for string parsing */
 199 gint subject_compare                    (const gchar    *s1,
 200                                          const gchar    *s2);
 201 void trim_subject                       (gchar          *str);
 202 void eliminate_parenthesis              (gchar          *str,
 203                                          gchar           op,
 204                                          gchar           cl);
 205 void extract_parenthesis                (gchar          *str,
 206                                          gchar           op,
 207                                          gchar           cl);
 208
 209 void extract_one_parenthesis_with_skip_quote    (gchar          *str,
 210                                                  gchar           quote_chr,
 211                                                  gchar           op,
 212                                                  gchar           cl);
 213 void extract_parenthesis_with_skip_quote        (gchar          *str,
 214                                                  gchar           quote_chr,
 215                                                  gchar           op,
 216                                                  gchar           cl);
 217
 218 void eliminate_quote                    (gchar          *str,
 219                                          gchar           quote_chr);
 220 void extract_quote                      (gchar          *str,
 221                                          gchar           quote_chr);
 222 void eliminate_address_comment          (gchar          *str);
 223 gchar *strchr_with_skip_quote           (const gchar    *str,
 224                                          gint            quote_chr,
 225                                          gint            c);
 226 gchar *strrchr_with_skip_quote          (const gchar    *str,
 227                                          gint            quote_chr,
 228                                          gint            c);
 229 void extract_address                    (gchar          *str);
 230 GSList *address_list_append             (GSList         *addr_list,
 231                                          const gchar    *str);
 232 GSList *references_list_append          (GSList         *msgid_list,
 233                                          const gchar    *str);
 234 GSList *newsgroup_list_append           (GSList         *group_list,
 235                                          const gchar    *str);
 236 void remove_return                      (gchar          *str);
 237 void remove_space                       (gchar          *str);
 238 void unfold_line                        (gchar          *str);
 239 void subst_char                         (gchar          *str,
 240                                          gchar           orig,
 241                                          gchar           subst);
 242 gboolean is_header_line                 (const gchar    *str);
 243 gboolean is_ascii_str                   (const guchar   *str);
 244 gint get_quote_level                    (const gchar    *str);
 245 GList *uri_list_extract_filenames       (const gchar    *uri_list);
 246 gchar *strstr_with_skip_quote           (const gchar    *haystack,
 247                                          const gchar    *needle);
 248 gchar **strsplit_with_quote             (const gchar    *str,
 249                                          const gchar    *delim,
 250                                          gint            max_tokens);
 251
 252 /* return static strings */
 253 gchar *get_home_dir             (void);
 254 gchar *get_rc_dir               (void);
 255 gchar *get_news_cache_dir       (void);
 256 gchar *get_imap_cache_dir       (void);
 257 gchar *get_mbox_cache_dir       (void);
 258 gchar *get_mime_tmp_dir         (void);
 259 gchar *get_tmp_file             (void);
 260 gchar *get_domain_name          (void);
 261
 262 /* file / directory handling */
 263 off_t get_file_size             (const gchar    *file);
 264 off_t get_left_file_size        (FILE           *fp);
 265 gboolean file_exist             (const gchar    *file,
 266                                  gboolean        allow_fifo);
 267 gboolean is_dir_exist           (const gchar    *dir);
 268 gint change_dir                 (const gchar    *dir);
 269 gint make_dir_hier              (const gchar    *dir);
 270 gint remove_all_files           (const gchar    *dir);
 271 gint remove_numbered_files      (const gchar    *dir,
 272                                  guint           first,
 273                                  guint           last);
 274 gint remove_all_numbered_files  (const gchar    *dir);
 275 gint remove_dir_recursive       (const gchar    *dir);
 276 gint copy_file                  (const gchar    *src,
 277                                  const gchar    *dest);
 278 gint move_file                  (const gchar    *src,
 279                                  const gchar    *dest);
 280 gint change_file_mode_rw        (FILE           *fp,
 281                                  const gchar    *file);
 282 FILE *my_tmpfile                (void);
 283
 284 #define is_file_exist(file)             file_exist(file, FALSE)
 285 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
 286
 287 /* process execution */
 288 gint execute_async              (gchar *const    argv[]);
 289 gint execute_sync               (gchar *const    argv[]);
 290 gint execute_command_line       (const gchar    *cmdline,
 291                                  gboolean        async);
 292
 293 /* open URI with external browser */
 294 gint open_uri(const gchar *uri, const gchar *cmdline);
 295
 296 /* time functions */
 297 time_t remote_tzoffset_sec      (const gchar    *zone);
 298 time_t tzoffset_sec             (time_t         *now);
 299 gchar *tzoffset                 (time_t         *now);
 300 void get_rfc822_date            (gchar          *buf,
 301                                  gint            len);
 302
 303 /* logging */
 304 void set_log_file       (const gchar *filename);
 305 void close_log_file     (void);
 306 void log_verbosity_set  (gboolean verbose);
 307 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
 308 void log_print          (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
 309 void log_message        (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
 310 void log_warning        (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
 311 void log_error          (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
 312
 313 #endif /* __UTILS_H__ */