2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws 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 2 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, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 #include <glib-object.h>
33 #include <sys/types.h>
43 /* Wrappers for C library function that take pathname arguments. */
44 #if GLIB_CHECK_VERSION(2, 6, 0)
45 # include <glib/gstdio.h>
49 #define g_rename rename
53 #define g_unlink unlink
54 #define g_remove remove
57 #define g_freopen freopen
59 #endif /* GLIB_CHECK_VERSION */
61 #if !GLIB_CHECK_VERSION(2, 7, 0)
67 gint g_chdir (const gchar *path);
68 gint g_chmod (const gchar *path,
70 #endif /* G_OS_UNIX */
72 #endif /* !GLIB_CHECK_VERSION */
74 /* The AC_CHECK_SIZEOF() in configure fails for some machines.
75 * we provide some fallback values here */
76 #if !SIZEOF_UNSIGNED_SHORT
77 #undef SIZEOF_UNSIGNED_SHORT
78 #define SIZEOF_UNSIGNED_SHORT 2
80 #if !SIZEOF_UNSIGNED_INT
81 #undef SIZEOF_UNSIGNED_INT
82 #define SIZEOF_UNSIGNED_INT 4
84 #if !SIZEOF_UNSIGNED_LONG
85 #undef SIZEOF_UNSIGNED_LONG
86 #define SIZEOF_UNSIGNED_LONG 4
89 #ifndef HAVE_U32_TYPEDEF
90 #undef u32 /* maybe there is a macro with this name */
92 #define HAVE_U32_TYPEDEF
95 #ifndef BIG_ENDIAN_HOST
96 #if (G_BYTE_ORDER == G_BIG_ENDIAN)
97 #define BIG_ENDIAN_HOST 1
101 #define CHDIR_RETURN_IF_FAIL(dir) \
103 if (change_dir(dir) < 0) return; \
106 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
108 if (change_dir(dir) < 0) return val; \
111 #define Xalloca(ptr, size, iffail) \
113 if ((ptr = alloca(size)) == NULL) { \
114 g_warning("can't allocate memory\n"); \
119 #define Xstrdup_a(ptr, str, iffail) \
123 if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
124 g_warning("can't allocate memory\n"); \
127 strcpy(__tmp, str); \
132 #define Xstrndup_a(ptr, str, len, iffail) \
136 if ((__tmp = alloca(len + 1)) == NULL) { \
137 g_warning("can't allocate memory\n"); \
140 strncpy(__tmp, str, len); \
147 #define Xstrcat_a(ptr, str1, str2, iffail) \
152 len1 = strlen(str1); \
153 len2 = strlen(str2); \
154 if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
155 g_warning("can't allocate memory\n"); \
158 memcpy(__tmp, str1, len1); \
159 memcpy(__tmp + len1, str2, len2 + 1); \
165 #define AUTORELEASE_STR(str, iffail) \
168 Xstrdup_a(__str, str, iffail); \
173 #define FILE_OP_ERROR(file, func) \
175 fprintf(stderr, "%s: ", file); \
180 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
186 typedef gpointer (*GNodeMapFunc) (gpointer nodedata, gpointer data);
188 /* debug functions */
189 void debug_set_mode (gboolean mode);
190 gboolean debug_get_mode (void);
191 #define debug_print \
192 debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
195 /* for macro expansion */
197 #define Xstr(x) Str(x)
199 void list_free_strings (GList *list);
200 void slist_free_strings (GSList *list);
202 void hash_free_strings (GHashTable *table);
203 void hash_free_value_mem (GHashTable *table);
205 gint str_case_equal (gconstpointer v,
207 guint str_case_hash (gconstpointer key);
209 void ptr_array_free_strings (GPtrArray *array);
211 typedef gboolean (*StrFindFunc) (const gchar *haystack,
212 const gchar *needle);
214 gboolean str_find (const gchar *haystack,
215 const gchar *needle);
216 gboolean str_case_find (const gchar *haystack,
217 const gchar *needle);
218 gboolean str_find_equal (const gchar *haystack,
219 const gchar *needle);
220 gboolean str_case_find_equal (const gchar *haystack,
221 const gchar *needle);
223 /* number-string conversion */
224 gint to_number (const gchar *nstr);
225 gchar *itos_buf (gchar *nstr,
227 gchar *itos (gint n);
228 gchar *to_human_readable (off_t size);
230 /* alternative string functions */
231 gint strcmp2 (const gchar *s1,
233 gchar *strstr2 (const gchar *s1,
235 gint path_cmp (const gchar *s1,
237 gchar *strretchomp (gchar *str);
238 gchar *strtailchomp (gchar *str,
240 gchar *strcrchomp (gchar *str);
241 void file_strip_crs (const gchar *file);
242 gchar *strcasestr (const gchar *haystack,
243 const gchar *needle);
244 gpointer my_memmem (gconstpointer haystack,
246 gconstpointer needle,
248 gchar *strncpy2 (gchar *dest,
252 /* wide-character functions */
254 int iswalnum (wint_t wc);
257 int iswspace (wint_t wc);
260 wint_t towlower (wint_t wc);
264 size_t wcslen (const wchar_t *s);
267 wchar_t *wcscpy (wchar_t *dest,
271 wchar_t *wcsncpy (wchar_t *dest,
276 wchar_t *wcsdup (const wchar_t *s);
277 wchar_t *wcsndup (const wchar_t *s,
279 wchar_t *strdup_mbstowcs (const gchar *s);
280 gchar *strdup_wcstombs (const wchar_t *s);
281 gint wcsncasecmp (const wchar_t *s1,
284 wchar_t *wcscasestr (const wchar_t *haystack,
285 const wchar_t *needle);
286 gint get_mbs_len (const gchar *s);
288 gboolean is_next_nonascii (const gchar *s);
289 gint get_next_word_len (const gchar *s);
291 /* functions for string parsing */
292 gint subject_compare (const gchar *s1,
294 gint subject_compare_for_sort (const gchar *s1,
296 void trim_subject_for_compare (gchar *str);
297 void trim_subject_for_sort (gchar *str);
298 void trim_subject (gchar *str);
299 void eliminate_parenthesis (gchar *str,
302 void extract_parenthesis (gchar *str,
306 void extract_parenthesis_with_skip_quote (gchar *str,
311 void eliminate_quote (gchar *str,
313 void extract_quote (gchar *str,
315 void eliminate_address_comment (gchar *str);
316 gchar *strchr_with_skip_quote (const gchar *str,
319 gchar *strrchr_with_skip_quote (const gchar *str,
322 void extract_address (gchar *str);
323 void extract_list_id_str (gchar *str);
325 GSList *slist_concat_unique (GSList *first,
327 GSList *address_list_append (GSList *addr_list,
329 GSList *address_list_append_with_comments(GSList *addr_list,
331 GSList *references_list_prepend (GSList *msgid_list,
333 GSList *references_list_append (GSList *msgid_list,
335 GSList *newsgroup_list_append (GSList *group_list,
338 GList *add_history (GList *list,
341 void remove_return (gchar *str);
342 void remove_space (gchar *str);
343 void unfold_line (gchar *str);
344 void subst_char (gchar *str,
347 void subst_chars (gchar *str,
350 void subst_for_filename (gchar *str);
351 void subst_for_shellsafe_filename (gchar *str);
352 gboolean is_header_line (const gchar *str);
353 gboolean is_ascii_str (const gchar *str);
354 gint get_quote_level (const gchar *str,
355 const gchar *quote_chars);
356 gint check_line_length (const gchar *str,
360 gchar *strstr_with_skip_quote (const gchar *haystack,
361 const gchar *needle);
362 gchar *strchr_parenthesis_close (const gchar *str,
366 gchar **strsplit_parenthesis (const gchar *str,
370 gchar **strsplit_with_quote (const gchar *str,
374 gchar *get_abbrev_newsgroup_name (const gchar *group,
376 gchar *trim_string (const gchar *str,
379 GList *uri_list_extract_filenames (const gchar *uri_list);
380 gboolean is_uri_string (const gchar *str);
381 gchar *get_uri_path (const gchar *uri);
382 gint get_uri_len (const gchar *str);
383 void decode_uri (gchar *decoded_uri,
384 const gchar *encoded_uri);
385 gint scan_mailto_url (const gchar *mailto,
392 /* return static strings */
393 const gchar *get_home_dir (void);
394 const gchar *get_rc_dir (void);
395 const gchar *get_mail_base_dir (void);
396 const gchar *get_news_cache_dir (void);
397 const gchar *get_imap_cache_dir (void);
398 const gchar *get_mbox_cache_dir (void);
399 const gchar *get_mime_tmp_dir (void);
400 const gchar *get_template_dir (void);
401 const gchar *get_header_cache_dir (void);
402 const gchar *get_plugin_dir (void);
403 const gchar *get_tmp_dir (void);
404 gchar *get_tmp_file (void);
405 const gchar *get_domain_name (void);
407 /* file / directory handling */
408 off_t get_file_size (const gchar *file);
409 off_t get_file_size_as_crlf (const gchar *file);
410 off_t get_left_file_size (FILE *fp);
412 gboolean file_exist (const gchar *file,
413 gboolean allow_fifo);
414 gboolean is_relative_filename (const gchar *file);
415 gboolean is_dir_exist (const gchar *dir);
416 gboolean is_file_entry_exist (const gchar *file);
417 gboolean dirent_is_regular_file (struct dirent *d);
418 gboolean dirent_is_directory (struct dirent *d);
420 #define is_file_exist(file) file_exist(file, FALSE)
421 #define is_file_or_fifo_exist(file) file_exist(file, TRUE)
423 gint change_dir (const gchar *dir);
424 gint make_dir (const gchar *dir);
425 gint make_dir_hier (const gchar *dir);
426 gint remove_all_files (const gchar *dir);
427 gint remove_numbered_files (const gchar *dir,
430 gint remove_numbered_files_not_in_list(const gchar *dir,
432 gint remove_all_numbered_files (const gchar *dir);
433 gint remove_expired_files (const gchar *dir,
435 gint remove_dir_recursive (const gchar *dir);
436 gint append_file (const gchar *src,
438 gboolean keep_backup);
439 gint rename_force (const gchar *oldpath,
440 const gchar *newpath);
441 gint copy_file (const gchar *src,
443 gboolean keep_backup);
444 gint move_file (const gchar *src,
447 gint copy_dir (const gchar *src,
449 gint copy_file_part_to_fp (FILE *fp,
453 gint copy_file_part (FILE *fp,
458 gchar *canonicalize_str (const gchar *str);
459 gint canonicalize_file (const gchar *src,
461 gint canonicalize_file_replace (const gchar *file);
462 gint uncanonicalize_file (const gchar *src,
464 gint uncanonicalize_file_replace(const gchar *file);
466 gchar *normalize_newlines (const gchar *str);
468 gchar *get_outgoing_rfc2822_str (FILE *fp);
470 gint change_file_mode_rw (FILE *fp,
472 FILE *my_tmpfile (void);
473 FILE *get_tmpfile_in_dir (const gchar *dir,
475 FILE *str_open_as_stream (const gchar *str);
476 gint str_write_to_file (const gchar *str,
478 gchar *file_read_to_str (const gchar *file);
479 gchar *file_read_stream_to_str (FILE *fp);
481 /* process execution */
482 gint execute_async (gchar *const argv[]);
483 gint execute_sync (gchar *const argv[]);
484 gint execute_command_line (const gchar *cmdline,
486 gchar *get_command_output (const gchar *cmdline);
488 /* open URI with external browser */
489 gint open_uri(const gchar *uri, const gchar *cmdline);
492 time_t remote_tzoffset_sec (const gchar *zone);
493 time_t tzoffset_sec (time_t *now);
494 gchar *tzoffset (time_t *now);
495 void get_rfc822_date (gchar *buf,
498 size_t my_strftime (gchar *s,
501 const struct tm *tm);
504 void debug_print_real (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
505 const char * debug_srcname (const char *file);
507 /* subject threading */
508 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
509 void subject_table_insert(GHashTable *subject_table, gchar * subject,
511 void subject_table_remove(GHashTable *subject_table, gchar * subject);
512 gint subject_get_prefix_length (const gchar *subject);
514 /* quoting recognition */
515 const gchar * line_has_quote_char (const gchar *str,
516 const gchar *quote_chars);
517 const gchar * line_has_quote_char_last (const gchar *str,
518 const gchar *quote_chars);
520 guint g_stricase_hash (gconstpointer gptr);
521 gint g_stricase_equal (gconstpointer gptr1, gconstpointer gptr2);
522 gint g_int_compare (gconstpointer a, gconstpointer b);
524 gchar *generate_msgid (gchar *buf, gint len);
525 gchar *generate_mime_boundary (const gchar *prefix);
527 gint quote_cmd_argument(gchar * result, guint size,
529 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
531 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
532 void get_hex_str(gchar *out, guchar ch);
534 /* auto pointer for containers that support GType system */
536 #define G_TYPE_AUTO_POINTER g_auto_pointer_register()
537 typedef struct AutoPointer GAuto;
538 GType g_auto_pointer_register (void);
539 GAuto *g_auto_pointer_new (gpointer pointer);
540 GAuto *g_auto_pointer_new_with_free (gpointer p,
542 gpointer g_auto_pointer_get_ptr (GAuto *auto_ptr);
543 GAuto *g_auto_pointer_copy (GAuto *auto_ptr);
544 void g_auto_pointer_free (GAuto *auto_ptr);
545 void replace_returns (gchar *str);
547 gboolean get_uri_part(const gchar *start, const gchar *scanpos,
548 const gchar **bp, const gchar **ep, gboolean hdr);
549 gchar *make_uri_string(const gchar *bp, const gchar *ep);
550 gboolean get_email_part(const gchar *start, const gchar *scanpos,
551 const gchar **bp, const gchar **ep, gboolean hdr);
552 gchar *make_email_string(const gchar *bp, const gchar *ep);
553 gchar *make_http_string(const gchar *bp, const gchar *ep);
554 gchar *mailcap_get_command_for_type(const gchar *type);
560 #endif /* __UTILS_H__ */