* Fixes NB@63545

[modest] / src / modest-text-utils.h

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index 2248d90..64a5a4a 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -35,8 +35,19 @@
 
 #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)
+
+/* 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:
@@ -183,7 +194,7 @@ 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:
@@ -199,6 +210,21 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t
  */
 gchar* 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: a newly allocated string with the copy.
+ * 
+ * NULL in case of error or if address == NULL
+ */
+gchar* modest_text_utils_get_email_address (const gchar *email_address);
+
 
 /**
  * modest_text_utils_get_subject_prefix_len:
@@ -250,19 +276,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()
@@ -271,7 +327,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:
@@ -297,4 +354,35 @@ 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;
+
+gboolean     modest_text_utils_is_forbidden_char (const gchar character,
+                                                 ModestTextUtilsForbiddenCharType type);
+
 #endif /* __MODEST_TEXT_UTILS_H__ */