2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
25 #include "gapplication.h"
27 #include "gapplicationcommandline.h"
28 #include "gsimpleactiongroup.h"
29 #include "gremoteactiongroup.h"
30 #include "gapplicationimpl.h"
31 #include "gactiongroup.h"
32 #include "gactionmap.h"
33 #include "gmenumodel.h"
34 #include "gsettings.h"
35 #include "gnotification-private.h"
36 #include "gnotificationbackend.h"
37 #include "gdbusutils.h"
39 #include "gioenumtypes.h"
48 * SECTION:gapplication
49 * @title: GApplication
50 * @short_description: Core application class
53 * A #GApplication is the foundation of an application. It wraps some
54 * low-level platform-specific services and is intended to act as the
55 * foundation for higher-level application classes such as
56 * #GtkApplication or #MxApplication. In general, you should not use
57 * this class outside of a higher level framework.
59 * GApplication provides convenient life cycle management by maintaining
60 * a <firstterm>use count</firstterm> for the primary application instance.
61 * The use count can be changed using g_application_hold() and
62 * g_application_release(). If it drops to zero, the application exits.
63 * Higher-level classes such as #GtkApplication employ the use count to
64 * ensure that the application stays alive as long as it has any opened
67 * Another feature that GApplication (optionally) provides is process
68 * uniqueness. Applications can make use of this functionality by
69 * providing a unique application ID. If given, only one application
70 * with this ID can be running at a time per session. The session
71 * concept is platform-dependent, but corresponds roughly to a graphical
72 * desktop login. When your application is launched again, its
73 * arguments are passed through platform communication to the already
74 * running program. The already running instance of the program is
75 * called the <firstterm>primary instance</firstterm>; for non-unique
76 * applications this is the always the current instance.
77 * On Linux, the D-Bus session bus is used for communication.
79 * The use of #GApplication differs from some other commonly-used
80 * uniqueness libraries (such as libunique) in important ways. The
81 * application is not expected to manually register itself and check if
82 * it is the primary instance. Instead, the <code>main()</code>
83 * function of a #GApplication should do very little more than
84 * instantiating the application instance, possibly connecting signal
85 * handlers, then calling g_application_run(). All checks for
86 * uniqueness are done internally. If the application is the primary
87 * instance then the startup signal is emitted and the mainloop runs.
88 * If the application is not the primary instance then a signal is sent
89 * to the primary instance and g_application_run() promptly returns.
90 * See the code examples below.
92 * If used, the expected form of an application identifier is very close
94 * <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
95 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
96 * For details on valid application identifiers, see g_application_id_is_valid().
98 * On Linux, the application identifier is claimed as a well-known bus name
99 * on the user's session bus. This means that the uniqueness of your
100 * application is scoped to the current session. It also means that your
101 * application may provide additional services (through registration of other
102 * object paths) at that bus name. The registration of these object paths
103 * should be done with the shared GDBus session bus. Note that due to the
104 * internal architecture of GDBus, method calls can be dispatched at any time
105 * (even if a main loop is not running). For this reason, you must ensure that
106 * any object paths that you wish to register are registered before #GApplication
107 * attempts to acquire the bus name of your application (which happens in
108 * g_application_register()). Unfortunately, this means that you cannot use
109 * g_application_get_is_remote() to decide if you want to register object paths.
111 * GApplication also implements the #GActionGroup and #GActionMap
112 * interfaces and lets you easily export actions by adding them with
113 * g_action_map_add_action(). When invoking an action by calling
114 * g_action_group_activate_action() on the application, it is always
115 * invoked in the primary instance. The actions are also exported on
116 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
117 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
118 * for remote access to exported #GMenuModels.
120 * There is a number of different entry points into a GApplication:
122 * <listitem>via 'Activate' (i.e. just starting the application)</listitem>
123 * <listitem>via 'Open' (i.e. opening some files)</listitem>
124 * <listitem>by handling a command-line</listitem>
125 * <listitem>via activating an action</listitem>
127 * The #GApplication::startup signal lets you handle the application
128 * initialization for all of these in a single place.
130 * Regardless of which of these entry points is used to start the application,
131 * GApplication passes some <firstterm id="platform-data">platform
132 * data</firstterm> from the launching instance to the primary instance,
133 * in the form of a #GVariant dictionary mapping strings to variants.
134 * To use platform data, override the @before_emit or @after_emit virtual
135 * functions in your #GApplication subclass. When dealing with
136 * #GApplicationCommandLine objects, the platform data is directly
137 * available via g_application_command_line_get_cwd(),
138 * g_application_command_line_get_environ() and
139 * g_application_command_line_get_platform_data().
141 * As the name indicates, the platform data may vary depending on the
142 * operating system, but it always includes the current directory (key
143 * "cwd"), and optionally the environment (ie the set of environment
144 * variables and their values) of the calling process (key "environ").
145 * The environment is only added to the platform data if the
146 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
147 * can add their own platform data by overriding the @add_platform_data
148 * virtual function. For instance, #GtkApplication adds startup notification
151 * To parse commandline arguments you may handle the
152 * #GApplication::command-line signal or override the local_command_line()
153 * vfunc, to parse them in either the primary instance or the local instance,
156 * <example id="gapplication-example-open"><title>Opening files with a GApplication</title>
158 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-open.c">
159 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
164 * <example id="gapplication-example-actions"><title>A GApplication with actions</title>
166 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-actions.c">
167 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
172 * <example id="gapplication-example-menu"><title>A GApplication with menus</title>
174 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-menu.c">
175 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
180 * <example id="gapplication-example-dbushooks"><title>Using extra D-Bus hooks with a GApplication</title>
182 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-dbushooks.c">
183 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
191 * @startup: invoked on the primary instance immediately after registration
192 * @shutdown: invoked only on the registered primary instance immediately
193 * after the main loop terminates
194 * @activate: invoked on the primary instance when an activation occurs
195 * @open: invoked on the primary instance when there are files to open
196 * @command_line: invoked on the primary instance when a command-line is
197 * not handled locally
198 * @local_command_line: invoked (locally) when the process has been invoked
199 * via commandline execution (as opposed to, say, D-Bus activation - which
200 * is not currently supported by GApplication). The virtual function has
201 * the chance to inspect (and possibly replace) the list of command line
202 * arguments. See g_application_run() for more information.
203 * @before_emit: invoked on the primary instance before 'activate', 'open',
204 * 'command-line' or any action invocation, gets the 'platform data' from
205 * the calling instance
206 * @after_emit: invoked on the primary instance after 'activate', 'open',
207 * 'command-line' or any action invocation, gets the 'platform data' from
208 * the calling instance
209 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
210 * the primary instance when activating, opening or invoking actions
211 * @quit_mainloop: Used to be invoked on the primary instance when the use
212 * count of the application drops to zero (and after any inactivity
213 * timeout, if requested). Not used anymore since 2.32
214 * @run_mainloop: Used to be invoked on the primary instance from
215 * g_application_run() if the use-count is non-zero. Since 2.32,
216 * GApplication is iterating the main context directly and is not
217 * using @run_mainloop anymore
218 * @dbus_register: invoked locally during registration, if the application is
219 * using its D-Bus backend. You can use this to export extra objects on the
220 * bus, that need to exist before the application tries to own the bus name.
221 * The function is passed the #GDBusConnection to to session bus, and the
222 * object path that #GApplication will use to export is D-Bus API.
223 * If this function returns %TRUE, registration will proceed; otherwise
224 * registration will abort. Since: 2.34
225 * @dbus_unregister: invoked locally during unregistration, if the application
226 * is using its D-Bus backend. Use this to undo anything done by the
227 * @dbus_register vfunc. Since: 2.34
229 * Virtual function table for #GApplication.
234 struct _GApplicationPrivate
236 GApplicationFlags flags;
239 GActionGroup *actions;
240 GMenuModel *app_menu;
243 guint inactivity_timeout_id;
244 guint inactivity_timeout;
248 guint is_registered : 1;
250 guint did_startup : 1;
251 guint did_shutdown : 1;
252 guint must_quit_now : 1;
254 GRemoteActionGroup *remote_actions;
255 GApplicationImpl *impl;
257 GNotificationBackend *notifications;
267 PROP_INACTIVITY_TIMEOUT,
282 static guint g_application_signals[NR_SIGNALS];
284 static void g_application_action_group_iface_init (GActionGroupInterface *);
285 static void g_application_action_map_iface_init (GActionMapInterface *);
286 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
287 G_ADD_PRIVATE (GApplication)
288 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
289 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
291 /* GApplicationExportedActions {{{1 */
293 /* We create a subclass of GSimpleActionGroup that implements
294 * GRemoteActionGroup and deals with the platform data using
295 * GApplication's before/after_emit vfuncs. This is the action group we
298 * We could implement GRemoteActionGroup on GApplication directly, but
299 * this would be potentially extremely confusing to have exposed as part
300 * of the public API of GApplication. We certainly don't want anyone in
301 * the same process to be calling these APIs...
303 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
306 GSimpleActionGroup parent_instance;
307 GApplication *application;
308 } GApplicationExportedActions;
310 static GType g_application_exported_actions_get_type (void);
311 static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
312 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
313 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
316 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
317 const gchar *action_name,
319 GVariant *platform_data)
321 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
323 G_APPLICATION_GET_CLASS (exported->application)
324 ->before_emit (exported->application, platform_data);
326 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
328 G_APPLICATION_GET_CLASS (exported->application)
329 ->after_emit (exported->application, platform_data);
333 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
334 const gchar *action_name,
336 GVariant *platform_data)
338 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
340 G_APPLICATION_GET_CLASS (exported->application)
341 ->before_emit (exported->application, platform_data);
343 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
345 G_APPLICATION_GET_CLASS (exported->application)
346 ->after_emit (exported->application, platform_data);
350 g_application_exported_actions_init (GApplicationExportedActions *actions)
355 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
357 iface->activate_action_full = g_application_exported_actions_activate_action_full;
358 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
362 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
366 static GActionGroup *
367 g_application_exported_actions_new (GApplication *application)
369 GApplicationExportedActions *actions;
371 actions = g_object_new (g_application_exported_actions_get_type (), NULL);
372 actions->application = application;
374 return G_ACTION_GROUP (actions);
377 /* vfunc defaults {{{1 */
379 g_application_real_before_emit (GApplication *application,
380 GVariant *platform_data)
385 g_application_real_after_emit (GApplication *application,
386 GVariant *platform_data)
391 g_application_real_startup (GApplication *application)
393 application->priv->did_startup = TRUE;
397 g_application_real_shutdown (GApplication *application)
399 application->priv->did_shutdown = TRUE;
403 g_application_real_activate (GApplication *application)
405 if (!g_signal_has_handler_pending (application,
406 g_application_signals[SIGNAL_ACTIVATE],
408 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
410 static gboolean warned;
415 g_warning ("Your application does not implement "
416 "g_application_activate() and has no handlers connected "
417 "to the 'activate' signal. It should do one of these.");
423 g_application_real_open (GApplication *application,
428 if (!g_signal_has_handler_pending (application,
429 g_application_signals[SIGNAL_OPEN],
431 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
433 static gboolean warned;
438 g_warning ("Your application claims to support opening files "
439 "but does not implement g_application_open() and has no "
440 "handlers connected to the 'open' signal.");
446 g_application_real_command_line (GApplication *application,
447 GApplicationCommandLine *cmdline)
449 if (!g_signal_has_handler_pending (application,
450 g_application_signals[SIGNAL_COMMAND_LINE],
452 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
454 static gboolean warned;
459 g_warning ("Your application claims to support custom command line "
460 "handling but does not implement g_application_command_line() "
461 "and has no handlers connected to the 'command-line' signal.");
470 g_application_real_local_command_line (GApplication *application,
474 if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
476 if ((*arguments)[0] && (*arguments)[1] && g_str_equal ((*arguments)[1], "--gapplication-service"))
478 GError *error = NULL;
481 g_warning ("Additional arguments following --gapplication-service are ignored");
483 application->priv->flags |= G_APPLICATION_IS_SERVICE;
484 if (!g_application_register (application, NULL, &error))
486 g_warning ("%s", error->message);
487 g_error_free (error);
497 if ((application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE) &&
498 !(application->priv->flags & G_APPLICATION_IS_SERVICE))
503 GError *error = NULL;
506 if (!g_application_register (application, NULL, &error))
508 g_printerr ("Failed to register: %s\n", error->message);
509 g_error_free (error);
514 n_args = g_strv_length (*arguments);
516 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
518 if ((*exit_status = n_args > 1))
520 g_printerr ("GApplication service mode takes no arguments.\n");
521 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
529 g_application_activate (application);
535 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
537 g_critical ("This application can not open files.");
546 n_files = n_args - 1;
547 files = g_new (GFile *, n_files);
549 for (i = 0; i < n_files; i++)
550 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
552 g_application_open (application, files, n_files, "");
554 for (i = 0; i < n_files; i++)
555 g_object_unref (files[i]);
567 g_application_real_add_platform_data (GApplication *application,
568 GVariantBuilder *builder)
573 g_application_real_dbus_register (GApplication *application,
574 GDBusConnection *connection,
575 const gchar *object_path,
582 g_application_real_dbus_unregister (GApplication *application,
583 GDBusConnection *connection,
584 const gchar *object_path)
588 /* GObject implementation stuff {{{1 */
590 g_application_set_property (GObject *object,
595 GApplication *application = G_APPLICATION (object);
599 case PROP_APPLICATION_ID:
600 g_application_set_application_id (application,
601 g_value_get_string (value));
605 g_application_set_flags (application, g_value_get_flags (value));
608 case PROP_INACTIVITY_TIMEOUT:
609 g_application_set_inactivity_timeout (application,
610 g_value_get_uint (value));
613 case PROP_ACTION_GROUP:
614 g_clear_object (&application->priv->actions);
615 application->priv->actions = g_value_dup_object (value);
619 g_assert_not_reached ();
624 * g_application_set_action_group:
625 * @application: a #GApplication
626 * @action_group: (allow-none): a #GActionGroup, or %NULL
628 * This used to be how actions were associated with a #GApplication.
629 * Now there is #GActionMap for that.
633 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
634 * mix use of this API with use of #GActionMap on the same @application
635 * or things will go very badly wrong. This function is known to
636 * introduce buggy behaviour (ie: signals not emitted on changes to the
637 * action group), so you should really use #GActionMap instead.
640 g_application_set_action_group (GApplication *application,
641 GActionGroup *action_group)
643 g_return_if_fail (G_IS_APPLICATION (application));
644 g_return_if_fail (!application->priv->is_registered);
646 if (application->priv->actions != NULL)
647 g_object_unref (application->priv->actions);
649 application->priv->actions = action_group;
651 if (application->priv->actions != NULL)
652 g_object_ref (application->priv->actions);
656 g_application_get_property (GObject *object,
661 GApplication *application = G_APPLICATION (object);
665 case PROP_APPLICATION_ID:
666 g_value_set_string (value,
667 g_application_get_application_id (application));
671 g_value_set_flags (value,
672 g_application_get_flags (application));
675 case PROP_IS_REGISTERED:
676 g_value_set_boolean (value,
677 g_application_get_is_registered (application));
681 g_value_set_boolean (value,
682 g_application_get_is_remote (application));
685 case PROP_INACTIVITY_TIMEOUT:
686 g_value_set_uint (value,
687 g_application_get_inactivity_timeout (application));
691 g_assert_not_reached ();
696 g_application_constructed (GObject *object)
698 GApplication *application = G_APPLICATION (object);
700 if (g_application_get_default () == NULL)
701 g_application_set_default (application);
705 g_application_finalize (GObject *object)
707 GApplication *application = G_APPLICATION (object);
709 if (application->priv->impl)
710 g_application_impl_destroy (application->priv->impl);
711 g_free (application->priv->id);
713 if (g_application_get_default () == application)
714 g_application_set_default (NULL);
716 if (application->priv->actions)
717 g_object_unref (application->priv->actions);
719 if (application->priv->notifications)
720 g_object_unref (application->priv->notifications);
722 G_OBJECT_CLASS (g_application_parent_class)
727 g_application_init (GApplication *application)
729 application->priv = g_application_get_instance_private (application);
731 application->priv->actions = g_application_exported_actions_new (application);
733 /* application->priv->actions is the one and only ref on the group, so when
734 * we dispose, the action group will die, disconnecting all signals.
736 g_signal_connect_swapped (application->priv->actions, "action-added",
737 G_CALLBACK (g_action_group_action_added), application);
738 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
739 G_CALLBACK (g_action_group_action_enabled_changed), application);
740 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
741 G_CALLBACK (g_action_group_action_state_changed), application);
742 g_signal_connect_swapped (application->priv->actions, "action-removed",
743 G_CALLBACK (g_action_group_action_removed), application);
747 g_application_class_init (GApplicationClass *class)
749 GObjectClass *object_class = G_OBJECT_CLASS (class);
751 object_class->constructed = g_application_constructed;
752 object_class->finalize = g_application_finalize;
753 object_class->get_property = g_application_get_property;
754 object_class->set_property = g_application_set_property;
756 class->before_emit = g_application_real_before_emit;
757 class->after_emit = g_application_real_after_emit;
758 class->startup = g_application_real_startup;
759 class->shutdown = g_application_real_shutdown;
760 class->activate = g_application_real_activate;
761 class->open = g_application_real_open;
762 class->command_line = g_application_real_command_line;
763 class->local_command_line = g_application_real_local_command_line;
764 class->add_platform_data = g_application_real_add_platform_data;
765 class->dbus_register = g_application_real_dbus_register;
766 class->dbus_unregister = g_application_real_dbus_unregister;
768 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
769 g_param_spec_string ("application-id",
770 P_("Application identifier"),
771 P_("The unique identifier for the application"),
772 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
773 G_PARAM_STATIC_STRINGS));
775 g_object_class_install_property (object_class, PROP_FLAGS,
776 g_param_spec_flags ("flags",
777 P_("Application flags"),
778 P_("Flags specifying the behaviour of the application"),
779 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
780 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
782 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
783 g_param_spec_boolean ("is-registered",
785 P_("If g_application_register() has been called"),
786 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
788 g_object_class_install_property (object_class, PROP_IS_REMOTE,
789 g_param_spec_boolean ("is-remote",
791 P_("If this application instance is remote"),
792 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
794 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
795 g_param_spec_uint ("inactivity-timeout",
796 P_("Inactivity timeout"),
797 P_("Time (ms) to stay alive after becoming idle"),
799 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
801 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
802 g_param_spec_object ("action-group",
804 P_("The group of actions that the application exports"),
806 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
809 * GApplication::startup:
810 * @application: the application
812 * The ::startup signal is emitted on the primary instance immediately
813 * after registration. See g_application_register().
815 g_application_signals[SIGNAL_STARTUP] =
816 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
817 G_STRUCT_OFFSET (GApplicationClass, startup),
818 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
821 * GApplication::shutdown:
822 * @application: the application
824 * The ::shutdown signal is emitted only on the registered primary instance
825 * immediately after the main loop terminates.
827 g_application_signals[SIGNAL_SHUTDOWN] =
828 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
829 G_STRUCT_OFFSET (GApplicationClass, shutdown),
830 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
833 * GApplication::activate:
834 * @application: the application
836 * The ::activate signal is emitted on the primary instance when an
837 * activation occurs. See g_application_activate().
839 g_application_signals[SIGNAL_ACTIVATE] =
840 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
841 G_STRUCT_OFFSET (GApplicationClass, activate),
842 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
846 * GApplication::open:
847 * @application: the application
848 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
849 * @n_files: the length of @files
850 * @hint: a hint provided by the calling instance
852 * The ::open signal is emitted on the primary instance when there are
853 * files to open. See g_application_open() for more information.
855 g_application_signals[SIGNAL_OPEN] =
856 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
857 G_STRUCT_OFFSET (GApplicationClass, open),
859 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
862 * GApplication::command-line:
863 * @application: the application
864 * @command_line: a #GApplicationCommandLine representing the
867 * The ::command-line signal is emitted on the primary instance when
868 * a commandline is not handled locally. See g_application_run() and
869 * the #GApplicationCommandLine documentation for more information.
871 * Returns: An integer that is set as the exit status for the calling
872 * process. See g_application_command_line_set_exit_status().
874 g_application_signals[SIGNAL_COMMAND_LINE] =
875 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
876 G_STRUCT_OFFSET (GApplicationClass, command_line),
877 g_signal_accumulator_first_wins, NULL,
879 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
883 get_platform_data (GApplication *application)
885 GVariantBuilder *builder;
888 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
891 gchar *cwd = g_get_current_dir ();
892 g_variant_builder_add (builder, "{sv}", "cwd",
893 g_variant_new_bytestring (cwd));
897 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
902 envp = g_get_environ ();
903 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
906 g_variant_builder_add (builder, "{sv}", "environ", array);
909 G_APPLICATION_GET_CLASS (application)->
910 add_platform_data (application, builder);
912 result = g_variant_builder_end (builder);
913 g_variant_builder_unref (builder);
918 /* Application ID validity {{{1 */
921 * g_application_id_is_valid:
922 * @application_id: a potential application identifier
924 * Checks if @application_id is a valid application identifier.
926 * A valid ID is required for calls to g_application_new() and
927 * g_application_set_application_id().
929 * For convenience, the restrictions on application identifiers are
932 * <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-." and must not begin with a digit.</listitem>
933 * <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least three elements).</listitem>
934 * <listitem>Application identifiers must not begin or end with a '.' (period) character.</listitem>
935 * <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
936 * <listitem>Application identifiers must not exceed 255 characters.</listitem>
939 * Returns: %TRUE if @application_id is valid
942 g_application_id_is_valid (const gchar *application_id)
948 len = strlen (application_id);
953 if (!g_ascii_isalpha (application_id[0]))
956 if (application_id[len-1] == '.')
962 for (; *application_id; application_id++)
964 if (g_ascii_isalnum (*application_id) ||
965 (*application_id == '-') ||
966 (*application_id == '_'))
970 else if (allow_dot && *application_id == '.')
985 /* Public Constructor {{{1 */
988 * @application_id: (allow-none): the application id
989 * @flags: the application flags
991 * Creates a new #GApplication instance.
993 * If non-%NULL, the application id must be valid. See
994 * g_application_id_is_valid().
996 * If no application ID is given then some features of #GApplication
997 * (most notably application uniqueness) will be disabled.
999 * Returns: a new #GApplication instance
1002 g_application_new (const gchar *application_id,
1003 GApplicationFlags flags)
1005 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1007 return g_object_new (G_TYPE_APPLICATION,
1008 "application-id", application_id,
1013 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1015 * g_application_get_application_id:
1016 * @application: a #GApplication
1018 * Gets the unique identifier for @application.
1020 * Returns: the identifier for @application, owned by @application
1025 g_application_get_application_id (GApplication *application)
1027 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1029 return application->priv->id;
1033 * g_application_set_application_id:
1034 * @application: a #GApplication
1035 * @application_id: (allow-none): the identifier for @application
1037 * Sets the unique identifier for @application.
1039 * The application id can only be modified if @application has not yet
1042 * If non-%NULL, the application id must be valid. See
1043 * g_application_id_is_valid().
1048 g_application_set_application_id (GApplication *application,
1049 const gchar *application_id)
1051 g_return_if_fail (G_IS_APPLICATION (application));
1053 if (g_strcmp0 (application->priv->id, application_id) != 0)
1055 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1056 g_return_if_fail (!application->priv->is_registered);
1058 g_free (application->priv->id);
1059 application->priv->id = g_strdup (application_id);
1061 g_object_notify (G_OBJECT (application), "application-id");
1066 * g_application_get_flags:
1067 * @application: a #GApplication
1069 * Gets the flags for @application.
1071 * See #GApplicationFlags.
1073 * Returns: the flags for @application
1078 g_application_get_flags (GApplication *application)
1080 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1082 return application->priv->flags;
1086 * g_application_set_flags:
1087 * @application: a #GApplication
1088 * @flags: the flags for @application
1090 * Sets the flags for @application.
1092 * The flags can only be modified if @application has not yet been
1095 * See #GApplicationFlags.
1100 g_application_set_flags (GApplication *application,
1101 GApplicationFlags flags)
1103 g_return_if_fail (G_IS_APPLICATION (application));
1105 if (application->priv->flags != flags)
1107 g_return_if_fail (!application->priv->is_registered);
1109 application->priv->flags = flags;
1111 g_object_notify (G_OBJECT (application), "flags");
1116 * g_application_get_inactivity_timeout:
1117 * @application: a #GApplication
1119 * Gets the current inactivity timeout for the application.
1121 * This is the amount of time (in milliseconds) after the last call to
1122 * g_application_release() before the application stops running.
1124 * Returns: the timeout, in milliseconds
1129 g_application_get_inactivity_timeout (GApplication *application)
1131 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1133 return application->priv->inactivity_timeout;
1137 * g_application_set_inactivity_timeout:
1138 * @application: a #GApplication
1139 * @inactivity_timeout: the timeout, in milliseconds
1141 * Sets the current inactivity timeout for the application.
1143 * This is the amount of time (in milliseconds) after the last call to
1144 * g_application_release() before the application stops running.
1146 * This call has no side effects of its own. The value set here is only
1147 * used for next time g_application_release() drops the use count to
1148 * zero. Any timeouts currently in progress are not impacted.
1153 g_application_set_inactivity_timeout (GApplication *application,
1154 guint inactivity_timeout)
1156 g_return_if_fail (G_IS_APPLICATION (application));
1158 if (application->priv->inactivity_timeout != inactivity_timeout)
1160 application->priv->inactivity_timeout = inactivity_timeout;
1162 g_object_notify (G_OBJECT (application), "inactivity-timeout");
1165 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
1167 * g_application_get_is_registered:
1168 * @application: a #GApplication
1170 * Checks if @application is registered.
1172 * An application is registered if g_application_register() has been
1173 * successfully called.
1175 * Returns: %TRUE if @application is registered
1180 g_application_get_is_registered (GApplication *application)
1182 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1184 return application->priv->is_registered;
1188 * g_application_get_is_remote:
1189 * @application: a #GApplication
1191 * Checks if @application is remote.
1193 * If @application is remote then it means that another instance of
1194 * application already exists (the 'primary' instance). Calls to
1195 * perform actions on @application will result in the actions being
1196 * performed by the primary instance.
1198 * The value of this property cannot be accessed before
1199 * g_application_register() has been called. See
1200 * g_application_get_is_registered().
1202 * Returns: %TRUE if @application is remote
1207 g_application_get_is_remote (GApplication *application)
1209 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1210 g_return_val_if_fail (application->priv->is_registered, FALSE);
1212 return application->priv->is_remote;
1216 * g_application_get_dbus_connection:
1217 * @application: a #GApplication
1219 * Gets the #GDBusConnection being used by the application, or %NULL.
1221 * If #GApplication is using its D-Bus backend then this function will
1222 * return the #GDBusConnection being used for uniqueness and
1223 * communication with the desktop environment and other instances of the
1226 * If #GApplication is not using D-Bus then this function will return
1227 * %NULL. This includes the situation where the D-Bus backend would
1228 * normally be in use but we were unable to connect to the bus.
1230 * This function must not be called before the application has been
1231 * registered. See g_application_get_is_registered().
1233 * Returns: (transfer none): a #GDBusConnection, or %NULL
1238 g_application_get_dbus_connection (GApplication *application)
1240 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1241 g_return_val_if_fail (application->priv->is_registered, FALSE);
1243 return g_application_impl_get_dbus_connection (application->priv->impl);
1247 * g_application_get_dbus_object_path:
1248 * @application: a #GApplication
1250 * Gets the D-Bus object path being used by the application, or %NULL.
1252 * If #GApplication is using its D-Bus backend then this function will
1253 * return the D-Bus object path that #GApplication is using. If the
1254 * application is the primary instance then there is an object published
1255 * at this path. If the application is not the primary instance then
1256 * the result of this function is undefined.
1258 * If #GApplication is not using D-Bus then this function will return
1259 * %NULL. This includes the situation where the D-Bus backend would
1260 * normally be in use but we were unable to connect to the bus.
1262 * This function must not be called before the application has been
1263 * registered. See g_application_get_is_registered().
1265 * Returns: the object path, or %NULL
1270 g_application_get_dbus_object_path (GApplication *application)
1272 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1273 g_return_val_if_fail (application->priv->is_registered, FALSE);
1275 return g_application_impl_get_dbus_object_path (application->priv->impl);
1280 * g_application_register:
1281 * @application: a #GApplication
1282 * @cancellable: (allow-none): a #GCancellable, or %NULL
1283 * @error: a pointer to a NULL #GError, or %NULL
1285 * Attempts registration of the application.
1287 * This is the point at which the application discovers if it is the
1288 * primary instance or merely acting as a remote for an already-existing
1289 * primary instance. This is implemented by attempting to acquire the
1290 * application identifier as a unique bus name on the session bus using
1293 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1294 * given, then this process will always become the primary instance.
1296 * Due to the internal architecture of GDBus, method calls can be
1297 * dispatched at any time (even if a main loop is not running). For
1298 * this reason, you must ensure that any object paths that you wish to
1299 * register are registered before calling this function.
1301 * If the application has already been registered then %TRUE is
1302 * returned with no work performed.
1304 * The #GApplication::startup signal is emitted if registration succeeds
1305 * and @application is the primary instance (including the non-unique
1308 * In the event of an error (such as @cancellable being cancelled, or a
1309 * failure to connect to the session bus), %FALSE is returned and @error
1310 * is set appropriately.
1312 * Note: the return value of this function is not an indicator that this
1313 * instance is or is not the primary instance of the application. See
1314 * g_application_get_is_remote() for that.
1316 * Returns: %TRUE if registration succeeded
1321 g_application_register (GApplication *application,
1322 GCancellable *cancellable,
1325 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1327 if (!application->priv->is_registered)
1329 if (application->priv->id == NULL)
1330 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
1332 application->priv->impl =
1333 g_application_impl_register (application, application->priv->id,
1334 application->priv->flags,
1335 application->priv->actions,
1336 &application->priv->remote_actions,
1337 cancellable, error);
1339 if (application->priv->impl == NULL)
1342 application->priv->is_remote = application->priv->remote_actions != NULL;
1343 application->priv->is_registered = TRUE;
1345 g_object_notify (G_OBJECT (application), "is-registered");
1347 if (!application->priv->is_remote)
1349 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1351 if (!application->priv->did_startup)
1352 g_critical ("GApplication subclass '%s' failed to chain up on"
1353 " ::startup (from start of override function)",
1354 G_OBJECT_TYPE_NAME (application));
1361 /* Hold/release {{{1 */
1363 * g_application_hold:
1364 * @application: a #GApplication
1366 * Increases the use count of @application.
1368 * Use this function to indicate that the application has a reason to
1369 * continue to run. For example, g_application_hold() is called by GTK+
1370 * when a toplevel window is on the screen.
1372 * To cancel the hold, call g_application_release().
1375 g_application_hold (GApplication *application)
1377 g_return_if_fail (G_IS_APPLICATION (application));
1379 if (application->priv->inactivity_timeout_id)
1381 g_source_remove (application->priv->inactivity_timeout_id);
1382 application->priv->inactivity_timeout_id = 0;
1385 application->priv->use_count++;
1389 inactivity_timeout_expired (gpointer data)
1391 GApplication *application = G_APPLICATION (data);
1393 application->priv->inactivity_timeout_id = 0;
1395 return G_SOURCE_REMOVE;
1400 * g_application_release:
1401 * @application: a #GApplication
1403 * Decrease the use count of @application.
1405 * When the use count reaches zero, the application will stop running.
1407 * Never call this function except to cancel the effect of a previous
1408 * call to g_application_hold().
1411 g_application_release (GApplication *application)
1413 g_return_if_fail (G_IS_APPLICATION (application));
1415 application->priv->use_count--;
1417 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
1418 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
1419 inactivity_timeout_expired, application);
1422 /* Activate, Open {{{1 */
1424 * g_application_activate:
1425 * @application: a #GApplication
1427 * Activates the application.
1429 * In essence, this results in the #GApplication::activate signal being
1430 * emitted in the primary instance.
1432 * The application must be registered before calling this function.
1437 g_application_activate (GApplication *application)
1439 g_return_if_fail (G_IS_APPLICATION (application));
1440 g_return_if_fail (application->priv->is_registered);
1442 if (application->priv->is_remote)
1443 g_application_impl_activate (application->priv->impl,
1444 get_platform_data (application));
1447 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1451 * g_application_open:
1452 * @application: a #GApplication
1453 * @files: (array length=n_files): an array of #GFiles to open
1454 * @n_files: the length of the @files array
1455 * @hint: a hint (or ""), but never %NULL
1457 * Opens the given files.
1459 * In essence, this results in the #GApplication::open signal being emitted
1460 * in the primary instance.
1462 * @n_files must be greater than zero.
1464 * @hint is simply passed through to the ::open signal. It is
1465 * intended to be used by applications that have multiple modes for
1466 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1467 * for this functionality, you should use "".
1469 * The application must be registered before calling this function
1470 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1475 g_application_open (GApplication *application,
1480 g_return_if_fail (G_IS_APPLICATION (application));
1481 g_return_if_fail (application->priv->flags &
1482 G_APPLICATION_HANDLES_OPEN);
1483 g_return_if_fail (application->priv->is_registered);
1485 if (application->priv->is_remote)
1486 g_application_impl_open (application->priv->impl,
1487 files, n_files, hint,
1488 get_platform_data (application));
1491 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1492 0, files, n_files, hint);
1497 * g_application_run:
1498 * @application: a #GApplication
1499 * @argc: the argc from main() (or 0 if @argv is %NULL)
1500 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1502 * Runs the application.
1504 * This function is intended to be run from main() and its return value
1505 * is intended to be returned by main(). Although you are expected to pass
1506 * the @argc, @argv parameters from main() to this function, it is possible
1507 * to pass %NULL if @argv is not available or commandline handling is not
1508 * required. Note that on Windows, @argc and @argv are ignored, and
1509 * g_win32_get_command_line() is called internally (for proper support
1510 * of Unicode commandline arguments).
1512 * First, the local_command_line() virtual function is invoked.
1513 * This function always runs on the local instance. It gets passed a pointer
1514 * to a %NULL-terminated copy of the command line and is expected to
1515 * remove the arguments that it handled (shifting up remaining
1516 * arguments). See <xref linkend="gapplication-example-cmdline2"/> for
1517 * an example of parsing @argv manually. Alternatively, you may use the
1518 * #GOptionContext API, but you must use g_option_context_parse_strv()
1519 * in order to avoid memory leaks and encoding mismatches.
1521 * The last argument to local_command_line() is a pointer to the @status
1522 * variable which can used to set the exit status that is returned from
1523 * g_application_run().
1525 * If local_command_line() returns %TRUE, the command line is expected
1526 * to be completely handled, including possibly registering as the primary
1527 * instance, calling g_application_activate() or g_application_open(), etc.
1529 * If local_command_line() returns %FALSE then the application is registered
1530 * and the #GApplication::command-line signal is emitted in the primary
1531 * instance (which may or may not be this instance). The signal handler
1532 * gets passed a #GApplicationCommandLine object that (among other things)
1533 * contains the remaining commandline arguments that have not been handled
1534 * by local_command_line().
1536 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1537 * flag set then the default implementation of local_command_line()
1538 * always returns %FALSE immediately, resulting in the commandline
1539 * always being handled in the primary instance.
1541 * Otherwise, the default implementation of local_command_line() tries
1542 * to do a couple of things that are probably reasonable for most
1543 * applications. First, g_application_register() is called to attempt
1544 * to register the application. If that works, then the command line
1545 * arguments are inspected. If no commandline arguments are given, then
1546 * g_application_activate() is called. If commandline arguments are
1547 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1548 * are assumed to be filenames and g_application_open() is called.
1550 * If you need to handle commandline arguments that are not filenames,
1551 * and you don't mind commandline handling to happen in the primary
1552 * instance, you should set %G_APPLICATION_HANDLES_COMMAND_LINE and
1553 * process the commandline arguments in your #GApplication::command-line
1554 * signal handler, either manually or using the #GOptionContext API.
1556 * If you are interested in doing more complicated local handling of the
1557 * commandline then you should implement your own #GApplication subclass
1558 * and override local_command_line(). In this case, you most likely want
1559 * to return %TRUE from your local_command_line() implementation to
1560 * suppress the default handling. See
1561 * <xref linkend="gapplication-example-cmdline2"/> for an example.
1563 * If, after the above is done, the use count of the application is zero
1564 * then the exit status is returned immediately. If the use count is
1565 * non-zero then the default main context is iterated until the use count
1566 * falls to zero, at which point 0 is returned.
1568 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
1569 * run for as much as 10 seconds with a use count of zero while waiting
1570 * for the message that caused the activation to arrive. After that,
1571 * if the use count falls to zero the application will exit immediately,
1572 * except in the case that g_application_set_inactivity_timeout() is in
1575 * This function sets the prgname (g_set_prgname()), if not already set,
1576 * to the basename of argv[0]. Since 2.38, if %G_APPLICATION_IS_SERVICE
1577 * is specified, the prgname is set to the application ID. The main
1578 * impact of this is is that the wmclass of windows created by Gtk+ will
1579 * be set accordingly, which helps the window manager determine which
1580 * application is showing the window.
1582 * Since 2.40, applications that are not explicitly flagged as services
1583 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
1584 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
1585 * default handler for local_command_line) if "--gapplication-service"
1586 * was given in the command line. If this flag is present then normal
1587 * commandline processing is interrupted and the
1588 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise"
1589 * solution whereby running an application directly from the commandline
1590 * will invoke it in the normal way (which can be useful for debugging)
1591 * while still allowing applications to be D-Bus activated in service
1592 * mode. The D-Bus service file should invoke the executable with
1593 * "--gapplication-service" as the sole commandline argument. This
1594 * approach is suitable for use by most graphical applications but
1595 * should not be used from applications like editors that need precise
1596 * control over when processes invoked via the commandline will exit and
1597 * what their exit status will be.
1599 * Returns: the exit status
1604 g_application_run (GApplication *application,
1611 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1612 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1613 g_return_val_if_fail (!application->priv->must_quit_now, 1);
1616 arguments = g_win32_get_command_line ();
1621 arguments = g_new (gchar *, argc + 1);
1622 for (i = 0; i < argc; i++)
1623 arguments[i] = g_strdup (argv[i]);
1624 arguments[i] = NULL;
1628 if (g_get_prgname () == NULL)
1630 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
1632 g_set_prgname (application->priv->id);
1638 prgname = g_path_get_basename (argv[0]);
1639 g_set_prgname (prgname);
1644 if (!G_APPLICATION_GET_CLASS (application)
1645 ->local_command_line (application, &arguments, &status))
1647 GError *error = NULL;
1649 if (!g_application_register (application, NULL, &error))
1651 g_printerr ("Failed to register: %s\n", error->message);
1652 g_error_free (error);
1656 if (application->priv->is_remote)
1658 GVariant *platform_data;
1660 platform_data = get_platform_data (application);
1661 status = g_application_impl_command_line (application->priv->impl,
1662 arguments, platform_data);
1666 GApplicationCommandLine *cmdline;
1669 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1670 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1671 "arguments", v, NULL);
1672 g_signal_emit (application,
1673 g_application_signals[SIGNAL_COMMAND_LINE],
1674 0, cmdline, &status);
1675 g_object_unref (cmdline);
1679 g_strfreev (arguments);
1681 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1682 application->priv->is_registered &&
1683 !application->priv->use_count &&
1684 !application->priv->inactivity_timeout_id)
1686 application->priv->inactivity_timeout_id =
1687 g_timeout_add (10000, inactivity_timeout_expired, application);
1690 while (application->priv->use_count || application->priv->inactivity_timeout_id)
1692 if (application->priv->must_quit_now)
1695 g_main_context_iteration (NULL, TRUE);
1699 if (application->priv->is_registered && !application->priv->is_remote)
1701 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
1703 if (!application->priv->did_shutdown)
1704 g_critical ("GApplication subclass '%s' failed to chain up on"
1705 " ::shutdown (from end of override function)",
1706 G_OBJECT_TYPE_NAME (application));
1709 if (application->priv->impl)
1710 g_application_impl_flush (application->priv->impl);
1718 g_application_list_actions (GActionGroup *action_group)
1720 GApplication *application = G_APPLICATION (action_group);
1722 g_return_val_if_fail (application->priv->is_registered, NULL);
1724 if (application->priv->remote_actions != NULL)
1725 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
1727 else if (application->priv->actions != NULL)
1728 return g_action_group_list_actions (application->priv->actions);
1731 /* empty string array */
1732 return g_new0 (gchar *, 1);
1736 g_application_query_action (GActionGroup *group,
1737 const gchar *action_name,
1739 const GVariantType **parameter_type,
1740 const GVariantType **state_type,
1741 GVariant **state_hint,
1744 GApplication *application = G_APPLICATION (group);
1746 g_return_val_if_fail (application->priv->is_registered, FALSE);
1748 if (application->priv->remote_actions != NULL)
1749 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
1757 if (application->priv->actions != NULL)
1758 return g_action_group_query_action (application->priv->actions,
1770 g_application_change_action_state (GActionGroup *action_group,
1771 const gchar *action_name,
1774 GApplication *application = G_APPLICATION (action_group);
1776 g_return_if_fail (application->priv->is_remote ||
1777 application->priv->actions != NULL);
1778 g_return_if_fail (application->priv->is_registered);
1780 if (application->priv->remote_actions)
1781 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
1782 action_name, value, get_platform_data (application));
1785 g_action_group_change_action_state (application->priv->actions, action_name, value);
1789 g_application_activate_action (GActionGroup *action_group,
1790 const gchar *action_name,
1791 GVariant *parameter)
1793 GApplication *application = G_APPLICATION (action_group);
1795 g_return_if_fail (application->priv->is_remote ||
1796 application->priv->actions != NULL);
1797 g_return_if_fail (application->priv->is_registered);
1799 if (application->priv->remote_actions)
1800 g_remote_action_group_activate_action_full (application->priv->remote_actions,
1801 action_name, parameter, get_platform_data (application));
1804 g_action_group_activate_action (application->priv->actions, action_name, parameter);
1808 g_application_lookup_action (GActionMap *action_map,
1809 const gchar *action_name)
1811 GApplication *application = G_APPLICATION (action_map);
1813 g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
1815 return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
1819 g_application_add_action (GActionMap *action_map,
1822 GApplication *application = G_APPLICATION (action_map);
1824 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
1826 g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
1830 g_application_remove_action (GActionMap *action_map,
1831 const gchar *action_name)
1833 GApplication *application = G_APPLICATION (action_map);
1835 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
1837 g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
1841 g_application_action_group_iface_init (GActionGroupInterface *iface)
1843 iface->list_actions = g_application_list_actions;
1844 iface->query_action = g_application_query_action;
1845 iface->change_action_state = g_application_change_action_state;
1846 iface->activate_action = g_application_activate_action;
1850 g_application_action_map_iface_init (GActionMapInterface *iface)
1852 iface->lookup_action = g_application_lookup_action;
1853 iface->add_action = g_application_add_action;
1854 iface->remove_action = g_application_remove_action;
1857 /* Default Application {{{1 */
1859 static GApplication *default_app;
1862 * g_application_get_default:
1864 * Returns the default #GApplication instance for this process.
1866 * Normally there is only one #GApplication per process and it becomes
1867 * the default when it is created. You can exercise more control over
1868 * this by using g_application_set_default().
1870 * If there is no default application then %NULL is returned.
1872 * Returns: (transfer none): the default application for this process, or %NULL
1877 g_application_get_default (void)
1883 * g_application_set_default:
1884 * @application: (allow-none): the application to set as default, or %NULL
1886 * Sets or unsets the default application for the process, as returned
1887 * by g_application_get_default().
1889 * This function does not take its own reference on @application. If
1890 * @application is destroyed then the default application will revert
1896 g_application_set_default (GApplication *application)
1898 default_app = application;
1902 * g_application_quit:
1903 * @application: a #GApplication
1905 * Immediately quits the application.
1907 * Upon return to the mainloop, g_application_run() will return,
1908 * calling only the 'shutdown' function before doing so.
1910 * The hold count is ignored.
1912 * The result of calling g_application_run() again after it returns is
1918 g_application_quit (GApplication *application)
1920 g_return_if_fail (G_IS_APPLICATION (application));
1922 application->priv->must_quit_now = TRUE;
1926 * g_application_mark_busy:
1927 * @application: a #GApplication
1929 * Increases the busy count of @application.
1931 * Use this function to indicate that the application is busy, for instance
1932 * while a long running operation is pending.
1934 * The busy state will be exposed to other processes, so a session shell will
1935 * use that information to indicate the state to the user (e.g. with a
1938 * To cancel the busy indication, use g_application_unmark_busy().
1943 g_application_mark_busy (GApplication *application)
1947 g_return_if_fail (G_IS_APPLICATION (application));
1949 was_busy = (application->priv->busy_count > 0);
1950 application->priv->busy_count++;
1953 g_application_impl_set_busy_state (application->priv->impl, TRUE);
1957 * g_application_unmark_busy:
1958 * @application: a #GApplication
1960 * Decreases the busy count of @application.
1962 * When the busy count reaches zero, the new state will be propagated
1963 * to other processes.
1965 * This function must only be called to cancel the effect of a previous
1966 * call to g_application_mark_busy().
1971 g_application_unmark_busy (GApplication *application)
1973 g_return_if_fail (G_IS_APPLICATION (application));
1974 g_return_if_fail (application->priv->busy_count > 0);
1976 application->priv->busy_count--;
1978 if (application->priv->busy_count == 0)
1979 g_application_impl_set_busy_state (application->priv->impl, FALSE);
1982 /* Notifications {{{1 */
1985 * g_application_send_notification:
1986 * @application: a #GApplication
1987 * @id: (allow-none): id of the notification, or %NULL
1988 * @notification: the #GNotification to send
1990 * Sends a notification on behalf of @application to the desktop shell.
1991 * There is no guarantee that the notification is displayed immediately,
1994 * Notifications may persist after the application exits. It will be
1995 * D-Bus-activated when the notification or one of its actions is
1998 * Modifying @notification after this call has no effect. However, the
1999 * object can be reused for a later call to this function.
2001 * @id may be any string that uniquely identifies the event for the
2002 * application. It does not need to be in any special format. For
2003 * example, "new-message" might be appropriate for a notification about
2006 * If a previous notification was sent with the same @id, it will be
2007 * replaced with @notification and shown again as if it was a new
2008 * notification. This works even for notifications sent from a previous
2009 * execution of the application, as long as @id is the same string.
2011 * @id may be %NULL, but it is impossible to replace or withdraw
2012 * notifications without an id.
2014 * If @notification is no longer relevant, it can be withdrawn with
2015 * g_application_withdraw_notification().
2020 g_application_send_notification (GApplication *application,
2022 GNotification *notification)
2024 gchar *generated_id = NULL;
2026 g_return_if_fail (G_IS_APPLICATION (application));
2027 g_return_if_fail (G_IS_NOTIFICATION (notification));
2028 g_return_if_fail (g_application_get_is_registered (application));
2029 g_return_if_fail (!g_application_get_is_remote (application));
2031 if (application->priv->notifications == NULL)
2032 application->priv->notifications = g_notification_backend_new_default (application);
2036 generated_id = g_dbus_generate_guid ();
2040 g_notification_backend_send_notification (application->priv->notifications, id, notification);
2042 g_free (generated_id);
2046 * g_application_withdraw_notification:
2047 * @application: a #GApplication
2048 * @id: id of a previously sent notification
2050 * Withdraws a notification that was sent with
2051 * g_application_send_notification().
2053 * This call does nothing if a notification with @id doesn't exist or
2054 * the notification was never sent.
2056 * This function works even for notifications sent in previous
2057 * executions of this application, as long @id is the same as it was for
2058 * the sent notification.
2060 * Note that notifications are dismissed when the user clicks on one
2061 * of the buttons in a notification or triggers its default action, so
2062 * there is no need to explicitly withdraw the notification in that case.
2067 g_application_withdraw_notification (GApplication *application,
2070 g_return_if_fail (G_IS_APPLICATION (application));
2071 g_return_if_fail (id != NULL);
2073 if (application->priv->notifications)
2074 g_notification_backend_withdraw_notification (application->priv->notifications, id);
2078 /* vim:set foldmethod=marker: */