#include <time.h>
#include <glib.h>
#include <gdk/gdkcolor.h>
+#include <gtk/gtktextbuffer.h>
+#include <gtk/gtklabel.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)
+#define _AB(str) dgettext("osso-addressbook",str)
+#define _KR(str) dgettext("ke-recv",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:
/**
* modest_text_utils_remove_address
- * @address_list: none-NULL string with a comma-separated list of email addresses
+ * @address_list: non-NULL string with a comma-separated list of email addresses
* @address: an specific e-mail address
*
* remove a specific address from a list of email addresses; if @address
- * is NULL, returns an unchanged @address_list
+ * is NULL, returns an unchanged (but newly allocated) @address_list
*
* Returns: a newly allocated string containing the new list, or NULL
* in case of error or the original @address_list was NULL
gchar* modest_text_utils_remove_address (const gchar *address_list,
const gchar *address);
+
+/**
+ * modest_text_utils_remove_duplicate_addresses
+ * @address_list: non-NULL string with a comma-separated list of email addresses
+ *
+ * remove duplicate addresses from a list of email addresses
+ *
+ * Returns: a newly allocated string containing the new list, or NULL
+ * in case of error or the original @address_list was NULL
+ */
+gchar* modest_text_utils_remove_duplicate_addresses (const gchar *address_list);
+
+
/**
* modest_text_utils_address_range_at_position:
- * @address_list: utf8 string containing a list of addresses
+ * @address_list: non-NULL utf8 string containing a list of addresses
* @position: a gint
* @start: a gint pointer
* @end: a gint pointer
* @end
*/
void modest_text_utils_address_range_at_position (const gchar *recipients_list,
- gint position,
- gint *start,
- gint *end);
-
+ guint position,
+ guint *start,
+ guint *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:
*
* 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);
/**
*/
size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet);
-
+/**
+ * modest_text_utils_hyperlinkify:
+ * @string_buffer: buffer where we replace uri strings with links
+ *
+ * Replace uri's with links in the buffer. This is required that the document
+ * do not contain linkified links already.
+ */
+void modest_text_utils_hyperlinkify (GString *string_buffer);
/**
- * 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);
/**
*
* 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);
/**
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()
*
* 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:
* obtains a GSList of addresses from a string of addresses
* in the format understood by email protocols
*
- * Returns: a GSList of strings
+ * Returns: a newly allocated GSList of strings
**/
GSList *modest_text_utils_split_addresses_list (const gchar *addresses);
+
/**
* modest_text_utils_get_addresses_indexes:
* @addresses: a string
void modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
/**
+ * modest_text_utils_address_with_standard_length:
+ * @recipients_list: a string
+ *
+ * obtains the list of recipients, but making sure that lines are not longer than 1000 chars
+ *
+ * Returns: a newly allocated string
+ */
+gchar * modest_text_utils_address_with_standard_length (const gchar *recipients_list);
+
+/**
* modest_text_utils_get_color_string:
* @color: a #GdkColor
*
*/
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_label_get_selection:
+ * @label: a #GtkLabel
+ *
+ * Obtain the current selection of @label
+ *
+ * Returns: a string with current selection, or %NULL if no selection in @label
+ */
+gchar * modest_text_utils_label_get_selection (GtkLabel *label);
+
+/**
+ * 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);
+
+/**
+ * modest_text_utils_buffer_selection_is_valid:
+ * @buffer: a #GtkTextBuffer
+ *
+ * Checks if @buffer contains a valid selection for cut/copy. This means it's
+ * not empty, and no images are in the selection.
+ *
+ * Returns: %TRUE if there's a valid selection, false otherwise.
+ */
+gboolean modest_text_utils_buffer_selection_is_valid (GtkTextBuffer *buffer);
+
+/**
+ * modest_text_utils_escape_mnemonics:
+ * @text: a string
+ *
+ * obtains the representation of text, but escaping mnemonics (we duplicate _)
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_text_utils_escape_mnemonics (const gchar *text);
+
+
#endif /* __MODEST_TEXT_UTILS_H__ */