+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
/* modest-text-utils.h */
-/* insert (c)/licensing information) */
#ifndef __MODEST_TEXT_UTILS_H__
#define __MODEST_TEXT_UTILS_H__
-/* public */
+#include <time.h>
+#include <glib.h>
+
+/**
+ * modest_text_utils_derived_subject:
+ * @subject: a string which contains the original subject
+ * @prefix: the prefix for the new subject (such as 'Re:' or 'Fwd:'),
+ * must not be NULL
+ *
+ * create a 'derived' subject line for eg. replies and forwards
+ *
+ * Returns: a newly allocated string containing the resulting subject
+ * subject == NULL, then @prefix " " will be returned
+ */
+gchar* modest_text_utils_derived_subject (const gchar *subject,
+ const gchar* prefix);
+
/**
* modest_text_utils_quote:
- * @buf: a GtkTextBuffer which contains the message to quote
+ * @buf: a string which contains the message to quote
* @from: the sender of the original message
* @sent_date: sent date/time of the original message
* @limit: specifies the maximum characters per line in the quoted text
*
- * Returns: a string containing the quoted message
+ * quote an existing message
+ *
+ * Returns: a newly allocated string containing the quoted message
+ */
+gchar* modest_text_utils_quote (const gchar *text,
+ const gchar *content_type,
+ const gchar *from,
+ const time_t sent_date,
+ int limit);
+
+
+/**
+ * modest_text_utils_cited_text:
+ * @from: sender of the message
+ * @sent_date: the sent date of the original message
+ * @text: the text of the original message
+ *
+ * cite the text in a message
+ *
+ * Returns: a newly allocated string containing the cited text
+ */
+gchar* modest_text_utils_cite (const gchar *text,
+ const gchar *content_type,
+ const gchar *from,
+ time_t sent_date);
+
+/**
+ * modest_text_utils_inlined_text
+ * @from: the sender of the original message
+ * @sent_date: sent date/time of the original message
+ * @to: sent date/time of the original message
+ * @subject: sent date/time of the original message
+ * @text: sent date/time of the original message
+ *
+ * creates a new string with the "Original message" text prepended to
+ * the text passed as argument and some data of the header
+ *
+ * Returns: a newly allocated string containing the quoted message
+ */
+gchar* modest_text_utils_inline (const gchar *text,
+ const gchar *content_type,
+ const gchar *from,
+ time_t sent_date,
+ const gchar *to,
+ const gchar *subject);
+
+/**
+ * modest_text_utils_remove_address
+ * @address_list: string with a comma-separated list of email addresses
+ * @address: an specific e-mail address
+ *
+ * remove a specific address from a list of email addresses
+ *
+ * Returns: a newly allocated string containing the new list
+ */
+gchar* modest_text_utils_remove_address (const gchar *address_list,
+ const gchar *address);
+
+/**
+ * modest_text_utils_convert_to_html:
+ * @txt: a string which contains the message to quote
+ *
+ * convert plain text (utf8) into html
+ *
+ * Returns: a newly allocated string containing the html
+ */
+gchar* modest_text_utils_convert_to_html (const gchar *data);
+
+
+/**
+ * modest_text_utils_strftime:
+ * @s:
+ * @max:
+ * @fmt:
+ * @tm
+ *
+ * this is just an alias for strftime(3), so we can use that without
+ * getting warning from gcc
+ *
+ * Returns: a formatted string of max length @max in @s
+ */
+size_t modest_text_utils_strftime(char *s, size_t max, const char *fmt, const struct tm *tm);
+
+
+
+/**
+ * modest_text_utils_display_addres:
+ * @address: original address (UTF8 string)
+ *
+ * make a 'display address' from an address:
+ * "Foo Bar <foo@bar.cx> (Bla)" --> "Foo Bar"
+ * ie. removes "<...>" and "(...)" parts
+ * the change is in-place; removes leading/trailing whitespace
+ *
+ * Returns: the new address. The string is *not* newly allocated.
+ * NULL in case of error
*/
-gchar *
-modest_text_utils_quote(GtkTextBuffer *buf,
- const gchar *from,
- const time_t sent_date,
- const int limit);
+gchar* modest_text_utils_display_address (gchar *address);
-#endif
+#endif /* __MODEST_TEXT_UTILS_H__ */
projects / modest / blobdiff