2009-01-09 [colin] 3.7.0cvs19
[claws.git] / src / common / utils.h
index 4e6a3f949bb73373f2e617a6a66b5c3def289e49..b7df76ba9d78fe6bd91e8c93564ca08b8131444a 100644 (file)
@@ -1,10 +1,10 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws team
+ * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail team
  *
  * 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
@@ -13,8 +13,8 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifndef __UTILS_H__
@@ -71,19 +71,11 @@ gint g_chmod        (const gchar    *path,
 
 #endif /* !GLIB_CHECK_VERSION */
 
-/* The AC_CHECK_SIZEOF() in configure fails for some machines.
- * we provide some fallback values here */
-#if !SIZEOF_UNSIGNED_SHORT
-  #undef SIZEOF_UNSIGNED_SHORT
-  #define SIZEOF_UNSIGNED_SHORT 2
-#endif
-#if !SIZEOF_UNSIGNED_INT
-  #undef SIZEOF_UNSIGNED_INT
-  #define SIZEOF_UNSIGNED_INT 4
-#endif
-#if !SIZEOF_UNSIGNED_LONG
-  #undef SIZEOF_UNSIGNED_LONG
-  #define SIZEOF_UNSIGNED_LONG 4
+/* why is this sometimes undefined !? */
+#ifndef G_MAXOFFSET
+typedef gint64 goffset;
+#define G_MINOFFSET    G_MININT64
+#define G_MAXOFFSET    G_MAXINT64
 #endif
 
 #ifndef HAVE_U32_TYPEDEF
@@ -108,6 +100,14 @@ gint g_chmod       (const gchar    *path,
        if (change_dir(dir) < 0) return val; \
 }
 
+#define CHDIR_EXEC_CODE_RETURN_VAL_IF_FAIL(dir, val, code) \
+{ \
+       if (change_dir(dir) < 0) { \
+               code \
+               return val; \
+       } \
+}
+
 #define Xalloca(ptr, size, iffail) \
 { \
        if ((ptr = alloca(size)) == NULL) { \
@@ -172,7 +172,7 @@ gint g_chmod        (const gchar    *path,
 
 #define FILE_OP_ERROR(file, func) \
 { \
-       fprintf(stderr, "%s: ", file); \
+       g_printerr("%s: ", file); \
        fflush(stderr); \
        perror(func); \
 }
@@ -188,19 +188,34 @@ typedef gpointer (*GNodeMapFunc)  (gpointer nodedata, gpointer data);
 /* debug functions */
 void debug_set_mode            (gboolean mode);
 gboolean debug_get_mode                (void);
+
+#ifndef __CYGWIN__
 #define debug_print \
        debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
        debug_print_real
+#else
+  /* FIXME: cygwin: why debug_srcname couldn't be resolved in library? */
+#define debug_print \
+       debug_print_real("%s:%d:", __FILE__, __LINE__), \
+       debug_print_real
+#endif
 
 /* for macro expansion */
 #define Str(x) #x
 #define Xstr(x)        Str(x)
 
+
+/* System related stuff.  */
+
+gboolean superuser_p (void);
+
+
+/* String utilities.  */
+
 void list_free_strings         (GList          *list);
 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);
@@ -215,17 +230,12 @@ 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,
                                 gint         n);
 gchar *itos                    (gint         n);
-gchar *to_human_readable       (off_t        size);
+gchar *to_human_readable       (goffset      size);
 
 /* alternative string functions */
 gint strcmp2           (const gchar    *s1,
@@ -238,7 +248,7 @@ gchar *strretchomp  (gchar          *str);
 gchar *strtailchomp    (gchar          *str,
                         gchar           tail_char);
 gchar *strcrchomp      (gchar          *str);
-void file_strip_crs    (const gchar    *file);
+gint file_strip_crs    (const gchar    *file);
 gchar *strcasestr      (const gchar    *haystack,
                         const gchar    *needle);
 gpointer my_memmem     (gconstpointer   haystack,
@@ -249,42 +259,6 @@ gchar *strncpy2            (gchar          *dest,
                         const gchar    *src,
                         size_t          n);
 
-/* wide-character functions */
-#if !HAVE_ISWALNUM
-int iswalnum           (wint_t wc);
-#endif
-#if !HAVE_ISWSPACE
-int iswspace           (wint_t wc);
-#endif
-#if !HAVE_TOWLOWER
-wint_t towlower                (wint_t wc);
-#endif
-
-#if !HAVE_WCSLEN
-size_t wcslen          (const wchar_t *s);
-#endif
-#if !HAVE_WCSCPY
-wchar_t *wcscpy                (wchar_t       *dest,
-                        const wchar_t *src);
-#endif
-#if !HAVE_WCSNCPY
-wchar_t *wcsncpy       (wchar_t       *dest,
-                        const wchar_t *src,
-                        size_t         n);
-#endif
-
-wchar_t *wcsdup                        (const wchar_t *s);
-wchar_t *wcsndup               (const wchar_t *s,
-                                size_t         n);
-wchar_t *strdup_mbstowcs       (const gchar   *s);
-gchar *strdup_wcstombs         (const wchar_t *s);
-gint wcsncasecmp               (const wchar_t *s1,
-                                const wchar_t *s2,
-                                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 gchar *s);
 gint get_next_word_len         (const gchar *s);
 
@@ -293,8 +267,6 @@ 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,
@@ -303,27 +275,15 @@ void extract_parenthesis          (gchar          *str,
                                         gchar           op,
                                         gchar           cl);
 
-void extract_parenthesis_with_skip_quote       (gchar          *str,
-                                                gchar           quote_chr,
-                                                gchar           op,
-                                                gchar           cl);
-
-void eliminate_quote                   (gchar          *str,
-                                        gchar           quote_chr);
 void extract_quote                     (gchar          *str,
                                         gchar           quote_chr);
 void eliminate_address_comment         (gchar          *str);
 gchar *strchr_with_skip_quote          (const gchar    *str,
                                         gint            quote_chr,
                                         gint            c);
-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,
@@ -344,12 +304,11 @@ void unfold_line                  (gchar          *str);
 void subst_char                                (gchar          *str,
                                         gchar           orig,
                                         gchar           subst);
-void subst_chars                       (gchar          *str,
-                                        gchar          *orig,
-                                        gchar           subst);
+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 gchar    *str);
 gint get_quote_level                   (const gchar    *str,
                                         const gchar    *quote_chars);
@@ -357,16 +316,6 @@ gint check_line_length                     (const gchar    *str,
                                         gint            max_chars,
                                         gint           *line);
 
-gchar *strstr_with_skip_quote          (const gchar    *haystack,
-                                        const gchar    *needle);
-gchar *strchr_parenthesis_close                (const gchar    *str,
-                                        gchar           op,
-                                        gchar           cl);
-
-gchar **strsplit_parenthesis           (const gchar    *str,
-                                        gchar           op,
-                                        gchar           cl,
-                                        gint            max_tokens);
 gchar **strsplit_with_quote            (const gchar    *str,
                                         const gchar    *delim,
                                         gint            max_tokens);
@@ -382,32 +331,42 @@ gchar *get_uri_path                       (const gchar    *uri);
 gint get_uri_len                       (const gchar    *str);
 void decode_uri                                (gchar          *decoded_uri,
                                         const gchar    *encoded_uri);
+void decode_uri_with_plus              (gchar          *decoded_uri, 
+                                        const gchar    *encoded_uri, 
+                                        gboolean        with_plus);
 gint scan_mailto_url                   (const gchar    *mailto,
+                                        gchar         **from,
                                         gchar         **to,
                                         gchar         **cc,
                                         gchar         **bcc,
                                         gchar         **subject,
-                                        gchar         **body);
+                                        gchar         **body,
+                                        gchar         ***attach);
 
 /* return static strings */
 const gchar *get_home_dir              (void);
 const gchar *get_rc_dir                        (void);
+void  set_rc_dir                       (const gchar *dir);
+gboolean rc_dir_is_alt                 (void);
 const gchar *get_mail_base_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_plugin_dir             (void);
 const gchar *get_tmp_dir               (void);
+const gchar *get_locale_dir            (void);
 gchar *get_tmp_file                    (void);
 const gchar *get_domain_name           (void);
-
+#ifdef G_OS_WIN32
+const gchar *get_themes_dir             (void);
+const gchar *get_cert_file             (void);
+#endif
 /* file / directory handling */
 off_t get_file_size            (const gchar    *file);
 off_t get_file_size_as_crlf    (const gchar    *file);
-off_t get_left_file_size       (FILE           *fp);
+
+time_t get_file_mtime          (const gchar *file);
 
 gboolean file_exist            (const gchar    *file,
                                 gboolean        allow_fifo);
@@ -415,7 +374,6 @@ gboolean is_relative_filename   (const gchar *file);
 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)
@@ -430,8 +388,6 @@ gint remove_numbered_files  (const gchar    *dir,
 gint remove_numbered_files_not_in_list(const gchar *dir,
                                       GSList *numberlist);
 gint remove_all_numbered_files (const gchar    *dir);
-gint remove_expired_files      (const gchar    *dir,
-                                guint           hours);
 gint remove_dir_recursive      (const gchar    *dir);
 gint append_file               (const gchar    *src,
                                 const gchar    *dest,
@@ -459,9 +415,6 @@ 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);
 
@@ -477,10 +430,12 @@ 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);
+gchar *file_read_to_str_no_recode(const gchar *file);
+gchar *file_read_stream_to_str_no_recode(FILE *fp);
+
+char *fgets_crlf(char *buf, int size, FILE *stream);
 
 /* 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);
@@ -497,10 +452,10 @@ gchar *tzoffset                   (time_t         *now);
 void get_rfc822_date           (gchar          *buf,
                                 gint            len);
 
-size_t my_strftime             (gchar                  *s,
-                                size_t                  max,
-                                const gchar            *format,
-                                const struct tm        *tm);
+size_t fast_strftime           (gchar                  *buf, 
+                                gint                    buflen, 
+                                const gchar            *format, 
+                                struct tm              *lt);
 
 /* debugging */
 void debug_print_real  (const gchar *format, ...) G_GNUC_PRINTF(1, 2);
@@ -511,16 +466,13 @@ 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);
+void utils_free_regex(void);
 gint subject_get_prefix_length (const gchar *subject);
 
 /* quoting recognition */
 const gchar * line_has_quote_char      (const gchar *str,
                                         const gchar *quote_chars);
