2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2016 Hiroyuki Yamamoto and the Claws Mail team
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.
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.
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/>.
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
27 #include "claws-features.h"
35 #include <glib-object.h>
40 #include <sys/types.h>
50 /* The Hurd doesn't have these limits */
55 #define HOST_NAME_MAX 256
62 #define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
64 /* Wrappers for C library function that take pathname arguments. */
65 # include <glib/gstdio.h>
67 /* why is this sometimes undefined !? */
69 typedef gint64 goffset;
70 #define G_MINOFFSET G_MININT64
71 #define G_MAXOFFSET G_MAXINT64
74 #ifndef BIG_ENDIAN_HOST
75 #if (G_BYTE_ORDER == G_BIG_ENDIAN)
76 #define BIG_ENDIAN_HOST 1
80 #define CHDIR_RETURN_IF_FAIL(dir) \
82 if (change_dir(dir) < 0) return; \
85 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
87 if (change_dir(dir) < 0) return val; \
90 #define CHDIR_EXEC_CODE_RETURN_VAL_IF_FAIL(dir, val, code) \
92 if (change_dir(dir) < 0) { \
98 #define Xalloca(ptr, size, iffail) \
100 if ((ptr = alloca(size)) == NULL) { \
101 g_warning("can't allocate memory"); \
106 #define Xstrdup_a(ptr, str, iffail) \
110 if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
111 g_warning("can't allocate memory"); \
114 strcpy(__tmp, str); \
119 #define Xstrndup_a(ptr, str, len, iffail) \
123 if ((__tmp = alloca(len + 1)) == NULL) { \
124 g_warning("can't allocate memory"); \
127 memcpy(__tmp, str, len); \
134 #define Xstrcat_a(ptr, str1, str2, iffail) \
139 len1 = strlen(str1); \
140 len2 = strlen(str2); \
141 if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
142 g_warning("can't allocate memory"); \
145 memcpy(__tmp, str1, len1); \
146 memcpy(__tmp + len1, str2, len2 + 1); \
152 #define AUTORELEASE_STR(str, iffail) \
155 Xstrdup_a(__str, str, iffail); \
160 #define FILE_OP_ERROR(file, func) \
162 g_printerr("%s: ", file); \
167 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
169 /* from NetworkManager */
170 #if (defined(HAVE_BACKTRACE) && !defined(__FreeBSD__))
171 #define print_backtrace() \
174 void *_call_stack[512]; \
175 int _call_stack_size; \
177 _call_stack_size = backtrace (_call_stack, \
178 G_N_ELEMENTS (_call_stack)); \
179 _symbols = backtrace_symbols (_call_stack, _call_stack_size); \
180 if (_symbols != NULL) \
184 g_print ("traceback:\n"); \
185 while (_i < _call_stack_size) \
187 g_print ("%d:\t%s\n", _i, _symbols[_i]); \
195 #define print_backtrace() \
203 #define cm_return_val_if_fail(expr,val) G_STMT_START { \
205 g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
212 #define cm_return_if_fail(expr) G_STMT_START { \
214 g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
222 #define MIN(a, b) ((a) < (b) ? (a) : (b))
225 #define MAX(a, b) ((a) > (b) ? (a) : (b))
232 typedef gpointer (*GNodeMapFunc) (gpointer nodedata, gpointer data);
234 /* debug functions */
235 void debug_set_mode (gboolean mode);
236 gboolean debug_get_mode (void);
239 #define debug_print \
240 debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
243 /* FIXME: cygwin: why debug_srcname couldn't be resolved in library? */
244 #define debug_print \
245 debug_print_real("%s:%d:", __FILE__, __LINE__), \
249 /* for macro expansion */
251 #define Xstr(x) Str(x)
253 /* List utilities. */
255 GSList *slist_copy_deep (GSList *list,
258 /* String utilities. */
260 void list_free_strings_full (GList *list);
261 void slist_free_strings_full (GSList *list);
263 void hash_free_strings (GHashTable *table);
265 gint str_case_equal (gconstpointer v,
267 guint str_case_hash (gconstpointer key);
269 /* number-string conversion */
270 gint to_number (const gchar *nstr);
271 gchar *itos_buf (gchar *nstr,
273 gchar *itos (gint n);
274 gchar *to_human_readable (goffset size);
276 /* alternative string functions */
277 gint path_cmp (const gchar *s1,
279 gchar *strretchomp (gchar *str);
280 gchar *strtailchomp (gchar *str,
282 gchar *strcrchomp (gchar *str);
283 gchar *strcasestr (const gchar *haystack,
284 const gchar *needle);
285 gchar *strncasestr (const gchar *haystack,
287 const gchar *needle);
288 gpointer my_memmem (gconstpointer haystack,
290 gconstpointer needle,
292 gchar *strncpy2 (gchar *dest,
296 gboolean is_next_nonascii (const gchar *s);
297 gint get_next_word_len (const gchar *s);
299 /* functions for string parsing */
300 gint subject_compare (const gchar *s1,
302 gint subject_compare_for_sort (const gchar *s1,
304 void trim_subject (gchar *str);
305 void eliminate_parenthesis (gchar *str,
308 void extract_parenthesis (gchar *str,
312 void extract_quote (gchar *str,
314 gchar *escape_internal_quotes (gchar *str,
316 void eliminate_address_comment (gchar *str);
317 gchar *strchr_with_skip_quote (const gchar *str,
320 void extract_address (gchar *str);
321 void extract_list_id_str (gchar *str);
323 GSList *address_list_append (GSList *addr_list,
325 GSList *address_list_append_with_comments(GSList *addr_list,
327 GSList *references_list_prepend (GSList *msgid_list,
329 GSList *references_list_append (GSList *msgid_list,
331 GSList *newsgroup_list_append (GSList *group_list,
334 GList *add_history (GList *list,
337 void remove_return (gchar *str);
338 void remove_space (gchar *str);
339 void unfold_line (gchar *str);
340 void subst_char (gchar *str,
343 void subst_chars (gchar *str,
346 void subst_for_filename (gchar *str);
347 void subst_for_shellsafe_filename (gchar *str);
348 gboolean is_ascii_str (const gchar *str);
349 gint get_quote_level (const gchar *str,
350 const gchar *quote_chars);
351 gint check_line_length (const gchar *str,
355 gchar **strsplit_with_quote (const gchar *str,
359 gchar *get_abbrev_newsgroup_name (const gchar *group,
361 gchar *trim_string (const gchar *str,
364 GList *uri_list_extract_filenames (const gchar *uri_list);
365 gboolean is_uri_string (const gchar *str);
366 gchar *get_uri_path (const gchar *uri);
367 gint get_uri_len (const gchar *str);
368 void decode_uri (gchar *decoded_uri,
369 const gchar *encoded_uri);
370 void decode_uri_with_plus (gchar *decoded_uri,
371 const gchar *encoded_uri,
373 gint scan_mailto_url (const gchar *mailto,
383 /* return static strings */
384 const gchar *get_home_dir (void);
385 const gchar *get_rc_dir (void);
386 void set_rc_dir (const gchar *dir);
387 gboolean rc_dir_is_alt (void);
388 const gchar *get_mail_base_dir (void);
389 const gchar *get_news_cache_dir (void);
390 const gchar *get_imap_cache_dir (void);
391 const gchar *get_mime_tmp_dir (void);
392 const gchar *get_template_dir (void);
393 const gchar *get_plugin_dir (void);
394 const gchar *get_tmp_dir (void);
395 const gchar *get_locale_dir (void);
396 gchar *get_tmp_file (void);
397 const gchar *get_domain_name (void);
398 gboolean is_numeric_host_address (const gchar *hostaddress);
399 const gchar *get_desktop_file(void);
401 const gchar *w32_get_themes_dir (void);
402 const gchar *w32_get_cert_file (void);
404 /* file / directory handling */
405 off_t get_file_size (const gchar *file);
406 time_t get_file_mtime (const gchar *file);
408 gboolean file_exist (const gchar *file,
409 gboolean allow_fifo);
410 gboolean is_relative_filename (const gchar *file);
411 gboolean is_dir_exist (const gchar *dir);
412 gboolean is_file_entry_exist (const gchar *file);
413 gboolean dirent_is_regular_file (struct dirent *d);
415 #define is_file_exist(file) file_exist(file, FALSE)
416 #define is_file_or_fifo_exist(file) file_exist(file, TRUE)
418 gint change_dir (const gchar *dir);
419 gint make_dir (const gchar *dir);
420 gint make_dir_hier (const gchar *dir);
421 gint remove_all_files (const gchar *dir);
422 gint remove_numbered_files (const gchar *dir,
425 gint remove_numbered_files_not_in_list(const gchar *dir,
427 gint remove_all_numbered_files (const gchar *dir);
428 gint remove_dir_recursive (const gchar *dir);
429 gchar *canonicalize_str (const gchar *str);
430 gchar *normalize_newlines (const gchar *str);
432 gchar *get_outgoing_rfc2822_str (FILE *fp);
434 char *fgets_crlf(char *buf, int size, FILE *stream);
436 /* process execution */
437 gint execute_command_line (const gchar *cmdline,
439 const gchar *working_directory);
440 gchar *get_command_output (const gchar *cmdline);
442 /* open URI with external browser */
443 gint open_uri(const gchar *uri, const gchar *cmdline);
444 /* open file with text editor */
445 gint open_txt_editor(const gchar *filepath, const gchar *cmdline);
448 time_t remote_tzoffset_sec (const gchar *zone);
449 time_t tzoffset_sec (time_t *now);
450 gchar *tzoffset (time_t *now);
451 void get_rfc822_date (gchar *buf,
453 void get_rfc822_date_hide_tz (gchar *buf,
456 size_t fast_strftime (gchar *buf,
462 void debug_print_real (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
463 const char * debug_srcname (const char *file);
465 /* subject threading */
466 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
467 void subject_table_insert(GHashTable *subject_table, gchar * subject,
469 void subject_table_remove(GHashTable *subject_table, gchar * subject);
470 void utils_free_regex(void);
471 gint subject_get_prefix_length (const gchar *subject);
473 /* quoting recognition */
474 const gchar * line_has_quote_char (const gchar *str,
475 const gchar *quote_chars);
477 gint g_int_compare (gconstpointer a, gconstpointer b);
479 gchar *generate_mime_boundary (const gchar *prefix);
481 gint quote_cmd_argument(gchar * result, guint size,
483 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
485 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
486 void get_hex_str(gchar *out, guchar ch);
488 /* auto pointer for containers that support GType system */
490 #define G_TYPE_AUTO_POINTER g_auto_pointer_register()
491 typedef struct AutoPointer GAuto;
492 GType g_auto_pointer_register (void);
493 GAuto *g_auto_pointer_new (gpointer pointer);
494 GAuto *g_auto_pointer_new_with_free (gpointer p,
496 gpointer g_auto_pointer_get_ptr (GAuto *auto_ptr);
497 GAuto *g_auto_pointer_copy (GAuto *auto_ptr);
498 void g_auto_pointer_free (GAuto *auto_ptr);
499 void replace_returns (gchar *str);
500 gboolean get_uri_part (const gchar *start,
501 const gchar *scanpos,
505 gchar *make_uri_string (const gchar *bp,
507 gboolean get_email_part (const gchar *start,
508 const gchar *scanpos,
512 gchar *make_email_string(const gchar *bp,
514 gchar *make_http_string (const gchar *bp,
517 gchar *mailcap_get_command_for_type(const gchar *type,
518 const gchar *file_to_open);
519 void mailcap_update_default (const gchar *type,
520 const gchar *command);
522 gboolean file_is_email(const gchar *filename);
523 gboolean sc_g_list_bigger(GList *list, gint max);
524 gboolean sc_g_slist_bigger(GSList *list, gint max);
526 GMutex *cm_mutex_new(void);
527 void cm_mutex_free(GMutex *mutex);
529 int cm_canonicalize_filename(const gchar *filename, gchar **canonical_name);
531 guchar *g_base64_decode_zero(const gchar *text, gsize *out_len);
533 #if !GLIB_CHECK_VERSION(2, 30, 0)
534 gchar *g_utf8_substring (const gchar *p,
536 glong end_pos) G_GNUC_MALLOC;
539 gboolean get_random_bytes(void *buf, size_t count);
545 gboolean get_serverportfp_from_filename(const gchar *str, gchar **server, gchar **port, gchar **fp);
547 #endif /* __UTILS_H__ */