luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-06 02:51:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename exporter APIs

Browse Source 
There are no public 'exporter' objects, so don't allude to them
in the function names. At the same time, we want to make it clear
that these functions are D-Bus specific.

The new APIs are
g_action_group_dbus_export_start
g_action_group_dbus_export_query
g_action_group_dbus_export_stop
g_menu_model_dbus_export_start
g_menu_model_dbus_export_query
g_menu_model_dbus_export_stop
This commit is contained in:
Matthias Clasen 2011-11-26 23:21:12 -05:00 committed by Ryan Lortie
parent 435b2418da
commit db34b1aebe
10 changed files with 78 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/reference/gio/gio-sections.txt
View File

@ -2909,9 +2909,9 @@ G_ACTION_GROUP
<SECTION> <SECTION>
<FILE>gactiongroupexporter</FILE> <FILE>gactiongroupexporter</FILE>
g_action_group_exporter_export g_action_group_dbus_export_start
g_action_group_exporter_stop g_action_group_dbus_export_stop
g_action_group_exporter_query g_action_group_dbus_export_query
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -3545,9 +3545,9 @@ G_NETWORK_MONITOR_GET_INTERFACE
<SECTION> <SECTION>
<FILE>gmenuexporter</FILE> <FILE>gmenuexporter</FILE>
g_menu_exporter_export g_menu_model_dbus_export_start
g_menu_exporter_stop g_menu_model_dbus_export_stop
g_menu_exporter_query g_menu_model_dbus_export_query
</SECTION> </SECTION>
<SECTION> <SECTION>

30
gio/gactiongroupexporter.c
View File

