add TpRoomInfo

1 files changed, 308 insertions, 0 deletions

diff --git a/telepathy-glib/room-info.c b/telepathy-glib/room-info.c
new file mode 100644
index 000000000..119ddd2b3
--- /dev/null
+++ b/telepathy-glib/room-info.c
@@ -0,0 +1,308 @@
+/*
+ * room-info.c
+ *
+ * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#include "config.h"
+
+#include "room-info.h"
+#include "room-info-internal.h"
+
+#include <telepathy-glib/gtypes.h>
+#include <telepathy-glib/dbus.h>
+
+/**
+ * SECTION: room-info
+ * @title: TpRoomInfo
+ * @short_description: a room found by #TpRoomListChannel
+ *
+ * #TpRoomInfo represents a room found during a room listing using
+ * #TpRoomListChannel.
+ *
+ * See also: #TpRoomListChannel
+ */
+
+/**
+ * TpRoomInfo:
+ *
+ * Data structure representing a #TpRoomInfo.
+ *
+ * Since: UNRELEASED
+ */
+
+/**
+ * TpRoomInfoClass:
+ *
+ * The class of a #TpRoomInfo.
+ *
+ * Since: UNRELEASED
+ */
+
+G_DEFINE_TYPE (TpRoomInfo, tp_room_info, G_TYPE_OBJECT)
+
+struct _TpRoomInfoPriv {
+  TpHandle handle;
+  gchar *channel_type;
+  GHashTable *hash;
+};
+
+static void
+tp_room_info_finalize (GObject *object)
+{
+  TpRoomInfo *self = TP_ROOM_INFO (object);
+  void (*chain_up) (GObject *) =
+      ((GObjectClass *) tp_room_info_parent_class)->finalize;
+
+  g_free (self->priv->channel_type);
+  g_hash_table_unref (self->priv->hash);
+
+  if (chain_up != NULL)
+    chain_up (object);
+}
+
+static void
+tp_room_info_class_init (
+    TpRoomInfoClass *klass)
+{
+  GObjectClass *oclass = G_OBJECT_CLASS (klass);
+
+  oclass->finalize = tp_room_info_finalize;
+
+  g_type_class_add_private (klass, sizeof (TpRoomInfoPriv));
+}
+
+static void
+tp_room_info_init (TpRoomInfo *self)
+{
+  self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
+      TP_TYPE_ROOM_INFO, TpRoomInfoPriv);
+}
+
+TpRoomInfo *
+_tp_room_info_new (GValueArray *dbus_struct)
+{
+  TpRoomInfo *room;
+  GValue *v;
+
+  g_return_val_if_fail (dbus_struct != NULL, NULL);
+  g_return_val_if_fail (dbus_struct->n_values == 3, NULL);
+
+  /* We don't want to expose the GValueArray in the API so it's not
+   * a GObject property. */
+  room = g_object_new (TP_TYPE_ROOM_INFO,
+      NULL);
+
+  v = g_value_array_get_nth (dbus_struct, 0);
+  room->priv->handle = g_value_get_uint (v);
+
+  v = g_value_array_get_nth (dbus_struct, 1);
+  room->priv->channel_type = g_value_dup_string (v);
+
+  v = g_value_array_get_nth (dbus_struct, 2);
+  room->priv->hash = g_value_dup_boxed (v);
+
+  return room;
+}
+
+/**
+ * tp_room_info_get_handle:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: the #TpHandle of the room
+ *
+ * Since: UNRELEASED
+ */
+TpHandle
+tp_room_info_get_handle (TpRoomInfo *self)
+{
+  return self->priv->handle;
+}
+
+/**
+ * tp_room_info_get_channel_type:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: a string representing the D-Bus interface name of
+ * the channel type of the room
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_channel_type (TpRoomInfo *self)
+{
+  return self->priv->channel_type;
+}
+
+/**
+ * tp_room_info_get_handle_name:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: the identifier of the room (as would be returned
+ * by inspecting the #TpHandle returned by tp_room_info_get_handle())
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_handle_name (TpRoomInfo *self)
+{
+  return tp_asv_get_string (self->priv->hash, "handle-name");
+}
+
+/**
+ * tp_room_info_get_name:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: the human-readable name of the room if different
+ * from the handle
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_name (TpRoomInfo *self)
+{
+  return tp_asv_get_string (self->priv->hash, "name");
+}
+
+/**
+ * tp_room_info_get_description:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: a description of the room's overall purpose
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_description (TpRoomInfo *self)
+{
+  return tp_asv_get_string (self->priv->hash, "description");
+}
+
+/**
+ * tp_room_info_get_subject:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: the current subject of conversation in the room
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_subject (TpRoomInfo *self)
+{
+  return tp_asv_get_string (self->priv->hash, "subject");
+}
+
+/**
+ * tp_room_info_get_members:
+ * @self: a #TpRoomInfo
+ * @known: either %NULL, or a location in which to store %TRUE if the
+ * returned value is meaningful
+ *
+ * <!-- -->
+ *
+ * Returns: the number of members in the room
+ *
+ * Since: UNRELEASED
+ */
+guint
+tp_room_info_get_members (TpRoomInfo *self,
+    gboolean *known)
+{
+  return tp_asv_get_uint32 (self->priv->hash, "members", known);
+}
+
+/**
+ * tp_room_info_get_requires_password:
+ * @self: a #TpRoomInfo
+ * @known: either %NULL, or a location in which to store %TRUE if the
+ * returned value is meaningful
+ *
+ * <!-- -->
+ *
+ * Returns: %TRUE if the room requires a password to enter
+ *
+ * Since: UNRELEASED
+ */
+gboolean
+tp_room_info_get_requires_password (TpRoomInfo *self,
+    gboolean *known)
+{
+  return tp_asv_get_boolean (self->priv->hash, "password", known);
+}
+
+/**
+ * tp_room_info_get_invite_only:
+ * @self: a #TpRoomInfo
+ * @known: either %NULL, or a location in which to store %TRUE if the
+ * returned value is meaningful
+ *
+ * <!-- -->
+ *
+ * Returns: %TRUE if you cannot join the room, but must be invited
+ *
+ * Since: UNRELEASED
+ */
+gboolean
+tp_room_info_get_invite_only (TpRoomInfo *self,
+    gboolean *known)
+{
+  return tp_asv_get_boolean (self->priv->hash, "invite-only", known);
+}
+
+/**
+ * tp_room_info_get_room_id:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: the human-readable identifier of the room
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_room_id (TpRoomInfo *self)
+{
+  return tp_asv_get_string (self->priv->hash, "room-id");
+}
+
+/**
+ * tp_room_info_get_server:
+ * @self: a #TpRoomInfo
+ *
+ * <!-- -->
+ *
+ * Returns: the DNS name of the server hosting the room
+ *
+ * Since: UNRELEASED
+ */
+const gchar *
+tp_room_info_get_server (TpRoomInfo *self)
+{
+  return tp_asv_get_string (self->priv->hash, "server");
+}