blist.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
 */
#ifndef _PURPLE_BLIST_H_
#define _PURPLE_BLIST_H_
 
/* I can't believe I let ChipX86 inspire me to write good code. -Sean */
 
#include <glib.h>
 
typedef struct _PurpleBuddyList PurpleBuddyList;
typedef struct _PurpleBlistUiOps PurpleBlistUiOps;
typedef struct _PurpleBlistNode PurpleBlistNode;
 
typedef struct _PurpleChat PurpleChat;
typedef struct _PurpleGroup PurpleGroup;
typedef struct _PurpleContact PurpleContact;
typedef struct _PurpleBuddy PurpleBuddy;
 
/**************************************************************************/
/* Enumerations                                                           */
/**************************************************************************/
typedef enum
{
    PURPLE_BLIST_GROUP_NODE,
    PURPLE_BLIST_CONTACT_NODE,
    PURPLE_BLIST_BUDDY_NODE,
    PURPLE_BLIST_CHAT_NODE,
    PURPLE_BLIST_OTHER_NODE
 
} PurpleBlistNodeType;
 
#define PURPLE_BLIST_NODE_IS_CHAT(n)    (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE)
#define PURPLE_BLIST_NODE_IS_BUDDY(n)   (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE)
#define PURPLE_BLIST_NODE_IS_CONTACT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE)
#define PURPLE_BLIST_NODE_IS_GROUP(n)   (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE)
 
#define PURPLE_BUDDY_IS_ONLINE(b) \
    ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
     purple_presence_is_online(purple_buddy_get_presence(b)))
 
typedef enum
{
    PURPLE_BLIST_NODE_FLAG_NO_SAVE      = 1 << 0, 
    PURPLE_BLIST_NODE_FLAG_INVISIBLE    = 1 << 1, 
} PurpleBlistNodeFlags;
 
#define PURPLE_BLIST_NODE(obj) ((PurpleBlistNode *)(obj))
 
#define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f))
#define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
#define PURPLE_BLIST_NODE_IS_VISIBLE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_INVISIBLE))
 
#define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE  ? purple_chat_get_name((PurpleChat*)n) :        \
                     purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
 
#define PURPLE_GROUP(obj) ((PurpleGroup *)(obj))
 
#define PURPLE_CONTACT(obj) ((PurpleContact *)(obj))
 
#define PURPLE_BUDDY(obj) ((PurpleBuddy *)(obj))
 
#define PURPLE_CHAT(obj) ((PurpleChat *)(obj))
 
#include "account.h"
#include "buddyicon.h"
#include "media.h"
#include "status.h"
 
/**************************************************************************/
/* Data Structures                                                        */
/**************************************************************************/
 
#if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_BLIST_C_)
 
struct _PurpleBlistNode {
    PurpleBlistNodeType type;             
    PurpleBlistNode *prev;                
    PurpleBlistNode *next;                
    PurpleBlistNode *parent;              
    PurpleBlistNode *child;               
    GHashTable *settings;               
    void          *ui_data;             
    PurpleBlistNodeFlags flags;           
};
 
struct _PurpleBuddy {
    PurpleBlistNode node;                     
    char *name;                             
    char *alias;                            
    char *server_alias;                     
    void *proto_data;                       
    PurpleBuddyIcon *icon;                    
    PurpleAccount *account;                 
    PurplePresence *presence;
    PurpleMediaCaps media_caps;     
};
 
struct _PurpleContact {
    PurpleBlistNode node;       
    char *alias;            
    int totalsize;          
    int currentsize;        
    int online;             
    PurpleBuddy *priority;    
    gboolean priority_valid; 
};
 
 
struct _PurpleGroup {
    PurpleBlistNode node;                    
    char *name;                            
    int totalsize;                 
    int currentsize;               
    int online;                
};
 
struct _PurpleChat {
    PurpleBlistNode node;      
    char *alias;             
    GHashTable *components;  
    PurpleAccount *account; 
};
 
struct _PurpleBuddyList {
    PurpleBlistNode *root;          
    GHashTable *buddies;          
    void *ui_data;                
};
 
#endif /* PURPLE_HIDE_STRUCTS && PURPLE_BLIST_STRUCTS */
 
struct _PurpleBlistUiOps
{
    void (*new_list)(PurpleBuddyList *list); 
    void (*new_node)(PurpleBlistNode *node); 
    void (*show)(PurpleBuddyList *list);     
    void (*update)(PurpleBuddyList *list,
               PurpleBlistNode *node);       
    void (*remove)(PurpleBuddyList *list,
               PurpleBlistNode *node);       
    void (*destroy)(PurpleBuddyList *list);  
    void (*set_visible)(PurpleBuddyList *list,
                gboolean show);            
    void (*request_add_buddy)(PurpleAccount *account, const char *username,
                              const char *group, const char *alias);
    void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
                             const char *alias, const char *name);
    void (*request_add_group)(void);
 
    void (*save_node)(PurpleBlistNode *node);
 
    void (*remove_node)(PurpleBlistNode *node);
 
    void (*save_account)(PurpleAccount *account);
 
    void (*_purple_reserved1)(void);
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
PurpleBuddyList *purple_blist_new(void);
 
