* 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 * 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 typedef struct _PurpleRoomlistPrivate PurpleRoomlistPrivate; * Private data for a room list. struct _PurpleRoomlistPrivate { PurpleAccount *account; /* The account this list belongs to. */ GList *fields; /* The fields. */ GList *rooms; /* The list of rooms. */ gboolean in_progress; /* The listing is in progress. */ /* TODO Remove this and use protocol-specific subclasses. */ gpointer proto_data; /* Protocol private data. */ struct _PurpleRoomlistRoom { PurpleRoomlistRoomType type; /* The type of room. */ gchar *name; /* The name of the room. */ GList *fields; /* Other fields. */ PurpleRoomlistRoom *parent; /* The parent room, or NULL. */ gboolean expanded_once; /* A flag the UI uses to avoid multiple expand protocol cbs. */ * A field a room might have. struct _PurpleRoomlistField { PurpleRoomlistFieldType type; /* The type of field. */ gchar *label; /* The i18n user displayed name of the field. */ gchar *name; /* The internal name of the field. */ gboolean hidden; /* Hidden? */ /* Room list property enums */ static GParamSpec *properties[PROP_LAST]; static PurpleRoomlistUiOps *ops = NULL; G_DEFINE_TYPE_WITH_PRIVATE(PurpleRoomlist, purple_roomlist, G_TYPE_OBJECT); static void purple_roomlist_field_free(PurpleRoomlistField *f); static void purple_roomlist_room_destroy(PurpleRoomlist *list, PurpleRoomlistRoom *r); /**************************************************************************/ /**************************************************************************/ void purple_roomlist_show_with_account(PurpleAccount *account) if (ops && ops->show_with_account) ops->show_with_account(account); PurpleAccount *purple_roomlist_get_account(PurpleRoomlist *list) PurpleRoomlistPrivate *priv = NULL; g_return_val_if_fail(PURPLE_IS_ROOMLIST(list), NULL); priv = purple_roomlist_get_instance_private(list); void purple_roomlist_set_fields(PurpleRoomlist *list, GList *fields) PurpleRoomlistPrivate *priv = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); priv = purple_roomlist_get_instance_private(list); if (ops && ops->set_fields) ops->set_fields(list, fields); g_object_notify_by_pspec(G_OBJECT(list), properties[PROP_FIELDS]); void purple_roomlist_set_in_progress(PurpleRoomlist *list, gboolean in_progress) PurpleRoomlistPrivate *priv = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); priv = purple_roomlist_get_instance_private(list); priv->in_progress = in_progress; if (ops && ops->in_progress) ops->in_progress(list, in_progress); g_object_notify_by_pspec(G_OBJECT(list), properties[PROP_IN_PROGRESS]); gboolean purple_roomlist_get_in_progress(PurpleRoomlist *list) PurpleRoomlistPrivate *priv = NULL; g_return_val_if_fail(PURPLE_IS_ROOMLIST(list), FALSE); priv = purple_roomlist_get_instance_private(list); return priv->in_progress; void purple_roomlist_room_add(PurpleRoomlist *list, PurpleRoomlistRoom *room) PurpleRoomlistPrivate *priv = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); g_return_if_fail(room != NULL); priv = purple_roomlist_get_instance_private(list); priv->rooms = g_list_append(priv->rooms, room); if (ops && ops->add_room) ops->add_room(list, room); PurpleRoomlist *purple_roomlist_get_list(PurpleConnection *gc) PurpleProtocol *protocol = NULL; g_return_val_if_fail(PURPLE_IS_CONNECTION(gc), NULL); g_return_val_if_fail(PURPLE_CONNECTION_IS_CONNECTED(gc), NULL); protocol = purple_connection_get_protocol(gc); return purple_protocol_roomlist_iface_get_list(protocol, gc); void purple_roomlist_cancel_get_list(PurpleRoomlist *list) PurpleRoomlistPrivate *priv = NULL; PurpleProtocol *protocol = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); priv = purple_roomlist_get_instance_private(list); gc = purple_account_get_connection(priv->account); g_return_if_fail(PURPLE_IS_CONNECTION(gc)); protocol = purple_connection_get_protocol(gc); purple_protocol_roomlist_iface_cancel(protocol, list); void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category) PurpleRoomlistPrivate *priv = NULL; PurpleProtocol *protocol = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); g_return_if_fail(category != NULL); g_return_if_fail(category->type & PURPLE_ROOMLIST_ROOMTYPE_CATEGORY); priv = purple_roomlist_get_instance_private(list); gc = purple_account_get_connection(priv->account); g_return_if_fail(PURPLE_IS_CONNECTION(gc)); protocol = purple_connection_get_protocol(gc); purple_protocol_roomlist_iface_expand_category(protocol, list, category); GList * purple_roomlist_get_fields(PurpleRoomlist *list) PurpleRoomlistPrivate *priv = NULL; g_return_val_if_fail(PURPLE_IS_ROOMLIST(list), NULL); priv = purple_roomlist_get_instance_private(list); gpointer purple_roomlist_get_protocol_data(PurpleRoomlist *list) PurpleRoomlistPrivate *priv = NULL; g_return_val_if_fail(PURPLE_IS_ROOMLIST(list), NULL); priv = purple_roomlist_get_instance_private(list); void purple_roomlist_set_protocol_data(PurpleRoomlist *list, gpointer proto_data) PurpleRoomlistPrivate *priv = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); priv = purple_roomlist_get_instance_private(list); priv->proto_data = proto_data; gpointer purple_roomlist_get_ui_data(PurpleRoomlist *list) g_return_val_if_fail(PURPLE_IS_ROOMLIST(list), NULL); void purple_roomlist_set_ui_data(PurpleRoomlist *list, gpointer ui_data) g_return_if_fail(PURPLE_IS_ROOMLIST(list)); /**************************************************************************/ /* Room List GObject code */ /**************************************************************************/ /* Set method for GObject properties */ purple_roomlist_set_property(GObject *obj, guint param_id, const GValue *value, PurpleRoomlist *list = PURPLE_ROOMLIST(obj); PurpleRoomlistPrivate *priv = purple_roomlist_get_instance_private(list); priv->account = g_value_get_object(value); purple_roomlist_set_fields(list, g_value_get_pointer(value)); purple_roomlist_set_in_progress(list, g_value_get_boolean(value)); G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec); /* Get method for GObject properties */ purple_roomlist_get_property(GObject *obj, guint param_id, GValue *value, PurpleRoomlist *list = PURPLE_ROOMLIST(obj); g_value_set_object(value, purple_roomlist_get_account(list)); g_value_set_pointer(value, purple_roomlist_get_fields(list)); g_value_set_boolean(value, purple_roomlist_get_in_progress(list)); G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec); purple_roomlist_init(PurpleRoomlist *list) /* Called when done constructing */ purple_roomlist_constructed(GObject *object) PurpleRoomlist *list = PURPLE_ROOMLIST(object); G_OBJECT_CLASS(purple_roomlist_parent_class)->constructed(object); /* GObject finalize function */ purple_roomlist_finalize(GObject *object) PurpleRoomlist *list = PURPLE_ROOMLIST(object); PurpleRoomlistPrivate *priv = purple_roomlist_get_instance_private(list); purple_debug_misc("roomlist", "destroying list %p\n", list); for (l = priv->rooms; l; l = l->next) { PurpleRoomlistRoom *r = l->data; purple_roomlist_room_destroy(list, r); g_list_free(priv->rooms); g_list_free_full(priv->fields, (GDestroyNotify)purple_roomlist_field_free); G_OBJECT_CLASS(purple_roomlist_parent_class)->finalize(object); /* Class initializer function */ purple_roomlist_class_init(PurpleRoomlistClass *klass) GObjectClass *obj_class = G_OBJECT_CLASS(klass); obj_class->finalize = purple_roomlist_finalize; obj_class->constructed = purple_roomlist_constructed; obj_class->get_property = purple_roomlist_get_property; obj_class->set_property = purple_roomlist_set_property; properties[PROP_ACCOUNT] = g_param_spec_object("account", "Account", "The account for the room list.", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | properties[PROP_FIELDS] = g_param_spec_pointer("fields", "Fields", "The list of fields for a roomlist.", G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); properties[PROP_IN_PROGRESS] = g_param_spec_boolean("in-progress", "Whether the room list is being fetched.", FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); g_object_class_install_properties(obj_class, PROP_LAST, properties); PurpleRoomlist *purple_roomlist_new(PurpleAccount *account) PurpleProtocol *protocol; g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), NULL); protocol = purple_protocols_find(purple_account_get_protocol_id(account)); g_return_val_if_fail(PURPLE_IS_PROTOCOL(protocol), NULL); if (PURPLE_PROTOCOL_IMPLEMENTS(protocol, FACTORY, roomlist_new)) list = purple_protocol_factory_iface_roomlist_new(protocol, account); list = g_object_new(PURPLE_TYPE_ROOMLIST, g_return_val_if_fail(list != NULL, NULL); /************************************************************************** * Protocol Roomlist Interface API **************************************************************************/ #define DEFINE_PROTOCOL_FUNC(protocol,funcname,...) \ PurpleProtocolRoomlistInterface *roomlist_iface = \ PURPLE_PROTOCOL_ROOMLIST_GET_IFACE(protocol); \ if (roomlist_iface && roomlist_iface->funcname) \ roomlist_iface->funcname(__VA_ARGS__); #define DEFINE_PROTOCOL_FUNC_WITH_RETURN(protocol,defaultreturn,funcname,...) \ PurpleProtocolRoomlistInterface *roomlist_iface = \ PURPLE_PROTOCOL_ROOMLIST_GET_IFACE(protocol); \ if (roomlist_iface && roomlist_iface->funcname) \ return roomlist_iface->funcname(__VA_ARGS__); \ purple_protocol_roomlist_iface_get_type(void) if (G_UNLIKELY(type == 0)) { static const GTypeInfo info = { .class_size = sizeof(PurpleProtocolRoomlistInterface), type = g_type_register_static(G_TYPE_INTERFACE, "PurpleProtocolRoomlistInterface", &info, 0); purple_protocol_roomlist_iface_get_list(PurpleProtocol *protocol, DEFINE_PROTOCOL_FUNC_WITH_RETURN(protocol, NULL, get_list, gc); purple_protocol_roomlist_iface_cancel(PurpleProtocol *protocol, DEFINE_PROTOCOL_FUNC(protocol, cancel, list); purple_protocol_roomlist_iface_expand_category(PurpleProtocol *protocol, PurpleRoomlist *list, PurpleRoomlistRoom *category) DEFINE_PROTOCOL_FUNC(protocol, expand_category, list, category); purple_protocol_roomlist_iface_room_serialize(PurpleProtocol *protocol, PurpleRoomlistRoom *room) DEFINE_PROTOCOL_FUNC_WITH_RETURN(protocol, NULL, room_serialize, room); #undef DEFINE_PROTOCOL_FUNC_WITH_RETURN #undef DEFINE_PROTOCOL_FUNC /**************************************************************************/ /**************************************************************************/ PurpleRoomlistRoom *purple_roomlist_room_new(PurpleRoomlistRoomType type, const gchar *name, PurpleRoomlistRoom *parent) PurpleRoomlistRoom *room; g_return_val_if_fail(name != NULL, NULL); room = g_new0(PurpleRoomlistRoom, 1); room->name = g_strdup(name); void purple_roomlist_room_add_field(PurpleRoomlist *list, PurpleRoomlistRoom *room, gconstpointer field) PurpleRoomlistPrivate *priv = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); g_return_if_fail(room != NULL); priv = purple_roomlist_get_instance_private(list); g_return_if_fail(priv->fields != NULL); /* If this is the first call for this room, grab the first field in * the Roomlist's fields. Otherwise, grab the field that is one * more than the number of fields already present for the room. * (This works because g_list_nth_data() is zero-indexed and * g_list_length() is one-indexed.) */ f = g_list_nth_data(priv->fields, g_list_length(room->fields)); g_return_if_fail(f != NULL); case PURPLE_ROOMLIST_FIELD_STRING: room->fields = g_list_append(room->fields, g_strdup(field)); case PURPLE_ROOMLIST_FIELD_BOOL: case PURPLE_ROOMLIST_FIELD_INT: room->fields = g_list_append(room->fields, GINT_TO_POINTER(field)); g_object_notify_by_pspec(G_OBJECT(list), properties[PROP_FIELDS]); void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room) PurpleRoomlistPrivate *priv = NULL; g_return_if_fail(PURPLE_IS_ROOMLIST(list)); g_return_if_fail(room != NULL); priv = purple_roomlist_get_instance_private(list); gc = purple_account_get_connection(priv->account); components = g_hash_table_new(g_str_hash, g_str_equal); g_hash_table_replace(components, "name", room->name); for (l = priv->fields, j = room->fields; l && j; l = l->next, j = j->next) { PurpleRoomlistField *f = l->data; g_hash_table_replace(components, f->name, j->data); purple_serv_join_chat(gc, components); g_hash_table_destroy(components); PurpleRoomlistRoomType purple_roomlist_room_get_room_type(PurpleRoomlistRoom *room) const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room) PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room) gboolean purple_roomlist_room_get_expanded_once(PurpleRoomlistRoom *room) g_return_val_if_fail(room != NULL, FALSE); return room->expanded_once; void purple_roomlist_room_set_expanded_once(PurpleRoomlistRoom *room, gboolean expanded_once) g_return_if_fail(room != NULL); room->expanded_once = expanded_once; GList *purple_roomlist_room_get_fields(PurpleRoomlistRoom *room) static void purple_roomlist_room_destroy(PurpleRoomlist *list, PurpleRoomlistRoom *r) PurpleRoomlistPrivate *priv = purple_roomlist_get_instance_private(list); for (l = priv->fields, j = r->fields; l && j; l = l->next, j = j->next) { PurpleRoomlistField *f = l->data; if (f->type == PURPLE_ROOMLIST_FIELD_STRING) /**************************************************************************/ /**************************************************************************/ static PurpleRoomlistRoom *purple_roomlist_room_copy(PurpleRoomlistRoom *r) g_return_val_if_fail(r != NULL, NULL); return purple_roomlist_room_new(r->type, r->name, r->parent); static void purple_roomlist_room_free(PurpleRoomlistRoom *r) g_return_if_fail(r != NULL); GType purple_roomlist_room_get_type(void) type = g_boxed_type_register_static("PurpleRoomlistRoom", (GBoxedCopyFunc)purple_roomlist_room_copy, (GBoxedFreeFunc)purple_roomlist_room_free); /**************************************************************************/ /**************************************************************************/ PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type, const gchar *label, const gchar *name, g_return_val_if_fail(label != NULL, NULL); g_return_val_if_fail(name != NULL, NULL); f = g_new0(PurpleRoomlistField, 1); f->label = g_strdup(label); f->name = g_strdup(name); PurpleRoomlistFieldType purple_roomlist_field_get_field_type(PurpleRoomlistField *field) const char * purple_roomlist_field_get_label(PurpleRoomlistField *field) gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field) /**************************************************************************/ /* Room Field GBoxed code */ /**************************************************************************/ static PurpleRoomlistField *purple_roomlist_field_copy(PurpleRoomlistField *f) g_return_val_if_fail(f != NULL, NULL); return purple_roomlist_field_new(f->type, f->label, f->name, f->hidden); static void purple_roomlist_field_free(PurpleRoomlistField *f) g_return_if_fail(f != NULL); GType purple_roomlist_field_get_type(void) type = g_boxed_type_register_static("PurpleRoomlistField", (GBoxedCopyFunc)purple_roomlist_field_copy, (GBoxedFreeFunc)purple_roomlist_field_free); /**************************************************************************/ /* UI Registration Functions */ /**************************************************************************/ void purple_roomlist_set_ui_ops(PurpleRoomlistUiOps *ui_ops) PurpleRoomlistUiOps *purple_roomlist_get_ui_ops(void) /************************************************************************** **************************************************************************/ static PurpleRoomlistUiOps * purple_roomlist_ui_ops_copy(PurpleRoomlistUiOps *ops) PurpleRoomlistUiOps *ops_new; g_return_val_if_fail(ops != NULL, NULL); ops_new = g_new(PurpleRoomlistUiOps, 1); purple_roomlist_ui_ops_get_type(void) type = g_boxed_type_register_static("PurpleRoomlistUiOps", (GBoxedCopyFunc)purple_roomlist_ui_ops_copy,