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