X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=59c0714ef2d50744c5b87bd21c6dbd420c7231b2;hp=4077bab26954463f2663746c6e1c25e2d6661e04;hb=a31e3b7e2d3779420c9e0b62fc0ffba214137f0e;hpb=0602d943a3f435e3a091262d4177b842a41fd530 diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index 4077bab..59c0714 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -37,11 +37,15 @@ #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) +#define _AB(str) dgettext("osso-addressbook",str) +#define _KR(str) dgettext("ke-recv",str) +#define _UR(str) dgettext("osso-uri",str) /* Forbidden char arrays */ extern const gchar account_title_forbidden_chars[]; @@ -51,6 +55,10 @@ extern const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH; extern const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH; extern const guint USER_NAME_FORBIDDEN_CHARS_LENGTH; +/* It includes a white space as RFC 3676 Section 4.3 about usenet + message signatures defines */ +#define MODEST_TEXT_UTILS_SIGNATURE_MARKER "-- " + /** * modest_text_utils_derived_subject: * @subject: a string which contains the original subject @@ -128,11 +136,11 @@ gchar* modest_text_utils_inline (const gchar *text, /** * 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 @@ -140,6 +148,19 @@ gchar* modest_text_utils_inline (const gchar *text, 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: non-NULL utf8 string containing a list of addresses @@ -160,14 +181,14 @@ void modest_text_utils_address_range_at_position (const gchar *recipients_li /** * modest_text_utils_hyperlinkify_begin: * - * begin a linkify block, compiling the caches to be reused. + * begin a linkify block, compiling the caches to be reused. Use it in mainloop. */ void modest_text_utils_hyperlinkify_begin (void); /** * modest_text_utils_hyperlinkify_end: * - * end a linkify block, freeing the caches to be reused. + * end a linkify block, freeing the caches to be reused. Use it in mainloop. */ void modest_text_utils_hyperlinkify_end (void); @@ -206,7 +227,14 @@ gchar* modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gbo */ 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_address: @@ -223,6 +251,19 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t void modest_text_utils_get_display_address (gchar *address); /** + * modest_text_utils_get_display_addresses: + * @addresses: a list of comma-separated addresses + * + * Transforms a list of email addresses in a list of recipients, + * replacing each plain email address by the correspondent display + * address. + * + * Returns: a newly allocated string, that must be freed by the caller + **/ +gchar *modest_text_utils_get_display_addresses (const gchar *addresses); + + +/** * modest_text_utils_get_email_address: * @full_address: original address (UTF8 string) * @@ -352,11 +393,27 @@ gboolean modest_text_utils_validate_recipient (const gchar *recipient, * 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_join_addresses: + * @from: comma separated string of addresses + * @to: comma separated string of addresses + * @cc: comma separated string of addresses + * @bcc: comma separated string of addresses + * + * joins all the addresses in a single comma-separated string + * + * Returns: a newly allocated string with a list of addresses + **/ +gchar *modest_text_utils_join_addresses (const gchar *from, + const gchar *to, + const gchar *cc, + const gchar *bcc); + +/** * modest_text_utils_get_addresses_indexes: * @addresses: a string * @start_indexes: a #GSList pointer @@ -370,6 +427,16 @@ 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_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 * @@ -397,6 +464,15 @@ typedef enum { 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: @@ -410,5 +486,79 @@ typedef enum { 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); + +/** + * modest_text_utils_simplify_recipients: + * @recipients: a list of recipients + * + * returns a list of simplified recipients: + * * a@b converted to a@b + * * NULL converted to "" + * + * It's mainly intended for printing in screen addresses, but it can + * also be used for reply/forward. + */ +gchar *modest_text_utils_simplify_recipients (const gchar *recipient); + +/** + * modest_text_utils_remove_duplicate_addresses_list + * @address_list: non-NULL #GSList of email addresses + * + * remove duplicate addresses from a list of email addresses + * + * Returns: a list without the duplicate addresses or NULL in case of + * error or the original @address_list was NULL + */ +GSList *modest_text_utils_remove_duplicate_addresses_list (GSList *address_list); + +/** + * modest_text_utils_get_secure_header: + * @value: the value of a mail header + * @header: the header that we're evaluating + * + * This function returns the secure value for a header. Basically it + * avoids DoS attacks caused by specially malformed headers like for + * example. From:From:From...From: some@mail.com + * + * Returns: returns the secured header + **/ +gchar * modest_text_utils_get_secure_header (const gchar *value, const gchar *header); + +/** + * modest_text_utils_quote_names: + * @recipients: a list of valid email addresses separated by ',' or ';' + * + * This function quotes the name part of an email address if it's not + * quoted and if it exists. For example + * aaa@bbb.com -> aaa@bbb.com + * "my name" -> "my name" + * my name aaa@bbb.com -> "my name" aaa@bbb.com + * + * It even supports things like + * my, name , aaa@ccc.com -> "my, name" ; aaa@ccc.com + * + * Returns: a newly allocated string with the quoted email addresses + **/ +gchar * modest_text_utils_quote_names (const gchar *recipients); #endif /* __MODEST_TEXT_UTILS_H__ */