blist.h

Go to the documentation of this file.
00001 
00007 /* purple
00008  *
00009  * Purple is the legal property of its developers, whose names are too numerous
00010  * to list here.  Please refer to the COPYRIGHT file distributed with this
00011  * source distribution.
00012  *
00013  * This program is free software; you can redistribute it and/or modify
00014  * it under the terms of the GNU General Public License as published by
00015  * the Free Software Foundation; either version 2 of the License, or
00016  * (at your option) any later version.
00017  *
00018  * This program is distributed in the hope that it will be useful,
00019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00021  * GNU General Public License for more details.
00022  *
00023  * You should have received a copy of the GNU General Public License
00024  * along with this program; if not, write to the Free Software
00025  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00026  */
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 
00035 typedef struct _PurpleBuddyList PurpleBuddyList;
00037 typedef struct _PurpleBlistUiOps PurpleBlistUiOps;
00039 typedef struct _PurpleBlistNode PurpleBlistNode;
00040 
00042 typedef struct _PurpleChat PurpleChat;
00044 typedef struct _PurpleGroup PurpleGroup;
00046 typedef struct _PurpleContact PurpleContact;
00048 typedef struct _PurpleBuddy PurpleBuddy;
00049 
00050 /**************************************************************************/
00051 /* Enumerations                                                           */
00052 /**************************************************************************/
00053 typedef enum
00054 {
00055     PURPLE_BLIST_GROUP_NODE,
00056     PURPLE_BLIST_CONTACT_NODE,
00057     PURPLE_BLIST_BUDDY_NODE,
00058     PURPLE_BLIST_CHAT_NODE,
00059     PURPLE_BLIST_OTHER_NODE
00060 
00061 } PurpleBlistNodeType;
00062 
00063 #define PURPLE_BLIST_NODE_IS_CHAT(n)    (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE)
00064 #define PURPLE_BLIST_NODE_IS_BUDDY(n)   (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE)
00065 #define PURPLE_BLIST_NODE_IS_CONTACT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE)
00066 #define PURPLE_BLIST_NODE_IS_GROUP(n)   (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE)
00067 
00068 #define PURPLE_BUDDY_IS_ONLINE(b) \
00069     ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
00070      purple_presence_is_online(purple_buddy_get_presence(b)))
00071 
00072 typedef enum
00073 {
00074     PURPLE_BLIST_NODE_FLAG_NO_SAVE      = 1 << 0 
00076 } PurpleBlistNodeFlags;
00077 
00078 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f))
00079 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
00080 
00081 #define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE  ? purple_chat_get_name((PurpleChat*)n) :        \
00082                      purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
00083 
00084 #include "account.h"
00085 #include "buddyicon.h"
00086 #include "status.h"
00087 
00088 /**************************************************************************/
00089 /* Data Structures                                                        */
00090 /**************************************************************************/
00091 
00092 #if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_BLIST_C_)
00093 
00098 struct _PurpleBlistNode {
00099     PurpleBlistNodeType type;             
00100     PurpleBlistNode *prev;                
00101     PurpleBlistNode *next;                
00102     PurpleBlistNode *parent;              
00103     PurpleBlistNode *child;               
00104     GHashTable *settings;               
00105     void          *ui_data;             
00106     PurpleBlistNodeFlags flags;           
00107 };
00108 
00112 struct _PurpleBuddy {
00113     PurpleBlistNode node;                     
00114     char *name;                             
00115     char *alias;                            
00116     char *server_alias;                     
00117     void *proto_data;                       
00118     PurpleBuddyIcon *icon;                    
00119     PurpleAccount *account;                 
00120     PurplePresence *presence;
00121 };
00122 
00126 struct _PurpleContact {
00127     PurpleBlistNode node;       
00128     char *alias;            
00129     int totalsize;          
00130     int currentsize;        
00131     int online;             
00132     PurpleBuddy *priority;    
00133     gboolean priority_valid; 
00134 };
00135 
00136 
00140 struct _PurpleGroup {
00141     PurpleBlistNode node;                    
00142     char *name;                            
00143     int totalsize;                 
00144     int currentsize;               
00145     int online;                
00146 };
00147 
00152 struct _PurpleChat {
00153     PurpleBlistNode node;      
00154     char *alias;             
00155     GHashTable *components;  
00156     PurpleAccount *account; 
00157 };
00158 
00159 #endif /* PURPLE_HIDE_STRUCTS && PURPLE_BLIST_STRUCTS */
00160 
00161 
00165 struct _PurpleBuddyList {
00166     PurpleBlistNode *root;          
00167     GHashTable *buddies;          
00168     void *ui_data;                
00169 };
00170 
00177 struct _PurpleBlistUiOps
00178 {
00179     void (*new_list)(PurpleBuddyList *list); 
00180     void (*new_node)(PurpleBlistNode *node); 
00181     void (*show)(PurpleBuddyList *list);     
00182     void (*update)(PurpleBuddyList *list,
00183                PurpleBlistNode *node);       
00184     void (*remove)(PurpleBuddyList *list,
00185                PurpleBlistNode *node);       
00186     void (*destroy)(PurpleBuddyList *list);  
00187     void (*set_visible)(PurpleBuddyList *list,
00188                 gboolean show);            
00189     void (*request_add_buddy)(PurpleAccount *account, const char *username,
00190                               const char *group, const char *alias);
00191     void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
00192                              const char *alias, const char *name);
00193     void (*request_add_group)(void);
00194 
00195     void (*_purple_reserved1)(void);
00196     void (*_purple_reserved2)(void);
00197     void (*_purple_reserved3)(void);
00198     void (*_purple_reserved4)(void);
00199 };
00200 
00201 #ifdef __cplusplus
00202 extern "C" {
00203 #endif
00204 
00205 /**************************************************************************/
00207 /**************************************************************************/
00215 PurpleBuddyList *purple_blist_new(void);
00216 
00222 void purple_set_blist(PurpleBuddyList *blist);
00223 
00229 PurpleBuddyList *purple_get_blist(void);
00230 
00236 PurpleBlistNode *purple_blist_get_root(void);
00237 
00250 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
00251 
00263 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
00264 
00276 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
00277 
00289 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
00290 
00302 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
00303 
00307 void purple_blist_show(void);
00308 
00309 
00313 void purple_blist_destroy(void);
00314 
00320 void purple_blist_set_visible(gboolean show);
00321 
00328 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
00329 
00336 void purple_blist_update_node_icon(PurpleBlistNode *node);
00337 
00338 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
00339 
00345 void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
00346 #endif
00347 
00354 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
00355 
00362 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
00363 
00370 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
00371 
00379 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
00380 
00387 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
00388 
00395 void purple_blist_rename_group(PurpleGroup *group, const char *name);
00396 
00407 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
00408 
00420 void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
00421 
00430 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *screenname, const char *alias);
00431 
00443 void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
00444 
00452 PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
00453 
00461 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
00462 
00470 PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
00471 
00479 PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
00480 
00488 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
00489 
00503 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00504 
00514 PurpleGroup *purple_group_new(const char *name);
00515 
00525 void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
00526 
00532 PurpleContact *purple_contact_new(void);
00533 
00544 void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00545 
00554 void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
00555 
00562 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
00563 
00564 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
00565 
00573 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
00574 #endif
00575 
00582 const char *purple_contact_get_alias(PurpleContact *contact);
00583 
00592 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
00593 
00600 void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
00601 
00609 void purple_blist_remove_buddy(PurpleBuddy *buddy);
00610 
00617 void purple_blist_remove_contact(PurpleContact *contact);
00618 
00624 void purple_blist_remove_chat(PurpleChat *chat);
00625 
00632 void purple_blist_remove_group(PurpleGroup *group);
00633 
00641 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
00642 
00649 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
00650 
00660 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
00661 
00670 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
00671 
00680 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
00681 
00688 const char *purple_chat_get_name(PurpleChat *chat);
00689 
00697 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
00698 
00707 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
00708         PurpleGroup *group);
00709 
00718 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
00719 
00720 
00727 PurpleGroup *purple_find_group(const char *name);
00728 
00737 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
00738 
00746 PurpleGroup *purple_chat_get_group(PurpleChat *chat);
00747 
00756 PurpleAccount *purple_chat_get_account(PurpleChat *chat);
00757 
00766 GHashTable *purple_chat_get_components(PurpleChat *chat);
00767 
00774 PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
00775 
00776 
00785 GSList *purple_group_get_accounts(PurpleGroup *g);
00786 
00795 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
00796 
00804 const char *purple_group_get_name(PurpleGroup *group);
00805 
00812 void purple_blist_add_account(PurpleAccount *account);
00813 
00814 
00821 void purple_blist_remove_account(PurpleAccount *account);
00822 
00823 
00831 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
00832 
00839 int purple_blist_get_group_online_count(PurpleGroup *group);
00840 
00843 /****************************************************************************************/
00845 /****************************************************************************************/
00846 
00850 void purple_blist_load(void);
00851 
00859 void purple_blist_schedule_save(void);
00860 
00870 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
00871                                   const char *group, const char *alias);
00872 
00882 void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
00883                                  const char *alias, const char *name);
00884 
00889 void purple_blist_request_add_group(void);
00890 
00898 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
00899 
00908 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
00909 
00917 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
00918 
00927 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
00928 
00936 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
00937         const char *value);
00938 
00947 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
00948 
00955 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
00956 
00965 void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
00966 
00974 PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
00975 
00984 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
00985 
00994 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
00995 
00996 /**************************************************************************/
00998 /**************************************************************************/
01006 void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
01007 
01013 PurpleBlistUiOps *purple_blist_get_ui_ops(void);
01014 
01017 /**************************************************************************/
01019 /**************************************************************************/
01027 void *purple_blist_get_handle(void);
01028 
01032 void purple_blist_init(void);
01033 
01037 void purple_blist_uninit(void);
01038 
01041 #ifdef __cplusplus
01042 }
01043 #endif
01044 
01045 #endif /* _PURPLE_BLIST_H_ */