X-Git-Url: http://git.maemo.org/git/?a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=4077bab26954463f2663746c6e1c25e2d6661e04;hb=11a31802a2dedb9672769e27dafabacf404d02f3;hp=401907f0f5eb1ffd211def2f44aaf7e63d586c5c;hpb=fdf3571635d4c34c057c7734785e8e6685036567;p=modest diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index 401907f..4077bab 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -40,6 +40,16 @@ #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: @@ -132,7 +142,7 @@ gchar* modest_text_utils_remove_address (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 @@ -143,10 +153,23 @@ gchar* modest_text_utils_remove_address (const gchar *address_list, * @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: @@ -166,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); /** @@ -190,17 +213,14 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t * @address: original address (UTF8 string) * * make a 'display address' from an address: - * "Foo Bar (Bla)" --> "Foo Bar" - * ie. removes "<...>" and "(...)" parts - * the change is in-place; removes leading/trailing whitespace - * - * 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) + * "Foo Bar <foo@bar.cx>" --> "Foo Bar" + * ie. removes "<...>" parts + * the change is in-place; removes leading whitespace * - * NULL in case of error or if address == NULL + * NOTE: for optimization reasons, this function changes @address + * in-place */ -gchar* modest_text_utils_get_display_address (gchar *address); +void modest_text_utils_get_display_address (gchar *address); /** * modest_text_utils_get_email_address: @@ -250,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); /** @@ -268,6 +291,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 @@ -281,6 +315,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 @@ -343,4 +391,24 @@ gchar * modest_text_utils_get_color_string (GdkColor *color); */ 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__ */