source: protocols/bee.h @ 36577aa

Last change on this file since 36577aa was eaaa986, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-05-08T14:48:38Z

Misc. cleanup. Also updated the Yahoo! module to deal with struct groupchat
in a GSList so that a default config fully compiles again.

  • Property mode set to 100644
File size: 5.5 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2010 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* Stuff to handle, save and search buddies                             */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23  Suite 330, Boston, MA  02111-1307  USA
24*/
25
26#ifndef __BEE_H__
27#define __BEE_H__
28
29struct bee_ui_funcs;
30struct groupchat;
31
32typedef struct bee
33{
34        struct set *set;
35       
36        GSList *users;
37        struct account *accounts; /* TODO(wilmer): Use GSList here too? */
38       
39        /* Symbolic, to refer to the local user (who has no real bee_user
40           object). Not to be used by anything except so far imcb_chat_add/
41           remove_buddy(). This seems slightly cleaner than abusing NULL. */
42        struct bee_user *user;
43       
44        const struct bee_ui_funcs *ui;
45        void *ui_data;
46} bee_t;
47
48bee_t *bee_new();
49void bee_free( bee_t *b );
50
51typedef enum
52{
53        BEE_USER_ONLINE = 1,    /* Compatibility with old OPT_LOGGED_IN flag */
54        BEE_USER_AWAY = 4,      /* Compatibility with old OPT_AWAY flag */
55} bee_user_flags_t;
56
57typedef struct bee_user
58{
59        struct im_connection *ic;
60        char *handle;
61        char *fullname;
62        char *group;
63
64        bee_user_flags_t flags;
65        char *status;
66        char *status_msg;
67       
68        bee_t *bee;
69        void *ui_data;
70} bee_user_t;
71
72typedef struct bee_ui_funcs
73{
74        gboolean (*user_new)( bee_t *bee, struct bee_user *bu );
75        gboolean (*user_free)( bee_t *bee, struct bee_user *bu );
76        gboolean (*user_fullname)( bee_t *bee, bee_user_t *bu );
77        gboolean (*user_status)( bee_t *bee, struct bee_user *bu, struct bee_user *old );
78        gboolean (*user_msg)( bee_t *bee, bee_user_t *bu, const char *msg, time_t sent_at );
79        gboolean (*user_typing)( bee_t *bee, bee_user_t *bu, guint32 flags );
80       
81        gboolean (*chat_new)( bee_t *bee, struct groupchat *c );
82        gboolean (*chat_free)( bee_t *bee, struct groupchat *c );
83        gboolean (*chat_log)( bee_t *bee, struct groupchat *c, const char *text );
84        gboolean (*chat_msg)( bee_t *bee, struct groupchat *c, bee_user_t *bu, const char *msg, time_t sent_at );
85        gboolean (*chat_add_user)( bee_t *bee, struct groupchat *c, bee_user_t *bu );
86        gboolean (*chat_remove_user)( bee_t *bee, struct groupchat *c, bee_user_t *bu );
87        gboolean (*chat_topic)( bee_t *bee, struct groupchat *c, const char *new, bee_user_t *bu );
88        gboolean (*chat_name_hint)( bee_t *bee, struct groupchat *c, const char *name );
89       
90        struct file_transfer* (*ft_in_start)( bee_t *bee, bee_user_t *bu, const char *file_name, size_t file_size );
91        gboolean (*ft_out_start)( struct im_connection *ic, struct file_transfer *ft );
92        void (*ft_close)( struct im_connection *ic, struct file_transfer *ft );
93        void (*ft_finished)( struct im_connection *ic, struct file_transfer *ft );
94} bee_ui_funcs_t;
95
96
97/* bee.c */
98bee_t *bee_new();
99void bee_free( bee_t *b );
100
101/* bee_user.c */
102bee_user_t *bee_user_new( bee_t *bee, struct im_connection *ic, const char *handle );
103int bee_user_free( bee_t *bee, bee_user_t *bu );
104bee_user_t *bee_user_by_handle( bee_t *bee, struct im_connection *ic, const char *handle );
105int bee_user_msg( bee_t *bee, bee_user_t *bu, const char *msg, int flags );
106
107/* Callbacks from IM modules to core: */
108/* Buddy activity */
109/* To manipulate the status of a handle.
110 * - flags can be |='d with OPT_* constants. You will need at least:
111 *   OPT_LOGGED_IN and OPT_AWAY.
112 * - 'state' and 'message' can be NULL */
113G_MODULE_EXPORT void imcb_buddy_status( struct im_connection *ic, const char *handle, int flags, const char *state, const char *message );
114/* Not implemented yet! */ G_MODULE_EXPORT void imcb_buddy_times( struct im_connection *ic, const char *handle, time_t login, time_t idle );
115/* Call when a handle says something. 'flags' and 'sent_at may be just 0. */
116G_MODULE_EXPORT void imcb_buddy_msg( struct im_connection *ic, const char *handle, char *msg, guint32 flags, time_t sent_at );
117
118/* bee_chat.c */
119#if 0
120struct groupchat *imcb_chat_new( struct im_connection *ic, const char *handle );
121void imcb_chat_name_hint( struct groupchat *c, const char *name );
122void imcb_chat_free( struct groupchat *c );
123void imcb_chat_msg( struct groupchat *c, const char *who, char *msg, uint32_t flags, time_t sent_at );
124void imcb_chat_log( struct groupchat *c, char *format, ... );
125void imcb_chat_topic( struct groupchat *c, char *who, char *topic, time_t set_at );
126void imcb_chat_add_buddy( struct groupchat *b, const char *handle );
127void imcb_chat_remove_buddy( struct groupchat *b, const char *handle, const char *reason );
128static int remove_chat_buddy_silent( struct groupchat *b, const char *handle );
129#endif
130int bee_chat_msg( bee_t *bee, struct groupchat *c, const char *msg, int flags );
131struct groupchat *bee_chat_by_title( bee_t *bee, struct im_connection *ic, const char *title );
132
133#endif /* __BEE_H__ */
Note: See TracBrowser for help on using the repository browser.