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