Mercurial > pidgin.yaz
annotate libgaim/blist.h @ 14752:4124030c3f3a
[gaim-migrate @ 17509]
Fix the situation (I think it will only happen while shutting down) where GaimBuddy->proto_data could be accessed after it is freed.
Specifically, it happened when gtkblist was requesting the emblems from the msn prpl.
Big thanks to henningn for noticing the funkiness in valgrind.
I discovered that there is no function to retrieve all the buddies for an account (shock, horror) - so I modified gaim_find_buddies() to return all the account buddies if "name" is NULL.
committer: Tailor Script <tailor@pidgin.im>
author | Daniel Atallah <daniel.atallah@gmail.com> |
---|---|
date | Wed, 18 Oct 2006 03:32:14 +0000 |
parents | 8a1c6ed3dde6 |
children | 66c857a355b4 |
rev | line source |
---|---|
14192 | 1 /** |
2 * @file blist.h Buddy List API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GAIM_BLIST_H_ | |
26 #define _GAIM_BLIST_H_ | |
27 | |
28 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ | |
29 | |
30 #include <glib.h> | |
31 | |
32 typedef struct _GaimBuddyList GaimBuddyList; | |
33 typedef struct _GaimBlistUiOps GaimBlistUiOps; | |
34 typedef struct _GaimBlistNode GaimBlistNode; | |
35 | |
36 typedef struct _GaimChat GaimChat; | |
37 typedef struct _GaimGroup GaimGroup; | |
38 typedef struct _GaimContact GaimContact; | |
39 typedef struct _GaimBuddy GaimBuddy; | |
40 | |
41 /**************************************************************************/ | |
42 /* Enumerations */ | |
43 /**************************************************************************/ | |
44 typedef enum | |
45 { | |
46 GAIM_BLIST_GROUP_NODE, | |
47 GAIM_BLIST_CONTACT_NODE, | |
48 GAIM_BLIST_BUDDY_NODE, | |
49 GAIM_BLIST_CHAT_NODE, | |
50 GAIM_BLIST_OTHER_NODE | |
51 | |
52 } GaimBlistNodeType; | |
53 | |
54 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) | |
55 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) | |
56 #define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE) | |
57 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) | |
58 | |
59 #define GAIM_BUDDY_IS_ONLINE(b) \ | |
60 ((b) != NULL && gaim_account_is_connected((b)->account) && \ | |
61 gaim_presence_is_online(gaim_buddy_get_presence(b))) | |
62 | |
63 typedef enum | |
64 { | |
65 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */ | |
66 | |
67 } GaimBlistNodeFlags; | |
68 | |
69 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) | |
70 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) | |
71 | |
72 #define GAIM_BLIST_NODE_NAME(n) ((n)->type == GAIM_BLIST_CHAT_NODE ? gaim_chat_get_name((GaimChat*)n) : \ | |
73 (n)->type == GAIM_BLIST_BUDDY_NODE ? gaim_buddy_get_name((GaimBuddy*)n) : NULL) | |
74 | |
75 #include "account.h" | |
76 #include "buddyicon.h" | |
77 #include "status.h" | |
78 | |
79 /**************************************************************************/ | |
80 /* Data Structures */ | |
81 /**************************************************************************/ | |
82 | |
83 /** | |
84 * A Buddy list node. This can represent a group, a buddy, or anything else. | |
85 * This is a base class for struct buddy and struct group and for anything | |
86 * else that wants to put itself in the buddy list. */ | |
87 struct _GaimBlistNode { | |
88 GaimBlistNodeType type; /**< The type of node this is */ | |
89 GaimBlistNode *prev; /**< The sibling before this buddy. */ | |
90 GaimBlistNode *next; /**< The sibling after this buddy. */ | |
91 GaimBlistNode *parent; /**< The parent of this node */ | |
92 GaimBlistNode *child; /**< The child of this node */ | |
93 GHashTable *settings; /**< per-node settings */ | |
94 void *ui_data; /**< The UI can put data here. */ | |
95 GaimBlistNodeFlags flags; /**< The buddy flags */ | |
96 }; | |
97 | |
98 /** | |
99 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
100 */ | |
101 struct _GaimBuddy { | |
102 GaimBlistNode node; /**< The node that this buddy inherits from */ | |
103 char *name; /**< The screenname of the buddy. */ | |
104 char *alias; /**< The user-set alias of the buddy */ | |
105 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ | |
106 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ | |
107 GaimBuddyIcon *icon; /**< The buddy icon. */ | |
108 GaimAccount *account; /**< the account this buddy belongs to */ | |
109 GaimPresence *presence; | |
110 }; | |
111 | |
112 /** | |
113 * A contact. This contains everything Gaim will ever need to know about a contact. | |
114 */ | |
115 struct _GaimContact { | |
116 GaimBlistNode node; /**< The node that this contact inherits from. */ | |
117 char *alias; /**< The user-set alias of the contact */ | |
118 int totalsize; /**< The number of buddies in this contact */ | |
119 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ | |
120 int online; /**< The number of buddies in this contact who are currently online */ | |
121 GaimBuddy *priority; /**< The "top" buddy for this contact */ | |
122 gboolean priority_valid; /**< Is priority valid? */ | |
123 }; | |
124 | |
125 | |
126 /** | |
127 * A group. This contains everything Gaim will ever need to know about a group. | |
128 */ | |
129 struct _GaimGroup { | |
130 GaimBlistNode node; /**< The node that this group inherits from */ | |
131 char *name; /**< The name of this group. */ | |
132 int totalsize; /**< The number of chats and contacts in this group */ | |
133 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ | |
134 int online; /**< The number of chats and contacts in this group who are currently online */ | |
135 }; | |
136 | |
137 /** | |
138 * A chat. This contains everything Gaim needs to put a chat room in the | |
139 * buddy list. | |
140 */ | |
141 struct _GaimChat { | |
142 GaimBlistNode node; /**< The node that this chat inherits from */ | |
143 char *alias; /**< The display name of this chat. */ | |
144 GHashTable *components; /**< the stuff the protocol needs to know to join the chat */ | |
145 GaimAccount *account; /**< The account this chat is attached to */ | |
146 }; | |
147 | |
148 | |
149 /** | |
150 * The Buddy List | |
151 */ | |
152 struct _GaimBuddyList { | |
153 GaimBlistNode *root; /**< The first node in the buddy list */ | |
154 GHashTable *buddies; /**< Every buddy in this list */ | |
155 void *ui_data; /**< UI-specific data. */ | |
156 }; | |
157 | |
158 /** | |
159 * Buddy list UI operations. | |
160 * | |
161 * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps | |
162 * structure to the buddy list core. | |
163 */ | |
164 struct _GaimBlistUiOps | |
165 { | |
166 void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */ | |
167 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ | |
168 void (*show)(GaimBuddyList *list); /**< The core will call this when it's finished doing its core stuff */ | |
169 void (*update)(GaimBuddyList *list, | |
170 GaimBlistNode *node); /**< This will update a node in the buddy list. */ | |
171 void (*remove)(GaimBuddyList *list, | |
172 GaimBlistNode *node); /**< This removes a node from the list */ | |
173 void (*destroy)(GaimBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ | |
174 void (*set_visible)(GaimBuddyList *list, | |
175 gboolean show); /**< Hides or unhides the buddy list */ | |
176 void (*request_add_buddy)(GaimAccount *account, const char *username, | |
177 const char *group, const char *alias); | |
178 void (*request_add_chat)(GaimAccount *account, GaimGroup *group, | |
179 const char *alias, const char *name); | |
180 void (*request_add_group)(void); | |
181 }; | |
182 | |
183 #ifdef __cplusplus | |
184 extern "C" { | |
185 #endif | |
186 | |
187 /**************************************************************************/ | |
188 /** @name Buddy List API */ | |
189 /**************************************************************************/ | |
190 /*@{*/ | |
191 | |
192 /** | |
193 * Creates a new buddy list | |
194 * | |
195 * @return The new buddy list. | |
196 */ | |
197 GaimBuddyList *gaim_blist_new(void); | |
198 | |
199 /** | |
200 * Sets the main buddy list. | |
201 * | |
202 * @param blist The buddy list you want to use. | |
203 */ | |
204 void gaim_set_blist(GaimBuddyList *blist); | |
205 | |
206 /** | |
207 * Returns the main buddy list. | |
208 * | |
209 * @return The main buddy list. | |
210 */ | |
211 GaimBuddyList *gaim_get_blist(void); | |
212 | |
213 /** | |
214 * Returns the root node of the main buddy list. | |
215 * | |
216 * @return The root node. | |
217 */ | |
218 GaimBlistNode *gaim_blist_get_root(void); | |
219 | |
220 /** | |
221 * Returns the next node of a given node. This function is to be used to iterate | |
222 * over the tree returned by gaim_get_blist. | |
223 * | |
224 * @param node A node. | |
225 * @param offline Whether to include nodes for offline accounts | |
226 * @return The next node | |
227 */ | |
228 GaimBlistNode *gaim_blist_node_next(GaimBlistNode *node, gboolean offline); | |
229 | |
230 /** | |
231 * Shows the buddy list, creating a new one if necessary. | |
232 */ | |
233 void gaim_blist_show(void); | |
234 | |
235 | |
236 /** | |
237 * Destroys the buddy list window. | |
238 */ | |
239 void gaim_blist_destroy(void); | |
240 | |
241 /** | |
242 * Hides or unhides the buddy list. | |
243 * | |
244 * @param show Whether or not to show the buddy list | |
245 */ | |
246 void gaim_blist_set_visible(gboolean show); | |
247 | |
248 /** | |
249 * Updates a buddy's status. | |
250 * | |
251 * @param buddy The buddy whose status has changed. | |
252 * @param old_status The status from which we are changing. | |
253 */ | |
254 void gaim_blist_update_buddy_status(GaimBuddy *buddy, GaimStatus *old_status); | |
255 | |
256 /** | |
257 * Updates a buddy's icon. | |
258 * | |
259 * @param buddy The buddy whose buddy icon has changed | |
260 */ | |
261 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); | |
262 | |
263 /** | |
264 * Renames a buddy in the buddy list. | |
265 * | |
266 * @param buddy The buddy whose name will be changed. | |
267 * @param name The new name of the buddy. | |
268 */ | |
269 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); | |
270 | |
271 /** | |
272 * Aliases a contact in the buddy list. | |
273 * | |
274 * @param contact The contact whose alias will be changed. | |
275 * @param alias The contact's alias. | |
276 */ | |
277 void gaim_blist_alias_contact(GaimContact *contact, const char *alias); | |
278 | |
279 /** | |
280 * Aliases a buddy in the buddy list. | |
281 * | |
282 * @param buddy The buddy whose alias will be changed. | |
283 * @param alias The buddy's alias. | |
284 */ | |
285 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); | |
286 | |
287 /** | |
288 * Sets the server-sent alias of a buddy in the buddy list. | |
289 * PRPLs should call serv_got_alias() instead of this. | |
290 * | |
291 * @param buddy The buddy whose alias will be changed. | |
292 * @param alias The buddy's "official" alias. | |
293 */ | |
294 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); | |
295 | |
296 /** | |
297 * Aliases a chat in the buddy list. | |
298 * | |
299 * @param chat The chat whose alias will be changed. | |
300 * @param alias The chat's new alias. | |
301 */ | |
302 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); | |
303 | |
304 /** | |
305 * Renames a group | |
306 * | |
307 * @param group The group to rename | |
308 * @param name The new name | |
309 */ | |
310 void gaim_blist_rename_group(GaimGroup *group, const char *name); | |
311 | |
312 /** | |
313 * Creates a new chat for the buddy list | |
314 * | |
315 * @param account The account this chat will get added to | |
316 * @param alias The alias of the new chat | |
317 * @param components The info the prpl needs to join the chat | |
318 * @return A newly allocated chat | |
319 */ | |
320 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); | |
321 | |
322 /** | |
323 * Adds a new chat to the buddy list. | |
324 * | |
325 * The chat will be inserted right after node or appended to the end | |
326 * of group if node is NULL. If both are NULL, the buddy will be added to | |
327 * the "Chats" group. | |
328 * | |
329 * @param chat The new chat who gets added | |
330 * @param group The group to add the new chat to. | |
331 * @param node The insertion point | |
332 */ | |
333 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); | |
334 | |
335 /** | |
336 * Creates a new buddy | |
337 * | |
338 * @param account The account this buddy will get added to | |
339 * @param screenname The screenname of the new buddy | |
340 * @param alias The alias of the new buddy (or NULL if unaliased) | |
341 * @return A newly allocated buddy | |
342 */ | |
343 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); | |
344 | |
345 /** | |
346 * Sets a buddy's icon. | |
347 * | |
348 * This should only be called from within Gaim. You probably want to | |
349 * call gaim_buddy_icon_set_data(). | |
350 * | |
351 * @param buddy The buddy. | |
352 * @param icon The buddy icon. | |
353 * | |
354 * @see gaim_buddy_icon_set_data() | |
355 */ | |
356 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon); | |
357 | |
358 /** | |
359 * Returns a buddy's account. | |
360 * | |
361 * @param buddy The buddy. | |
362 * | |
363 * @return The account | |
364 */ | |
365 GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy); | |
366 | |
367 /** | |
368 * Returns a buddy's name | |
369 * | |
370 * @param buddy The buddy. | |
371 * | |
372 * @return The name. | |
373 */ | |
374 const char *gaim_buddy_get_name(const GaimBuddy *buddy); | |
375 | |
376 /** | |
377 * Returns a buddy's icon. | |
378 * | |
379 * @param buddy The buddy. | |
380 * | |
381 * @return The buddy icon. | |
382 */ | |
383 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); | |
384 | |
385 /** | |
386 * Returns a buddy's contact. | |
387 * | |
388 * @param buddy The buddy. | |
389 * | |
390 * @return The buddy's contact. | |
391 */ | |
392 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
393 | |
394 /** | |
395 * Returns a buddy's presence. | |
396 * | |
397 * @param buddy The buddy. | |
398 * | |
399 * @return The buddy's presence. | |
400 */ | |
401 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); | |
402 | |
403 /** | |
404 * Adds a new buddy to the buddy list. | |
405 * | |
406 * The buddy will be inserted right after node or prepended to the | |
407 * group if node is NULL. If both are NULL, the buddy will be added to | |
408 * the "Buddies" group. | |
409 * | |
410 * @param buddy The new buddy who gets added | |
411 * @param contact The optional contact to place the buddy in. | |
412 * @param group The group to add the new buddy to. | |
413 * @param node The insertion point | |
414 */ | |
415 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
416 | |
417 /** | |
418 * Creates a new group | |
419 * | |
420 * You can't have more than one group with the same name. Sorry. If you pass | |
421 * this the * name of a group that already exists, it will return that group. | |
422 * | |
423 * @param name The name of the new group | |
424 * @return A new group struct | |
425 */ | |
426 GaimGroup *gaim_group_new(const char *name); | |
427 | |
428 /** | |
429 * Adds a new group to the buddy list. | |
430 * | |
431 * The new group will be inserted after insert or prepended to the list if | |
432 * node is NULL. | |
433 * | |
434 * @param group The group | |
435 * @param node The insertion point | |
436 */ | |
437 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
438 | |
439 /** | |
440 * Creates a new contact | |
441 * | |
442 * @return A new contact struct | |
443 */ | |
444 GaimContact *gaim_contact_new(void); | |
445 | |
446 /** | |
447 * Adds a new contact to the buddy list. | |
448 * | |
449 * The new contact will be inserted after insert or prepended to the list if | |
450 * node is NULL. | |
451 * | |
452 * @param contact The contact | |
453 * @param group The group to add the contact to | |
454 * @param node The insertion point | |
455 */ | |
456 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
457 | |
458 /** | |
459 * Merges two contacts | |
460 * | |
461 * All of the buddies from source will be moved to target | |
462 * | |
463 * @param source The contact to merge | |
464 * @param node The place to merge to (a buddy or contact) | |
465 */ | |
466 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); | |
467 | |
468 /** | |
469 * Returns the highest priority buddy for a given contact. | |
470 * | |
471 * @param contact The contact | |
472 * @return The highest priority buddy | |
473 */ | |
474 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
475 | |
476 /** | |
477 * Sets the alias for a contact. | |
478 * | |
479 * @param contact The contact | |
480 * @param alias The alias to set, or NULL to unset | |
481 */ | |
482 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
483 | |
484 /** | |
485 * Gets the alias for a contact. | |
486 * | |
487 * @param contact The contact | |
488 * @return The alias, or NULL if it is not set. | |
489 */ | |
490 const char *gaim_contact_get_alias(GaimContact *contact); | |
491 | |
492 /** | |
493 * Determines whether an account owns any buddies in a given contact | |
494 * | |
495 * @param contact The contact to search through. | |
496 * @param account The account. | |
497 * | |
498 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
499 */ | |
500 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
501 | |
502 /** | |
503 * Invalidates the priority buddy so that the next call to | |
504 * gaim_contact_get_priority_buddy recomputes it. | |
505 * | |
506 * @param contact The contact | |
507 */ | |
508 void gaim_contact_invalidate_priority_buddy(GaimContact *contact); | |
509 /** | |
510 * Removes a buddy from the buddy list and frees the memory allocated to it. | |
511 * | |
512 * @param buddy The buddy to be removed | |
513 */ | |
514 void gaim_blist_remove_buddy(GaimBuddy *buddy); | |
515 | |
516 /** | |
517 * Removes a contact, and any buddies it contains, and frees the memory | |
518 * allocated to it. | |
519 * | |
520 * @param contact The contact to be removed | |
521 */ | |
522 void gaim_blist_remove_contact(GaimContact *contact); | |
523 | |
524 /** | |
525 * Removes a chat from the buddy list and frees the memory allocated to it. | |
526 * | |
527 * @param chat The chat to be removed | |
528 */ | |
529 void gaim_blist_remove_chat(GaimChat *chat); | |
530 | |
531 /** | |
532 * Removes a group from the buddy list and frees the memory allocated to it and to | |
533 * its children | |
534 * | |
535 * @param group The group to be removed | |
536 */ | |
537 void gaim_blist_remove_group(GaimGroup *group); | |
538 | |
539 /** | |
540 * Returns the alias of a buddy. | |
541 * | |
542 * @param buddy The buddy whose name will be returned. | |
543 * @return The alias (if set), server alias (if set), | |
544 * or NULL. | |
545 */ | |
546 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); | |
547 | |
14491
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
548 /** |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
549 * Gets the server alias for a buddy. |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
550 * |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
551 * @param buddy The buddy whose name will be returned |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
552 * @return The server alias, or NULL if it is not set. |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
553 */ |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
554 const char *gaim_buddy_get_server_alias(GaimBuddy *buddy); |
14192 | 555 |
556 /** | |
557 * Returns the correct name to display for a buddy, taking the contact alias | |
558 * into account. In order of precedence: the buddy's alias; the buddy's | |
559 * contact alias; the buddy's server alias; the buddy's user name. | |
560 * | |
561 * @param buddy The buddy whose name will be returned | |
562 * @return The appropriate name or alias, or NULL. | |
563 * | |
564 */ | |
565 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); | |
566 | |
567 /** | |
568 * Returns the correct alias for this user, ignoring server aliases. Used | |
569 * when a user-recognizable name is required. In order: buddy's alias; buddy's | |
570 * contact alias; buddy's user name. | |
571 * | |
572 * @param buddy The buddy whose alias will be returned. | |
573 * @return The appropriate name or alias. | |
574 */ | |
575 const char *gaim_buddy_get_local_alias(GaimBuddy *buddy); | |
576 | |
577 /** | |
578 * Returns the correct name to display for a buddy. In order of precedence: | |
579 * the buddy's alias; the buddy's server alias; the buddy's contact alias; | |
580 * the buddy's user name. | |
581 * | |
582 * @param buddy The buddy whose name will be returned. | |
583 * @return The appropriate name or alias, or NULL | |
584 */ | |
585 const char *gaim_buddy_get_alias(GaimBuddy *buddy); | |
586 | |
587 /** | |
588 * Returns the correct name to display for a blist chat. | |
589 * | |
590 * @param chat The chat whose name will be returned. | |
591 * @return The alias (if set), or first component value. | |
592 */ | |
593 const char *gaim_chat_get_name(GaimChat *chat); | |
594 | |
595 /** | |
596 * Finds the buddy struct given a screenname and an account | |
597 * | |
598 * @param account The account this buddy belongs to | |
599 * @param name The buddy's screenname | |
600 * @return The buddy or NULL if the buddy does not exist | |
601 */ | |
602 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); | |
603 | |
604 /** | |
605 * Finds the buddy struct given a screenname, an account, and a group | |
606 * | |
607 * @param account The account this buddy belongs to | |
608 * @param name The buddy's screenname | |
609 * @param group The group to look in | |
610 * @return The buddy or NULL if the buddy does not exist in the group | |
611 */ | |
612 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
613 GaimGroup *group); | |
614 | |
615 /** | |
616 * Finds all GaimBuddy structs given a screenname and an account | |
617 * | |
618 * @param account The account this buddy belongs to | |
14752
4124030c3f3a
[gaim-migrate @ 17509]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
14491
diff
changeset
|
619 * @param name The buddy's screenname (or NULL to return all buddies in the account) |
14192 | 620 * |
621 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
622 */ | |
623 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
624 | |
625 | |
626 /** | |
627 * Finds a group by name | |
628 * | |
629 * @param name The groups name | |
630 * @return The group or NULL if the group does not exist | |
631 */ | |
632 GaimGroup *gaim_find_group(const char *name); | |
633 | |
634 /** | |
635 * Finds a chat by name. | |
636 * | |
637 * @param account The chat's account. | |
638 * @param name The chat's name. | |
639 * | |
640 * @return The chat, or @c NULL if the chat does not exist. | |
641 */ | |
642 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); | |
643 | |
644 /** | |
645 * Returns the group of which the chat is a member. | |
646 * | |
647 * @param chat The chat. | |
648 * | |
649 * @return The parent group, or @c NULL if the chat is not in a group. | |
650 */ | |
651 GaimGroup *gaim_chat_get_group(GaimChat *chat); | |
652 | |
653 /** | |
654 * Returns the group of which the buddy is a member. | |
655 * | |
656 * @param buddy The buddy | |
657 * @return The group or NULL if the buddy is not in a group | |
658 */ | |
659 GaimGroup *gaim_buddy_get_group(GaimBuddy *buddy); | |
660 | |
661 | |
662 /** | |
663 * Returns a list of accounts that have buddies in this group | |
664 * | |
665 * @param g The group | |
666 * | |
667 * @return A list of gaim_accounts | |
668 */ | |
669 GSList *gaim_group_get_accounts(GaimGroup *g); | |
670 | |
671 /** | |
672 * Determines whether an account owns any buddies in a given group | |
673 * | |
674 * @param g The group to search through. | |
675 * @param account The account. | |
676 * | |
677 * @return TRUE if there are any buddies in the group, or FALSE otherwise. | |
678 */ | |
679 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); | |
680 | |
681 /** | |
682 * Called when an account gets signed on. Tells the UI to update all the | |
683 * buddies. | |
684 * | |
685 * @param account The account | |
686 */ | |
687 void gaim_blist_add_account(GaimAccount *account); | |
688 | |
689 | |
690 /** | |
691 * Called when an account gets signed off. Sets the presence of all the buddies to 0 | |
692 * and tells the UI to update them. | |
693 * | |
694 * @param account The account | |
695 */ | |
696 void gaim_blist_remove_account(GaimAccount *account); | |
697 | |
698 | |
699 /** | |
700 * Determines the total size of a group | |
701 * | |
702 * @param group The group | |
703 * @param offline Count buddies in offline accounts | |
704 * @return The number of buddies in the group | |
705 */ | |
706 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); | |
707 | |
708 /** | |
709 * Determines the number of online buddies in a group | |
710 * | |
711 * @param group The group | |
712 * @return The number of online buddies in the group, or 0 if the group is NULL | |
713 */ | |
714 int gaim_blist_get_group_online_count(GaimGroup *group); | |
715 | |
716 /*@}*/ | |
717 | |
718 /****************************************************************************************/ | |
719 /** @name Buddy list file management API */ | |
720 /****************************************************************************************/ | |
721 | |
722 /** | |
723 * Loads the buddy list from ~/.gaim/blist.xml. | |
724 */ | |
725 void gaim_blist_load(void); | |
726 | |
727 /** | |
728 * Schedule a save of the blist.xml file. This is used by the privacy | |
729 * API whenever the privacy settings are changed. If you make a change | |
730 * to blist.xml using one of the functions in the buddy list API, then | |
731 * the buddy list is saved automatically, so you should not need to | |
732 * call this. | |
733 */ | |
734 void gaim_blist_schedule_save(void); | |
735 | |
736 /** | |
737 * Requests from the user information needed to add a buddy to the | |
738 * buddy list. | |
739 * | |
740 * @param account The account the buddy is added to. | |
741 * @param username The username of the buddy. | |
742 * @param group The name of the group to place the buddy in. | |
743 * @param alias The optional alias for the buddy. | |
744 */ | |
745 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, | |
746 const char *group, const char *alias); | |
747 | |
748 /** | |
749 * Requests from the user information needed to add a chat to the | |
750 * buddy list. | |
751 * | |
752 * @param account The account the buddy is added to. | |
753 * @param group The optional group to add the chat to. | |
754 * @param alias The optional alias for the chat. | |
755 * @param name The required chat name. | |
756 */ | |
757 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, | |
758 const char *alias, const char *name); | |
759 | |
760 /** | |
761 * Requests from the user information needed to add a group to the | |
762 * buddy list. | |
763 */ | |
764 void gaim_blist_request_add_group(void); | |
765 | |
766 /** | |
767 * Associates a boolean with a node in the buddy list | |
768 * | |
769 * @param node The node to associate the data with | |
770 * @param key The identifier for the data | |
771 * @param value The value to set | |
772 */ | |
773 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
774 | |
775 /** | |
776 * Retrieves a named boolean setting from a node in the buddy list | |
777 * | |
778 * @param node The node to retrieve the data from | |
779 * @param key The identifier of the data | |
780 * | |
781 * @return The value, or FALSE if there is no setting | |
782 */ | |
783 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
784 | |
785 /** | |
786 * Associates an integer with a node in the buddy list | |
787 * | |
788 * @param node The node to associate the data with | |
789 * @param key The identifier for the data | |
790 * @param value The value to set | |
791 */ | |
792 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
793 | |
794 /** | |
795 * Retrieves a named integer setting from a node in the buddy list | |
796 * | |
797 * @param node The node to retrieve the data from | |
798 * @param key The identifier of the data | |
799 * | |
800 * @return The value, or 0 if there is no setting | |
801 */ | |
802 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
803 | |
804 /** | |
805 * Associates a string with a node in the buddy list | |
806 * | |
807 * @param node The node to associate the data with | |
808 * @param key The identifier for the data | |
809 * @param value The value to set | |
810 */ | |
811 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
812 const char *value); | |
813 | |
814 /** | |
815 * Retrieves a named string setting from a node in the buddy list | |
816 * | |
817 * @param node The node to retrieve the data from | |
818 * @param key The identifier of the data | |
819 * | |
820 * @return The value, or NULL if there is no setting | |
821 */ | |
822 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
823 | |
824 /** | |
825 * Removes a named setting from a blist node | |
826 * | |
827 * @param node The node from which to remove the setting | |
828 * @param key The name of the setting | |
829 */ | |
830 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
831 | |
832 /** | |
833 * Set the flags for the given node. Setting a node's flags will overwrite | |
834 * the old flags, so if you want to save them, you must first call | |
835 * gaim_blist_node_get_flags and modify that appropriately. | |
836 * | |
837 * @param node The node on which to set the flags. | |
838 * @param flags The flags to set. This is a bitmask. | |
839 */ | |
840 void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags); | |
841 | |
842 /** | |
843 * Get the current flags on a given node. | |
844 * | |
845 * @param node The node from which to get the flags. | |
846 * | |
847 * @return The flags on the node. This is a bitmask. | |
848 */ | |
849 GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node); | |
850 | |
851 /*@}*/ | |
852 | |
853 /** | |
854 * Retrieves the extended menu items for a buddy list node. | |
855 * @param n The blist node for which to obtain the extended menu items. | |
856 * @return A list of GaimMenuAction items, as harvested by the | |
857 * blist-node-extended-menu signal. | |
858 */ | |
859 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
860 | |
861 /**************************************************************************/ | |
862 /** @name UI Registration Functions */ | |
863 /**************************************************************************/ | |
864 /*@{*/ | |
865 | |
866 /** | |
867 * Sets the UI operations structure to be used for the buddy list. | |
868 * | |
869 * @param ops The ops struct. | |
870 */ | |
871 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); | |
872 | |
873 /** | |
874 * Returns the UI operations structure to be used for the buddy list. | |
875 * | |
876 * @return The UI operations structure. | |
877 */ | |
878 GaimBlistUiOps *gaim_blist_get_ui_ops(void); | |
879 | |
880 /*@}*/ | |
881 | |
882 /**************************************************************************/ | |
883 /** @name Buddy List Subsystem */ | |
884 /**************************************************************************/ | |
885 /*@{*/ | |
886 | |
887 /** | |
888 * Returns the handle for the buddy list subsystem. | |
889 * | |
890 * @return The buddy list subsystem handle. | |
891 */ | |
892 void *gaim_blist_get_handle(void); | |
893 | |
894 /** | |
895 * Initializes the buddy list subsystem. | |
896 */ | |
897 void gaim_blist_init(void); | |
898 | |
899 /** | |
900 * Uninitializes the buddy list subsystem. | |
901 */ | |
902 void gaim_blist_uninit(void); | |
903 | |
904 /*@}*/ | |
905 | |
906 #ifdef __cplusplus | |
907 } | |
908 #endif | |
909 | |
910 #endif /* _GAIM_BLIST_H_ */ |