2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2003 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 typedef gpointer (*GNodeMapFunc) (gpointer nodedata, gpointer data);
149 /* debug functions */
150 void debug_set_mode (gboolean mode);
151 gboolean debug_get_mode (void);
152 #define debug_print \
153 debug_print_real(__FILE__ ":%d:", __LINE__), \
156 /* for macro expansion */
158 #define Xstr(x) Str(x)
160 void list_free_strings (GList *list);
161 void slist_free_strings (GSList *list);
163 void hash_free_strings (GHashTable *table);
164 void hash_free_value_mem (GHashTable *table);
166 gint str_case_equal (gconstpointer v,
168 guint str_case_hash (gconstpointer key);
170 void ptr_array_free_strings (GPtrArray *array);
172 /* number-string conversion */
173 gint to_number (const gchar *nstr);
174 gchar *itos_buf (gchar *nstr,
176 gchar *itos (gint n);
177 gchar *to_human_readable (off_t size);
179 /* alternative string functions */
180 gint strcmp2 (const gchar *s1,
182 gchar *strstr2 (const gchar *s1,
184 gint path_cmp (const gchar *s1,
186 gchar *strretchomp (gchar *str);
187 gchar *strtailchomp (gchar *str,
189 gchar *strcrchomp (gchar *str);
190 gchar *strcasestr (const gchar *haystack,
191 const gchar *needle);
192 gchar *strncpy2 (gchar *dest,
196 /* wide-character functions */
198 int iswalnum (wint_t wc);
201 int iswspace (wint_t wc);
204 wint_t towlower (wint_t wc);
208 size_t wcslen (const wchar_t *s);
211 wchar_t *wcscpy (wchar_t *dest,
215 wchar_t *wcsncpy (wchar_t *dest,
220 wchar_t *wcsdup (const wchar_t *s);
221 wchar_t *wcsndup (const wchar_t *s,
223 wchar_t *strdup_mbstowcs (const gchar *s);
224 gchar *strdup_wcstombs (const wchar_t *s);
225 gint wcsncasecmp (const wchar_t *s1,
228 wchar_t *wcscasestr (const wchar_t *haystack,
229 const wchar_t *needle);
230 gint get_mbs_len (const gchar *s);
232 gboolean is_next_nonascii (const guchar *s);
233 gint get_next_word_len (const guchar *s);
235 /* functions for string parsing */
236 gint subject_compare (const gchar *s1,
238 gint subject_compare_for_sort (const gchar *s1,
240 void trim_subject_for_compare (gchar *str);
241 void trim_subject_for_sort (gchar *str);
242 void trim_subject (gchar *str);
243 void eliminate_parenthesis (gchar *str,
246 void extract_parenthesis (gchar *str,
250 void extract_parenthesis_with_skip_quote (gchar *str,
255 void eliminate_quote (gchar *str,
257 void extract_quote (gchar *str,
259 void eliminate_address_comment (gchar *str);
260 gchar *strchr_with_skip_quote (const gchar *str,
263 gchar *strrchr_with_skip_quote (const gchar *str,
266 void extract_address (gchar *str);
267 void extract_list_id_str (gchar *str);
269 GSList *slist_concat_unique (GSList *first,
271 GSList *address_list_append (GSList *addr_list,
273 GSList *address_list_append_with_comments(GSList *addr_list,
275 GSList *references_list_append (GSList *msgid_list,
277 GSList *newsgroup_list_append (GSList *group_list,
280 GList *add_history (GList *list,
283 void remove_return (gchar *str);
284 void remove_space (gchar *str);
285 void unfold_line (gchar *str);
286 void subst_char (gchar *str,
289 void subst_chars (gchar *str,
292 void subst_for_filename (gchar *str);
293 void subst_for_shellsafe_filename (gchar *str);
294 gboolean is_header_line (const gchar *str);
295 gboolean is_ascii_str (const guchar *str);
296 gint get_quote_level (const gchar *str,
297 const gchar *quote_chars);
298 gchar *strstr_with_skip_quote (const gchar *haystack,
299 const gchar *needle);
300 gchar *strchr_parenthesis_close (const gchar *str,
304 gchar **strsplit_parenthesis (const gchar *str,
308 gchar **strsplit_with_quote (const gchar *str,
312 gchar *get_abbrev_newsgroup_name (const gchar *group,
314 gchar *trim_string (const gchar *str,
317 GList *uri_list_extract_filenames (const gchar *uri_list);
318 gboolean is_uri_string (const gchar *str);
319 gchar *get_uri_path (const gchar *uri);
320 void decode_uri (gchar *decoded_uri,
321 const gchar *encoded_uri);
322 gint scan_mailto_url (const gchar *mailto,
329 /* return static strings */
330 gchar *get_home_dir (void);
331 gchar *get_rc_dir (void);
332 gchar *get_news_cache_dir (void);
333 gchar *get_imap_cache_dir (void);
334 gchar *get_mbox_cache_dir (void);
335 gchar *get_mime_tmp_dir (void);
336 gchar *get_template_dir (void);
337 gchar *get_header_cache_dir (void);
338 gchar *get_tmp_dir (void);
339 gchar *get_tmp_file (void);
340 gchar *get_domain_name (void);
342 /* file / directory handling */
343 off_t get_file_size (const gchar *file);
344 off_t get_file_size_as_crlf (const gchar *file);
345 off_t get_left_file_size (FILE *fp);
347 gboolean file_exist (const gchar *file,
348 gboolean allow_fifo);
349 gboolean is_dir_exist (const gchar *dir);
350 gboolean is_file_entry_exist (const gchar *file);
351 gboolean dirent_is_regular_file (struct dirent *d);
352 gboolean dirent_is_directory (struct dirent *d);
354 #define is_file_exist(file) file_exist(file, FALSE)
355 #define is_file_or_fifo_exist(file) file_exist(file, TRUE)
357 gint change_dir (const gchar *dir);
358 gint make_dir (const gchar *dir);
359 gint make_dir_hier (const gchar *dir);
360 gint remove_all_files (const gchar *dir);
361 gint remove_numbered_files (const gchar *dir,
364 gint remove_numbered_files_not_in_list(const gchar *dir,
366 gint remove_all_numbered_files (const gchar *dir);
367 gint remove_expired_files (const gchar *dir,
369 gint remove_dir_recursive (const gchar *dir);
370 gint append_file (const gchar *src,
372 gboolean keep_backup);
373 gint copy_file (const gchar *src,
375 gboolean keep_backup);
376 gint move_file (const gchar *src,
379 gint copy_file_part (FILE *fp,
384 gchar *canonicalize_str (const gchar *str);
385 gint canonicalize_file (const gchar *src,
387 gint canonicalize_file_replace (const gchar *file);
388 gint uncanonicalize_file (const gchar *src,
390 gint uncanonicalize_file_replace(const gchar *file);
392 gchar *normalize_newlines (const gchar *str);
394 gchar *get_outgoing_rfc2822_str (FILE *fp);
396 gint change_file_mode_rw (FILE *fp,
398 FILE *my_tmpfile (void);
399 FILE *get_tmpfile_in_dir (const gchar *dir,
401 FILE *str_open_as_stream (const gchar *str);
402 gint str_write_to_file (const gchar *str,
404 gchar *file_read_to_str (const gchar *file);
405 gchar *file_read_stream_to_str (FILE *fp);
407 /* process execution */
408 gint execute_async (gchar *const argv[]);
409 gint execute_sync (gchar *const argv[]);
410 gint execute_command_line (const gchar *cmdline,
412 gchar *get_command_output (const gchar *cmdline);
414 /* open URI with external browser */
415 gint open_uri(const gchar *uri, const gchar *cmdline);
418 time_t remote_tzoffset_sec (const gchar *zone);
419 time_t tzoffset_sec (time_t *now);
420 gchar *tzoffset (time_t *now);
421 void get_rfc822_date (gchar *buf,
425 void debug_print_real (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
427 /* subject threading */
428 void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
429 void subject_table_insert(GHashTable *subject_table, gchar * subject,
431 void subject_table_remove(GHashTable *subject_table, gchar * subject);
432 gint subject_get_prefix_length (const gchar *subject);
434 /* quoting recognition */
435 const gchar * line_has_quote_char (const gchar *str,
436 const gchar *quote_chars);
437 const gchar * line_has_quote_char_last (const gchar *str,
438 const gchar *quote_chars);
440 /* used in extended search */
441 gchar * expand_search_string (const gchar *str);
443 guint g_stricase_hash (gconstpointer gptr);
444 gint g_stricase_equal (gconstpointer gptr1, gconstpointer gptr2);
445 gint g_int_compare (gconstpointer a, gconstpointer b);
447 gchar *generate_msgid (const gchar *address, gchar *buf, gint len);
448 gchar *generate_mime_boundary (const gchar *prefix);
450 gint quote_cmd_argument(gchar * result, guint size,
452 GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
454 #endif /* __UTILS_H__ */