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