00001
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030 #ifndef _PURPLE_PRPL_H_
00031 #define _PURPLE_PRPL_H_
00032
00033 typedef struct _PurplePluginProtocolInfo PurplePluginProtocolInfo;
00034 typedef struct _PurpleAttentionType PurpleAttentionType;
00035
00036
00038
00039
00040 typedef enum {
00041 PURPLE_ICON_SCALE_DISPLAY = 0x01,
00042 PURPLE_ICON_SCALE_SEND = 0x02
00043 } PurpleIconScaleRules;
00044
00045
00051 typedef struct _PurpleBuddyIconSpec PurpleBuddyIconSpec;
00052
00057 #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0, 0}
00058
00059 #ifdef HAVE_UNISTD_H
00060 #include <unistd.h>
00061 #endif
00062
00063 #include "blist.h"
00064 #include "conversation.h"
00065 #include "ft.h"
00066 #include "imgstore.h"
00067 #include "notify.h"
00068 #include "proxy.h"
00069 #include "plugin.h"
00070 #include "roomlist.h"
00071 #include "status.h"
00072 #include "whiteboard.h"
00073
00074 struct _PurpleBuddyIconSpec {
00075 char *format;
00078 int min_width;
00079 int min_height;
00080 int max_width;
00081 int max_height;
00082 size_t max_filesize;
00083 PurpleIconScaleRules scale_rules;
00084 };
00085
00086 struct proto_chat_entry {
00087 const char *label;
00088 const char *identifier;
00089 gboolean required;
00090 gboolean is_int;
00091 int min;
00092 int max;
00093 gboolean secret;
00094 };
00095
00096 struct _PurpleAttentionType
00097 {
00098 const char *name;
00099 const char *incoming_description;
00100 const char *outgoing_description;
00101 const char *icon_name;
00102 const char *unlocalized_name;
00104
00105 gpointer _reserved2;
00106 gpointer _reserved3;
00107 gpointer _reserved4;
00108 };
00109
00115 typedef enum
00116 {
00124 OPT_PROTO_UNIQUE_CHATNAME = 0x00000004,
00125
00131 OPT_PROTO_CHAT_TOPIC = 0x00000008,
00132
00139 OPT_PROTO_NO_PASSWORD = 0x00000010,
00140
00146 OPT_PROTO_MAIL_CHECK = 0x00000020,
00147
00153 OPT_PROTO_IM_IMAGE = 0x00000040,
00154
00161 OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080,
00162
00168 OPT_PROTO_USE_POINTSIZE = 0x00000100,
00169
00175 OPT_PROTO_REGISTER_NOSCREENNAME = 0x00000200,
00176
00181 OPT_PROTO_SLASH_COMMANDS_NATIVE = 0x00000400,
00182
00183 } PurpleProtocolOptions;
00184
00192 struct _PurplePluginProtocolInfo
00193 {
00194 PurpleProtocolOptions options;
00196 GList *user_splits;
00197 GList *protocol_options;
00199 PurpleBuddyIconSpec icon_spec;
00209 const char *(*list_icon)(PurpleAccount *account, PurpleBuddy *buddy);
00210
00215 const char *(*list_emblem)(PurpleBuddy *buddy);
00216
00221 char *(*status_text)(PurpleBuddy *buddy);
00222
00226 void (*tooltip_text)(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full);
00227
00233 GList *(*status_types)(PurpleAccount *account);
00234
00240 GList *(*blist_node_menu)(PurpleBlistNode *node);
00241 GList *(*chat_info)(PurpleConnection *);
00242 GHashTable *(*chat_info_defaults)(PurpleConnection *, const char *chat_name);
00243
00244
00245
00247 void (*login)(PurpleAccount *);
00248
00250 void (*close)(PurpleConnection *);
00251
00261 int (*send_im)(PurpleConnection *, const char *who,
00262 const char *message,
00263 PurpleMessageFlags flags);
00264
00265 void (*set_info)(PurpleConnection *, const char *info);
00266 unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state);
00271 void (*get_info)(PurpleConnection *, const char *who);
00272 void (*set_status)(PurpleAccount *account, PurpleStatus *status);
00273
00274 void (*set_idle)(PurpleConnection *, int idletime);
00275 void (*change_passwd)(PurpleConnection *, const char *old_pass,
00276 const char *new_pass);
00277 void (*add_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group);
00278 void (*add_buddies)(PurpleConnection *, GList *buddies, GList *groups);
00279 void (*remove_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group);
00280 void (*remove_buddies)(PurpleConnection *, GList *buddies, GList *groups);
00281 void (*add_permit)(PurpleConnection *, const char *name);
00282 void (*add_deny)(PurpleConnection *, const char *name);
00283 void (*rem_permit)(PurpleConnection *, const char *name);
00284 void (*rem_deny)(PurpleConnection *, const char *name);
00285 void (*set_permit_deny)(PurpleConnection *);
00286 void (*join_chat)(PurpleConnection *, GHashTable *components);
00287 void (*reject_chat)(PurpleConnection *, GHashTable *components);
00288 char *(*get_chat_name)(GHashTable *components);
00289 void (*chat_invite)(PurpleConnection *, int id,
00290 const char *message, const char *who);
00291 void (*chat_leave)(PurpleConnection *, int id);
00292 void (*chat_whisper)(PurpleConnection *, int id,
00293 const char *who, const char *message);
00294 int (*chat_send)(PurpleConnection *, int id, const char *message, PurpleMessageFlags flags);
00295
00302 void (*keepalive)(PurpleConnection *);
00303
00305 void (*register_user)(PurpleAccount *);
00306
00310 void (*get_cb_info)(PurpleConnection *, int, const char *who);
00315 void (*get_cb_away)(PurpleConnection *, int, const char *who);
00316
00318 void (*alias_buddy)(PurpleConnection *, const char *who,
00319 const char *alias);
00320
00322 void (*group_buddy)(PurpleConnection *, const char *who,
00323 const char *old_group, const char *new_group);
00324
00326 void (*rename_group)(PurpleConnection *, const char *old_name,
00327 PurpleGroup *group, GList *moved_buddies);
00328
00329 void (*buddy_free)(PurpleBuddy *);
00330
00331 void (*convo_closed)(PurpleConnection *, const char *who);
00332
00338 const char *(*normalize)(const PurpleAccount *, const char *who);
00339
00345 void (*set_buddy_icon)(PurpleConnection *, PurpleStoredImage *img);
00346
00347 void (*remove_group)(PurpleConnection *gc, PurpleGroup *group);
00348
00358 char *(*get_cb_real_name)(PurpleConnection *gc, int id, const char *who);
00359
00360 void (*set_chat_topic)(PurpleConnection *gc, int id, const char *topic);
00361
00362 PurpleChat *(*find_blist_chat)(PurpleAccount *account, const char *name);
00363
00364
00365 PurpleRoomlist *(*roomlist_get_list)(PurpleConnection *gc);
00366 void (*roomlist_cancel)(PurpleRoomlist *list);
00367 void (*roomlist_expand_category)(PurpleRoomlist *list, PurpleRoomlistRoom *category);
00368
00369
00370 gboolean (*can_receive_file)(PurpleConnection *, const char *who);
00371 void (*send_file)(PurpleConnection *, const char *who, const char *filename);
00372 PurpleXfer *(*new_xfer)(PurpleConnection *, const char *who);
00373
00378 gboolean (*offline_message)(const PurpleBuddy *buddy);
00379
00380 PurpleWhiteboardPrplOps *whiteboard_prpl_ops;
00381
00383 int (*send_raw)(PurpleConnection *gc, const char *buf, int len);
00384
00385
00386 char *(*roomlist_room_serialize)(PurpleRoomlistRoom *room);
00387
00392
00393
00394
00395 void (*unregister_user)(PurpleAccount *, PurpleAccountUnregistrationCb cb, void *user_data);
00396
00397
00398 gboolean (*send_attention)(PurpleConnection *gc, const char *username, guint type);
00399 GList *(*get_attention_types)(PurpleAccount *acct);
00400
00401 void (*_purple_reserved4)(void);
00402 };
00403
00404 #define PURPLE_IS_PROTOCOL_PLUGIN(plugin) \
00405 ((plugin)->info->type == PURPLE_PLUGIN_PROTOCOL)
00406
00407 #define PURPLE_PLUGIN_PROTOCOL_INFO(plugin) \
00408 ((PurplePluginProtocolInfo *)(plugin)->info->extra_info)
00409
00410 #ifdef __cplusplus
00411 extern "C" {
00412 #endif
00413
00414
00416
00432 PurpleAttentionType *purple_attention_type_new(const char *ulname, const char *name,
00433 const char *inc_desc, const char *out_desc);
00434
00444 void purple_attention_type_set_name(PurpleAttentionType *type, const char *name);
00445
00454 void purple_attention_type_set_incoming_desc(PurpleAttentionType *type, const char *desc);
00455
00464 void purple_attention_type_set_outgoing_desc(PurpleAttentionType *type, const char *desc);
00465
00474 void purple_attention_type_set_icon_name(PurpleAttentionType *type, const char *name);
00475
00485 void purple_attention_type_set_unlocalized_name(PurpleAttentionType *type, const char *ulname);
00486
00494 const char *purple_attention_type_get_name(const PurpleAttentionType *type);
00495
00503 const char *purple_attention_type_get_incoming_desc(const PurpleAttentionType *type);
00504
00512 const char *purple_attention_type_get_outgoing_desc(const PurpleAttentionType *type);
00513
00522 const char *purple_attention_type_get_icon_name(const PurpleAttentionType *type);
00523
00531 const char *purple_attention_type_get_unlocalized_name(const PurpleAttentionType *type);
00532
00535
00537
00549 void purple_prpl_got_account_idle(PurpleAccount *account, gboolean idle,
00550 time_t idle_time);
00551
00560 void purple_prpl_got_account_login_time(PurpleAccount *account, time_t login_time);
00561
00572 void purple_prpl_got_account_status(PurpleAccount *account,
00573 const char *status_id, ...) G_GNUC_NULL_TERMINATED;
00586 void purple_prpl_got_user_idle(PurpleAccount *account, const char *name,
00587 gboolean idle, time_t idle_time);
00588
00598 void purple_prpl_got_user_login_time(PurpleAccount *account, const char *name,
00599 time_t login_time);
00600
00612 void purple_prpl_got_user_status(PurpleAccount *account, const char *name,
00613 const char *status_id, ...) G_GNUC_NULL_TERMINATED;
00614
00624 void purple_prpl_got_user_status_deactive(PurpleAccount *account, const char *name,
00625 const char *status_id);
00626
00635 void purple_prpl_change_account_status(PurpleAccount *account,
00636 PurpleStatus *old_status,
00637 PurpleStatus *new_status);
00638
00647 GList *purple_prpl_get_statuses(PurpleAccount *account, PurplePresence *presence);
00648
00651
00653
00661 PurplePlugin *purple_find_prpl(const char *id);
00662
00665 #ifdef __cplusplus
00666 }
00667 #endif
00668
00669 #endif