Mercurial > pidgin.yaz
annotate src/prpl.h @ 10035:4e7fe18a36b7
[gaim-migrate @ 10994]
Wait, didn't I already commit this?
It should make libfaim compile again with c++
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sat, 18 Sep 2004 17:19:29 +0000 |
parents | 9baedaca25c7 |
children | af06746954de |
rev | line source |
---|---|
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
1 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
2 * @file prpl.h Protocol Plugin functions |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4966
diff
changeset
|
3 * @ingroup core |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
4 * |
981 | 5 * gaim |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
10 * |
981 | 11 * This program is free software; you can redistribute it and/or modify |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 | |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
26 /* this file should be all that prpls need to include. therefore, by including |
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
27 * this file, they should get glib, proxy, gaim_connection, prpl, etc. */ |
981 | 28 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
29 #ifndef _GAIM_PRPL_H_ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
30 #define _GAIM_PRPL_H_ |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
31 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
32 typedef struct _GaimPluginProtocolInfo GaimPluginProtocolInfo; |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
33 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
34 /**************************************************************************/ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
35 /** @name Basic Protocol Information */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
36 /**************************************************************************/ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
37 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
38 /** |
6622 | 39 * Flags applicable to outgoing/incoming IMs from prpls. |
40 */ | |
41 typedef enum | |
42 { | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
43 GAIM_CONV_IM_AUTO_RESP = 0x0001, /**< Auto response. */ |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
44 GAIM_CONV_IM_IMAGES = 0x0002 /**< Contains images. */ |
9584 | 45 } GaimConvImFlags; |
8749
d7b8eb1f0a18
[gaim-migrate @ 9504]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
46 |
9584 | 47 typedef enum |
48 { | |
49 GAIM_CONV_CHAT_WHISPER = 0x0001, /**< Whispered message.*/ | |
50 GAIM_CONV_CHAT_DELAYED = 0x0002 /**< Delayed message. */ | |
51 | |
52 } GaimConvChatFlags; | |
6622 | 53 |
9318 | 54 typedef enum { |
55 GAIM_ICON_SCALE_DISPLAY = 0x01, /**< We scale the icon when we display it */ | |
56 GAIM_ICON_SCALE_SEND = 0x02 /**< We scale the icon before we send it to the server */ | |
57 } GaimIconScaleRules; | |
58 | |
59 | |
9308 | 60 /** |
61 * A description of a Buddy Icon specification. This tells Gaim what kind of image file | |
62 * it should give this prpl, and what kind of image file it should expect back. | |
9316 | 63 * Dimensions less than 1 should be ignored and the image not scaled. |
9308 | 64 */ |
65 typedef struct { | |
66 char *format; /**< This is a comma-delimited list of image formats or NULL if icons are not supported. | |
67 * The core nor the prpl will actually check to see if the data it's given matches this, it's entirely | |
68 * up to the UI to do what it wants */ | |
9318 | 69 int min_width; /**< The minimum width of this icon */ |
70 int min_height; /**< The minimum height of this icon */ | |
71 int max_width; /**< The maximum width of this icon */ | |
72 int max_height; /**< The maximum height of this icon */ | |
73 GaimIconScaleRules scale_rules; /**< How to stretch this icon */ | |
9308 | 74 } GaimBuddyIconSpec; |
75 | |
9999 | 76 /** |
77 * This #define exists just to make it easier to fill out the buddy icon | |
78 * field in the prpl info struct for protocols that couldn't care less. | |
79 */ | |
9318 | 80 #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0} |
9308 | 81 |
8573 | 82 #include "blist.h" |
83 #include "proxy.h" | |
84 #include "plugin.h" | |
9999 | 85 #include "roomlist.h" |
9944 | 86 #include "status.h" |
8573 | 87 |
9713 | 88 struct proto_chat_entry { |
89 char *label; | |
90 char *identifier; | |
91 gboolean is_int; | |
92 int min; | |
93 int max; | |
94 gboolean secret; | |
95 }; | |
96 | |
6622 | 97 /** |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
98 * Protocol options |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
99 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
100 * These should all be stuff that some plugins can do and others can't. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
101 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
102 typedef enum |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
103 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
104 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
105 * Use a unique name, not an alias, for chat rooms. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
106 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
107 * Jabber lets you choose what name you want for chat. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
108 * So it shouldn't be pulling the alias for when you're in chat; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
109 * it gets annoying. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
110 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
111 OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
112 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
113 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
114 * Chat rooms have topics. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
115 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
116 * IRC and Jabber support this. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
117 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
118 OPT_PROTO_CHAT_TOPIC = 0x00000008, |
1370
776bb4c6c0b8
[gaim-migrate @ 1380]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1355
diff
changeset
|
119 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
120 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
121 * Don't require passwords for sign-in. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
122 * |
9999 | 123 * Zephyr doesn't require passwords, so there's no |
124 * need for a password prompt. | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
125 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
126 OPT_PROTO_NO_PASSWORD = 0x00000010, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
127 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
128 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
129 * Notify on new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
130 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
131 * MSN and Yahoo notify you when you have new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
132 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
133 OPT_PROTO_MAIL_CHECK = 0x00000020, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
134 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
135 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
136 * Images in IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
137 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
138 * Oscar lets you send images in direct IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
139 */ |
9999 | 140 OPT_PROTO_IM_IMAGE = 0x00000040, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
141 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
142 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
143 * Allow passwords to be optional. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
144 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
145 * Passwords in IRC are optional, and are needed for certain |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
146 * functionality. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
147 */ |
9999 | 148 OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
149 |
5367 | 150 /** |
151 * Allows font size to be specified in sane point size | |
152 * | |
153 * Probably just Jabber and Y!M | |
154 */ | |
9999 | 155 OPT_PROTO_USE_POINTSIZE = 0x00000100 |
5367 | 156 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
157 } GaimProtocolOptions; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
158 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
159 /** |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
160 * A protocol plugin information structure. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
161 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
162 * Every protocol plugin initializes this structure. It is the gateway |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
163 * between gaim and the protocol plugin. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
164 */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
165 struct _GaimPluginProtocolInfo |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
166 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
167 GaimProtocolOptions options; /**< Protocol options. */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
168 |
5638
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
169 GList *user_splits; /* A GList of GaimAccountUserSplit */ |
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
170 GList *protocol_options; /* A GList of GaimAccountOption */ |
9308 | 171 |
172 GaimBuddyIconSpec icon_spec; /* The icon spec. */ | |
173 | |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
174 /** |
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
175 * Returns the base icon name for the given buddy and account. |
4687 | 176 * If buddy is NULL, it will return the name to use for the account's icon |
177 */ | |
6695 | 178 const char *(*list_icon)(GaimAccount *account, GaimBuddy *buddy); |
4687 | 179 |
180 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
181 * Fills the four char**'s with string identifiers for "emblems" |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
182 * that the UI will interpret and display as relevant |
4687 | 183 */ |
9952 | 184 void (*list_emblems)(GaimBuddy *buddy, const char **se, const char **sw, |
185 const char **nw, const char **ne); | |
4722 | 186 |
187 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
188 * Gets a short string representing this buddy's status. This will |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
189 * be shown on the buddy list. |
4722 | 190 */ |
6695 | 191 char *(*status_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
192 |
4724 | 193 /** |
194 * Gets a string to put in the buddy list tooltip. | |
195 */ | |
6695 | 196 char *(*tooltip_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
197 |
9950 | 198 GList *(*status_types)(GaimAccount *account); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
199 |
9030 | 200 GList *(*blist_node_menu)(GaimBlistNode *node); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
201 GList *(*chat_info)(GaimConnection *); |
9754 | 202 GHashTable *(*chat_info_defaults)(GaimConnection *, const char *chat_name); |
1333
b332d8f46b84
[gaim-migrate @ 1343]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1318
diff
changeset
|
203 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
204 /* All the server-related functions */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
205 void (*login)(GaimAccount *); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
206 void (*close)(GaimConnection *); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
207 int (*send_im)(GaimConnection *, const char *who, |
6982 | 208 const char *message, |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
209 GaimConvImFlags flags); |
5954 | 210 void (*set_info)(GaimConnection *, const char *info); |
6059 | 211 int (*send_typing)(GaimConnection *, const char *name, int typing); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
212 void (*get_info)(GaimConnection *, const char *who); |
9949 | 213 void (*set_status)(GaimAccount *account, GaimStatus *status); |
214 | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
215 void (*set_idle)(GaimConnection *, int idletime); |
5946
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
216 void (*change_passwd)(GaimConnection *, const char *old_pass, |
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
217 const char *new_pass); |
9285 | 218 void (*add_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); |
219 void (*add_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
220 void (*remove_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); | |
221 void (*remove_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
222 void (*add_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
223 void (*add_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
224 void (*rem_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
225 void (*rem_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
226 void (*set_permit_deny)(GaimConnection *); |
9753 | 227 void (*warn)(GaimConnection *, const char *who, gboolean anonymous); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
228 void (*join_chat)(GaimConnection *, GHashTable *components); |
8562 | 229 void (*reject_chat)(GaimConnection *, GHashTable *components); |
9917 | 230 char *(*get_chat_name)(GHashTable *components); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
231 void (*chat_invite)(GaimConnection *, int id, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
232 const char *who, const char *message); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
233 void (*chat_leave)(GaimConnection *, int id); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
234 void (*chat_whisper)(GaimConnection *, int id, |
6059 | 235 const char *who, const char *message); |
236 int (*chat_send)(GaimConnection *, int id, const char *message); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
237 void (*keepalive)(GaimConnection *); |
1713
14caa7df478c
[gaim-migrate @ 1723]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1626
diff
changeset
|
238 |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
239 /* new user registration */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
240 void (*register_user)(GaimAccount *); |
2956 | 241 |
242 /* get "chat buddy" info and away message */ | |
6059 | 243 void (*get_cb_info)(GaimConnection *, int, const char *who); |
244 void (*get_cb_away)(GaimConnection *, int, const char *who); | |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
245 |
3136 | 246 /* save/store buddy's alias on server list/roster */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
247 void (*alias_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
248 const char *alias); |
3136 | 249 |
250 /* change a buddy's group on a server list/roster */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
251 void (*group_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
252 const char *old_group, const char *new_group); |
3136 | 253 |
3348 | 254 /* rename a group on a server list/roster */ |
9285 | 255 void (*rename_group)(GaimConnection *, const char *old_name, |
256 GaimGroup *group, GList *moved_buddies); | |
3348 | 257 |
6695 | 258 void (*buddy_free)(GaimBuddy *); |
2607
e0d4a23aac89
[gaim-migrate @ 2620]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2582
diff
changeset
|
259 |
6059 | 260 void (*convo_closed)(GaimConnection *, const char *who); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
261 |
7322 | 262 const char *(*normalize)(const GaimAccount *, const char *); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
263 |
5842 | 264 void (*set_buddy_icon)(GaimConnection *, const char *filename); |
6885
66dd420d3d23
[gaim-migrate @ 7431]
Christian Hammond <chipx86@chipx86.com>
parents:
6846
diff
changeset
|
265 |
9285 | 266 void (*remove_group)(GaimConnection *gc, GaimGroup *group); |
7398 | 267 |
268 char *(*get_cb_real_name)(GaimConnection *gc, int id, const char *who); | |
7971 | 269 |
270 void (*set_chat_topic)(GaimConnection *gc, int id, const char *topic); | |
7999 | 271 |
272 GaimChat *(*find_blist_chat)(GaimAccount *account, const char *name); | |
8113 | 273 |
274 /* room listing prpl callbacks */ | |
9999 | 275 GaimRoomlist *(*roomlist_get_list)(GaimConnection *gc); |
276 void (*roomlist_cancel)(GaimRoomlist *list); | |
277 void (*roomlist_expand_category)(GaimRoomlist *list, GaimRoomlistRoom *category); | |
9466 | 278 |
279 /* file transfer callbacks */ | |
280 gboolean (*can_receive_file)(GaimConnection *, const char *who); | |
281 void (*send_file)(GaimConnection *, const char *who, const char *filename); | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
282 }; |
2246
933346315b9b
[gaim-migrate @ 2256]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2232
diff
changeset
|
283 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
284 #define GAIM_IS_PROTOCOL_PLUGIN(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
285 ((plugin)->info->type == GAIM_PLUGIN_PROTOCOL) |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
286 |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
287 #define GAIM_PLUGIN_PROTOCOL_INFO(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
288 ((GaimPluginProtocolInfo *)(plugin)->info->extra_info) |
981 | 289 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
290 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
291 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
292 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
293 |
9944 | 294 /**************************************************************************/ |
295 /** @name Protocol Plugin API */ | |
296 /**************************************************************************/ | |
297 /*@{*/ | |
298 | |
299 /** | |
300 * Notifies Gaim that an account's idle state and time have changed. | |
301 * | |
302 * This is meant to be called from protocol plugins. | |
303 * | |
304 * @param account The account. | |
305 * @param idle The user's idle state. | |
306 * @param idle_time The user's idle time. | |
307 */ | |
308 void gaim_prpl_got_account_idle(GaimAccount *account, gboolean idle, | |
309 time_t idle_time); | |
310 | |
311 /** | |
312 * Notifies Gaim of an account's log-in time. | |
313 * | |
314 * This is meant to be called from protocol plugins. | |
315 * | |
316 * @param account The account the user is on. | |
317 * @param login_time The user's log-in time. | |
318 */ | |
319 void gaim_prpl_got_account_login_time(GaimAccount *account, const char *name, | |
320 time_t login_time); | |
321 | |
322 /** | |
323 * Notifies Gaim that an account's status has changed. | |
324 * | |
325 * This is meant to be called from protocol plugins. | |
326 * | |
327 * @param account The account the user is on. | |
328 * @param status_id The status ID. | |
329 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
330 * @param ... A NULL-terminated list of attribute IDs and values, | |
331 * beginning with the value for @a attr_id. | |
332 */ | |
333 void gaim_prpl_got_account_status(GaimAccount *account, | |
334 const char *status_id, const char *attr_id, | |
335 ...); | |
336 | |
337 /** | |
338 * Notifies Gaim that an account's warning level has changed. | |
339 * | |
340 * This is meant to be called from protocol plugins. | |
341 * | |
342 * @param account The account the user is on. | |
343 * @param username The user that warned the account. | |
344 * @param level The new warning level. | |
345 */ | |
346 void gaim_prpl_got_account_warning_level(GaimAccount *account, | |
347 const char *username, | |
348 unsigned int level); | |
349 | |
350 | |
351 /** | |
352 * Notifies Gaim that a user's idle state and time have changed. | |
353 * | |
354 * This is meant to be called from protocol plugins. | |
355 * | |
356 * @param account The account the user is on. | |
357 * @param name The screen name of the user. | |
358 * @param idle The user's idle state. | |
359 * @param idle_time The user's idle time. | |
360 */ | |
361 void gaim_prpl_got_user_idle(GaimAccount *account, const char *name, | |
362 gboolean idle, time_t idle_time); | |
363 | |
364 /** | |
365 * Notifies Gaim of a user's log-in time. | |
366 * | |
367 * This is meant to be called from protocol plugins. | |
368 * | |
369 * @param account The account the user is on. | |
370 * @param name The screen name of the user. | |
371 * @param login_time The user's log-in time. | |
372 */ | |
373 void gaim_prpl_got_user_login_time(GaimAccount *account, const char *name, | |
374 time_t login_time); | |
375 | |
376 /** | |
377 * Notifies Gaim that a user's status has changed. | |
378 * | |
379 * This is meant to be called from protocol plugins. | |
380 * | |
381 * @param account The account the user is on. | |
382 * @param name The screen name of the user. | |
383 * @param status_id The status ID. | |
384 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
385 * @param ... A NULL-terminated list of attribute IDs and values, | |
386 * beginning with the value for @a attr_id. | |
387 */ | |
388 void gaim_prpl_got_user_status(GaimAccount *account, const char *name, | |
389 const char *status_id, const char *attr_id, ...); | |
390 | |
391 /** | |
392 * Notifies Gaim that a user's warning level has changed. | |
393 * | |
394 * This is meant to be called from protocol plugins. | |
395 * | |
396 * @param account The account the user is on. | |
397 * @param name The screen name of the user. | |
398 * @param level The new warning level. | |
399 */ | |
400 void gaim_prpl_got_user_warning_level(GaimAccount *account, const char *name, | |
401 unsigned int level); | |
402 | |
403 /** | |
404 * Informs the server that an account's status changed. | |
405 * | |
406 * @param account The account the user is on. | |
407 * @param status The status that was activated, or deactivated | |
408 * (in the case of independent statuses). | |
409 */ | |
410 void gaim_prpl_set_account_status(GaimAccount *account, GaimStatus *status); | |
411 | |
10006 | 412 /** |
413 * Retrieves the list of stock status types from a prpl. | |
414 * | |
415 * @param account The account the user is on. | |
416 * @param presence The presence for which we're going to get statuses | |
417 * | |
418 * @return List of statuses | |
419 */ | |
420 GList *gaim_prpl_get_statuses(GaimAccount *account, GaimPresence *presence); | |
421 | |
9944 | 422 /*@}*/ |
423 | |
424 /**************************************************************************/ | |
425 /** @name Protocol Plugin Subsystem API */ | |
426 /**************************************************************************/ | |
427 /*@{*/ | |
428 | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
429 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
430 * Finds a protocol plugin structure of the specified type. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
431 * |
9000 | 432 * @param id The protocol plugin; |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
433 */ |
7956 | 434 GaimPlugin *gaim_find_prpl(const char *id); |
981 | 435 |
9944 | 436 /*@}*/ |
437 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
438 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
439 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
440 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
441 |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
442 #endif /* _PRPL_H_ */ |