Fix bug #3211 “Fails to build in Debian hurd-i386 architecture”
[claws.git] / src / common / utils.h
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2014 Hiroyuki Yamamoto and the Claws Mail team
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 3 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, see <http://www.gnu.org/licenses/>.
17  *
18  * The code of the g_utf8_substring function below is owned by
19  * Matthias Clasen <matthiasc@src.gnome.org>/<mclasen@redhat.com>
20  * and is got from GLIB 2.30
21  *
22  */
23
24 #ifndef __UTILS_H__
25 #define __UTILS_H__
26
27 #ifdef HAVE_CONFIG_H
28 #include "claws-features.h"
29 #endif
30
31 #ifdef HAVE_BACKTRACE
32 #include <execinfo.h>
33 #endif
34
35 #include <glib.h>
36 #include <glib-object.h>
37 #include <stdio.h>
38 #include <string.h>
39 #include <stdlib.h>
40 #include <unistd.h>
41 #include <sys/types.h>
42 #include <dirent.h>
43 #include <time.h>
44 #if HAVE_ALLOCA_H
45 #  include <alloca.h>
46 #endif
47 #if HAVE_WCHAR_H
48 #  include <wchar.h>
49 #endif
50
51 /* The Hurd doesn't have this limit */
52 #ifndef PATH_MAX
53   #define PATH_MAX 4196
54 #endif
55
56 #ifdef G_OS_WIN32
57
58 #define fsync _commit
59
60 #define pipe(phandles)  _pipe (phandles, 4096, _O_BINARY)
61 #endif
62 /* Wrappers for C library function that take pathname arguments. */
63 #  include <glib/gstdio.h>
64
65 /* why is this sometimes undefined !? */
66 #ifndef G_MAXOFFSET
67 typedef gint64 goffset;
68 #define G_MINOFFSET     G_MININT64
69 #define G_MAXOFFSET     G_MAXINT64
70 #endif
71
72 #ifndef HAVE_U32_TYPEDEF
73   #undef u32        /* maybe there is a macro with this name */
74   typedef guint32 u32;
75   #define HAVE_U32_TYPEDEF
76 #endif
77
78 #ifndef BIG_ENDIAN_HOST
79   #if (G_BYTE_ORDER == G_BIG_ENDIAN)
80     #define BIG_ENDIAN_HOST 1
81   #endif
82 #endif
83
84 #define CHDIR_RETURN_IF_FAIL(dir) \
85 { \
86         if (change_dir(dir) < 0) return; \
87 }
88
89 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
90 { \
91         if (change_dir(dir) < 0) return val; \
92 }
93
94 #define CHDIR_EXEC_CODE_RETURN_VAL_IF_FAIL(dir, val, code) \
95 { \
96         if (change_dir(dir) < 0) { \
97                 code \
98                 return val; \
99         } \
100 }
101
102 #define Xalloca(ptr, size, iffail) \
103 { \
104         if ((ptr = alloca(size)) == NULL) { \
105                 g_warning("can't allocate memory\n"); \
106                 iffail; \
107         } \
108 }
109
110 #define Xstrdup_a(ptr, str, iffail) \
111 { \
112         gchar *__tmp; \
113  \
114         if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
115                 g_warning("can't allocate memory\n"); \
116                 iffail; \
117         } else \
118                 strcpy(__tmp, str); \
119  \
120         ptr = __tmp; \
121 }
122
123 #define Xstrndup_a(ptr, str, len, iffail) \
124 { \
125         gchar *__tmp; \
126  \
127         if ((__tmp = alloca(len + 1)) == NULL) { \
128                 g_warning("can't allocate memory\n"); \
129                 iffail; \
130         } else { \
131                 strncpy(__tmp, str, len); \
132                 __tmp[len] = '\0'; \
133         } \
134  \
135         ptr = __tmp; \
136 }
137
138 #define Xstrcat_a(ptr, str1, str2, iffail) \
139 { \
140         gchar *__tmp; \
141         gint len1, len2; \
142  \
143         len1 = strlen(str1); \
144         len2 = strlen(str2); \
145         if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
146                 g_warning("can't allocate memory\n"); \
147                 iffail; \
148         } else { \
149                 memcpy(__tmp, str1, len1); \
150                 memcpy(__tmp + len1, str2, len2 + 1); \
151         } \
152  \
153         ptr = __tmp; \
154 }
155
156 #define AUTORELEASE_STR(str, iffail) \
157 { \
158         gchar *__str; \
159         Xstrdup_a(__str, str, iffail); \
160         g_free(str); \
161         str = __str; \
162 }
163
164 #define FILE_OP_ERROR(file, func) \
165 { \
166         g_printerr("%s: ", file); \
167         fflush(stderr); \
168         perror(func); \
169 }
170
171 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
172
173 /* from NetworkManager */
174 #if (defined(HAVE_BACKTRACE) && !defined(__FreeBSD__))
175 #define print_backtrace()                                               \
176 G_STMT_START                                                            \
177 {                                                                       \
178         void *_call_stack[512];                                         \
179         int  _call_stack_size;                                          \
180         char **_symbols;                                                \
181         _call_stack_size = backtrace (_call_stack,                      \
182                                       G_N_ELEMENTS (_call_stack));      \
183         _symbols = backtrace_symbols (_call_stack, _call_stack_size);   \
184         if (_symbols != NULL)                                           \
185         {                                                               \
186                 int _i;                                                 \
187                 _i = 0;                                                 \
188                 g_print ("traceback:\n");                               \
189                 while (_i < _call_stack_size)                           \
190                 {                                                       \
191                         g_print ("%d:\t%s\n", _i, _symbols[_i]);        \
192                         _i++;                                           \
193                 }                                                       \
194                 free (_symbols);                                        \
195         }                                                               \
196 }                                                                       \
197 G_STMT_END
198 #else
199 #define print_backtrace()                                               \
200 G_STMT_START                                                            \
201 {                                                                       \
202 }                                                                       \
203 G_STMT_END
204 #endif
205
206
207 #define cm_return_val_if_fail(expr,val) G_STMT_START {                  \
208         if (!(expr)) {                                                  \
209                 g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
210                 print_backtrace();                                      \
211                 g_print("\n");                                          \
212                 return val;                                             \
213         }                                                               \
214 } G_STMT_END
215
216 #define cm_return_if_fail(expr) G_STMT_START {                          \
217         if (!(expr)) {                                                  \
218                 g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
219                 print_backtrace();                                      \
220                 g_print("\n");                                          \
221                 return;                                                 \
222         }                                                               \
223 } G_STMT_END
224
225 #ifdef __cplusplus
226 extern "C" {
227 #endif
228
229 typedef gpointer (*GNodeMapFunc)        (gpointer nodedata, gpointer data);
230
231 /* debug functions */
232 void debug_set_mode             (gboolean mode);
233 gboolean debug_get_mode         (void);
234
235 #ifndef __CYGWIN__
236 #define debug_print \
237         debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
238         debug_print_real
239 #else
240   /* FIXME: cygwin: why debug_srcname couldn't be resolved in library? */
241 #define debug_print \
242         debug_print_real("%s:%d:", __FILE__, __LINE__), \
243         debug_print_real
244 #endif
245
246 /* for macro expansion */
247 #define Str(x)  #x
248 #define Xstr(x) Str(x)
249
250
251 /* System related stuff.  */
252
253 gboolean superuser_p (void);
254
255 /* List utilities. */
256
257 GSList *slist_copy_deep         (GSList         *list,
258                                  GCopyFunc       func);
259
260 /* String utilities.  */
261
262 void list_free_strings          (GList          *list);
263 void slist_free_strings         (GSList         *list);
264 void slist_free_strings_full    (GSList         *list);
265
266 void hash_free_strings          (GHashTable     *table);
267
268 gint str_case_equal             (gconstpointer   v,
269                                  gconstpointer   v2);
270 guint str_case_hash             (gconstpointer   key);
271
272 void ptr_array_free_strings     (GPtrArray      *array);
273
274 /* number-string conversion */
275 gint to_number                  (const gchar *nstr);
276 gchar *itos_buf                 (gchar       *nstr,
277                                  gint         n);
278 gchar *itos                     (gint         n);
279 gchar *to_human_readable        (goffset      size);
280
281 /* alternative string functions */
282 gint strcmp2            (const gchar    *s1,
283                          const gchar    *s2);
284 gchar *strstr2          (const gchar    *s1,
285                          const gchar    *s2);
286 gint path_cmp           (const gchar    *s1,
287                          const gchar    *s2);
288 gchar *strretchomp      (gchar          *str);
289 gchar *strtailchomp     (gchar          *str,
290                          gchar           tail_char);
291 gchar *strcrchomp       (gchar          *str);
292 gint file_strip_crs     (const gchar    *file);
293 gchar *strcasestr       (const gchar    *haystack,
294                          const gchar    *needle);
295 gchar *strncasestr      (const gchar    *haystack,
296                          gint            haystack_len,
297                          const gchar    *needle);
298 gpointer my_memmem      (gconstpointer   haystack,
299                          size_t          haystacklen,
300                          gconstpointer   needle,
301                          size_t          needlelen);
302 gchar *strncpy2         (gchar          *dest,
303                          const gchar    *src,
304                          size_t          n);
305
306 gboolean is_next_nonascii       (const gchar *s);
307 gint get_next_word_len          (const gchar *s);
308
309 /* functions for string parsing */
310 gint subject_compare                    (const gchar    *s1,
311                                          const gchar    *s2);
312 gint subject_compare_for_sort           (const gchar    *s1,
313                                          const gchar    *s2);
314 void trim_subject                       (gchar          *str);
315 void eliminate_parenthesis              (gchar          *str,
316                                          gchar           op,
317                                          gchar           cl);
318 void extract_parenthesis                (gchar          *str,
319                                          gchar           op,
320                                          gchar           cl);
321
322 void extract_quote                      (gchar          *str,
323                                          gchar           quote_chr);
324 gchar *escape_internal_quotes           (gchar          *str,
325                                          gchar           quote_chr);
326 void eliminate_address_comment          (gchar          *str);
327 gchar *strchr_with_skip_quote           (const gchar    *str,
328                                          gint            quote_chr,
329                                          gint            c);
330 void extract_address                    (gchar          *str);
331 void extract_list_id_str                (gchar          *str);
332
333 GSList *address_list_append             (GSList         *addr_list,
334                                          const gchar    *str);
335 GSList *address_list_append_with_comments(GSList        *addr_list,
336                                          const gchar    *str);
337 GSList *references_list_prepend         (GSList         *msgid_list,
338                                          const gchar    *str);
339 GSList *references_list_append          (GSList         *msgid_list,
340                                          const gchar    *str);
341 GSList *newsgroup_list_append           (GSList         *group_list,
342                                          const gchar    *str);
343
344 GList *add_history                      (GList          *list,
345                                          const gchar    *str);
346
347 void remove_return                      (gchar          *str);
348 void remove_space                       (gchar          *str);
349 void unfold_line                        (gchar          *str);
350 void subst_char                         (gchar          *str,
351                                          gchar           orig,
352                                          gchar           subst);
353 void subst_chars                        (gchar          *str,   
354                                          gchar          *orig, 
355                                          gchar          subst);
356 void subst_for_filename                 (gchar          *str);
357 void subst_for_shellsafe_filename       (gchar          *str);
358 gboolean is_ascii_str                   (const gchar    *str);
359 gint get_quote_level                    (const gchar    *str,
360                                          const gchar    *quote_chars);
361 gint check_line_length                  (const gchar    *str,
362                                          gint            max_chars,
363                                          gint           *line);
364
365 gchar **strsplit_with_quote             (const gchar    *str,
366                                          const gchar    *delim,
367                                          gint            max_tokens);
368
369 gchar *get_abbrev_newsgroup_name        (const gchar    *group,
370                                          gint            len);
371 gchar *trim_string                      (const gchar    *str,
372                                          gint            len);
373
374 GList *uri_list_extract_filenames       (const gchar    *uri_list);
375 gboolean is_uri_string                  (const gchar    *str);
376 gchar *get_uri_path                     (const gchar    *uri);
377 gint get_uri_len                        (const gchar    *str);
378 void decode_uri                         (gchar          *decoded_uri,
379                                          const gchar    *encoded_uri);
380 void decode_uri_with_plus               (gchar          *decoded_uri, 
381                                          const gchar    *encoded_uri, 
382                                          gboolean        with_plus);
383 gint scan_mailto_url                    (const gchar    *mailto,
384                                          gchar         **from,
385                                          gchar         **to,
386                                          gchar         **cc,
387                                          gchar         **bcc,
388                                          gchar         **subject,
389                                          gchar         **body,
390                                          gchar         ***attach,
391                                          gchar         **inreplyto);
392
393 /* return static strings */
394 const gchar *get_home_dir               (void);
395 const gchar *get_rc_dir                 (void);
396 void  set_rc_dir                        (const gchar *dir);
397 gboolean rc_dir_is_alt                  (void);
398 const gchar *get_mail_base_dir          (void);
399 const gchar *get_news_cache_dir         (void);
400 const gchar *get_imap_cache_dir         (void);
401 const gchar *get_mime_tmp_dir           (void);
402 const gchar *get_template_dir           (void);
403 const gchar *get_plugin_dir             (void);
404 const gchar *get_tmp_dir                (void);
405 const gchar *get_locale_dir             (void);
406 gchar *get_tmp_file                     (void);
407 const gchar *get_domain_name            (void);
408 const gchar *get_desktop_file(void);
409 #ifdef G_OS_WIN32
410 const gchar *get_themes_dir             (void);
411 const gchar *get_cert_file              (void);
412 #endif
413 /* file / directory handling */
414 off_t get_file_size             (const gchar    *file);
415 off_t get_file_size_as_crlf     (const gchar    *file);
416
417 time_t get_file_mtime           (const gchar *file);
418
419 gboolean file_exist             (const gchar    *file,
420                                  gboolean        allow_fifo);
421 gboolean is_relative_filename   (const gchar *file);
422 gboolean is_dir_exist           (const gchar    *dir);
423 gboolean is_file_entry_exist    (const gchar    *file);
424 gboolean dirent_is_regular_file (struct dirent  *d);
425
426 #define is_file_exist(file)             file_exist(file, FALSE)
427 #define is_file_or_fifo_exist(file)     file_exist(file, TRUE)
428
429 gint change_dir                 (const gchar    *dir);
430 gint make_dir                   (const gchar    *dir);
431 gint make_dir_hier              (const gchar    *dir);
432 gint remove_all_files           (const gchar    *dir);
433 gint remove_numbered_files      (const gchar    *dir,
434                                  guint           first,
435                                  guint           last);
436 gint remove_numbered_files_not_in_list(const gchar *dir,
437                                        GSList *numberlist);
438 gint remove_all_numbered_files  (const gchar    *dir);
439 gint remove_dir_recursive       (const gchar    *dir);
440 gint append_file                (const gchar    *src,
441                                  const gchar    *dest,
442                                  gboolean        keep_backup);
443 gint rename_force               (const gchar    *oldpath,
444                                  const gchar    *newpath);
445 gint copy_file                  (const gchar    *src,
446                                  const gchar    *dest,
447                                  gboolean        keep_backup);
448 gint move_file                  (const gchar    *src,
449                                  const gchar    *dest,
450                                  gboolean        overwrite);
451 gint copy_dir                   (const gchar    *src,
452                                  const gchar    *dest);
453 gint copy_file_part_to_fp       (FILE           *fp,
454                                  off_t           offset,
455                                  size_t          length,
456                                  FILE           *dest_fp);
457 gint copy_file_part             (FILE           *fp,
458                                  off_t           offset,
459                                  size_t          length,
460                                  const gchar    *dest);
461
462 gchar *canonicalize_str         (const gchar    *str);
463 gint canonicalize_file          (const gchar    *src,
464                                  const gchar    *dest);
465 gint canonicalize_file_replace  (const gchar    *file);
466
467 gchar *normalize_newlines       (const gchar    *str);
468
469 gchar *get_outgoing_rfc2822_str (FILE           *fp);
470
471 gint change_file_mode_rw        (FILE           *fp,
472                                  const gchar    *file);
473 FILE *my_tmpfile                (void);
474 FILE *get_tmpfile_in_dir        (const gchar    *dir,
475                                  gchar         **filename);
476 FILE *str_open_as_stream        (const gchar    *str);
477 gint str_write_to_file          (const gchar    *str,
478                                  const gchar    *file);
479 gchar *file_read_to_str         (const gchar    *file);
480 gchar *file_read_stream_to_str  (FILE           *fp);
481 gchar *file_read_to_str_no_recode(const gchar *file);
482 gchar *file_read_stream_to_str_no_recode(FILE *fp);
483
484 char *fgets_crlf(char *buf, int size, FILE *stream);
485
486 /* process execution */
487 gint execute_command_line       (const gchar    *cmdline,
488                                  gboolean        async);
489 gchar *get_command_output       (const gchar    *cmdline);
490
491 /* open URI with external browser */
492 gint open_uri(const gchar *uri, const gchar *cmdline);
493 /* open file with text editor */
494 gint open_txt_editor(const gchar *filepath, const gchar *cmdline);
495
496 /* time functions */
497 time_t remote_tzoffset_sec      (const gchar    *zone);
498 time_t tzoffset_sec             (time_t         *now);
499 gchar *tzoffset                 (time_t         *now);
500 void get_rfc822_date            (gchar          *buf,
501                                  gint            len);
502
503 size_t fast_strftime            (gchar                  *buf, 
504                                  gint                    buflen, 
505                                  const gchar            *format, 
506                                  struct tm              *lt);
507
508 /* debugging */
509 void debug_print_real   (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
510 const char * debug_srcname (const char *file);
511
512 /* subject threading */
513 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
514 void subject_table_insert(GHashTable *subject_table, gchar * subject,
515                           void * data);
516 void subject_table_remove(GHashTable *subject_table, gchar * subject);
517 void utils_free_regex(void);
518 gint subject_get_prefix_length (const gchar *subject);
519
520 /* quoting recognition */
521 const gchar * line_has_quote_char       (const gchar *str,
522                                          const gchar *quote_chars);
523
524 gint g_int_compare      (gconstpointer a, gconstpointer b);
525
526 gchar *generate_msgid           (gchar *buf, gint len, gchar *user_addr);
527 gchar *generate_mime_boundary   (const gchar *prefix);
528
529 gint quote_cmd_argument(gchar * result, guint size,
530                         const gchar * path);
531 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
532
533 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
534 void get_hex_str(gchar *out, guchar ch);
535
536 /* auto pointer for containers that support GType system */
537
538 #define G_TYPE_AUTO_POINTER     g_auto_pointer_register()
539 typedef struct AutoPointer      GAuto;
540 GType g_auto_pointer_register           (void);
541 GAuto *g_auto_pointer_new               (gpointer pointer);
542 GAuto *g_auto_pointer_new_with_free     (gpointer p, 
543                                          GFreeFunc free);
544 gpointer g_auto_pointer_get_ptr         (GAuto *auto_ptr);
545 GAuto *g_auto_pointer_copy              (GAuto *auto_ptr);
546 void g_auto_pointer_free                (GAuto *auto_ptr);
547 void replace_returns                    (gchar *str);
548 gboolean get_uri_part   (const gchar *start,
549                          const gchar *scanpos,
550                          const gchar **bp,
551                          const gchar **ep,
552                          gboolean hdr);
553 gchar *make_uri_string  (const gchar *bp,
554                          const gchar *ep);
555 gboolean get_email_part (const gchar *start, 
556                          const gchar *scanpos,
557                          const gchar **bp, 
558                          const gchar **ep,
559                          gboolean hdr);
560 gchar *make_email_string(const gchar *bp,
561                          const gchar *ep);
562 gchar *make_http_string (const gchar *bp,
563                          const gchar *ep);
564
565 gchar *mailcap_get_command_for_type(const gchar *type, 
566                                     const gchar *file_to_open);
567 void mailcap_update_default        (const gchar *type,
568                                     const gchar *command);
569
570 gboolean file_is_email(const gchar *filename);
571 gboolean sc_g_list_bigger(GList *list, gint max);
572 gboolean sc_g_slist_bigger(GSList *list, gint max);
573
574 int claws_unlink(const gchar *filename);
575
576 GMutex *cm_mutex_new(void);
577 void cm_mutex_free(GMutex *mutex);
578
579 int cm_canonicalize_filename(const gchar *filename, gchar **canonical_name);
580
581 #if !GLIB_CHECK_VERSION(2, 30, 0)
582 gchar   *g_utf8_substring         (const gchar *p,
583                                    glong        start_pos,
584                                    glong        end_pos) G_GNUC_MALLOC;
585 #endif
586
587 #ifdef __cplusplus
588 }
589 #endif
590
591 #endif /* __UTILS_H__ */