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)
46 #define _AB(str) dgettext("osso-addressbook",str)
47 #define _KR(str) dgettext("ke-recv",str)
49 /* Forbidden char arrays */
50 extern const gchar account_title_forbidden_chars[];
51 extern const gchar folder_name_forbidden_chars[];
52 extern const gchar user_name_forbidden_chars[];
53 extern const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH;
54 extern const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH;
55 extern const guint USER_NAME_FORBIDDEN_CHARS_LENGTH;
57 /* It includes a white space as RFC 3676 Section 4.3 about usenet
58 message signatures defines */
59 #define MODEST_TEXT_UTILS_SIGNATURE_MARKER "-- "
62 * modest_text_utils_derived_subject:
63 * @subject: a string which contains the original subject
64 * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
67 * create a 'derived' subject line for eg. replies and forwards
69 * Returns: a newly allocated string containing the resulting subject
70 * subject == NULL, then @prefix " " will be returned
72 gchar* modest_text_utils_derived_subject (const gchar *subject,
77 * modest_text_utils_quote:
78 * @text: a non-NULL string which contains the message to quote
79 * @from: a non-NULL sender of the original message
80 * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
81 * @signature: NULL or the signature to add
82 * @sent_date: sent date/time of the original message
83 * @attachments: a #GList of the attachments
84 * @limit: specifies the maximum characters per line in the quoted text
86 * quote an existing message
88 * Returns: a newly allocated string containing the quoted message
90 gchar* modest_text_utils_quote (const gchar *text,
91 const gchar *content_type,
92 const gchar *signature,
94 const time_t sent_date,
100 * modest_text_utils_cited_text:
101 * @from: sender of the message
102 * @sent_date: the sent date of the original message
103 * @text: the text of the original message
105 * cite the text in a message
107 * Returns: a newly allocated string containing the cited text
109 gchar* modest_text_utils_cite (const gchar *text,
110 const gchar *content_type,
111 const gchar *signature,
116 * modest_text_utils_inlined_text
117 * @from: the non-NULL sender of the original message
118 * @sent_date: sent date/time of the original message
123 * creates a new string with the "Original message" text prepended to
124 * the text passed as argument and some data of the header
126 * Returns: a newly allocated string containing the quoted message
128 gchar* modest_text_utils_inline (const gchar *text,
129 const gchar *content_type,
130 const gchar *signature,
134 const gchar *subject);
137 * modest_text_utils_remove_address
138 * @address_list: non-NULL string with a comma-separated list of email addresses
139 * @address: an specific e-mail address
141 * remove a specific address from a list of email addresses; if @address
142 * is NULL, returns an unchanged (but newly allocated) @address_list
144 * Returns: a newly allocated string containing the new list, or NULL
145 * in case of error or the original @address_list was NULL
147 gchar* modest_text_utils_remove_address (const gchar *address_list,
148 const gchar *address);
152 * modest_text_utils_remove_duplicate_addresses
153 * @address_list: non-NULL string with a comma-separated list of email addresses
155 * remove duplicate addresses from a list of email addresses
157 * Returns: a newly allocated string containing the new list, or NULL
158 * in case of error or the original @address_list was NULL
160 gchar* modest_text_utils_remove_duplicate_addresses (const gchar *address_list);
164 * modest_text_utils_address_range_at_position:
165 * @address_list: non-NULL utf8 string containing a list of addresses
167 * @start: a gint pointer
168 * @end: a gint pointer
170 * Finds the start and end positions of the address at @position,
171 * in @recipients_list, a list of addresses in the format of a
172 * recipient list in email. It stores the results in @start and
175 void modest_text_utils_address_range_at_position (const gchar *recipients_list,
181 * modest_text_utils_hyperlinkify_begin:
183 * begin a linkify block, compiling the caches to be reused. Use it in mainloop.
185 void modest_text_utils_hyperlinkify_begin (void);
188 * modest_text_utils_hyperlinkify_end:
190 * end a linkify block, freeing the caches to be reused. Use it in mainloop.
192 void modest_text_utils_hyperlinkify_end (void);
195 * modest_text_utils_convert_to_html:
198 * convert plain text (utf8) into html
200 * Returns: a newly allocated string containing the html
202 gchar* modest_text_utils_convert_to_html (const gchar *txt);
205 * modest_text_utils_convert_to_html_body:
208 * convert plain text (utf8) into html without adding html headers.
210 * Returns: a newly allocated string containing the html
212 gchar* modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify);
216 * modest_text_utils_strftime:
222 * this is just an alias for strftime(3), so we can use that without
223 * getting warning from gcc
225 * Returns: a formatted string of max length @max in @s
227 size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, time_t timet);
230 * modest_text_utils_hyperlinkify:
231 * @string_buffer: buffer where we replace uri strings with links
233 * Replace uri's with links in the buffer. This is required that the document
234 * do not contain linkified links already.
236 void modest_text_utils_hyperlinkify (GString *string_buffer);
239 * modest_text_utils_get_display_address:
240 * @address: original address (UTF8 string)
242 * make a 'display address' from an address:
243 * "Foo Bar <foo@bar.cx>" --> "Foo Bar"
244 * ie. removes "<...>" parts
245 * the change is in-place; removes leading whitespace
247 * NOTE: for optimization reasons, this function changes @address
250 void modest_text_utils_get_display_address (gchar *address);
253 * modest_text_utils_get_display_addresses:
254 * @addresses: a list of comma-separated addresses
256 * Transforms a list of email addresses in a list of recipients,
257 * replacing each plain email address by the correspondent display
260 * Returns: a newly allocated string, that must be freed by the caller
262 gchar *modest_text_utils_get_display_addresses (const gchar *addresses);
266 * modest_text_utils_get_email_address:
267 * @full_address: original address (UTF8 string)
269 * make a 'foo@bar.cx' from an address:
270 * "Foo Bar <foo@bar.cx> (Bla)" --> "foo@bar.cx"
271 * If no "<...>" is found, then it returns the full
274 * Returns: a newly allocated string with the copy.
276 * NULL in case of error or if address == NULL
278 gchar* modest_text_utils_get_email_address (const gchar *email_address);
282 * modest_text_utils_get_subject_prefix_len:
283 * @subject: original subject (UTF8 string)
285 * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
287 * Returns: the length of the prefix, or 0 if there is none
289 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
293 * modest_text_utils_utf8_strcmp:
294 * @s1: the first string
295 * @s2: the second string
296 * @insensitive: should the comparison be case-insensitive?
298 * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison
300 * Returns: an integer less than, equal to, or greater than zero if s1 is found,
301 * respectively, to be less than, to match, or be greater than s2.
303 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
308 * modest_text_utils_get_display_date:
309 * @date: the date to display
311 * get a string representation for a date.
313 * Returns: the new display date, as a *static* string.
314 * This string should not be modified, and will change
315 * upon recalling this function. g_strdup it if you to
319 const gchar* modest_text_utils_get_display_date (time_t date);
323 * modest_text_utils_get_display_size:
324 * @size: size in bytes
326 * get a string representation for a size in bytes.
328 * Returns: the newly allocated display string for the
329 * size in bytes. must be freed.
331 gchar * modest_text_utils_get_display_size (guint64 size);
336 * modest_text_utils_validate_domain_name:
337 * @email_address: a NULL-terminated string
339 * validates the domain name passed as argument
341 * Returns: TRUE if the domain name is valid, FALSE otherwise
343 gboolean modest_text_utils_validate_domain_name (const gchar *domain);
346 * modest_text_utils_validate_email_address:
347 * @email_address: a string
348 * @invalid_char_position: pointer to the position of the invalid
349 * character in case validation failed because of this, or %NULL.
351 * validates the email address passed as argument
353 * Returns: TRUE if the address is valid, FALSE otherwise
355 gboolean modest_text_utils_validate_email_address (const gchar *email_address,
356 const gchar **invalid_char_position);
360 * modest_text_utils_validate_folder_name:
361 * @folder_name: a string
363 * validates the folder name passed as argument. a 'valid folder name'
364 * is a name which should be valid on both Unix and Windows file systems.
365 * of course, this might be stricter than strictly needed in some cases,
366 * but it's better to err on the safe side.
368 * Returns: TRUE if the folder name is valid, FALSE otherwise
370 gboolean modest_text_utils_validate_folder_name (const gchar *folder_name);
373 * modest_text_utils_validate_recipient:
374 * @recipient: a string
375 * @invalid_char_position: pointer to the position of the invalid char,
376 * if validation failed because there's an invalid char there, or %NULL.
378 * validates @recipient as a valid recipient field for header.
379 * It's different from modest_text_utils_validate_email_address()
380 * as it validates a whole recipient, and not only the part between
381 * the < and > symbols.
383 * Returns: %TRUE if the recipient is valid, FALSE otherwise
385 gboolean modest_text_utils_validate_recipient (const gchar *recipient,
386 const gchar **invalid_char_position);
389 * modest_text_utils_split_addresses_list:
390 * @addresses: a string
392 * obtains a GSList of addresses from a string of addresses
393 * in the format understood by email protocols
395 * Returns: a newly allocated GSList of strings
397 GSList *modest_text_utils_split_addresses_list (const gchar *addresses);
401 * modest_text_utils_get_addresses_indexes:
402 * @addresses: a string
403 * @start_indexes: a #GSList pointer
404 * @end_indexes: a #GSList pointer
406 * obtains two #GSList of @addresses with the range offsets of the addresses in
409 * Returns: a GSList of strings
411 void modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
414 * modest_text_utils_address_with_standard_length:
415 * @recipients_list: a string
417 * obtains the list of recipients, but making sure that lines are not longer than 1000 chars
419 * Returns: a newly allocated string
421 gchar * modest_text_utils_address_with_standard_length (const gchar *recipients_list);
424 * modest_text_utils_get_color_string:
425 * @color: a #GdkColor
427 * Obtains a proper markup string for @color, in the format used
430 * Returns: a newly allocated string
432 gchar * modest_text_utils_get_color_string (GdkColor *color);
435 * modest_text_utils_text_buffer_get_text:
436 * @buffer: a #GtkTextBuffer
438 * Obtains the contents of a @buffer in a string, replacing image
439 * pixbufs with blank spaces.
441 * Returns: a newly allocated UTF-8 string
443 gchar * modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer);
446 ACCOUNT_TITLE_FORBIDDEN_CHARS,
447 FOLDER_NAME_FORBIDDEN_CHARS,
448 USER_NAME_FORBIDDEN_NAMES,
449 } ModestTextUtilsForbiddenCharType;
452 * modest_text_utils_label_get_selection:
453 * @label: a #GtkLabel
455 * Obtain the current selection of @label
457 * Returns: a string with current selection, or %NULL if no selection in @label
459 gchar * modest_text_utils_label_get_selection (GtkLabel *label);
462 * modest_text_utils_is_forbidden_char:
463 * @character: some character
464 * @type: the type of forbidden char (see #ModestTextUtilsForbiddenCharType)
466 * check whether the given character is 'forbidden'
468 * Returns: TRUE if it's forbidden, FALSE otherwise
470 gboolean modest_text_utils_is_forbidden_char (const gchar character,
471 ModestTextUtilsForbiddenCharType type);
474 * modest_text_utils_buffer_selection_is_valid:
475 * @buffer: a #GtkTextBuffer
477 * Checks if @buffer contains a valid selection for cut/copy. This means it's
478 * not empty, and no images are in the selection.
480 * Returns: %TRUE if there's a valid selection, false otherwise.
482 gboolean modest_text_utils_buffer_selection_is_valid (GtkTextBuffer *buffer);
485 * modest_text_utils_escape_mnemonics:
488 * obtains the representation of text, but escaping mnemonics (we duplicate _)
490 * Returns: a newly allocated string
492 gchar *modest_text_utils_escape_mnemonics (const gchar *text);
495 * modest_text_utils_simplify_recipients:
496 * @recipients: a list of recipients
498 * returns a list of simplified recipients:
499 * * a@b <a@b> converted to a@b
500 * * NULL converted to ""
502 * It's mainly intended for printing in screen addresses, but it can
503 * also be used for reply/forward.
505 gchar *modest_text_utils_simplify_recipients (const gchar *recipient);
508 * modest_text_utils_remove_duplicate_addresses_list
509 * @address_list: non-NULL #GSList of email addresses
511 * remove duplicate addresses from a list of email addresses
513 * Returns: a list without the duplicate addresses or NULL in case of
514 * error or the original @address_list was NULL
516 GSList *modest_text_utils_remove_duplicate_addresses_list (GSList *address_list);
519 * modest_text_utils_get_secure_header:
520 * @value: the value of a mail header
521 * @header: the header that we're evaluating
523 * This function returns the secure value for a header. Basically it
524 * avoids DoS attacks caused by specially malformed headers like for
525 * example. From:From:From...From: some@mail.com
527 * Returns: returns the secured header
529 gchar * modest_text_utils_get_secure_header (const gchar *value, const gchar *header);
531 #endif /* __MODEST_TEXT_UTILS_H__ */