* revert to the in-place 'modest_text_utils_get_display_address',

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

diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h
index 549bfbd..5945c34 100644 (file)
--- a/src/modest-text-utils.h
+++ b/src/modest-text-utils.h
@@ -36,9 +36,20 @@
 #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:
@@ -185,21 +196,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);
 
 
 /**
@@ -252,6 +275,17 @@ 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
@@ -265,6 +299,20 @@ gchar * modest_text_utils_get_display_size (guint64 size);
 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
@@ -316,4 +364,35 @@ void         modest_text_utils_get_addresses_indexes (const gchar *addresses, GS
  */
 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__ */