sync with sylpheed 0.5.0pre2 release
[claws.git] / 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 /* for macro expansion */
121 #define Str(x)  #x
122 #define Xstr(x) Str(x)
123
124 void list_free_strings          (GList          *list);
125 void slist_free_strings         (GSList         *list);
126
127 void hash_free_strings          (GHashTable     *table);
128
129 void ptr_array_free_strings     (GPtrArray      *array);
130
131 /* number-string conversion */
132 gint to_number                  (const gchar *nstr);
133 gchar *itos_buf                 (gchar       *nstr,
134                                  gint         n);
135 gchar *itos                     (gint         n);
136 gchar *to_human_readable        (off_t        size);
137
138 /* alternative string functions */
139 gint strcmp2            (const gchar    *s1,
140                          const gchar    *s2);
141 gint path_cmp           (const gchar    *s1,
142                          const gchar    *s2);
143 gchar *strretchomp      (gchar          *str);
144 gchar *strtailchomp     (gchar          *str,
145                          gchar           tail_char);
146 gchar *strcasestr       (const gchar    *haystack,
147                          const gchar    *needle);
148 gchar *strncpy2         (gchar          *dest,
149                          const gchar    *src,
150                          size_t          n);
151
152 /* wide-character functions */
153 #if !HAVE_ISWALNUM
154 int iswalnum            (wint_t wc);
155 #endif
156 #if !HAVE_ISWSPACE
157 int iswspace            (wint_t wc);
158 #endif
159 #if !HAVE_TOWLOWER
160 wint_t towlower         (wint_t wc);
161 #endif
162
163 #if !HAVE_WCSLEN
164 size_t wcslen           (const wchar_t *s);
165 #endif
166 #if !HAVE_WCSCPY
167 wchar_t *wcscpy         (wchar_t       *dest,
168                          const wchar_t *src);
169 #endif
170 #if !HAVE_WCSNCPY
171 wchar_t *wcsncpy        (wchar_t       *dest,
172                          const wchar_t *src,
173                          size_t         n);
174 #endif
175
176 wchar_t *wcsdup                 (const wchar_t *s);
177 wchar_t *wcsndup                (const wchar_t *s,
178                                  size_t         n);
179 wchar_t *strdup_mbstowcs        (const gchar   *s);
180 gchar *strdup_wcstombs          (const wchar_t *s);
181 gint wcsncasecmp                (const wchar_t *s1,
182                                  const wchar_t *s2,
183                                  size_t         n);
184 wchar_t *wcscasestr             (const wchar_t *haystack,
185                                  const wchar_t *needle);
186
187 gboolean is_next_nonascii       (const wchar_t *s);
188 gboolean is_next_mbs            (const wchar_t *s);
189 wchar_t *find_wspace            (const wchar_t *s);
190
191 /* functions for string parsing */
192 gint subject_compare                    (const gchar    *s1,
193                                          const gchar    *s2);
194 void trim_subject                       (gchar          *str);
195 void eliminate_parenthesis              (gchar          *str,
196                                          gchar           op,
197                                          gchar           cl);
198 void extract_parenthesis                (gchar          *str,
199                                          gchar           op,
200                                          gchar           cl);
201
202 void extract_one_parenthesis_with_skip_quote    (gchar          *str,
203                                                  gchar           quote_chr,
204                                                  gchar           op,
205                                                  gchar           cl);
206 void extract_parenthesis_with_skip_quote        (gchar          *str,
207                                                  gchar           quote_chr,
208                                                  gchar           op,
209                                                  gchar           cl);
210
211 void eliminate_quote                    (gchar          *str,
212                                          gchar           quote_chr);
213 void extract_quote                      (gchar          *str,
214                                          gchar           quote_chr);
215 void eliminate_address_comment          (gchar          *str);
216 gchar *strchr_with_skip_quote           (const gchar    *str,
217                                          gint            quote_chr,
218                                          gint            c);
219 gchar *strrchr_with_skip_quote          (const gchar    *str,
220                                          gint            quote_chr,
221                                          gint            c);
222 void extract_address                    (gchar          *str);
223 GSList *address_list_append             (GSList         *addr_list,
224                                          const gchar    *str);
225 GSList *references_list_append          (GSList         *msgid_list,
226                                          const gchar    *str);
227 GSList *newsgroup_list_append           (GSList         *group_list,
228                                          const gchar    *str);
229 void remove_return                      (gchar          *str);
230 void remove_space                       (gchar          *str);
231 void unfold_line                        (gchar          *str);
232 void subst_char                         (gchar          *str,
233                                          gchar           orig,
234                                          gchar           subst);
235 gboolean is_header_line                 (const gchar    *str);
236 gboolean is_ascii_str                   (const guchar   *str);
237 gint get_quote_level                    (const gchar    *str);
238 GList *uri_list_extract_filenames       (const gchar    *uri_list);
239 gchar *strstr_with_skip_quote           (const gchar    *haystack,
240                                          const gchar    *needle);
241 gchar **strsplit_with_quote             (const gchar    *str,
242                                          const gchar    *delim,
243                                          gint            max_tokens);
244
245 /* return static strings */
246 gchar *get_home_dir             (void);
247 gchar *get_rc_dir               (void);
248 gchar *get_news_cache_dir       (void);
249 gchar *get_imap_cache_dir       (void);
250 gchar *get_mbox_cache_dir       (void);
251 gchar *get_mime_tmp_dir         (void);
252 gchar *get_tmp_file             (void);
253 gchar *get_domain_name          (void);
254
255 /* file / directory handling */
256 off_t get_file_size             (const gchar    *file);
257 off_t get_left_file_size        (FILE           *fp);
258 gboolean file_exist             (const gchar    *file,
259                                  gboolean        allow_fifo);
260 gboolean is_dir_exist           (const gchar    *dir);
261 gint change_dir                 (const gchar    *dir);
262 gint make_dir_hier              (const gchar    *dir);
263 gint remove_all_files           (const gchar    *dir);
264 gint remove_numbered_files      (const gchar    *dir,
265                                  guint           first,
266                                  guint           last);
267 gint remove_all_numbered_files  (const gchar    *dir);
268 gint remove_dir_recursive       (const gchar    *dir);
269 gint copy_file                  (const gchar    *src,
270                                  const gchar    *dest);
271 gint move_file                  (const gchar    *src,
272                                  const gchar    *dest);
273 gint change_file_mode_rw        (FILE           *fp,
274                                  const gchar    *file);
275 FILE *my_tmpfile                (void);
276
277 #define is_file_exist(file)             file_exist(file, FALSE)
278 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
279
280 /* process execution */
281 gint execute_async              (gchar *const    argv[]);
282 gint execute_command_line       (const gchar    *cmdline);
283
284 /* open URI with external browser */
285 gint open_uri(const gchar *uri, const gchar *cmdline);
286
287 /* time functions */
288 time_t remote_tzoffset_sec      (const gchar    *zone);
289 time_t tzoffset_sec             (time_t         *now);
290 gchar *tzoffset                 (time_t         *now);
291 void get_rfc822_date            (gchar          *buf,
292                                  gint            len);
293
294 /* logging */
295 void set_log_file       (const gchar *filename);
296 void close_log_file     (void);
297 void debug_print        (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
298 void log_print          (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
299 void log_message        (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
300 void log_warning        (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
301 void log_error          (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
302
303 #endif /* __UTILS_H__ */