2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2020 The Claws Mail Team and Hiroyuki Yamamoto
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"
36 #include <glib-object.h>
41 #include <sys/types.h>
51 /* The Hurd doesn't have these limits */
56 #define HOST_NAME_MAX 256
63 #define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
65 /* Wrappers for C library function that take pathname arguments. */
66 # include <glib/gstdio.h>
68 /* why is this sometimes undefined !? */
70 typedef gint64 goffset;
71 #define G_MINOFFSET G_MININT64
72 #define G_MAXOFFSET G_MAXINT64
75 #ifndef BIG_ENDIAN_HOST
76 #if (G_BYTE_ORDER == G_BIG_ENDIAN)
77 #define BIG_ENDIAN_HOST 1
81 #define CHDIR_RETURN_IF_FAIL(dir) \
83 if (change_dir(dir) < 0) return; \
86 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
88 if (change_dir(dir) < 0) return val; \
91 #define CHDIR_EXEC_CODE_RETURN_VAL_IF_FAIL(dir, val, code) \
93 if (change_dir(dir) < 0) { \
99 #define Xalloca(ptr, size, iffail) \
101 if ((ptr = alloca(size)) == NULL) { \
102 g_warning("can't allocate memory"); \
107 #define Xstrdup_a(ptr, str, iffail) \
111 if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
112 g_warning("can't allocate memory"); \
115 strcpy(__tmp, str); \
120 #define Xstrndup_a(ptr, str, len, iffail) \
124 if ((__tmp = alloca(len + 1)) == NULL) { \
125 g_warning("can't allocate memory"); \
128 memcpy(__tmp, str, len); \
135 #define Xstrcat_a(ptr, str1, str2, iffail) \
140 len1 = strlen(str1); \
141 len2 = strlen(str2); \
142 if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
143 g_warning("can't allocate memory"); \
146 memcpy(__tmp, str1, len1); \
147 memcpy(__tmp + len1, str2, len2 + 1); \
153 #define AUTORELEASE_STR(str, iffail) \
156 Xstrdup_a(__str, str, iffail); \
161 #define FILE_OP_ERROR(file, func) \
163 g_printerr("%s: ", file); \
168 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
170 /* from NetworkManager */
171 #if (defined(HAVE_BACKTRACE) && !defined(__FreeBSD__))
172 #define print_backtrace() \
175 void *_call_stack[512]; \
176 int _call_stack_size; \
178 _call_stack_size = backtrace (_call_stack, \
179 G_N_ELEMENTS (_call_stack)); \
180 _symbols = backtrace_symbols (_call_stack, _call_stack_size); \
181 if (_symbols != NULL) \
185 g_print ("traceback:\n"); \
186 while (_i < _call_stack_size) \
188 g_print ("%d:\t%s\n", _i, _symbols[_i]); \
196 #define print_backtrace() \
204 #define cm_return_val_if_fail(expr,val) G_STMT_START { \
206 g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
213 #define cm_return_if_fail(expr) G_STMT_START { \
215 g_print("%s:%d Condition %s failed\n", __FILE__, __LINE__, #expr);\
223 #define MIN(a, b) ((a) < (b) ? (a) : (b))
226 #define MAX(a, b) ((a) > (b) ? (a) : (b))
233 typedef gpointer (*GNodeMapFunc) (gpointer nodedata, gpointer data);
235 /* debug functions */
236 void debug_set_mode (gboolean mode);
237 gboolean debug_get_mode (void);
240 #define debug_print \
241 debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
244 /* FIXME: cygwin: why debug_srcname couldn't be resolved in library? */
245 #define debug_print \
246 debug_print_real("%s:%d:", __FILE__, __LINE__), \
250 /* for macro expansion */
252 #define Xstr(x) Str(x)
254 /* List utilities. */
256 GSList *slist_copy_deep (GSList *list,
259 /* String utilities. */
261 void list_free_strings_full (GList *list);
262 void slist_free_strings_full (GSList *list);
264 void hash_free_strings (GHashTable *table);
266 gint str_case_equal (gconstpointer v,
268 guint str_case_hash (gconstpointer key);
270 /* number-string conversion */
271 gint to_number (const gchar *nstr);
272 gchar *itos_buf (gchar *nstr,
274 gchar *itos (gint n);
275 gchar *to_human_readable (goffset size);
277 /* alternative string functions */
278 gint path_cmp (const gchar *s1,
280 gchar *strretchomp (gchar *str);
281 gchar *strtailchomp (gchar *str,
283 gchar *strcrchomp (gchar *str);
284 #ifndef HAVE_STRCASESTR
285 gchar *strcasestr (const gchar *haystack,
286 const gchar *needle);
287 #endif /* HAVE_STRCASESTR */
288 gchar *strncasestr (const gchar *haystack,
290 const gchar *needle);
291 gpointer my_memmem (gconstpointer haystack,
293 gconstpointer needle,
295 gchar *strncpy2 (gchar *dest,
299 gboolean is_next_nonascii (const gchar *s);
300 gint get_next_word_len (const gchar *s);
302 /* functions for string parsing */
303 gint subject_compare (const gchar *s1,
305 gint subject_compare_for_sort (const gchar *s1,
307 void trim_subject (gchar *str);
308 void eliminate_parenthesis (gchar *str,
311 void extract_parenthesis (gchar *str,
315 void extract_quote (gchar *str,
317 gchar *escape_internal_quotes (gchar *str,
319 void eliminate_address_comment (gchar *str);
320 gchar *strchr_with_skip_quote (const gchar *str,
323 void extract_address (gchar *str);
324 void extract_list_id_str (gchar *str);
326 GSList *address_list_append (GSList *addr_list,
328 GSList *address_list_append_with_comments(GSList *addr_list,
330 GSList *references_list_prepend (GSList *msgid_list,
332 GSList *references_list_append (GSList *msgid_list,
334 GSList *newsgroup_list_append (GSList *group_list,
337 GList *add_history (GList *list,
340 void remove_return (gchar *str);
341 void remove_space (gchar *str);
342 void unfold_line (gchar *str);
343 void subst_char (gchar *str,
346 void subst_chars (gchar *str,
349 void subst_for_filename (gchar *str);
350 void subst_for_shellsafe_filename (gchar *str);
351 gboolean is_ascii_str (const gchar *str);
352 gint get_quote_level (const gchar *str,
353 const gchar *quote_chars);
354 gint check_line_length (const gchar *str,
358 gchar **strsplit_with_quote (const gchar *str,
362 gchar *get_abbrev_newsgroup_name (const gchar *group,
364 gchar *trim_string (const gchar *str,
367 GList *uri_list_extract_filenames (const gchar *uri_list);
368 gboolean is_uri_string (const gchar *str);
369 gchar *get_uri_path (const gchar *uri);
370 gint get_uri_len (const gchar *str);
371 void decode_uri (gchar *decoded_uri,
372 const gchar *encoded_uri);
373 void decode_uri_with_plus (gchar *decoded_uri,
374 const gchar *encoded_uri,
376 gint scan_mailto_url (const gchar *mailto,
386 /* return static strings */
387 const gchar *get_home_dir (void);
388 const gchar *get_rc_dir (void);
389 void set_rc_dir (const gchar *dir);
390 gboolean rc_dir_is_alt (void);
391 const gchar *get_mail_base_dir (void);
392 const gchar *get_news_cache_dir (void);
393 const gchar *get_imap_cache_dir (void);
394 const gchar *get_mime_tmp_dir (void);
395 const gchar *get_template_dir (void);
396 const gchar *get_plugin_dir (void);
397 const gchar *get_tmp_dir (void);
398 const gchar *get_locale_dir (void);
399 gchar *get_tmp_file (void);
400 const gchar *get_domain_name (void);
401 gboolean is_numeric_host_address (const gchar *hostaddress);
402 const gchar *get_desktop_file(void);
404 const gchar *w32_get_themes_dir (void);
405 const gchar *w32_get_cert_file (void);
407 /* file / directory handling */
408 off_t get_file_size (const gchar *file);
409 time_t get_file_mtime (const gchar *file);
411 gboolean file_exist (const gchar *file,
412 gboolean allow_fifo);
413 gboolean is_relative_filename (const gchar *file);
414 gboolean is_dir_exist (const gchar *dir);
415 gboolean is_file_entry_exist (const gchar *file);
416 gboolean is_file_entry_regular(const gchar *file);
417 gboolean dirent_is_regular_file (struct dirent *d);
419 #define is_file_exist(file) file_exist(file, FALSE)
420 #define is_file_or_fifo_exist(file) file_exist(file, TRUE)
422 gint change_dir (const gchar *dir);
423 gint make_dir (const gchar *dir);
424 gint make_dir_hier (const gchar *dir);
425 gint remove_all_files (const gchar *dir);
426 gint remove_numbered_files (const gchar *dir,
429 gint remove_numbered_files_not_in_list(const gchar *dir,
431 gint remove_all_numbered_files (const gchar *dir);
432 gint remove_dir_recursive (const gchar *dir);
433 gchar *canonicalize_str (const gchar *str);
434 gchar *normalize_newlines (const gchar *str);
436 gchar *get_outgoing_rfc2822_str (FILE *fp);
438 char *fgets_crlf(char *buf, int size, FILE *stream);
440 /* process execution */
441 gint execute_command_line (const gchar *cmdline,
443 const gchar *working_directory);
444 gchar *get_command_output (const gchar *cmdline);
445 FILE *get_command_output_stream (const gchar *cmdline);
447 /* open URI with external browser */
448 gint open_uri(const gchar *uri, const gchar *cmdline);
449 /* open file with text editor */
450 gint open_txt_editor(const gchar *filepath, const gchar *cmdline);
453 time_t remote_tzoffset_sec (const gchar *zone);
454 time_t tzoffset_sec (time_t *now);
455 gchar *tzoffset (time_t *now);
456 void get_rfc822_date (gchar *buf,
458 void get_rfc822_date_hide_tz (gchar *buf,
461 size_t fast_strftime (gchar *buf,
467 void debug_print_real (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
468 const char * debug_srcname (const char *file);
470 /* subject threading */
471 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
472 void subject_table_insert(GHashTable *subject_table, gchar * subject,
474 void subject_table_remove(GHashTable *subject_table, gchar * subject);
475 void utils_free_regex(void);
476 gint subject_get_prefix_length (const gchar *subject);
478 /* quoting recognition */
479 const gchar * line_has_quote_char (const gchar *str,
480 const gchar *quote_chars);
482 gint g_int_compare (gconstpointer a, gconstpointer b);
484 gchar *generate_mime_boundary (const gchar *prefix);
486 gint quote_cmd_argument(gchar * result, guint size,
488 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
490 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
491 void get_hex_str(gchar *out, guchar ch);
493 /* auto pointer for containers that support GType system */
495 #define G_TYPE_AUTO_POINTER g_auto_pointer_register()
496 typedef struct AutoPointer GAuto;
497 GType g_auto_pointer_register (void);
498 GAuto *g_auto_pointer_new (gpointer pointer);
499 GAuto *g_auto_pointer_new_with_free (gpointer p,
501 gpointer g_auto_pointer_get_ptr (GAuto *auto_ptr);
502 GAuto *g_auto_pointer_copy (GAuto *auto_ptr);
503 void g_auto_pointer_free (GAuto *auto_ptr);
504 void replace_returns (gchar *str);
505 gboolean get_uri_part (const gchar *start,
506 const gchar *scanpos,
510 gchar *make_uri_string (const gchar *bp,
512 gboolean get_email_part (const gchar *start,
513 const gchar *scanpos,
517 gchar *make_email_string(const gchar *bp,
519 gchar *make_http_string (const gchar *bp,
522 gchar *mailcap_get_command_for_type(const gchar *type,
523 const gchar *file_to_open);
524 void mailcap_update_default (const gchar *type,
525 const gchar *command);
527 gboolean file_is_email(const gchar *filename);
528 gboolean sc_g_list_bigger(GList *list, gint max);
529 gboolean sc_g_slist_bigger(GSList *list, gint max);
531 GMutex *cm_mutex_new(void);
532 void cm_mutex_free(GMutex *mutex);
534 int cm_canonicalize_filename(const gchar *filename, gchar **canonical_name);
536 guchar *g_base64_decode_zero(const gchar *text, gsize *out_len);
538 #if !GLIB_CHECK_VERSION(2, 30, 0)
539 gchar *g_utf8_substring (const gchar *p,
541 glong end_pos) G_GNUC_MALLOC;
544 gboolean get_random_bytes(void *buf, size_t count);
550 gboolean get_serverportfp_from_filename(const gchar *str, gchar **server, gchar **port, gchar **fp);
553 gchar *win32_debug_log_path(void);
556 #endif /* __UTILS_H__ */