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 
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)    (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE)
00057 #define PURPLE_BLIST_NODE_IS_BUDDY(n)   (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE)
00058 #define PURPLE_BLIST_NODE_IS_CONTACT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE)
00059 #define PURPLE_BLIST_NODE_IS_GROUP(n)   (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE)
00060 
00061 #define PURPLE_BUDDY_IS_ONLINE(b) \
00062     ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
00063      purple_presence_is_online(purple_buddy_get_presence(b)))
00064 
00065 typedef enum
00066 {
00067     PURPLE_BLIST_NODE_FLAG_NO_SAVE      = 1 << 0, 
00069 } PurpleBlistNodeFlags;
00070 
00071 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (((PurpleBlistNode*)(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 
00239 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
00240 
00252 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
00253 
00265 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
00266 
00278 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
00279 
00291 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
00292 
00296 void purple_blist_show(void);
00297 
00298 
00302 void purple_blist_destroy(void);
00303 
00309 void purple_blist_set_visible(gboolean show);
00310 
00317 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
00318 
00324 void purple_blist_update_buddy_icon(PurpleBuddy *buddy);
00325 
00332 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
00333 
00340 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
00341 
00348 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
00349 
00357 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
00358 
00365 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
00366 
00373 void purple_blist_rename_group(PurpleGroup *group, const char *name);
00374 
00385 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
00386 
00398 void purple_blist_add_chat(PurpleChat *chat, PurpleGroup *group, PurpleBlistNode *node);
00399 
00408 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *screenname, const char *alias);
00409 
00421 void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
00422 
00430 PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
00431 
00439 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
00440 
00448 PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
00449 
00457 PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
00458 
00466 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
00467 
00481 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00482 
00492 PurpleGroup *purple_group_new(const char *name);
00493 
00503 void purple_blist_add_group(PurpleGroup *group, PurpleBlistNode *node);
00504 
00510 PurpleContact *purple_contact_new(void);
00511 
00522 void purple_blist_add_contact(PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
00523 
00532 void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
00533 
00540 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
00541 
00542 #ifndef PURPLE_DISABLE_DEPRECATED
00543 
00551 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
00552 #endif
00553 
00560 const char *purple_contact_get_alias(PurpleContact *contact);
00561 
00570 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
00571 
00578 void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
00579 
00587 void purple_blist_remove_buddy(PurpleBuddy *buddy);
00588 
00595 void purple_blist_remove_contact(PurpleContact *contact);
00596 
00602 void purple_blist_remove_chat(PurpleChat *chat);
00603 
00610 void purple_blist_remove_group(PurpleGroup *group);
00611 
00619 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
00620 
00627 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
00628 
00638 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
00639 
00648 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
00649 
00658 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
00659 
00666 const char *purple_chat_get_name(PurpleChat *chat);
00667 
00675 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
00676 
00685 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
00686         PurpleGroup *group);
00687 
00696 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
00697 
00698 
00705 PurpleGroup *purple_find_group(const char *name);
00706 
00715 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
00716 
00724 PurpleGroup *purple_chat_get_group(PurpleChat *chat);
00725 
00734 PurpleAccount *purple_chat_get_account(PurpleChat *chat);
00735 
00744 GHashTable *purple_chat_get_components(PurpleChat *chat);
00745 
00752 PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
00753 
00754 
00763 GSList *purple_group_get_accounts(PurpleGroup *g);
00764 
00773 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
00774 
00782 const char *purple_group_get_name(PurpleGroup *group);
00783 
00790 void purple_blist_add_account(PurpleAccount *account);
00791 
00792 
00799 void purple_blist_remove_account(PurpleAccount *account);
00800 
00801 
00809 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
00810 
00817 int purple_blist_get_group_online_count(PurpleGroup *group);
00818 
00821 /****************************************************************************************/
00823 /****************************************************************************************/
00824 
00828 void purple_blist_load(void);
00829 
00837 void purple_blist_schedule_save(void);
00838 
00848 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
00849                                   const char *group, const char *alias);
00850 
00860 void purple_blist_request_add_chat(PurpleAccount *account, PurpleGroup *group,
00861                                  const char *alias, const char *name);
00862 
00867 void purple_blist_request_add_group(void);
00868 
00876 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
00877 
00886 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
00887 
00895 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
00896 
00905 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
00906 
00914 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
00915         const char *value);
00916 
00925 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
00926 
00933 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
00934 
00943 void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
00944 
00952 PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
00953 
00962 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
00963 
00972 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
00973 
00974 /**************************************************************************/
00976 /**************************************************************************/
00984 void purple_blist_set_ui_ops(PurpleBlistUiOps *ops);
00985 
00991 PurpleBlistUiOps *purple_blist_get_ui_ops(void);
00992 
00995 /**************************************************************************/
00997 /**************************************************************************/
01005 void *purple_blist_get_handle(void);
01006 
01010 void purple_blist_init(void);
01011 
01015 void purple_blist_uninit(void);
01016 
01019 #ifdef __cplusplus
01020 }
01021 #endif
01022 
01023 #endif /* _PURPLE_BLIST_H_ */