X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=5945c340020c5e9893cfcd87759ccacec6e4ee63;hp=18dea347926c7a4afbcd20af0f9a0d03fe4c0a6e;hb=51ee3dbf9a9338a7683fb2efe9daeefb316849bd;hpb=32ba35b63ed6986eab57acf8bfd76dba10ee129e diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index 18dea34..5945c34 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -35,6 +35,21 @@ #include #include +#include +#include + +#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: @@ -56,7 +71,9 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, * @text: a non-NULL string which contains the message to quote * @from: a non-NULL sender of the original message * @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 @@ -65,8 +82,10 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, */ gchar* modest_text_utils_quote (const gchar *text, const gchar *content_type, + const gchar *signature, const gchar *from, const time_t sent_date, + GList *attachments, int limit); @@ -82,6 +101,7 @@ gchar* modest_text_utils_quote (const gchar *text, */ gchar* modest_text_utils_cite (const gchar *text, const gchar *content_type, + const gchar *signature, const gchar *from, time_t sent_date); @@ -100,6 +120,7 @@ gchar* modest_text_utils_cite (const gchar *text, */ gchar* modest_text_utils_inline (const gchar *text, const gchar *content_type, + const gchar *signature, const gchar *from, time_t sent_date, const gchar *to, @@ -139,7 +160,7 @@ void modest_text_utils_address_range_at_position (const gchar *recipients_li /** * modest_text_utils_convert_to_html: - * @txt: a string which contains the message to quote + * @txt: a string * * convert plain text (utf8) into html * @@ -147,6 +168,16 @@ void modest_text_utils_address_range_at_position (const gchar *recipients_li */ gchar* modest_text_utils_convert_to_html (const gchar *txt); +/** + * modest_text_utils_convert_to_html_body: + * @txt: a string + * + * convert plain text (utf8) into html without adding html headers. + * + * Returns: a newly allocated string containing the html + */ +gchar* modest_text_utils_convert_to_html_body (const gchar *data); + /** * modest_text_utils_strftime: @@ -165,18 +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 (Bla)" --> "Foo Bar" - * ie. removes "<...>" and "(...)" parts - * the change is in-place; removes leading/trailing whitespace + * "Foo Bar " --> "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 (Bla)" --> "foo@bar.cx" + * If no "<...>" is found, then it returns the full + * strings. + * + * Returns: a newly allocated string with the copy. * - * Returns: the new address. The string is *not* newly allocated. - * NULL in case of error + * 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); /** @@ -226,18 +272,62 @@ gchar* modest_text_utils_get_display_date (time_t date); * Returns: the newly allocated display string for the * size in bytes. must be freed. */ -gchar * modest_text_utils_get_display_size (guint size); +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() + * as it validates a whole recipient, and not only the part between + * the < and > symbols. + * + * Returns: %TRUE if the recipient is valid, FALSE otherwise + **/ +gboolean modest_text_utils_validate_recipient (const gchar *recipient, + const gchar **invalid_char_position); /** * modest_text_utils_split_addresses_list: @@ -250,4 +340,59 @@ gboolean modest_text_utils_validate_email_address (const gchar *email_addres **/ GSList *modest_text_utils_split_addresses_list (const gchar *addresses); +/** + * modest_text_utils_get_addresses_indexes: + * @addresses: a string + * @start_indexes: a #GSList pointer + * @end_indexes: a #GSList pointer + * + * obtains two #GSList of @addresses with the range offsets of the addresses in + * the string + * + * Returns: a GSList of strings + **/ +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__ */