libempathy/empathy-utils.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2003-2007 Imendio AB
   4  * Copyright (C) 2007-2008 Collabora Ltd.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * Authors: Richard Hult <richard@imendio.com>
  22  *          Martyn Russell <martyn@imendio.com>
  23  *          Xavier Claessens <xclaesse@gmail.com>
  24  */
  25
  26 #ifndef __EMPATHY_UTILS_H__
  27 #define __EMPATHY_UTILS_H__
  28
  29 #include <glib.h>
  30 #include <glib-object.h>
  31
  32 #include <libxml/parser.h>
  33 #include <libxml/tree.h>
  34
  35 #include <libmissioncontrol/mc-account.h>
  36 #include <libmissioncontrol/mission-control.h>
  37
  38 #include "empathy-contact.h"
  39
  40 G_BEGIN_DECLS
  41
  42 #define EMPATHY_GET_PRIV(obj,type) ((type##Priv*) ((type*)obj)->priv)
  43 #define G_STR_EMPTY(x) ((x) == NULL || (x)[0] == '\0')
  44
  45 typedef enum {
  46         EMPATHY_REGEX_AS_IS,
  47         EMPATHY_REGEX_BROWSER,
  48         EMPATHY_REGEX_APT,
  49         EMPATHY_REGEX_EMAIL,
  50         EMPATHY_REGEX_OTHER,
  51         EMPATHY_REGEX_ALL,
  52 } EmpathyRegExType;
  53
  54 /* Regular expressions */
  55 gchar *      empathy_substring                      (const gchar     *str,
  56                                                     gint             start,
  57                                                     gint             end);
  58 gint         empathy_regex_match                    (EmpathyRegExType  type,
  59                                                     const gchar     *msg,
  60                                                     GArray          *start,
  61                                                     GArray          *end);
  62
  63 /* Strings */
  64 gint         empathy_strcasecmp                     (const gchar     *s1,
  65                                                     const gchar     *s2);
  66 gint         empathy_strncasecmp                    (const gchar     *s1,
  67                                                     const gchar     *s2,
  68                                                     gsize            n);
  69
  70 /* XML */
  71 gboolean     empathy_xml_validate                   (xmlDoc          *doc,
  72                                                     const gchar     *dtd_filename);
  73 xmlNodePtr   empathy_xml_node_get_child             (xmlNodePtr       node,
  74                                                     const gchar     *child_name);
  75 xmlChar *    empathy_xml_node_get_child_content     (xmlNodePtr       node,
  76                                                     const gchar     *child_name);
  77 xmlNodePtr   empathy_xml_node_find_child_prop_value (xmlNodePtr       node,
  78                                                     const gchar     *prop_name,
  79                                                     const gchar     *prop_value);
  80
  81 /* Others */
  82 guint        empathy_account_hash                   (gconstpointer    key);
  83 gboolean     empathy_account_equal                  (gconstpointer    a,
  84                                                     gconstpointer    b);
  85 MissionControl *empathy_mission_control_new         (void);
  86 void         empathy_call_with_contact              (EmpathyContact  *contact);
  87 void         empathy_call_with_contact_id           (McAccount       *account,
  88                                                      const gchar     *contact_id);
  89 void         empathy_chat_with_contact              (EmpathyContact  *contact);
  90 void         empathy_chat_with_contact_id           (McAccount       *account,
  91                                                      const gchar     *contact_id);
  92 const gchar * empathy_presence_get_default_message  (McPresence       presence);
  93 const gchar * empathy_presence_to_str               (McPresence       presence);
  94 McPresence    empathy_presence_from_str             (const gchar     *str);
  95 gchar *       empathy_file_lookup                   (const gchar     *filename,
  96                                                      const gchar     *subdir);
  97
  98 typedef gboolean (*EmpathyRunUntilReadyFunc)        (GObject         *object,
  99                                                      gpointer         user_data);
 100 void          empathy_run_until_ready               (gpointer         object);
 101 void          empathy_run_until_ready_full          (gpointer         object,
 102                                                      const gchar     *signal,
 103                                                      EmpathyRunUntilReadyFunc  func,
 104                                                      gpointer         user_data,
 105                                                      GMainLoop      **loop);
 106 McAccount *  empathy_channel_get_account            (TpChannel       *channel);
 107 gpointer      empathy_connect_to_account_status_changed (MissionControl *mc,
 108                                                          GCallback       handler,
 109                                                          gpointer        user_data,
 110                                                          GClosureNotify  free_func);
 111 void          empathy_disconnect_account_status_changed (gpointer        token);
 112
 113 G_END_DECLS
 114
 115 #endif /*  __EMPATHY_UTILS_H__ */