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
|
|
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 /**************************************************************************/
|
|
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 */
|
|
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 {
|
|
106 void (*show)(struct gaim_buddy_list *list); /**< The core will call this when its finished doing it's core stuff */
|
|
107 void (*update)(struct gaim_buddy_list *list,
|
|
108 GaimBlistNode *node); /**< This will update a node in the buddy list. */
|
|
109 void (*remove)(struct gaim_buddy_list *list,
|
|
110 GaimBlistNode *node); /**< This removes a node from the list */
|
|
111 void (*destroy)(struct gaim_buddy_list *list); /**< When the list gets destroyed, this gets called to destroy the UI. */
|
|
112 void (*set_visible)(struct gaim_buddy_list *list,
|
|
113 gboolean show); /**< Hides or unhides the buddy list */
|
|
114
|
|
115 };
|
|
116
|
|
117 /**************************************************************************/
|
|
118 /* Globals */
|
|
119 /**************************************************************************/
|
|
120 extern struct gaim_buddy_list *gaimbuddylist; /**< A global for the core buddy list. */
|
|
121
|
|
122
|
|
123 /**************************************************************************/
|
|
124 /** @name Buddy List API */
|
|
125 /**************************************************************************/
|
|
126 /*@{*/
|
|
127
|
|
128 /**
|
|
129 * Creates a new buddy list
|
|
130 */
|
|
131 struct gaim_buddy_list *gaim_blist_new();
|
|
132
|
|
133
|
|
134 /**
|
|
135 * Shows the buddy list, creating a new one if necessary.
|
|
136 *
|
|
137 */
|
|
138 void gaim_blist_show();
|
|
139
|
|
140
|
|
141 /**
|
|
142 * Destroys the buddy list window.
|
|
143 */
|
|
144 void gaim_blist_destroy();
|
|
145
|
|
146 /**
|
|
147 * Hides or unhides the buddy list.
|
|
148 *
|
|
149 * @param show Whether or not to show the buddy list
|
|
150 */
|
|
151 void gaim_blist_set_visible(gboolean show);
|
|
152
|
|
153 /**
|
|
154 * Updates a buddy's status.
|
|
155 *
|
|
156 * This needs to not take an int.
|
|
157 *
|
|
158 * @param buddy The buddy whose status has changed
|
|
159 * @param status The new status in cryptic prpl-understood code
|
|
160 */
|
|
161 void gaim_blist_update_buddy_status(struct buddy *buddy, int status);
|
|
162
|
|
163
|
|
164 /**
|
|
165 * Updates a buddy's presence.
|
|
166 *
|
|
167 * @param buddy The buddy whose presence has changed
|
|
168 * @param presence The new presence
|
|
169 */
|
|
170 void gaim_blist_update_buddy_presence(struct buddy *buddy, int presence);
|
|
171
|
|
172
|
|
173 /**
|
|
174 * Updates a buddy's idle time.
|
|
175 *
|
|
176 * @param buddy The buddy whose idle time has changed
|
|
177 * @param idle The buddy's idle time in minutes.
|
|
178 */
|
|
179 void gaim_blist_update_buddy_idle(struct buddy *buddy, int idle);
|
|
180
|
|
181
|
|
182 /**
|
|
183 * Updates a buddy's warning level.
|
|
184 *
|
|
185 * @param buddy The buddy whose warning level has changed
|
|
186 * @param evil The warning level as an int from 0 to 100 (or higher, I guess... but that'd be weird)
|
|
187 */
|
|
188 void gaim_blist_update_buddy_evil(struct buddy *buddy, int warning);
|
|
189
|
|
190
|
|
191 /**
|
|
192 * Renames a buddy in the buddy list.
|
|
193 *
|
|
194 * @param buddy The buddy whose name will be changed.
|
|
195 * @param name The new name of the buddy.
|
|
196 */
|
|
197 void gaim_blist_rename_buddy(struct buddy *buddy, const char *name);
|
|
198
|
|
199
|
|
200 /**
|
|
201 * Aliases a buddy in the buddy list.
|
|
202 *
|
|
203 * @param buddy The buddy whose alias will be changed.
|
|
204 * @param alias The buddy's alias.
|
|
205 */
|
|
206 void gaim_blist_alias_buddy(struct buddy *buddy, const char *alias);
|
|
207
|
|
208
|
|
209 /**
|
|
210 * Renames a group
|
|
211 *
|
|
212 * @param group The group to rename
|
|
213 * @param name The new name
|
|
214 */
|
|
215 void gaim_blist_rename_group(struct group *group, const char *name);
|
|
216
|
|
217
|
|
218 /**
|
|
219 * Creates a new buddy
|
|
220 *
|
|
221 * @param account The account this buddy will get added to
|
|
222 * @param screenname The screenname of the new buddy
|
|
223 * @param alias The alias of the new buddy (or NULL if unaliased)
|
|
224 * @return A newly allocated buddy
|
|
225 */
|
|
226 struct buddy *gaim_buddy_new(struct gaim_account *account, const char *screenname, const char *alias);
|
|
227
|
|
228 /**
|
|
229 * Adds a new buddy to the buddy list.
|
|
230 *
|
|
231 * The buddy will be inserted right after node or appended to the end
|
|
232 * of group if node is NULL. If both are NULL, the buddy will be added to
|
|
233 * the "Buddies" group.
|
|
234 *
|
|
235 * @param buddy The new buddy who gets added
|
|
236 * @param group The group to add the new buddy to.
|
|
237 * @param node The insertion point
|
|
238 */
|
|
239 void gaim_blist_add_buddy(struct buddy *buddy, struct group *group, GaimBlistNode *node);
|
|
240
|
|
241 /**
|
|
242 * Creates a new group
|
|
243 *
|
|
244 * You can't have more than one group with the same name. Sorry. If you pass this the
|
|
245 * name of a group that already exists, it will return that group.
|
|
246 *
|
|
247 * @param name The name of the new group
|
|
248 * @return A new group struct
|
|
249 */
|
|
250 struct group *gaim_group_new(const char *name);
|
|
251
|
|
252 /**
|
|
253 * Adds a new group to the buddy list.
|
|
254 *
|
|
255 * The new group will be inserted after insert or appended to the end of
|
|
256 * the list if node is NULL.
|
|
257 *
|
|
258 * @param group The group to add the new buddy to.
|
|
259 * @param node The insertion point
|
|
260 */
|
|
261 void gaim_blist_add_group(struct group *group, GaimBlistNode *node);
|
|
262
|
|
263 /**
|
|
264 * Removes a buddy from the buddy list and frees the memory allocated to it.
|
|
265 *
|
|
266 * @param buddy The buddy to be removed
|
|
267 */
|
|
268 void gaim_blist_remove_buddy(struct buddy *buddy);
|
|
269
|
|
270 /**
|
|
271 * Removes a group from the buddy list and frees the memory allocated to it and to
|
|
272 * its children
|
|
273 *
|
|
274 * @param group The group to be removed
|
|
275 */
|
|
276 void gaim_blist_remove_group(struct group *group);
|
|
277
|
|
278
|
|
279 /**
|
|
280 * Returns the alias of a buddy.
|
|
281 *
|
|
282 * @param buddy The buddy whose name will be returned.
|
|
283 * @return The alias (if set), server alias (if option is set), or NULL.
|
|
284 */
|
|
285 char *gaim_get_buddy_alias_only(struct buddy *buddy);
|
|
286
|
|
287
|
|
288 /**
|
|
289 * Returns the correct name to display for a buddy.
|
|
290 *
|
|
291 * @param buddy The buddy whose name will be returned.
|
|
292 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown"
|
|
293 */
|
|
294 char *gaim_get_buddy_alias(struct buddy *buddy);
|
|
295
|
|
296 /**
|
|
297 * Finds the buddy struct given a screenname and an account
|
|
298 *
|
|
299 * @param name The buddy's screenname
|
|
300 * @param account The account this buddy belongs to
|
|
301 * @return The buddy or NULL if the buddy does not exist
|
|
302 */
|
|
303 struct buddy *gaim_find_buddy(struct gaim_account *account, const char *name);
|
|
304
|
|
305 /**
|
|
306 * Finds a group by name
|
|
307 *
|
|
308 * @param name The groups name
|
|
309 * @return The group or NULL if the group does not exist
|
|
310 */
|
|
311 struct group *gaim_find_group(const char *name);
|
|
312
|
|
313 /**
|
|
314 * Returns the group of which the buddy is a member.
|
|
315 *
|
|
316 * @param buddy The buddy
|
|
317 * @return The group or NULL if the buddy is not in a group
|
|
318 */
|
|
319 struct group *gaim_find_buddys_group(struct buddy *buddy);
|
|
320
|
|
321
|
|
322 /**
|
|
323 * Returns a list of accounts that have buddies in this group
|
|
324 *
|
|
325 * @param group The group
|
|
326 * @return A list of gaim_accounts
|
|
327 */
|
|
328 GSList *gaim_group_get_accounts(struct group *g);
|
|
329
|
|
330 /**
|
|
331 * Determines whether an account owns any buddies in a given group
|
|
332 *
|
|
333 * @param g The group to search through.
|
|
334 * @account The account.
|
|
335 */
|
|
336 gboolean gaim_group_on_account(struct group *g, struct gaim_account *account);
|
|
337
|
|
338 /**
|
|
339 * Called when an account gets signed off. Sets the presence of all the buddies to 0
|
|
340 * and tells the UI to update them.
|
|
341 *
|
|
342 * @param account The account
|
|
343 */
|
|
344 void gaim_blist_remove_account(struct gaim_account *account);
|
|
345
|
|
346
|
|
347 /*@}*/
|
|
348
|
|
349 /****************************************************************************************/
|
|
350 /** @name Buddy list file management API */
|
|
351 /****************************************************************************************/
|
|
352
|
|
353 /*@{*/
|
|
354 /**
|
|
355 * Saves the buddy list to file
|
|
356 */
|
|
357 void gaim_blist_save();
|
|
358
|
|
359 /**
|
|
360 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c
|
|
361 *
|
|
362 * @param account This is the account that the buddies and groups from config will get added to
|
|
363 * @param config This is the toc-style buddy list data
|
|
364 */
|
|
365 void parse_toc_buddy_list(struct gaim_account *account, char *config);
|
|
366
|
|
367
|
|
368 /**
|
|
369 * Loads the buddy list from ~/.gaim/blist.xml.
|
|
370 */
|
|
371 void gaim_blist_load();
|
|
372
|
|
373 /**
|
|
374 * Associates some data with the buddy in the xml buddy list
|
|
375 *
|
|
376 * @param b The buddy the data is associated with
|
|
377 * @param key The key used to retrieve the data
|
|
378 * @param value The data to set
|
|
379 */
|
|
380 void gaim_buddy_set_setting(struct buddy *b, const char *key, const char *value);
|
|
381
|
|
382 /**
|
|
383 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting())
|
|
384 *
|
|
385 * @param b The buddy to retrieve data from
|
|
386 * @param key The key to retrieve the data with
|
|
387 * @return The associated data or NULL if no data is associated
|
|
388 */
|
|
389 char *gaim_buddy_get_setting(struct buddy *b, const char *key);
|
|
390
|
|
391 /*@}*/
|
|
392
|
|
393 /**************************************************************************/
|
|
394 /** @name UI Registration Functions */
|
|
395 /**************************************************************************/
|
|
396 /*@{*/
|
|
397
|
|
398 /**
|
|
399 * Sets the UI operations structure to be used for the buddy list.
|
|
400 *
|
|
401 * @param ops The ops struct.
|
|
402 */
|
|
403 void gaim_set_blist_ui_ops(struct gaim_blist_ui_ops *ops);
|
|
404
|
|
405 /*@}*/
|
|
406
|
|
407 #endif /* _LIST_H_ */
|