void purple_set_blist(PurpleBuddyList *blist);
 
PurpleBuddyList *purple_get_blist(void);
 
PurpleBlistNode *purple_blist_get_root(void);
 
GSList *purple_blist_get_buddies(void);
 
gpointer purple_blist_get_ui_data(void);
 
void purple_blist_set_ui_data(gpointer ui_data);
 
PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
 
PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
 
PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
 
PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
 
PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
 
gpointer purple_blist_node_get_ui_data(const PurpleBlistNode *node);
 
void purple_blist_node_set_ui_data(PurpleBlistNode *node, gpointer ui_data);
 
void purple_blist_show(void);
 
 
void purple_blist_destroy(void);
 
void purple_blist_set_visible(gboolean show);
 
void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
 
void purple_blist_update_node_icon(PurpleBlistNode *node);
 
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
#endif
 
void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
 
void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
 
void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
 
void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
 
void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
 
void purple_blist_rename_group(PurpleGroup *group, const char *name);
 
PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
 
void purple_chat_destroy(PurpleChat *chat);
 
void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
 
PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *name, const char *alias);
 
void purple_buddy_destroy(PurpleBuddy *buddy);
 
void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
 
PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
 
const char *purple_buddy_get_name(const PurpleBuddy *buddy);
 
PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
 
gpointer purple_buddy_get_protocol_data(const PurpleBuddy *buddy);
 
void purple_buddy_set_protocol_data(PurpleBuddy *buddy, gpointer data);
 
PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
 
PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
 
PurpleMediaCaps purple_buddy_get_media_caps(const PurpleBuddy *buddy);
 
void purple_buddy_set_media_caps(PurpleBuddy *buddy, PurpleMediaCaps media_caps);
 
void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
 
PurpleGroup *purple_group_new(const char *name);
 
void purple_group_destroy(PurpleGroup *group);
 
void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
 
PurpleContact *purple_contact_new(void);
 
void purple_contact_destroy(PurpleContact *contact);
 
PurpleGroup *purple_contact_get_group(const PurpleContact *contact);
 
void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
 
void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
 
PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
 
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
void purple_contact_set_alias(PurpleContact *contact, const char *alias);
#endif
 
const char *purple_contact_get_alias(PurpleContact *contact);
 
gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
 
void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
 
void purple_blist_remove_buddy(PurpleBuddy *buddy);
 
void purple_blist_remove_contact(PurpleContact *contact);
 
void purple_blist_remove_chat(PurpleChat *chat);
 
void purple_blist_remove_group(PurpleGroup *group);
 
const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
 
const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
 
const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
 
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
#endif
 
const char *purple_buddy_get_alias(PurpleBuddy *buddy);
 
const char *purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy);
 
const char *purple_chat_get_name(PurpleChat *chat);
 
PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
 
PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
        PurpleGroup *group);
 
GSList *purple_find_buddies(PurpleAccount *account, const char *name);
 
 
PurpleGroup *purple_find_group(const char *name);
 
PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
 
PurpleGroup *purple_chat_get_group(PurpleChat *chat);
 
PurpleAccount *purple_chat_get_account(PurpleChat *chat);
 
GHashTable *purple_chat_get_components(PurpleChat *chat);
 
PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
 
 
GSList *purple_group_get_accounts(PurpleGroup *g);
 
gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
 
const char *purple_group_get_name(PurpleGroup *group);
 
void purple_blist_add_account(PurpleAccount *account);
 
 
void purple_blist_remove_account(PurpleAccount *account);
 
 
int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
 
int purple_blist_get_group_online_count(PurpleGroup *group);
 
/****************************************************************************************/
/****************************************************************************************/
 
void purple_blist_load(void);
 
void purple_blist_schedule_save(void);
 
void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
                                  const char *group, const char *alias);
 
void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
                                 const char *alias, const char *name);
 
void purple_blist_request_add_group(void);
 
void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
 
gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
 
void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
 
int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
 
void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
        const char *value);
 
const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
 
void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
 
void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
 
PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
 
PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
 
GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
 
/**************************************************************************/
/**************************************************************************/
void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
 
PurpleBlistUiOps *purple_blist_get_ui_ops(void);
 
/**************************************************************************/
/**************************************************************************/
void *purple_blist_get_handle(void);
 
void purple_blist_init(void);
 
void purple_blist_uninit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_BLIST_H_ */