pidgin: libpurple/value.h comparison

comparison libpurple/value.h @ 15822:32c366eeeb99

sed -ie 's/gaim/purple/g'

author	Sean Egan <seanegan@gmail.com>
date	Mon, 19 Mar 2007 07:01:17 +0000
parents	5fe8042783c1
children	391a79778f89

comparison

equal deleted inserted replaced

-:84b0f9b23ede
+:32c366eeeb99
 /**
 * @file value.h Value wrapper API
 * @ingroup core
 *
-* gaim
+* purple
 *
-* Gaim is the legal property of its developers, whose names are too numerous
+* 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
 *
 * 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 _GAIM_VALUE_H_
+#ifndef _PURPLE_VALUE_H_
-#define _GAIM_VALUE_H_
+#define _PURPLE_VALUE_H_
 #include <glib.h>
 /**
 * Specific value types.
 */
 typedef enum
 {
-	GAIM_TYPE_UNKNOWN = 0,  /**< Unknown type.                     */
+	PURPLE_TYPE_UNKNOWN = 0,  /**< Unknown type.                     */
-	GAIM_TYPE_SUBTYPE,      /**< Subtype.                          */
+	PURPLE_TYPE_SUBTYPE,      /**< Subtype.                          */
-	GAIM_TYPE_CHAR,         /**< Character.                        */
+	PURPLE_TYPE_CHAR,         /**< Character.                        */
-	GAIM_TYPE_UCHAR,        /**< Unsigned character.               */
+	PURPLE_TYPE_UCHAR,        /**< Unsigned character.               */
-	GAIM_TYPE_BOOLEAN,      /**< Boolean.                          */
+	PURPLE_TYPE_BOOLEAN,      /**< Boolean.                          */
-	GAIM_TYPE_SHORT,        /**< Short integer.                    */
+	PURPLE_TYPE_SHORT,        /**< Short integer.                    */
-	GAIM_TYPE_USHORT,       /**< Unsigned short integer.           */
+	PURPLE_TYPE_USHORT,       /**< Unsigned short integer.           */
-	GAIM_TYPE_INT,          /**< Integer.                          */
+	PURPLE_TYPE_INT,          /**< Integer.                          */
-	GAIM_TYPE_UINT,         /**< Unsigned integer.                 */
+	PURPLE_TYPE_UINT,         /**< Unsigned integer.                 */
-	GAIM_TYPE_LONG,         /**< Long integer.                     */
+	PURPLE_TYPE_LONG,         /**< Long integer.                     */
-	GAIM_TYPE_ULONG,        /**< Unsigned long integer.            */
+	PURPLE_TYPE_ULONG,        /**< Unsigned long integer.            */
-	GAIM_TYPE_INT64,        /**< 64-bit integer.                   */
+	PURPLE_TYPE_INT64,        /**< 64-bit integer.                   */
-	GAIM_TYPE_UINT64,       /**< 64-bit unsigned integer.          */
+	PURPLE_TYPE_UINT64,       /**< 64-bit unsigned integer.          */
-	GAIM_TYPE_STRING,       /**< String.                           */
+	PURPLE_TYPE_STRING,       /**< String.                           */
-	GAIM_TYPE_OBJECT,       /**< Object pointer.                   */
+	PURPLE_TYPE_OBJECT,       /**< Object pointer.                   */
-	GAIM_TYPE_POINTER,      /**< Generic pointer.                  */
+	PURPLE_TYPE_POINTER,      /**< Generic pointer.                  */
-	GAIM_TYPE_ENUM,         /**< Enum.                             */
+	PURPLE_TYPE_ENUM,         /**< Enum.                             */
-	GAIM_TYPE_BOXED         /**< Boxed pointer with specific type. */
+	PURPLE_TYPE_BOXED         /**< Boxed pointer with specific type. */
-} GaimType;
+} PurpleType;
 /**
-* Gaim-specific subtype values.
+* Purple-specific subtype values.
 */
 typedef enum
 {
-	GAIM_SUBTYPE_UNKNOWN = 0,
+	PURPLE_SUBTYPE_UNKNOWN = 0,
-	GAIM_SUBTYPE_ACCOUNT,
+	PURPLE_SUBTYPE_ACCOUNT,
-	GAIM_SUBTYPE_BLIST,
+	PURPLE_SUBTYPE_BLIST,
-	GAIM_SUBTYPE_BLIST_BUDDY,
+	PURPLE_SUBTYPE_BLIST_BUDDY,
-	GAIM_SUBTYPE_BLIST_GROUP,
+	PURPLE_SUBTYPE_BLIST_GROUP,
-	GAIM_SUBTYPE_BLIST_CHAT,
+	PURPLE_SUBTYPE_BLIST_CHAT,
-	GAIM_SUBTYPE_BUDDY_ICON,
+	PURPLE_SUBTYPE_BUDDY_ICON,
-	GAIM_SUBTYPE_CONNECTION,
+	PURPLE_SUBTYPE_CONNECTION,
-	GAIM_SUBTYPE_CONVERSATION,
+	PURPLE_SUBTYPE_CONVERSATION,
-	GAIM_SUBTYPE_PLUGIN,
+	PURPLE_SUBTYPE_PLUGIN,
-	GAIM_SUBTYPE_BLIST_NODE,
+	PURPLE_SUBTYPE_BLIST_NODE,
-	GAIM_SUBTYPE_CIPHER,
+	PURPLE_SUBTYPE_CIPHER,
-	GAIM_SUBTYPE_STATUS,
+	PURPLE_SUBTYPE_STATUS,
-	GAIM_SUBTYPE_LOG,
+	PURPLE_SUBTYPE_LOG,
-	GAIM_SUBTYPE_XFER,
+	PURPLE_SUBTYPE_XFER,
-	GAIM_SUBTYPE_SAVEDSTATUS,
+	PURPLE_SUBTYPE_SAVEDSTATUS,
-	GAIM_SUBTYPE_XMLNODE,
+	PURPLE_SUBTYPE_XMLNODE,
-	GAIM_SUBTYPE_USERINFO
+	PURPLE_SUBTYPE_USERINFO
-} GaimSubType;
+} PurpleSubType;
 /**
 * A wrapper for a type, subtype, and specific type of value.
 */
 typedef struct
 {
-	GaimType type;
+	PurpleType type;
 	unsigned short flags;
 	union
 	{
 		char char_data;
 		unsigned int subtype;
 		char *specific_type;
 	} u;
-} GaimValue;
+} PurpleValue;
 #ifdef __cplusplus
 extern "C" {
 #endif
 /**
-* Creates a new GaimValue.
+* Creates a new PurpleValue.
 *
 * This function takes a type and, depending on that type, a sub-type
 * or specific type.
 *
-* If @a type is GAIM_TYPE_BOXED, the next parameter must be a
+* If @a type is PURPLE_TYPE_BOXED, the next parameter must be a
 * string representing the specific type.
 *
-* If @a type is GAIM_TYPE_SUBTYPE, the next parameter must be a
+* If @a type is PURPLE_TYPE_SUBTYPE, the next parameter must be a
 * integer or enum representing the sub-type.
 *
 * If the subtype or specific type is not set when required, random
 * errors may occur. You have been warned.
 *
 * @param type The type.
 *
 * @return The new value.
 */
-GaimValue *gaim_value_new(GaimType type, ...);
+PurpleValue *purple_value_new(PurpleType type, ...);
 /**
-* Creates a new outgoing GaimValue.  If a value is an "outgoing" value
+* Creates a new outgoing PurpleValue.  If a value is an "outgoing" value
 * it means the value can be modified by plugins and scripts.
 *
 * This function takes a type and, depending on that type, a sub-type
 * or specific type.
 *
-* If @a type is GAIM_TYPE_BOXED, the next parameter must be a
+* If @a type is PURPLE_TYPE_BOXED, the next parameter must be a
 * string representing the specific type.
 *
-* If @a type is GAIM_TYPE_SUBTYPE, the next parameter must be a
+* If @a type is PURPLE_TYPE_SUBTYPE, the next parameter must be a
 * integer or enum representing the sub-type.
 *
 * If the sub-type or specific type is not set when required, random
 * errors may occur. You have been warned.
 *
 * @param type The type.
 *
 * @return The new value.
 */
-GaimValue *gaim_value_new_outgoing(GaimType type, ...);
+PurpleValue *purple_value_new_outgoing(PurpleType type, ...);
 /**
-* Destroys a GaimValue.
+* Destroys a PurpleValue.
 *
 * @param value The value to destroy.
 */
-void gaim_value_destroy(GaimValue *value);
+void purple_value_destroy(PurpleValue *value);
 /**
-* Duplicated a GaimValue.
+* Duplicated a PurpleValue.
 *
 * @param value The value to duplicate.
 *
 * @return The duplicate value.
 */
-GaimValue *gaim_value_dup(const GaimValue *value);
+PurpleValue *purple_value_dup(const PurpleValue *value);
 /**
 * Returns a value's type.
 *
 * @param value The value whose type you want.
 *
 * @return The value's type.
 */
-GaimType gaim_value_get_type(const GaimValue *value);
+PurpleType purple_value_get_type(const PurpleValue *value);
 /**
 * Returns a value's subtype.
 *
-* If the value's type is not GAIM_TYPE_SUBTYPE, this will return 0.
+* If the value's type is not PURPLE_TYPE_SUBTYPE, this will return 0.
 * Subtypes should never have a subtype of 0.
 *
 * @param value The value whose subtype you want.
 *
-* @return The value's subtype, or 0 if @a type is not GAIM_TYPE_SUBTYPE.
+* @return The value's subtype, or 0 if @a type is not PURPLE_TYPE_SUBTYPE.
 */
-unsigned int gaim_value_get_subtype(const GaimValue *value);
+unsigned int purple_value_get_subtype(const PurpleValue *value);
 /**
 * Returns a value's specific type.
 *
-* If the value's type is not GAIM_TYPE_BOXED, this will return @c NULL.
+* If the value's type is not PURPLE_TYPE_BOXED, this will return @c NULL.
 *
 * @param value The value whose specific type you want.
 *
-* @return The value's specific type, or @a NULL if not GAIM_TYPE_BOXED.
+* @return The value's specific type, or @a NULL if not PURPLE_TYPE_BOXED.
 */
-const char *gaim_value_get_specific_type(const GaimValue *value);
+const char *purple_value_get_specific_type(const PurpleValue *value);
 /**
 * Returns whether or not the value is an outgoing value.
 *
 * @param value The value.
 *
 * @return TRUE if the value is outgoing, or FALSE otherwise.
 */
-gboolean gaim_value_is_outgoing(const GaimValue *value);
+gboolean purple_value_is_outgoing(const PurpleValue *value);
 /**
 * Sets the value's character data.
 *
 * @param value The value.
 * @param data The character data.
 */
-void gaim_value_set_char(GaimValue *value, char data);
+void purple_value_set_char(PurpleValue *value, char data);
 /**
 * Sets the value's unsigned character data.
 *
 * @param value The value.
 * @param data The unsigned character data.
 */
-void gaim_value_set_uchar(GaimValue *value, unsigned char data);
+void purple_value_set_uchar(PurpleValue *value, unsigned char data);
 /**
 * Sets the value's boolean data.
 *
 * @param value The value.
 * @param data The boolean data.
 */
-void gaim_value_set_boolean(GaimValue *value, gboolean data);
+void purple_value_set_boolean(PurpleValue *value, gboolean data);
 /**
 * Sets the value's short integer data.
 *
 * @param value The value.
 * @param data The short integer data.
 */
-void gaim_value_set_short(GaimValue *value, short data);
+void purple_value_set_short(PurpleValue *value, short data);
 /**
 * Sets the value's unsigned short integer data.
 *
 * @param value The value.
 * @param data The unsigned short integer data.
 */
-void gaim_value_set_ushort(GaimValue *value, unsigned short data);
+void purple_value_set_ushort(PurpleValue *value, unsigned short data);
 /**
 * Sets the value's integer data.
 *
 * @param value The value.
 * @param data The integer data.
 */
-void gaim_value_set_int(GaimValue *value, int data);
+void purple_value_set_int(PurpleValue *value, int data);
 /**
 * Sets the value's unsigned integer data.
 *
 * @param value The value.
 * @param data The unsigned integer data.
 */
-void gaim_value_set_uint(GaimValue *value, unsigned int data);
+void purple_value_set_uint(PurpleValue *value, unsigned int data);
 /**
 * Sets the value's long integer data.
 *
 * @param value The value.
 * @param data The long integer data.
 */
-void gaim_value_set_long(GaimValue *value, long data);
+void purple_value_set_long(PurpleValue *value, long data);
 /**
 * Sets the value's unsigned long integer data.
 *
 * @param value The value.
 * @param data The unsigned long integer data.
 */
-void gaim_value_set_ulong(GaimValue *value, unsigned long data);
+void purple_value_set_ulong(PurpleValue *value, unsigned long data);
 /**
 * Sets the value's 64-bit integer data.
 *
 * @param value The value.
 * @param data The 64-bit integer data.
 */
-void gaim_value_set_int64(GaimValue *value, gint64 data);
+void purple_value_set_int64(PurpleValue *value, gint64 data);
 /**
 * Sets the value's unsigned 64-bit integer data.
 *
 * @param value The value.
 * @param data The unsigned 64-bit integer data.
 */
-void gaim_value_set_uint64(GaimValue *value, guint64 data);
+void purple_value_set_uint64(PurpleValue *value, guint64 data);
 /**
 * Sets the value's string data.
 *
 * @param value The value.
 * @param data The string data.
 */
-void gaim_value_set_string(GaimValue *value, const char *data);
+void purple_value_set_string(PurpleValue *value, const char *data);
 /**
 * Sets the value's object data.
 *
 * @param value The value.
 * @param data The object data.
 */
-void gaim_value_set_object(GaimValue *value, void *data);
+void purple_value_set_object(PurpleValue *value, void *data);
 /**
 * Sets the value's pointer data.
 *
 * @param value The value.
 * @param data The pointer data.
 */
-void gaim_value_set_pointer(GaimValue *value, void *data);
+void purple_value_set_pointer(PurpleValue *value, void *data);
 /**
 * Sets the value's enum data.
 *
 * @param value The value.
 * @param data The enum data.
 */
-void gaim_value_set_enum(GaimValue *value, int data);
+void purple_value_set_enum(PurpleValue *value, int data);
 /**
 * Sets the value's boxed data.
 *
 * @param value The value.
 * @param data The boxed data.
 */
-void gaim_value_set_boxed(GaimValue *value, void *data);
+void purple_value_set_boxed(PurpleValue *value, void *data);
 /**
 * Returns the value's character data.
 *
 * @param value The value.
 *
 * @return The character data.
 */
-char gaim_value_get_char(const GaimValue *value);
+char purple_value_get_char(const PurpleValue *value);
 /**
 * Returns the value's unsigned character data.
 *
 * @param value The value.
 *
 * @return The unsigned character data.
 */
-unsigned char gaim_value_get_uchar(const GaimValue *value);
+unsigned char purple_value_get_uchar(const PurpleValue *value);
 /**
 * Returns the value's boolean data.
 *
 * @param value The value.
 *
 * @return The boolean data.
 */
-gboolean gaim_value_get_boolean(const GaimValue *value);
+gboolean purple_value_get_boolean(const PurpleValue *value);
 /**
 * Returns the value's short integer data.
 *
 * @param value The value.
 *
 * @return The short integer data.
 */
-short gaim_value_get_short(const GaimValue *value);
+short purple_value_get_short(const PurpleValue *value);
 /**
 * Returns the value's unsigned short integer data.
 *
 * @param value The value.
 *
 * @return The unsigned short integer data.
 */
-unsigned short gaim_value_get_ushort(const GaimValue *value);
+unsigned short purple_value_get_ushort(const PurpleValue *value);
 /**
 * Returns the value's integer data.
 *
 * @param value The value.
 *
 * @return The integer data.
 */
-int gaim_value_get_int(const GaimValue *value);
+int purple_value_get_int(const PurpleValue *value);
 /**
 * Returns the value's unsigned integer data.
 *
 * @param value The value.
 *
 * @return The unsigned integer data.
 */
-unsigned int gaim_value_get_uint(const GaimValue *value);
+unsigned int purple_value_get_uint(const PurpleValue *value);
 /**
 * Returns the value's long integer data.
 *
 * @param value The value.
 *
 * @return The long integer data.
 */
-long gaim_value_get_long(const GaimValue *value);
+long purple_value_get_long(const PurpleValue *value);
 /**
 * Returns the value's unsigned long integer data.
 *
 * @param value The value.
 *
 * @return The unsigned long integer data.
 */
-unsigned long gaim_value_get_ulong(const GaimValue *value);
+unsigned long purple_value_get_ulong(const PurpleValue *value);
 /**
 * Returns the value's 64-bit integer data.
 *
 * @param value The value.
 *
 * @return The 64-bit integer data.
 */
-gint64 gaim_value_get_int64(const GaimValue *value);
+gint64 purple_value_get_int64(const PurpleValue *value);
 /**
 * Returns the value's unsigned 64-bit integer data.
 *
 * @param value The value.
 *
 * @return The unsigned 64-bit integer data.
 */
-guint64 gaim_value_get_uint64(const GaimValue *value);
+guint64 purple_value_get_uint64(const PurpleValue *value);
 /**
 * Returns the value's string data.
 *
 * @param value The value.
 *
 * @return The string data.
 */
-const char *gaim_value_get_string(const GaimValue *value);
+const char *purple_value_get_string(const PurpleValue *value);
 /**
 * Returns the value's object data.
 *
 * @param value The value.
 *
 * @return The object data.
 */
-void *gaim_value_get_object(const GaimValue *value);
+void *purple_value_get_object(const PurpleValue *value);
 /**
 * Returns the value's pointer data.
 *
 * @param value The value.
 *
 * @return The pointer data.
 */
-void *gaim_value_get_pointer(const GaimValue *value);
+void *purple_value_get_pointer(const PurpleValue *value);
 /**
 * Returns the value's enum data.
 *
 * @param value The value.
 *
 * @return The enum data.
 */
-int gaim_value_get_enum(const GaimValue *value);
+int purple_value_get_enum(const PurpleValue *value);
 /**
 * Returns the value's boxed data.
 *
 * @param value The value.
 *
 * @return The boxed data.
 */
-void *gaim_value_get_boxed(const GaimValue *value);
+void *purple_value_get_boxed(const PurpleValue *value);
 #ifdef __cplusplus
 }
 #endif
-#endif /* _GAIM_VALUE_H_ */
+#endif /* _PURPLE_VALUE_H_ */

Mercurial > pidgin

comparison libpurple/value.h @ 15822:32c366eeeb99