blist.h

Go to the documentation of this file.
00001 
00027 #ifndef _PURPLE_BLIST_H_
00028 #define _PURPLE_BLIST_H_
00029 
00030 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */
00031 
00032 #include <glib.h>
00033 
00034 typedef struct _PurpleBuddyList PurpleBuddyList;
00035 typedef struct _PurpleBlistUiOps PurpleBlistUiOps;
00036 typedef struct _PurpleBlistNode PurpleBlistNode;
00037 
00038 typedef struct _PurpleChat PurpleChat;
00039 typedef struct _PurpleGroup PurpleGroup;
00040 typedef struct _PurpleContact PurpleContact;
00041 typedef struct _PurpleBuddy PurpleBuddy;
00042 
00043 /**************************************************************************/
00044 /* Enumerations                                                           */
00045 /**************************************************************************/
00046 typedef enum
00047 {
00048     PURPLE_BLIST_GROUP_NODE,
00049     PURPLE_BLIST_CONTACT_NODE,
00050     PURPLE_BLIST_BUDDY_NODE,
00051     PURPLE_BLIST_CHAT_NODE,
00052     PURPLE_BLIST_OTHER_NODE
00053 
00054 } PurpleBlistNodeType;
00055 
00056 #define PURPLE_BLIST_NODE_IS_CHAT(n)    ((n)->type == PURPLE_BLIST_CHAT_NODE)
00057 #define PURPLE_BLIST_NODE_IS_BUDDY(n)   ((n)->type == PURPLE_BLIST_BUDDY_NODE)
00058 #define PURPLE_BLIST_NODE_IS_CONTACT(n) ((n)->type == PURPLE_BLIST_CONTACT_NODE)
00059 #define PURPLE_BLIST_NODE_IS_GROUP(n)   ((n)->type == PURPLE_BLIST_GROUP_NODE)
00060 
00061 #define PURPLE_BUDDY_IS_ONLINE(b) \
00062     ((b) != NULL && purple_account_is_connected((b)->account) && \
00063      purple_presence_is_online(purple_buddy_get_presence(b)))
00064 
00065 typedef enum
00066 {
00067     PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 
00069 } PurpleBlistNodeFlags;
00070 
00071 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f))
00072 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
00073 
00074 #define PURPLE_BLIST_NODE_NAME(n) ((n)->type == PURPLE_BLIST_CHAT_NODE  ? purple_chat_get_name((PurpleChat*)n) :        \
00075                      (n)->type == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
00076 
00077 #include "account.h"
00078 #include "buddyicon.h"
00079 #include "status.h"
00080 
00081 /**************************************************************************/
00082 /* Data Structures                                                        */
00083 /**************************************************************************/
00084 
00089 struct _PurpleBlistNode {
00090     PurpleBlistNodeType type;             
00091     PurpleBlistNode *prev;                
00092     PurpleBlistNode *next;                
00093     PurpleBlistNode *parent;              
00094     PurpleBlistNode *child;               
00095     GHashTable *settings;               
00096     void          *ui_data;             
00097     PurpleBlistNodeFlags flags;           
00098 };
00099 
00103 struct _PurpleBuddy {
00104     PurpleBlistNode node;                     
00105     char *name;                             
00106     char *alias;                            
00107     char *server_alias;                     
00108     void *proto_data;                       
00109     PurpleBuddyIcon *icon;                    
00110     PurpleAccount *account;                 
00111     PurplePresence *presence;
00112 };
00113 
00117 struct _PurpleContact {
00118     PurpleBlistNode node;       
00119     char *alias;            
00120     int totalsize;          
00121     int currentsize;        
00122     int online;             
00123     PurpleBuddy *priority;    
00124     gboolean priority_valid; 
00125 };
00126 
00127 
00131 struct _PurpleGroup {
00132     PurpleBlistNode node;                    
00133     char *name;                            
00134     int totalsize;                 
00135     int currentsize;               
00136     int online;                
00137 };
00138 
00143 struct _PurpleChat {
00144     PurpleBlistNode node;      
00145     char *alias;             
00146     GHashTable *components;  
00147     PurpleAccount *account; 
00148 };
00149 
00150 
00154 struct _PurpleBuddyList {
00155     PurpleBlistNode *root;          
00156     GHashTable *buddies;          
00157     void *ui_data;                
00158 };
00159 
00166 struct _PurpleBlistUiOps
00167 {
00168     void (*new_list)(PurpleBuddyList *list); 
00169     void (*new_node)(PurpleBlistNode *node); 
00170     void (*show)(PurpleBuddyList *list);     
00171     void (*update)(PurpleBuddyList *list,
00172                PurpleBlistNode *node);       
00173     void (*remove)(PurpleBuddyList *list,
00174                PurpleBlistNode *node);       
00175     void (*destroy)(PurpleBuddyList *list);  
00176     void (*set_visible)(PurpleBuddyList *list,
00177                 gboolean show);            
00178     void (*request_add_buddy)(PurpleAccount *account, const char *username,
00179                               const char *group, const char *alias);
00180     void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
00181                              const char *alias, const char *name);
00182     void (*request_add_group)(void);
00183 
00184     void (*_purple_reserved1)(void);
00185     void (*_purple_reserved2)(void);
00186     void (*_purple_reserved3)(void);
00187     void (*_purple_reserved4)(void);
00188 };
00189 
00190 #ifdef __cplusplus
00191 extern "C" {
00192 #endif
00193 
00194 /**************************************************************************/
00196 /**************************************************************************/
00204 PurpleBuddyList *purple_blist_new(void);
00205 
00211 void purple_set_blist(PurpleBuddyList *blist);
00212 
00218 PurpleBuddyList *purple_get_blist(void);
00219 
00225 PurpleBlistNode *purple_blist_get_root(void);
00226 
00235 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
00236 
00240 void purple_blist_show(void);
00241 
00242 
00246 void purple_blist_destroy(void);
00247 
00253 void purple_blist_set_visible(gboolean show);
00254 
00261 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
00262 
00268 void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
00269 
00276 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
00277 
00284 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
00285 
00292 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
00293 
00301 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
00302 
00309 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
00310 
00317 void purple_blist_rename_group(PurpleGroup *group, const char *name);
00318 
00329 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
00330 
00342 void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
00343 
00352 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *screenname, const char *alias);
00353 
00365 void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
00366 
00374 PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
00375 
00383 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
00384 
00392 PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
00393 
00401 PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
00402 
00410 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
00411 
00424 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00425 
00435 PurpleGroup *purple_group_new(const char *name);
00436 
00446 void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
00447 
00453 PurpleContact *purple_contact_new(void);
00454 
00465 void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00466 
00475 void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
00476 
00483 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
00484 
00491 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
00492 
00499 const char *purple_contact_get_alias(PurpleContact *contact);
00500 
00509 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
00510 
00517 void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
00523 void purple_blist_remove_buddy(PurpleBuddy *buddy);
00524 
00531 void purple_blist_remove_contact(PurpleContact *contact);
00532 
00538 void purple_blist_remove_chat(PurpleChat *chat);
00539 
00546 void purple_blist_remove_group(PurpleGroup *group);
00547 
00555 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
00556 
00563 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
00564 
00574 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
00575 
00584 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
00585 
00594 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
00595 
00602 const char *purple_chat_get_name(PurpleChat *chat);
00603 
00611 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
00612 
00621 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
00622         PurpleGroup *group);
00623 
00632 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
00633 
00634 
00641 PurpleGroup *purple_find_group(const char *name);
00642 
00651 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
00652 
00660 PurpleGroup *purple_chat_get_group(PurpleChat *chat);
00661 
00668 PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
00669 
00670 
00678 GSList *purple_group_get_accounts(PurpleGroup *g);
00679 
00688 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
00689 
00697 const char *purple_group_get_name(PurpleGroup *group);
00698 
00705 void purple_blist_add_account(PurpleAccount *account);
00706 
00707 
00714 void purple_blist_remove_account(PurpleAccount *account);
00715 
00716 
00724 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
00725 
00732 int purple_blist_get_group_online_count(PurpleGroup *group);
00733 
00736 /****************************************************************************************/
00738 /****************************************************************************************/
00739 
00743 void purple_blist_load(void);
00744 
00752 void purple_blist_schedule_save(void);
00753 
00763 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
00764                                   const char *group, const char *alias);
00765 
00775 void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
00776                                  const char *alias, const char *name);
00777 
00782 void purple_blist_request_add_group(void);
00783 
00791 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
00792 
00801 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
00802 
00810 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
00811 
00820 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
00821 
00829 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
00830         const char *value);
00831 
00840 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
00841 
00848 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
00849 
00858 void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
00859 
00867 PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
00868 
00876 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
00877 
00886 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
00887 
00888 /**************************************************************************/
00890 /**************************************************************************/
00898 void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
00899 
00905 PurpleBlistUiOps *purple_blist_get_ui_ops(void);
00906 
00909 /**************************************************************************/
00911 /**************************************************************************/
00919 void *purple_blist_get_handle(void);
00920 
00924 void purple_blist_init(void);
00925 
00929 void purple_blist_uninit(void);
00930 
00933 #ifdef __cplusplus
00934 }
00935 #endif
00936 
00937 #endif /* _PURPLE_BLIST_H_ */