git.maemo.org Git - modest/blob - 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 /**
  40  * modest_text_utils_derived_subject:
  41  * @subject: a string which contains the original subject
  42  * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
  43  *           must not be NULL
  44  *
  45  * create a 'derived' subject line for eg. replies and forwards
  46  *
  47  * Returns: a newly allocated string containing the resulting subject
  48  * subject == NULL, then @prefix " " will be returned
  49  */
  50 gchar* modest_text_utils_derived_subject (const gchar *subject,
  51                                           const gchar* prefix);
  52
  53
  54 /**
  55  * modest_text_utils_quote:
  56  * @text: a non-NULL string which contains the message to quote
  57  * @from: a non-NULL  sender of the original message
  58  * @content_type: the non-NULL content type for the quoting, e.g. "text/html"
  59  * @signature: NULL or the signature to add
  60  * @sent_date: sent date/time of the original message
  61  * @limit: specifies the maximum characters per line in the quoted text
  62  *
  63  * quote an existing message
  64  *
  65  * Returns: a newly allocated string containing the quoted message
  66  */
  67 gchar* modest_text_utils_quote (const gchar *text,
  68                                 const gchar *content_type,
  69                                 const gchar *signature,
  70                                 const gchar *from,
  71                                 const time_t sent_date,
  72                                 int limit);
  73
  74
  75 /**
  76  * modest_text_utils_cited_text:
  77  * @from: sender of the message
  78  * @sent_date: the sent date of the original message
  79  * @text: the text of the original message
  80  *
  81  * cite the text in a message
  82  *
  83  * Returns: a newly allocated string containing the cited text
  84  */
  85 gchar* modest_text_utils_cite (const gchar *text,
  86                                const gchar *content_type,
  87                                const gchar *signature,
  88                                const gchar *from,
  89                                time_t sent_date);
  90
  91 /**
  92  * modest_text_utils_inlined_text
  93  * @from: the non-NULL sender of the original message
  94  * @sent_date: sent date/time of the original message
  95  * @to:
  96  * @subject:
  97  * @text:
  98  *
  99  * creates a new string with the "Original message" text prepended to
 100  * the text passed as argument and some data of the header
 101  *
 102  * Returns: a newly allocated string containing the quoted message
 103  */
 104 gchar*   modest_text_utils_inline (const gchar *text,
 105                                    const gchar *content_type,
 106                                    const gchar *signature,
 107                                    const gchar *from,
 108                                    time_t sent_date,
 109                                    const gchar *to,
 110                                    const gchar *subject);
 111
 112 /**
 113  * modest_text_utils_remove_address
 114  * @address_list: none-NULL string with a comma-separated list of email addresses
 115  * @address: an specific e-mail address
 116  *
 117  * remove a specific address from a list of email addresses; if @address
 118  * is NULL, returns an unchanged @address_list
 119  *
 120  * Returns: a newly allocated string containing the new list, or NULL
 121  * in case of error or the original @address_list was NULL
 122  */
 123 gchar*   modest_text_utils_remove_address (const gchar *address_list,
 124                                            const gchar *address);
 125
 126 /**
 127  * modest_text_utils_address_range_at_position:
 128  * @address_list: utf8 string containing a list of addresses
 129  * @position: a gint
 130  * @start: a gint pointer
 131  * @end: a gint pointer
 132  *
 133  * Finds the start and end positions of the address at @position,
 134  * in @recipients_list, a list of addresses in the format of a
 135  * recipient list in email. It stores the results in @start and
 136  * @end
 137  */
 138 void     modest_text_utils_address_range_at_position (const gchar *recipients_list,
 139                                                       gint position,
 140                                                       gint *start,
 141                                                       gint *end);
 142
 143
 144 /**
 145  * modest_text_utils_convert_to_html:
 146  * @txt: a string
 147  *
 148  * convert plain text (utf8) into html
 149  *
 150  * Returns: a newly allocated string containing the html
 151  */
 152 gchar*  modest_text_utils_convert_to_html (const gchar *txt);
 153
 154 /**
 155  * modest_text_utils_convert_to_html_body:
 156  * @txt: a string
 157  *
 158  * convert plain text (utf8) into html without adding html headers.
 159  *
 160  * Returns: a newly allocated string containing the html
 161  */
 162 gchar*  modest_text_utils_convert_to_html_body (const gchar *data);
 163
 164
 165 /**
 166  * modest_text_utils_strftime:
 167  * @s:
 168  * @max:
 169  * @fmt:
 170  * @timet:
 171  *
 172  * this is just an alias for strftime(3), so we can use that without
 173  * getting warning from gcc
 174  *
 175  * Returns: a formatted string of max length @max in @s
 176  */
 177 size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, time_t timet);
 178
 179
 180
 181 /**
 182  * modest_text_utils_get_display_addres:
 183  * @address: original address (UTF8 string)
 184  *
 185  * make a 'display address' from an address:
 186  * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
 187  * ie. removes "<...>" and "(...)" parts
 188  * the change is in-place; removes leading/trailing whitespace
 189  *
 190  * Returns: the new address. The string is *not* newly allocated.
 191  * NULL in case of error
 192  */
 193 gchar* modest_text_utils_get_display_address (gchar *address);
 194
 195
 196 /**
 197  * modest_text_utils_get_subject_prefix_len:
 198  * @subject: original subject (UTF8 string)
 199  *
 200  * determine the length of the "Re:/RE:/Fwd:" prefix in an e-mail address
 201  *
 202  * Returns: the length of the  prefix, or 0 if there is none
 203  */
 204 gint modest_text_utils_get_subject_prefix_len (const gchar *subject);
 205
 206
 207 /**
 208  * modest_text_utils_utf8_strcmp:
 209  * @s1: the first string
 210  * @s2: the second string
 211  * @insensitive: should the comparison be case-insensitive?
 212  *
 213  * a strcmp that is NULL-safe, can deal with UTF8 and case-insensitive comparison
 214  *
 215  * Returns: an integer less than, equal to, or greater than zero if s1 is found,
 216  * respectively, to be less than, to match, or be greater than s2.
 217  */
 218 gint modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive);
 219
 220
 221
 222 /**
 223  * modest_text_utils_get_display_date:
 224  * @date: the date to display
 225  *
 226  * get a string representation for a date.
 227  *
 228  * Returns: the new display date, as a newly allocated string;
 229  * free with g_free
 230  */
 231 gchar* modest_text_utils_get_display_date (time_t date);
 232
 233
 234 /**
 235  * modest_text_utils_get_display_size:
 236  * @size: size in bytes
 237  *
 238  * get a string representation for a size in bytes.
 239  *
 240  * Returns: the newly allocated display string for the
 241  * size in bytes. must be freed.
 242  */
 243 gchar * modest_text_utils_get_display_size (guint size);
 244
 245
 246 /**
 247  * modest_text_utils_validate_email_address:
 248  * @email_address: a string
 249  *
 250  * validates the email address passed as argument
 251  *
 252  * Returns: TRUE if the address is valid, FALSE otherwise
 253  **/
 254 gboolean     modest_text_utils_validate_email_address (const gchar *email_address);
 255
 256 /**
 257  * modest_text_utils_split_addresses_list:
 258  * @addresses: a string
 259  *
 260  * obtains a GSList of addresses from a string of addresses
 261  * in the format understood by email protocols
 262  *
 263  * Returns: a GSList of strings
 264  **/
 265 GSList      *modest_text_utils_split_addresses_list (const gchar *addresses);
 266
 267 #endif /* __MODEST_TEXT_UTILS_H__ */