util.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 *
 * @todo Rename the functions so that they live somewhere in the purple
 *       namespace.
 */
#ifndef _PURPLE_UTIL_H_
#define _PURPLE_UTIL_H_
 
#include <stdio.h>
 
typedef struct _PurpleUtilFetchUrlData PurpleUtilFetchUrlData;
typedef struct _PurpleMenuAction PurpleMenuAction;
typedef struct _PurpleKeyValuePair PurpleKeyValuePair;
 
#include "account.h"
#include "signals.h"
#include "xmlnode.h"
#include "notify.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct _PurpleMenuAction
{
    char *label;
    PurpleCallback callback;
    gpointer data;
    GList *children;
};
 
typedef char *(*PurpleInfoFieldFormatCallback)(const char *field, size_t len);
 
struct _PurpleKeyValuePair
{
    gchar *key;
    void *value;
 
};
 
PurpleMenuAction *purple_menu_action_new(const char *label, PurpleCallback callback,
                                     gpointer data, GList *children);
 
void purple_menu_action_free(PurpleMenuAction *act);
 
void purple_util_set_current_song(const char *title, const char *artist,
        const char *album);
 
char * purple_util_format_song_info(const char *title, const char *artist,
        const char *album, gpointer unused);
 
/**************************************************************************/
/**************************************************************************/
void purple_util_init(void);
 
void purple_util_uninit(void);
 
/**************************************************************************/
/**************************************************************************/
gchar *purple_base16_encode(const guchar *data, gsize len);
 
guchar *purple_base16_decode(const char *str, gsize *ret_len);
 
gchar *purple_base16_encode_chunked(const guchar *data, gsize len);
 
 
/**************************************************************************/
/**************************************************************************/
gchar *purple_base64_encode(const guchar *data, gsize len);
 
guchar *purple_base64_decode(const char *str, gsize *ret_len);
 
/**************************************************************************/
/**************************************************************************/
guchar *purple_quotedp_decode(const char *str, gsize *ret_len);
 
/**************************************************************************/
/**************************************************************************/
char *purple_mime_decode_field(const char *str);
 
/**************************************************************************/
/**************************************************************************/
const char *purple_utf8_strftime(const char *format, const struct tm *tm);
 
const char *purple_get_tzoff_str(const struct tm *tm, gboolean iso);
 
const char *purple_date_format_short(const struct tm *tm);
 
const char *purple_date_format_long(const struct tm *tm);
 
const char *purple_date_format_full(const struct tm *tm);
 
const char *purple_time_format(const struct tm *tm);
 
time_t purple_time_build(int year, int month, int day, int hour,
                       int min, int sec);
 
#define PURPLE_NO_TZ_OFF -500000
 
time_t purple_str_to_time(const char *timestamp, gboolean utc,
                        struct tm *tm, long *tz_off, const char **rest);
 
/**************************************************************************/
/**************************************************************************/
gchar *purple_markup_escape_text(const gchar *text, gssize length);
 
gboolean purple_markup_find_tag(const char *needle, const char *haystack,
                              const char **start, const char **end,
                              GData **attributes);
 
gboolean purple_markup_extract_info_field(const char *str, int len, PurpleNotifyUserInfo *user_info,
                                        const char *start_token, int skip,
                                        const char *end_token, char check_value,
                                        const char *no_value_token,
                                        const char *display_name, gboolean is_link,
                                        const char *link_prefix,
                    PurpleInfoFieldFormatCallback format_cb);
 
void purple_markup_html_to_xhtml(const char *html, char **dest_xhtml,
                               char **dest_plain);
 
char *purple_markup_strip_html(const char *str);
 
char *purple_markup_linkify(const char *str);
 
char *purple_unescape_text(const char *text);
 
char *purple_unescape_html(const char *html);
 
char *purple_markup_slice(const char *str, guint x, guint y);
 
char *purple_markup_get_tag_name(const char *tag);
 
const char * purple_markup_unescape_entity(const char *text, int *length);
 
char * purple_markup_get_css_property(const gchar *style, const gchar *opt);
 
gboolean purple_markup_is_rtl(const char *html);
 
/**************************************************************************/
/**************************************************************************/
const gchar *purple_home_dir(void);
 
const char *purple_user_dir(void);
 
void purple_util_set_user_dir(const char *dir);
 
int purple_build_dir(const char *path, int mode);
 
gboolean purple_util_write_data_to_file(const char *filename, const char *data,
                                      gssize size);
 
gboolean
purple_util_write_data_to_file_absolute(const char *filename_full, const char *data, gssize size);
 
xmlnode *purple_util_read_xml_from_file(const char *filename,
                                      const char *description);
 
FILE *purple_mkstemp(char **path, gboolean binary);
 
const char *
purple_util_get_image_extension(gconstpointer data, size_t len);
 
char *purple_util_get_image_checksum(gconstpointer image_data, size_t image_len);
 
char *purple_util_get_image_filename(gconstpointer image_data, size_t image_len);
 
/**************************************************************************/
/**************************************************************************/
gboolean purple_program_is_valid(const char *program);
 
gboolean purple_running_gnome(void);
 
gboolean purple_running_kde(void);
 
gboolean purple_running_osx(void);
 
char *purple_fd_get_ip(int fd);
 
