Mercurial > pidgin
annotate src/blist.h @ 5864:417b1001d2b1
[gaim-migrate @ 6295]
Rewrote the pounce API again. Now it's even MORE core/UI-split, and will
allow for loading/saving.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sat, 14 Jun 2003 11:14:49 +0000 |
parents | 5e93fc46d1af |
children | 390d32a6b130 |
rev | line source |
---|---|
5228 | 1 /** |
5497 | 2 * @file blist.h Buddy List API |
5228 | 3 * @ingroup core |
4 * | |
5 * gaim | |
6 * | |
7 * Copyright (C) 2003, Sean Egan <sean.egan@binghamton.edu> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 | |
24 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ | |
25 | |
26 #ifndef _LIST_H_ | |
27 #define _LIST_H_ | |
28 | |
29 #include <glib.h> | |
30 | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
31 typedef struct _GaimBlistNode GaimBlistNode; |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
32 |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
33 /* TODO Namespace these! */ |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
34 struct chat; |
5794
5e93fc46d1af
[gaim-migrate @ 6219]
Christian Hammond <chipx86@chipx86.com>
parents:
5758
diff
changeset
|
35 struct buddy; |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
36 |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
37 #include "account.h" |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
38 |
5228 | 39 /**************************************************************************/ |
40 /* Enumerations */ | |
41 /**************************************************************************/ | |
42 enum gaim_blist_node_type { | |
43 GAIM_BLIST_GROUP_NODE, | |
44 GAIM_BLIST_BUDDY_NODE, | |
5234 | 45 GAIM_BLIST_CHAT_NODE, |
5228 | 46 GAIM_BLIST_OTHER_NODE, |
47 }; | |
48 | |
5234 | 49 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) |
5228 | 50 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) |
51 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) | |
52 | |
53 enum gaim_buddy_presence_state { | |
54 GAIM_BUDDY_SIGNING_OFF = -1, | |
55 GAIM_BUDDY_OFFLINE = 0, | |
56 GAIM_BUDDY_ONLINE, | |
57 GAIM_BUDDY_SIGNING_ON, | |
58 }; | |
59 | |
60 #define GAIM_BUDDY_IS_ONLINE(b) ((b)->present == GAIM_BUDDY_ONLINE || \ | |
61 (b)->present == GAIM_BUDDY_SIGNING_ON) | |
62 | |
63 | |
64 /**************************************************************************/ | |
65 /* Data Structures */ | |
66 /**************************************************************************/ | |
67 | |
68 /** | |
69 * A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for struct buddy and | |
70 * struct group and for anything else that wants to put itself in the buddy list. */ | |
71 struct _GaimBlistNode { | |
72 enum gaim_blist_node_type type; /**< The type of node this is */ | |
73 GaimBlistNode *prev; /**< The sibling before this buddy. */ | |
74 GaimBlistNode *next; /**< The sibling after this buddy. */ | |
75 GaimBlistNode *parent; /**< The parent of this node */ | |
76 GaimBlistNode *child; /**< The child of this node */ | |
77 void *ui_data; /**< The UI can put data here. */ | |
78 }; | |
79 | |
80 /** | |
81 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
82 */ | |
83 struct buddy { | |
84 GaimBlistNode node; /**< The node that this buddy inherits from */ | |
85 char *name; /**< The screenname of the buddy. */ | |
86 char *alias; /**< The user-set alias of the buddy */ | |
87 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ | |
88 enum gaim_buddy_presence_state present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if | |
89 he has recently signed on */ | |
90 int evil; /**< The warning level */ | |
91 time_t signon; /**< The time the buddy signed on. */ | |
92 int idle; /**< The time the buddy has been idle in minutes. */ | |
93 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
94 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
95 GaimAccount *account; /**< the account this buddy belongs to */ |
5228 | 96 GHashTable *settings; /**< per-buddy settings from the XML buddy list, set by plugins and the likes. */ |
97 guint timer; /**< The timer handle. */ | |
98 }; | |
99 | |
100 /** | |
101 * A group. This contains everything Gaim will ever need to know about a group. | |
102 */ | |
103 struct group { | |
104 GaimBlistNode node; /**< The node that this group inherits from */ | |
105 char *name; /**< The name of this group. */ | |
5277 | 106 int totalsize; /**< The number of buddies in this group */ |
107 int currentsize; /**< The number of buddies in this group corresponding to online accounts */ | |
108 int online; /**< The number of buddies in this group who are currently online */ | |
5228 | 109 GHashTable *settings; /**< per-group settings from the XML buddy list, set by plugins and the likes. */ |
110 }; | |
111 | |
5234 | 112 /** |
113 * A group. This contains everything Gaim needs to put a chat room in the | |
114 * buddy list. | |
115 */ | |
116 struct chat { | |
117 GaimBlistNode node; /**< The node that this chat inherits from */ | |
118 char *alias; /**< The display name of this chat. */ | |
119 GHashTable *components; /**< the stuff the protocol needs to know to join the chat */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
120 GaimAccount *account; /**< The account this chat is attached to */ |
5234 | 121 }; |
122 | |
5228 | 123 |
124 /** | |
125 * The Buddy List | |
126 */ | |
127 struct gaim_buddy_list { | |
128 GaimBlistNode *root; /**< The first node in the buddy list */ | |
5247 | 129 GHashTable *buddies; /**< Every buddy in this list */ |
5228 | 130 struct gaim_blist_ui_ops *ui_ops; /**< The UI operations for the buddy list */ |
131 | |
132 void *ui_data; /**< UI-specific data. */ | |
133 }; | |
134 | |
135 /** | |
136 * Buddy list UI operations. | |
137 * | |
138 * Any UI representing a buddy list must assign a filled-out gaim_window_ops | |
139 * structure to the buddy list core. | |
140 */ | |
141 struct gaim_blist_ui_ops | |
142 { | |
143 void (*new_list)(struct gaim_buddy_list *list); /**< Sets UI-specific data on a buddy list. */ | |
144 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ | |
145 void (*show)(struct gaim_buddy_list *list); /**< The core will call this when its finished doing it's core stuff */ | |
146 void (*update)(struct gaim_buddy_list *list, | |
147 GaimBlistNode *node); /**< This will update a node in the buddy list. */ | |
148 void (*remove)(struct gaim_buddy_list *list, | |
149 GaimBlistNode *node); /**< This removes a node from the list */ | |
150 void (*destroy)(struct gaim_buddy_list *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ | |
151 void (*set_visible)(struct gaim_buddy_list *list, | |
152 gboolean show); /**< Hides or unhides the buddy list */ | |
153 | |
154 }; | |
155 | |
156 /**************************************************************************/ | |
157 /** @name Buddy List API */ | |
158 /**************************************************************************/ | |
159 /*@{*/ | |
160 | |
161 /** | |
162 * Creates a new buddy list | |
163 */ | |
164 struct gaim_buddy_list *gaim_blist_new(); | |
165 | |
166 /** | |
167 * Sets the main buddy list. | |
168 * | |
169 * @return The main buddy list. | |
170 */ | |
171 void gaim_set_blist(struct gaim_buddy_list *blist); | |
172 | |
173 /** | |
174 * Returns the main buddy list. | |
175 * | |
176 * @return The main buddy list. | |
177 */ | |
178 struct gaim_buddy_list *gaim_get_blist(void); | |
179 | |
180 /** | |
181 * Shows the buddy list, creating a new one if necessary. | |
182 * | |
183 */ | |
184 void gaim_blist_show(); | |
185 | |
186 | |
187 /** | |
188 * Destroys the buddy list window. | |
189 */ | |
190 void gaim_blist_destroy(); | |
191 | |
192 /** | |
193 * Hides or unhides the buddy list. | |
194 * | |
195 * @param show Whether or not to show the buddy list | |
196 */ | |
197 void gaim_blist_set_visible(gboolean show); | |
198 | |
199 /** | |
200 * Updates a buddy's status. | |
5234 | 201 * |
5228 | 202 * This needs to not take an int. |
203 * | |
204 * @param buddy The buddy whose status has changed | |
205 * @param status The new status in cryptic prpl-understood code | |
206 */ | |
207 void gaim_blist_update_buddy_status(struct buddy *buddy, int status); | |
208 | |
209 | |
210 /** | |
211 * Updates a buddy's presence. | |
212 * | |
213 * @param buddy The buddy whose presence has changed | |
214 * @param presence The new presence | |
215 */ | |
216 void gaim_blist_update_buddy_presence(struct buddy *buddy, int presence); | |
217 | |
218 | |
219 /** | |
220 * Updates a buddy's idle time. | |
221 * | |
222 * @param buddy The buddy whose idle time has changed | |
223 * @param idle The buddy's idle time in minutes. | |
224 */ | |
225 void gaim_blist_update_buddy_idle(struct buddy *buddy, int idle); | |
226 | |
227 | |
228 /** | |
229 * Updates a buddy's warning level. | |
230 * | |
231 * @param buddy The buddy whose warning level has changed | |
232 * @param evil The warning level as an int from 0 to 100 (or higher, I guess... but that'd be weird) | |
233 */ | |
234 void gaim_blist_update_buddy_evil(struct buddy *buddy, int warning); | |
235 | |
236 /** | |
237 * Updates a buddy's icon. | |
238 * | |
239 * @param buddy The buddy whose buddy icon has changed | |
240 */ | |
241 void gaim_blist_update_buddy_icon(struct buddy *buddy); | |
242 | |
243 | |
244 | |
245 /** | |
246 * Renames a buddy in the buddy list. | |
247 * | |
248 * @param buddy The buddy whose name will be changed. | |
249 * @param name The new name of the buddy. | |
250 */ | |
251 void gaim_blist_rename_buddy(struct buddy *buddy, const char *name); | |
252 | |
253 | |
254 /** | |
255 * Aliases a buddy in the buddy list. | |
256 * | |
257 * @param buddy The buddy whose alias will be changed. | |
258 * @param alias The buddy's alias. | |
259 */ | |
260 void gaim_blist_alias_buddy(struct buddy *buddy, const char *alias); | |
261 | |
5234 | 262 /** |
263 * Aliases a chat in the buddy list. | |
264 * | |
265 * @param chat The chat whose alias will be changed. | |
266 * @param alias The chat's new alias. | |
267 */ | |
268 void gaim_blist_alias_chat(struct chat *chat, const char *alias); | |
5228 | 269 |
270 /** | |
271 * Renames a group | |
272 * | |
273 * @param group The group to rename | |
274 * @param name The new name | |
275 */ | |
276 void gaim_blist_rename_group(struct group *group, const char *name); | |
277 | |
5234 | 278 /** |
279 * Creates a new chat for the buddy list | |
280 * | |
281 * @param account The account this chat will get added to | |
282 * @param alias The alias of the new chat | |
283 * @param components The info the prpl needs to join the chat | |
284 * @return A newly allocated chat | |
285 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
286 struct chat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 287 |
288 /** | |
289 * Adds a new chat to the buddy list. | |
290 * | |
291 * The chat will be inserted right after node or appended to the end | |
292 * of group if node is NULL. If both are NULL, the buddy will be added to | |
293 * the "Chats" group. | |
294 * | |
295 * @param chat The new chat who gets added | |
296 * @param group The group to add the new chat to. | |
297 * @param node The insertion point | |
298 */ | |
299 void gaim_blist_add_chat(struct chat *chat, struct group *group, GaimBlistNode *node); | |
5228 | 300 |
301 /** | |
302 * Creates a new buddy | |
303 * | |
304 * @param account The account this buddy will get added to | |
305 * @param screenname The screenname of the new buddy | |
306 * @param alias The alias of the new buddy (or NULL if unaliased) | |
307 * @return A newly allocated buddy | |
308 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
309 struct buddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 310 |
311 /** | |
312 * Adds a new buddy to the buddy list. | |
313 * | |
314 * The buddy will be inserted right after node or appended to the end | |
315 * of group if node is NULL. If both are NULL, the buddy will be added to | |
316 * the "Buddies" group. | |
317 * | |
318 * @param buddy The new buddy who gets added | |
319 * @param group The group to add the new buddy to. | |
320 * @param node The insertion point | |
321 */ | |
322 void gaim_blist_add_buddy(struct buddy *buddy, struct group *group, GaimBlistNode *node); | |
323 | |
324 /** | |
325 * Creates a new group | |
326 * | |
327 * You can't have more than one group with the same name. Sorry. If you pass this the | |
328 * name of a group that already exists, it will return that group. | |
329 * | |
330 * @param name The name of the new group | |
331 * @return A new group struct | |
332 */ | |
333 struct group *gaim_group_new(const char *name); | |
334 | |
335 /** | |
336 * Adds a new group to the buddy list. | |
337 * | |
338 * The new group will be inserted after insert or appended to the end of | |
339 * the list if node is NULL. | |
340 * | |
341 * @param group The group to add the new buddy to. | |
342 * @param node The insertion point | |
343 */ | |
344 void gaim_blist_add_group(struct group *group, GaimBlistNode *node); | |
345 | |
346 /** | |
347 * Removes a buddy from the buddy list and frees the memory allocated to it. | |
348 * | |
349 * @param buddy The buddy to be removed | |
350 */ | |
351 void gaim_blist_remove_buddy(struct buddy *buddy); | |
352 | |
353 /** | |
5234 | 354 * Removes a chat from the buddy list and frees the memory allocated to it. |
355 * | |
356 * @param chat The chat to be removed | |
357 */ | |
358 void gaim_blist_remove_chat(struct chat *chat); | |
359 | |
360 /** | |
5228 | 361 * Removes a group from the buddy list and frees the memory allocated to it and to |
362 * its children | |
363 * | |
364 * @param group The group to be removed | |
365 */ | |
366 void gaim_blist_remove_group(struct group *group); | |
367 | |
368 /** | |
369 * Returns the alias of a buddy. | |
370 * | |
371 * @param buddy The buddy whose name will be returned. | |
372 * @return The alias (if set), server alias (if option is set), or NULL. | |
373 */ | |
374 char *gaim_get_buddy_alias_only(struct buddy *buddy); | |
375 | |
376 | |
377 /** | |
378 * Returns the correct name to display for a buddy. | |
379 * | |
380 * @param buddy The buddy whose name will be returned. | |
381 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown" | |
382 */ | |
383 char *gaim_get_buddy_alias(struct buddy *buddy); | |
384 | |
385 /** | |
386 * Finds the buddy struct given a screenname and an account | |
387 * | |
5758 | 388 * @param name The buddy's screenname or NULL to search for more buddies with the same screenname |
389 * as the previous search | |
5228 | 390 * @param account The account this buddy belongs to |
391 * @return The buddy or NULL if the buddy does not exist | |
392 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
393 struct buddy *gaim_find_buddy(GaimAccount *account, const char *name); |
5228 | 394 |
395 /** | |
396 * Finds a group by name | |
397 * | |
398 * @param name The groups name | |
399 * @return The group or NULL if the group does not exist | |
400 */ | |
401 struct group *gaim_find_group(const char *name); | |
402 | |
403 /** | |
404 * Returns the group of which the buddy is a member. | |
405 * | |
406 * @param buddy The buddy | |
407 * @return The group or NULL if the buddy is not in a group | |
408 */ | |
409 struct group *gaim_find_buddys_group(struct buddy *buddy); | |
410 | |
411 | |
412 /** | |
413 * Returns a list of accounts that have buddies in this group | |
414 * | |
415 * @param group The group | |
416 * @return A list of gaim_accounts | |
417 */ | |
418 GSList *gaim_group_get_accounts(struct group *g); | |
419 | |
420 /** | |
421 * Determines whether an account owns any buddies in a given group | |
422 * | |
423 * @param g The group to search through. | |
424 * @param account The account. | |
425 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
426 gboolean gaim_group_on_account(struct group *g, GaimAccount *account); |
5228 | 427 |
428 /** | |
5234 | 429 * Called when an account gets signed on. Tells the UI to update all the |
430 * buddies. | |
431 * | |
432 * @param account The account | |
433 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
434 void gaim_blist_add_account(GaimAccount *account); |
5234 | 435 |
436 | |
437 /** | |
5228 | 438 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
439 * and tells the UI to update them. | |
440 * | |
441 * @param account The account | |
442 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
443 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 444 |
445 | |
446 /** | |
447 * Determines the total size of a group | |
448 * | |
449 * @param group The group | |
450 * @param offline Count buddies in offline accounts | |
451 * @return The number of buddies in the group | |
452 */ | |
453 int gaim_blist_get_group_size(struct group *group, gboolean offline); | |
454 | |
455 /** | |
456 * Determines the number of online buddies in a group | |
457 * | |
458 * @param group The group | |
459 * @return The number of online buddies in the group, or 0 if the group is NULL | |
460 */ | |
461 int gaim_blist_get_group_online_count(struct group *group); | |
462 | |
463 /*@}*/ | |
464 | |
465 /****************************************************************************************/ | |
466 /** @name Buddy list file management API */ | |
467 /****************************************************************************************/ | |
468 | |
469 /*@{*/ | |
470 /** | |
471 * Saves the buddy list to file | |
472 */ | |
473 void gaim_blist_save(); | |
474 | |
475 /** | |
476 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c | |
477 * | |
478 * @param account This is the account that the buddies and groups from config will get added to | |
479 * @param config This is the toc-style buddy list data | |
480 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
481 void parse_toc_buddy_list(GaimAccount *account, char *config); |
5228 | 482 |
483 | |
484 /** | |
485 * Loads the buddy list from ~/.gaim/blist.xml. | |
486 */ | |
487 void gaim_blist_load(); | |
488 | |
489 /** | |
490 * Associates some data with the group in the xml buddy list | |
491 * | |
492 * @param g The group the data is associated with | |
493 * @param key The key used to retrieve the data | |
494 * @param value The data to set | |
495 */ | |
496 void gaim_group_set_setting(struct group *g, const char *key, const char *value); | |
497 | |
498 /** | |
499 * Retrieves data from the XML buddy list set by gaim_group_set_setting()) | |
500 * | |
501 * @param g The group to retrieve data from | |
502 * @param key The key to retrieve the data with | |
503 * @return The associated data or NULL if no data is associated | |
504 */ | |
505 char *gaim_group_get_setting(struct group *g, const char *key); | |
506 | |
507 | |
508 /** | |
509 * Associates some data with the buddy in the xml buddy list | |
510 * | |
511 * @param b The buddy the data is associated with | |
512 * @param key The key used to retrieve the data | |
513 * @param value The data to set | |
514 */ | |
515 void gaim_buddy_set_setting(struct buddy *b, const char *key, const char *value); | |
516 | |
517 /** | |
518 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting()) | |
519 * | |
520 * @param b The buddy to retrieve data from | |
521 * @param key The key to retrieve the data with | |
522 * @return The associated data or NULL if no data is associated | |
523 */ | |
524 char *gaim_buddy_get_setting(struct buddy *b, const char *key); | |
525 | |
526 /*@}*/ | |
527 | |
528 /**************************************************************************/ | |
529 /** @name UI Registration Functions */ | |
530 /**************************************************************************/ | |
531 /*@{*/ | |
532 | |
533 /** | |
534 * Sets the UI operations structure to be used for the buddy list. | |
535 * | |
536 * @param ops The ops struct. | |
537 */ | |
538 void gaim_set_blist_ui_ops(struct gaim_blist_ui_ops *ops); | |
539 | |
540 /** | |
541 * Returns the UI operations structure to be used for the buddy list. | |
542 * | |
543 * @return The UI operations structure. | |
544 */ | |
545 struct gaim_blist_ui_ops *gaim_get_blist_ui_ops(void); | |
546 | |
547 /*@}*/ | |
548 | |
549 #endif /* _LIST_H_ */ |