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>
40 #include <gtk/gtklabel.h>
42 #define _FM(str) dgettext("hildon-fm",str)
43 #define _CS(str) dgettext("hildon-common-strings",str)
44 #define _HL(str) dgettext("hildon-libs",str)
45 #define _MD(str) dgettext("maemo-af-desktop",str)
47 /* Forbidden char arrays */
48 extern const gchar account_title_forbidden_chars[];
49 extern const gchar folder_name_forbidden_chars[];
50 extern const gchar user_name_forbidden_chars[];
51 extern const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH;
52 extern const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH;
53 extern const guint USER_NAME_FORBIDDEN_CHARS_LENGTH;
56 * modest_text_utils_derived_subject:
57 * @subject: a string which contains the original subject
58 * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
61 * create a 'derived' subject line for eg. replies and forwards
63 * Returns: a newly allocated string containing the resulting subject
64 * subject == NULL, then @prefix " " will be returned
66 gchar* modest_text_utils_derived_subject (const gchar *subject,
71 * modest_text_utils_quote:
72 * @text: a non-NULL string which contains the message to quote
73 * @from: a non-NULL sender of the original message
74 * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
75 * @signature: NULL or the signature to add
76 * @sent_date: sent date/time of the original message
77 * @attachments: a #GList of the attachments
78 * @limit: specifies the maximum characters per line in the quoted text
80 * quote an existing message
82 * Returns: a newly allocated string containing the quoted message
84 gchar* modest_text_utils_quote (const gchar *text,
85 const gchar *content_type,
86 const gchar *signature,
88 const time_t sent_date,
94 * modest_text_utils_cited_text:
95 * @from: sender of the message
96 * @sent_date: the sent date of the original message
97 * @text: the text of the original message
99 * cite the text in a message
101 * Returns: a newly allocated string containing the cited text
103 gchar* modest_text_utils_cite (const gchar *text,
104 const gchar *content_type,
105 const gchar *signature,
110 * modest_text_utils_inlined_text
111 * @from: the non-NULL sender of the original message
112 * @sent_date: sent date/time of the original message
117 * creates a new string with the "Original message" text prepended to
118 * the text passed as argument and some data of the header
120 * Returns: a newly allocated string containing the quoted message
122 gchar* modest_text_utils_inline (const gchar *text,
123 const gchar *content_type,
124 const gchar *signature,
128 const gchar *subject);
131 * modest_text_utils_remove_address
132 * @address_list: non-NULL string with a comma-separated list of email addresses
133 * @address: an specific e-mail address
135 * remove a specific address from a list of email addresses; if @address
136 * is NULL, returns an unchanged (but newly allocated) @address_list
138 * Returns: a newly allocated string containing the new list, or NULL
139 * in case of error or the original @address_list was NULL
141 gchar* modest_text_utils_remove_address (const gchar *address_list,
142 const gchar *address);
146 * modest_text_utils_remove_duplicate_addresses
147 * @address_list: non-NULL string with a comma-separated list of email addresses
149 * remove duplicate addresses from a list of email addresses
151 * Returns: a newly allocated string containing the new list, or NULL
152 * in case of error or the original @address_list was NULL
154 gchar* modest_text_utils_remove_duplicate_addresses (const gchar *address_list);
159 * modest_text_utils_address_range_at_position:
160 * @address_list: non-NULL utf8 string containing a list of addresses
162 * @start: a gint pointer
163 * @end: a gint pointer
165 * Finds the start and end positions of the address at @position,
166 * in @recipients_list, a list of addresses in the format of a
167 * recipient list in email. It stores the results in @start and
170 void modest_text_utils_address_range_at_position (const gchar *recipients_list,
176 * modest_text_utils_hyperlinkify_begin:
178 * begin a linkify block, compiling the caches to be reused.
180 void modest_text_utils_hyperlinkify_begin (void);
183 * modest_text_utils_hyperlinkify_end:
185 * end a linkify block, freeing the caches to be reused.
187 void modest_text_utils_hyperlinkify_end (void);
190 * modest_text_utils_convert_to_html:
193 * convert plain text (utf8) into html
195 * Returns: a newly allocated string containing the html
197 gchar* modest_text_utils_convert_to_html (const gchar *txt);
200 * modest_text_utils_convert_to_html_body:
203 * convert plain text (utf8) into html without adding html headers.
205 * Returns: a newly allocated string containing the html
207 gchar* modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify);
211 * modest_text_utils_strftime:
217 * this is just an alias for strftime(3), so we can use that without
218 * getting warning from gcc
220 * Returns: a formatted string of max length @max in @s
222 size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet);
227 * modest_text_utils_get_display_address:
228 * @address: original address (UTF8 string)
230 * make a 'display address' from an address:
231 * "Foo Bar <foo@bar.cx>" --> "Foo Bar"
232 * ie. removes "<...>" parts
233 * the change is in-place; removes leading whitespace
235 * NOTE: for optimization reasons, this function changes @address
238 void modest_text_utils_get_display_address (gchar *address);
241 * modest_text_utils_get_email_address:
242 * @full_address: original address (UTF8 string)
244 * make a 'foo@bar.cx' from an address:
245 * "Foo Bar <foo@bar.cx> (Bla)" --> "foo@bar.cx"
246 * If no "<...>" is found, then it returns the full
249 * Returns: a newly allocated string with the copy.
251 * NULL in case of error or if address == NULL
253 gchar* modest_text_utils_get_email_address (const gchar *email_address);
257 * modest_text_utils_get_subject_prefix_len:
258 * @subject: original subject (UTF8 string)
260 * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
262 * Returns: the length of the prefix, or 0 if there is none
264 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
268 * modest_text_utils_utf8_strcmp:
269 * @s1: the first string
270 * @s2: the second string
271 * @insensitive: should the comparison be case-insensitive?
273 * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison
275 * Returns: an integer less than, equal to, or greater than zero if s1 is found,
276 * respectively, to be less than, to match, or be greater than s2.
278 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
283 * modest_text_utils_get_display_date:
284 * @date: the date to display
286 * get a string representation for a date.
288 * Returns: the new display date, as a *static* string.
289 * This string should not be modified, and will change
290 * upon recalling this function. g_strdup it if you to
294 const gchar* modest_text_utils_get_display_date (time_t date);
298 * modest_text_utils_get_display_size:
299 * @size: size in bytes
301 * get a string representation for a size in bytes.
303 * Returns: the newly allocated display string for the
304 * size in bytes. must be freed.
306 gchar * modest_text_utils_get_display_size (guint64 size);
311 * modest_text_utils_validate_domain_name:
312 * @email_address: a NULL-terminated string
314 * validates the domain name passed as argument
316 * Returns: TRUE if the domain name is valid, FALSE otherwise
318 gboolean modest_text_utils_validate_domain_name (const gchar *domain);
321 * modest_text_utils_validate_email_address:
322 * @email_address: a string
323 * @invalid_char_position: pointer to the position of the invalid
324 * character in case validation failed because of this, or %NULL.
326 * validates the email address passed as argument
328 * Returns: TRUE if the address is valid, FALSE otherwise
330 gboolean modest_text_utils_validate_email_address (const gchar *email_address,
331 const gchar **invalid_char_position);
335 * modest_text_utils_validate_folder_name:
336 * @folder_name: a string
338 * validates the folder name passed as argument. a 'valid folder name'
339 * is a name which should be valid on both Unix and Windows file systems.
340 * of course, this might be stricter than strictly needed in some cases,
341 * but it's better to err on the safe side.
343 * Returns: TRUE if the folder name is valid, FALSE otherwise
345 gboolean modest_text_utils_validate_folder_name (const gchar *folder_name);
348 * modest_text_utils_validate_recipient:
349 * @recipient: a string
350 * @invalid_char_position: pointer to the position of the invalid char,
351 * if validation failed because there's an invalid char there, or %NULL.
353 * validates @recipient as a valid recipient field for header.
354 * It's different from modest_text_utils_validate_email_address()
355 * as it validates a whole recipient, and not only the part between
356 * the < and > symbols.
358 * Returns: %TRUE if the recipient is valid, FALSE otherwise
360 gboolean modest_text_utils_validate_recipient (const gchar *recipient,
361 const gchar **invalid_char_position);
364 * modest_text_utils_split_addresses_list:
365 * @addresses: a string
367 * obtains a GSList of addresses from a string of addresses
368 * in the format understood by email protocols
370 * Returns: a newly allocated GSList of strings
372 GSList *modest_text_utils_split_addresses_list (const gchar *addresses);
376 * modest_text_utils_get_addresses_indexes:
377 * @addresses: a string
378 * @start_indexes: a #GSList pointer
379 * @end_indexes: a #GSList pointer
381 * obtains two #GSList of @addresses with the range offsets of the addresses in
384 * Returns: a GSList of strings
386 void modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
389 * modest_text_utils_address_with_standard_length:
390 * @recipients_list: a string
392 * obtains the list of recipients, but making sure that lines are not longer than 1000 chars
394 * Returns: a newly allocated string
396 gchar * modest_text_utils_address_with_standard_length (const gchar *recipients_list);
399 * modest_text_utils_get_color_string:
400 * @color: a #GdkColor
402 * Obtains a proper markup string for @color, in the format used
405 * Returns: a newly allocated string
407 gchar * modest_text_utils_get_color_string (GdkColor *color);
410 * modest_text_utils_text_buffer_get_text:
411 * @buffer: a #GtkTextBuffer
413 * Obtains the contents of a @buffer in a string, replacing image
414 * pixbufs with blank spaces.
416 * Returns: a newly allocated UTF-8 string
418 gchar * modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer);
421 ACCOUNT_TITLE_FORBIDDEN_CHARS,
422 FOLDER_NAME_FORBIDDEN_CHARS,
423 USER_NAME_FORBIDDEN_NAMES,
424 } ModestTextUtilsForbiddenCharType;
427 * modest_text_utils_label_get_selection:
428 * @label: a #GtkLabel
430 * Obtain the current selection of @label
432 * Returns: a string with current selection, or %NULL if no selection in @label
434 gchar * modest_text_utils_label_get_selection (GtkLabel *label);
437 * modest_text_utils_is_forbidden_char:
438 * @character: some character
439 * @type: the type of forbidden char (see #ModestTextUtilsForbiddenCharType)
441 * check whether the given character is 'forbidden'
443 * Returns: TRUE if it's forbidden, FALSE otherwise
445 gboolean modest_text_utils_is_forbidden_char (const gchar character,
446 ModestTextUtilsForbiddenCharType type);
449 * modest_text_utils_buffer_selection_is_valid:
450 * @buffer: a #GtkTextBuffer
452 * Checks if @buffer contains a valid selection for cut/copy. This means it's
453 * not empty, and no images are in the selection.
455 * Returns: %TRUE if there's a valid selection, false otherwise.
457 gboolean modest_text_utils_buffer_selection_is_valid (GtkTextBuffer *buffer);
460 * modest_text_utils_escape_mnemonics:
463 * obtains the representation of text, but escaping mnemonics (we duplicate _)
465 * Returns: a newly allocated string
467 gchar *modest_text_utils_escape_mnemonics (const gchar *text);
470 #endif /* __MODEST_TEXT_UTILS_H__ */