2004-11-18 [paul] 0.9.12cvs158.1
[claws.git] / src / common / utils.h
index 2c77192fa032374fe2445f13daf572f5ed2b1fd6..96bdadc65700d66bedd89b45d79ad29e2e46c10c 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2002 Hiroyuki Yamamoto
+ * Copyright (C) 1999-2004 Hiroyuki Yamamoto
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,6 +30,7 @@
 #include <stdlib.h>
 #include <unistd.h>
 #include <sys/types.h>
+#include <dirent.h>
 #include <time.h>
 #if HAVE_ALLOCA_H
 #  include <alloca.h>
        ptr = __tmp; \
 }
 
+#define AUTORELEASE_STR(str, iffail) \
+{ \
+       gchar *__str; \
+       Xstrdup_a(__str, str, iffail); \
+       g_free(str); \
+       str = __str; \
+}
+
 #define FILE_OP_ERROR(file, func) \
 { \
        fprintf(stderr, "%s: ", file); \
        perror(func); \
 }
 
+#define IS_ASCII(c) (((guchar) c) <= 0177 ? 1 : 0)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef gpointer (*GNodeMapFunc)       (gpointer nodedata, gpointer data);
+
 /* debug functions */
 void debug_set_mode            (gboolean mode);
-gboolean debug_get_mode                ();
+gboolean debug_get_mode                (void);
 #define debug_print \
        debug_print_real(__FILE__ ":%d:", __LINE__), \
        debug_print_real
@@ -152,8 +169,24 @@ void slist_free_strings            (GSList         *list);
 void hash_free_strings         (GHashTable     *table);
 void hash_free_value_mem       (GHashTable     *table);
 
+gint str_case_equal            (gconstpointer   v,
+                                gconstpointer   v2);
+guint str_case_hash            (gconstpointer   key);
+
 void ptr_array_free_strings    (GPtrArray      *array);
 
