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. It wraps some
50 * low-level platform-specific services and is intended to act as the
51 * foundation for higher-level application classes such as
52 * #GtkApplication or #MxApplication. In general, you should not use
53 * this class outside of a higher level framework.
55 * GApplication provides convenient life cycle management by maintaining
56 * a <firstterm>use count</firstterm> for the primary application instance.
57 * The use count can be changed using g_application_hold() and
58 * g_application_release(). If it drops to zero, the application exits.
59 * Higher-level classes such as #GtkApplication employ the use count to
60 * ensure that the application stays alive as long as it has any opened
63 * Another feature that GApplication (optionally) provides is process
64 * uniqueness. Applications can make use of this functionality by
65 * providing a unique application ID. If given, only one application
66 * with this ID can be running at a time per session. The session
67 * concept is platform-dependent, but corresponds roughly to a graphical
68 * desktop login. When your application is launched again, its
69 * arguments are passed through platform communication to the already
70 * running program. The already running instance of the program is
71 * called the <firstterm>primary instance</firstterm>. On Linux, the
72 * D-Bus session bus is used for communication.
74 * If used, the expected form of an application identifier is very close
76 * <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
77 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
78 * For details on valid application identifiers, see g_application_id_is_valid().
80 * On Linux, the application identifier is claimed as a well-known bus name
81 * on the user's session bus. This means that the uniqueness of your
82 * application is scoped to the current session. It also means that your
83 * application may provide additional services (through registration of other
84 * object paths) at that bus name. The registration of these object paths
85 * should be done with the shared GDBus session bus. Note that due to the
86 * internal architecture of GDBus, method calls can be dispatched at any time
87 * (even if a main loop is not running). For this reason, you must ensure that
88 * any object paths that you wish to register are registered before #GApplication
89 * attempts to acquire the bus name of your application (which happens in
90 * g_application_register()). Unfortunately, this means that you cannot use
91 * g_application_get_is_remote() to decide if you want to register object paths.
93 * GApplication also implements the #GActionGroup and #GActionMap
94 * interfaces and lets you easily export actions by adding them with
95 * g_action_map_add_action(). When invoking an action by calling
96 * g_action_group_activate_action() on the application, it is always
97 * invoked in the primary instance. The actions are also exported on
98 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
99 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
100 * for remote access to exported #GMenuModels.
102 * There is a number of different entry points into a GApplication:
104 * <listitem>via 'Activate' (i.e. just starting the application)</listitem>
105 * <listitem>via 'Open' (i.e. opening some files)</listitem>
106 * <listitem>by handling a command-line</listitem>
107 * <listitem>via activating an action</listitem>
109 * The #GApplication::startup signal lets you handle the application
110 * initialization for all of these in a single place.
112 * Regardless of which of these entry points is used to start the application,
113 * GApplication passes some <firstterm id="platform-data">platform
114 * data</firstterm> from the launching instance to the primary instance,
115 * in the form of a #GVariant dictionary mapping strings to variants.
116 * To use platform data, override the @before_emit or @after_emit virtual
117 * functions in your #GApplication subclass. When dealing with
118 * #GApplicationCommandLine objects, the platform data is directly
119 * available via g_application_command_line_get_cwd(),
120 * g_application_command_line_get_environ() and
121 * g_application_command_line_get_platform_data().
123 * As the name indicates, the platform data may vary depending on the
124 * operating system, but it always includes the current directory (key
125 * "cwd"), and optionally the environment (ie the set of environment
126 * variables and their values) of the calling process (key "environ").
127 * The environment is only added to the platform data if the
128 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
129 * can add their own platform data by overriding the @add_platform_data
130 * virtual function. For instance, #GtkApplication adds startup notification
133 * To parse commandline arguments you may handle the
134 * #GApplication::command-line signal or override the local_command_line()
135 * vfunc, to parse them in either the primary instance or the local instance,
138 * <example id="gapplication-example-open"><title>Opening files with a GApplication</title>
140 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-open.c">
141 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
146 * <example id="gapplication-example-actions"><title>A GApplication with actions</title>
148 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-actions.c">
149 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
154 * <example id="gapplication-example-menu"><title>A GApplication with menus</title>
156 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-menu.c">
157 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
165 * @startup: invoked on the primary instance immediately after registration
166 * @shutdown: invoked only on the registered primary instance immediately
167 * after the main loop terminates
168 * @activate: invoked on the primary instance when an activation occurs
169 * @open: invoked on the primary instance when there are files to open
170 * @command_line: invoked on the primary instance when a command-line is
171 * not handled locally
172 * @local_command_line: invoked (locally) when the process has been invoked
173 * via commandline execution (as opposed to, say, D-Bus activation - which
174 * is not currently supported by GApplication). The virtual function has
175 * the chance to inspect (and possibly replace) the list of command line
176 * arguments. See g_application_run() for more information.
177 * @before_emit: invoked on the primary instance before 'activate', 'open',
178 * 'command-line' or any action invocation, gets the 'platform data' from
179 * the calling instance
180 * @after_emit: invoked on the primary instance after 'activate', 'open',
181 * 'command-line' or any action invocation, gets the 'platform data' from
182 * the calling instance
183 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
184 * the primary instance when activating, opening or invoking actions
185 * @quit_mainloop: Used to be invoked on the primary instance when the use
186 * count of the application drops to zero (and after any inactivity
187 * timeout, if requested). Not used anymore since 2.32
188 * @run_mainloop: Used to be invoked on the primary instance from
189 * g_application_run() if the use-count is non-zero. Since 2.32,
190 * GApplication is iterating the main context directly and is not
191 * using @run_mainloop anymore
193 * Virtual function table for #GApplication.
198 struct _GApplicationPrivate
200 GApplicationFlags flags;
203 GActionGroup *actions;
204 GMenuModel *app_menu;
207 guint inactivity_timeout_id;
208 guint inactivity_timeout;
211 guint is_registered : 1;
213 guint did_startup : 1;
214 guint did_shutdown : 1;
215 guint must_quit_now : 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 if (g_application_get_default () == NULL)
621 g_application_set_default (application);
625 g_application_finalize (GObject *object)
627 GApplication *application = G_APPLICATION (object);
629 if (application->priv->impl)
630 g_application_impl_destroy (application->priv->impl);
631 g_free (application->priv->id);
633 if (g_application_get_default () == application)
634 g_application_set_default (NULL);
636 if (application->priv->actions)
637 g_object_unref (application->priv->actions);
639 G_OBJECT_CLASS (g_application_parent_class)
644 g_application_init (GApplication *application)
646 application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
648 GApplicationPrivate);
650 application->priv->actions = g_application_exported_actions_new (application);
652 /* application->priv->actions is the one and only ref on the group, so when
653 * we dispose, the action group will die, disconnecting all signals.
655 g_signal_connect_swapped (application->priv->actions, "action-added",
656 G_CALLBACK (g_action_group_action_added), application);
657 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
658 G_CALLBACK (g_action_group_action_enabled_changed), application);
659 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
660 G_CALLBACK (g_action_group_action_state_changed), application);
661 g_signal_connect_swapped (application->priv->actions, "action-removed",
662 G_CALLBACK (g_action_group_action_removed), application);
666 g_application_class_init (GApplicationClass *class)
668 GObjectClass *object_class = G_OBJECT_CLASS (class);
670 object_class->constructed = g_application_constructed;
671 object_class->finalize = g_application_finalize;
672 object_class->get_property = g_application_get_property;
673 object_class->set_property = g_application_set_property;
675 class->before_emit = g_application_real_before_emit;
676 class->after_emit = g_application_real_after_emit;
677 class->startup = g_application_real_startup;
678 class->shutdown = g_application_real_shutdown;
679 class->activate = g_application_real_activate;
680 class->open = g_application_real_open;
681 class->command_line = g_application_real_command_line;
682 class->local_command_line = g_application_real_local_command_line;
683 class->add_platform_data = g_application_real_add_platform_data;
685 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
686 g_param_spec_string ("application-id",
687 P_("Application identifier"),
688 P_("The unique identifier for the application"),
689 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
690 G_PARAM_STATIC_STRINGS));
692 g_object_class_install_property (object_class, PROP_FLAGS,
693 g_param_spec_flags ("flags",
694 P_("Application flags"),
695 P_("Flags specifying the behaviour of the application"),
696 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
697 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
699 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
700 g_param_spec_boolean ("is-registered",
702 P_("If g_application_register() has been called"),
703 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
705 g_object_class_install_property (object_class, PROP_IS_REMOTE,
706 g_param_spec_boolean ("is-remote",
708 P_("If this application instance is remote"),
709 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
711 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
712 g_param_spec_uint ("inactivity-timeout",
713 P_("Inactivity timeout"),
714 P_("Time (ms) to stay alive after becoming idle"),
716 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
718 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
719 g_param_spec_object ("action-group",
721 P_("The group of actions that the application exports"),
723 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
726 * GApplication::startup:
727 * @application: the application
729 * The ::startup signal is emitted on the primary instance immediately
730 * after registration. See g_application_register().
732 g_application_signals[SIGNAL_STARTUP] =
733 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
734 G_STRUCT_OFFSET (GApplicationClass, startup),
735 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
738 * GApplication::shutdown:
739 * @application: the application
741 * The ::shutdown signal is emitted only on the registered primary instance
742 * immediately after the main loop terminates.
744 g_application_signals[SIGNAL_SHUTDOWN] =
745 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
746 G_STRUCT_OFFSET (GApplicationClass, shutdown),
747 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
750 * GApplication::activate:
751 * @application: the application
753 * The ::activate signal is emitted on the primary instance when an
754 * activation occurs. See g_application_activate().
756 g_application_signals[SIGNAL_ACTIVATE] =
757 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
758 G_STRUCT_OFFSET (GApplicationClass, activate),
759 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
763 * GApplication::open:
764 * @application: the application
765 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
766 * @n_files: the length of @files
767 * @hint: a hint provided by the calling instance
769 * The ::open signal is emitted on the primary instance when there are
770 * files to open. See g_application_open() for more information.
772 g_application_signals[SIGNAL_OPEN] =
773 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
774 G_STRUCT_OFFSET (GApplicationClass, open),
776 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
779 * GApplication::command-line:
780 * @application: the application
781 * @command_line: a #GApplicationCommandLine representing the
784 * The ::command-line signal is emitted on the primary instance when
785 * a commandline is not handled locally. See g_application_run() and
786 * the #GApplicationCommandLine documentation for more information.
788 * Returns: An integer that is set as the exit status for the calling
789 * process. See g_application_command_line_set_exit_status().
791 g_application_signals[SIGNAL_COMMAND_LINE] =
792 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
793 G_STRUCT_OFFSET (GApplicationClass, command_line),
794 g_signal_accumulator_first_wins, NULL,
796 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
798 g_type_class_add_private (class, sizeof (GApplicationPrivate));
802 get_platform_data (GApplication *application)
804 GVariantBuilder *builder;
807 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
810 gchar *cwd = g_get_current_dir ();
811 g_variant_builder_add (builder, "{sv}", "cwd",
812 g_variant_new_bytestring (cwd));
816 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
821 envp = g_get_environ ();
822 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
825 g_variant_builder_add (builder, "{sv}", "environ", array);
828 G_APPLICATION_GET_CLASS (application)->
829 add_platform_data (application, builder);
831 result = g_variant_builder_end (builder);
832 g_variant_builder_unref (builder);
837 /* Application ID validity {{{1 */
840 * g_application_id_is_valid:
841 * @application_id: a potential application identifier
843 * Checks if @application_id is a valid application identifier.
845 * A valid ID is required for calls to g_application_new() and
846 * g_application_set_application_id().
848 * For convenience, the restrictions on application identifiers are
851 * <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-." and must not begin with a digit.</listitem>
852 * <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least three elements).</listitem>
853 * <listitem>Application identifiers must not begin or end with a '.' (period) character.</listitem>
854 * <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
855 * <listitem>Application identifiers must not exceed 255 characters.</listitem>
858 * Returns: %TRUE if @application_id is valid
861 g_application_id_is_valid (const gchar *application_id)
867 len = strlen (application_id);
872 if (!g_ascii_isalpha (application_id[0]))
875 if (application_id[len-1] == '.')
881 for (; *application_id; application_id++)
883 if (g_ascii_isalnum (*application_id) ||
884 (*application_id == '-') ||
885 (*application_id == '_'))
889 else if (allow_dot && *application_id == '.')
904 /* Public Constructor {{{1 */
907 * @application_id: (allow-none): the application id
908 * @flags: the application flags
910 * Creates a new #GApplication instance.
912 * This function calls g_type_init() for you.
914 * If non-%NULL, the application id must be valid. See
915 * g_application_id_is_valid().
917 * If no application ID is given then some features of #GApplication
918 * (most notably application uniqueness) will be disabled.
920 * Returns: a new #GApplication instance
923 g_application_new (const gchar *application_id,
924 GApplicationFlags flags)
926 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
930 return g_object_new (G_TYPE_APPLICATION,
931 "application-id", application_id,
936 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
938 * g_application_get_application_id:
939 * @application: a #GApplication
941 * Gets the unique identifier for @application.
943 * Returns: the identifier for @application, owned by @application
948 g_application_get_application_id (GApplication *application)
950 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
952 return application->priv->id;
956 * g_application_set_application_id:
957 * @application: a #GApplication
958 * @application_id: (allow-none): the identifier for @application
960 * Sets the unique identifier for @application.
962 * The application id can only be modified if @application has not yet
965 * If non-%NULL, the application id must be valid. See
966 * g_application_id_is_valid().
971 g_application_set_application_id (GApplication *application,
972 const gchar *application_id)
974 g_return_if_fail (G_IS_APPLICATION (application));
976 if (g_strcmp0 (application->priv->id, application_id) != 0)
978 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
979 g_return_if_fail (!application->priv->is_registered);
981 g_free (application->priv->id);
982 application->priv->id = g_strdup (application_id);
984 g_object_notify (G_OBJECT (application), "application-id");
989 * g_application_get_flags:
990 * @application: a #GApplication
992 * Gets the flags for @application.
994 * See #GApplicationFlags.
996 * Returns: the flags for @application
1001 g_application_get_flags (GApplication *application)
1003 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1005 return application->priv->flags;
1009 * g_application_set_flags:
1010 * @application: a #GApplication
1011 * @flags: the flags for @application
1013 * Sets the flags for @application.
1015 * The flags can only be modified if @application has not yet been
1018 * See #GApplicationFlags.
1023 g_application_set_flags (GApplication *application,
1024 GApplicationFlags flags)
1026 g_return_if_fail (G_IS_APPLICATION (application));
1028 if (application->priv->flags != flags)
1030 g_return_if_fail (!application->priv->is_registered);
1032 application->priv->flags = flags;
1034 g_object_notify (G_OBJECT (application), "flags");
1039 * g_application_get_inactivity_timeout:
1040 * @application: a #GApplication
1042 * Gets the current inactivity timeout for the application.
1044 * This is the amount of time (in milliseconds) after the last call to
1045 * g_application_release() before the application stops running.
1047 * Returns: the timeout, in milliseconds
1052 g_application_get_inactivity_timeout (GApplication *application)
1054 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1056 return application->priv->inactivity_timeout;
1060 * g_application_set_inactivity_timeout:
1061 * @application: a #GApplication
1062 * @inactivity_timeout: the timeout, in milliseconds
1064 * Sets the current inactivity timeout for the application.
1066 * This is the amount of time (in milliseconds) after the last call to
1067 * g_application_release() before the application stops running.
1069 * This call has no side effects of its own. The value set here is only
1070 * used for next time g_application_release() drops the use count to
1071 * zero. Any timeouts currently in progress are not impacted.
1076 g_application_set_inactivity_timeout (GApplication *application,
1077 guint inactivity_timeout)
1079 g_return_if_fail (G_IS_APPLICATION (application));
1081 if (application->priv->inactivity_timeout != inactivity_timeout)
1083 application->priv->inactivity_timeout = inactivity_timeout;
1085 g_object_notify (G_OBJECT (application), "inactivity-timeout");
1088 /* Read-only property getters (is registered, is remote) {{{1 */
1090 * g_application_get_is_registered:
1091 * @application: a #GApplication
1093 * Checks if @application is registered.
1095 * An application is registered if g_application_register() has been
1096 * successfully called.
1098 * Returns: %TRUE if @application is registered
1103 g_application_get_is_registered (GApplication *application)
1105 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1107 return application->priv->is_registered;
1111 * g_application_get_is_remote:
1112 * @application: a #GApplication
1114 * Checks if @application is remote.
1116 * If @application is remote then it means that another instance of
1117 * application already exists (the 'primary' instance). Calls to
1118 * perform actions on @application will result in the actions being
1119 * performed by the primary instance.
1121 * The value of this property cannot be accessed before
1122 * g_application_register() has been called. See
1123 * g_application_get_is_registered().
1125 * Returns: %TRUE if @application is remote
1130 g_application_get_is_remote (GApplication *application)
1132 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1133 g_return_val_if_fail (application->priv->is_registered, FALSE);
1135 return application->priv->is_remote;
1140 * g_application_register:
1141 * @application: a #GApplication
1142 * @cancellable: (allow-none): a #GCancellable, or %NULL
1143 * @error: a pointer to a NULL #GError, or %NULL
1145 * Attempts registration of the application.
1147 * This is the point at which the application discovers if it is the
1148 * primary instance or merely acting as a remote for an already-existing
1149 * primary instance. This is implemented by attempting to acquire the
1150 * application identifier as a unique bus name on the session bus using
1153 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1154 * given, then this process will always become the primary instance.
1156 * Due to the internal architecture of GDBus, method calls can be
1157 * dispatched at any time (even if a main loop is not running). For
1158 * this reason, you must ensure that any object paths that you wish to
1159 * register are registered before calling this function.
1161 * If the application has already been registered then %TRUE is
1162 * returned with no work performed.
1164 * The #GApplication::startup signal is emitted if registration succeeds
1165 * and @application is the primary instance (including the non-unique
1168 * In the event of an error (such as @cancellable being cancelled, or a
1169 * failure to connect to the session bus), %FALSE is returned and @error
1170 * is set appropriately.
1172 * Note: the return value of this function is not an indicator that this
1173 * instance is or is not the primary instance of the application. See
1174 * g_application_get_is_remote() for that.
1176 * Returns: %TRUE if registration succeeded
1181 g_application_register (GApplication *application,
1182 GCancellable *cancellable,
1185 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1187 if (!application->priv->is_registered)
1189 if (application->priv->id == NULL)
1190 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
1192 application->priv->impl =
1193 g_application_impl_register (application, application->priv->id,
1194 application->priv->flags,
1195 application->priv->actions,
1196 &application->priv->remote_actions,
1197 cancellable, error);
1199 if (application->priv->impl == NULL)
1202 application->priv->is_remote = application->priv->remote_actions != NULL;
1203 application->priv->is_registered = TRUE;
1205 g_object_notify (G_OBJECT (application), "is-registered");
1207 if (!application->priv->is_remote)
1209 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1211 if (!application->priv->did_startup)
1212 g_critical ("GApplication subclass '%s' failed to chain up on"
1213 " ::startup (from start of override function)",
1214 G_OBJECT_TYPE_NAME (application));
1221 /* Hold/release {{{1 */
1223 * g_application_hold:
1224 * @application: a #GApplication
1226 * Increases the use count of @application.
1228 * Use this function to indicate that the application has a reason to
1229 * continue to run. For example, g_application_hold() is called by GTK+
1230 * when a toplevel window is on the screen.
1232 * To cancel the hold, call g_application_release().
1235 g_application_hold (GApplication *application)
1237 if (application->priv->inactivity_timeout_id)
1239 g_source_remove (application->priv->inactivity_timeout_id);
1240 application->priv->inactivity_timeout_id = 0;
1243 application->priv->use_count++;
1247 inactivity_timeout_expired (gpointer data)
1249 GApplication *application = G_APPLICATION (data);
1251 application->priv->inactivity_timeout_id = 0;
1253 return G_SOURCE_REMOVE;
1258 * g_application_release:
1259 * @application: a #GApplication
1261 * Decrease the use count of @application.
1263 * When the use count reaches zero, the application will stop running.
1265 * Never call this function except to cancel the effect of a previous
1266 * call to g_application_hold().
1269 g_application_release (GApplication *application)
1271 application->priv->use_count--;
1273 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
1274 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
1275 inactivity_timeout_expired, application);
1278 /* Activate, Open {{{1 */
1280 * g_application_activate:
1281 * @application: a #GApplication
1283 * Activates the application.
1285 * In essence, this results in the #GApplication::activate signal being
1286 * emitted in the primary instance.
1288 * The application must be registered before calling this function.
1293 g_application_activate (GApplication *application)
1295 g_return_if_fail (G_IS_APPLICATION (application));
1296 g_return_if_fail (application->priv->is_registered);
1298 if (application->priv->is_remote)
1299 g_application_impl_activate (application->priv->impl,
1300 get_platform_data (application));
1303 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1307 * g_application_open:
1308 * @application: a #GApplication
1309 * @files: (array length=n_files): an array of #GFiles to open
1310 * @n_files: the length of the @files array
1311 * @hint: a hint (or ""), but never %NULL
1313 * Opens the given files.
1315 * In essence, this results in the #GApplication::open signal being emitted
1316 * in the primary instance.
1318 * @n_files must be greater than zero.
1320 * @hint is simply passed through to the ::open signal. It is
1321 * intended to be used by applications that have multiple modes for
1322 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1323 * for this functionality, you should use "".
1325 * The application must be registered before calling this function
1326 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1331 g_application_open (GApplication *application,
1336 g_return_if_fail (G_IS_APPLICATION (application));
1337 g_return_if_fail (application->priv->flags &
1338 G_APPLICATION_HANDLES_OPEN);
1339 g_return_if_fail (application->priv->is_registered);
1341 if (application->priv->is_remote)
1342 g_application_impl_open (application->priv->impl,
1343 files, n_files, hint,
1344 get_platform_data (application));
1347 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1348 0, files, n_files, hint);
1353 * g_application_run:
1354 * @application: a #GApplication
1355 * @argc: the argc from main() (or 0 if @argv is %NULL)
1356 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1358 * Runs the application.
1360 * This function is intended to be run from main() and its return value
1361 * is intended to be returned by main(). Although you are expected to pass
1362 * the @argc, @argv parameters from main() to this function, it is possible
1363 * to pass %NULL if @argv is not available or commandline handling is not
1366 * First, the local_command_line() virtual function is invoked.
1367 * This function always runs on the local instance. It gets passed a pointer
1368 * to a %NULL-terminated copy of @argv and is expected to remove the arguments
1369 * that it handled (shifting up remaining arguments). See
1370 * <xref linkend="gapplication-example-cmdline2"/> for an example of
1371 * parsing @argv manually. Alternatively, you may use the #GOptionContext API,
1372 * after setting <literal>argc = g_strv_length (argv);</literal>.
1374 * The last argument to local_command_line() is a pointer to the @status
1375 * variable which can used to set the exit status that is returned from
1376 * g_application_run().
1378 * If local_command_line() returns %TRUE, the command line is expected
1379 * to be completely handled, including possibly registering as the primary
1380 * instance, calling g_application_activate() or g_application_open(), etc.
1382 * If local_command_line() returns %FALSE then the application is registered
1383 * and the #GApplication::command-line signal is emitted in the primary
1384 * instance (which may or may not be this instance). The signal handler
1385 * gets passed a #GApplicationCommandLine object that (among other things)
1386 * contains the remaining commandline arguments that have not been handled
1387 * by local_command_line().
1389 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1390 * flag set then the default implementation of local_command_line()
1391 * always returns %FALSE immediately, resulting in the commandline
1392 * always being handled in the primary instance.
1394 * Otherwise, the default implementation of local_command_line() tries
1395 * to do a couple of things that are probably reasonable for most
1396 * applications. First, g_application_register() is called to attempt
1397 * to register the application. If that works, then the command line
1398 * arguments are inspected. If no commandline arguments are given, then
1399 * g_application_activate() is called. If commandline arguments are
1400 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1401 * are assumed to be filenames and g_application_open() is called.
1403 * If you need to handle commandline arguments that are not filenames,
1404 * and you don't mind commandline handling to happen in the primary
1405 * instance, you should set %G_APPLICATION_HANDLES_COMMAND_LINE and
1406 * process the commandline arguments in your #GApplication::command-line
1407 * signal handler, either manually or using the #GOptionContext API.
1409 * If you are interested in doing more complicated local handling of the
1410 * commandline then you should implement your own #GApplication subclass
1411 * and override local_command_line(). In this case, you most likely want
1412 * to return %TRUE from your local_command_line() implementation to
1413 * suppress the default handling. See
1414 * <xref linkend="gapplication-example-cmdline2"/> for an example.
1416 * If, after the above is done, the use count of the application is zero
1417 * then the exit status is returned immediately. If the use count is
1418 * non-zero then the default main context is iterated until the use count
1419 * falls to zero, at which point 0 is returned.
1421 * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1422 * use count of zero is delayed for a while (ie: the instance stays
1423 * around to provide its <emphasis>service</emphasis> to others).
1425 * Returns: the exit status
1430 g_application_run (GApplication *application,
1438 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1439 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1440 g_return_val_if_fail (!application->priv->must_quit_now, 1);
1442 arguments = g_new (gchar *, argc + 1);
1443 for (i = 0; i < argc; i++)
1444 arguments[i] = g_strdup (argv[i]);
1445 arguments[i] = NULL;
1447 if (g_get_prgname () == NULL && argc > 0)
1451 prgname = g_path_get_basename (argv[0]);
1452 g_set_prgname (prgname);
1456 if (!G_APPLICATION_GET_CLASS (application)
1457 ->local_command_line (application, &arguments, &status))
1459 GError *error = NULL;
1461 if (!g_application_register (application, NULL, &error))
1463 g_printerr ("%s", error->message);
1464 g_error_free (error);
1468 if (application->priv->is_remote)
1470 GVariant *platform_data;
1472 platform_data = get_platform_data (application);
1473 status = g_application_impl_command_line (application->priv->impl,
1474 arguments, platform_data);
1478 GApplicationCommandLine *cmdline;
1481 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1482 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1483 "arguments", v, NULL);
1484 g_signal_emit (application,
1485 g_application_signals[SIGNAL_COMMAND_LINE],
1486 0, cmdline, &status);
1487 g_object_unref (cmdline);
1491 g_strfreev (arguments);
1493 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1494 application->priv->is_registered &&
1495 !application->priv->use_count &&
1496 !application->priv->inactivity_timeout_id)
1498 application->priv->inactivity_timeout_id =
1499 g_timeout_add (10000, inactivity_timeout_expired, application);
1502 while (application->priv->use_count || application->priv->inactivity_timeout_id)
1504 if (application->priv->must_quit_now)
1507 g_main_context_iteration (NULL, TRUE);
1511 if (!application->priv->is_remote)
1513 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
1515 if (!application->priv->did_shutdown)
1516 g_critical ("GApplication subclass '%s' failed to chain up on"
1517 " ::shutdown (from end of override function)",
1518 G_OBJECT_TYPE_NAME (application));
1521 if (application->priv->impl)
1522 g_application_impl_flush (application->priv->impl);
1530 g_application_list_actions (GActionGroup *action_group)
1532 GApplication *application = G_APPLICATION (action_group);
1534 g_return_val_if_fail (application->priv->is_registered, NULL);
1536 if (application->priv->remote_actions != NULL)
1537 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
1539 else if (application->priv->actions != NULL)
1540 return g_action_group_list_actions (application->priv->actions);
1543 /* empty string array */
1544 return g_new0 (gchar *, 1);
1548 g_application_query_action (GActionGroup *group,
1549 const gchar *action_name,
1551 const GVariantType **parameter_type,
1552 const GVariantType **state_type,
1553 GVariant **state_hint,
1556 GApplication *application = G_APPLICATION (group);
1558 g_return_val_if_fail (application->priv->is_registered, FALSE);
1560 if (application->priv->remote_actions != NULL)
1561 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
1569 if (application->priv->actions != NULL)
1570 return g_action_group_query_action (application->priv->actions,
1582 g_application_change_action_state (GActionGroup *action_group,
1583 const gchar *action_name,
1586 GApplication *application = G_APPLICATION (action_group);
1588 g_return_if_fail (application->priv->is_remote ||
1589 application->priv->actions != NULL);
1590 g_return_if_fail (application->priv->is_registered);
1592 if (application->priv->remote_actions)
1593 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
1594 action_name, value, get_platform_data (application));
1597 g_action_group_change_action_state (application->priv->actions, action_name, value);
1601 g_application_activate_action (GActionGroup *action_group,
1602 const gchar *action_name,
1603 GVariant *parameter)
1605 GApplication *application = G_APPLICATION (action_group);
1607 g_return_if_fail (application->priv->is_remote ||
1608 application->priv->actions != NULL);
1609 g_return_if_fail (application->priv->is_registered);
1611 if (application->priv->remote_actions)
1612 g_remote_action_group_activate_action_full (application->priv->remote_actions,
1613 action_name, parameter, get_platform_data (application));
1616 g_action_group_activate_action (application->priv->actions, action_name, parameter);
1620 g_application_lookup_action (GActionMap *action_map,
1621 const gchar *action_name)
1623 GApplication *application = G_APPLICATION (action_map);
1625 g_return_val_if_fail (G_IS_SIMPLE_ACTION_GROUP (application->priv->actions), NULL);
1627 return g_simple_action_group_lookup (G_SIMPLE_ACTION_GROUP (application->priv->actions), action_name);
1631 g_application_add_action (GActionMap *action_map,
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_insert (G_SIMPLE_ACTION_GROUP (application->priv->actions), action);
1642 g_application_remove_action (GActionMap *action_map,
1643 const gchar *action_name)
1645 GApplication *application = G_APPLICATION (action_map);
1647 g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP (application->priv->actions));
1649 g_simple_action_group_remove (G_SIMPLE_ACTION_GROUP (application->priv->actions), action_name);
1653 g_application_action_group_iface_init (GActionGroupInterface *iface)
1655 iface->list_actions = g_application_list_actions;
1656 iface->query_action = g_application_query_action;
1657 iface->change_action_state = g_application_change_action_state;
1658 iface->activate_action = g_application_activate_action;
1662 g_application_action_map_iface_init (GActionMapInterface *iface)
1664 iface->lookup_action = g_application_lookup_action;
1665 iface->add_action = g_application_add_action;
1666 iface->remove_action = g_application_remove_action;
1669 /* Default Application {{{1 */
1671 static GApplication *default_app;
1674 * g_application_get_default:
1676 * Returns the default #GApplication instance for this process.
1678 * Normally there is only one #GApplication per process and it becomes
1679 * the default when it is created. You can exercise more control over
1680 * this by using g_application_set_default().
1682 * If there is no default application then %NULL is returned.
1684 * Returns: (transfer none): the default application for this process, or %NULL
1689 g_application_get_default (void)
1695 * g_application_set_default:
1696 * @application: (allow-none): the application to set as default, or %NULL
1698 * Sets or unsets the default application for the process, as returned
1699 * by g_application_get_default().
1701 * This function does not take its own reference on @application. If
1702 * @application is destroyed then the default application will revert
1708 g_application_set_default (GApplication *application)
1710 default_app = application;
1714 * g_application_quit:
1715 * @application: a #GApplication
1717 * Immediately quits the application.
1719 * Upon return to the mainloop, g_application_run() will return,
1720 * calling only the 'shutdown' function before doing so.
1722 * The hold count is ignored.
1724 * The result of calling g_application_run() again after it returns is
1730 g_application_quit (GApplication *application)
1732 g_return_if_fail (G_IS_APPLICATION (application));
1734 application->priv->must_quit_now = TRUE;
1738 /* vim:set foldmethod=marker: */