Mercurial > pidgin
view libpurple/prpl.h @ 18338:466f933f4a6b
merge of '3063645a233865eda6b7df4cb96b20845a76c2e3'
and 'd15e93f9dc9615b125f858391e7f047eb1c9f6e5'
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Thu, 28 Jun 2007 06:13:28 +0000 |
parents | 72906c5ac037 |
children | 5c1ed6296b56 0f46f13c0805 f12bf92d64ec |
line wrap: on
line source
/** * @file prpl.h Protocol Plugin functions * @ingroup core * * purple * * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* this file should be all that prpls need to include. therefore, by including * this file, they should get glib, proxy, purple_connection, prpl, etc. */ #ifndef _PURPLE_PRPL_H_ #define _PURPLE_PRPL_H_ typedef struct _PurplePluginProtocolInfo PurplePluginProtocolInfo; /**************************************************************************/ /** @name Basic Protocol Information */ /**************************************************************************/ typedef enum { PURPLE_ICON_SCALE_DISPLAY = 0x01, /**< We scale the icon when we display it */ PURPLE_ICON_SCALE_SEND = 0x02 /**< We scale the icon before we send it to the server */ } PurpleIconScaleRules; /** * A description of a Buddy Icon specification. This tells Purple what kind of image file * it should give this prpl, and what kind of image file it should expect back. * Dimensions less than 1 should be ignored and the image not scaled. */ typedef struct _PurpleBuddyIconSpec PurpleBuddyIconSpec; /** * This \#define exists just to make it easier to fill out the buddy icon * field in the prpl info struct for protocols that couldn't care less. */ #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0, 0} #ifdef HAVE_UNISTD_H #include <unistd.h> #endif #include "blist.h" #include "conversation.h" #include "ft.h" #include "imgstore.h" #include "notify.h" #include "proxy.h" #include "plugin.h" #include "roomlist.h" #include "status.h" #include "whiteboard.h" struct _PurpleBuddyIconSpec { char *format; /**< This is a comma-delimited list of image formats or NULL if icons are not supported. * Neither the core nor the prpl will actually check to see if the data it's given matches this; it's * entirely up to the UI to do what it wants */ int min_width; /**< The minimum width of this icon */ int min_height; /**< The minimum height of this icon */ int max_width; /**< The maximum width of this icon */ int max_height; /**< The maximum height of this icon */ size_t max_filesize; /**< The maximum number of bytes */ PurpleIconScaleRules scale_rules; /**< How to stretch this icon */ }; struct proto_chat_entry { const char *label; const char *identifier; gboolean required; gboolean is_int; int min; int max; gboolean secret; }; /** * Protocol options * * These should all be stuff that some plugins can do and others can't. */ typedef enum { /** * Use a unique name, not an alias, for chat rooms. * * XMPP lets you choose what name you want for chat. * So it shouldn't be pulling the alias for when you're in chat; * it gets annoying. */ OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, /** * Chat rooms have topics. * * IRC and XMPP support this. */ OPT_PROTO_CHAT_TOPIC = 0x00000008, /** * Don't require passwords for sign-in. * * Zephyr doesn't require passwords, so there's no * need for a password prompt. */ OPT_PROTO_NO_PASSWORD = 0x00000010, /** * Notify on new mail. * * MSN and Yahoo notify you when you have new mail. */ OPT_PROTO_MAIL_CHECK = 0x00000020, /** * Images in IMs. * * Oscar lets you send images in direct IMs. */ OPT_PROTO_IM_IMAGE = 0x00000040, /** * Allow passwords to be optional. * * Passwords in IRC are optional, and are needed for certain * functionality. */ OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080, /** * Allows font size to be specified in sane point size * * Probably just XMPP and Y!M */ OPT_PROTO_USE_POINTSIZE = 0x00000100, /** * Set the Register button active when screenname is not given. * * Gadu-Gadu doesn't need a screenname to register new account. */ OPT_PROTO_REGISTER_NOSCREENNAME = 0x00000200, /** * Indicates that slash commands are native to this protocol. * Used as a hint that unknown commands should not be sent as messages. */ OPT_PROTO_SLASH_COMMANDS_NATIVE = 0x00000400, } PurpleProtocolOptions; /** * A protocol plugin information structure. * * Every protocol plugin initializes this structure. It is the gateway * between purple and the protocol plugin. Many of this callbacks can be * NULL. If a callback must be implemented, it has a comment indicating so. */ struct _PurplePluginProtocolInfo { PurpleProtocolOptions options; /**< Protocol options. */ GList *user_splits; /* A GList of PurpleAccountUserSplit */ GList *protocol_options; /* A GList of PurpleAccountOption */ PurpleBuddyIconSpec icon_spec; /* The icon spec. */ /** * Returns the base icon name for the given buddy and account. * If buddy is NULL and the account is non-NULL, it will return the * name to use for the account's icon. If both are NULL, it will * return the name to use for the protocol's icon. * * This must be implemented. */ const char *(*list_icon)(PurpleAccount *account, PurpleBuddy *buddy); /** * Fills the four char**'s with string identifiers for "emblems" * that the UI will interpret and display as relevant */ const char *(*list_emblem)(PurpleBuddy *buddy); /** * Gets a short string representing this buddy's status. This will * be shown on the buddy list. */ char *(*status_text)(PurpleBuddy *buddy); /** * Allows the prpl to add text to a buddy's tooltip. */ void (*tooltip_text)(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full); /** * This must be implemented, and must add at least the offline * and online states. */ GList *(*status_types)(PurpleAccount *account); GList *(*blist_node_menu)(PurpleBlistNode *node); GList *(*chat_info)(PurpleConnection *); GHashTable *(*chat_info_defaults)(PurpleConnection *, const char *chat_name); /* All the server-related functions */ /** This must be implemented. */ void (*login)(PurpleAccount *); /** This must be implemented. */ void (*close)(PurpleConnection *); /** * This PRPL function should return a positive value on success. * If the message is too big to be sent, return -E2BIG. If * the account is not connected, return -ENOTCONN. If the * PRPL is unable to send the message for another reason, return * some other negative value. You can use one of the valid * errno values, or just big something. If the message should * not be echoed to the conversation window, return 0. */ int (*send_im)(PurpleConnection *, const char *who, const char *message, PurpleMessageFlags flags); void (*set_info)(PurpleConnection *, const char *info); unsigned int (*send_typing)(PurpleConnection *, const char *name, PurpleTypingState state); void (*get_info)(PurpleConnection *, const char *who); void (*set_status)(PurpleAccount *account, PurpleStatus *status); void (*set_idle)(PurpleConnection *, int idletime); void (*change_passwd)(PurpleConnection *, const char *old_pass, const char *new_pass); void (*add_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group); void (*add_buddies)(PurpleConnection *, GList *buddies, GList *groups); void (*remove_buddy)(PurpleConnection *, PurpleBuddy *buddy, PurpleGroup *group); void (*remove_buddies)(PurpleConnection *, GList *buddies, GList *groups); void (*add_permit)(PurpleConnection *, const char *name); void (*add_deny)(PurpleConnection *, const char *name); void (*rem_permit)(PurpleConnection *, const char *name); void (*rem_deny)(PurpleConnection *, const char *name); void (*set_permit_deny)(PurpleConnection *); void (*join_chat)(PurpleConnection *, GHashTable *components); void (*reject_chat)(PurpleConnection *, GHashTable *components); char *(*get_chat_name)(GHashTable *components); void (*chat_invite)(PurpleConnection *, int id, const char *message, const char *who); void (*chat_leave)(PurpleConnection *, int id); void (*chat_whisper)(PurpleConnection *, int id, const char *who, const char *message); int (*chat_send)(PurpleConnection *, int id, const char *message, PurpleMessageFlags flags); void (*keepalive)(PurpleConnection *); /* new user registration */ void (*register_user)(PurpleAccount *); /* get "chat buddy" info and away message */ void (*get_cb_info)(PurpleConnection *, int, const char *who); void (*get_cb_away)(PurpleConnection *, int, const char *who); /* save/store buddy's alias on server list/roster */ void (*alias_buddy)(PurpleConnection *, const char *who, const char *alias); /* change a buddy's group on a server list/roster */ void (*group_buddy)(PurpleConnection *, const char *who, const char *old_group, const char *new_group); /* rename a group on a server list/roster */ void (*rename_group)(PurpleConnection *, const char *old_name, PurpleGroup *group, GList *moved_buddies); void (*buddy_free)(PurpleBuddy *); void (*convo_closed)(PurpleConnection *, const char *who); const char *(*normalize)(const PurpleAccount *, const char *); /* The prpl does NOT own a reference to img. If it needs one, it * must purple_imgstore_ref(img) itself. */ void (*set_buddy_icon)(PurpleConnection *, PurpleStoredImage *img); void (*remove_group)(PurpleConnection *gc, PurpleGroup *group); char *(*get_cb_real_name)(PurpleConnection *gc, int id, const char *who); void (*set_chat_topic)(PurpleConnection *gc, int id, const char *topic); PurpleChat *(*find_blist_chat)(PurpleAccount *account, const char *name); /* room listing prpl callbacks */ PurpleRoomlist *(*roomlist_get_list)(PurpleConnection *gc); void (*roomlist_cancel)(PurpleRoomlist *list); void (*roomlist_expand_category)(PurpleRoomlist *list, PurpleRoomlistRoom *category); /* file transfer callbacks */ gboolean (*can_receive_file)(PurpleConnection *, const char *who); void (*send_file)(PurpleConnection *, const char *who, const char *filename); PurpleXfer *(*new_xfer)(PurpleConnection *, const char *who); gboolean (*offline_message)(const PurpleBuddy *buddy); PurpleWhiteboardPrplOps *whiteboard_prpl_ops; /* For use in plugins that may understand the underlying protocol */ int (*send_raw)(PurpleConnection *gc, const char *buf, int len); /* room list serialize */ char *(*roomlist_room_serialize)(PurpleRoomlistRoom *room); void (*_purple_reserved1)(void); void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); }; #define PURPLE_IS_PROTOCOL_PLUGIN(plugin) \ ((plugin)->info->type == PURPLE_PLUGIN_PROTOCOL) #define PURPLE_PLUGIN_PROTOCOL_INFO(plugin) \ ((PurplePluginProtocolInfo *)(plugin)->info->extra_info) #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name Protocol Plugin API */ /**************************************************************************/ /*@{*/ /** * Notifies Purple that an account's idle state and time have changed. * * This is meant to be called from protocol plugins. * * @param account The account. * @param idle The user's idle state. * @param idle_time The user's idle time. */ void purple_prpl_got_account_idle(PurpleAccount *account, gboolean idle, time_t idle_time); /** * Notifies Purple of an account's log-in time. * * This is meant to be called from protocol plugins. * * @param account The account the user is on. * @param login_time The user's log-in time. */ void purple_prpl_got_account_login_time(PurpleAccount *account, time_t login_time); /** * Notifies Purple that an account's status has changed. * * This is meant to be called from protocol plugins. * * @param account The account the user is on. * @param status_id The status ID. * @param ... A NULL-terminated list of attribute IDs and values, * beginning with the value for @a attr_id. */ void purple_prpl_got_account_status(PurpleAccount *account, const char *status_id, ...) G_GNUC_NULL_TERMINATED; /** * Notifies Purple that a user's idle state and time have changed. * * This is meant to be called from protocol plugins. * * @param account The account the user is on. * @param name The screen name of the user. * @param idle The user's idle state. * @param idle_time The user's idle time. This is the time at * which the user became idle, in seconds since * the epoch. */ void purple_prpl_got_user_idle(PurpleAccount *account, const char *name, gboolean idle, time_t idle_time); /** * Notifies Purple of a user's log-in time. * * This is meant to be called from protocol plugins. * * @param account The account the user is on. * @param name The screen name of the user. * @param login_time The user's log-in time. */ void purple_prpl_got_user_login_time(PurpleAccount *account, const char *name, time_t login_time); /** * Notifies Purple that a user's status has been activated. * * This is meant to be called from protocol plugins. * * @param account The account the user is on. * @param name The screen name of the user. * @param status_id The status ID. * @param ... A NULL-terminated list of attribute IDs and values, * beginning with the value for @a attr_id. */ void purple_prpl_got_user_status(PurpleAccount *account, const char *name, const char *status_id, ...) G_GNUC_NULL_TERMINATED; /** * Notifies libpurple that a user's status has been deactivated * * This is meant to be called from protocol plugins. * * @param account The account the user is on. * @param name The screen name of the user. * @param status_id The status ID. */ void purple_prpl_got_user_status_deactive(PurpleAccount *account, const char *name, const char *status_id); /** * Informs the server that an account's status changed. * * @param account The account the user is on. * @param old_status The previous status. * @param new_status The status that was activated, or deactivated * (in the case of independent statuses). */ void purple_prpl_change_account_status(PurpleAccount *account, PurpleStatus *old_status, PurpleStatus *new_status); /** * Retrieves the list of stock status types from a prpl. * * @param account The account the user is on. * @param presence The presence for which we're going to get statuses * * @return List of statuses */ GList *purple_prpl_get_statuses(PurpleAccount *account, PurplePresence *presence); /*@}*/ /**************************************************************************/ /** @name Protocol Plugin Subsystem API */ /**************************************************************************/ /*@{*/ /** * Finds a protocol plugin structure of the specified type. * * @param id The protocol plugin; */ PurplePlugin *purple_find_prpl(const char *id); /*@}*/ #ifdef __cplusplus } #endif #endif /* _PRPL_H_ */