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