sycn with 0.8.8cvs11
[claws.git] / src / common / utils.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2003 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 Xstrcat_a(ptr, str1, str2, iffail) \
115 { \
116         gchar *__tmp; \
117         gint len1, len2; \
118  \
119         len1 = strlen(str1); \
120         len2 = strlen(str2); \
121         if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
122                 g_warning("can't allocate memory\n"); \
123                 iffail; \
124         } else { \
125                 memcpy(__tmp, str1, len1); \
126                 memcpy(__tmp + len1, str2, len2 + 1); \
127         } \
128  \
129         ptr = __tmp; \
130 }
131
132 #define FILE_OP_ERROR(file, func) \
133 { \
134         fprintf(stderr, "%s: ", file); \
135         perror(func); \
136 }
137
138 /* debug functions */
139 void debug_set_mode             (gboolean mode);
140 gboolean debug_get_mode         ();
141 #define debug_print \
142         debug_print_real(__FILE__ ":%d:", __LINE__), \
143         debug_print_real
144
145 /* for macro expansion */
146 #define Str(x)  #x
147 #define Xstr(x) Str(x)
148
149 void list_free_strings          (GList          *list);
150 void slist_free_strings         (GSList         *list);
151
152 void hash_free_strings          (GHashTable     *table);
153 void hash_free_value_mem        (GHashTable     *table);
154
155 void ptr_array_free_strings     (GPtrArray      *array);
156
157 /* number-string conversion */
158 gint to_number                  (const gchar *nstr);
159 gchar *itos_buf                 (gchar       *nstr,
160                                  gint         n);
161 gchar *itos                     (gint         n);
162 gchar *to_human_readable        (off_t        size);
163
164 /* alternative string functions */
165 gint strcmp2            (const gchar    *s1,
166                          const gchar    *s2);
167 gchar *strstr2          (const gchar    *s1,
168                          const gchar    *s2);
169 gint path_cmp           (const gchar    *s1,
170                          const gchar    *s2);
171 gchar *strretchomp      (gchar          *str);
172 gchar *strtailchomp     (gchar          *str,
173                          gchar           tail_char);
174 gchar *strcrchomp       (gchar          *str);
175 gchar *strcasestr       (const gchar    *haystack,
176                          const gchar    *needle);
177 gchar *strncpy2         (gchar          *dest,
178                          const gchar    *src,
179                          size_t          n);
180
181 /* wide-character functions */
182 #if !HAVE_ISWALNUM
183 int iswalnum            (wint_t wc);
184 #endif
185 #if !HAVE_ISWSPACE
186 int iswspace            (wint_t wc);
187 #endif
188 #if !HAVE_TOWLOWER
189 wint_t towlower         (wint_t wc);
190 #endif
191
192 #if !HAVE_WCSLEN
193 size_t wcslen           (const wchar_t *s);
194 #endif
195 #if !HAVE_WCSCPY
196 wchar_t *wcscpy         (wchar_t       *dest,
197                          const wchar_t *src);
198 #endif
199 #if !HAVE_WCSNCPY
200 wchar_t *wcsncpy        (wchar_t       *dest,
201                          const wchar_t *src,
202                          size_t         n);
203 #endif
204
205 wchar_t *wcsdup                 (const wchar_t *s);
206 wchar_t *wcsndup                (const wchar_t *s,
207                                  size_t         n);
208 wchar_t *strdup_mbstowcs        (const gchar   *s);
209 gchar *strdup_wcstombs          (const wchar_t *s);
210 gint wcsncasecmp                (const wchar_t *s1,
211                                  const wchar_t *s2,
212                                  size_t         n);
213 wchar_t *wcscasestr             (const wchar_t *haystack,
214                                  const wchar_t *needle);
215
216 gboolean is_next_nonascii       (const guchar *s);
217 gint get_next_word_len          (const gchar *s);
218
219 /* functions for string parsing */
220 gint subject_compare                    (const gchar    *s1,
221                                          const gchar    *s2);
222 void trim_subject                       (gchar          *str);
223 void eliminate_parenthesis              (gchar          *str,
224                                          gchar           op,
225                                          gchar           cl);
226 void extract_parenthesis                (gchar          *str,
227                                          gchar           op,
228                                          gchar           cl);
229
230 void extract_one_parenthesis_with_skip_quote    (gchar          *str,
231                                                  gchar           quote_chr,
232                                                  gchar           op,
233                                                  gchar           cl);
234 void extract_parenthesis_with_skip_quote        (gchar          *str,
235                                                  gchar           quote_chr,
236                                                  gchar           op,
237                                                  gchar           cl);
238
239 void eliminate_quote                    (gchar          *str,
240                                          gchar           quote_chr);
241 void extract_quote                      (gchar          *str,
242                                          gchar           quote_chr);
243 void eliminate_address_comment          (gchar          *str);
244 gchar *strchr_with_skip_quote           (const gchar    *str,
245                                          gint            quote_chr,
246                                          gint            c);
247 gchar *strrchr_with_skip_quote          (const gchar    *str,
248                                          gint            quote_chr,
249                                          gint            c);
250 void extract_address                    (gchar          *str);
251
252 GSList *slist_concat_unique             (GSList         *first,
253                                          GSList         *second);
254 GSList *address_list_append             (GSList         *addr_list,
255                                          const gchar    *str);
256 GSList *references_list_append          (GSList         *msgid_list,
257                                          const gchar    *str);
258 GSList *newsgroup_list_append           (GSList         *group_list,
259                                          const gchar    *str);
260
261 GList *add_history                      (GList          *list,
262                                          const gchar    *str);
263
264 void remove_return                      (gchar          *str);
265 void remove_space                       (gchar          *str);
266 void unfold_line                        (gchar          *str);
267 void subst_char                         (gchar          *str,
268                                          gchar           orig,
269                                          gchar           subst);
270 void subst_chars                        (gchar          *str,
271                                          gchar          *orig,
272                                          gchar           subst);
273 void subst_for_filename                 (gchar          *str);
274 gboolean is_header_line                 (const gchar    *str);
275 gboolean is_ascii_str                   (const guchar   *str);
276 gint get_quote_level                    (const gchar    *str,
277                                          const gchar    *quote_chars);
278 gchar *strstr_with_skip_quote           (const gchar    *haystack,
279                                          const gchar    *needle);
280 gchar *strchr_parenthesis_close         (const gchar    *str,
281                                          gchar           op,
282                                          gchar           cl);
283
284 gchar **strsplit_parenthesis            (const gchar    *str,
285                                          gchar           op,
286                                          gchar           cl,
287                                          gint            max_tokens);
288 gchar **strsplit_with_quote             (const gchar    *str,
289                                          const gchar    *delim,
290                                          gint            max_tokens);
291
292 gchar *get_abbrev_newsgroup_name        (const gchar    *group,
293                                          gint            len);
294 gchar *trim_string                      (const gchar    *str,
295                                          gint            len);
296
297 GList *uri_list_extract_filenames       (const gchar    *uri_list);
298 void decode_uri                         (gchar          *decoded_uri,
299                                          const gchar    *encoded_uri);
300 gint scan_mailto_url                    (const gchar    *mailto,
301                                          gchar         **to,
302                                          gchar         **cc,
303                                          gchar         **bcc,
304                                          gchar         **subject,
305                                          gchar         **body);
306
307 /* return static strings */
308 gchar *get_home_dir             (void);
309 gchar *get_rc_dir               (void);
310 gchar *get_news_cache_dir       (void);
311 gchar *get_imap_cache_dir       (void);
312 gchar *get_mbox_cache_dir       (void);
313 gchar *get_mime_tmp_dir         (void);
314 gchar *get_template_dir         (void);
315 gchar *get_header_cache_dir     (void);
316 gchar *get_tmp_dir              (void);
317 gchar *get_tmp_file             (void);
318 gchar *get_domain_name          (void);
319
320 /* file / directory handling */
321 off_t get_file_size             (const gchar    *file);
322 off_t get_file_size_as_crlf     (const gchar    *file);
323 off_t get_left_file_size        (FILE           *fp);
324
325 gboolean file_exist             (const gchar    *file,
326                                  gboolean        allow_fifo);
327 gboolean is_dir_exist           (const gchar    *dir);
328 gboolean is_file_entry_exist    (const gchar    *file);
329
330 #define is_file_exist(file)             file_exist(file, FALSE)
331 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
332
333 gint change_dir                 (const gchar    *dir);
334 gint make_dir                   (const gchar    *dir);
335 gint make_dir_hier              (const gchar    *dir);
336 gint remove_all_files           (const gchar    *dir);
337 gint remove_numbered_files      (const gchar    *dir,
338                                  guint           first,
339                                  guint           last);
340 gint remove_numbered_files_not_in_list(const gchar *dir,
341                                        GSList *numberlist);
342 gint remove_all_numbered_files  (const gchar    *dir);
343 gint remove_expired_files       (const gchar    *dir,
344                                  guint           hours);
345 gint remove_dir_recursive       (const gchar    *dir);
346 gint append_file                (const gchar    *src,
347                                  const gchar    *dest,
348                                  gboolean        keep_backup);
349 gint copy_file                  (const gchar    *src,
350                                  const gchar    *dest,
351                                  gboolean        keep_backup);
352 gint move_file                  (const gchar    *src,
353                                  const gchar    *dest,
354                                  gboolean        overwrite);
355 gint copy_file_part             (FILE           *fp,
356                                  off_t           offset,
357                                  size_t          length,
358                                  const gchar    *dest);
359
360 gchar *canonicalize_str         (const gchar    *str);
361 gint canonicalize_file          (const gchar    *src,
362                                  const gchar    *dest);
363 gint canonicalize_file_replace  (const gchar    *file);
364 gint uncanonicalize_file        (const gchar    *src,
365                                  const gchar    *dest);
366 gint uncanonicalize_file_replace(const gchar    *file);
367
368 gint change_file_mode_rw        (FILE           *fp,
369                                  const gchar    *file);
370 FILE *my_tmpfile                (void);
371 FILE *str_open_as_stream        (const gchar    *str);
372 gint str_write_to_file          (const gchar    *str,
373                                  const gchar    *file);
374 gchar *file_read_to_str         (const gchar    *file);
375
376 /* process execution */
377 gint execute_async              (gchar *const    argv[]);
378 gint execute_sync               (gchar *const    argv[]);
379 gint execute_command_line       (const gchar    *cmdline,
380                                  gboolean        async);
381
382 /* open URI with external browser */
383 gint open_uri(const gchar *uri, const gchar *cmdline);
384
385 /* time functions */
386 time_t remote_tzoffset_sec      (const gchar    *zone);
387 time_t tzoffset_sec             (time_t         *now);
388 gchar *tzoffset                 (time_t         *now);
389 void get_rfc822_date            (gchar          *buf,
390                                  gint            len);
391
392 /* debugging */
393 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
394
395 /* subject threading */
396 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
397 void subject_table_insert(GHashTable *subject_table, gchar * subject,
398                           void * data);
399 void subject_table_remove(GHashTable *subject_table, gchar * subject);
400 gboolean subject_is_reply(const gchar *subject);
401
402 /* quoting recognition */
403 const gchar * line_has_quote_char       (const gchar *str,
404                                          const gchar *quote_chars);
405 const gchar * line_has_quote_char_last  (const gchar *str,
406                                          const gchar *quote_chars);
407
408 /* used in extended search */
409 gchar * expand_search_string    (const gchar *str);
410
411 guint g_stricase_hash   (gconstpointer gptr);
412 gint g_stricase_equal   (gconstpointer gptr1, gconstpointer gptr2);
413
414 #endif /* __UTILS_H__ */