Mercurial > pidgin.yaz
annotate src/prpl.h @ 11460:d68ca756e983
[gaim-migrate @ 13699]
Don't double-up non-aliased users in the tab completion list.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Tue, 06 Sep 2005 05:39:53 +0000 |
parents | 201617d49573 |
children | a147a8a05678 |
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.*/ | |
10104 | 50 GAIM_CONV_CHAT_DELAYED = 0x0002, /**< Delayed message. */ |
51 GAIM_CONV_CHAT_ALERT = 0x0004 /**< Alert message. */ | |
9584 | 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 /** |
11035
11e465b55fe6
[gaim-migrate @ 12922]
Gary Kramlich <grim@reaperworld.com>
parents:
10870
diff
changeset
|
77 * This \#define exists just to make it easier to fill out the buddy icon |
9999 | 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; | |
10475 | 91 gboolean required; |
9713 | 92 gboolean is_int; |
93 int min; | |
94 int max; | |
95 gboolean secret; | |
96 }; | |
97 | |
6622 | 98 /** |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
99 * Protocol options |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
100 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
101 * 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
|
102 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
103 typedef enum |
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 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
106 * Use a unique name, not an alias, for chat rooms. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
107 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
108 * Jabber lets you choose what name you want for chat. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
109 * 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
|
110 * it gets annoying. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
111 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
112 OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, |
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 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
115 * Chat rooms have topics. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
116 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
117 * IRC and Jabber support this. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
118 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
119 OPT_PROTO_CHAT_TOPIC = 0x00000008, |
1370
776bb4c6c0b8
[gaim-migrate @ 1380]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1355
diff
changeset
|
120 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
121 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
122 * Don't require passwords for sign-in. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
123 * |
9999 | 124 * Zephyr doesn't require passwords, so there's no |
125 * need for a password prompt. | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
126 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
127 OPT_PROTO_NO_PASSWORD = 0x00000010, |
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 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
130 * Notify on new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
131 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
132 * MSN and Yahoo notify you when you have new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
133 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
134 OPT_PROTO_MAIL_CHECK = 0x00000020, |
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 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
137 * Images in IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
138 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
139 * Oscar lets you send images in direct IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
140 */ |
9999 | 141 OPT_PROTO_IM_IMAGE = 0x00000040, |
4557
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 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
144 * Allow passwords to be optional. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
145 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
146 * Passwords in IRC are optional, and are needed for certain |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
147 * functionality. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
148 */ |
9999 | 149 OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
150 |
5367 | 151 /** |
152 * Allows font size to be specified in sane point size | |
153 * | |
154 * Probably just Jabber and Y!M | |
155 */ | |
11358 | 156 OPT_PROTO_USE_POINTSIZE = 0x00000100, |
157 | |
158 /** | |
159 * Set the Register button active when screenname is not given. | |
160 * | |
161 * Gadu-Gadu doesn't need a screenname to register new account. | |
162 */ | |
163 OPT_PROTO_REGISTER_NOSCREENNAME = 0x00000200, | |
5367 | 164 |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
165 /** |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
166 * Chats use the display name for "my" nickname. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
167 * |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
168 * IRC uses the user's current nickname in the chat list, not the |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
169 * username that's been setup for the account. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
170 */ |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
171 OPT_PROTO_USE_DISPLAY_NAME_FOR_ME_IN_CHATS = 0x00000200 |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11358
diff
changeset
|
172 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
173 } GaimProtocolOptions; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
174 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
175 /** |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
176 * A protocol plugin information structure. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
177 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
178 * Every protocol plugin initializes this structure. It is the gateway |
10160 | 179 * between gaim and the protocol plugin. Many of this callbacks can be |
10162 | 180 * NULL. If a callback must be implemented, it has a comment indicating so. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
181 */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
182 struct _GaimPluginProtocolInfo |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
183 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
184 GaimProtocolOptions options; /**< Protocol options. */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
185 |
5638
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
186 GList *user_splits; /* A GList of GaimAccountUserSplit */ |
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
187 GList *protocol_options; /* A GList of GaimAccountOption */ |
10160 | 188 |
9308 | 189 GaimBuddyIconSpec icon_spec; /* The icon spec. */ |
10160 | 190 |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
191 /** |
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
192 * Returns the base icon name for the given buddy and account. |
10160 | 193 * If buddy is NULL, it will return the name to use for the account's |
194 * icon. This must be implemented. | |
4687 | 195 */ |
6695 | 196 const char *(*list_icon)(GaimAccount *account, GaimBuddy *buddy); |
4687 | 197 |
198 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
199 * Fills the four char**'s with string identifiers for "emblems" |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
200 * that the UI will interpret and display as relevant |
4687 | 201 */ |
9952 | 202 void (*list_emblems)(GaimBuddy *buddy, const char **se, const char **sw, |
203 const char **nw, const char **ne); | |
4722 | 204 |
205 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
206 * Gets a short string representing this buddy's status. This will |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
207 * be shown on the buddy list. |
4722 | 208 */ |
6695 | 209 char *(*status_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
210 |
4724 | 211 /** |
212 * Gets a string to put in the buddy list tooltip. | |
213 */ | |
6695 | 214 char *(*tooltip_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
215 |
10200 | 216 /** |
217 * This must be implemented, and must add at least the offline | |
218 * and online states. | |
219 */ | |
9950 | 220 GList *(*status_types)(GaimAccount *account); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
221 |
9030 | 222 GList *(*blist_node_menu)(GaimBlistNode *node); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
223 GList *(*chat_info)(GaimConnection *); |
9754 | 224 GHashTable *(*chat_info_defaults)(GaimConnection *, const char *chat_name); |
1333
b332d8f46b84
[gaim-migrate @ 1343]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1318
diff
changeset
|
225 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
226 /* All the server-related functions */ |
10160 | 227 |
228 /** This must be implemented. */ | |
10400 | 229 void (*login)(GaimAccount *, GaimStatus *); |
10160 | 230 |
231 /** This must be implemented. */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
232 void (*close)(GaimConnection *); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
233 int (*send_im)(GaimConnection *, const char *who, |
6982 | 234 const char *message, |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
235 GaimConvImFlags flags); |
5954 | 236 void (*set_info)(GaimConnection *, const char *info); |
6059 | 237 int (*send_typing)(GaimConnection *, const char *name, int typing); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
238 void (*get_info)(GaimConnection *, const char *who); |
9949 | 239 void (*set_status)(GaimAccount *account, GaimStatus *status); |
240 | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
241 void (*set_idle)(GaimConnection *, int idletime); |
5946
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
242 void (*change_passwd)(GaimConnection *, const char *old_pass, |
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
243 const char *new_pass); |
9285 | 244 void (*add_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); |
245 void (*add_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
246 void (*remove_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); | |
247 void (*remove_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
248 void (*add_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
249 void (*add_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
250 void (*rem_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
251 void (*rem_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
252 void (*set_permit_deny)(GaimConnection *); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
253 void (*join_chat)(GaimConnection *, GHashTable *components); |
8562 | 254 void (*reject_chat)(GaimConnection *, GHashTable *components); |
9917 | 255 char *(*get_chat_name)(GHashTable *components); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
256 void (*chat_invite)(GaimConnection *, int id, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
257 const char *who, const char *message); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
258 void (*chat_leave)(GaimConnection *, int id); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
259 void (*chat_whisper)(GaimConnection *, int id, |
6059 | 260 const char *who, const char *message); |
261 int (*chat_send)(GaimConnection *, int id, const char *message); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
262 void (*keepalive)(GaimConnection *); |
1713
14caa7df478c
[gaim-migrate @ 1723]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1626
diff
changeset
|
263 |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
264 /* new user registration */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
265 void (*register_user)(GaimAccount *); |
2956 | 266 |
267 /* get "chat buddy" info and away message */ | |
6059 | 268 void (*get_cb_info)(GaimConnection *, int, const char *who); |
269 void (*get_cb_away)(GaimConnection *, int, const char *who); | |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
270 |
3136 | 271 /* save/store buddy's alias on server list/roster */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
272 void (*alias_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
273 const char *alias); |
3136 | 274 |
275 /* change a buddy's group on a server list/roster */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
276 void (*group_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
277 const char *old_group, const char *new_group); |
3136 | 278 |
3348 | 279 /* rename a group on a server list/roster */ |
9285 | 280 void (*rename_group)(GaimConnection *, const char *old_name, |
281 GaimGroup *group, GList *moved_buddies); | |
3348 | 282 |
6695 | 283 void (*buddy_free)(GaimBuddy *); |
2607
e0d4a23aac89
[gaim-migrate @ 2620]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2582
diff
changeset
|
284 |
6059 | 285 void (*convo_closed)(GaimConnection *, const char *who); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
286 |
7322 | 287 const char *(*normalize)(const GaimAccount *, const char *); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
288 |
5842 | 289 void (*set_buddy_icon)(GaimConnection *, const char *filename); |
6885
66dd420d3d23
[gaim-migrate @ 7431]
Christian Hammond <chipx86@chipx86.com>
parents:
6846
diff
changeset
|
290 |
9285 | 291 void (*remove_group)(GaimConnection *gc, GaimGroup *group); |
7398 | 292 |
293 char *(*get_cb_real_name)(GaimConnection *gc, int id, const char *who); | |
7971 | 294 |
295 void (*set_chat_topic)(GaimConnection *gc, int id, const char *topic); | |
7999 | 296 |
297 GaimChat *(*find_blist_chat)(GaimAccount *account, const char *name); | |
8113 | 298 |
299 /* room listing prpl callbacks */ | |
9999 | 300 GaimRoomlist *(*roomlist_get_list)(GaimConnection *gc); |
301 void (*roomlist_cancel)(GaimRoomlist *list); | |
302 void (*roomlist_expand_category)(GaimRoomlist *list, GaimRoomlistRoom *category); | |
9466 | 303 |
304 /* file transfer callbacks */ | |
305 gboolean (*can_receive_file)(GaimConnection *, const char *who); | |
306 void (*send_file)(GaimConnection *, const char *who, const char *filename); | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
307 }; |
2246
933346315b9b
[gaim-migrate @ 2256]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2232
diff
changeset
|
308 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
309 #define GAIM_IS_PROTOCOL_PLUGIN(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
310 ((plugin)->info->type == GAIM_PLUGIN_PROTOCOL) |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
311 |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
312 #define GAIM_PLUGIN_PROTOCOL_INFO(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
313 ((GaimPluginProtocolInfo *)(plugin)->info->extra_info) |
981 | 314 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
315 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
316 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
317 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
318 |
9944 | 319 /**************************************************************************/ |
320 /** @name Protocol Plugin API */ | |
321 /**************************************************************************/ | |
322 /*@{*/ | |
323 | |
324 /** | |
325 * Notifies Gaim that an account's idle state and time have changed. | |
326 * | |
327 * This is meant to be called from protocol plugins. | |
328 * | |
329 * @param account The account. | |
330 * @param idle The user's idle state. | |
331 * @param idle_time The user's idle time. | |
332 */ | |
333 void gaim_prpl_got_account_idle(GaimAccount *account, gboolean idle, | |
334 time_t idle_time); | |
335 | |
336 /** | |
337 * Notifies Gaim of an account's log-in time. | |
338 * | |
339 * This is meant to be called from protocol plugins. | |
340 * | |
341 * @param account The account the user is on. | |
342 * @param login_time The user's log-in time. | |
343 */ | |
10870 | 344 void gaim_prpl_got_account_login_time(GaimAccount *account, time_t login_time); |
9944 | 345 |
346 /** | |
347 * Notifies Gaim that an account's status has changed. | |
348 * | |
349 * This is meant to be called from protocol plugins. | |
350 * | |
351 * @param account The account the user is on. | |
352 * @param status_id The status ID. | |
353 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
354 * @param ... A NULL-terminated list of attribute IDs and values, | |
355 * beginning with the value for @a attr_id. | |
356 */ | |
357 void gaim_prpl_got_account_status(GaimAccount *account, | |
358 const char *status_id, const char *attr_id, | |
359 ...); | |
360 /** | |
361 * Notifies Gaim that a user's idle state and time have changed. | |
362 * | |
363 * This is meant to be called from protocol plugins. | |
364 * | |
365 * @param account The account the user is on. | |
366 * @param name The screen name of the user. | |
367 * @param idle The user's idle state. | |
10860 | 368 * @param idle_time The user's idle time. This is the time at |
369 * which the user became idle, in seconds since | |
370 * the epoch. | |
9944 | 371 */ |
372 void gaim_prpl_got_user_idle(GaimAccount *account, const char *name, | |
373 gboolean idle, time_t idle_time); | |
374 | |
375 /** | |
376 * Notifies Gaim of a user's log-in time. | |
377 * | |
378 * This is meant to be called from protocol plugins. | |
379 * | |
380 * @param account The account the user is on. | |
381 * @param name The screen name of the user. | |
382 * @param login_time The user's log-in time. | |
383 */ | |
384 void gaim_prpl_got_user_login_time(GaimAccount *account, const char *name, | |
385 time_t login_time); | |
386 | |
387 /** | |
388 * Notifies Gaim that a user's status has changed. | |
389 * | |
390 * This is meant to be called from protocol plugins. | |
391 * | |
392 * @param account The account the user is on. | |
393 * @param name The screen name of the user. | |
394 * @param status_id The status ID. | |
395 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
396 * @param ... A NULL-terminated list of attribute IDs and values, | |
397 * beginning with the value for @a attr_id. | |
398 */ | |
399 void gaim_prpl_got_user_status(GaimAccount *account, const char *name, | |
400 const char *status_id, const char *attr_id, ...); | |
401 /** | |
402 * Informs the server that an account's status changed. | |
403 * | |
10447 | 404 * @param account The account the user is on. |
405 * @param old_status The previous status. | |
406 * @param new_status The status that was activated, or deactivated | |
407 * (in the case of independent statuses). | |
9944 | 408 */ |
10447 | 409 void gaim_prpl_change_account_status(GaimAccount *account, |
410 GaimStatus *old_status, | |
411 GaimStatus *new_status); | |
9944 | 412 |
10006 | 413 /** |
414 * Retrieves the list of stock status types from a prpl. | |
415 * | |
416 * @param account The account the user is on. | |
417 * @param presence The presence for which we're going to get statuses | |
418 * | |
419 * @return List of statuses | |
420 */ | |
421 GList *gaim_prpl_get_statuses(GaimAccount *account, GaimPresence *presence); | |
422 | |
9944 | 423 /*@}*/ |
424 | |
425 /**************************************************************************/ | |
426 /** @name Protocol Plugin Subsystem API */ | |
427 /**************************************************************************/ | |
428 /*@{*/ | |
429 | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
430 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
431 * Finds a protocol plugin structure of the specified type. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
432 * |
9000 | 433 * @param id The protocol plugin; |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
434 */ |
7956 | 435 GaimPlugin *gaim_find_prpl(const char *id); |
981 | 436 |
9944 | 437 /*@}*/ |
438 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
439 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
440 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
441 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
442 |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
443 #endif /* _PRPL_H_ */ |