util.h

Go to the documentation of this file.
00001 
00006 /* purple
00007  *
00008  * Purple is the legal property of its developers, whose names are too numerous
00009  * to list here.  Please refer to the COPYRIGHT file distributed with this
00010  * source distribution.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU General Public License as published by
00014  * the Free Software Foundation; either version 2 of the License, or
00015  * (at your option) any later version.
00016  *
00017  * This program is distributed in the hope that it will be useful,
00018  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  * GNU General Public License for more details.
00021  *
00022  * You should have received a copy of the GNU General Public License
00023  * along with this program; if not, write to the Free Software
00024  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00025  *
00026  * @todo Rename the functions so that they live somewhere in the purple
00027  *       namespace.
00028  */
00029 #ifndef _PURPLE_UTIL_H_
00030 #define _PURPLE_UTIL_H_
00031 
00032 #include <stdio.h>
00033 
00034 #include "account.h"
00035 #include "xmlnode.h"
00036 #include "notify.h"
00037 
00038 #ifdef __cplusplus
00039 extern "C" {
00040 #endif
00041 
00042 typedef struct _PurpleUtilFetchUrlData PurpleUtilFetchUrlData;
00043 
00044 typedef struct _PurpleMenuAction
00045 {
00046     char *label;
00047     PurpleCallback callback;
00048     gpointer data;
00049     GList *children;
00050 } PurpleMenuAction;
00051 
00052 typedef char *(*PurpleInfoFieldFormatCallback)(const char *field, size_t len);
00053 
00060 typedef struct _PurpleKeyValuePair
00061 {
00062     gchar *key;
00063     void *value;
00064 
00065 } PurpleKeyValuePair;
00066 
00078 PurpleMenuAction *purple_menu_action_new(const char *label, PurpleCallback callback,
00079                                      gpointer data, GList *children);
00080 
00086 void purple_menu_action_free(PurpleMenuAction *act);
00087 
00088 /**************************************************************************/
00090 /**************************************************************************/
00104 gchar *purple_base16_encode(const guchar *data, gsize len);
00105 
00121 guchar *purple_base16_decode(const char *str, gsize *ret_len);
00122 
00135 gchar *purple_base16_encode_chunked(const guchar *data, gsize len);
00136 
00137 
00140 /**************************************************************************/
00142 /**************************************************************************/
00156 gchar *purple_base64_encode(const guchar *data, gsize len);
00157 
00173 guchar *purple_base64_decode(const char *str, gsize *ret_len);
00174 
00177 /**************************************************************************/
00179 /**************************************************************************/
00194 guchar *purple_quotedp_decode(const char *str, gsize *ret_len);
00195 
00198 /**************************************************************************/
00200 /**************************************************************************/
00222 char *purple_mime_decode_field(const char *str);
00223 
00227 /**************************************************************************/
00229 /**************************************************************************/
00258 const char *purple_utf8_strftime(const char *format, const struct tm *tm);
00259 
00268 const char *purple_get_tzoff_str(const struct tm *tm, gboolean iso);
00269 
00280 const char *purple_date_format_short(const struct tm *tm);
00281 
00292 const char *purple_date_format_long(const struct tm *tm);
00293 
00304 const char *purple_date_format_full(const struct tm *tm);
00305 
00316 const char *purple_time_format(const struct tm *tm);
00317 
00330 time_t purple_time_build(int year, int month, int day, int hour,
00331                        int min, int sec);
00332 
00335 #define PURPLE_NO_TZ_OFF -500000
00336 
00357 time_t purple_str_to_time(const char *timestamp, gboolean utc,
00358                         struct tm *tm, long *tz_off, const char **rest);
00359 
00363 /**************************************************************************/
00365 /**************************************************************************/
00383 gboolean purple_markup_find_tag(const char *needle, const char *haystack,
00384                               const char **start, const char **end,
00385                               GData **attributes);
00386 
00410 gboolean purple_markup_extract_info_field(const char *str, int len, PurpleNotifyUserInfo *user_info,
00411                                         const char *start_token, int skip,
00412                                         const char *end_token, char check_value,
00413                                         const char *no_value_token,
00414                                         const char *display_name, gboolean is_link,
00415                                         const char *link_prefix,
00416                     PurpleInfoFieldFormatCallback format_cb);
00417 
00425 void purple_markup_html_to_xhtml(const char *html, char **dest_xhtml,
00426                                char **dest_plain);
00427 
00435 char *purple_markup_strip_html(const char *str);
00436 
00444 char *purple_markup_linkify(const char *str);
00445 
00456 char *purple_unescape_html(const char *html);
00457 
00479 char *purple_markup_slice(const char *str, guint x, guint y);
00480 
00490 char *purple_markup_get_tag_name(const char *tag);
00491 
00508 const char * purple_markup_unescape_entity(const char *text, int *length);
00509 
00526 char * purple_markup_get_css_property(const gchar *style, const gchar *opt);
00527 
00528 
00532 /**************************************************************************/
00534 /**************************************************************************/
00544 const gchar *purple_home_dir(void);
00545 
00554 const char *purple_user_dir(void);
00555 
00560 void purple_util_set_user_dir(const char *dir);
00561 
00572 int purple_build_dir(const char *path, int mode);
00573 
00589 gboolean purple_util_write_data_to_file(const char *filename, const char *data,
00590                                       gssize size);
00591 
00609 gboolean
00610 purple_util_write_data_to_file_absolute(const char *filename_full, const char *data, gssize size);
00611 
00626 xmlnode *purple_util_read_xml_from_file(const char *filename,
00627                                       const char *description);
00628 
00645 FILE *purple_mkstemp(char **path, gboolean binary);
00646 
00655 const char *
00656 purple_util_get_image_extension(gconstpointer data, size_t len);
00657 
00662 char *purple_util_get_image_filename(gconstpointer image_data, size_t image_len);
00663 
00667 /**************************************************************************/
00669 /**************************************************************************/
00679 gboolean purple_program_is_valid(const char *program);
00680 
00686 gboolean purple_running_gnome(void);
00687 
00693 gboolean purple_running_kde(void);
00694 
00700 gboolean purple_running_osx(void);
00701 
00709 char *purple_fd_get_ip(int fd);
00710 
00714 /**************************************************************************/
00716 /**************************************************************************/
00736 const char *purple_normalize(const PurpleAccount *account, const char *str);
00737 
00750 const char *purple_normalize_nocase(const PurpleAccount *account, const char *str);
00751 
00761 gboolean purple_str_has_prefix(const char *s, const char *p);
00762 
00772 gboolean purple_str_has_suffix(const char *s, const char *x);
00773 
00782 gchar *purple_strdup_withhtml(const gchar *src);
00783 
00791 char *purple_str_add_cr(const char *str);
00792 
00804 void purple_str_strip_char(char *str, char thechar);
00805 
00816 void purple_util_chrreplace(char *string, char delimiter,
00817                           char replacement);
00818 
00831 gchar *purple_strreplace(const char *string, const char *delimiter,
00832                        const char *replacement);
00833 
00834 
00845 char *purple_utf8_ncr_encode(const char *in);
00846 
00847 
00858 char *purple_utf8_ncr_decode(const char *in);
00859 
00860 
00873 gchar *purple_strcasereplace(const char *string, const char *delimiter,
00874                            const char *replacement);
00875 
00885 const char *purple_strcasestr(const char *haystack, const char *needle);
00886 
00895 char *purple_str_size_to_units(size_t size);
00896 
00905 char *purple_str_seconds_to_string(guint sec);
00906 
00920 char *purple_str_binary_to_ascii(const unsigned char *binary, guint len);
00924 /**************************************************************************/
00926 /**************************************************************************/
00929 void purple_got_protocol_handler_uri(const char *uri);
00930 
00943 gboolean purple_url_parse(const char *url, char **ret_host, int *ret_port,
00944                         char **ret_path, char **ret_user, char **ret_passwd);
00945 
00961 typedef void (*PurpleUtilFetchUrlCallback)(PurpleUtilFetchUrlData *url_data, gpointer user_data, const gchar *url_text, gsize len, const gchar *error_message);
00962 
00974 #define purple_util_fetch_url(url, full, user_agent, http11, cb, data) \
00975     purple_util_fetch_url_request(url, full, user_agent, http11, NULL, \
00976         FALSE, cb, data);
00977 
00993 PurpleUtilFetchUrlData *purple_util_fetch_url_request(const gchar *url,
00994         gboolean full, const gchar *user_agent, gboolean http11,
00995         const gchar *request, gboolean include_headers,
00996         PurpleUtilFetchUrlCallback callback, gpointer data);
00997 
01004 void purple_util_fetch_url_cancel(PurpleUtilFetchUrlData *url_data);
01005 
01015 const char *purple_url_decode(const char *str);
01016 
01026 const char *purple_url_encode(const char *str);
01027 
01035 gboolean purple_email_is_valid(const char *address);
01036 
01046 GList *purple_uri_list_extract_uris(const gchar *uri_list);
01047 
01060 GList *purple_uri_list_extract_filenames(const gchar *uri_list);
01061 
01064 /**************************************************************************
01065  * UTF8 String Functions
01066  **************************************************************************/
01078 gchar *purple_utf8_try_convert(const char *str);
01079 
01089 gchar *purple_utf8_salvage(const char *str);
01090 
01104 int purple_utf8_strcasecmp(const char *a, const char *b);
01105 
01116 gboolean purple_utf8_has_word(const char *haystack, const char *needle);
01117 
01126 void purple_print_utf8_to_console(FILE *filestream, char *message);
01127 
01137 gboolean purple_message_meify(char *message, gssize len);
01138 
01147 char *purple_text_strip_mnemonic(const char *in);
01148 
01160 #define purple_add_eight(x) ((x)+8)
01161 
01171 const char *purple_unescape_filename(const char *str);
01172 
01180 const char *purple_escape_filename(const char *str);
01181 
01186 const char *_purple_oscar_convert(const char *act, const char *protocol);
01187 
01193 void purple_restore_default_signal_handlers(void);
01194 
01195 #ifdef __cplusplus
01196 }
01197 #endif
01198 
01199 #endif /* _PURPLE_UTIL_H_ */