[glib] add GPropertyAction
- From: Ryan Lortie <ryanl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] add GPropertyAction
- Date: Thu, 11 Jul 2013 16:36:06 +0000 (UTC)
commit f77e1216500986ae60b42a77e25717e1710c6013
Author: Ryan Lortie <desrt desrt ca>
Date: Fri Jun 28 11:41:43 2013 -0400
add GPropertyAction
Add a new type of GAction that represents the value of a property on an
object. As an example, this might be used on the "visible-child-name"
property of a GtkStack.
https://bugzilla.gnome.org/show_bug.cgi?id=703270
docs/reference/gio/gio-docs.xml | 1 +
docs/reference/gio/gio-sections.txt | 15 +
gio/Makefile.am | 2 +
gio/gio.h | 1 +
gio/giotypes.h | 1 +
gio/gpropertyaction.c | 555 +++++++++++++++++++++++++++++++++++
gio/gpropertyaction.h | 49 +++
gio/tests/actions.c | 174 +++++++++++-
8 files changed, 797 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml
index 5e3cff1..b2ddae2 100644
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -210,6 +210,7 @@
<xi:include href="xml/gsimpleactiongroup.xml"/>
<xi:include href="xml/gaction.xml"/>
<xi:include href="xml/gsimpleaction.xml"/>
+ <xi:include href="xml/gpropertyaction.xml"/>
<xi:include href="xml/gremoteactiongroup.xml"/>
<xi:include href="xml/gactiongroupexporter.xml"/>
<xi:include href="xml/gdbusactiongroup.xml"/>
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index 45fd759..3674a3d 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -3148,6 +3148,21 @@ G_SIMPLE_ACTION
</SECTION>
<SECTION>
+<FILE>gpropertyaction</FILE>
+<TITLE>GPropertyAction</TITLE>
+GPropertyAction
+
+<SUBSECTION>
+g_property_action_new
+
+<SUBSECTION Standard>
+g_property_action_get_type
+G_TYPE_PROPERTY_ACTION
+G_IS_PROPERTY_ACTION
+G_PROPERTY_ACTION
+</SECTION>
+
+<SECTION>
<FILE>gsimpleactiongroup</FILE>
<TITLE>GSimpleActionGroup</TITLE>
GSimpleActionGroup
diff --git a/gio/Makefile.am b/gio/Makefile.am
index 1e7b6b7..33d5885 100644
--- a/gio/Makefile.am
+++ b/gio/Makefile.am
@@ -145,6 +145,7 @@ application_headers = \
gactiongroupexporter.h \
gdbusactiongroup.h \
gaction.h \
+ gpropertyaction.h \
gsimpleaction.h \
\
gmenumodel.h \
@@ -167,6 +168,7 @@ application_sources = \
gdbusactiongroup-private.h \
gdbusactiongroup.c \
gaction.c \
+ gpropertyaction.c \
gsimpleaction.c \
\
gmenumodel.c \
diff --git a/gio/gio.h b/gio/gio.h
index d27b911..fadcd58 100644
--- a/gio/gio.h
+++ b/gio/gio.h
@@ -100,6 +100,7 @@
#include <gio/gpollableinputstream.h>
#include <gio/gpollableoutputstream.h>
#include <gio/gpollableutils.h>
+#include <gio/gpropertyaction.h>
#include <gio/gproxy.h>
#include <gio/gproxyaddress.h>
#include <gio/gproxyaddressenumerator.h>
diff --git a/gio/giotypes.h b/gio/giotypes.h
index d09bfae..adcbdae 100644
--- a/gio/giotypes.h
+++ b/gio/giotypes.h
@@ -52,6 +52,7 @@ typedef struct _GRemoteActionGroup GRemoteActionGroup;
typedef struct _GDBusActionGroup GDBusActionGroup;
typedef struct _GActionMap GActionMap;
typedef struct _GActionGroup GActionGroup;
+typedef struct _GPropertyAction GPropertyAction;
typedef struct _GSimpleAction GSimpleAction;
typedef struct _GAction GAction;
typedef struct _GApplication GApplication;
diff --git a/gio/gpropertyaction.c b/gio/gpropertyaction.c
new file mode 100644
index 0000000..5e90c7a
--- /dev/null
+++ b/gio/gpropertyaction.c
@@ -0,0 +1,555 @@
+/*
+ * Copyright © 2013 Canonical Limited
+ *
+ * This program 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 of the licence 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., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Ryan Lortie <desrt desrt ca>
+ */
+
+#include "config.h"
+
+#include "gpropertyaction.h"
+
+#include "gsettings-mapping.h"
+#include "gaction.h"
+#include "glibintl.h"
+
+/**
+ * SECTION:gpropertyaction
+ * @title: GPropertyAction
+ * @short_description: A GAction reflecting a GObject property
+ *
+ * A #GPropertyAction is a way to get a #GAction with a state value
+ * reflecting and controlling the value of a #GObject property.
+ *
+ * The state of the action will correspond to the value of the property.
+ * Changing it will change the property (assuming the requested value
+ * matches the requirements as specified in the #GParamSpec).
+ *
+ * Only the most common types are presently supported. Booleans are
+ * mapped to booleans, strings to strings, signed/unsigned integers to
+ * int32/uint32 and floats and doubles to doubles.
+ *
+ * If the property is an enum then the state will be string-typed and
+ * conversion will automatically be performed between the enum value and
+ * "nick" string as per the #GEnumValue table.
+ *
+ * Flags types are not currently supported.
+ *
+ * Properties of object types, boxed types and pointer types are not
+ * supported and probably never will be.
+ *
+ * Properties of #GVariant types are not currently supported.
+ *
+ * If the property is boolean-valued then the action will have a NULL
+ * parameter type, and activating the action (with no parameter) will
+ * toggle the value of the property.
+ *
+ * In all other cases, the parameter type will correspond to the type of
+ * the property.
+ *
+ * The general idea here is to reduce the number of locations where a
+ * particular piece of state is kept (and therefore has to be
+ * synchronised between). #GPropertyAction does not have a separate
+ * state that is kept in sync with the property value -- its state
+ * <em>is</em> the property value.
+ *
+ * For example, it might be useful to create a #GAction corresponding to
+ * the "visible-child-name" property of a #GtkStack so that the current
+ * page can be switched from a menu. The active radio indication in the
+ * menu is then directly determined from the active page of the
+ * #GtkStack.
+ *
+ * An anti-example would be binding the "active-id" property on a
+ * #GtkComboBox. This is because the state of the combobox itself is
+ * probably uninteresting and is actually being used to control
+ * something else.
+ *
+ * Another anti-example would be to bind to the "visible-child-name"
+ * property of a #GtkStack if this value is actually stored in
+ * #GSettings. In that case, the real source of the value is
+ * #GSettings. If you want a #GAction to control a setting stored in
+ * #GSettings, see g_settings_create_action() instead, and possibly
+ * combine its use with g_settings_bind().
+ *
+ * Since: 2.38
+ **/
+struct _GPropertyAction
+{
+ GObject parent_instance;
+
+ gchar *name;
+ gpointer object;
+ GParamSpec *pspec;
+ const GVariantType *state_type;
+};
+
+/**
+ * GPropertyAction:
+ *
+ * This type is opaque.
+ *
+ * Since: 2.38
+ **/
+
+typedef GObjectClass GPropertyActionClass;
+
+static void g_property_action_iface_init (GActionInterface *iface);
+G_DEFINE_TYPE_WITH_CODE (GPropertyAction, g_property_action, G_TYPE_OBJECT,
+ G_IMPLEMENT_INTERFACE (G_TYPE_ACTION, g_property_action_iface_init))
+
+enum
+{
+ PROP_NONE,
+ PROP_NAME,
+ PROP_PARAMETER_TYPE,
+ PROP_ENABLED,
+ PROP_STATE_TYPE,
+ PROP_STATE,
+ PROP_OBJECT,
+ PROP_PROPERTY_NAME
+};
+
+static const gchar *
+g_property_action_get_name (GAction *action)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (action);
+
+ return paction->name;
+}
+
+static const GVariantType *
+g_property_action_get_parameter_type (GAction *action)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (action);
+
+ return paction->pspec->value_type == G_TYPE_BOOLEAN ? NULL : paction->state_type;
+}
+
+static const GVariantType *
+g_property_action_get_state_type (GAction *action)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (action);
+
+ return paction->state_type;
+}
+
+static GVariant *
+g_property_action_get_state_hint (GAction *action)
+{
+ return NULL;
+}
+
+static gboolean
+g_property_action_get_enabled (GAction *action)
+{
+ return TRUE;
+}
+
+static void
+g_property_action_set_state (GPropertyAction *paction,
+ GVariant *variant)
+{
+ GValue value = G_VALUE_INIT;
+
+ g_value_init (&value, paction->pspec->value_type);
+ g_settings_get_mapping (&value, variant, NULL);
+ g_object_set_property (paction->object, paction->pspec->name, &value);
+ g_value_unset (&value);
+}
+
+static void
+g_property_action_change_state (GAction *action,
+ GVariant *value)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (action);
+
+ g_return_if_fail (g_variant_is_of_type (value, paction->state_type));
+
+ g_property_action_set_state (paction, value);
+}
+
+static GVariant *
+g_property_action_get_state (GAction *action)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (action);
+ GValue value = G_VALUE_INIT;
+ GVariant *result;
+
+ g_value_init (&value, paction->pspec->value_type);
+ g_object_get_property (paction->object, paction->pspec->name, &value);
+ result = g_settings_set_mapping (&value, paction->state_type, NULL);
+ g_value_unset (&value);
+
+ return g_variant_ref_sink (result);
+}
+
+static void
+g_property_action_activate (GAction *action,
+ GVariant *parameter)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (action);
+
+ if (paction->pspec->value_type == G_TYPE_BOOLEAN)
+ {
+ gboolean value;
+
+ g_return_if_fail (paction->pspec->value_type == G_TYPE_BOOLEAN && parameter == NULL);
+
+ g_object_get (paction->object, paction->pspec->name, &value, NULL);
+ value = !value;
+ g_object_set (paction->object, paction->pspec->name, value, NULL);
+ }
+ else
+ {
+ g_return_if_fail (parameter != NULL && g_variant_is_of_type (parameter, paction->state_type));
+
+ g_property_action_set_state (paction, parameter);
+ }
+}
+
+static const GVariantType *
+g_property_action_determine_type (GParamSpec *pspec)
+{
+ if (G_TYPE_IS_ENUM (pspec->value_type))
+ return G_VARIANT_TYPE_STRING;
+
+ switch (pspec->value_type)
+ {
+ case G_TYPE_BOOLEAN:
+ return G_VARIANT_TYPE_BOOLEAN;
+
+ case G_TYPE_INT:
+ return G_VARIANT_TYPE_INT32;
+
+ case G_TYPE_UINT:
+ return G_VARIANT_TYPE_UINT32;
+
+ case G_TYPE_DOUBLE:
+ case G_TYPE_FLOAT:
+ return G_VARIANT_TYPE_DOUBLE;
+
+ case G_TYPE_STRING:
+ return G_VARIANT_TYPE_STRING;
+
+ default:
+ g_critical ("Unable to use GPropertyAction with property '%s::%s' of type '%s'",
+ g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->value_type));
+ return NULL;
+ }
+}
+
+static void
+g_property_action_notify (GObject *object,
+ GParamSpec *pspec,
+ gpointer user_data)
+{
+ GPropertyAction *paction = user_data;
+
+ g_assert (object == paction->object);
+ g_assert (pspec == paction->pspec);
+
+ g_object_notify (G_OBJECT (paction), "state");
+}
+
+static void
+g_property_action_set_property_name (GPropertyAction *paction,
+ const gchar *property_name)
+{
+ GParamSpec *pspec;
+ gchar *detailed;
+
+ pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (paction->object), property_name);
+
+ if (pspec == NULL)
+ {
+ g_critical ("Attempted to use non-existent property '%s::%s' for GPropertyAction",
+ G_OBJECT_TYPE_NAME (paction->object), property_name);
+ return;
+ }
+
+ if (~pspec->flags & G_PARAM_READABLE || ~pspec->flags & G_PARAM_WRITABLE || pspec->flags &
G_PARAM_CONSTRUCT_ONLY)
+ {
+ g_critical ("Property '%s::%s' used with GPropertyAction must be readable, writable, and not
construct-only",
+ G_OBJECT_TYPE_NAME (paction->object), property_name);
+ return;
+ }
+
+ paction->pspec = pspec;
+
+ detailed = g_strconcat ("notify::", paction->pspec->name, NULL);
+ paction->state_type = g_property_action_determine_type (paction->pspec);
+ g_signal_connect (paction->object, detailed, G_CALLBACK (g_property_action_notify), paction);
+ g_free (detailed);
+}
+
+static void
+g_property_action_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (object);
+
+ switch (prop_id)
+ {
+ case PROP_NAME:
+ paction->name = g_value_dup_string (value);
+ break;
+
+ case PROP_OBJECT:
+ paction->object = g_value_dup_object (value);
+ break;
+
+ case PROP_PROPERTY_NAME:
+ g_property_action_set_property_name (paction, g_value_get_string (value));
+ break;
+
+ default:
+ g_assert_not_reached ();
+ }
+}
+
+static void
+g_property_action_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GAction *action = G_ACTION (object);
+
+ switch (prop_id)
+ {
+ case PROP_NAME:
+ g_value_set_string (value, g_property_action_get_name (action));
+ break;
+
+ case PROP_PARAMETER_TYPE:
+ g_value_set_boxed (value, g_property_action_get_parameter_type (action));
+ break;
+
+ case PROP_ENABLED:
+ g_value_set_boolean (value, g_property_action_get_enabled (action));
+ break;
+
+ case PROP_STATE_TYPE:
+ g_value_set_boxed (value, g_property_action_get_state_type (action));
+ break;
+
+ case PROP_STATE:
+ g_value_take_variant (value, g_property_action_get_state (action));
+ break;
+
+ default:
+ g_assert_not_reached ();
+ }
+}
+
+static void
+g_property_action_finalize (GObject *object)
+{
+ GPropertyAction *paction = G_PROPERTY_ACTION (object);
+
+ g_signal_handlers_disconnect_by_func (paction->object, g_property_action_notify, paction);
+ g_object_unref (paction->object);
+ g_free (paction->name);
+
+ G_OBJECT_CLASS (g_property_action_parent_class)
+ ->finalize (object);
+}
+
+void
+g_property_action_init (GPropertyAction *property)
+{
+}
+
+void
+g_property_action_iface_init (GActionInterface *iface)
+{
+ iface->get_name = g_property_action_get_name;
+ iface->get_parameter_type = g_property_action_get_parameter_type;
+ iface->get_state_type = g_property_action_get_state_type;
+ iface->get_state_hint = g_property_action_get_state_hint;
+ iface->get_enabled = g_property_action_get_enabled;
+ iface->get_state = g_property_action_get_state;
+ iface->change_state = g_property_action_change_state;
+ iface->activate = g_property_action_activate;
+}
+
+void
+g_property_action_class_init (GPropertyActionClass *class)
+{
+ GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+ object_class->set_property = g_property_action_set_property;
+ object_class->get_property = g_property_action_get_property;
+ object_class->finalize = g_property_action_finalize;
+
+ /**
+ * GPropertyAction:name:
+ *
+ * The name of the action. This is mostly meaningful for identifying
+ * the action once it has been added to a #GActionMap.
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_NAME,
+ g_param_spec_string ("name",
+ P_("Action Name"),
+ P_("The name used to invoke the action"),
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GPropertyAction:parameter-type:
+ *
+ * The type of the parameter that must be given when activating the
+ * action.
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_PARAMETER_TYPE,
+ g_param_spec_boxed ("parameter-type",
+ P_("Parameter Type"),
+ P_("The type of GVariant passed to activate()"),
+ G_TYPE_VARIANT_TYPE,
+ G_PARAM_READABLE |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GPropertyAction:enabled:
+ *
+ * If @action is currently enabled.
+ *
+ * If the action is disabled then calls to g_action_activate() and
+ * g_action_change_state() have no effect.
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_ENABLED,
+ g_param_spec_boolean ("enabled",
+ P_("Enabled"),
+ P_("If the action can be activated"),
+ TRUE,
+ G_PARAM_READABLE |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GPropertyAction:state-type:
+ *
+ * The #GVariantType of the state that the action has, or %NULL if the
+ * action is stateless.
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_STATE_TYPE,
+ g_param_spec_boxed ("state-type",
+ P_("State Type"),
+ P_("The type of the state kept by the action"),
+ G_TYPE_VARIANT_TYPE,
+ G_PARAM_READABLE |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GPropertyAction:state:
+ *
+ * The state of the action, or %NULL if the action is stateless.
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_STATE,
+ g_param_spec_variant ("state",
+ P_("State"),
+ P_("The state the action is in"),
+ G_VARIANT_TYPE_ANY,
+ NULL,
+ G_PARAM_READABLE |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GPropertyAction:object:
+ *
+ * The object to wrap a property on.
+ *
+ * The object must be a non-%NULL #GObject with properties.
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_OBJECT,
+ g_param_spec_object ("object",
+ P_("Object"),
+ P_("The object with the property to wrap"),
+ G_TYPE_OBJECT,
+ G_PARAM_WRITABLE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GPropertyAction:property-name:
+ *
+ * The name of the property to wrap on the object.
+ *
+ * The property must exist on the passed-in object and it must be
+ * readable and writable (and not construct-only).
+ *
+ * Since: 2.38
+ **/
+ g_object_class_install_property (object_class, PROP_PROPERTY_NAME,
+ g_param_spec_string ("property-name",
+ P_("Property name"),
+ P_("The name of the property to wrap"),
+ NULL,
+ G_PARAM_WRITABLE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+}
+
+/**
+ * g_property_action_new:
+ * @name: the name of the action to create
+ * @object: the object that has the property to wrap
+ * @property_name: the name of the property
+ *
+ * Creates a #GAction corresponding to the value of property
+ * @property_name on @object.
+ *
+ * The property must be existent and readable and writable (and not
+ * construct-only).
+ *
+ * This function takes a reference on @object and doesn't release it
+ * until the action is destroyed.
+ *
+ * Returns: a new #GPropertyAction
+ *
+ * Since: 2.38
+ **/
+GPropertyAction *
+g_property_action_new (const gchar *name,
+ gpointer object,
+ const gchar *property_name)
+{
+ g_return_val_if_fail (name != NULL, NULL);
+ g_return_val_if_fail (G_IS_OBJECT (object), NULL);
+ g_return_val_if_fail (property_name != NULL, NULL);
+
+ return g_object_new (G_TYPE_PROPERTY_ACTION,
+ "name", name,
+ "object", object,
+ "property-name", property_name,
+ NULL);
+}
diff --git a/gio/gpropertyaction.h b/gio/gpropertyaction.h
new file mode 100644
index 0000000..3a43af8
--- /dev/null
+++ b/gio/gpropertyaction.h
@@ -0,0 +1,49 @@
+/*
+ * Copyright © 2013 Canonical Limited
+ *
+ * This program 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 of the licence 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., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Ryan Lortie <desrt desrt ca>
+ */
+
+#ifndef __G_PROPERTY_ACTION_H__
+#define __G_PROPERTY_ACTION_H__
+
+#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
+#error "Only <gio/gio.h> can be included directly."
+#endif
+
+#include <gio/giotypes.h>
+
+G_BEGIN_DECLS
+
+#define G_TYPE_PROPERTY_ACTION (g_property_action_get_type ())
+#define G_PROPERTY_ACTION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst),
\
+ G_TYPE_PROPERTY_ACTION, GPropertyAction))
+#define G_IS_PROPERTY_ACTION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst),
\
+ G_TYPE_PROPERTY_ACTION))
+
+GLIB_AVAILABLE_IN_2_38
+GType g_property_action_get_type (void) G_GNUC_CONST;
+
+GLIB_AVAILABLE_IN_2_38
+GPropertyAction * g_property_action_new (const gchar *name,
+ gpointer object,
+ const gchar *property_name);
+
+G_END_DECLS
+
+#endif /* __G_PROPERTY_ACTION_H__ */
diff --git a/gio/tests/actions.c b/gio/tests/actions.c
index b9ba675..8d165e4 100644
--- a/gio/tests/actions.c
+++ b/gio/tests/actions.c
@@ -904,6 +904,178 @@ test_bug679509 (void)
session_bus_down ();
}
+static gchar *state_change_log;
+
+static void
+state_changed (GActionGroup *group,
+ const gchar *action_name,
+ GVariant *value,
+ gpointer user_data)
+{
+ GString *string;
+
+ g_assert (!state_change_log);
+
+ string = g_string_new (action_name);
+ g_string_append_c (string, ':');
+ g_variant_print_string (value, string, TRUE);
+ state_change_log = g_string_free (string, FALSE);
+}
+
+static void
+verify_changed (const gchar *log_entry)
+{
+ g_assert_cmpstr (state_change_log, ==, log_entry);
+ g_clear_pointer (&state_change_log, g_free);
+}
+
+static void
+ensure_state (GSimpleActionGroup *group,
+ const gchar *action_name,
+ const gchar *expected)
+{
+ GVariant *value;
+ gchar *printed;
+
+ value = g_action_group_get_action_state (G_ACTION_GROUP (group), action_name);
+ printed = g_variant_print (value, TRUE);
+ g_variant_unref (value);
+
+ g_assert_cmpstr (printed, ==, expected);
+ g_free (printed);
+}
+
+static void
+test_property_actions (void)
+{
+ GSimpleActionGroup *group;
+ GPropertyAction *action;
+ GSocketClient *client;
+ GApplication *app;
+
+ group = g_simple_action_group_new ();
+ g_signal_connect (group, "action-state-changed", G_CALLBACK (state_changed), NULL);
+
+ client = g_socket_client_new ();
+ app = g_application_new ("org.gtk.test", 0);
+
+ /* string... */
+ action = g_property_action_new ("app-id", app, "application-id");
+ g_action_map_add_action (G_ACTION_MAP (group), G_ACTION (action));
+ g_object_unref (action);
+
+ /* uint... */
+ action = g_property_action_new ("keepalive", app, "inactivity-timeout");
+ g_action_map_add_action (G_ACTION_MAP (group), G_ACTION (action));
+ g_object_unref (action);
+
+ /* bool... */
+ action = g_property_action_new ("tls", client, "tls");
+ g_action_map_add_action (G_ACTION_MAP (group), G_ACTION (action));
+ g_object_unref (action);
+
+ /* enum... */
+ action = g_property_action_new ("type", client, "type");
+ g_action_map_add_action (G_ACTION_MAP (group), G_ACTION (action));
+ g_object_unref (action);
+
+ /* the objects should be held alive by the actions... */
+ g_object_unref (client);
+ g_object_unref (app);
+
+ ensure_state (group, "app-id", "'org.gtk.test'");
+ ensure_state (group, "keepalive", "uint32 0");
+ ensure_state (group, "tls", "false");
+ ensure_state (group, "type", "'stream'");
+
+ verify_changed (NULL);
+
+ /* some string tests... */
+ g_action_group_change_action_state (G_ACTION_GROUP (group), "app-id", g_variant_new ("s",
"org.gtk.test2"));
+ verify_changed ("app-id:'org.gtk.test2'");
+ g_assert_cmpstr (g_application_get_application_id (app), ==, "org.gtk.test2");
+ ensure_state (group, "app-id", "'org.gtk.test2'");
+
+ g_action_group_activate_action (G_ACTION_GROUP (group), "app-id", g_variant_new ("s", "org.gtk.test3"));
+ verify_changed ("app-id:'org.gtk.test3'");
+ g_assert_cmpstr (g_application_get_application_id (app), ==, "org.gtk.test3");
+ ensure_state (group, "app-id", "'org.gtk.test3'");
+
+ g_application_set_application_id (app, "org.gtk.test");
+ verify_changed ("app-id:'org.gtk.test'");
+ ensure_state (group, "app-id", "'org.gtk.test'");
+
+ /* uint tests */
+ g_action_group_change_action_state (G_ACTION_GROUP (group), "keepalive", g_variant_new ("u", 1234));
+ verify_changed ("keepalive:uint32 1234");
+ g_assert_cmpuint (g_application_get_inactivity_timeout (app), ==, 1234);
+ ensure_state (group, "keepalive", "uint32 1234");
+
+ g_action_group_activate_action (G_ACTION_GROUP (group), "keepalive", g_variant_new ("u", 5678));
+ verify_changed ("keepalive:uint32 5678");
+ g_assert_cmpuint (g_application_get_inactivity_timeout (app), ==, 5678);
+ ensure_state (group, "keepalive", "uint32 5678");
+
+ g_application_set_inactivity_timeout (app, 0);
+ verify_changed ("keepalive:uint32 0");
+ ensure_state (group, "keepalive", "uint32 0");
+
+ /* bool tests */
+ g_action_group_change_action_state (G_ACTION_GROUP (group), "tls", g_variant_new ("b", TRUE));
+ verify_changed ("tls:true");
+ g_assert (g_socket_client_get_tls (client));
+ ensure_state (group, "tls", "true");
+
+ /* test toggle true->false */
+ g_action_group_activate_action (G_ACTION_GROUP (group), "tls", NULL);
+ verify_changed ("tls:false");
+ g_assert (!g_socket_client_get_tls (client));
+ ensure_state (group, "tls", "false");
+
+ /* and now back false->true */
+ g_action_group_activate_action (G_ACTION_GROUP (group), "tls", NULL);
+ verify_changed ("tls:true");
+ g_assert (g_socket_client_get_tls (client));
+ ensure_state (group, "tls", "true");
+
+ g_socket_client_set_tls (client, FALSE);
+ verify_changed ("tls:false");
+ ensure_state (group, "tls", "false");
+
+ /* enum tests */
+ g_action_group_change_action_state (G_ACTION_GROUP (group), "type", g_variant_new ("s", "datagram"));
+ verify_changed ("type:'datagram'");
+ g_assert_cmpint (g_socket_client_get_socket_type (client), ==, G_SOCKET_TYPE_DATAGRAM);
+ ensure_state (group, "type", "'datagram'");
+
+ g_action_group_activate_action (G_ACTION_GROUP (group), "type", g_variant_new ("s", "stream"));
+ verify_changed ("type:'stream'");
+ g_assert_cmpint (g_socket_client_get_socket_type (client), ==, G_SOCKET_TYPE_STREAM);
+ ensure_state (group, "type", "'stream'");
+
+ g_socket_client_set_socket_type (client, G_SOCKET_TYPE_SEQPACKET);
+ verify_changed ("type:'seqpacket'");
+ ensure_state (group, "type", "'seqpacket'");
+
+ /* Check some error cases... */
+ g_test_expect_message ("GLib-GIO", G_LOG_LEVEL_CRITICAL, "*non-existent*");
+ action = g_property_action_new ("foo", app, "xyz");
+ g_test_assert_expected_messages ();
+ g_object_unref (action);
+
+ g_test_expect_message ("GLib-GIO", G_LOG_LEVEL_CRITICAL, "*writable*");
+ action = g_property_action_new ("foo", app, "is-registered");
+ g_test_assert_expected_messages ();
+ g_object_unref (action);
+
+ g_test_expect_message ("GLib-GIO", G_LOG_LEVEL_CRITICAL, "*type 'GSocketAddress'*");
+ action = g_property_action_new ("foo", client, "local-address");
+ g_test_assert_expected_messages ();
+ g_object_unref (action);
+
+ g_object_unref (group);
+}
+
int
main (int argc, char **argv)
{
@@ -916,7 +1088,7 @@ main (int argc, char **argv)
g_test_add_func ("/actions/parse-detailed", test_parse_detailed);
g_test_add_func ("/actions/dbus/export", test_dbus_export);
g_test_add_func ("/actions/dbus/threaded", test_dbus_threaded);
- g_test_add_func ("/actions/dbus/bug679509", test_bug679509);
+ g_test_add_func ("/actions/property", test_property_actions);
return g_test_run ();
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
