libempathy/empathy-utils.h

   1 /*
   2  * Copyright (C) 2003-2007 Imendio AB
   3  * Copyright (C) 2007-2011 Collabora Ltd.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, write to the
  17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  18  * Boston, MA  02110-1301  USA
  19  *
  20  * Authors: Richard Hult <richard@imendio.com>
  21  *          Martyn Russell <martyn@imendio.com>
  22  *          Xavier Claessens <xclaesse@gmail.com>
  23  */
  24
  25 #ifndef __EMPATHY_UTILS_H__
  26 #define __EMPATHY_UTILS_H__
  27
  28 #include <glib.h>
  29 #include <glib-object.h>
  30
  31 #include <gnutls/gnutls.h>
  32 #include <gnutls/x509.h>
  33 #include <libxml/parser.h>
  34 #include <libxml/tree.h>
  35 #include <folks/folks.h>
  36 #include <folks/folks-telepathy.h>
  37 #include <telepathy-glib/telepathy-glib.h>
  38
  39 #include "empathy-contact.h"
  40
  41 #define EMPATHY_GET_PRIV(obj,type) ((type##Priv *) ((type *) obj)->priv)
  42 #define EMP_STR_EMPTY(x) ((x) == NULL || (x)[0] == '\0')
  43
  44 G_BEGIN_DECLS
  45
  46 void empathy_init (void);
  47
  48 /* XML */
  49 gboolean empathy_xml_validate (xmlDoc *doc,
  50     const gchar *dtd_filename);
  51 xmlNodePtr empathy_xml_node_get_child (xmlNodePtr node,
  52     const gchar *child_name);
  53 xmlChar * empathy_xml_node_get_child_content (xmlNodePtr node,
  54     const gchar *child_name);
  55 xmlNodePtr empathy_xml_node_find_child_prop_value (xmlNodePtr node,
  56     const gchar *prop_name,
  57     const gchar *prop_value);
  58
  59 /* Others */
  60 const gchar * empathy_presence_get_default_message (
  61     TpConnectionPresenceType presence);
  62 const gchar * empathy_presence_to_str (TpConnectionPresenceType presence);
  63 TpConnectionPresenceType empathy_presence_from_str (const gchar *str);
  64 gchar * empathy_file_lookup (const gchar *filename,
  65     const gchar *subdir);
  66 gboolean empathy_check_available_state (void);
  67 gint empathy_uint_compare (gconstpointer a,
  68     gconstpointer b);
  69
  70 const gchar * empathy_account_get_error_message (TpAccount *account,
  71     gboolean *user_requested);
  72
  73 gchar *empathy_protocol_icon_name (const gchar *protocol);
  74 const gchar *empathy_protocol_name_to_display_name (const gchar *proto_name);
  75 const gchar *empathy_service_name_to_display_name (const gchar *proto_name);
  76
  77 #define EMPATHY_ARRAY_TYPE_OBJECT (empathy_type_dbus_ao ())
  78 GType empathy_type_dbus_ao (void);
  79
  80 gboolean empathy_account_manager_get_accounts_connected (gboolean *connecting);
  81
  82 void empathy_connect_new_account (TpAccount *account,
  83     TpAccountManager *account_manager);
  84
  85 TpConnectionPresenceType empathy_folks_presence_type_to_tp (
  86     FolksPresenceType type);
  87 gboolean empathy_folks_individual_contains_contact (
  88     FolksIndividual *individual);
  89 EmpathyContact * empathy_contact_dup_from_folks_individual (
  90     FolksIndividual *individual);
  91 TpChannelGroupChangeReason tp_channel_group_change_reason_from_folks_groups_change_reason (
  92     FolksGroupDetailsChangeReason reason);
  93 TpfPersonaStore * empathy_dup_persona_store_for_connection (
  94     TpConnection *connection);
  95 gboolean empathy_connection_can_add_personas (TpConnection *connection);
  96 gboolean empathy_connection_can_alias_personas (TpConnection *connection,
  97                                                 FolksIndividual *individual);
  98 gboolean empathy_connection_can_group_personas (TpConnection *connection,
  99                                                 FolksIndividual *individual);
 100 gboolean empathy_folks_persona_is_interesting (FolksPersona *persona);
 101
 102 gchar * empathy_get_x509_certificate_hostname (gnutls_x509_crt_t cert);
 103
 104 gchar *empathy_format_currency (gint amount,
 105     guint scale,
 106     const gchar *currency);
 107
 108 gboolean empathy_account_has_uri_scheme_tel (TpAccount *account);
 109
 110 TpContact * empathy_get_tp_contact_for_individual (FolksIndividual *individual,
 111     TpConnection *conn);
 112
 113 void empathy_individual_can_audio_video_call (FolksIndividual *individual,
 114     gboolean *can_audio_call,
 115     gboolean *can_video_call,
 116     EmpathyContact **out_contact);
 117
 118 FolksIndividual * empathy_create_individual_from_tp_contact (
 119     TpContact *contact);
 120
 121 FolksIndividual * empathy_ensure_individual_from_tp_contact (
 122     TpContact *contact);
 123
 124 const gchar * const * empathy_individual_get_client_types (
 125     FolksIndividual *individual);
 126
 127 GVariant * empathy_asv_to_vardict (const GHashTable *asv);
 128
 129 GVariant * empathy_boxed_to_variant (GType gtype,
 130     const gchar *variant_type,
 131     gpointer boxed);
 132
 133 /* Copied from wocky/wocky-utils.h */
 134
 135 #define empathy_implement_finish_void(source, tag) \
 136     if (g_simple_async_result_propagate_error (\
 137       G_SIMPLE_ASYNC_RESULT (result), error)) \
 138       return FALSE; \
 139     g_return_val_if_fail (g_simple_async_result_is_valid (result, \
 140             G_OBJECT(source), tag), \
 141         FALSE); \
 142     return TRUE;
 143
 144 #define empathy_implement_finish_copy_pointer(source, tag, copy_func, \
 145     out_param) \
 146     GSimpleAsyncResult *_simple; \
 147     _simple = (GSimpleAsyncResult *) result; \
 148     if (g_simple_async_result_propagate_error (_simple, error)) \
 149       return FALSE; \
 150     g_return_val_if_fail (g_simple_async_result_is_valid (result, \
 151             G_OBJECT (source), tag), \
 152         FALSE); \
 153     if (out_param != NULL) \
 154       *out_param = copy_func ( \
 155           g_simple_async_result_get_op_res_gpointer (_simple)); \
 156     return TRUE;
 157
 158 #define empathy_implement_finish_return_copy_pointer(source, tag, copy_func) \
 159     GSimpleAsyncResult *_simple; \
 160     _simple = (GSimpleAsyncResult *) result; \
 161     if (g_simple_async_result_propagate_error (_simple, error)) \
 162       return NULL; \
 163     g_return_val_if_fail (g_simple_async_result_is_valid (result, \
 164             G_OBJECT (source), tag), \
 165         NULL); \
 166     return copy_func (g_simple_async_result_get_op_res_gpointer (_simple));
 167
 168 #define empathy_implement_finish_return_pointer(source, tag) \
 169     GSimpleAsyncResult *_simple; \
 170     _simple = (GSimpleAsyncResult *) result; \
 171     if (g_simple_async_result_propagate_error (_simple, error)) \
 172       return NULL; \
 173     g_return_val_if_fail (g_simple_async_result_is_valid (result, \
 174             G_OBJECT (source), tag), \
 175         NULL); \
 176     return g_simple_async_result_get_op_res_gpointer (_simple);
 177
 178 G_END_DECLS
 179
 180 #endif /*  __EMPATHY_UTILS_H__ */