2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2004 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 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
32 #include <sys/types.h>
42 /* The AC_CHECK_SIZEOF() in configure fails for some machines.
43 * we provide some fallback values here */
44 #if !SIZEOF_UNSIGNED_SHORT
45 #undef SIZEOF_UNSIGNED_SHORT
46 #define SIZEOF_UNSIGNED_SHORT 2
48 #if !SIZEOF_UNSIGNED_INT
49 #undef SIZEOF_UNSIGNED_INT
50 #define SIZEOF_UNSIGNED_INT 4
52 #if !SIZEOF_UNSIGNED_LONG
53 #undef SIZEOF_UNSIGNED_LONG
54 #define SIZEOF_UNSIGNED_LONG 4
57 #ifndef HAVE_U32_TYPEDEF
58 #undef u32 /* maybe there is a macro with this name */
60 #define HAVE_U32_TYPEDEF
63 #ifndef BIG_ENDIAN_HOST
64 #if (G_BYTE_ORDER == G_BIG_ENDIAN)
65 #define BIG_ENDIAN_HOST 1
69 #define CHDIR_RETURN_IF_FAIL(dir) \
71 if (change_dir(dir) < 0) return; \
74 #define CHDIR_RETURN_VAL_IF_FAIL(dir, val) \
76 if (change_dir(dir) < 0) return val; \
79 #define Xalloca(ptr, size, iffail) \
81 if ((ptr = alloca(size)) == NULL) { \
82 g_warning("can't allocate memory\n"); \
87 #define Xstrdup_a(ptr, str, iffail) \
91 if ((__tmp = alloca(strlen(str) + 1)) == NULL) { \
92 g_warning("can't allocate memory\n"); \
100 #define Xstrndup_a(ptr, str, len, iffail) \
104 if ((__tmp = alloca(len + 1)) == NULL) { \
105 g_warning("can't allocate memory\n"); \
108 strncpy(__tmp, str, len); \
115 #define Xstrcat_a(ptr, str1, str2, iffail) \
120 len1 = strlen(str1); \
121 len2 = strlen(str2); \
122 if ((__tmp = alloca(len1 + len2 + 1)) == NULL) { \
123 g_warning("can't allocate memory\n"); \
126 memcpy(__tmp, str1, len1); \
127 memcpy(__tmp + len1, str2, len2 + 1); \
133 #define AUTORELEASE_STR(str, iffail) \
136 Xstrdup_a(__str, str, iffail); \
141 #define FILE_OP_ERROR(file, func) \
143 fprintf(stderr, "%s: ", file); \
147 #define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
153 typedef gpointer (*GNodeMapFunc) (gpointer nodedata, gpointer data);
155 /* debug functions */
156 void debug_set_mode (gboolean mode);
157 gboolean debug_get_mode (void);
158 #define debug_print \
159 debug_print_real(__FILE__ ":%d:", __LINE__), \
162 /* for macro expansion */
164 #define Xstr(x) Str(x)
166 void list_free_strings (GList *list);
167 void slist_free_strings (GSList *list);
169 void hash_free_strings (GHashTable *table);
170 void hash_free_value_mem (GHashTable *table);
172 gint str_case_equal (gconstpointer v,
174 guint str_case_hash (gconstpointer key);
176 void ptr_array_free_strings (GPtrArray *array);
178 typedef gboolean (*StrFindFunc) (const gchar *haystack,
179 const gchar *needle);
181 gboolean str_find (const gchar *haystack,
182 const gchar *needle);
183 gboolean str_case_find (const gchar *haystack,
184 const gchar *needle);
185 gboolean str_find_equal (const gchar *haystack,
186 const gchar *needle);
187 gboolean str_case_find_equal (const gchar *haystack,
188 const gchar *needle);
190 /* number-string conversion */
191 gint to_number (const gchar *nstr);
192 gchar *itos_buf (gchar *nstr,
194 gchar *itos (gint n);
195 gchar *to_human_readable (off_t size);
197 /* alternative string functions */
198 gint strcmp2 (const gchar *s1,
200 gchar *strstr2 (const gchar *s1,
202 gint path_cmp (const gchar *s1,
204 gchar *strretchomp (gchar *str);
205 gchar *strtailchomp (gchar *str,
207 gchar *strcrchomp (gchar *str);
208 gchar *strcasestr (const gchar *haystack,
209 const gchar *needle);
210 gpointer my_memmem (gconstpointer haystack,
212 gconstpointer needle,
214 gchar *strncpy2 (gchar *dest,
218 /* wide-character functions */
220 int iswalnum (wint_t wc);
223 int iswspace (wint_t wc);
226 wint_t towlower (wint_t wc);
230 size_t wcslen (const wchar_t *s);
233 wchar_t *wcscpy (wchar_t *dest,
237 wchar_t *wcsncpy (wchar_t *dest,
242 wchar_t *wcsdup (const wchar_t *s);
243 wchar_t *wcsndup (const wchar_t *s,
245 wchar_t *strdup_mbstowcs (const gchar *s);
246 gchar *strdup_wcstombs (const wchar_t *s);
247 gint wcsncasecmp (const wchar_t *s1,
250 wchar_t *wcscasestr (const wchar_t *haystack,
251 const wchar_t *needle);
252 gint get_mbs_len (const gchar *s);
254 gboolean is_next_nonascii (const guchar *s);
255 gint get_next_word_len (const guchar *s);
257 /* functions for string parsing */
258 gint subject_compare (const gchar *s1,
260 gint subject_compare_for_sort (const gchar *s1,
262 void trim_subject_for_compare (gchar *str);
263 void trim_subject_for_sort (gchar *str);
264 void trim_subject (gchar *str);
265 void eliminate_parenthesis (gchar *str,
268 void extract_parenthesis (gchar *str,
272 void extract_parenthesis_with_skip_quote (gchar *str,
277 void eliminate_quote (gchar *str,
279 void extract_quote (gchar *str,
281 void eliminate_address_comment (gchar *str);
282 gchar *strchr_with_skip_quote (const gchar *str,
285 gchar *strrchr_with_skip_quote (const gchar *str,
288 void extract_address (gchar *str);
289 void extract_list_id_str (gchar *str);
291 GSList *slist_concat_unique (GSList *first,
293 GSList *address_list_append (GSList *addr_list,
295 GSList *address_list_append_with_comments(GSList *addr_list,
297 GSList *references_list_append (GSList *msgid_list,
299 GSList *newsgroup_list_append (GSList *group_list,
302 GList *add_history (GList *list,
305 void remove_return (gchar *str);
306 void remove_space (gchar *str);
307 void unfold_line (gchar *str);
308 void subst_char (gchar *str,
311 void subst_chars (gchar *str,
314 void subst_for_filename (gchar *str);
315 void subst_for_shellsafe_filename (gchar *str);
316 gboolean is_header_line (const gchar *str);
317 gboolean is_ascii_str (const guchar *str);
318 gint get_quote_level (const gchar *str,
319 const gchar *quote_chars);
320 gchar *strstr_with_skip_quote (const gchar *haystack,
321 const gchar *needle);
322 gchar *strchr_parenthesis_close (const gchar *str,
326 gchar **strsplit_parenthesis (const gchar *str,
330 gchar **strsplit_with_quote (const gchar *str,
334 gchar *get_abbrev_newsgroup_name (const gchar *group,
336 gchar *trim_string (const gchar *str,
339 GList *uri_list_extract_filenames (const gchar *uri_list);
340 gboolean is_uri_string (const gchar *str);
341 gchar *get_uri_path (const gchar *uri);
342 void decode_uri (gchar *decoded_uri,
343 const gchar *encoded_uri);
344 gint scan_mailto_url (const gchar *mailto,
351 /* return static strings */
352 const gchar *get_home_dir (void);
353 const gchar *get_rc_dir (void);
354 const gchar *get_news_cache_dir (void);
355 const gchar *get_imap_cache_dir (void);
356 const gchar *get_mbox_cache_dir (void);
357 const gchar *get_mime_tmp_dir (void);
358 const gchar *get_template_dir (void);
359 const gchar *get_header_cache_dir (void);
360 const gchar *get_tmp_dir (void);
361 gchar *get_tmp_file (void);
362 const gchar *get_domain_name (void);
364 /* file / directory handling */
365 off_t get_file_size (const gchar *file);
366 off_t get_file_size_as_crlf (const gchar *file);
367 off_t get_left_file_size (FILE *fp);
369 gboolean file_exist (const gchar *file,
370 gboolean allow_fifo);
371 gboolean is_dir_exist (const gchar *dir);
372 gboolean is_file_entry_exist (const gchar *file);
373 gboolean dirent_is_regular_file (struct dirent *d);
374 gboolean dirent_is_directory (struct dirent *d);
376 #define is_file_exist(file) file_exist(file, FALSE)
377 #define is_file_or_fifo_exist(file) file_exist(file, TRUE)
379 gint change_dir (const gchar *dir);
380 gint make_dir (const gchar *dir);
381 gint make_dir_hier (const gchar *dir);
382 gint remove_all_files (const gchar *dir);
383 gint remove_numbered_files (const gchar *dir,
386 gint remove_numbered_files_not_in_list(const gchar *dir,
388 gint remove_all_numbered_files (const gchar *dir);
389 gint remove_expired_files (const gchar *dir,
391 gint remove_dir_recursive (const gchar *dir);
392 gint append_file (const gchar *src,
394 gboolean keep_backup);
395 gint copy_file (const gchar *src,
397 gboolean keep_backup);
398 gint move_file (const gchar *src,
401 gint copy_file_part_to_fp (FILE *fp,
405 gint copy_file_part (FILE *fp,
410 gchar *canonicalize_str (const gchar *str);
411 gint canonicalize_file (const gchar *src,
413 gint canonicalize_file_replace (const gchar *file);
414 gint uncanonicalize_file (const gchar *src,
416 gint uncanonicalize_file_replace(const gchar *file);
418 gchar *normalize_newlines (const gchar *str);
420 gchar *get_outgoing_rfc2822_str (FILE *fp);
422 gint change_file_mode_rw (FILE *fp,
424 FILE *my_tmpfile (void);
425 FILE *get_tmpfile_in_dir (const gchar *dir,
427 FILE *str_open_as_stream (const gchar *str);
428 gint str_write_to_file (const gchar *str,
430 gchar *file_read_to_str (const gchar *file);
431 gchar *file_read_stream_to_str (FILE *fp);
433 /* process execution */
434 gint execute_async (gchar *const argv[]);
435 gint execute_sync (gchar *const argv[]);
436 gint execute_command_line (const gchar *cmdline,
438 gchar *get_command_output (const gchar *cmdline);
440 /* open URI with external browser */
441 gint open_uri(const gchar *uri, const gchar *cmdline);
444 time_t remote_tzoffset_sec (const gchar *zone);
445 time_t tzoffset_sec (time_t *now);
446 gchar *tzoffset (time_t *now);
447 void get_rfc822_date (gchar *buf,
451 void debug_print_real (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
453 /* subject threading */
454 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
455 void subject_table_insert(GHashTable *subject_table, gchar * subject,
457 void subject_table_remove(GHashTable *subject_table, gchar * subject);
458 gint subject_get_prefix_length (const gchar *subject);
460 /* quoting recognition */
461 const gchar * line_has_quote_char (const gchar *str,
462 const gchar *quote_chars);
463 const gchar * line_has_quote_char_last (const gchar *str,
464 const gchar *quote_chars);
466 guint g_stricase_hash (gconstpointer gptr);
467 gint g_stricase_equal (gconstpointer gptr1, gconstpointer gptr2);
468 gint g_int_compare (gconstpointer a, gconstpointer b);
470 gchar *generate_msgid (gchar *buf, gint len);
471 gchar *generate_mime_boundary (const gchar *prefix);
473 gint quote_cmd_argument(gchar * result, guint size,
475 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
477 gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
478 void get_hex_str(gchar *out, guchar ch);
484 #endif /* __UTILS_H__ */