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__
38 #include <gdk/gdkcolor.h>
39 #include <gtk/gtktextbuffer.h>
41 #define _FM(str) dgettext("hildon-fm",str)
42 #define _CS(str) dgettext("hildon-common-strings",str)
44 /* Forbidden char arrays */
45 extern const gchar account_title_forbidden_chars[];
46 extern const gchar folder_name_forbidden_chars[];
47 extern const gchar user_name_forbidden_chars[];
48 extern const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH;
49 extern const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH;
50 extern const guint USER_NAME_FORBIDDEN_CHARS_LENGTH;
53 * modest_text_utils_derived_subject:
54 * @subject: a string which contains the original subject
55 * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
58 * create a 'derived' subject line for eg. replies and forwards
60 * Returns: a newly allocated string containing the resulting subject
61 * subject == NULL, then @prefix " " will be returned
63 gchar* modest_text_utils_derived_subject (const gchar *subject,
68 * modest_text_utils_quote:
69 * @text: a non-NULL string which contains the message to quote
70 * @from: a non-NULL sender of the original message
71 * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
72 * @signature: NULL or the signature to add
73 * @sent_date: sent date/time of the original message
74 * @attachments: a #GList of the attachments
75 * @limit: specifies the maximum characters per line in the quoted text
77 * quote an existing message
79 * Returns: a newly allocated string containing the quoted message
81 gchar* modest_text_utils_quote (const gchar *text,
82 const gchar *content_type,
83 const gchar *signature,
85 const time_t sent_date,
91 * modest_text_utils_cited_text:
92 * @from: sender of the message
93 * @sent_date: the sent date of the original message
94 * @text: the text of the original message
96 * cite the text in a message
98 * Returns: a newly allocated string containing the cited text
100 gchar* modest_text_utils_cite (const gchar *text,
101 const gchar *content_type,
102 const gchar *signature,
107 * modest_text_utils_inlined_text
108 * @from: the non-NULL sender of the original message
109 * @sent_date: sent date/time of the original message
114 * creates a new string with the "Original message" text prepended to
115 * the text passed as argument and some data of the header
117 * Returns: a newly allocated string containing the quoted message
119 gchar* modest_text_utils_inline (const gchar *text,
120 const gchar *content_type,
121 const gchar *signature,
125 const gchar *subject);
128 * modest_text_utils_remove_address
129 * @address_list: none-NULL string with a comma-separated list of email addresses
130 * @address: an specific e-mail address
132 * remove a specific address from a list of email addresses; if @address
133 * is NULL, returns an unchanged @address_list
135 * Returns: a newly allocated string containing the new list, or NULL
136 * in case of error or the original @address_list was NULL
138 gchar* modest_text_utils_remove_address (const gchar *address_list,
139 const gchar *address);
142 * modest_text_utils_address_range_at_position:
143 * @address_list: utf8 string containing a list of addresses
145 * @start: a gint pointer
146 * @end: a gint pointer
148 * Finds the start and end positions of the address at @position,
149 * in @recipients_list, a list of addresses in the format of a
150 * recipient list in email. It stores the results in @start and
153 void modest_text_utils_address_range_at_position (const gchar *recipients_list,
160 * modest_text_utils_convert_to_html:
163 * convert plain text (utf8) into html
165 * Returns: a newly allocated string containing the html
167 gchar* modest_text_utils_convert_to_html (const gchar *txt);
170 * modest_text_utils_convert_to_html_body:
173 * convert plain text (utf8) into html without adding html headers.
175 * Returns: a newly allocated string containing the html
177 gchar* modest_text_utils_convert_to_html_body (const gchar *data);
181 * modest_text_utils_strftime:
187 * this is just an alias for strftime(3), so we can use that without
188 * getting warning from gcc
190 * Returns: a formatted string of max length @max in @s
192 size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet);
197 * modest_text_utils_get_display_address:
198 * @address: original address (UTF8 string)
200 * make a 'display address' from an address:
201 * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
202 * ie. removes "<...>" and "(...)" parts
203 * the change is in-place; removes leading/trailing whitespace
205 * Returns: the new address of the string; this new string
206 * is _NOT_ newly allocated, so should not be freed. (remember
207 * the old address of the parameter if that one needs to be freed)
209 * NULL in case of error or if address == NULL
211 gchar* modest_text_utils_get_display_address (gchar *address);
214 * modest_text_utils_get_email_address:
215 * @full_address: original address (UTF8 string)
217 * make a 'foo@bar.cx' from an address:
218 * "Foo Bar <foo@bar.cx> (Bla)" --> "foo@bar.cx"
219 * If no "<...>" is found, then it returns the full
222 * Returns: a newly allocated string with the copy.
224 * NULL in case of error or if address == NULL
226 gchar* modest_text_utils_get_email_address (const gchar *email_address);
230 * modest_text_utils_get_subject_prefix_len:
231 * @subject: original subject (UTF8 string)
233 * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
235 * Returns: the length of the prefix, or 0 if there is none
237 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
241 * modest_text_utils_utf8_strcmp:
242 * @s1: the first string
243 * @s2: the second string
244 * @insensitive: should the comparison be case-insensitive?
246 * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison
248 * Returns: an integer less than, equal to, or greater than zero if s1 is found,
249 * respectively, to be less than, to match, or be greater than s2.
251 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
256 * modest_text_utils_get_display_date:
257 * @date: the date to display
259 * get a string representation for a date.
261 * Returns: the new display date, as a newly allocated string;
264 gchar* modest_text_utils_get_display_date (time_t date);
268 * modest_text_utils_get_display_size:
269 * @size: size in bytes
271 * get a string representation for a size in bytes.
273 * Returns: the newly allocated display string for the
274 * size in bytes. must be freed.
276 gchar * modest_text_utils_get_display_size (guint64 size);
281 * modest_text_utils_validate_domain_name:
282 * @email_address: a NULL-terminated string
284 * validates the domain name passed as argument
286 * Returns: TRUE if the domain name is valid, FALSE otherwise
288 gboolean modest_text_utils_validate_domain_name (const gchar *domain);
291 * modest_text_utils_validate_email_address:
292 * @email_address: a string
293 * @invalid_char_position: pointer to the position of the invalid
294 * character in case validation failed because of this, or %NULL.
296 * validates the email address passed as argument
298 * Returns: TRUE if the address is valid, FALSE otherwise
300 gboolean modest_text_utils_validate_email_address (const gchar *email_address,
301 const gchar **invalid_char_position);
305 * modest_text_utils_validate_folder_name:
306 * @folder_name: a string
308 * validates the folder name passed as argument. a 'valid folder name'
309 * is a name which should be valid on both Unix and Windows file systems.
310 * of course, this might be stricter than strictly needed in some cases,
311 * but it's better to err on the safe side.
313 * Returns: TRUE if the folder name is valid, FALSE otherwise
315 gboolean modest_text_utils_validate_folder_name (const gchar *folder_name);
318 * modest_text_utils_validate_recipient:
319 * @recipient: a string
320 * @invalid_char_position: pointer to the position of the invalid char,
321 * if validation failed because there's an invalid char there, or %NULL.
323 * validates @recipient as a valid recipient field for header.
324 * It's different from modest_text_utils_validate_email_address()
325 * as it validates a whole recipient, and not only the part between
326 * the < and > symbols.
328 * Returns: %TRUE if the recipient is valid, FALSE otherwise
330 gboolean modest_text_utils_validate_recipient (const gchar *recipient,
331 const gchar **invalid_char_position);
334 * modest_text_utils_split_addresses_list:
335 * @addresses: a string
337 * obtains a GSList of addresses from a string of addresses
338 * in the format understood by email protocols
340 * Returns: a GSList of strings
342 GSList *modest_text_utils_split_addresses_list (const gchar *addresses);
345 * modest_text_utils_get_addresses_indexes:
346 * @addresses: a string
347 * @start_indexes: a #GSList pointer
348 * @end_indexes: a #GSList pointer
350 * obtains two #GSList of @addresses with the range offsets of the addresses in
353 * Returns: a GSList of strings
355 void modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
358 * modest_text_utils_get_color_string:
359 * @color: a #GdkColor
361 * Obtains a proper markup string for @color, in the format used
364 * Returns: a newly allocated string
366 gchar * modest_text_utils_get_color_string (GdkColor *color);
369 * modest_text_utils_text_buffer_get_text:
370 * @buffer: a #GtkTextBuffer
372 * Obtains the contents of a @buffer in a string, replacing image
373 * pixbufs with blank spaces.
375 * Returns: a newly allocated UTF-8 string
377 gchar * modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer);
380 ACCOUNT_TITLE_FORBIDDEN_CHARS,
381 FOLDER_NAME_FORBIDDEN_CHARS,
382 USER_NAME_FORBIDDEN_NAMES,
383 } ModestTextUtilsForbiddenCharType;
385 gboolean modest_text_utils_is_forbidden_char (const gchar character,
386 ModestTextUtilsForbiddenCharType type);
388 #endif /* __MODEST_TEXT_UTILS_H__ */