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
  38 /**
  39  * modest_text_utils_derived_subject:
  40  * @subject: a string which contains the original subject
  41  * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:')
  42  *
  43  * create a 'derived' subject line for eg. replies and forwards
  44  *
  45  * Returns: a newly allocated string containing the resulting subject
  46  */
  47 gchar* modest_text_utils_derived_subject (const gchar *subject,
  48                                           const gchar* prefix);
  49
  50
  51 /**
  52  * modest_text_utils_quote:
  53  * @buf: a string which contains the message to quote
  54  * @from: the sender of the original message
  55  * @sent_date: sent date/time of the original message
  56  * @limit: specifies the maximum characters per line in the quoted text
  57  *
  58  * quote an existing message
  59  *
  60  * Returns: a newly allocated string containing the quoted message
  61  */
  62 gchar* modest_text_utils_quote (const gchar *text,
  63                                 const gchar *content_type,
  64                                 const gchar *from,
  65                                 const time_t sent_date,
  66                                 int limit);
  67
  68
  69 /**
  70  * modest_text_utils_cited_text:
  71  * @from: sender of the message
  72  * @sent_date: the sent date of the original message
  73  * @text: the text of the original message
  74  *
  75  * cite the text in a message
  76  *
  77  * Returns: a newly allocated string containing the cited text
  78  */
  79 gchar* modest_text_utils_cite (const gchar *text,
  80                                const gchar *content_type,
  81                                const gchar *from,
  82                                time_t sent_date);
  83
  84 /**
  85  * modest_text_utils_inlined_text
  86  * @from: the sender of the original message
  87  * @sent_date: sent date/time of the original message
  88  * @to: sent date/time of the original message
  89  * @subject: sent date/time of the original message
  90  * @text: sent date/time of the original message
  91  *
  92  * creates a new string with the "Original message" text prepended to
  93  * the text passed as argument and some data of the header
  94  *
  95  * Returns: a newly allocated string containing the quoted message
  96  */
  97 gchar*   modest_text_utils_inline (const gchar *text,
  98                                    const gchar *content_type,
  99                                    const gchar *from,
 100                                    time_t sent_date,
 101                                    const gchar *to,
 102                                    const gchar *subject);
 103
 104 /**
 105  * modest_text_utils_remove_address
 106  * @address_list: string with a comma-separated list of email addresses
 107  * @address: an specific e-mail address
 108  *
 109  * remove a specific address from a list of email addresses
 110  *
 111  * Returns: a newly allocated string containing the new list
 112  */
 113 gchar*   modest_text_utils_remove_address (const gchar *address_list,
 114                                            const gchar *address);
 115
 116 /**
 117  * modest_text_utils_convert_to_html:
 118  * @txt: a string which contains the message to quote
 119  *
 120  * convert plain text (utf8) into html
 121  *
 122  * Returns: a newly allocated string containing the html
 123  */
 124 gchar*  modest_text_utils_convert_to_html (const gchar *data);
 125
 126
 127 /**
 128  * modest_text_utils_strftime:
 129  * @s:
 130  * @max:
 131  * @fmt:
 132  * @tm
 133  *
 134  * this is just an alias for strftime(3), so we can use that without
 135  * getting warning from gcc
 136  *
 137  * Returns: a formatted string of max length @max in @s
 138  */
 139 size_t modest_text_utils_strftime(char *s, size_t max, const char  *fmt, const  struct tm *tm);
 140
 141
 142
 143 /**
 144  * modest_text_utils_display_addres:
 145  * @address: original address (UTF8 string)
 146  *
 147  * make a 'display address' from an address:
 148  * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
 149  * the change is in-place
 150  *
 151  * Returns: the new address. The string is *not* newly allocated.
 152  * NULL in case of error
 153  */
 154 gchar* modest_text_utils_display_address (gchar *address);
 155
 156
 157 #endif /* __MODEST_TEXT_UTILS_H__ */