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"
36 #include "gioenumtypes.h"
45 * SECTION:gapplication
46 * @title: GApplication
47 * @short_description: Core application class
49 * A #GApplication is the foundation of an application, unique for a
50 * given application identifier. The GApplication class wraps some
51 * low-level platform-specific services and is intended to act as the
52 * foundation for higher-level application classes such as
53 * #GtkApplication or #MxApplication. In general, you should not use
54 * this class outside of a higher level framework.
56 * One of the core features that GApplication provides is process
57 * uniqueness, in the context of a "session". The session concept is
58 * platform-dependent, but corresponds roughly to a graphical desktop
59 * login. When your application is launched again, its arguments
60 * are passed through platform communication to the already running
61 * program. The already running instance of the program is called the
62 * <firstterm>primary instance</firstterm>. On Linux, the D-Bus session
63 * bus is used for communication.
65 * GApplication provides convenient life cycle management by maintaining
66 * a <firstterm>use count</firstterm> for the primary application instance.
67 * The use count can be changed using g_application_hold() and
68 * g_application_release(). If it drops to zero, the application exits.
69 * Higher-level classes such as #GtkApplication employ the use count to
70 * ensure that the application stays alive as long as it has any opened
73 * Before using GApplication, you must choose an "application identifier".
74 * The expected form of an application identifier is very close to that of
75 * of a <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
76 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
77 * For details on valid application identifiers, see g_application_id_is_valid().
79 * On Linux, the application identifier is claimed as a well-known bus name
80 * on the user's session bus. This means that the uniqueness of your
81 * application is scoped to the current session. It also means that your
82 * application may provide additional services (through registration of other
83 * object paths) at that bus name. The registration of these object paths
84 * should be done with the shared GDBus session bus. Note that due to the
85 * internal architecture of GDBus, method calls can be dispatched at any time
86 * (even if a main loop is not running). For this reason, you must ensure that
87 * any object paths that you wish to register are registered before #GApplication
88 * attempts to acquire the bus name of your application (which happens in
89 * g_application_register()). Unfortunately, this means that you cannot use
90 * g_application_get_is_remote() to decide if you want to register object paths.
92 * GApplication also implements the #GActionGroup and #GActionMap
93 * interfaces and lets you easily export actions by adding them with
94 * g_action_map_add_action(). When invoking an action by calling
95 * g_action_group_activate_action() on the application, it is always
96 * invoked in the primary instance. The actions are also exported on
97 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
98 * conveniently access them remotely. Additionally, g_application_set_app_menu()
99 * and g_application_set_menubar() can be used to export representation
100 * data for the actions, in the form of #GMenuModels. GIO provides
101 * a #GDBusMenuModel wrapper for remote access to exported #GMenuModels.
103 * There is a number of different entry points into a GApplication:
105 * <listitem>via 'Activate' (i.e. just starting the application)</listitem>
106 * <listitem>via 'Open' (i.e. opening some files)</listitem>
107 * <listitem>by handling a command-line</listitem>
108 * <listitem>via activating an action</listitem>
110 * The #GApplication::startup signal lets you handle the application
111 * initialization for all of these in a single place.
113 * Regardless of which of these entry points is used to start the application,
114 * GApplication passes some <firstterm id="platform-data">platform
115 * data</firstterm> from the launching instance to the primary instance,
116 * in the form of a #GVariant dictionary mapping strings to variants.
117 * To use platform data, override the @before_emit or @after_emit virtual
118 * functions in your #GApplication subclass. When dealing with
119 * #GApplicationCommandline objects, the platform data is directly
120 * available via g_application_command_line_get_cwd(),
121 * g_application_command_line_get_environ() and
122 * g_application_command_line_get_platform_data().
124 * As the name indicates, the platform data may vary depending on the
125 * operating system, but it always includes the current directory (key
126 * "cwd"), and optionally the environment (ie the set of environment
127 * variables and their values) of the calling process (key "environ").
128 * The environment is only added to the platform data if the
129 * #G_APPLICATION_SEND_ENVIONMENT flag is set. GApplication subclasses
130 * can add their own platform data by overriding the @add_platform_data
131 * virtual function. For instance, #GtkApplication adds startup notification
134 * To parse commandline arguments you may handle the
135 * #GApplication::command-line signal or override the local_command_line()
136 * vfunc, to parse them in either the primary instance or the local instance,
139 * <example id="gapplication-example-open"><title>Opening files with a GApplication</title>
141 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-open.c">
142 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
147 * <example id="gapplication-example-actions"><title>A GApplication with actions</title>
149 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-actions.c">
150 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
155 * <example id="gapplication-example-menu"><title>A GApplication with menus</title>
157 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-menu.c">
158 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
166 * @startup: invoked on the primary instance immediately after registration
167 * @shutdown: invoked only on the registered primary instance immediately
168 * after the main loop terminates
169 * @activate: invoked on the primary instance when an activation occurs
170 * @open: invoked on the primary instance when there are files to open
171 * @command_line: invoked on the primary instance when a command-line is
172 * not handled locally
173 * @local_command_line: invoked (locally) when the process has been invoked
174 * via commandline execution (as opposed to, say, D-Bus activation - which
175 * is not currently supported by GApplication). The virtual function has
176 * the chance to inspect (and possibly replace) the list of command line
177 * arguments. See g_application_run() for more information.
178 * @before_emit: invoked on the primary instance before 'activate', 'open',
179 * 'command-line' or any action invocation, gets the 'platform data' from
180 * the calling instance
181 * @after_emit: invoked on the primary instance after 'activate', 'open',
182 * 'command-line' or any action invocation, gets the 'platform data' from
183 * the calling instance
184 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
185 * the primary instance when activating, opening or invoking actions
186 * @quit_mainloop: Used to be invoked on the primary instance when the use
187 * count of the application drops to zero (and after any inactivity
188 * timeout, if requested). Not used anymore since 2.32
189 * @run_mainloop: Used to be invoked on the primary instance from
190 * g_application_run() if the use-count is non-zero. Since 2.32,
191 * GApplication is iterating the main context directly and is not
192 * using @run_mainloop anymore
194 * Virtual function table for #GApplication.
199 struct _GApplicationPrivate
201 GApplicationFlags flags;
204 GActionGroup *actions;
205 GMenuModel *app_menu;
208 guint inactivity_timeout_id;
209 guint inactivity_timeout;
212 guint is_registered : 1;
214 guint did_startup : 1;
215 guint did_shutdown : 1;
217 GRemoteActionGroup *remote_actions;
218 GApplicationImpl *impl;
228 PROP_INACTIVITY_TIMEOUT,
243 static guint g_application_signals[NR_SIGNALS];
245 static void g_application_action_group_iface_init (GActionGroupInterface *);
246 static void g_application_action_map_iface_init (GActionMapInterface *);
247 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
248 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
249 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
251 /* GApplicationExportedActions {{{1 */
253 /* We create a subclass of GSimpleActionGroup that implements
254 * GRemoteActionGroup and deals with the platform data using
255 * GApplication's before/after_emit vfuncs. This is the action group we
258 * We could implement GRemoteActionGroup on GApplication directly, but
259 * this would be potentially extremely confusing to have exposed as part
260 * of the public API of GApplication. We certainly don't want anyone in
261 * the same process to be calling these APIs...
263 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
266 GSimpleActionGroup parent_instance;
267 GApplication *application;
268 } GApplicationExportedActions;
270 static GType g_application_exported_actions_get_type (void);
271 static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
272 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
273 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
276 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
277 const gchar *action_name,
279 GVariant *platform_data)
281 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
283 G_APPLICATION_GET_CLASS (exported->application)
284 ->before_emit (exported->application, platform_data);
286 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
288 G_APPLICATION_GET_CLASS (exported->application)
289 ->after_emit (exported->application, platform_data);
293 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
294 const gchar *action_name,
296 GVariant *platform_data)
298 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
300 G_APPLICATION_GET_CLASS (exported->application)
301 ->before_emit (exported->application, platform_data);
303 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
305 G_APPLICATION_GET_CLASS (exported->application)
306 ->after_emit (exported->application, platform_data);
310 g_application_exported_actions_init (GApplicationExportedActions *actions)
315 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
317 iface->activate_action_full = g_application_exported_actions_activate_action_full;
318 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
322 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
326 static GActionGroup *
327 g_application_exported_actions_new (GApplication *application)
329 GApplicationExportedActions *actions;
331 actions = g_object_new (g_application_exported_actions_get_type (), NULL);
332 actions->application = application;
334 return G_ACTION_GROUP (actions);
337 /* vfunc defaults {{{1 */
339 g_application_real_before_emit (GApplication *application,
340 GVariant *platform_data)
345 g_application_real_after_emit (GApplication *application,
346 GVariant *platform_data)
351 g_application_real_startup (GApplication *application)
353 application->priv->did_startup = TRUE;
357 g_application_real_shutdown (GApplication *application)
359 application->priv->did_shutdown = TRUE;
363 g_application_real_activate (GApplication *application)
365 if (!g_signal_has_handler_pending (application,
366 g_application_signals[SIGNAL_ACTIVATE],
368 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
370 static gboolean warned;
375 g_warning ("Your application does not implement "
376 "g_application_activate() and has no handlers connected "
377 "to the 'activate' signal. It should do one of these.");
383 g_application_real_open (GApplication *application,
388 if (!g_signal_has_handler_pending (application,
389 g_application_signals[SIGNAL_OPEN],
391 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
393 static gboolean warned;
398 g_warning ("Your application claims to support opening files "
399 "but does not implement g_application_open() and has no "
400 "handlers connected to the 'open' signal.");
406 g_application_real_command_line (GApplication *application,
407 GApplicationCommandLine *cmdline)
409 if (!g_signal_has_handler_pending (application,
410 g_application_signals[SIGNAL_COMMAND_LINE],
412 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
414 static gboolean warned;
419 g_warning ("Your application claims to support custom command line "
420 "handling but does not implement g_application_command_line() "
421 "and has no handlers connected to the 'command-line' signal.");
430 g_application_real_local_command_line (GApplication *application,
434 if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
439 GError *error = NULL;
442 if (!g_application_register (application, NULL, &error))
444 g_critical ("%s", error->message);
445 g_error_free (error);
450 n_args = g_strv_length (*arguments);
452 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
454 if ((*exit_status = n_args > 1))
456 g_printerr ("GApplication service mode takes no arguments.\n");
457 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
465 g_application_activate (application);
471 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
473 g_critical ("This application can not open files.");
482 n_files = n_args - 1;
483 files = g_new (GFile *, n_files);
485 for (i = 0; i < n_files; i++)
486 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
488 g_application_open (application, files, n_files, "");
490 for (i = 0; i < n_files; i++)
491 g_object_unref (files[i]);
503 g_application_real_add_platform_data (GApplication *application,
504 GVariantBuilder *builder)
508 /* GObject implementation stuff {{{1 */
510 g_application_set_property (GObject *object,
515 GApplication *application = G_APPLICATION (object);
519 case PROP_APPLICATION_ID:
520 g_application_set_application_id (application,
521 g_value_get_string (value));
525 g_application_set_flags (application, g_value_get_flags (value));
528 case PROP_INACTIVITY_TIMEOUT:
529 g_application_set_inactivity_timeout (application,
530 g_value_get_uint (value));
533 case PROP_ACTION_GROUP:
534 g_clear_object (&application->priv->actions);
535 application->priv->actions = g_value_dup_object (value);
539 g_assert_not_reached ();
544 * g_application_set_action_group:
545 * @application: a #GApplication
546 * @action_group: (allow-none): a #GActionGroup, or %NULL
548 * This used to be how actions were associated with a #GApplication.
549 * Now there is #GActionMap for that.
553 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
554 * mix use of this API with use of #GActionMap on the same @application
555 * or things will go very badly wrong. This function is known to
556 * introduce buggy behaviour (ie: signals not emitted on changes to the
557 * action group), so you should really use #GActionMap instead.
560 g_application_set_action_group (GApplication *application,
561 GActionGroup *action_group)
563 g_return_if_fail (G_IS_APPLICATION (application));
564 g_return_if_fail (!application->priv->is_registered);
566 if (application->priv->actions != NULL)
567 g_object_unref (application->priv->actions);
569 application->priv->actions = action_group;
571 if (application->priv->actions != NULL)
572 g_object_ref (application->priv->actions);
576 g_application_get_property (GObject *object,
581 GApplication *application = G_APPLICATION (object);
585 case PROP_APPLICATION_ID:
586 g_value_set_string (value,
587 g_application_get_application_id (application));
591 g_value_set_flags (value,
592 g_application_get_flags (application));
595 case PROP_IS_REGISTERED:
596 g_value_set_boolean (value,
597 g_application_get_is_registered (application));
601 g_value_set_boolean (value,
602 g_application_get_is_remote (application));
605 case PROP_INACTIVITY_TIMEOUT:
606 g_value_set_uint (value,
607 g_application_get_inactivity_timeout (application));
611 g_assert_not_reached ();
616 g_application_constructed (GObject *object)
618 GApplication *application = G_APPLICATION (object);
620 g_assert (application->priv->id != NULL);
622 if (g_application_get_default () == NULL)
623 g_application_set_default (application);
627 g_application_finalize (GObject *object)
629 GApplication *application = G_APPLICATION (object);
631 if (application->priv->impl)
632 g_application_impl_destroy (application->priv->impl);
633 g_free (application->priv->id);
635 if (g_application_get_default () == application)
636 g_application_set_default (NULL);
638 if (application->priv->actions)
639 g_object_unref (application->priv->actions);
641 G_OBJECT_CLASS (g_application_parent_class)
646 g_application_init (GApplication *application)
648 application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
650 GApplicationPrivate);
652 application->priv->actions = g_application_exported_actions_new (application);
654 /* application->priv->actions is the one and only ref on the group, so when
655 * we dispose, the action group will die, disconnecting all signals.
657 g_signal_connect_swapped (application->priv->actions, "action-added",
658 G_CALLBACK (g_action_group_action_added), application);
659 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
660 G_CALLBACK (g_action_group_action_enabled_changed), application);
661 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
662 G_CALLBACK (g_action_group_action_state_changed), application);
663 g_signal_connect_swapped (application->priv->actions, "action-removed",
664 G_CALLBACK (g_action_group_action_removed), application);
668 g_application_class_init (GApplicationClass *class)
670 GObjectClass *object_class = G_OBJECT_CLASS (class);
672 object_class->constructed = g_application_constructed;
673 object_class->finalize = g_application_finalize;
674 object_class->get_property = g_application_get_property;
675 object_class->set_property = g_application_set_property;
677 class->before_emit = g_application_real_before_emit;
678 class->after_emit = g_application_real_after_emit;
679 class->startup = g_application_real_startup;
680 class->shutdown = g_application_real_shutdown;
681 class->activate = g_application_real_activate;
682 class->open = g_application_real_open;
683 class->command_line = g_application_real_command_line;
684 class->local_command_line = g_application_real_local_command_line;
685 class->add_platform_data = g_application_real_add_platform_data;
687 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
688 g_param_spec_string ("application-id",
689 P_("Application identifier"),
690 P_("The unique identifier for the application"),
691 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
692 G_PARAM_STATIC_STRINGS));
694 g_object_class_install_property (object_class, PROP_FLAGS,
695 g_param_spec_flags ("flags",
696 P_("Application flags"),
697 P_("Flags specifying the behaviour of the application"),
698 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
699 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
701 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
702 g_param_spec_boolean ("is-registered",
704 P_("If g_application_register() has been called"),
705 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
707 g_object_class_install_property (object_class, PROP_IS_REMOTE,
708 g_param_spec_boolean ("is-remote",
710 P_("If this application instance is remote"),
711 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
713 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
714 g_param_spec_uint ("inactivity-timeout",
715 P_("Inactivity timeout"),
716 P_("Time (ms) to stay alive after becoming idle"),
718 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
720 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
721 g_param_spec_object ("action-group",
723 P_("The group of actions that the application exports"),
725 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
728 * GApplication::startup:
729 * @application: the application
731 * The ::startup signal is emitted on the primary instance immediately
732 * after registration. See g_application_register().
734 g_application_signals[SIGNAL_STARTUP] =
735 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
736 G_STRUCT_OFFSET (GApplicationClass, startup),
737 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
740 * GApplication::shutdown:
741 * @application: the application
743 * The ::shutdown signal is emitted only on the registered primary instance
744 * immediately after the main loop terminates.
746 g_application_signals[SIGNAL_SHUTDOWN] =
747 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
748 G_STRUCT_OFFSET (GApplicationClass, shutdown),
749 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
752 * GApplication::activate:
753 * @application: the application
755 * The ::activate signal is emitted on the primary instance when an
756 * activation occurs. See g_application_activate().
758 g_application_signals[SIGNAL_ACTIVATE] =
759 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
760 G_STRUCT_OFFSET (GApplicationClass, activate),
761 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
765 * GApplication::open:
766 * @application: the application
767 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
768 * @n_files: the length of @files
769 * @hint: a hint provided by the calling instance
771 * The ::open signal is emitted on the primary instance when there are
772 * files to open. See g_application_open() for more information.
774 g_application_signals[SIGNAL_OPEN] =
775 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
776 G_STRUCT_OFFSET (GApplicationClass, open),
778 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
781 * GApplication::command-line:
782 * @application: the application
783 * @command_line: a #GApplicationCommandLine representing the
786 * The ::command-line signal is emitted on the primary instance when
787 * a commandline is not handled locally. See g_application_run() and
788 * the #GApplicationCommandline documentation for more information.
790 * Returns: An integer that is set as the exit status for the calling
791 * process. See g_application_command_line_set_exit_status().
793 g_application_signals[SIGNAL_COMMAND_LINE] =
794 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
795 G_STRUCT_OFFSET (GApplicationClass, command_line),
796 g_signal_accumulator_first_wins, NULL,
798 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
800 g_type_class_add_private (class, sizeof (GApplicationPrivate));
804 get_platform_data (GApplication *application)
806 GVariantBuilder *builder;
809 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
812 gchar *cwd = g_get_current_dir ();
813 g_variant_builder_add (builder, "{sv}", "cwd",
814 g_variant_new_bytestring (cwd));
818 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
823 envp = g_get_environ ();
824 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
827 g_variant_builder_add (builder, "{sv}", "environ", array);
830 G_APPLICATION_GET_CLASS (application)->
831 add_platform_data (application, builder);
833 result = g_variant_builder_end (builder);
834 g_variant_builder_unref (builder);
839 /* Application ID validity {{{1 */
842 * g_application_id_is_valid:
843 * @application_id: a potential application identifier
845 * Checks if @application_id is a valid application identifier.
847 * A valid ID is required for calls to g_application_new() and
848 * g_application_set_application_id().
850 * For convenience, the restrictions on application identifiers are
853 * <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-." and must not begin with a digit.</listitem>
854 * <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least three elements).</listitem>
855 * <listitem>Application identifiers must not begin or end with a '.' (period) character.</listitem>
856 * <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
857 * <listitem>Application identifiers must not exceed 255 characters.</listitem>
860 * Returns: %TRUE if @application_id is valid
863 g_application_id_is_valid (const gchar *application_id)
869 len = strlen (application_id);
874 if (!g_ascii_isalpha (application_id[0]))
877 if (application_id[len-1] == '.')
883 for (; *application_id; application_id++)
885 if (g_ascii_isalnum (*application_id) ||
886 (*application_id == '-') ||
887 (*application_id == '_'))
891 else if (allow_dot && *application_id == '.')
906 /* Public Constructor {{{1 */
909 * @application_id: the application id
910 * @flags: the application flags
912 * Creates a new #GApplication instance.
914 * This function calls g_type_init() for you.
916 * The application id must be valid. See g_application_id_is_valid().
918 * Returns: a new #GApplication instance
921 g_application_new (const gchar *application_id,
922 GApplicationFlags flags)
924 g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
928 return g_object_new (G_TYPE_APPLICATION,
929 "application-id", application_id,
934 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
936 * g_application_get_application_id:
937 * @application: a #GApplication
939 * Gets the unique identifier for @application.
941 * Returns: the identifier for @application, owned by @application
946 g_application_get_application_id (GApplication *application)
948 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
950 return application->priv->id;
954 * g_application_set_application_id:
955 * @application: a #GApplication
956 * @application_id: the identifier for @application
958 * Sets the unique identifier for @application.
960 * The application id can only be modified if @application has not yet
963 * The application id must be valid. See g_application_id_is_valid().
968 g_application_set_application_id (GApplication *application,
969 const gchar *application_id)
971 g_return_if_fail (G_IS_APPLICATION (application));
973 if (g_strcmp0 (application->priv->id, application_id) != 0)
975 g_return_if_fail (g_application_id_is_valid (application_id));
976 g_return_if_fail (!application->priv->is_registered);
978 g_free (application->priv->id);
979 application->priv->id = g_strdup (application_id);
981 g_object_notify (G_OBJECT (application), "application-id");
986 * g_application_get_flags:
987 * @application: a #GApplication
989 * Gets the flags for @application.
991 * See #GApplicationFlags.
993 * Returns: the flags for @application
998 g_application_get_flags (GApplication *application)
1000 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1002 return application->priv->flags;
1006 * g_application_set_flags:
1007 * @application: a #GApplication
1008 * @flags: the flags for @application
1010 * Sets the flags for @application.
1012 * The flags can only be modified if @application has not yet been
1015 * See #GApplicationFlags.
1020 g_application_set_flags (GApplication *application,
1021 GApplicationFlags flags)
1023 g_return_if_fail (G_IS_APPLICATION (application));
1025 if (application->priv->flags != flags)
1027 g_return_if_fail (!application->priv->is_registered);
1029 application->priv->flags = flags;
1031 g_object_notify (G_OBJECT (application), "flags");
1036 * g_application_get_inactivity_timeout:
1037 * @application: a #GApplication
1039 * Gets the current inactivity timeout for the application.
1041 * This is the amount of time (in milliseconds) after the last call to
1042 * g_application_release() before the application stops running.
1044 * Returns: the timeout, in milliseconds
1049 g_application_get_inactivity_timeout (GApplication *application)
1051 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1053 return application->priv->inactivity_timeout;
1057 * g_application_set_inactivity_timeout:
1058 * @application: a #GApplication
1059 * @inactivity_timeout: the timeout, in milliseconds
1061 * Sets the current inactivity timeout for the application.
1063 * This is the amount of time (in milliseconds) after the last call to
1064 * g_application_release() before the application stops running.
1066 * This call has no side effects of its own. The value set here is only
1067 * used for next time g_application_release() drops the use count to
1068 * zero. Any timeouts currently in progress are not impacted.
1073 g_application_set_inactivity_timeout (GApplication *application,
1074 guint inactivity_timeout)
1076 g_return_if_fail (G_IS_APPLICATION (application));
1078 if (application->priv->inactivity_timeout != inactivity_timeout)
1080 application->priv->inactivity_timeout = inactivity_timeout;
1082 g_object_notify (G_OBJECT (application), "inactivity-timeout");
1085 /* Read-only property getters (is registered, is remote) {{{1 */
1087 * g_application_get_is_registered:
1088 * @application: a #GApplication
1090 * Checks if @application is registered.
1092 * An application is registered if g_application_register() has been
1093 * successfully called.
1095 * Returns: %TRUE if @application is registered
1100 g_application_get_is_registered (GApplication *application)
1102 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1104 return application->priv->is_registered;
1108 * g_application_get_is_remote:
1109 * @application: a #GApplication
1111 * Checks if @application is remote.
1113 * If @application is remote then it means that another instance of
1114 * application already exists (the 'primary' instance). Calls to
1115 * perform actions on @application will result in the actions being
1116 * performed by the primary instance.
1118 * The value of this property cannot be accessed before
1119 * g_application_register() has been called. See
1120 * g_application_get_is_registered().
1122 * Returns: %TRUE if @application is remote
1127 g_application_get_is_remote (GApplication *application)
1129 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1130 g_return_val_if_fail (application->priv->is_registered, FALSE);
1132 return application->priv->is_remote;
1137 * g_application_register:
1138 * @application: a #GApplication
1139 * @cancellable: a #GCancellable, or %NULL
1140 * @error: a pointer to a NULL #GError, or %NULL
1142 * Attempts registration of the application.
1144 * This is the point at which the application discovers if it is the
1145 * primary instance or merely acting as a remote for an already-existing
1146 * primary instance. This is implemented by attempting to acquire the
1147 * application identifier as a unique bus name on the session bus using
1150 * Due to the internal architecture of GDBus, method calls can be
1151 * dispatched at any time (even if a main loop is not running). For
1152 * this reason, you must ensure that any object paths that you wish to
1153 * register are registered before calling this function.
1155 * If the application has already been registered then %TRUE is
1156 * returned with no work performed.
1158 * The #GApplication::startup signal is emitted if registration succeeds
1159 * and @application is the primary instance.
1161 * In the event of an error (such as @cancellable being cancelled, or a
1162 * failure to connect to the session bus), %FALSE is returned and @error
1163 * is set appropriately.
1165 * Note: the return value of this function is not an indicator that this
1166 * instance is or is not the primary instance of the application. See
1167 * g_application_get_is_remote() for that.
1169 * Returns: %TRUE if registration succeeded
1174 g_application_register (GApplication *application,
1175 GCancellable *cancellable,
1178 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1180 if (!application->priv->is_registered)
1182 if (~application->priv->flags & G_APPLICATION_NON_UNIQUE)
1184 application->priv->impl =
1185 g_application_impl_register (application, application->priv->id,
1186 application->priv->flags,
1187 application->priv->actions,
1188 &application->priv->remote_actions,
1189 cancellable, error);
1191 if (application->priv->impl == NULL)
1195 application->priv->is_remote = application->priv->remote_actions != NULL;
1196 application->priv->is_registered = TRUE;
1198 g_object_notify (G_OBJECT (application), "is-registered");
1200 if (!application->priv->is_remote)
1202 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1204 if (!application->priv->did_startup)
1205 g_critical ("GApplication subclass '%s' failed to chain up on"
1206 " ::startup (from start of override function)",
1207 G_OBJECT_TYPE_NAME (application));
1214 /* Hold/release {{{1 */
1216 * g_application_hold:
1217 * @application: a #GApplication
1219 * Increases the use count of @application.
1221 * Use this function to indicate that the application has a reason to
1222 * continue to run. For example, g_application_hold() is called by GTK+
1223 * when a toplevel window is on the screen.
1225 * To cancel the hold, call g_application_release().
1228 g_application_hold (GApplication *application)
1230 if (application->priv->inactivity_timeout_id)
1232 g_source_remove (application->priv->inactivity_timeout_id);
1233 application->priv->inactivity_timeout_id = 0;
1236 application->priv->use_count++;
1240 inactivity_timeout_expired (gpointer data)
1242 GApplication *application = G_APPLICATION (data);
1244 application->priv->inactivity_timeout_id = 0;
1246 return G_SOURCE_REMOVE;
1251 * g_application_release:
1252 * @application: a #GApplication
1254 * Decrease the use count of @application.
1256 * When the use count reaches zero, the application will stop running.
1258 * Never call this function except to cancel the effect of a previous
1259 * call to g_application_hold().
1262 g_application_release (GApplication *application)
1264 application->priv->use_count--;
1266 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
1267 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
1268 inactivity_timeout_expired, application);
1271 /* Activate, Open {{{1 */
1273 * g_application_activate:
1274 * @application: a #GApplication
1276 * Activates the application.
1278 * In essence, this results in the #GApplication::activate() signal being
1279 * emitted in the primary instance.
1281 * The application must be registered before calling this function.
1286 g_application_activate (GApplication *application)
1288 g_return_if_fail (G_IS_APPLICATION (application));
1289 g_return_if_fail (application->priv->is_registered);
1291 if (application->priv->is_remote)
1292 g_application_impl_activate (application->priv->impl,
1293 get_platform_data (application));
1296 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1300 * g_application_open:
1301 * @application: a #GApplication
1302 * @files: (array length=n_files): an array of #GFiles to open
1303 * @n_files: the length of the @files array
1304 * @hint: a hint (or ""), but never %NULL
1306 * Opens the given files.
1308 * In essence, this results in the #GApplication::open signal being emitted
1309 * in the primary instance.
1311 * @n_files must be greater than zero.
1313 * @hint is simply passed through to the ::open signal. It is
1314 * intended to be used by applications that have multiple modes for
1315 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1316 * for this functionality, you should use "".
1318 * The application must be registered before calling this function
1319 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1324 g_application_open (GApplication *application,
1329 g_return_if_fail (G_IS_APPLICATION (application));
1330 g_return_if_fail (application->priv->flags &
1331 G_APPLICATION_HANDLES_OPEN);
1332 g_return_if_fail (application->priv->is_registered);
1334 if (application->priv->is_remote)
1335 g_application_impl_open (application->priv->impl,
1336 files, n_files, hint,
1337 get_platform_data (application));
1340 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1341 0, files, n_files, hint);
1346 * g_application_run:
1347 * @application: a #GApplication
1348 * @argc: the argc from main() (or 0 if @argv is %NULL)
1349 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1351 * Runs the application.
1353 * This function is intended to be run from main() and its return value
1354 * is intended to be returned by main(). Although you are expected to pass
1355 * the @argc, @argv parameters from main() to this function, it is possible
1356 * to pass %NULL if @argv is not available or commandline handling is not
1359 * First, the local_command_line() virtual function is invoked.
1360 * This function always runs on the local instance. It gets passed a pointer
1361 * to a %NULL-terminated copy of @argv and is expected to remove the arguments
1362 * that it handled (shifting up remaining arguments). See
1363 * <xref linkend="gapplication-example-cmdline2"/> for an example of
1364 * parsing @argv manually. Alternatively, you may use the #GOptionContext API,
1365 * after setting <literal>argc = g_strv_length (argv);</literal>.
1367 * The last argument to local_command_line() is a pointer to the @status
1368 * variable which can used to set the exit status that is returned from
1369 * g_application_run().
1371 * If local_command_line() returns %TRUE, the command line is expected
1372 * to be completely handled, including possibly registering as the primary
1373 * instance, calling g_application_activate() or g_application_open(), etc.
1375 * If local_command_line() returns %FALSE then the application is registered
1376 * and the #GApplication::command-line signal is emitted in the primary
1377 * instance (which may or may not be this instance). The signal handler
1378 * gets passed a #GApplicationCommandline object that (among other things)
1379 * contains the remaining commandline arguments that have not been handled
1380 * by local_command_line().
1382 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1383 * flag set then the default implementation of local_command_line()
1384 * always returns %FALSE immediately, resulting in the commandline
1385 * always being handled in the primary instance.
1387 * Otherwise, the default implementation of local_command_line() tries
1388 * to do a couple of things that are probably reasonable for most
1389 * applications. First, g_application_register() is called to attempt
1390 * to register the application. If that works, then the command line
1391 * arguments are inspected. If no commandline arguments are given, then
1392 * g_application_activate() is called. If commandline arguments are
1393 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1394 * are assumed to be filenames and g_application_open() is called.
1396 * If you need to handle commandline arguments that are not filenames,
1397 * and you don't mind commandline handling to happen in the primary
1398 * instance, you should set %G_APPLICATION_HANDLED_COMMAND_LINE and
1399 * process the commandline arguments in your #GApplication::command-line
1400 * signal handler, either manually or using the #GOptionContext API.
1402 * If you are interested in doing more complicated local handling of the
1403 * commandline then you should implement your own #GApplication subclass
1404 * and override local_command_line(). In this case, you most likely want
1405 * to return %TRUE from your local_command_line() implementation to
1406 * suppress the default handling. See
1407 * <xref linkend="gapplication-example-cmdline2"/> for an example.
1409 * If, after the above is done, the use count of the application is zero
1410 * then the exit status is returned immediately. If the use count is
1411 * non-zero then the default main context is iterated until the use count
1412 * falls to zero, at which point 0 is returned.
1414 * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1415 * use count of zero is delayed for a while (ie: the instance stays
1416 * around to provide its <emphasis>service</emphasis> to others).
1418 * Returns: the exit status
1423 g_application_run (GApplication *application,
1431 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1432 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1434 arguments = g_new (gchar *, argc + 1);
1435 for (i = 0; i < argc; i++)
1436 arguments[i] = g_strdup (argv[i]);
1437 arguments[i] = NULL;
1439 if (g_get_prgname () == NULL && argc > 0)
1443 prgname = g_path_get_basename (argv[0]);
1444 g_set_prgname (prgname);
1448 if (!G_APPLICATION_GET_CLASS (application)
1449 ->local_command_line (application, &arguments, &status))
1451 GError *error = NULL;
1453 if (!g_application_register (application, NULL, &error))
1455 g_printerr ("%s", error->message);
1456 g_error_free (error);
1460 if (application->priv->is_remote)
1462 GVariant *platform_data;
1464 platform_data = get_platform_data (application);
1465 status = g_application_impl_command_line (application->priv->impl,
1466 arguments, platform_data);
1470 GApplicationCommandLine *cmdline;
1473 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1474 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1475 "arguments", v, NULL);
1476 g_signal_emit (application,
1477 g_application_signals[SIGNAL_COMMAND_LINE],
1478 0, cmdline, &status);
1479 g_object_unref (cmdline);
1483 g_strfreev (arguments);
1485 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1486 application->priv->is_registered &&
1487 !application->priv->use_count &&
1488 !application->priv->inactivity_timeout_id)
1490 application->priv->inactivity_timeout_id =
1491 g_timeout_add (10000, inactivity_timeout_expired, application);
1494 while (application->priv->use_count || application->priv->inactivity_timeout_id)
1496 g_main_context_iteration (NULL, TRUE);
1500 if (!application->priv->is_remote)
1502 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
1504 if (!application->priv->did_shutdown)
1505 g_critical ("GApplication subclass '%s' failed to chain up on"
1506 " ::shutdown (from end of override function)",
1507 G_OBJECT_TYPE_NAME (application));
1510 if (application->priv->impl)
1511 g_application_impl_flush (application->priv->impl);
1519 g_application_list_actions (GActionGroup *action_group)
1521 GApplication *application = G_APPLICATION (action_group);
1523 g_return_val_if_fail (application->priv->is_registered, NULL);
1525 if (application->priv->remote_actions != NULL)
1526 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
1528 else if (application->priv->actions != NULL)
1529 return g_action_group_list_actions (application->priv->actions);
1532 /* empty string array */
1533 return g_new0 (gchar *, 1);
1537 g_application_query_action (GActionGroup *group,
1538 const gchar *action_name,
1540 const GVariantType **parameter_type,
1541 const GVariantType **state_type,
1542 GVariant **state_hint,
1545 GApplication *application = G_APPLICATION (group);
1547 g_return_val_if_fail (application->priv->is_registered, FALSE);
1549 if (application->priv->remote_actions != NULL)
1550 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
1558 if (application->priv->actions != NULL)
1559 return g_action_group_query_action (application->priv->actions,
1571 g_application_change_action_state (GActionGroup *action_group,
1572 const gchar *action_name,
1575 GApplication *application = G_APPLICATION (action_group);
1577 g_return_if_fail (application->priv->is_remote ||
1578 application->priv->actions != NULL);
1579 g_return_if_fail (application->priv->is_registered);
1581 if (application->priv->remote_actions)
1582 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
1583 action_name, value, get_platform_data (application));
1586 g_action_group_change_action_state (application->priv->actions, action_name, value);
1590 g_application_activate_action (GActionGroup *action_group,
1591 const gchar *action_name,
1592 GVariant *parameter)
1594 GApplication *application = G_APPLICATION (action_group);
1596 g_return_if_fail (application->priv->is_remote ||
1597 application->priv->actions != NULL);
1598 g_return_if_fail (application->priv->is_registered);
1600 if (application->priv->remote_actions)
1601 g_remote_action_group_activate_action_full (application->priv->remote_actions,
1602 action_name, parameter, get_platform_data (application));
1605 g_action_group_activate_action (application->priv->actions, action_name, parameter);
1609 g_application_lookup_action (GActionMap *action_map,
1610 const gchar *action_name)
1612 GApplication *application = G_APPLICATION (action_map);
1614 g_return_val_if_fail (G_IS_SIMPLE_ACTION_GROUP (application->priv->actions), NULL);
1616 return g_simple_action_group_lookup (G_SIMPLE_ACTION_GROUP (application->priv->actions), action_name);
1620 g_application_add_action (GActionMap *action_map,
1623 GApplication *application = G_APPLICATION (action_map);
1625 g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP (application->priv->actions));
1627 g_simple_action_group_insert (G_SIMPLE_ACTION_GROUP (application->priv->actions), action);
1631 g_application_remove_action (GActionMap *action_map,
1632 const gchar *action_name)
1634 GApplication *application = G_APPLICATION (action_map);
1636 g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP (application->priv->actions));
1638 g_simple_action_group_remove (G_SIMPLE_ACTION_GROUP (application->priv->actions), action_name);
1642 g_application_action_group_iface_init (GActionGroupInterface *iface)
1644 iface->list_actions = g_application_list_actions;
1645 iface->query_action = g_application_query_action;
1646 iface->change_action_state = g_application_change_action_state;
1647 iface->activate_action = g_application_activate_action;
1651 g_application_action_map_iface_init (GActionMapInterface *iface)
1653 iface->lookup_action = g_application_lookup_action;
1654 iface->add_action = g_application_add_action;
1655 iface->remove_action = g_application_remove_action;
1658 /* Default Application {{{1 */
1660 static GApplication *default_app;
1663 * g_application_get_default:
1664 * @returns: (transfer none): the default application for this process, or %NULL
1666 * Returns the default #GApplication instance for this process.
1668 * Normally there is only one #GApplication per process and it becomes
1669 * the default when it is created. You can exercise more control over
1670 * this by using g_application_set_default().
1672 * If there is no default application then %NULL is returned.
1677 g_application_get_default (void)
1683 * g_application_set_default:
1684 * @application: the application to set as default, or %NULL
1686 * Sets or unsets the default application for the process, as returned
1687 * by g_application_get_default().
1689 * This function does not take its own reference on @application. If
1690 * @application is destroyed then the default application will revert
1696 g_application_set_default (GApplication *application)
1698 default_app = application;
1702 /* vim:set foldmethod=marker: */