+typedef gboolean (*StrFindFunc) (const gchar   *haystack,
+                                const gchar    *needle);
+
+gboolean str_find              (const gchar    *haystack,
+                                const gchar    *needle);
+gboolean str_case_find         (const gchar    *haystack,
+                                const gchar    *needle);
+gboolean str_find_equal                (const gchar    *haystack,
+                                const gchar    *needle);
+gboolean str_case_find_equal   (const gchar    *haystack,
+                                const gchar    *needle);
+
 /* number-string conversion */
 gint to_number                 (const gchar *nstr);
 gchar *itos_buf                        (gchar       *nstr,
@@ -212,13 +245,18 @@ gint wcsncasecmp          (const wchar_t *s1,
                                 size_t         n);
 wchar_t *wcscasestr            (const wchar_t *haystack,
                                 const wchar_t *needle);
+gint get_mbs_len               (const gchar    *s);
 
 gboolean is_next_nonascii      (const guchar *s);
-gint get_next_word_len         (const gchar *s);
+gint get_next_word_len         (const guchar *s);
 
 /* functions for string parsing */
 gint subject_compare                   (const gchar    *s1,
                                         const gchar    *s2);
+gint subject_compare_for_sort          (const gchar    *s1,
+                                        const gchar    *s2);
+void trim_subject_for_compare          (gchar          *str);
+void trim_subject_for_sort             (gchar          *str);
 void trim_subject                      (gchar          *str);
 void eliminate_parenthesis             (gchar          *str,
                                         gchar           op,
@@ -227,10 +265,6 @@ void extract_parenthesis           (gchar          *str,
                                         gchar           op,
                                         gchar           cl);
 
-void extract_one_parenthesis_with_skip_quote   (gchar          *str,
-                                                gchar           quote_chr,
-                                                gchar           op,
-                                                gchar           cl);
 void extract_parenthesis_with_skip_quote       (gchar          *str,
                                                 gchar           quote_chr,
                                                 gchar           op,
@@ -248,11 +282,14 @@ gchar *strrchr_with_skip_quote            (const gchar    *str,
                                         gint            quote_chr,
                                         gint            c);
 void extract_address                   (gchar          *str);
+void extract_list_id_str               (gchar          *str);
 
 GSList *slist_concat_unique            (GSList         *first,
                                         GSList         *second);
 GSList *address_list_append            (GSList         *addr_list,
                                         const gchar    *str);
+GSList *address_list_append_with_comments(GSList       *addr_list,
+                                        const gchar    *str);
 GSList *references_list_append         (GSList         *msgid_list,
                                         const gchar    *str);
 GSList *newsgroup_list_append          (GSList         *group_list,
@@ -271,6 +308,7 @@ void subst_chars                    (gchar          *str,
                                         gchar          *orig,
                                         gchar           subst);
 void subst_for_filename                        (gchar          *str);
+void subst_for_shellsafe_filename      (gchar          *str);
 gboolean is_header_line                        (const gchar    *str);
 gboolean is_ascii_str                  (const guchar   *str);
 gint get_quote_level                   (const gchar    *str,
@@ -295,6 +333,8 @@ gchar *trim_string                  (const gchar    *str,
                                         gint            len);
 
 GList *uri_list_extract_filenames      (const gchar    *uri_list);
+gboolean is_uri_string                 (const gchar    *str);
+gchar *get_uri_path                    (const gchar    *uri);
 void decode_uri                                (gchar          *decoded_uri,
                                         const gchar    *encoded_uri);
 gint scan_mailto_url                   (const gchar    *mailto,
@@ -305,17 +345,17 @@ gint scan_mailto_url                      (const gchar    *mailto,
                                         gchar         **body);
 
 /* return static strings */
-gchar *get_home_dir            (void);
-gchar *get_rc_dir              (void);
-gchar *get_news_cache_dir      (void);
-gchar *get_imap_cache_dir      (void);
-gchar *get_mbox_cache_dir      (void);
-gchar *get_mime_tmp_dir                (void);
-gchar *get_template_dir                (void);
-gchar *get_header_cache_dir     (void);
-gchar *get_tmp_dir             (void);
-gchar *get_tmp_file            (void);
-gchar *get_domain_name         (void);
+const gchar *get_home_dir              (void);
+const gchar *get_rc_dir                        (void);
+const gchar *get_news_cache_dir                (void);
+const gchar *get_imap_cache_dir                (void);
+const gchar *get_mbox_cache_dir                (void);
+const gchar *get_mime_tmp_dir          (void);
+const gchar *get_template_dir          (void);
+const gchar *get_header_cache_dir      (void);
+const gchar *get_tmp_dir               (void);
+gchar *get_tmp_file                    (void);
+const gchar *get_domain_name           (void);
 
 /* file / directory handling */
 off_t get_file_size            (const gchar    *file);
@@ -326,6 +366,8 @@ gboolean file_exist         (const gchar    *file,
                                 gboolean        allow_fifo);
 gboolean is_dir_exist          (const gchar    *dir);
 gboolean is_file_entry_exist   (const gchar    *file);
+gboolean dirent_is_regular_file        (struct dirent  *d);
+gboolean dirent_is_directory   (struct dirent  *d);
 
 #define is_file_exist(file)            file_exist(file, FALSE)
 #define is_file_or_fifo_exist(file)    file_exist(file, TRUE)
@@ -352,26 +394,44 @@ gint copy_file                    (const gchar    *src,
 gint move_file                 (const gchar    *src,
                                 const gchar    *dest,
                                 gboolean        overwrite);
+gint copy_file_part_to_fp      (FILE           *fp,
+                                off_t           offset,
+                                size_t          length,
+                                FILE           *dest_fp);
 gint copy_file_part            (FILE           *fp,
                                 off_t           offset,
                                 size_t          length,
                                 const gchar    *dest);
+
+gchar *canonicalize_str                (const gchar    *str);
 gint canonicalize_file         (const gchar    *src,
                                 const gchar    *dest);
 gint canonicalize_file_replace (const gchar    *file);
+gint uncanonicalize_file       (const gchar    *src,
+                                const gchar    *dest);
+gint uncanonicalize_file_replace(const gchar   *file);
+
+gchar *normalize_newlines      (const gchar    *str);
+
+gchar *get_outgoing_rfc2822_str        (FILE           *fp);
+
 gint change_file_mode_rw       (FILE           *fp,
                                 const gchar    *file);
 FILE *my_tmpfile               (void);
+FILE *get_tmpfile_in_dir       (const gchar    *dir,
+                                gchar         **filename);
 FILE *str_open_as_stream       (const gchar    *str);
 gint str_write_to_file         (const gchar    *str,
                                 const gchar    *file);
 gchar *file_read_to_str                (const gchar    *file);
+gchar *file_read_stream_to_str (FILE           *fp);
 
 /* process execution */
 gint execute_async             (gchar *const    argv[]);
 gint execute_sync              (gchar *const    argv[]);
 gint execute_command_line      (const gchar    *cmdline,
                                 gboolean        async);
+gchar *get_command_output      (const gchar    *cmdline);
 
 /* open URI with external browser */
 gint open_uri(const gchar *uri, const gchar *cmdline);
@@ -391,7 +451,7 @@ void * subject_table_lookup(GHashTable *subject_table, gchar * subject);
 void subject_table_insert(GHashTable *subject_table, gchar * subject,
                          void * data);
 void subject_table_remove(GHashTable *subject_table, gchar * subject);
-gboolean subject_is_reply(const gchar *subject);
+gint subject_get_prefix_length (const gchar *subject);
 
 /* quoting recognition */
 const gchar * line_has_quote_char      (const gchar *str,
@@ -399,10 +459,22 @@ const gchar * line_has_quote_char (const gchar *str,
 const gchar * line_has_quote_char_last (const gchar *str,
                                         const gchar *quote_chars);
 
-/* used in extended search */
-gchar * expand_search_string   (const gchar *str);
-
 guint g_stricase_hash  (gconstpointer gptr);
 gint g_stricase_equal  (gconstpointer gptr1, gconstpointer gptr2);
+gint g_int_compare     (gconstpointer a, gconstpointer b);
+
+gchar *generate_msgid          (gchar *buf, gint len);
+gchar *generate_mime_boundary  (const gchar *prefix);
+
+gint quote_cmd_argument(gchar * result, guint size,
+                       const gchar * path);
+GNode *g_node_map(GNode *node, GNodeMapFunc func, gpointer data);
+
+gboolean get_hex_value(guchar *out, gchar c1, gchar c2);
+void get_hex_str(gchar *out, guchar ch);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* __UTILS_H__ */