X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-text-utils.h;h=1c7fe4170c5fb86b6f2fc10ce09c0a56b0ef3030;hp=3813468ec886305fb7ebf4f55bab53e281905414;hb=40a8f5cbe03bd040fe3403dbfa6806df4fb6bc8a;hpb=2671dbb64b4a9771d58835cbb2d7f2804c0f0ed2 diff --git a/src/modest-text-utils.h b/src/modest-text-utils.h index 3813468..1c7fe41 100644 --- a/src/modest-text-utils.h +++ b/src/modest-text-utils.h @@ -35,6 +35,11 @@ #include #include +#include +#include + +#define _FM(str) dgettext("hildon-fm",str) +#define _CS(str) dgettext("hildon-common-strings",str) /** * modest_text_utils_derived_subject: @@ -53,9 +58,12 @@ gchar* modest_text_utils_derived_subject (const gchar *subject, /** * modest_text_utils_quote: - * @text: 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 @@ -64,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); @@ -81,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 @@ -99,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, @@ -119,8 +131,26 @@ 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 * @@ -128,25 +158,35 @@ gchar* modest_text_utils_remove_address (const gchar *address_list, */ 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: * @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: + * modest_text_utils_get_display_address: * @address: original address (UTF8 string) * * make a 'display address' from an address: @@ -154,11 +194,29 @@ size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const * ie. removes "<...>" and "(...)" parts * the change is in-place; removes leading/trailing whitespace * - * Returns: the new address. The string is *not* newly allocated. - * NULL in case of error + * 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_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. + * + * NULL in case of error or if address == NULL + */ +gchar* modest_text_utils_get_email_address (const gchar *email_address); + /** * modest_text_utils_get_subject_prefix_len: @@ -168,7 +226,7 @@ gchar* modest_text_utils_get_display_address (gchar *address); * * Returns: the length of the prefix, or 0 if there is none */ -gint modest_text_utils_get_subject_prefix_len (const gchar *sub); +gint modest_text_utils_get_subject_prefix_len (const gchar *subject); /** @@ -192,11 +250,122 @@ 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 + */ +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_domain_name: + * @email_address: a NULL-terminated string + * + * validates the domain name passed as argument * - * Returns: the new display date. The string is *not* newly allocated, - * but is a static buffer (for optimization reasons). Therefore, when - * you call this function, you will loose the data. + * 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, + 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: + * @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 */ -const gchar* modest_text_utils_get_display_date (time_t date); +gchar * modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer); #endif /* __MODEST_TEXT_UTILS_H__ */