src/purple/purple-private.h

   1 /**
   2  * @file purple-private.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /* Forward declarations */
  24 struct sipe_core_public;
  25 struct _PurpleAccount;
  26 struct _PurpleChat;
  27 struct _PurpleConnection;
  28 struct _PurpleRoomlist;
  29 struct _PurpleXfer;
  30
  31 #ifndef _PurpleMessageFlags
  32 #define _PurpleMessageFlags int
  33 #endif
  34
  35 struct sipe_backend_private {
  36         struct sipe_core_public *public;
  37         struct _PurpleConnection *gc;
  38         struct _PurpleAccount *account;
  39         struct _PurpleRoomlist *roomlist;
  40         GHashTable *roomlist_map; /* name -> uri */
  41         GList *rejoin_chats;
  42         time_t last_keepalive;
  43 };
  44
  45 /**
  46  * Initiates outgoing file transfer, sending @c file to remote peer identified
  47  * by @c who.
  48  *
  49  * @param gc   a PurpleConnection
  50  * @param who  string identifying receiver of the file
  51  * @param file local file system path of the file to send
  52  */
  53 void sipe_purple_ft_send_file(struct _PurpleConnection *gc,
  54                               const char *who,
  55                               const char *file);
  56
  57 /**
  58  * Creates new PurpleXfer structure representing a file transfer.
  59  *
  60  * @param gc  a PurpleConnection
  61  * @param who remote participant in the file transfer session
  62  */
  63 struct _PurpleXfer *sipe_purple_ft_new_xfer(struct _PurpleConnection *gc,
  64                                             const char *who);
  65
  66 /* libpurple chat callbacks */
  67 #define SIPE_PURPLE_COMPONENT_KEY_CONVERSATION "_conv"
  68
  69 void sipe_purple_chat_setup_rejoin(struct sipe_backend_private *purple_private);
  70 void sipe_purple_chat_destroy_rejoin(struct sipe_backend_private *purple_private);
  71 void sipe_purple_chat_invite(struct _PurpleConnection *gc,
  72                              int id,
  73                              const char *message,
  74                              const char *name);
  75 void sipe_purple_chat_leave(struct _PurpleConnection *gc, int id);
  76 int sipe_purple_chat_send(struct _PurpleConnection *gc,
  77                           int id,
  78                           const char *what,
  79                           _PurpleMessageFlags flags);
  80 GList *sipe_purple_chat_menu(struct _PurpleChat *chat);
  81
  82 /* libpurple chat room callbacks */
  83 GList *sipe_purple_chat_info(struct _PurpleConnection *gc);
  84 GHashTable *sipe_purple_chat_info_defaults(struct _PurpleConnection *gc,
  85                                            const char *chat_name);
  86 void sipe_purple_chat_join(struct _PurpleConnection *gc, GHashTable *data);
  87 struct _PurpleRoomlist *sipe_purple_roomlist_get_list(struct _PurpleConnection *gc);
  88 void sipe_purple_roomlist_cancel(struct _PurpleRoomlist *list);
  89
  90 /* Convenience macros */
  91 #define PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC ((struct sipe_core_public *) account->gc->proto_data)
  92 #define PURPLE_GC_TO_SIPE_CORE_PUBLIC      ((struct sipe_core_public *) gc->proto_data)
  93
  94 /*
  95   Local Variables:
  96   mode: c
  97   c-file-style: "bsd"
  98   indent-tabs-mode: t
  99   tab-width: 8
 100   End:
 101 */