blist.h
Go to the documentation of this file.
1 
7 /* purple
8  *
9  * Purple is the legal property of its developers, whose names are too numerous
10  * to list here. Please refer to the COPYRIGHT file distributed with this
11  * source distribution.
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
26  */
27 #ifndef _PURPLE_BLIST_H_
28 #define _PURPLE_BLIST_H_
29 
30 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */
31 
32 #include <glib.h>
33 
40 
42 typedef struct _PurpleChat PurpleChat;
44 typedef struct _PurpleGroup PurpleGroup;
48 typedef struct _PurpleBuddy PurpleBuddy;
49 
50 /**************************************************************************/
51 /* Enumerations */
52 /**************************************************************************/
53 typedef enum
54 {
55  PURPLE_BLIST_GROUP_NODE,
56  PURPLE_BLIST_CONTACT_NODE,
57  PURPLE_BLIST_BUDDY_NODE,
58  PURPLE_BLIST_CHAT_NODE,
59  PURPLE_BLIST_OTHER_NODE
60 
61 } PurpleBlistNodeType;
62 
63 #define PURPLE_BLIST_NODE_IS_CHAT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE)
64 #define PURPLE_BLIST_NODE_IS_BUDDY(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE)
65 #define PURPLE_BLIST_NODE_IS_CONTACT(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CONTACT_NODE)
66 #define PURPLE_BLIST_NODE_IS_GROUP(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_GROUP_NODE)
67 
68 #define PURPLE_BUDDY_IS_ONLINE(b) \
69  ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
70  purple_presence_is_online(purple_buddy_get_presence(b)))
71 
72 typedef enum
73 {
77 
81 #define PURPLE_BLIST_NODE(obj) ((PurpleBlistNode *)(obj))
82 
83 #define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f))
84 #define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
85 
86 #define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \
87  purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)
88 
92 #define PURPLE_GROUP(obj) ((PurpleGroup *)(obj))
93 
97 #define PURPLE_CONTACT(obj) ((PurpleContact *)(obj))
98 
102 #define PURPLE_BUDDY(obj) ((PurpleBuddy *)(obj))
103 
107 #define PURPLE_CHAT(obj) ((PurpleChat *)(obj))
108 
109 #include "account.h"
110 #include "buddyicon.h"
111 #include "media.h"
112 #include "status.h"
113 
114 /**************************************************************************/
115 /* Data Structures */
116 /**************************************************************************/
117 
118 #if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_BLIST_C_)
119 
125  PurpleBlistNodeType type;
130  GHashTable *settings;
131  void *ui_data;
133 };
134 
138 struct _PurpleBuddy {
140  char *name;
141  char *alias;
142  char *server_alias;
143  void *proto_data;
146  PurplePresence *presence;
147  PurpleMediaCaps media_caps;
148 };
149 
155  char *alias;
156  int totalsize;
158  int online;
160  gboolean priority_valid;
161 };
162 
163 
167 struct _PurpleGroup {
169  char *name;
170  int totalsize;
172  int online;
173 };
174 
179 struct _PurpleChat {
181  char *alias;
182  GHashTable *components;
184 };
185 
191  GHashTable *buddies;
192  void *ui_data;
193 };
194 
195 #endif /* PURPLE_HIDE_STRUCTS && PURPLE_BLIST_STRUCTS */
196 
204 {
205  void (*new_list)(PurpleBuddyList *list);
206  void (*new_node)(PurpleBlistNode *node);
207  void (*show)(PurpleBuddyList *list);
208  void (*update)(PurpleBuddyList *list,
209  PurpleBlistNode *node);
210  void (*remove)(PurpleBuddyList *list,
211  PurpleBlistNode *node);
212  void (*destroy)(PurpleBuddyList *list);
214  gboolean show);
215  void (*request_add_buddy)(PurpleAccount *account, const char *username,
216  const char *group, const char *alias);
217  void (*request_add_chat)(PurpleAccount *account, PurpleGroup *group,
218  const char *alias, const char *name);
219  void (*request_add_group)(void);
220 
232  void (*save_node)(PurpleBlistNode *node);
233 
246  void (*remove_node)(PurpleBlistNode *node);
247 
261  void (*save_account)(PurpleAccount *account);
262 
263  void (*_purple_reserved1)(void);
264 };
265 
266 #ifdef __cplusplus
267 extern "C" {
268 #endif
269 
270 /**************************************************************************/
272 /**************************************************************************/
282 
289 void purple_set_blist(PurpleBuddyList *blist);
290 
297 
304 
316 GSList *purple_blist_get_buddies(void);
317 
325 gpointer purple_blist_get_ui_data(void);
326 
334 void purple_blist_set_ui_data(gpointer ui_data);
335 
348 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
349 
362 
375 
388 
401 
409 gpointer purple_blist_node_get_ui_data(const PurpleBlistNode *node);
410 
419 void purple_blist_node_set_ui_data(PurpleBlistNode *node, gpointer ui_data);
420 
424 void purple_blist_show(void);
425 
426 
434 void purple_blist_destroy(void);
435 
441 void purple_blist_set_visible(gboolean show);
442 
451 void purple_blist_update_buddy_status(PurpleBuddy *buddy, PurpleStatus *old_status);
452 
461 
462 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
463 
470 #endif
471 
478 void purple_blist_rename_buddy(PurpleBuddy *buddy, const char *name);
479 
486 void purple_blist_alias_contact(PurpleContact *contact, const char *alias);
487 
494 void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
495 
503 void purple_blist_server_alias_buddy(PurpleBuddy *buddy, const char *alias);
504 
511 void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
512 
519 void purple_blist_rename_group(PurpleGroup *group, const char *name);
520 
531 PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
532 
538 void purple_chat_destroy(PurpleChat *chat);
539 
552 
568 PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *name, const char *alias);
569 
575 void purple_buddy_destroy(PurpleBuddy *buddy);
576 
589 
598 
606 const char *purple_buddy_get_name(const PurpleBuddy *buddy);
607 
616 
628 gpointer purple_buddy_get_protocol_data(const PurpleBuddy *buddy);
629 
641 void purple_buddy_set_protocol_data(PurpleBuddy *buddy, gpointer data);
642 
651 
659 PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
660 
669 PurpleMediaCaps purple_buddy_get_media_caps(const PurpleBuddy *buddy);
670 
677 void purple_buddy_set_media_caps(PurpleBuddy *buddy, PurpleMediaCaps media_caps);
678 
692 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
693 
703 PurpleGroup *purple_group_new(const char *name);
704 
710 void purple_group_destroy(PurpleGroup *group);
711 
722 
729 
736 
746 
758 
768 
776 
777 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
778 
786 void purple_contact_set_alias(PurpleContact *contact, const char *alias);
787 #endif
788 
795 const char *purple_contact_get_alias(PurpleContact *contact);
796 
805 gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
806 
814 
824 
835 
842 
850 
858 const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
859 
866 const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
867 
877 const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
878 
879 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BLIST_C_)
880 
889 const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
890 #endif
891 
900 const char *purple_buddy_get_alias(PurpleBuddy *buddy);
901 
911 
918 const char *purple_chat_get_name(PurpleChat *chat);
919 
927 PurpleBuddy *purple_find_buddy(PurpleAccount *account, const char *name);
928 
937 PurpleBuddy *purple_find_buddy_in_group(PurpleAccount *account, const char *name,
938  PurpleGroup *group);
939 
948 GSList *purple_find_buddies(PurpleAccount *account, const char *name);
949 
950 
957 PurpleGroup *purple_find_group(const char *name);
958 
967 PurpleChat *purple_blist_find_chat(PurpleAccount *account, const char *name);
968 
977 
988 
998 GHashTable *purple_chat_get_components(PurpleChat *chat);
999 
1007 
1008 
1018 
1027 gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
1028 
1036 const char *purple_group_get_name(PurpleGroup *group);
1037 
1045 
1046 
1054 
1055 
1063 int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
1064 
1072 
1075 /****************************************************************************************/
1077 /****************************************************************************************/
1078 
1082 void purple_blist_load(void);
1083 
1091 void purple_blist_schedule_save(void);
1092 
1102 void purple_blist_request_add_buddy(PurpleAccount *account, const char *username,
1103  const char *group, const char *alias);
1104 
1115  const char *alias, const char *name);
1116 
1122 
1130 void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
1131 
1140 gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
1141 
1149 void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
1150 
1159 int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
1160 
1168 void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
1169  const char *value);
1170 
1179 const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
1180 
1187 void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
1188 
1198 
1207 
1217 PurpleBlistNodeType purple_blist_node_get_type(PurpleBlistNode *node);
1218 
1228 
1229 /**************************************************************************/
1231 /**************************************************************************/
1240 
1247 
1250 /**************************************************************************/
1252 /**************************************************************************/
1260 void *purple_blist_get_handle(void);
1261 
1265 void purple_blist_init(void);
1266 
1270 void purple_blist_uninit(void);
1271 
1274 #ifdef __cplusplus
1275 }
1276 #endif
1277 
1278 #endif /* _PURPLE_BLIST_H_ */