Mercurial > pidgin
view libpurple/status.h @ 17658:4f65f25f9447
Update for (future) 0.8.
author | Jeffrey Connelly <jaconnel@calpoly.edu> |
---|---|
date | Sun, 24 Jun 2007 05:07:43 +0000 |
parents | 08b9f27cf219 |
children | 759cd72bd2ff ab6d2763b8d8 |
line wrap: on
line source
/* * 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 */ #ifndef _PURPLE_STATUS_H_ #define _PURPLE_STATUS_H_ /** * @file status.h Status API * @ingroup core * * A brief explanation of the status API: * * PurpleStatusType's are created by each PRPL. They outline the * available statuses of the protocol. AIM, for example, supports * an available state with an optional available message, an away * state with a mandatory message, and an invisible state (which is * technically "independent" of the other two, but we'll get into * that later). PurpleStatusTypes are very permanent. They are * hardcoded in each PRPL and will not change often. And because * they are hardcoded, they do not need to be saved to any XML file. * * A PurpleStatus can be thought of as an "instance" of a PurpleStatusType. * If you're familiar with object-oriented programming languages * then this should be immediately clear. Say, for example, that * one of your AIM buddies has set himself as "away." You have a * PurpleBuddy node for this person in your buddy list. Purple wants * to mark this buddy as "away," so it creates a new PurpleStatus. * The PurpleStatus has its PurpleStatusType set to the "away" state * for the oscar PRPL. The PurpleStatus also contains the buddy's * away message. PurpleStatuses are sometimes saved, depending on * the context. The current PurpleStatuses associated with each of * your accounts are saved so that the next time you start Purple, * your accounts will be set to their last known statuses. There * is also a list of saved statuses that are written to the * status.xml file. Also, each PurpleStatus has a "savable" boolean. * If "savable" is set to FALSE then the status is NEVER saved. * All PurpleStatuses should be inside a PurplePresence. * * * A PurpleStatus is either "indepedent" or "exclusive." * Independent statuses can be active or inactive and it doesn't * affect anything else. However, you can only have one exclusive * status per PurplePresence. If you activate one exlusive status, * then the previous exclusive status is automatically deactivated. * * A PurplePresence is like a collection of PurpleStatuses (plus some * other random info). For any buddy, or for any one of your accounts, * or for any person you're chatting with, you may know various * amounts of information. This information is all contained in * one PurplePresence. If one of your buddies is away and idle, * then the presence contains the PurpleStatus for their awayness, * and it contains their current idle time. PurplePresences are * never saved to disk. The information they contain is only relevent * for the current PurpleSession. */ typedef struct _PurpleStatusType PurpleStatusType; typedef struct _PurpleStatusAttr PurpleStatusAttr; typedef struct _PurplePresence PurplePresence; typedef struct _PurpleStatus PurpleStatus; /** * A context for a presence. * * The context indicates what the presence applies to. */ typedef enum { PURPLE_PRESENCE_CONTEXT_UNSET = 0, PURPLE_PRESENCE_CONTEXT_ACCOUNT, PURPLE_PRESENCE_CONTEXT_CONV, PURPLE_PRESENCE_CONTEXT_BUDDY } PurplePresenceContext; /** * A primitive defining the basic structure of a status type. */ typedef enum { PURPLE_STATUS_UNSET = 0, PURPLE_STATUS_OFFLINE, PURPLE_STATUS_AVAILABLE, PURPLE_STATUS_UNAVAILABLE, PURPLE_STATUS_INVISIBLE, PURPLE_STATUS_AWAY, PURPLE_STATUS_EXTENDED_AWAY, PURPLE_STATUS_MOBILE, PURPLE_STATUS_NUM_PRIMITIVES } PurpleStatusPrimitive; #include "account.h" #include "blist.h" #include "conversation.h" #include "value.h" #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name PurpleStatusPrimitive API */ /**************************************************************************/ /*@{*/ /** * Lookup the id of a primitive status type based on the type. This * ID is a unique plain-text name of the status, without spaces. * * @param type A primitive status type. * * @return The unique ID for this type. */ const char *purple_primitive_get_id_from_type(PurpleStatusPrimitive type); /** * Lookup the name of a primitive status type based on the type. This * name is the plain-English name of the status type. It is usually one * or two words. * * @param type A primitive status type. * * @return The name of this type, suitable for users to see. */ const char *purple_primitive_get_name_from_type(PurpleStatusPrimitive type); /** * Lookup the value of a primitive status type based on the id. The * ID is a unique plain-text name of the status, without spaces. * * @param id The unique ID of a primitive status type. * * @return The PurpleStatusPrimitive value. */ PurpleStatusPrimitive purple_primitive_get_type_from_id(const char *id); /*@}*/ /**************************************************************************/ /** @name PurpleStatusType API */ /**************************************************************************/ /*@{*/ /** * Creates a new status type. * * @param primitive The primitive status type. * @param id The ID of the status type, or @c NULL to use the id of * the primitive status type. * @param name The name presented to the user, or @c NULL to use the * name of the primitive status type. * @param saveable TRUE if the information set for this status by the * user can be saved for future sessions. * @param user_settable TRUE if this is a status the user can manually set. * @param independent TRUE if this is an independent (non-exclusive) * status type. * * @return A new status type. */ PurpleStatusType *purple_status_type_new_full(PurpleStatusPrimitive primitive, const char *id, const char *name, gboolean saveable, gboolean user_settable, gboolean independent); /** * Creates a new status type with some default values (not * savable and not independent). * * @param primitive The primitive status type. * @param id The ID of the status type, or @c NULL to use the id of * the primitive status type. * @param name The name presented to the user, or @c NULL to use the * name of the primitive status type. * @param user_settable TRUE if this is a status the user can manually set. * * @return A new status type. */ PurpleStatusType *purple_status_type_new(PurpleStatusPrimitive primitive, const char *id, const char *name, gboolean user_settable); /** * Creates a new status type with attributes. * * @param primitive The primitive status type. * @param id The ID of the status type, or @c NULL to use the id of * the primitive status type. * @param name The name presented to the user, or @c NULL to use the * name of the primitive status type. * @param saveable TRUE if the information set for this status by the * user can be saved for future sessions. * @param user_settable TRUE if this is a status the user can manually set. * @param independent TRUE if this is an independent (non-exclusive) * status type. * @param attr_id The ID of the first attribute. * @param attr_name The name of the first attribute. * @param attr_value The value type of the first attribute attribute. * @param ... Additional attribute information. * * @return A new status type. */ PurpleStatusType *purple_status_type_new_with_attrs(PurpleStatusPrimitive primitive, const char *id, const char *name, gboolean saveable, gboolean user_settable, gboolean independent, const char *attr_id, const char *attr_name, PurpleValue *attr_value, ...); /** * Destroys a status type. * * @param status_type The status type to destroy. */ void purple_status_type_destroy(PurpleStatusType *status_type); /** * Sets a status type's primary attribute. * * The value for the primary attribute is used as the description for * the particular status type. An example is an away message. The message * would be the primary attribute. * * @param status_type The status type. * @param attr_id The ID of the primary attribute. */ void purple_status_type_set_primary_attr(PurpleStatusType *status_type, const char *attr_id); /** * Adds an attribute to a status type. * * @param status_type The status type to add the attribute to. * @param id The ID of the attribute. * @param name The name presented to the user. * @param value The value type of this attribute. */ void purple_status_type_add_attr(PurpleStatusType *status_type, const char *id, const char *name, PurpleValue *value); /** * Adds multiple attributes to a status type. * * @param status_type The status type to add the attribute to. * @param id The ID of the first attribute. * @param name The description of the first attribute. * @param value The value type of the first attribute attribute. * @param ... Additional attribute information. */ void purple_status_type_add_attrs(PurpleStatusType *status_type, const char *id, const char *name, PurpleValue *value, ...); /** * Adds multiple attributes to a status type using a va_list. * * @param status_type The status type to add the attribute to. * @param args The va_list of attributes. */ void purple_status_type_add_attrs_vargs(PurpleStatusType *status_type, va_list args); /** * Returns the primitive type of a status type. * * @param status_type The status type. * * @return The primitive type of the status type. */ PurpleStatusPrimitive purple_status_type_get_primitive( const PurpleStatusType *status_type); /** * Returns the ID of a status type. * * @param status_type The status type. * * @return The ID of the status type. */ const char *purple_status_type_get_id(const PurpleStatusType *status_type); /** * Returns the name of a status type. * * @param status_type The status type. * * @return The name of the status type. */ const char *purple_status_type_get_name(const PurpleStatusType *status_type); /** * Returns whether or not the status type is saveable. * * @param status_type The status type. * * @return TRUE if user-defined statuses based off this type are saveable. * FALSE otherwise. */ gboolean purple_status_type_is_saveable(const PurpleStatusType *status_type); /** * Returns whether or not the status type can be set or modified by the * user. * * @param status_type The status type. * * @return TRUE if the status type can be set or modified by the user. * FALSE if it's a protocol-set setting. */ gboolean purple_status_type_is_user_settable(const PurpleStatusType *status_type); /** * Returns whether or not the status type is independent. * * Independent status types are non-exclusive. If other status types on * the same hierarchy level are set, this one will not be affected. * * @param status_type The status type. * * @return TRUE if the status type is independent, or FALSE otherwise. */ gboolean purple_status_type_is_independent(const PurpleStatusType *status_type); /** * Returns whether the status type is exclusive. * * @param status_type The status type. * * @return TRUE if the status type is exclusive, FALSE otherwise. */ gboolean purple_status_type_is_exclusive(const PurpleStatusType *status_type); /** * Returns whether or not a status type is available. * * Available status types are online and possibly invisible, but not away. * * @param status_type The status type. * * @return TRUE if the status is available, or FALSE otherwise. */ gboolean purple_status_type_is_available(const PurpleStatusType *status_type); /** * Returns a status type's primary attribute ID. * * @param type The status type. * * @return The primary attribute's ID. */ const char *purple_status_type_get_primary_attr(const PurpleStatusType *type); /** * Returns the attribute with the specified ID. * * @param status_type The status type containing the attribute. * @param id The ID of the desired attribute. * * @return The attribute, if found. NULL otherwise. */ PurpleStatusAttr *purple_status_type_get_attr(const PurpleStatusType *status_type, const char *id); /** * Returns a list of all attributes in a status type. * * @param status_type The status type. * * @return The list of attributes. */ const GList *purple_status_type_get_attrs(const PurpleStatusType *status_type); /** * Find the PurpleStatusType with the given id. * * @param status_types A list of status types. Often account->status_types. * @param id The unique ID of the status type you wish to find. * * @return The status type with the given ID, or NULL if one could * not be found. */ const PurpleStatusType *purple_status_type_find_with_id(GList *status_types, const char *id); /*@}*/ /**************************************************************************/ /** @name PurpleStatusAttr API */ /**************************************************************************/ /*@{*/ /** * Creates a new status attribute. * * @param id The ID of the attribute. * @param name The name presented to the user. * @param value_type The type of data contained in the attribute. * * @return A new status attribute. */ PurpleStatusAttr *purple_status_attr_new(const char *id, const char *name, PurpleValue *value_type); /** * Destroys a status attribute. * * @param attr The status attribute to destroy. */ void purple_status_attr_destroy(PurpleStatusAttr *attr); /** * Returns the ID of a status attribute. * * @param attr The status attribute. * * @return The status attribute's ID. */ const char *purple_status_attr_get_id(const PurpleStatusAttr *attr); /** * Returns the name of a status attribute. * * @param attr The status attribute. * * @return The status attribute's name. */ const char *purple_status_attr_get_name(const PurpleStatusAttr *attr); /** * Returns the value of a status attribute. * * @param attr The status attribute. * * @return The status attribute's value. */ PurpleValue *purple_status_attr_get_value(const PurpleStatusAttr *attr); /*@}*/ /**************************************************************************/ /** @name PurpleStatus API */ /**************************************************************************/ /*@{*/ /** * Creates a new status. * * @param status_type The type of status. * @param presence The parent presence. * * @return The new status. */ PurpleStatus *purple_status_new(PurpleStatusType *status_type, PurplePresence *presence); /** * Destroys a status. * * @param status The status to destroy. */ void purple_status_destroy(PurpleStatus *status); /** * Sets whether or not a status is active. * * This should only be called by the account, conversation, and buddy APIs. * * @param status The status. * @param active The active state. */ void purple_status_set_active(PurpleStatus *status, gboolean active); /** * Sets whether or not a status is active. * * This should only be called by the account, conversation, and buddy APIs. * * @param status The status. * @param active The active state. * @param args A list of attributes to set on the status. This list is * composed of key/value pairs, where each key is a valid * attribute name for this PurpleStatusType. The list should * be NULL terminated. */ void purple_status_set_active_with_attrs(PurpleStatus *status, gboolean active, va_list args); /** * Sets whether or not a status is active. * * This should only be called by the account, conversation, and buddy APIs. * * @param status The status. * @param active The active state. * @param attrs A list of attributes to set on the status. This list is * composed of key/value pairs, where each key is a valid * attribute name for this PurpleStatusType. */ void purple_status_set_active_with_attrs_list(PurpleStatus *status, gboolean active, const GList *attrs); /** * Sets the boolean value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * @param value The boolean value. */ void purple_status_set_attr_boolean(PurpleStatus *status, const char *id, gboolean value); /** * Sets the integer value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * @param value The integer value. */ void purple_status_set_attr_int(PurpleStatus *status, const char *id, int value); /** * Sets the string value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * @param value The string value. */ void purple_status_set_attr_string(PurpleStatus *status, const char *id, const char *value); /** * Returns the status's type. * * @param status The status. * * @return The status's type. */ PurpleStatusType *purple_status_get_type(const PurpleStatus *status); /** * Returns the status's presence. * * @param status The status. * * @return The status's presence. */ PurplePresence *purple_status_get_presence(const PurpleStatus *status); /** * Returns the status's type ID. * * This is a convenience method for * purple_status_type_get_id(purple_status_get_type(status)). * * @param status The status. * * @return The status's ID. */ const char *purple_status_get_id(const PurpleStatus *status); /** * Returns the status's name. * * This is a convenience method for * purple_status_type_get_name(purple_status_get_type(status)). * * @param status The status. * * @return The status's name. */ const char *purple_status_get_name(const PurpleStatus *status); /** * Returns whether or not a status is independent. * * This is a convenience method for * purple_status_type_is_independent(purple_status_get_type(status)). * * @param status The status. * * @return TRUE if the status is independent, or FALSE otherwise. */ gboolean purple_status_is_independent(const PurpleStatus *status); /** * Returns whether or not a status is exclusive. * * This is a convenience method for * purple_status_type_is_exclusive(purple_status_get_type(status)). * * @param status The status. * * @return TRUE if the status is exclusive, FALSE otherwise. */ gboolean purple_status_is_exclusive(const PurpleStatus *status); /** * Returns whether or not a status is available. * * Available statuses are online and possibly invisible, but not away or idle. * * This is a convenience method for * purple_status_type_is_available(purple_status_get_type(status)). * * @param status The status. * * @return TRUE if the status is available, or FALSE otherwise. */ gboolean purple_status_is_available(const PurpleStatus *status); /** * Returns the active state of a status. * * @param status The status. * * @return The active state of the status. */ gboolean purple_status_is_active(const PurpleStatus *status); /** * Returns whether or not a status is considered 'online' * * @param status The status. * * @return TRUE if the status is considered online, FALSE otherwise */ gboolean purple_status_is_online(const PurpleStatus *status); /** * Returns the value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * * @return The value of the attribute. */ PurpleValue *purple_status_get_attr_value(const PurpleStatus *status, const char *id); /** * Returns the boolean value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * * @return The boolean value of the attribute. */ gboolean purple_status_get_attr_boolean(const PurpleStatus *status, const char *id); /** * Returns the integer value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * * @return The integer value of the attribute. */ int purple_status_get_attr_int(const PurpleStatus *status, const char *id); /** * Returns the string value of an attribute in a status with the specified ID. * * @param status The status. * @param id The attribute ID. * * @return The string value of the attribute. */ const char *purple_status_get_attr_string(const PurpleStatus *status, const char *id); /** * Compares two statuses for availability. * * @param status1 The first status. * @param status2 The second status. * * @return -1 if @a status1 is more available than @a status2. * 0 if @a status1 is equal to @a status2. * 1 if @a status2 is more available than @a status1. */ gint purple_status_compare(const PurpleStatus *status1, const PurpleStatus *status2); /*@}*/ /**************************************************************************/ /** @name PurplePresence API */ /**************************************************************************/ /*@{*/ /** * Creates a new presence. * * @param context The presence context. * * @return A new presence. */ PurplePresence *purple_presence_new(PurplePresenceContext context); /** * Creates a presence for an account. * * @param account The account. * * @return The new presence. */ PurplePresence *purple_presence_new_for_account(PurpleAccount *account); /** * Creates a presence for a conversation. * * @param conv The conversation. * * @return The new presence. */ PurplePresence *purple_presence_new_for_conv(PurpleConversation *conv); /** * Creates a presence for a buddy. * * @param buddy The buddy. * * @return The new presence. */ PurplePresence *purple_presence_new_for_buddy(PurpleBuddy *buddy); /** * Destroys a presence. * * All statuses added to this list will be destroyed along with * the presence. * * @param presence The presence to destroy. */ void purple_presence_destroy(PurplePresence *presence); /** * Adds a status to a presence. * * @param presence The presence. * @param status The status to add. */ void purple_presence_add_status(PurplePresence *presence, PurpleStatus *status); /** * Adds a list of statuses to the presence. * * @param presence The presence. * @param source_list The source list of statuses to add. */ void purple_presence_add_list(PurplePresence *presence, const GList *source_list); /** * Sets the active state of a status in a presence. * * Only independent statuses can be set unactive. Normal statuses can only * be set active, so if you wish to disable a status, set another * non-independent status to active, or use purple_presence_switch_status(). * * @param presence The presence. * @param status_id The ID of the status. * @param active The active state. */ void purple_presence_set_status_active(PurplePresence *presence, const char *status_id, gboolean active); /** * Switches the active status in a presence. * * This is similar to purple_presence_set_status_active(), except it won't * activate independent statuses. * * @param presence The presence. * @param status_id The status ID to switch to. */ void purple_presence_switch_status(PurplePresence *presence, const char *status_id); /** * Sets the idle state and time on a presence. * * @param presence The presence. * @param idle The idle state. * @param idle_time The idle time, if @a idle is TRUE. This * is the time at which the user became idle, * in seconds since the epoch. */ void purple_presence_set_idle(PurplePresence *presence, gboolean idle, time_t idle_time); /** * Sets the login time on a presence. * * @param presence The presence. * @param login_time The login time. */ void purple_presence_set_login_time(PurplePresence *presence, time_t login_time); /** * Returns the presence's context. * * @param presence The presence. * * @return The presence's context. */ PurplePresenceContext purple_presence_get_context(const PurplePresence *presence); /** * Returns a presence's account. * * @param presence The presence. * * @return The presence's account. */ PurpleAccount *purple_presence_get_account(const PurplePresence *presence); /** * Returns a presence's conversation. * * @param presence The presence. * * @return The presence's conversation. */ PurpleConversation *purple_presence_get_conversation(const PurplePresence *presence); /** * Returns a presence's chat user. * * @param presence The presence. * * @return The chat's user. */ const char *purple_presence_get_chat_user(const PurplePresence *presence); /** * Returns the presence's buddy. * * @param presence The presence. * * @return The presence's buddy. */ PurpleBuddy *purple_presence_get_buddy(const PurplePresence *presence); /** * Returns all the statuses in a presence. * * @param presence The presence. * * @return The statuses. */ const GList *purple_presence_get_statuses(const PurplePresence *presence); /** * Returns the status with the specified ID from a presence. * * @param presence The presence. * @param status_id The ID of the status. * * @return The status if found, or NULL. */ PurpleStatus *purple_presence_get_status(const PurplePresence *presence, const char *status_id); /** * Returns the active exclusive status from a presence. * * @param presence The presence. * * @return The active exclusive status. */ PurpleStatus *purple_presence_get_active_status(const PurplePresence *presence); /** * Returns whether or not a presence is available. * * Available presences are online and possibly invisible, but not away or idle. * * @param presence The presence. * * @return TRUE if the presence is available, or FALSE otherwise. */ gboolean purple_presence_is_available(const PurplePresence *presence); /** * Returns whether or not a presence is online. * * @param presence The presence. * * @return TRUE if the presence is online, or FALSE otherwise. */ gboolean purple_presence_is_online(const PurplePresence *presence); /** * Returns whether or not a status in a presence is active. * * A status is active if itself or any of its sub-statuses are active. * * @param presence The presence. * @param status_id The ID of the status. * * @return TRUE if the status is active, or FALSE. */ gboolean purple_presence_is_status_active(const PurplePresence *presence, const char *status_id); /** * Returns whether or not a status with the specified primitive type * in a presence is active. * * A status is active if itself or any of its sub-statuses are active. * * @param presence The presence. * @param primitive The status primitive. * * @return TRUE if the status is active, or FALSE. */ gboolean purple_presence_is_status_primitive_active( const PurplePresence *presence, PurpleStatusPrimitive primitive); /** * Returns whether or not a presence is idle. * * @param presence The presence. * * @return TRUE if the presence is idle, or FALSE otherwise. * If the presence is offline (purple_presence_is_online() * returns FALSE) then FALSE is returned. */ gboolean purple_presence_is_idle(const PurplePresence *presence); /** * Returns the presence's idle time. * * @param presence The presence. * * @return The presence's idle time. */ time_t purple_presence_get_idle_time(const PurplePresence *presence); /** * Returns the presence's login time. * * @param presence The presence. * * @return The presence's login time. */ time_t purple_presence_get_login_time(const PurplePresence *presence); /** * Compares two presences for availability. * * @param presence1 The first presence. * @param presence2 The second presence. * * @return -1 if @a presence1 is more available than @a presence2. * 0 if @a presence1 is equal to @a presence2. * 1 if @a presence1 is less available than @a presence2. */ gint purple_presence_compare(const PurplePresence *presence1, const PurplePresence *presence2); /*@}*/ /**************************************************************************/ /** @name Status subsystem */ /**************************************************************************/ /*@{*/ /** * Get the handle for the status subsystem. * * @return the handle to the status subsystem */ void *purple_status_get_handle(void); /** * Initializes the status subsystem. */ void purple_status_init(void); /** * Uninitializes the status subsystem. */ void purple_status_uninit(void); /*@}*/ #ifdef __cplusplus } #endif #endif /* _PURPLE_STATUS_H_ */