1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 /* modest-text-utils.h */
33 #ifndef __MODEST_TEXT_UTILS_H__
34 #define __MODEST_TEXT_UTILS_H__
39 #define _FM(str) dgettext("hildon-fm",str)
42 * modest_text_utils_derived_subject:
43 * @subject: a string which contains the original subject
44 * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
47 * create a 'derived' subject line for eg. replies and forwards
49 * Returns: a newly allocated string containing the resulting subject
50 * subject == NULL, then @prefix " " will be returned
52 gchar* modest_text_utils_derived_subject (const gchar *subject,
57 * modest_text_utils_quote:
58 * @text: a non-NULL string which contains the message to quote
59 * @from: a non-NULL sender of the original message
60 * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
61 * @signature: NULL or the signature to add
62 * @sent_date: sent date/time of the original message
63 * @attachments: a #GList of the attachments
64 * @limit: specifies the maximum characters per line in the quoted text
66 * quote an existing message
68 * Returns: a newly allocated string containing the quoted message
70 gchar* modest_text_utils_quote (const gchar *text,
71 const gchar *content_type,
72 const gchar *signature,
74 const time_t sent_date,
80 * modest_text_utils_cited_text:
81 * @from: sender of the message
82 * @sent_date: the sent date of the original message
83 * @text: the text of the original message
85 * cite the text in a message
87 * Returns: a newly allocated string containing the cited text
89 gchar* modest_text_utils_cite (const gchar *text,
90 const gchar *content_type,
91 const gchar *signature,
96 * modest_text_utils_inlined_text
97 * @from: the non-NULL sender of the original message
98 * @sent_date: sent date/time of the original message
103 * creates a new string with the "Original message" text prepended to
104 * the text passed as argument and some data of the header
106 * Returns: a newly allocated string containing the quoted message
108 gchar* modest_text_utils_inline (const gchar *text,
109 const gchar *content_type,
110 const gchar *signature,
114 const gchar *subject);
117 * modest_text_utils_remove_address
118 * @address_list: none-NULL string with a comma-separated list of email addresses
119 * @address: an specific e-mail address
121 * remove a specific address from a list of email addresses; if @address
122 * is NULL, returns an unchanged @address_list
124 * Returns: a newly allocated string containing the new list, or NULL
125 * in case of error or the original @address_list was NULL
127 gchar* modest_text_utils_remove_address (const gchar *address_list,
128 const gchar *address);
131 * modest_text_utils_address_range_at_position:
132 * @address_list: utf8 string containing a list of addresses
134 * @start: a gint pointer
135 * @end: a gint pointer
137 * Finds the start and end positions of the address at @position,
138 * in @recipients_list, a list of addresses in the format of a
139 * recipient list in email. It stores the results in @start and
142 void modest_text_utils_address_range_at_position (const gchar *recipients_list,
149 * modest_text_utils_convert_to_html:
152 * convert plain text (utf8) into html
154 * Returns: a newly allocated string containing the html
156 gchar* modest_text_utils_convert_to_html (const gchar *txt);
159 * modest_text_utils_convert_to_html_body:
162 * convert plain text (utf8) into html without adding html headers.
164 * Returns: a newly allocated string containing the html
166 gchar* modest_text_utils_convert_to_html_body (const gchar *data);
170 * modest_text_utils_strftime:
176 * this is just an alias for strftime(3), so we can use that without
177 * getting warning from gcc
179 * Returns: a formatted string of max length @max in @s
181 size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet);
186 * modest_text_utils_get_display_addres:
187 * @address: original address (UTF8 string)
189 * make a 'display address' from an address:
190 * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
191 * ie. removes "<...>" and "(...)" parts
192 * the change is in-place; removes leading/trailing whitespace
194 * Returns: the new address of the string; this new string
195 * is _NOT_ newly allocated, so should not be freed. (remember
196 * the old address of the parameter if that one needs to be freed)
198 * NULL in case of error or if address == NULL
200 gchar* modest_text_utils_get_display_address (gchar *address);
204 * modest_text_utils_get_subject_prefix_len:
205 * @subject: original subject (UTF8 string)
207 * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
209 * Returns: the length of the prefix, or 0 if there is none
211 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
215 * modest_text_utils_utf8_strcmp:
216 * @s1: the first string
217 * @s2: the second string
218 * @insensitive: should the comparison be case-insensitive?
220 * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison
222 * Returns: an integer less than, equal to, or greater than zero if s1 is found,
223 * respectively, to be less than, to match, or be greater than s2.
225 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
230 * modest_text_utils_get_display_date:
231 * @date: the date to display
233 * get a string representation for a date.
235 * Returns: the new display date, as a newly allocated string;
238 gchar* modest_text_utils_get_display_date (time_t date);
242 * modest_text_utils_get_display_size:
243 * @size: size in bytes
245 * get a string representation for a size in bytes.
247 * Returns: the newly allocated display string for the
248 * size in bytes. must be freed.
250 gchar * modest_text_utils_get_display_size (guint64 size);
254 * modest_text_utils_validate_email_address:
255 * @email_address: a string
257 * validates the email address passed as argument
259 * Returns: TRUE if the address is valid, FALSE otherwise
261 gboolean modest_text_utils_validate_email_address (const gchar *email_address);
264 * modest_text_utils_validate_recipient:
265 * @recipient: a string
267 * validates @recipient as a valid recipient field for header.
268 * It's different from modest_text_utils_validate_email_address()
269 * as it validates a whole recipient, and not only the part between
270 * the < and > symbols.
272 * Returns: %TRUE if the recipient is valid, FALSE otherwise
274 gboolean modest_text_utils_validate_recipient (const gchar *recipient);
277 * modest_text_utils_split_addresses_list:
278 * @addresses: a string
280 * obtains a GSList of addresses from a string of addresses
281 * in the format understood by email protocols
283 * Returns: a GSList of strings
285 GSList *modest_text_utils_split_addresses_list (const gchar *addresses);
288 * modest_text_utils_get_addresses_indexes:
289 * @addresses: a string
290 * @start_indexes: a #GSList pointer
291 * @end_indexes: a #GSList pointer
293 * obtains two #GSList of @addresses with the range offsets of the addresses in
296 * Returns: a GSList of strings
298 void modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
300 #endif /* __MODEST_TEXT_UTILS_H__ */