-const gchar * line_has_quote_char_last (const gchar *str,
-                                        const gchar *quote_chars);
 
-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);
@@ -545,16 +497,33 @@ gpointer g_auto_pointer_get_ptr           (GAuto *auto_ptr);
 GAuto *g_auto_pointer_copy             (GAuto *auto_ptr);
 void g_auto_pointer_free               (GAuto *auto_ptr);
 void replace_returns                   (gchar *str);
-
-gboolean get_uri_part(const gchar *start, const gchar *scanpos,
-                            const gchar **bp, const gchar **ep, gboolean hdr);
-gchar *make_uri_string(const gchar *bp, const gchar *ep);
-gboolean get_email_part(const gchar *start, const gchar *scanpos,
-                              const gchar **bp, const gchar **ep, gboolean hdr);
-gchar *make_email_string(const gchar *bp, const gchar *ep);
-gchar *make_http_string(const gchar *bp, const gchar *ep);
-gchar *mailcap_get_command_for_type(const gchar *type);
-
+gboolean get_uri_part  (const gchar *start,
+                        const gchar *scanpos,
+                        const gchar **bp,
+                        const gchar **ep,
+                        gboolean hdr);
+gchar *make_uri_string (const gchar *bp,
+                        const gchar *ep);
+gboolean get_email_part        (const gchar *start, 
+                        const gchar *scanpos,
+                        const gchar **bp, 
+                        const gchar **ep,
+                        gboolean hdr);
+gchar *make_email_string(const gchar *bp,
+                        const gchar *ep);
+gchar *make_http_string (const gchar *bp,
+                        const gchar *ep);
+
+gchar *mailcap_get_command_for_type(const gchar *type, 
+                                   const gchar *file_to_open);
+void mailcap_update_default       (const gchar *type,
+                                   const gchar *command);
+
+gboolean file_is_email(const gchar *filename);
+gboolean sc_g_list_bigger(GList *list, gint max);
+gboolean sc_g_slist_bigger(GSList *list, gint max);
+
+int claws_unlink(const gchar *filename);
 #ifdef __cplusplus
 }
 #endif