2007-02-27 [colin] 2.8.0cvs6
[claws.git] / src / common / utils.h
index 13af7e143383acbd4c11e9a524a93113e7a8d7dd..65779c101a2b39661abd5dc653ac4caf02f6b0b9 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-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
@@ -14,7 +14,7 @@
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef __UTILS_H__
 #endif
 
 #include <glib.h>
+#include <glib-object.h>
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
 #include <unistd.h>
 #include <sys/types.h>
+#include <dirent.h>
 #include <time.h>
 #if HAVE_ALLOCA_H
 #  include <alloca.h>
 #  include <wchar.h>
 #endif
 
+/* Wrappers for C library function that take pathname arguments. */
+#if GLIB_CHECK_VERSION(2, 6, 0)
+#  include <glib/gstdio.h>
+#else
+
+#define g_open         open
+#define g_rename       rename
+#define g_mkdir                mkdir
+#define g_stat         stat
+#define g_lstat                lstat
+#define g_unlink       unlink
+#define g_remove       remove
+#define g_rmdir                rmdir
+#define g_fopen                fopen
+#define g_freopen      freopen
+
+#endif /* GLIB_CHECK_VERSION */
+
+#if !GLIB_CHECK_VERSION(2, 7, 0)
+
+#ifdef G_OS_UNIX
+#define g_chdir                chdir
+#define g_chmod                chmod
+#else
+gint g_chdir   (const gchar    *path);
+gint g_chmod   (const gchar    *path,
+                gint            mode);
+#endif /* G_OS_UNIX */
+
+#endif /* !GLIB_CHECK_VERSION */
+
 /* The AC_CHECK_SIZEOF() in configure fails for some machines.
  * we provide some fallback values here */
 #if !SIZEOF_UNSIGNED_SHORT
        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); \
+       fflush(stderr); \
        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);
+
+#ifndef __CYGWIN__
 #define debug_print \
-       debug_print_real(__FILE__ ":%d:", __LINE__), \
+       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
@@ -152,8 +210,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,
@@ -172,53 +246,27 @@ gchar *strretchomp        (gchar          *str);
 gchar *strtailchomp    (gchar          *str,
                         gchar           tail_char);
 gchar *strcrchomp      (gchar          *str);
+void file_strip_crs    (const gchar    *file);
 gchar *strcasestr      (const gchar    *haystack,
                         const gchar    *needle);
+gpointer my_memmem     (gconstpointer   haystack,
+                        size_t          haystacklen,
+                        gconstpointer   needle,
+                        size_t          needlelen);
 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);
-
-gboolean is_next_nonascii      (const guchar *s);
+gboolean is_next_nonascii      (const gchar *s);
 gint get_next_word_len         (const gchar *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 +275,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 +292,16 @@ 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_prepend                (GSList         *msgid_list,
+                                        const gchar    *str);
 GSList *references_list_append         (GSList         *msgid_list,
                                         const gchar    *str);
 GSList *newsgroup_list_append          (GSList         *group_list,
@@ -271,10 +320,15 @@ 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);
+gboolean is_ascii_str                  (const gchar    *str);
 gint get_quote_level                   (const gchar    *str,
                                         const gchar    *quote_chars);
+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,
@@ -290,43 +344,57 @@ gchar **strsplit_with_quote               (const gchar    *str,
                                         gint            max_tokens);
 
 gchar *get_abbrev_newsgroup_name       (const gchar    *group,
-                                        gint            len);
-
+                                        gint            len);
 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);
+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         **to,
                                         gchar         **cc,
                                         gchar         **bcc,
                                         gchar         **subject,
-                                        gchar         **body);
+                                        gchar         **body,
+                                        gchar         **attach);
 
 /* 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_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);
 
 /* 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);
+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)
@@ -347,35 +415,57 @@ gint remove_dir_recursive (const gchar    *dir);
 gint append_file               (const gchar    *src,
                                 const gchar    *dest,
                                 gboolean        keep_backup);
+gint rename_force              (const gchar    *oldpath,
+                                const gchar    *newpath);
 gint copy_file                 (const gchar    *src,
                                 const gchar    *dest,
                                 gboolean        keep_backup);
 gint move_file                 (const gchar    *src,
                                 const gchar    *dest,
                                 gboolean        overwrite);
+gint copy_dir                  (const gchar    *src,
+                                const gchar    *dest);
+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);
+/* open file with text editor */
+gint open_txt_editor(const gchar *filepath, const gchar *cmdline);
 
 /* time functions */
 time_t remote_tzoffset_sec     (const gchar    *zone);
@@ -384,15 +474,25 @@ 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);
+const char * debug_srcname (const char *file);
 
 /* subject threading */
 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,
@@ -400,10 +500,59 @@ 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);
+
+/* auto pointer for containers that support GType system */
+
+#define G_TYPE_AUTO_POINTER    g_auto_pointer_register()
+typedef struct AutoPointer     GAuto;
+GType g_auto_pointer_register          (void);
+GAuto *g_auto_pointer_new              (gpointer pointer);
+GAuto *g_auto_pointer_new_with_free    (gpointer p, 
+                                        GFreeFunc free);
+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, 
+                                   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);
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* __UTILS_H__ */