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