Mercurial > pidgin
annotate src/list.h @ 5097:2b9df97b2b21
[gaim-migrate @ 5459]
Daniel Yacob wrote a Amharic translation of gaim.
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Thu, 10 Apr 2003 17:37:50 +0000 |
parents | b37d7d09ec83 |
children | 94f11800cac5 |
rev | line source |
---|---|
4688 | 1 /** |
2 * @file list.h Buddy List API | |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4785
diff
changeset
|
3 * @ingroup core |
4688 | 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 | |
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 |
5068 | 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 | |
4688 | 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. */ | |
5068 | 66 GaimBlistNode *parent; /**< The parent of this node */ |
4688 | 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") */ | |
5068 | 79 enum gaim_buddy_presence_state present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if |
4688 | 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. */ | |
5068 | 84 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ |
4688 | 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. */ | |
5068 | 88 guint timer; /**< The timer handle. */ |
4688 | 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 }; | |
98 | |
99 | |
100 /** | |
101 * The Buddy List | |
102 */ | |
103 struct gaim_buddy_list { | |
104 GaimBlistNode *root; /**< The first node in the buddy list */ | |
105 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
|
106 |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
107 void *ui_data; /**< UI-specific data. */ |
4688 | 108 }; |
109 | |
110 /** | |
111 * Buddy list UI operations. | |
112 * | |
113 * Any UI representing a buddy list must assign a filled-out gaim_window_ops | |
114 * structure to the buddy list core. | |
115 */ | |
116 struct gaim_blist_ui_ops | |
117 { | |
4695
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
118 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
|
119 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ |
4688 | 120 void (*show)(struct gaim_buddy_list *list); /**< The core will call this when its finished doing it's core stuff */ |
121 void (*update)(struct gaim_buddy_list *list, | |
122 GaimBlistNode *node); /**< This will update a node in the buddy list. */ | |
123 void (*remove)(struct gaim_buddy_list *list, | |
124 GaimBlistNode *node); /**< This removes a node from the list */ | |
125 void (*destroy)(struct gaim_buddy_list *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ | |
4785 | 126 void (*set_visible)(struct gaim_buddy_list *list, |
4688 | 127 gboolean show); /**< Hides or unhides the buddy list */ |
4770 | 128 |
4785 | 129 }; |
4770 | 130 |
131 /**************************************************************************/ | |
4688 | 132 /** @name Buddy List API */ |
133 /**************************************************************************/ | |
134 /*@{*/ | |
135 | |
136 /** | |
137 * Creates a new buddy list | |
138 */ | |
139 struct gaim_buddy_list *gaim_blist_new(); | |
140 | |
4695
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
141 /** |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
142 * Sets the main buddy list. |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
143 * |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
144 * @return The main buddy list. |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
145 */ |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
146 void gaim_set_blist(struct gaim_buddy_list *blist); |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
147 |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
148 /** |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
149 * Returns the main buddy list. |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
150 * |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
151 * @return The main buddy list. |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
152 */ |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
153 struct gaim_buddy_list *gaim_get_blist(void); |
4688 | 154 |
155 /** | |
156 * Shows the buddy list, creating a new one if necessary. | |
157 * | |
158 */ | |
159 void gaim_blist_show(); | |
160 | |
161 | |
162 /** | |
163 * Destroys the buddy list window. | |
164 */ | |
165 void gaim_blist_destroy(); | |
166 | |
167 /** | |
168 * Hides or unhides the buddy list. | |
169 * | |
170 * @param show Whether or not to show the buddy list | |
171 */ | |
172 void gaim_blist_set_visible(gboolean show); | |
173 | |
174 /** | |
175 * Updates a buddy's status. | |
176 * | |
177 * This needs to not take an int. | |
178 * | |
179 * @param buddy The buddy whose status has changed | |
180 * @param status The new status in cryptic prpl-understood code | |
181 */ | |
182 void gaim_blist_update_buddy_status(struct buddy *buddy, int status); | |
183 | |
184 | |
185 /** | |
186 * Updates a buddy's presence. | |
187 * | |
188 * @param buddy The buddy whose presence has changed | |
189 * @param presence The new presence | |
190 */ | |
191 void gaim_blist_update_buddy_presence(struct buddy *buddy, int presence); | |
192 | |
193 | |
194 /** | |
195 * Updates a buddy's idle time. | |
196 * | |
197 * @param buddy The buddy whose idle time has changed | |
198 * @param idle The buddy's idle time in minutes. | |
199 */ | |
200 void gaim_blist_update_buddy_idle(struct buddy *buddy, int idle); | |
201 | |
202 | |
203 /** | |
204 * Updates a buddy's warning level. | |
4757 | 205 * |
4688 | 206 * @param buddy The buddy whose warning level has changed |
207 * @param evil The warning level as an int from 0 to 100 (or higher, I guess... but that'd be weird) | |
208 */ | |
209 void gaim_blist_update_buddy_evil(struct buddy *buddy, int warning); | |
210 | |
4757 | 211 /** |
4765
b6f6a10f9baf
[gaim-migrate @ 5083]
Christian Hammond <chipx86@chipx86.com>
parents:
4757
diff
changeset
|
212 * Updates a buddy's icon. |
4757 | 213 * |
214 * @param buddy The buddy whose buddy icon has changed | |
215 */ | |
216 void gaim_blist_update_buddy_icon(struct buddy *buddy); | |
217 | |
218 | |
4688 | 219 |
220 /** | |
221 * Renames a buddy in the buddy list. | |
222 * | |
223 * @param buddy The buddy whose name will be changed. | |
224 * @param name The new name of the buddy. | |
225 */ | |
226 void gaim_blist_rename_buddy(struct buddy *buddy, const char *name); | |
227 | |
228 | |
229 /** | |
230 * Aliases a buddy in the buddy list. | |
231 * | |
232 * @param buddy The buddy whose alias will be changed. | |
233 * @param alias The buddy's alias. | |
234 */ | |
235 void gaim_blist_alias_buddy(struct buddy *buddy, const char *alias); | |
236 | |
237 | |
238 /** | |
239 * Renames a group | |
240 * | |
241 * @param group The group to rename | |
242 * @param name The new name | |
243 */ | |
244 void gaim_blist_rename_group(struct group *group, const char *name); | |
245 | |
246 | |
247 /** | |
248 * Creates a new buddy | |
249 * | |
250 * @param account The account this buddy will get added to | |
251 * @param screenname The screenname of the new buddy | |
252 * @param alias The alias of the new buddy (or NULL if unaliased) | |
253 * @return A newly allocated buddy | |
254 */ | |
255 struct buddy *gaim_buddy_new(struct gaim_account *account, const char *screenname, const char *alias); | |
256 | |
257 /** | |
258 * Adds a new buddy to the buddy list. | |
259 * | |
260 * The buddy will be inserted right after node or appended to the end | |
261 * of group if node is NULL. If both are NULL, the buddy will be added to | |
262 * the "Buddies" group. | |
263 * | |
264 * @param buddy The new buddy who gets added | |
265 * @param group The group to add the new buddy to. | |
266 * @param node The insertion point | |
267 */ | |
268 void gaim_blist_add_buddy(struct buddy *buddy, struct group *group, GaimBlistNode *node); | |
269 | |
270 /** | |
271 * Creates a new group | |
272 * | |
273 * You can't have more than one group with the same name. Sorry. If you pass this the | |
274 * name of a group that already exists, it will return that group. | |
275 * | |
276 * @param name The name of the new group | |
277 * @return A new group struct | |
278 */ | |
279 struct group *gaim_group_new(const char *name); | |
280 | |
281 /** | |
282 * Adds a new group to the buddy list. | |
283 * | |
284 * The new group will be inserted after insert or appended to the end of | |
285 * the list if node is NULL. | |
286 * | |
287 * @param group The group to add the new buddy to. | |
288 * @param node The insertion point | |
289 */ | |
290 void gaim_blist_add_group(struct group *group, GaimBlistNode *node); | |
291 | |
292 /** | |
293 * Removes a buddy from the buddy list and frees the memory allocated to it. | |
294 * | |
295 * @param buddy The buddy to be removed | |
296 */ | |
297 void gaim_blist_remove_buddy(struct buddy *buddy); | |
298 | |
299 /** | |
300 * Removes a group from the buddy list and frees the memory allocated to it and to | |
301 * its children | |
302 * | |
303 * @param group The group to be removed | |
304 */ | |
305 void gaim_blist_remove_group(struct group *group); | |
306 | |
307 /** | |
308 * Returns the alias of 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), or NULL. | |
312 */ | |
313 char *gaim_get_buddy_alias_only(struct buddy *buddy); | |
314 | |
315 | |
316 /** | |
317 * Returns the correct name to display for a buddy. | |
318 * | |
319 * @param buddy The buddy whose name will be returned. | |
320 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown" | |
321 */ | |
322 char *gaim_get_buddy_alias(struct buddy *buddy); | |
323 | |
324 /** | |
325 * Finds the buddy struct given a screenname and an account | |
326 * | |
327 * @param name The buddy's screenname | |
328 * @param account The account this buddy belongs to | |
329 * @return The buddy or NULL if the buddy does not exist | |
330 */ | |
331 struct buddy *gaim_find_buddy(struct gaim_account *account, const char *name); | |
332 | |
333 /** | |
334 * Finds a group by name | |
335 * | |
336 * @param name The groups name | |
337 * @return The group or NULL if the group does not exist | |
338 */ | |
339 struct group *gaim_find_group(const char *name); | |
340 | |
341 /** | |
342 * Returns the group of which the buddy is a member. | |
343 * | |
344 * @param buddy The buddy | |
345 * @return The group or NULL if the buddy is not in a group | |
346 */ | |
347 struct group *gaim_find_buddys_group(struct buddy *buddy); | |
348 | |
349 | |
350 /** | |
351 * Returns a list of accounts that have buddies in this group | |
352 * | |
353 * @param group The group | |
354 * @return A list of gaim_accounts | |
355 */ | |
356 GSList *gaim_group_get_accounts(struct group *g); | |
357 | |
358 /** | |
359 * Determines whether an account owns any buddies in a given group | |
360 * | |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4785
diff
changeset
|
361 * @param g The group to search through. |
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4785
diff
changeset
|
362 * @param account The account. |
4688 | 363 */ |
364 gboolean gaim_group_on_account(struct group *g, struct gaim_account *account); | |
365 | |
366 /** | |
367 * Called when an account gets signed off. Sets the presence of all the buddies to 0 | |
368 * and tells the UI to update them. | |
369 * | |
370 * @param account The account | |
371 */ | |
372 void gaim_blist_remove_account(struct gaim_account *account); | |
373 | |
374 | |
4701 | 375 /** |
376 * Determines the total size of a group | |
377 * | |
378 * @param group The group | |
379 * @param offline Count buddies in offline accounts | |
380 * @return The number of buddies in the group | |
381 */ | |
382 int gaim_blist_get_group_size(struct group *group, gboolean offline); | |
383 | |
384 /** | |
385 * Determines the number of online buddies in a group | |
386 * | |
387 * @param group The group | |
388 * @return The number of online buddies in the group, or 0 if the group is NULL | |
389 */ | |
390 int gaim_blist_get_group_online_count(struct group *group); | |
391 | |
4688 | 392 /*@}*/ |
393 | |
394 /****************************************************************************************/ | |
395 /** @name Buddy list file management API */ | |
396 /****************************************************************************************/ | |
397 | |
398 /*@{*/ | |
399 /** | |
400 * Saves the buddy list to file | |
401 */ | |
402 void gaim_blist_save(); | |
403 | |
404 /** | |
405 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c | |
406 * | |
407 * @param account This is the account that the buddies and groups from config will get added to | |
408 * @param config This is the toc-style buddy list data | |
409 */ | |
410 void parse_toc_buddy_list(struct gaim_account *account, char *config); | |
411 | |
412 | |
413 /** | |
414 * Loads the buddy list from ~/.gaim/blist.xml. | |
415 */ | |
416 void gaim_blist_load(); | |
417 | |
418 /** | |
419 * Associates some data with the buddy in the xml buddy list | |
420 * | |
421 * @param b The buddy the data is associated with | |
422 * @param key The key used to retrieve the data | |
423 * @param value The data to set | |
424 */ | |
425 void gaim_buddy_set_setting(struct buddy *b, const char *key, const char *value); | |
426 | |
427 /** | |
428 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting()) | |
429 * | |
430 * @param b The buddy to retrieve data from | |
431 * @param key The key to retrieve the data with | |
432 * @return The associated data or NULL if no data is associated | |
433 */ | |
434 char *gaim_buddy_get_setting(struct buddy *b, const char *key); | |
435 | |
436 /*@}*/ | |
437 | |
438 /**************************************************************************/ | |
439 /** @name UI Registration Functions */ | |
440 /**************************************************************************/ | |
441 /*@{*/ | |
442 | |
443 /** | |
444 * Sets the UI operations structure to be used for the buddy list. | |
445 * | |
446 * @param ops The ops struct. | |
447 */ | |
448 void gaim_set_blist_ui_ops(struct gaim_blist_ui_ops *ops); | |
449 | |
4695
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
450 /** |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
451 * 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
|
452 * |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
453 * @return The UI operations structure. |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
454 */ |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
455 struct gaim_blist_ui_ops *gaim_get_blist_ui_ops(void); |
4bdd9a5fd026
[gaim-migrate @ 5006]
Christian Hammond <chipx86@chipx86.com>
parents:
4688
diff
changeset
|
456 |
4688 | 457 /*@}*/ |
458 | |
459 #endif /* _LIST_H_ */ |