* make modest_text_utils_get_display_date return a ptr to
[modest] / src / modest-text-utils.h
index d896346..e11d702 100644 (file)
 
 #include <time.h>
 #include <glib.h>
+#include <gdk/gdkcolor.h>
+#include <gtk/gtktextbuffer.h>
 
 #define _FM(str) dgettext("hildon-fm",str)
+#define _CS(str) dgettext("hildon-common-strings",str)
+#define _HL(str) dgettext("hildon-libs",str)
+#define _MD(str) dgettext("maemo-af-desktop",str)
+
+/* Forbidden char arrays */
+extern const gchar account_title_forbidden_chars[];
+extern const gchar folder_name_forbidden_chars[];
+extern const gchar user_name_forbidden_chars[];
+extern const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH;
+extern const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH;
+extern const guint USER_NAME_FORBIDDEN_CHARS_LENGTH;
 
 /**
  * modest_text_utils_derived_subject:
@@ -60,6 +73,7 @@ gchar* modest_text_utils_derived_subject (const gchar *subject,
  * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
  * @signature: NULL or the signature to add
  * @sent_date: sent date/time of the original message
+ * @attachments: a #GList of the attachments
  * @limit: specifies the maximum characters per line in the quoted text
  * 
  * quote an existing message
@@ -71,6 +85,7 @@ gchar* modest_text_utils_quote (const gchar *text,
                                const gchar *signature,
                                const gchar *from,
                                const time_t sent_date, 
+                               GList *attachments,
                                int limit);
 
 
@@ -141,7 +156,20 @@ void     modest_text_utils_address_range_at_position (const gchar *recipients_li
                                                      gint position,
                                                      gint *start,
                                                      gint *end);
-                                                     
+
+/**
+ * modest_text_utils_hyperlinkify_begin:
+ *
+ * begin a linkify block, compiling the caches to be reused.
+ */
+void modest_text_utils_hyperlinkify_begin (void);
+
+/**
+ * modest_text_utils_hyperlinkify_end:
+ *
+ * end a linkify block, freeing the caches to be reused.
+ */
+void modest_text_utils_hyperlinkify_end (void);
 
 /**
  * modest_text_utils_convert_to_html:
@@ -161,7 +189,7 @@ gchar*  modest_text_utils_convert_to_html (const gchar *txt);
  * 
  * Returns: a newly allocated string containing the html
  */
-gchar*  modest_text_utils_convert_to_html_body (const gchar *data);
+gchar*  modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify);
 
 
 /**
@@ -181,21 +209,33 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t
 
 
 /**
- * modest_text_utils_get_display_addres:
+ * modest_text_utils_get_display_address:
  * @address: original address (UTF8 string)
  *
  * make a 'display address' from an address:
- * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
- * ie. removes "<...>" and "(...)" parts
- * the change is in-place; removes leading/trailing whitespace
+ * "Foo Bar <foo@bar.cx>" --> "Foo Bar"
+ * ie. removes "<...>" parts
+ * the change is in-place; removes leading whitespace
+ * 
+ * NOTE: for optimization reasons, this function changes @address
+ * in-place
+ */
+void modest_text_utils_get_display_address (gchar *address);
+
+/**
+ * modest_text_utils_get_email_address:
+ * @full_address: original address (UTF8 string)
+ *
+ * make a 'foo@bar.cx' from an address:
+ * "Foo Bar <foo@bar.cx> (Bla)" --> "foo@bar.cx"
+ * If no "<...>" is found, then it returns the full
+ * strings.
  * 
- * Returns: the new address of the string; this new string
- * is _NOT_ newly allocated, so should not be freed. (remember
- * the old address of the parameter if that one needs to be freed)
+ * Returns: a newly allocated string with the copy.
  * 
  * NULL in case of error or if address == NULL
  */
-gchar* modest_text_utils_get_display_address (gchar *address);
+gchar* modest_text_utils_get_email_address (const gchar *email_address);
 
 
 /**
@@ -230,10 +270,13 @@ gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean i
  *
  * get a string representation for a date.
  * 
- * Returns: the new display date, as a newly allocated string;
- * free with g_free
+ * Returns: the new display date, as a *static* string.
+ * This string should not be modified, and will change
+ * upon recalling this function. g_strdup it if you to
+ * do so.
+ * 
  */
