X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=21bad3f56b5aa6eae585ac6c1e9d8e94e0a81654;hp=c3199f965775e6ae9fca463f22f408c5d900b1a9;hb=85b60b61bf30595fabd3bb9b3c5e2d9a0592912f;hpb=3084439a659fa9aec750337f94cad4bca0c92898 diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index c3199f9..21bad3f 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -34,15 +34,23 @@ #define __MODEST_TEXT_UTILS_H__ #include +#include +#include +#include + +#define _FM(str) dgettext("hildon-fm",str) +#define _CS(str) dgettext("hildon-common-strings",str) /** * modest_text_utils_derived_subject: * @subject: a string which contains the original subject - * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:') + * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'), + * must not be NULL * * create a 'derived' subject line for eg. replies and forwards * * Returns: a newly allocated string containing the resulting subject + * subject == NULL, then @prefix " " will be returned */ gchar* modest_text_utils_derived_subject (const gchar *subject, const gchar* prefix); @@ -50,9 +58,12 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, /** * modest_text_utils_quote: - * @buf: a string which contains the message to quote - * @from: the sender of the original message + * @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 @@ -61,8 +72,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); @@ -78,16 +91,17 @@ 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); /** * modest_text_utils_inlined_text - * @from: the sender of the original message + * @from: the non-NULL sender of the original message * @sent_date: sent date/time of the original message - * @to: sent date/time of the original message - * @subject: sent date/time of the original message - * @text: sent date/time of the original message + * @to: + * @subject: + * @text: * * creates a new string with the "Original message" text prepended to * the text passed as argument and some data of the header @@ -96,6 +110,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, @@ -103,25 +118,55 @@ gchar* modest_text_utils_inline (const gchar *text, /** * modest_text_utils_remove_address - * @address_list: string with a comma-separated list of email addresses - * @address: an specific e-mail address + * @address_list: none-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 + * remove a specific address from a list of email addresses; if @address + * is NULL, returns an unchanged @address_list * - * Returns: a newly allocated string containing the new 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_address_range_at_position: + * @address_list: utf8 string containing a list of addresses + * @position: a gint + * @start: a gint pointer + * @end: a gint pointer + * + * Finds the start and end positions of the address at @position, + * in @recipients_list, a list of addresses in the format of a + * recipient list in email. It stores the results in @start and + * @end + */ +void modest_text_utils_address_range_at_position (const gchar *recipients_list, + gint position, + gint *start, + gint *end); + + +/** * modest_text_utils_convert_to_html: - * @txt: a string which contains the message to quote + * @txt: a string * * convert plain text (utf8) into html * * Returns: a newly allocated string containing the html */ -gchar* modest_text_utils_convert_to_html (const gchar *data); +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); /** @@ -129,14 +174,158 @@ gchar* modest_text_utils_convert_to_html (const gchar *data); * @s: * @max: * @fmt: - * @tm + * @timet: * * this is just an alias for strftime(3), so we can use that without * getting warning from gcc * * Returns: a formatted string of max length @max in @s */ -size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const struct tm *tm); +size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet); + + + +/** + * modest_text_utils_get_display_addres: + * @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) + * + * NULL in case of error or if address == NULL + */ +gchar* modest_text_utils_get_display_address (gchar *address); + + +/** + * modest_text_utils_get_subject_prefix_len: + * @subject: original subject (UTF8 string) + * + * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address + * + * Returns: the length of the prefix, or 0 if there is none + */ +gint modest_text_utils_get_subject_prefix_len (const gchar *subject); + + +/** + * modest_text_utils_utf8_strcmp: + * @s1: the first string + * @s2: the second string + * @insensitive: should the comparison be case-insensitive? + * + * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison + * + * Returns: an integer less than, equal to, or greater than zero if s1 is found, + * respectively, to be less than, to match, or be greater than s2. + */ +gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive); + + + +/** + * modest_text_utils_get_display_date: + * @date: the date to display + * + * get a string representation for a date. + * + * Returns: the new display date, as a newly allocated string; + * free with g_free + */ +gchar* modest_text_utils_get_display_date (time_t date); + + +/** + * modest_text_utils_get_display_size: + * @size: size in bytes + * + * get a string representation for a size in bytes. + * + * Returns: the newly allocated display string for the + * size in bytes. must be freed. + */ +gchar * modest_text_utils_get_display_size (guint64 size); + + +/** + * 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, + const gchar **invalid_char_position); + +/** + * 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: + * @addresses: a string + * + * obtains a GSList of addresses from a string of addresses + * in the format understood by email protocols + * + * Returns: a GSList of strings + **/ +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); #endif /* __MODEST_TEXT_UTILS_H__ */