2 * Copyright © 2010 Codethink Limited
3 * Copyright © 2011 Canonical Limited
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published
7 * by the Free Software Foundation; either version 2 of the licence or (at
8 * your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Authors: Ryan Lortie <desrt@desrt.ca>
23 #include "gdbusactiongroup-private.h"
25 #include "gremoteactiongroup.h"
26 #include "gdbusconnection.h"
27 #include "gactiongroup.h"
30 * SECTION:gdbusactiongroup
31 * @title: GDBusActionGroup
32 * @short_description: A D-Bus GActionGroup implementation
34 * @see_also: [GActionGroup exporter][gio-GActionGroup-exporter]
36 * #GDBusActionGroup is an implementation of the #GActionGroup
37 * interface that can be used as a proxy for an action group
38 * that is exported over D-Bus with g_dbus_connection_export_action_group().
41 struct _GDBusActionGroup
43 GObject parent_instance;
45 GDBusConnection *connection;
48 guint subscription_id;
51 /* The 'strict' flag indicates that the non-existence of at least one
52 * action has potentially been observed through the API. This means
53 * that we should always emit 'action-added' signals for all new
56 * The user can observe the non-existence of an action by listing the
57 * actions or by performing a query (such as parameter type) on a
58 * non-existent action.
60 * If the user has no way of knowing that a given action didn't
61 * already exist then we can skip emitting 'action-added' signals
62 * since they have no way of knowing that it wasn't there from the
68 typedef GObjectClass GDBusActionGroupClass;
73 GVariantType *parameter_type;
79 action_info_free (gpointer user_data)
81 ActionInfo *info = user_data;
86 g_variant_unref (info->state);
88 if (info->parameter_type)
89 g_variant_type_free (info->parameter_type);
91 g_slice_free (ActionInfo, info);
95 action_info_new_from_iter (GVariantIter *iter)
97 const gchar *param_str;
103 if (!g_variant_iter_next (iter, "{s(b&g@av)}", &name,
104 &enabled, ¶m_str, &state))
107 info = g_slice_new (ActionInfo);
109 info->enabled = enabled;
111 if (g_variant_n_children (state))
112 g_variant_get_child (state, 0, "v", &info->state);
115 g_variant_unref (state);
118 info->parameter_type = g_variant_type_copy ((GVariantType *) param_str);
120 info->parameter_type = NULL;
125 static void g_dbus_action_group_remote_iface_init (GRemoteActionGroupInterface *iface);
126 static void g_dbus_action_group_iface_init (GActionGroupInterface *iface);
127 G_DEFINE_TYPE_WITH_CODE (GDBusActionGroup, g_dbus_action_group, G_TYPE_OBJECT,
128 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_dbus_action_group_iface_init)
129 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_dbus_action_group_remote_iface_init))
132 g_dbus_action_group_changed (GDBusConnection *connection,
134 const gchar *object_path,
135 const gchar *interface_name,
136 const gchar *signal_name,
137 GVariant *parameters,
140 GDBusActionGroup *group = user_data;
141 GActionGroup *g_group = user_data;
143 /* make sure that we've been fully initialised */
144 if (group->actions == NULL)
147 if (g_str_equal (signal_name, "Changed") &&
148 g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(asa{sb}a{sv}a{s(bgav)})")))
155 g_variant_get_child (parameters, 0, "as", &iter);
156 while (g_variant_iter_next (iter, "&s", &name))
158 if (g_hash_table_lookup (group->actions, name))
160 g_hash_table_remove (group->actions, name);
161 g_action_group_action_removed (g_group, name);
164 g_variant_iter_free (iter);
173 g_variant_get_child (parameters, 1, "a{sb}", &iter);
174 while (g_variant_iter_next (iter, "{&sb}", &name, &enabled))
178 info = g_hash_table_lookup (group->actions, name);
180 if (info && info->enabled != enabled)
182 info->enabled = enabled;
183 g_action_group_action_enabled_changed (g_group, name, enabled);
186 g_variant_iter_free (iter);
195 g_variant_get_child (parameters, 2, "a{sv}", &iter);
196 while (g_variant_iter_next (iter, "{&sv}", &name, &state))
200 info = g_hash_table_lookup (group->actions, name);
202 if (info && info->state && !g_variant_equal (state, info->state) &&
203 g_variant_is_of_type (state, g_variant_get_type (info->state)))
205 g_variant_unref (info->state);
206 info->state = g_variant_ref (state);
208 g_action_group_action_state_changed (g_group, name, state);
211 g_variant_unref (state);
213 g_variant_iter_free (iter);
221 g_variant_get_child (parameters, 3, "a{s(bgav)}", &iter);
222 while ((info = action_info_new_from_iter (iter)))
224 if (!g_hash_table_lookup (group->actions, info->name))
226 g_hash_table_insert (group->actions, info->name, info);
229 g_action_group_action_added (g_group, info->name);
232 action_info_free (info);
234 g_variant_iter_free (iter);
241 g_dbus_action_group_describe_all_done (GObject *source,
242 GAsyncResult *result,
245 GDBusActionGroup *group= user_data;
248 g_assert (group->actions == NULL);
249 group->actions = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, action_info_free);
251 g_assert (group->connection == (gpointer) source);
252 reply = g_dbus_connection_call_finish (group->connection, result, NULL);
259 g_variant_get (reply, "(a{s(bgav)})", &iter);
260 while ((action = action_info_new_from_iter (iter)))
262 g_hash_table_insert (group->actions, action->name, action);
265 g_action_group_action_added (G_ACTION_GROUP (group), action->name);
267 g_variant_iter_free (iter);
268 g_variant_unref (reply);
271 g_object_unref (group);
276 g_dbus_action_group_async_init (GDBusActionGroup *group)
278 if (group->subscription_id != 0)
281 group->subscription_id =
282 g_dbus_connection_signal_subscribe (group->connection, group->bus_name, "org.gtk.Actions", "Changed", group->object_path,
283 NULL, G_DBUS_SIGNAL_FLAGS_NONE, g_dbus_action_group_changed, group, NULL);
285 g_dbus_connection_call (group->connection, group->bus_name, group->object_path, "org.gtk.Actions", "DescribeAll", NULL,
286 G_VARIANT_TYPE ("(a{s(bgav)})"), G_DBUS_CALL_FLAGS_NONE, -1, NULL,
287 g_dbus_action_group_describe_all_done, g_object_ref (group));
291 g_dbus_action_group_list_actions (GActionGroup *g_group)
293 GDBusActionGroup *group = G_DBUS_ACTION_GROUP (g_group);
296 if (group->actions != NULL)
302 n = g_hash_table_size (group->actions);
303 keys = g_new (gchar *, n + 1);
305 g_hash_table_iter_init (&iter, group->actions);
306 while (g_hash_table_iter_next (&iter, &key, NULL))
307 keys[i++] = g_strdup (key);
308 g_assert_cmpint (i, ==, n);
313 g_dbus_action_group_async_init (group);
314 keys = g_new0 (gchar *, 1);
317 group->strict = TRUE;
323 g_dbus_action_group_query_action (GActionGroup *g_group,
324 const gchar *action_name,
326 const GVariantType **parameter_type,
327 const GVariantType **state_type,
328 GVariant **state_hint,
331 GDBusActionGroup *group = G_DBUS_ACTION_GROUP (g_group);
334 if (group->actions != NULL)
336 info = g_hash_table_lookup (group->actions, action_name);
340 group->strict = TRUE;
345 *enabled = info->enabled;
348 *parameter_type = info->parameter_type;
351 *state_type = info->state ? g_variant_get_type (info->state) : NULL;
357 *state = info->state ? g_variant_ref (info->state) : NULL;
363 g_dbus_action_group_async_init (group);
364 group->strict = TRUE;
371 g_dbus_action_group_activate_action_full (GRemoteActionGroup *remote,
372 const gchar *action_name,
374 GVariant *platform_data)
376 GDBusActionGroup *group = G_DBUS_ACTION_GROUP (remote);
377 GVariantBuilder builder;
379 g_variant_builder_init (&builder, G_VARIANT_TYPE ("av"));
382 g_variant_builder_add (&builder, "v", parameter);
384 g_dbus_connection_call (group->connection, group->bus_name, group->object_path, "org.gtk.Actions", "Activate",
385 g_variant_new ("(sav@a{sv})", action_name, &builder, platform_data),
386 NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
390 g_dbus_action_group_change_action_state_full (GRemoteActionGroup *remote,
391 const gchar *action_name,
393 GVariant *platform_data)
395 GDBusActionGroup *group = G_DBUS_ACTION_GROUP (remote);
397 g_dbus_connection_call (group->connection, group->bus_name, group->object_path, "org.gtk.Actions", "SetState",
398 g_variant_new ("(sv@a{sv})", action_name, value, platform_data),
399 NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
403 g_dbus_action_group_change_state (GActionGroup *group,
404 const gchar *action_name,
407 g_dbus_action_group_change_action_state_full (G_REMOTE_ACTION_GROUP (group),
408 action_name, value, g_variant_new ("a{sv}", NULL));
412 g_dbus_action_group_activate (GActionGroup *group,
413 const gchar *action_name,
416 g_dbus_action_group_activate_action_full (G_REMOTE_ACTION_GROUP (group),
417 action_name, parameter, g_variant_new ("a{sv}", NULL));
421 g_dbus_action_group_finalize (GObject *object)
423 GDBusActionGroup *group = G_DBUS_ACTION_GROUP (object);
425 if (group->subscription_id)
426 g_dbus_connection_signal_unsubscribe (group->connection, group->subscription_id);
429 g_hash_table_unref (group->actions);
431 g_object_unref (group->connection);
432 g_free (group->object_path);
433 g_free (group->bus_name);
435 G_OBJECT_CLASS (g_dbus_action_group_parent_class)
440 g_dbus_action_group_init (GDBusActionGroup *group)
445 g_dbus_action_group_class_init (GDBusActionGroupClass *class)
447 GObjectClass *object_class = G_OBJECT_CLASS (class);
449 object_class->finalize = g_dbus_action_group_finalize;
453 g_dbus_action_group_remote_iface_init (GRemoteActionGroupInterface *iface)
455 iface->activate_action_full = g_dbus_action_group_activate_action_full;
456 iface->change_action_state_full = g_dbus_action_group_change_action_state_full;
460 g_dbus_action_group_iface_init (GActionGroupInterface *iface)
462 iface->list_actions = g_dbus_action_group_list_actions;
463 iface->query_action = g_dbus_action_group_query_action;
464 iface->change_action_state = g_dbus_action_group_change_state;
465 iface->activate_action = g_dbus_action_group_activate;
469 * g_dbus_action_group_get:
470 * @connection: A #GDBusConnection
471 * @bus_name: the bus name which exports the action group
472 * @object_path: the object path at which the action group is exported
474 * Obtains a #GDBusActionGroup for the action group which is exported at
475 * the given @bus_name and @object_path.
477 * The thread default main context is taken at the time of this call.
478 * All signals on the menu model (and any linked models) are reported
479 * with respect to this context. All calls on the returned menu model
480 * (and linked models) must also originate from this same context, with
481 * the thread default main context unchanged.
483 * This call is non-blocking. The returned action group may or may not
484 * already be filled in. The correct thing to do is connect the signals
485 * for the action group to monitor for changes and then to call
486 * g_action_group_list_actions() to get the initial list.
488 * Returns: (transfer full): a #GDBusActionGroup
493 g_dbus_action_group_get (GDBusConnection *connection,
494 const gchar *bus_name,
495 const gchar *object_path)
497 GDBusActionGroup *group;
499 group = g_object_new (G_TYPE_DBUS_ACTION_GROUP, NULL);
500 group->connection = g_object_ref (connection);
501 group->bus_name = g_strdup (bus_name);
502 group->object_path = g_strdup (object_path);
508 g_dbus_action_group_sync (GDBusActionGroup *group,
509 GCancellable *cancellable,
514 g_assert (group->subscription_id == 0);
516 group->subscription_id =
517 g_dbus_connection_signal_subscribe (group->connection, group->bus_name, "org.gtk.Actions", "Changed", group->object_path,
518 NULL, G_DBUS_SIGNAL_FLAGS_NONE, g_dbus_action_group_changed, group, NULL);
520 reply = g_dbus_connection_call_sync (group->connection, group->bus_name, group->object_path, "org.gtk.Actions",
521 "DescribeAll", NULL, G_VARIANT_TYPE ("(a{s(bgav)})"),
522 G_DBUS_CALL_FLAGS_NONE, -1, cancellable, error);
529 g_assert (group->actions == NULL);
530 group->actions = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, action_info_free);
532 g_variant_get (reply, "(a{s(bgav)})", &iter);
533 while ((action = action_info_new_from_iter (iter)))
534 g_hash_table_insert (group->actions, action->name, action);
535 g_variant_iter_free (iter);
536 g_variant_unref (reply);
539 return reply != NULL;