2006-02-05 [colin] 2.0.0cvs12
[claws.git] / src / common / utils.h
index df8e57607c03b0fac71691f97f888c5200d67f4e..5529ca3d6630ca655f284d5ae849b5ef9aa2bcb3 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2003 Hiroyuki Yamamoto
+ * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws 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__
@@ -25,6 +25,7 @@
 #endif
 
 #include <glib.h>
+#include <glib-object.h>
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.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
 #define FILE_OP_ERROR(file, func) \
 { \
        fprintf(stderr, "%s: ", file); \
+       fflush(stderr); \
        perror(func); \
 }
 
@@ -156,7 +189,7 @@ typedef gpointer (*GNodeMapFunc)    (gpointer nodedata, gpointer data);
 void debug_set_mode            (gboolean mode);
 gboolean debug_get_mode                (void);
 #define debug_print \
-       debug_print_real(__FILE__ ":%d:", __LINE__), \
+       debug_print_real("%s:%d:", debug_srcname(__FILE__), __LINE__), \
        debug_print_real
 
 /* for macro expansion */
@@ -175,6 +208,18 @@ 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,
@@ -193,8 +238,13 @@ 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);
@@ -235,8 +285,8 @@ 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 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,
@@ -278,6 +328,8 @@ 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,
@@ -298,9 +350,13 @@ void subst_chars                   (gchar          *str,
 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,
@@ -323,6 +379,7 @@ gchar *trim_string                  (const gchar    *str,
 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);
 gint scan_mailto_url                   (const gchar    *mailto,
@@ -335,12 +392,14 @@ gint scan_mailto_url                      (const gchar    *mailto,
 /* return static strings */
 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);
 gchar *get_tmp_file                    (void);
 const gchar *get_domain_name           (void);
@@ -352,6 +411,7 @@ off_t get_left_file_size    (FILE           *fp);
 
 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);
@@ -376,12 +436,16 @@ 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,
@@ -423,6 +487,8 @@ 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);
@@ -431,8 +497,14 @@ 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);
+
 /* 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);
@@ -451,7 +523,7 @@ 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          (const gchar *address, gchar *buf, gint len);
+gchar *generate_msgid          (gchar *buf, gint len);
 gchar *generate_mime_boundary  (const gchar *prefix);
 
 gint quote_cmd_argument(gchar * result, guint size,
@@ -461,6 +533,29 @@ 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);
+gboolean file_is_email (const gchar *filename);
+
 #ifdef __cplusplus
 }
 #endif