gobjectification: 379595b9: Forgot to add these
aluink at soc.pidgin.im
aluink at soc.pidgin.im
Wed Jul 1 10:25:32 EDT 2009
-----------------------------------------------------------------
Revision: 379595b90783157740701b9923c5eb761e51efc7
Ancestor: f98d3b52d50a85706665b11d5597b06afa70c5d4
Author: aluink at soc.pidgin.im
Date: 2009-07-01T14:23:57
Branch: im.pidgin.gobjectification
URL: http://d.pidgin.im/viewmtn/revision/info/379595b90783157740701b9923c5eb761e51efc7
Added files:
libpurple/blist-node.h libpurple/buddy.h libpurple/chat.h
libpurple/contact.h libpurple/group.h
ChangeLog:
Forgot to add these
-------------- next part --------------
============================================================
--- libpurple/blist-node.h 7941548f61d359ebc5e83864a14e92e7f3037c55
+++ libpurple/blist-node.h 7941548f61d359ebc5e83864a14e92e7f3037c55
@@ -0,0 +1,284 @@
+/**
+ * @file blist.h Buddy List API
+ * @ingroup core
+ * @see @ref blist-signals
+ */
+
+/* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
+ */
+
+#ifndef _PURPLE_BLIST_NODE_H_
+#define _PURPLE_BLIST_NODE_H_
+
+#include <glib.h>
+
+#define PURPLE_BUDDY_IS_ONLINE(b) \
+ ((b) != NULL && purple_account_is_connected(purple_buddy_get_account(b)) && \
+ purple_presence_is_online(purple_buddy_get_presence(b)))
+
+typedef enum
+{
+ PURPLE_BLIST_NODE_FLAG_NO_SAVE = 1 << 0 /**< node should not be saved with the buddy list */
+
+} PurpleBlistNodeFlags;
+
+/**
+ * @since 2.6.0
+ */
+#define PURPLE_BLIST_NODE_HAS_FLAG(b, f) (purple_blist_node_get_flags((PurpleBlistNode*)(b)) & (f))
+#define PURPLE_BLIST_NODE_SHOULD_SAVE(b) (! PURPLE_BLIST_NODE_HAS_FLAG(b, PURPLE_BLIST_NODE_FLAG_NO_SAVE))
+
+/*#define PURPLE_BLIST_NODE_NAME(n) (purple_blist_node_get_type(n) == PURPLE_BLIST_CHAT_NODE ? purple_chat_get_name((PurpleChat*)n) : \
+ purple_blist_node_get_type(n) == PURPLE_BLIST_BUDDY_NODE ? purple_buddy_get_name((PurpleBuddy*)n) : NULL)*/
+
+/** @copydoc _PurpleBlistNode */
+typedef struct _PurpleBlistNode PurpleBlistNode;
+typedef struct _PurpleBlistNodePrivate PurpleBlistNodePrivate;
+typedef struct _PurpleBlistNodeClass PurpleBlistNodeClass;
+#define PURPLE_BLIST_NODE_TYPE (purple_blist_node_get_gtype ())
+#define PURPLE_BLIST_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_BLIST_NODE_TYPE, PurpleBlistNode))
+#define PURPLE_IS_BLIST_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_BLIST_NODE_TYPE))
+#define PURPLE_BLIST_NODE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_BLIST_NODE_TYPE, PurpleBlistNodeClass))
+#define PURPLE_IS_BLIST_NODE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_BLIST_NODE_TYPE))
+#define PURPLE_GET_BLIST_NODE_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_BLIST_NODE_TYPE, PurpleBlistNodeClass))
+#define PURPLE_BLIST_NODE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), PURPLE_BLIST_NODE_TYPE, PurpleBlistNodePrivate))
+
+
+/**
+ * A Buddy list node. This can represent a group, a buddy, or anything else.
+ * This is a base class for PurpleBuddy, PurpleContact, PurpleGroup, and for
+ * anything else that wants to put itself in the buddy list. */
+struct _PurpleBlistNode {
+ PurpleObject _parent;
+ PurpleBlistNode *prev; /**< The sibling before this buddy. */
+ PurpleBlistNode *next; /**< The sibling after this buddy. */
+ PurpleBlistNode *parent; /**< The parent of this node */
+ PurpleBlistNode *child; /**< The child of this node */
+
+ GHashTable *settings; /**< per-node settings; keys are
+ <tt>gchar *</tt>, values are
+ slice-allocated
+ <tt>GValue</tt>. */
+
+ void *ui_data; /**< The UI can put data here. */
+ PurpleBlistNodeFlags flags; /**< The buddy flags */
+};
+
+struct _PurpleBlistNodeClass {
+ PurpleObjectClass parent;
+};
+
+/**
+ * Returns the next node of a given node. This function is to be used to iterate
+ * over the tree returned by purple_get_blist.
+ *
+ * @param node A node.
+ * @param offline Whether to include nodes for offline accounts
+ * @return The next node
+ * @see purple_blist_node_get_parent
+ * @see purple_blist_node_get_first_child
+ * @see purple_blist_node_get_sibling_next
+ * @see purple_blist_node_get_sibling_prev
+ */
+PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
+
+/**
+ * Returns the parent node of a given node.
+ *
+ * @param node A node.
+ * @return The parent node.
+ * @since 2.4.0
+ * @see purple_blist_node_get_first_child
+ * @see purple_blist_node_get_sibling_next
+ * @see purple_blist_node_get_sibling_prev
+ * @see purple_blist_node_next
+ */
+PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
+
+/**
+ * Returns the the first child node of a given node.
+ *
+ * @param node A node.
+ * @return The child node.
+ * @since 2.4.0
+ * @see purple_blist_node_get_parent
+ * @see purple_blist_node_get_sibling_next
+ * @see purple_blist_node_get_sibling_prev
+ * @see purple_blist_node_next
+ */
+PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
+
+/**
+ * Returns the sibling node of a given node.
+ *
+ * @param node A node.
+ * @return The sibling node.
+ * @since 2.4.0
+ * @see purple_blist_node_get_parent
+ * @see purple_blist_node_get_first_child
+ * @see purple_blist_node_get_sibling_prev
+ * @see purple_blist_node_next
+ */
+PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
+
+/**
+ * Returns the previous sibling node of a given node.
+ *
+ * @param node A node.
+ * @return The sibling node.
+ * @since 2.4.0
+ * @see purple_blist_node_get_parent
+ * @see purple_blist_node_get_first_child
+ * @see purple_blist_node_get_sibling_next
+ * @see purple_blist_node_next
+ */
+PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
+
+/**
+ * Returns the UI data of a given node.
+ *
+ * @param node The node.
+ * @return The UI data.
+ * @since 2.6.0
+ */
+gpointer purple_blist_node_get_ui_data(const PurpleBlistNode *node);
+
+/**
+ * Sets the UI data of a given node.
+ *
+ * @param node The node.
+ * @param ui_data The UI data.
+ *
+ * @since 2.6.0
+ */
+void purple_blist_node_set_ui_data(PurpleBlistNode *node, gpointer ui_data);
+
+/**
+ * Checks whether a node has a particular setting.
+ *
+ * @param node The node in question
+ * @param key The name of a setting
+ * @return @c TRUE if @a node has any value set for @a key, and @c FALSE
+ * otherwise.
+ */
+gboolean purple_blist_node_has_setting(PurpleBlistNode *node, const char *key);
+
+/**
+ * Associates a boolean with a node in the buddy list
+ *
+ * @param node The node to associate the data with
+ * @param key The identifier for the data
+ * @param value The value to set
+ */
+void purple_blist_node_set_bool(PurpleBlistNode *node, const char *key, gboolean value);
+
+/**
+ * Retrieves a named boolean setting from a node in the buddy list
+ *
+ * @param node The node to retrieve the data from
+ * @param key The identifier of the data
+ *
+ * @return The value, or FALSE if there is no setting
+ */
+gboolean purple_blist_node_get_bool(PurpleBlistNode *node, const char *key);
+
+/**
+ * Associates an integer with a node in the buddy list
+ *
+ * @param node The node to associate the data with
+ * @param key The identifier for the data
+ * @param value The value to set
+ */
+void purple_blist_node_set_int(PurpleBlistNode *node, const char *key, int value);
+
+/**
+ * Retrieves a named integer setting from a node in the buddy list
+ *
+ * @param node The node to retrieve the data from
+ * @param key The identifier of the data
+ *
+ * @return The value, or 0 if there is no setting
+ */
+int purple_blist_node_get_int(PurpleBlistNode *node, const char *key);
+
+/**
+ * Associates a string with a node in the buddy list
+ *
+ * @param node The node to associate the data with
+ * @param key The identifier for the data
+ * @param value The value to set
+ */
+void purple_blist_node_set_string(PurpleBlistNode *node, const char *key,
+ const char *value);
+
+/**
+ * Retrieves a named string setting from a node in the buddy list
+ *
+ * @param node The node to retrieve the data from
+ * @param key The identifier of the data
+ *
+ * @return The value, or NULL if there is no setting
+ */
+const char *purple_blist_node_get_string(PurpleBlistNode *node, const char *key);
+
+/**
+ * Removes a named setting from a blist node
+ *
+ * @param node The node from which to remove the setting
+ * @param key The name of the setting
+ */
+void purple_blist_node_remove_setting(PurpleBlistNode *node, const char *key);
+
+/**
+ * Set the flags for the given node. Setting a node's flags will overwrite
+ * the old flags, so if you want to save them, you must first call
+ * purple_blist_node_get_flags and modify that appropriately.
+ *
+ * @param node The node on which to set the flags.
+ * @param flags The flags to set. This is a bitmask.
+ */
+void purple_blist_node_set_flags(PurpleBlistNode *node, PurpleBlistNodeFlags flags);
+
+/**
+ * Get the current flags on a given node.
+ *
+ * @param node The node from which to get the flags.
+ *
+ * @return The flags on the node. This is a bitmask.
+ */
+PurpleBlistNodeFlags purple_blist_node_get_flags(PurpleBlistNode *node);
+
+/*@}*/
+
+/**
+ * Retrieves the extended menu items for a buddy list node.
+ * @param n The blist node for which to obtain the extended menu items.
+ * @return A list of PurpleMenuAction items, as harvested by the
+ * blist-node-extended-menu signal.
+ */
+GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
+
+/**
+ * Get the GType for PurpleBlistNode
+ */
+GType purple_blist_node_get_gtype(void);
+
+#endif
============================================================
--- libpurple/buddy.h 55eb99b376c4e9012ebf94abcb580f504465feb5
+++ libpurple/buddy.h 55eb99b376c4e9012ebf94abcb580f504465feb5
@@ -0,0 +1,206 @@
+/**
+ * @file blist.h Buddy List API
+ * @ingroup core
+ * @see @ref blist-signals
+ */
+
+/* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
+ */
+#ifndef _PURPLE_BUDDY_H_
+#define _PURPLE_BUDDY_H_
+
+#include <glib.h>
+
+/** @copydoc _PurpleBuddy */
+typedef struct _PurpleBuddy PurpleBuddy;
+typedef struct _PurpleBuddyClass PurpleBuddyClass;
+
+#include "buddyicon.h"
+#include "status.h"
+
+#define PURPLE_BUDDY_TYPE (purple_buddy_get_type ())
+#define PURPLE_BUDDY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_BUDDY_TYPE, PurpleBuddy))
+#define PURPLE_IS_BUDDY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_BUDDY_TYPE))
+#define PURPLE_BUDDY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_BUDDY_TYPE, PurpleBuddyClass))
+#define PURPLE_IS_BUDDY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_BUDDY_TYPE))
+#define PURPLE_GET_BUDDY_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_BUDDY_TYPE, PurpleBuddyClass))
+
+#if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_BUDDY_C_)
+/**
+ * A buddy. This contains everything Purple will ever need to know about someone on the buddy list. Everything.
+ */
+struct _PurpleBuddy {
+ PurpleBlistNode node; /**< The node that this buddy inherits from */
+ char *name; /**< The name of the buddy. */
+ char *alias; /**< The user-set alias of the buddy */
+ char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */
+ void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */
+ PurpleBuddyIcon *icon; /**< The buddy icon. */
+ PurpleAccount *account; /**< the account this buddy belongs to */
+ PurplePresence *presence;
+};
+
+struct _PurpleBuddyClass {
+ PurpleBlistNodeClass parent;
+};
+
+#endif
+
+/**
+ * Creates a new buddy.
+ *
+ * This function only creates the PurpleBuddy. Use purple_blist_add_buddy
+ * to add the buddy to the list and purple_account_add_buddy to sync up
+ * with the server.
+ *
+ * @param account The account this buddy will get added to
+ * @param name The name of the new buddy
+ * @param alias The alias of the new buddy (or NULL if unaliased)
+ * @return A newly allocated buddy
+ *
+ * @see purple_account_add_buddy
+ * @see purple_blist_add_buddy
+ */
+PurpleBuddy *purple_buddy_new(PurpleAccount *account, const char *name, const char *alias);
+
+/**
+ * Destroys a buddy
+ *
+ * @param buddy The buddy to destroy
+ */
+void purple_buddy_destroy(PurpleBuddy *buddy);
+
+/**
+ * Sets a buddy's icon.
+ *
+ * This should only be called from within Purple. You probably want to
+ * call purple_buddy_icon_set_data().
+ *
+ * @param buddy The buddy.
+ * @param icon The buddy icon.
+ *
+ * @see purple_buddy_icon_set_data()
+ */
+void purple_buddy_set_icon(PurpleBuddy *buddy, PurpleBuddyIcon *icon);
+
+/**
+ * Gets the server alias for a buddy.
+ *
+ * @param buddy The buddy whose name will be returned
+ * @return The server alias, or NULL if it is not set.
+ */
+const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
+
+/**
+ * Returns the local alias for the buddy, or @c NULL if none exists.
+ *
+ * @param buddy The buddy
+ * @return The local alias for the buddy
+ *
+ * @since 2.6.0
+ */
+const char *purple_buddy_get_local_buddy_alias(PurpleBuddy *buddy);
+
+/**
+ * Returns a buddy's account.
+ *
+ * @param buddy The buddy.
+ *
+ * @return The account
+ */
+PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
+
+/**
+ * Returns a buddy's name
+ *
+ * @param buddy The buddy.
+ *
+ * @return The name.
+ */
+const char *purple_buddy_get_name(const PurpleBuddy *buddy);
+
+/**
+ * Returns a buddy's icon.
+ *
+ * @param buddy The buddy.
+ *
+ * @return The buddy icon.
+ */
+PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
+
+/**
+ * Returns a buddy's protocol-specific data.
+ *
+ * This should only be called from the associated prpl.
+ *
+ * @param buddy The buddy.
+ * @return The protocol data.
+ *
+ * @see purple_buddy_set_protocol_data()
+ * @since 2.6.0
+ */
+gpointer purple_buddy_get_protocol_data(const PurpleBuddy *buddy);
+
+/**
+ * Aliases a buddy in the buddy list.
+ *
+ * @param buddy The buddy whose alias will be changed.
+ * @param alias The buddy's alias.
+ */
+void purple_blist_alias_buddy(PurpleBuddy *buddy, const char *alias);
+
+/**
+* Returns the alias of a buddy.
+*
+* @param buddy The buddy whose name will be returned.
+* @return The alias (if set), server alias (if set),
+* or NULL.
+*/
+const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
+
+/**
+ * Sets a buddy's protocol-specific data.
+ *
+ * This should only be called from the associated prpl.
+ *
+ * @param buddy The buddy.
+ * @param data The data.
+ *
+ * @see purple_buddy_get_protocol_data()
+ * @since 2.6.0
+ */
+void purple_buddy_set_protocol_data(PurpleBuddy *buddy, gpointer data);
+
+/**
+ * Returns a buddy's presence.
+ *
+ * @param buddy The buddy.
+ *
+ * @return The buddy's presence.
+ */
+PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
+
+/**
+ * Get the GType for PurpleBuddy
+ */
+GType purple_buddy_get_type(void);
+
+#endif
============================================================
--- libpurple/chat.h 6bf9a79a648f9b556d194807f7e19ead8dc278ea
+++ libpurple/chat.h 6bf9a79a648f9b556d194807f7e19ead8dc278ea
@@ -0,0 +1,114 @@
+/**
+ * @file blist.h Buddy List API
+ * @ingroup core
+ * @see @ref blist-signals
+ */
+
+/* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
+ */
+#ifndef _PURPLE_CHAT_H_
+#define _PURPLE_CHAT_H_
+
+#include <glib.h>
+
+/** @copydoc _PurpleChat */
+typedef struct _PurpleChat PurpleChat;
+typedef struct _PurpleChatClass PurpleChatClass;
+
+#include "blist-node.h"
+
+#define PURPLE_CHAT_TYPE (purple_chat_get_type ())
+#define PURPLE_CHAT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_CHAT_TYPE, PurpleChat))
+#define PURPLE_IS_CHAT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_CHAT_TYPE))
+#define PURPLE_CHAT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_CHAT_TYPE, PurpleChatClass))
+#define PURPLE_IS_CHAT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_CHAT_TYPE))
+#define PURPLE_GET_CHAT_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_CHAT_TYPE, PurpleChatClass))
+
+#if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_CHAT_C_)
+
+/**
+ * A chat. This contains everything Purple needs to put a chat room in the
+ * buddy list.
+ */
+struct _PurpleChat {
+ PurpleBlistNode node; /**< The node that this chat inherits from */
+ char *alias; /**< The display name of this chat. */
+ GHashTable *components; /**< the stuff the protocol needs to know to join the chat */
+ PurpleAccount *account; /**< The account this chat is attached to */
+};
+
+struct _PurpleChatClass {
+ PurpleBlistNodeClass parent;
+};
+#endif
+
+/**
+ * Creates a new chat for the buddy list
+ *
+ * @param account The account this chat will get added to
+ * @param alias The alias of the new chat
+ * @param components The info the prpl needs to join the chat. The
+ * hash function should be g_str_hash() and the
+ * equal function should be g_str_equal().
+ * @return A newly allocated chat
+ */
+PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
+
+/**
+ * Destroys a chat
+ *
+ * @param chat The chat to destroy
+ */
+void purple_chat_destroy(PurpleChat *chat);
+
+/**
+ * Returns the correct name to display for a blist chat.
+ *
+ * @param chat The chat whose name will be returned.
+ * @return The alias (if set), or first component value.
+ */
+const char *purple_chat_get_name(PurpleChat *chat);
+
+/**
+ * Aliases a chat in the buddy list.
+ *
+ * @param chat The chat whose alias will be changed.
+ * @param alias The chat's new alias.
+ */
+void purple_blist_alias_chat(PurpleChat *chat, const char *alias);
+
+/**
+ * Get a hashtable containing information about a chat.
+ *
+ * @param chat The chat.
+ *
+ * @constreturn The hashtable.
+ *
+ * @since 2.4.0
+ */
+GHashTable *purple_chat_get_components(PurpleChat *chat);
+
+/**
+ * Get the GType for PurpleChat
+ */
+GType purple_chat_get_type(void);
+
+#endif
============================================================
--- libpurple/contact.h 5b1f6d24e0c1be2b58b3c61f9530d028ef648e5a
+++ libpurple/contact.h 5b1f6d24e0c1be2b58b3c61f9530d028ef648e5a
@@ -0,0 +1,182 @@
+/**
+ * @file blist.h Buddy List API
+ * @ingroup core
+ * @see @ref blist-signals
+ */
+
+/* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
+ */
+#ifndef _PURPLE_CONTACT_H_
+#define _PURPLE_CONTACT_H_
+
+#include <glib.h>
+
+/** @copydoc _PurpleContact */
+typedef struct _PurpleContact PurpleContact;
+typedef struct _PurpleContactClass PurpleContactClass;
+
+#include "buddy.h"
+
+#define PURPLE_CONTACT_TYPE (purple_contact_get_type ())
+#define PURPLE_CONTACT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_CONTACT_TYPE, PurpleContact))
+#define PURPLE_IS_CONTACT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_CONTACT_TYPE))
+#define PURPLE_CONTACT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_CONTACT_TYPE, PurpleContactClass))
+#define PURPLE_IS_CONTACT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_CONTACT_TYPE))
+#define PURPLE_GET_CONTACT_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_CONTACT_TYPE, PurpleContactClass))
+
+#if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_CONTACT_C_)
+/**
+ * A contact. This contains everything Purple will ever need to know about a contact.
+ */
+struct _PurpleContact {
+ PurpleBlistNode node; /**< The node that this contact inherits from. */
+ char *alias; /**< The user-set alias of the contact */
+ int totalsize; /**< The number of buddies in this contact */
+ int currentsize; /**< The number of buddies in this contact corresponding to online accounts */
+ int online; /**< The number of buddies in this contact who are currently online */
+ PurpleBuddy *priority; /**< The "top" buddy for this contact */
+ gboolean priority_valid; /**< Is priority valid? */
+};
+
+struct _PurpleContactClass {
+ PurpleBlistNodeClass parent;
+};
+#endif
+
+/**
+ * Creates a new contact
+ *
+ * @return A new contact struct
+ */
+PurpleContact *purple_contact_new(void);
+
+#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BUDDY_C_)
+/**
+ * Returns the correct alias for this user, ignoring server aliases. Used
+ * when a user-recognizable name is required. In order: buddy's alias; buddy's
+ * contact alias; buddy's user name.
+ *
+ * @param buddy The buddy whose alias will be returned.
+ * @return The appropriate name or alias.
+ * @deprecated Try purple_buddy_get_alias(), if server aliases are okay.
+ */
+const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
+#endif
+
+/**
+ * Returns the correct name to display for a buddy. In order of precedence:
+ * the buddy's alias; the buddy's server alias; the buddy's contact alias;
+ * the buddy's user name.
+ *
+ * @param buddy The buddy whose name will be returned.
+ * @return The appropriate name or alias, or NULL
+ */
+const char *purple_buddy_get_alias(PurpleBuddy *buddy);
+
+/**
+ * Destroys a contact
+ *
+ * @param contact The contact to destroy
+ */
+void purple_contact_destroy(PurpleContact *contact);
+
+/**
+ * Returns the highest priority buddy for a given contact.
+ *
+ * @param contact The contact
+ * @return The highest priority buddy
+ */
+PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
+
+#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONTACT_C_)
+/**
+ * Sets the alias for a contact.
+ *
+ * @param contact The contact
+ * @param alias The alias to set, or NULL to unset
+ *
+ * @deprecated Use purple_blist_alias_contact() instead.
+ */
+void purple_contact_set_alias(PurpleContact *contact, const char *alias);
+#endif
+
+/**
+ * Gets the alias for a contact.
+ *
+ * @param contact The contact
+ * @return The alias, or NULL if it is not set.
+ */
+const char *purple_contact_get_alias(PurpleContact *contact);
+
+/**
+ * Returns a buddy's contact.
+ *
+ * @param buddy The buddy.
+ *
+ * @return The buddy's contact.
+ */
+PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
+
+/**
+ * Merges two contacts
+ *
+ * All of the buddies from source will be moved to target
+ *
+ * @param source The contact to merge
+ * @param node The place to merge to (a buddy or contact)
+ */
+void purple_blist_merge_contact(PurpleContact *source, PurpleBlistNode *node);
+
+/**
+ * Returns the correct name to display for a buddy, taking the contact alias
+ * into account. In order of precedence: the buddy's alias; the buddy's
+ * contact alias; the buddy's server alias; the buddy's user name.
+ *
+ * @param buddy The buddy whose name will be returned
+ * @return The appropriate name or alias, or NULL.
+ *
+ */
+const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
+
+/**
+ * Determines whether an account owns any buddies in a given contact
+ *
+ * @param contact The contact to search through.
+ * @param account The account.
+ *
+ * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise.
+ */
+gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
+
+/**
+ * Invalidates the priority buddy so that the next call to
+ * purple_contact_get_priority_buddy recomputes it.
+ *
+ * @param contact The contact
+ */
+void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
+
+/**
+ * Get the GType for PurpleContact
+ */
+GType purple_contact_get_type(void);
+
+#endif
============================================================
--- libpurple/group.h fe615f7839c9eb8cc6b642e5ea5330f01923249d
+++ libpurple/group.h fe615f7839c9eb8cc6b642e5ea5330f01923249d
@@ -0,0 +1,150 @@
+/**
+ * @file blist.h Buddy List API
+ * @ingroup core
+ * @see @ref blist-signals
+ */
+
+/* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
+ */
+#ifndef _PURPLE_GROUP_H_
+#define _PURPLE_GROUP_H_
+
+#include <glib.h>
+
+/** @copydoc _PurpleGroup */
+typedef struct _PurpleGroup PurpleGroup;
+typedef struct _PurpleGroupClass PurpleGroupClass;
+
+#include "buddy.h"
+#include "chat.h"
+#include "contact.h"
+
+#define PURPLE_GROUP_TYPE (purple_group_get_type ())
+#define PURPLE_GROUP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_GROUP_TYPE, PurpleGroup))
+#define PURPLE_IS_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_GROUP_TYPE))
+#define PURPLE_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_GROUP_TYPE, PurpleGroupClass))
+#define PURPLE_IS_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_GROUP_TYPE))
+#define PURPLE_GET_GROUP_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_GROUP_TYPE, PurpleGroupClass))
+
+#if !(defined PURPLE_HIDE_STRUCTS) || (defined _PURPLE_GROUP_C_)
+/**
+ * A group. This contains everything Purple will ever need to know about a group.
+ */
+struct _PurpleGroup {
+ PurpleBlistNode node; /**< The node that this group inherits from */
+ char *name; /**< The name of this group. */
+ int totalsize; /**< The number of chats and contacts in this group */
+ int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */
+ int online; /**< The number of chats and contacts in this group who are currently online */
+};
+
+struct _PurpleGroupClass {
+ PurpleBlistNodeClass parent;
+};
+#endif
+
+/**
+ * Creates a new group
+ *
+ * You can't have more than one group with the same name. Sorry. If you pass
+ * this the name of a group that already exists, it will return that group.
+ *
+ * @param name The name of the new group
+ * @return A new group struct
+*/
+PurpleGroup *purple_group_new(const char *name);
+
+/**
+ * Destroys a group
+ *
+ * @param group The group to destroy
+*/
+void purple_group_destroy(PurpleGroup *group);
+
+/**
+ * Returns the group of which the buddy is a member.
+ *
+ * @param buddy The buddy
+ * @return The group or NULL if the buddy is not in a group
+ */
+PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
+
+/**
+ * Returns a list of accounts that have buddies in this group
+ *
+ * @param g The group
+ *
+ * @return A GSList of accounts (which must be freed), or NULL if the group
+ * has no accounts.
+ */
+GSList *purple_group_get_accounts(PurpleGroup *g);
+
+/**
+ * Determines whether an account owns any buddies in a given group
+ *
+ * @param g The group to search through.
+ * @param account The account.
+ *
+ * @return TRUE if there are any buddies in the group, or FALSE otherwise.
+ */
+gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
+
+/**
+ * Returns the name of a group.
+ *
+ * @param group The group.
+ *
+ * @return The name of the group.
+ */
+const char *purple_group_get_name(PurpleGroup *group);
+
+/**
+ * Determines the total size of a group
+ *
+ * @param group The group
+ * @param offline Count buddies in offline accounts
+ * @return The number of buddies in the group
+ */
+int purple_blist_get_group_size(PurpleGroup *group, gboolean offline);
+
+/**
+ * Returns the group of which the chat is a member.
+ *
+ * @param chat The chat.
+ *
+ * @return The parent group, or @c NULL if the chat is not in a group.
+ */
+PurpleGroup *purple_chat_get_group(PurpleChat *chat);
+
+/**
+ * Determines the number of online buddies in a group
+ *
+ * @param group The group
+ * @return The number of online buddies in the group, or 0 if the group is NULL
+ */
+int purple_blist_get_group_online_count(PurpleGroup *group);
+
+/**
+ * Get the GType for PurpleGroup
+ */
+GType purple_group_get_type(void);
+
+#endif
More information about the Commits
mailing list