@ -455,7 +455,7 @@ org_gtk_Actions_method_call (GDBusConnection *connection,
} }
/** /**
* g_action_group_exporter_export: * g_action_group_dbus_export_start:
* @connection: a #GDBusConnection * @connection: a #GDBusConnection
* @object_path: a D-Bus object path * @object_path: a D-Bus object path
* @action_group: a #GActionGroup * @action_group: a #GActionGroup
@ -467,22 +467,22 @@ org_gtk_Actions_method_call (GDBusConnection *connection,
* subject to change in the future. * subject to change in the future.
* *
* A given action group can only be exported on one object path and an * A given action group can only be exported on one object path and an
* object_path can only have one action group exported on it. If either * object path can only have one action group exported on it. If either
* constraint is violated, the export will fail and %FALSE will be * constraint is violated, the export will fail and %FALSE will be
* returned (with @error set accordingly). * returned (with @error set accordingly).
* *
* Use g_action_group_exporter_stop() to stop exporting @action_group, * Use g_action_group_dbus_export_stop() to stop exporting @action_group,
* or g_action_group_exporter_query() to find out if and where a given * or g_action_group_dbus_export_query() to find out if and where a given
* action group is exported. * action group is exported.
* *
* Returns: %TRUE if the export is successful, or %FALSE (with @error * Returns: %TRUE if the export is successful, or %FALSE (with @error
* set) in the event of a failure. * set) in the event of a failure.
**/ **/
gboolean gboolean
g_action_group_exporter_export (GDBusConnection *connection, g_action_group_dbus_export_start (GDBusConnection *connection,
const gchar *object_path, const gchar *object_path,
GActionGroup *action_group, GActionGroup *action_group,
GError **error) GError **error)
{ {
const GDBusInterfaceVTable vtable = { const GDBusInterfaceVTable vtable = {
org_gtk_Actions_method_call org_gtk_Actions_method_call
@ -547,19 +547,19 @@ g_action_group_exporter_export (GDBusConnection *connection,
} }
/** /**
* g_action_group_exporter_stop: * g_action_group_dbus_export_stop:
* @action_group: a #GActionGroup * @action_group: a #GActionGroup
* *
* Stops the export of @action_group. * Stops the export of @action_group.
* *
* This reverses the effect of a previous call to * This reverses the effect of a previous call to
* g_action_group_exporter_export() for @action_group. * g_action_group_dbus_export_start() for @action_group.
* *
* Returns: %TRUE if an export was stopped or %FALSE if @action_group * Returns: %TRUE if an export was stopped or %FALSE if @action_group
* was not exported in the first place * was not exported in the first place
**/ **/
gboolean gboolean
g_action_group_exporter_stop (GActionGroup *action_group) g_action_group_dbus_export_stop (GActionGroup *action_group)
{ {
GActionGroupExporter *exporter; GActionGroupExporter *exporter;
gint i; gint i;
@ -584,7 +584,7 @@ g_action_group_exporter_stop (GActionGroup *action_group)
} }
/** /**
* g_action_group_exporter_query: * g_action_group_dbus_export_query:
* @action_group: a #GActionGroup * @action_group: a #GActionGroup
* @connection: (out): the #GDBusConnection used for exporting * @connection: (out): the #GDBusConnection used for exporting
* @object_path: (out): the object path used for exporting * @object_path: (out): the object path used for exporting
@ -601,9 +601,9 @@ g_action_group_exporter_stop (GActionGroup *action_group)
* Returns: %TRUE if @action_group was exported, else %FALSE * Returns: %TRUE if @action_group was exported, else %FALSE
**/ **/
gboolean gboolean
g_action_group_exporter_query (GActionGroup *action_group, g_action_group_dbus_export_query (GActionGroup *action_group,
GDBusConnection **connection, GDBusConnection **connection,
const gchar **object_path) const gchar **object_path)
{ {
GActionGroupExporter *exporter; GActionGroupExporter *exporter;

16
gio/gactiongroupexporter.h
View File

@ -32,16 +32,16 @@
G_BEGIN_DECLS G_BEGIN_DECLS
gboolean g_action_group_exporter_export (GDBusConnection *connection, gboolean g_action_group_dbus_export_start (GDBusConnection *connection,
const gchar *object_path, const gchar *object_path,
GActionGroup *action_group, GActionGroup *action_group,
GError **error); GError **error);
gboolean g_action_group_exporter_stop (GActionGroup *action_group); gboolean g_action_group_dbus_export_stop (GActionGroup *action_group);
gboolean g_action_group_exporter_query (GActionGroup *action_group, gboolean g_action_group_dbus_export_query (GActionGroup *action_group,
GDBusConnection **connection, GDBusConnection **connection,
const gchar **object_path); const gchar **object_path);
G_END_DECLS G_END_DECLS

28
gio/gapplicationimpl-dbus.c
View File

@ -239,9 +239,9 @@ g_application_impl_destroy (GApplicationImpl *impl)
g_dbus_connection_unregister_object (impl->session_bus, g_dbus_connection_unregister_object (impl->session_bus,
impl->object_id); impl->object_id);
if (impl->actions_exported) if (impl->actions_exported)
g_action_group_exporter_stop (impl->app); g_action_group_dbus_export_stop (impl->app);
if (impl->menu_exported) if (impl->menu_exported)
g_menu_exporter_stop (g_application_get_menu (impl->app)); g_menu_model_dbus_export_stop (g_application_get_menu (impl->app));
g_dbus_connection_call (impl->session_bus, g_dbus_connection_call (impl->session_bus,
"org.freedesktop.DBus", "org.freedesktop.DBus",
@ -324,9 +324,9 @@ g_application_impl_register (GApplication *application,
return NULL; return NULL;
} }
if (!g_action_group_exporter_export (impl->session_bus, if (!g_action_group_dbus_export_start (impl->session_bus,
impl->object_path, impl->object_path,
impl->app, error)) impl->app, error))
{ {
g_dbus_connection_unregister_object (impl->session_bus, g_dbus_connection_unregister_object (impl->session_bus,
impl->object_id); impl->object_id);
@ -343,12 +343,12 @@ g_application_impl_register (GApplication *application,
if (g_application_get_menu (impl->app)) if (g_application_get_menu (impl->app))
{ {
if (!g_menu_exporter_export (impl->session_bus, if (!g_menu_model_dbus_export_start (impl->session_bus,
impl->object_path, impl->object_path,
g_application_get_menu (impl->app), g_application_get_menu (impl->app),
error)) error))
{ {
g_action_group_exporter_stop (impl->app); g_action_group_dbus_export_stop (impl->app);
impl->actions_exported = FALSE; impl->actions_exported = FALSE;
g_dbus_connection_unregister_object (impl->session_bus, g_dbus_connection_unregister_object (impl->session_bus,
@ -383,12 +383,12 @@ g_application_impl_register (GApplication *application,
impl->object_id); impl->object_id);
impl->object_id = 0; impl->object_id = 0;
g_action_group_exporter_stop (impl->app); g_action_group_dbus_export_stop (impl->app);
impl->actions_exported = FALSE; impl->actions_exported = FALSE;
if (impl->menu_exported) if (impl->menu_exported)
{ {
g_menu_exporter_stop (g_application_get_menu (impl->app)); g_menu_model_dbus_export_stop (g_application_get_menu (impl->app));
impl->menu_exported = FALSE; impl->menu_exported = FALSE;
} }
@ -424,11 +424,11 @@ g_application_impl_register (GApplication *application,
g_dbus_connection_unregister_object (impl->session_bus, g_dbus_connection_unregister_object (impl->session_bus,
impl->object_id); impl->object_id);
impl->object_id = 0; impl->object_id = 0;
g_action_group_exporter_stop (impl->app); g_action_group_dbus_export_stop (impl->app);
impl->actions_exported = FALSE; impl->actions_exported = FALSE;
if (impl->menu_exported) if (impl->menu_exported)
{ {
g_menu_exporter_stop (g_application_get_menu (impl->app)); g_menu_model_dbus_export_stop (g_application_get_menu (impl->app));
impl->menu_exported = FALSE; impl->menu_exported = FALSE;
} }

2
gio/gdbusactiongroup.c
View File

@ -37,7 +37,7 @@
* *
* #GDBusActionGroup is an implementation of the #GActionGroup * #GDBusActionGroup is an implementation of the #GActionGroup
* interface that can be used as a proxy for an action group * interface that can be used as a proxy for an action group
* that is exported over D-Bus with g_action_group_exporter_export(). * that is exported over D-Bus with g_action_group_dbus_export_start().
*/ */
struct _GDBusActionGroup struct _GDBusActionGroup

12
gio/gio.symbols
View File

@ -1413,9 +1413,9 @@ g_action_group_has_action
g_action_group_list_actions g_action_group_list_actions
g_action_group_query_action g_action_group_query_action
g_action_group_change_action_state g_action_group_change_action_state
g_action_group_exporter_export g_action_group_dbus_export_start
g_action_group_exporter_query g_action_group_dbus_export_query
g_action_group_exporter_stop g_action_group_dbus_export_stop
g_action_activate g_action_activate
g_action_get_enabled g_action_get_enabled
g_action_get_name g_action_get_name
@ -1615,9 +1615,9 @@ g_menu_attribute_iter_get_next
g_menu_attribute_iter_get_type g_menu_attribute_iter_get_type
g_menu_attribute_iter_get_value g_menu_attribute_iter_get_value
g_menu_attribute_iter_next g_menu_attribute_iter_next
g_menu_exporter_export g_menu_model_dbus_export_start
g_menu_exporter_query g_menu_model_dbus_export_query
g_menu_exporter_stop g_menu_model_dbus_export_stop
g_menu_freeze g_menu_freeze
g_menu_get_type g_menu_get_type
g_menu_insert g_menu_insert

34
gio/gmenuexporter.c
View File

@ -759,7 +759,7 @@ g_menu_exporter_new (GDBusConnection *connection,
static GHashTable *g_menu_exporter_exported_menus; static GHashTable *g_menu_exporter_exported_menus;
/** /**
* g_menu_exporter_export: * g_menu_model_dbus_export_start:
* @connection: a #GDBusConnection * @connection: a #GDBusConnection
* @object_path: a D-Bus object path * @object_path: a D-Bus object path
* @menu: a #GMenuModel * @menu: a #GMenuModel
@ -771,22 +771,22 @@ static GHashTable *g_menu_exporter_exported_menus;
* It is subject to change in the future. * It is subject to change in the future.
* *
* A given menu model can only be exported on one object path * A given menu model can only be exported on one object path
* and an object_path can only have one action group exported * and an object path can only have one action group exported
* on it. If either constraint is violated, the export will * on it. If either constraint is violated, the export will
* fail and %FALSE will be returned (with @error set accordingly). * fail and %FALSE will be returned (with @error set accordingly).
* *
* Use g_menu_exporter_stop() to stop exporting @menu * Use g_menu_model_dbus_export_stop() to stop exporting @menu
* or g_menu_exporter_query() to find out if and where a given * or g_menu_model_dbus_export_query() to find out if and where
* menu model is exported. * a given menu model is exported.
* *
* Returns: %TRUE if the export is successful, or %FALSE (with * Returns: %TRUE if the export is successful, or %FALSE (with
* @error set) in the event of a failure. * @error set) in the event of a failure.
*/ */
gboolean gboolean
g_menu_exporter_export (GDBusConnection *connection, g_menu_model_dbus_export_start (GDBusConnection *connection,
const gchar *object_path, const gchar *object_path,
GMenuModel *menu, GMenuModel *menu,
GError **error) GError **error)
{ {
GMenuExporter *exporter; GMenuExporter *exporter;
@ -810,19 +810,19 @@ g_menu_exporter_export (GDBusConnection *connection,
} }
/** /**
* g_menu_exporter_stop: * g_menu_model_dbus_export_stop:
* @menu: a #GMenuModel * @menu: a #GMenuModel
* *
* Stops the export of @menu. * Stops the export of @menu.
* *
* This reverses the effect of a previous call to * This reverses the effect of a previous call to
* g_menu_exporter_export() for @menu. * g_menu_model_dbus_export_start() for @menu.
* *
* Returns: %TRUE if an export was stopped or %FALSE * Returns: %TRUE if an export was stopped or %FALSE
* if @menu was not exported in the first place * if @menu was not exported in the first place
*/ */
gboolean gboolean
g_menu_exporter_stop (GMenuModel *menu) g_menu_model_dbus_export_stop (GMenuModel *menu)
{ {
GMenuExporter *exporter; GMenuExporter *exporter;
@ -840,7 +840,7 @@ g_menu_exporter_stop (GMenuModel *menu)
} }
/** /**
* g_menu_exporter_query: * g_menu_model_dbus_export_query:
* @menu: a #GMenuModel * @menu: a #GMenuModel
* @connection: (out): the #GDBusConnection used for exporting * @connection: (out): the #GDBusConnection used for exporting
* @object_path: (out): the object path used for exporting * @object_path: (out): the object path used for exporting
@ -858,9 +858,9 @@ g_menu_exporter_stop (GMenuModel *menu)
* Returns: %TRUE if @menu was exported, else %FALSE * Returns: %TRUE if @menu was exported, else %FALSE
*/ */
gboolean gboolean
g_menu_exporter_query (GMenuModel *menu, g_menu_model_dbus_export_query (GMenuModel *menu,
GDBusConnection **connection, GDBusConnection **connection,
const gchar **object_path) const gchar **object_path)
{ {
GMenuExporter *exporter; GMenuExporter *exporter;

18
gio/gmenuexporter.h
View File

@ -27,18 +27,16 @@
G_BEGIN_DECLS G_BEGIN_DECLS
gboolean g_menu_exporter_export (GDBusConnection *connection, gboolean g_menu_model_dbus_export_start (GDBusConnection *connection,
const gchar *object_path, const gchar *object_path,
GMenuModel *menu, GMenuModel *menu,
GError **error); GError **error);
gboolean g_menu_exporter_stop (GMenuModel *menu); gboolean g_menu_model_dbus_export_stop (GMenuModel *menu);
gboolean g_menu_model_dbus_export_query (GMenuModel *menu,
GDBusConnection **connection,
gboolean g_menu_exporter_query (GMenuModel *menu, const gchar **object_path);
GDBusConnection **connection,
const gchar **object_path);
G_END_DECLS G_END_DECLS

2
gio/gmenuproxy.c
View File

@ -33,7 +33,7 @@
* *
* #GMenuProxy is an implementation of #GMenuModel that can be used * #GMenuProxy is an implementation of #GMenuModel that can be used
* as a proxy for a menu model that is exported over D-Bus with * as a proxy for a menu model that is exported over D-Bus with
* g_menu_exporter_export(). * g_menu_model_dbus_export_start().
*/ */
/* /*

4
gio/tests/gmenumodel.c
View File

@ -590,7 +590,7 @@ test_roundtrip (void)
state.rand = g_rand_new_with_seed (g_test_rand_int ()); state.rand = g_rand_new_with_seed (g_test_rand_int ());
state.random = random_menu_new (state.rand, TOP_ORDER); state.random = random_menu_new (state.rand, TOP_ORDER);
g_menu_exporter_export (bus, "/", G_MENU_MODEL (state.random), NULL); g_menu_model_dbus_export_start (bus, "/", G_MENU_MODEL (state.random), NULL);
state.proxy = g_menu_proxy_get (bus, g_dbus_connection_get_unique_name (bus), "/"); state.proxy = g_menu_proxy_get (bus, g_dbus_connection_get_unique_name (bus), "/");
state.count = 0; state.count = 0;
state.success = 0; state.success = 0;
@ -602,7 +602,7 @@ test_roundtrip (void)
g_main_loop_unref (state.loop); g_main_loop_unref (state.loop);
g_object_unref (state.proxy); g_object_unref (state.proxy);
g_menu_exporter_stop (G_MENU_MODEL (state.random)); g_menu_model_dbus_export_stop (G_MENU_MODEL (state.random));
g_object_unref (state.random); g_object_unref (state.random);
g_rand_free (state.rand); g_rand_free (state.rand);
g_object_unref (bus); g_object_unref (bus);