int purple_socket_get_family(int fd);
 
gboolean purple_socket_speaks_ipv4(int fd);
 
/**************************************************************************/
/**************************************************************************/
gboolean purple_strequal(const gchar *left, const gchar *right);
 
const char *purple_normalize(const PurpleAccount *account, const char *str);
 
const char *purple_normalize_nocase(const PurpleAccount *account, const char *str);
 
gboolean purple_str_has_prefix(const char *s, const char *p);
 
gboolean purple_str_has_suffix(const char *s, const char *x);
 
gchar *purple_strdup_withhtml(const gchar *src);
 
char *purple_str_add_cr(const char *str);
 
void purple_str_strip_char(char *str, char thechar);
 
void purple_util_chrreplace(char *string, char delimiter,
                          char replacement);
 
gchar *purple_strreplace(const char *string, const char *delimiter,
                       const char *replacement);
 
 
char *purple_utf8_ncr_encode(const char *in);
 
 
char *purple_utf8_ncr_decode(const char *in);
 
 
gchar *purple_strcasereplace(const char *string, const char *delimiter,
                           const char *replacement);
 
const char *purple_strcasestr(const char *haystack, const char *needle);
 
char *purple_str_size_to_units(size_t size);
 
char *purple_str_seconds_to_string(guint sec);
 
char *purple_str_binary_to_ascii(const unsigned char *binary, guint len);
/**************************************************************************/
/**************************************************************************/
void purple_got_protocol_handler_uri(const char *uri);
 
gboolean purple_url_parse(const char *url, char **ret_host, int *ret_port,
                        char **ret_path, char **ret_user, char **ret_passwd);
 
typedef void (*PurpleUtilFetchUrlCallback)(PurpleUtilFetchUrlData *url_data, gpointer user_data, const gchar *url_text, gsize len, const gchar *error_message);
 
#define purple_util_fetch_url(url, full, user_agent, http11, cb, data) \
    purple_util_fetch_url_request(url, full, user_agent, http11, NULL, \
        FALSE, cb, data);
 
#define purple_util_fetch_url_len(url, full, user_agent, http11, max_len, cb, data) \
    purple_util_fetch_url_request_len(url, full, user_agent, http11, NULL, \
        FALSE, max_len, cb, data);
 
PurpleUtilFetchUrlData *purple_util_fetch_url_request(const gchar *url,
        gboolean full, const gchar *user_agent, gboolean http11,
        const gchar *request, gboolean include_headers,
        PurpleUtilFetchUrlCallback callback, gpointer data);
 
PurpleUtilFetchUrlData *purple_util_fetch_url_request_len(const gchar *url,
        gboolean full, const gchar *user_agent, gboolean http11,
        const gchar *request, gboolean include_headers, gssize max_len,
        PurpleUtilFetchUrlCallback callback, gpointer data);
 
PurpleUtilFetchUrlData *purple_util_fetch_url_request_len_with_account(
        PurpleAccount *account, const gchar *url,
        gboolean full, const gchar *user_agent, gboolean http11,
        const gchar *request, gboolean include_headers, gssize max_len,
        PurpleUtilFetchUrlCallback callback, gpointer data);
 
PurpleUtilFetchUrlData *
purple_util_fetch_url_request_data_len_with_account(PurpleAccount *account,
        const char *url, gboolean full, const char *user_agent, gboolean http11,
        const char *request, gsize request_len, gboolean include_headers, gssize max_len,
        PurpleUtilFetchUrlCallback callback, void *user_data);
void purple_util_fetch_url_cancel(PurpleUtilFetchUrlData *url_data);
 
const char *purple_url_decode(const char *str);
 
const char *purple_url_encode(const char *str);
 
gboolean purple_email_is_valid(const char *address);
 
gboolean purple_ip_address_is_valid(const char *ip);
 
gboolean purple_ipv4_address_is_valid(const char *ip);
 
gboolean purple_ipv6_address_is_valid(const char *ip);
 
GList *purple_uri_list_extract_uris(const gchar *uri_list);
 
GList *purple_uri_list_extract_filenames(const gchar *uri_list);
 
char *purple_uri_escape_for_open(const char *unescaped);
 
/**************************************************************************
 * UTF8 String Functions
 **************************************************************************/
gchar *purple_utf8_try_convert(const char *str);
 
gchar *purple_utf8_salvage(const char *str);
 
gchar *purple_utf8_strip_unprintables(const gchar *str);
 
const gchar *purple_gai_strerror(gint errnum);
 
int purple_utf8_strcasecmp(const char *a, const char *b);
 
gboolean purple_utf8_has_word(const char *haystack, const char *needle);
 
void purple_print_utf8_to_console(FILE *filestream, char *message);
 
gboolean purple_message_meify(char *message, gssize len);
 
char *purple_text_strip_mnemonic(const char *in);
 
#define purple_add_eight(x) ((x)+8)
 
const char *purple_unescape_filename(const char *str);
 
const char *purple_escape_filename(const char *str);
 
const char *_purple_oscar_convert(const char *act, const char *protocol);
 
void purple_restore_default_signal_handlers(void);
 
const gchar *purple_get_host_name(void);
 
gchar *purple_uuid_random(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_UTIL_H_ */