2248d900c14cf0ca9ed0596a630f06e5fa05d7c2
[modest] / src / modest-text-utils.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30
31 /* modest-text-utils.h */
32
33 #ifndef __MODEST_TEXT_UTILS_H__
34 #define __MODEST_TEXT_UTILS_H__
35
36 #include <time.h>
37 #include <glib.h>
38
39 #define _FM(str) dgettext("hildon-fm",str)
40
41 /**
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:'),
45  *           must not be NULL
46  *
47  * create a 'derived' subject line for eg. replies and forwards 
48  * 
49  * Returns: a newly allocated string containing the resulting subject
50  * subject == NULL, then @prefix " " will be returned
51  */
52 gchar* modest_text_utils_derived_subject (const gchar *subject, 
53                                           const gchar* prefix);
54
55
56 /**
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
65  * 
66  * quote an existing message
67  * 
68  * Returns: a newly allocated string containing the quoted message
69  */
70 gchar* modest_text_utils_quote (const gchar *text, 
71                                 const gchar *content_type,
72                                 const gchar *signature,
73                                 const gchar *from,
74                                 const time_t sent_date, 
75                                 GList *attachments,
76                                 int limit);
77
78
79 /**
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
84  *
85  * cite the text in a message
86  * 
87  * Returns: a newly allocated string containing the cited text
88  */
89 gchar* modest_text_utils_cite (const gchar *text,
90                                const gchar *content_type,
91                                const gchar *signature,
92                                const gchar *from,
93                                time_t sent_date);
94
95 /**
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
99  * @to: 
100  * @subject: 
101  * @text: 
102  *
103  * creates a new string with the "Original message" text prepended to
104  * the text passed as argument and some data of the header
105  * 
106  * Returns: a newly allocated string containing the quoted message
107  */
108 gchar*   modest_text_utils_inline (const gchar *text,
109                                    const gchar *content_type,
110                                    const gchar *signature,
111                                    const gchar *from,
112                                    time_t sent_date,
113                                    const gchar *to,
114                                    const gchar *subject);
115
116 /**
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 
120  *
121  * remove a specific address from a list of email addresses; if @address
122  * is NULL, returns an unchanged @address_list
123  * 
124  * Returns: a newly allocated string containing the new list, or NULL
125  * in case of error or the original @address_list was NULL
126  */
127 gchar*   modest_text_utils_remove_address (const gchar *address_list, 
128                                            const gchar *address);
129
130 /**
131  * modest_text_utils_address_range_at_position:
132  * @address_list: utf8 string containing a list of addresses
133  * @position: a gint
134  * @start: a gint pointer
135  * @end: a gint pointer
136  *
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
140  * @end
141  */
142 void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
143                                                       gint position,
144                                                       gint *start,
145                                                       gint *end);
146                                                       
147
148 /**
149  * modest_text_utils_convert_to_html:
150  * @txt: a string
151  *
152  * convert plain text (utf8) into html
153  * 
154  * Returns: a newly allocated string containing the html
155  */
156 gchar*  modest_text_utils_convert_to_html (const gchar *txt);
157
158 /**
159  * modest_text_utils_convert_to_html_body:
160  * @txt: a string
161  *
162  * convert plain text (utf8) into html without adding html headers.
163  * 
164  * Returns: a newly allocated string containing the html
165  */
166 gchar*  modest_text_utils_convert_to_html_body (const gchar *data);
167
168
169 /**
170  * modest_text_utils_strftime:
171  * @s:
172  * @max:
173  * @fmt:
174  * @timet:
175  *
176  * this is just an alias for strftime(3), so we can use that without
177  * getting warning from gcc
178  * 
179  * Returns: a formatted string of max length @max in @s
180  */
181 size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t timet);
182
183
184
185 /**
186  * modest_text_utils_get_display_addres:
187  * @address: original address (UTF8 string)
188  *
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
193  * 
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)
197  * 
198  * NULL in case of error or if address == NULL
199  */
200 gchar* modest_text_utils_get_display_address (gchar *address);
201
202
203 /**
204  * modest_text_utils_get_subject_prefix_len:
205  * @subject: original subject (UTF8 string)
206  *
207  * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
208  * 
209  * Returns: the length of the  prefix, or 0 if there is none
210  */
211 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
212
213
214 /**
215  * modest_text_utils_utf8_strcmp:
216  * @s1: the first string
217  * @s2: the second string
218  * @insensitive: should the comparison be case-insensitive?
219  *
220  * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison 
221  *
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.
224  */
225 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
226
227
228
229 /**
230  * modest_text_utils_get_display_date:
231  * @date: the date to display
232  *
233  * get a string representation for a date.
234  * 
235  * Returns: the new display date, as a newly allocated string;
236  * free with g_free
237  */
238 gchar* modest_text_utils_get_display_date (time_t date);
239
240
241 /**
242  * modest_text_utils_get_display_size:
243  * @size: size in bytes
244  *
245  * get a string representation for a size in bytes.
246  * 
247  * Returns: the newly allocated display string for the
248  * size in bytes. must be freed.
249  */
250 gchar * modest_text_utils_get_display_size (guint64 size);
251
252
253 /**
254  * modest_text_utils_validate_email_address:
255  * @email_address: a string
256  * 
257  * validates the email address passed as argument
258  * 
259  * Returns: TRUE if the address is valid, FALSE otherwise
260  **/
261 gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
262
263 /**
264  * modest_text_utils_validate_recipient:
265  * @recipient: a string
266  *
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 &lt; and &gt; symbols.
271  *
272  * Returns: %TRUE if the recipient is valid, FALSE otherwise
273  **/
274 gboolean     modest_text_utils_validate_recipient (const gchar *recipient);
275
276 /**
277  * modest_text_utils_split_addresses_list:
278  * @addresses: a string
279  *
280  * obtains a GSList of addresses from a string of addresses
281  * in the format understood by email protocols
282  *
283  * Returns: a GSList of strings
284  **/
285 GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
286
287 /**
288  * modest_text_utils_get_addresses_indexes:
289  * @addresses: a string
290  * @start_indexes: a #GSList pointer
291  * @end_indexes: a #GSList pointer
292  *
293  * obtains two #GSList of @addresses with the range offsets of the addresses in
294  * the string
295  *
296  * Returns: a GSList of strings
297  **/
298 void         modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes);
299
300 #endif /* __MODEST_TEXT_UTILS_H__ */