-gchar* modest_text_utils_get_display_date (time_t date);
+const gchar* modest_text_utils_get_display_date (time_t date);
 
 
 /**
@@ -248,19 +291,49 @@ gchar* modest_text_utils_get_display_date (time_t date);
 gchar * modest_text_utils_get_display_size (guint64 size);
 
 
+
+/**
+ * modest_text_utils_validate_domain_name:
+ * @email_address: a NULL-terminated string
+ * 
+ * validates the domain name passed as argument
+ * 
+ * Returns: TRUE if the domain name is valid, FALSE otherwise
+ **/
+gboolean modest_text_utils_validate_domain_name (const gchar *domain);
+
 /**
  * modest_text_utils_validate_email_address:
  * @email_address: a string
+ * @invalid_char_position: pointer to the position of the invalid
+ * character in case validation failed because of this, or %NULL.
  * 
  * validates the email address passed as argument
  * 
  * Returns: TRUE if the address is valid, FALSE otherwise
  **/
-gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
+gboolean     modest_text_utils_validate_email_address (const gchar *email_address, 
+                                                      const gchar **invalid_char_position);
+
+
+/**
+ * modest_text_utils_validate_folder_name:
+ * @folder_name: a string
+ * 
+ * validates the folder name passed as argument. a 'valid folder name'
+ * is a name which should be valid on both Unix and Windows file systems.
+ * of course, this might be stricter than strictly needed in some cases,
+ * but it's better to err on the safe side.
+ * 
+ * Returns: TRUE if the folder name is valid, FALSE otherwise
+ **/
+gboolean modest_text_utils_validate_folder_name (const gchar *folder_name);
 
 /**
  * modest_text_utils_validate_recipient:
  * @recipient: a string
+ * @invalid_char_position: pointer to the position of the invalid char,
+ * if validation failed because there's an invalid char there, or %NULL.
  *
  * validates @recipient as a valid recipient field for header.
  * It's different from modest_text_utils_validate_email_address()
@@ -269,7 +342,8 @@ gboolean     modest_text_utils_validate_email_address (const gchar *email_addres
  *
  * Returns: %TRUE if the recipient is valid, FALSE otherwise
  **/
-gboolean     modest_text_utils_validate_recipient (const gchar *recipient);
+gboolean     modest_text_utils_validate_recipient (const gchar *recipient,
+                                                  const gchar **invalid_char_position);
 
 /**
  * modest_text_utils_split_addresses_list:
@@ -295,4 +369,46 @@ GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
  **/
 void         modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
 
+/**
+ * modest_text_utils_get_color_string:
+ * @color: a #GdkColor
+ *
+ * Obtains a proper markup string for @color, in the format used
+ * by Pango and HTML.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *      modest_text_utils_get_color_string (GdkColor *color);
+
+/**
+ * modest_text_utils_text_buffer_get_text:
+ * @buffer: a #GtkTextBuffer
+ *
+ * Obtains the contents of a @buffer in a string, replacing image
+ * pixbufs with blank spaces.
+ *
+ * Returns: a newly allocated UTF-8 string
+ */
+gchar *      modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer);
+
+typedef enum {
+       ACCOUNT_TITLE_FORBIDDEN_CHARS,
+       FOLDER_NAME_FORBIDDEN_CHARS,
+       USER_NAME_FORBIDDEN_NAMES,
+} ModestTextUtilsForbiddenCharType;
+
+
+/**
+ * modest_text_utils_is_forbidden_char:
+ * @character: some character
+ * @type: the type of forbidden char (see #ModestTextUtilsForbiddenCharType)
+ * 
+ * check whether the given character is 'forbidden'
+ *
+ * Returns: TRUE if it's forbidden, FALSE otherwise
+ */
+gboolean     modest_text_utils_is_forbidden_char (const gchar character,
+                                                 ModestTextUtilsForbiddenCharType type);
+
+
 #endif /* __MODEST_TEXT_UTILS_H__ */