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, see <http://www.gnu.org/licenses/>.
17 * Authors: Ryan Lortie <desrt@desrt.ca>
23 #include "gapplication.h"
25 #include "gapplicationcommandline.h"
26 #include "gsimpleactiongroup.h"
27 #include "gremoteactiongroup.h"
28 #include "gapplicationimpl.h"
29 #include "gactiongroup.h"
30 #include "gactionmap.h"
31 #include "gmenumodel.h"
32 #include "gsettings.h"
33 #include "gnotification-private.h"
34 #include "gnotificationbackend.h"
35 #include "gdbusutils.h"
37 #include "gioenumtypes.h"
46 * SECTION:gapplication
47 * @title: GApplication
48 * @short_description: Core application class
51 * A #GApplication is the foundation of an application. It wraps some
52 * low-level platform-specific services and is intended to act as the
53 * foundation for higher-level application classes such as
54 * #GtkApplication or #MxApplication. In general, you should not use
55 * this class outside of a higher level framework.
57 * GApplication provides convenient life cycle management by maintaining
58 * a "use count" for the primary application instance. The use count can
59 * be changed using g_application_hold() and g_application_release(). If
60 * it drops to zero, the application exits. Higher-level classes such as
61 * #GtkApplication employ the use count to ensure that the application
62 * stays alive as long as it has any opened windows.
64 * Another feature that GApplication (optionally) provides is process
65 * uniqueness. Applications can make use of this functionality by
66 * providing a unique application ID. If given, only one application
67 * with this ID can be running at a time per session. The session
68 * concept is platform-dependent, but corresponds roughly to a graphical
69 * desktop login. When your application is launched again, its
70 * arguments are passed through platform communication to the already
71 * running program. The already running instance of the program is
72 * called the "primary instance"; for non-unique applications this is
73 * the always the current instance. On Linux, the D-Bus session bus
74 * is used for communication.
76 * The use of #GApplication differs from some other commonly-used
77 * uniqueness libraries (such as libunique) in important ways. The
78 * application is not expected to manually register itself and check
79 * if it is the primary instance. Instead, the main() function of a
80 * #GApplication should do very little more than instantiating the
81 * application instance, possibly connecting signal handlers, then
82 * calling g_application_run(). All checks for uniqueness are done
83 * internally. If the application is the primary instance then the
84 * startup signal is emitted and the mainloop runs. If the application
85 * is not the primary instance then a signal is sent to the primary
86 * instance and g_application_run() promptly returns. See the code
89 * If used, the expected form of an application identifier is very close
91 * [DBus bus name](http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface).
92 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
93 * For details on valid application identifiers, see g_application_id_is_valid().
95 * On Linux, the application identifier is claimed as a well-known bus name
96 * on the user's session bus. This means that the uniqueness of your
97 * application is scoped to the current session. It also means that your
98 * application may provide additional services (through registration of other
99 * object paths) at that bus name. The registration of these object paths
100 * should be done with the shared GDBus session bus. Note that due to the
101 * internal architecture of GDBus, method calls can be dispatched at any time
102 * (even if a main loop is not running). For this reason, you must ensure that
103 * any object paths that you wish to register are registered before #GApplication
104 * attempts to acquire the bus name of your application (which happens in
105 * g_application_register()). Unfortunately, this means that you cannot use
106 * g_application_get_is_remote() to decide if you want to register object paths.
108 * GApplication also implements the #GActionGroup and #GActionMap
109 * interfaces and lets you easily export actions by adding them with
110 * g_action_map_add_action(). When invoking an action by calling
111 * g_action_group_activate_action() on the application, it is always
112 * invoked in the primary instance. The actions are also exported on
113 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
114 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
115 * for remote access to exported #GMenuModels.
117 * There is a number of different entry points into a GApplication:
119 * - via 'Activate' (i.e. just starting the application)
121 * - via 'Open' (i.e. opening some files)
123 * - by handling a command-line
125 * - via activating an action
127 * The #GApplication::startup signal lets you handle the application
128 * initialization for all of these in a single place.
130 * Regardless of which of these entry points is used to start the
131 * application, GApplication passes some "platform data from the
132 * launching instance to the primary instance, in the form of a
133 * #GVariant dictionary mapping strings to variants. To use platform
134 * data, override the @before_emit or @after_emit virtual functions
135 * in your #GApplication subclass. When dealing with
136 * #GApplicationCommandLine objects, the platform data is
137 * directly available via g_application_command_line_get_cwd(),
138 * g_application_command_line_get_environ() and
139 * g_application_command_line_get_platform_data().
141 * As the name indicates, the platform data may vary depending on the
142 * operating system, but it always includes the current directory (key
143 * "cwd"), and optionally the environment (ie the set of environment
144 * variables and their values) of the calling process (key "environ").
145 * The environment is only added to the platform data if the
146 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
147 * can add their own platform data by overriding the @add_platform_data
148 * virtual function. For instance, #GtkApplication adds startup notification
151 * To parse commandline arguments you may handle the
152 * #GApplication::command-line signal or override the local_command_line()
153 * vfunc, to parse them in either the primary instance or the local instance,
156 * For an example of opening files with a GApplication, see
157 * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c).
159 * For an example of using actions with GApplication, see
160 * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c).
162 * For an example of using extra D-Bus hooks with GApplication, see
163 * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
169 * #GApplication is an opaque data structure and can only be accessed
170 * using the following functions.
176 * @startup: invoked on the primary instance immediately after registration
177 * @shutdown: invoked only on the registered primary instance immediately
178 * after the main loop terminates
179 * @activate: invoked on the primary instance when an activation occurs
180 * @open: invoked on the primary instance when there are files to open
181 * @command_line: invoked on the primary instance when a command-line is
182 * not handled locally
183 * @local_command_line: invoked (locally) when the process has been invoked
184 * via commandline execution (as opposed to, say, D-Bus activation - which
185 * is not currently supported by GApplication). The virtual function has
186 * the chance to inspect (and possibly replace) the list of command line
187 * arguments. See g_application_run() for more information.
188 * @before_emit: invoked on the primary instance before 'activate', 'open',
189 * 'command-line' or any action invocation, gets the 'platform data' from
190 * the calling instance
191 * @after_emit: invoked on the primary instance after 'activate', 'open',
192 * 'command-line' or any action invocation, gets the 'platform data' from
193 * the calling instance
194 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
195 * the primary instance when activating, opening or invoking actions
196 * @quit_mainloop: Used to be invoked on the primary instance when the use
197 * count of the application drops to zero (and after any inactivity
198 * timeout, if requested). Not used anymore since 2.32
199 * @run_mainloop: Used to be invoked on the primary instance from
200 * g_application_run() if the use-count is non-zero. Since 2.32,
201 * GApplication is iterating the main context directly and is not
202 * using @run_mainloop anymore
203 * @dbus_register: invoked locally during registration, if the application is
204 * using its D-Bus backend. You can use this to export extra objects on the
205 * bus, that need to exist before the application tries to own the bus name.
206 * The function is passed the #GDBusConnection to to session bus, and the
207 * object path that #GApplication will use to export is D-Bus API.
208 * If this function returns %TRUE, registration will proceed; otherwise
209 * registration will abort. Since: 2.34
210 * @dbus_unregister: invoked locally during unregistration, if the application
211 * is using its D-Bus backend. Use this to undo anything done by the
212 * @dbus_register vfunc. Since: 2.34
213 * @handle_local_options: invoked locally after the parsing of the commandline
214 * options has occurred.
216 * Virtual function table for #GApplication.
221 struct _GApplicationPrivate
223 GApplicationFlags flags;
225 gchar *resource_path;
227 GActionGroup *actions;
228 GMenuModel *app_menu;
231 guint inactivity_timeout_id;
232 guint inactivity_timeout;
236 guint is_registered : 1;
238 guint did_startup : 1;
239 guint did_shutdown : 1;
240 guint must_quit_now : 1;
242 GRemoteActionGroup *remote_actions;
243 GApplicationImpl *impl;
245 GNotificationBackend *notifications;
247 /* GOptionContext support */
248 GOptionGroup *main_options;
249 GSList *option_groups;
250 GHashTable *packed_options;
251 gboolean options_parsed;
253 /* Allocated option strings, from g_application_add_main_option() */
254 GSList *option_strings;
262 PROP_RESOURCE_BASE_PATH,
265 PROP_INACTIVITY_TIMEOUT,
278 SIGNAL_HANDLE_LOCAL_OPTIONS,
282 static guint g_application_signals[NR_SIGNALS];
284 static void g_application_action_group_iface_init (GActionGroupInterface *);
285 static void g_application_action_map_iface_init (GActionMapInterface *);
286 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
287 G_ADD_PRIVATE (GApplication)
288 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
289 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
291 /* GApplicationExportedActions {{{1 */
293 /* We create a subclass of GSimpleActionGroup that implements
294 * GRemoteActionGroup and deals with the platform data using
295 * GApplication's before/after_emit vfuncs. This is the action group we
298 * We could implement GRemoteActionGroup on GApplication directly, but
299 * this would be potentially extremely confusing to have exposed as part
300 * of the public API of GApplication. We certainly don't want anyone in
301 * the same process to be calling these APIs...
303 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
306 GSimpleActionGroup parent_instance;
307 GApplication *application;
308 } GApplicationExportedActions;
310 static GType g_application_exported_actions_get_type (void);
311 static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
312 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
313 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
316 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
317 const gchar *action_name,
319 GVariant *platform_data)
321 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
323 G_APPLICATION_GET_CLASS (exported->application)
324 ->before_emit (exported->application, platform_data);
326 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
328 G_APPLICATION_GET_CLASS (exported->application)
329 ->after_emit (exported->application, platform_data);
333 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
334 const gchar *action_name,
336 GVariant *platform_data)
338 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
340 G_APPLICATION_GET_CLASS (exported->application)
341 ->before_emit (exported->application, platform_data);
343 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
345 G_APPLICATION_GET_CLASS (exported->application)
346 ->after_emit (exported->application, platform_data);
350 g_application_exported_actions_init (GApplicationExportedActions *actions)
355 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
357 iface->activate_action_full = g_application_exported_actions_activate_action_full;
358 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
362 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
366 static GActionGroup *
367 g_application_exported_actions_new (GApplication *application)
369 GApplicationExportedActions *actions;
371 actions = g_object_new (g_application_exported_actions_get_type (), NULL);
372 actions->application = application;
374 return G_ACTION_GROUP (actions);
377 /* Command line option handling {{{1 */
380 free_option_entry (gpointer data)
382 GOptionEntry *entry = data;
386 case G_OPTION_ARG_STRING:
387 case G_OPTION_ARG_FILENAME:
388 g_free (*(gchar **) entry->arg_data);
391 case G_OPTION_ARG_STRING_ARRAY:
392 case G_OPTION_ARG_FILENAME_ARRAY:
393 g_strfreev (*(gchar ***) entry->arg_data);
397 /* most things require no free... */
401 /* ...except for the space that we allocated for it ourselves */
402 g_free (entry->arg_data);
404 g_slice_free (GOptionEntry, entry);
408 g_application_pack_option_entries (GApplication *application,
414 g_hash_table_iter_init (&iter, application->priv->packed_options);
415 while (g_hash_table_iter_next (&iter, NULL, &item))
417 GOptionEntry *entry = item;
418 GVariant *value = NULL;
422 case G_OPTION_ARG_NONE:
423 if (*(gboolean *) entry->arg_data != 2)
424 value = g_variant_new_boolean (*(gboolean *) entry->arg_data);
427 case G_OPTION_ARG_STRING:
428 if (*(gchar **) entry->arg_data)
429 value = g_variant_new_string (*(gchar **) entry->arg_data);
432 case G_OPTION_ARG_INT:
433 if (*(gint32 *) entry->arg_data)
434 value = g_variant_new_int32 (*(gint32 *) entry->arg_data);
437 case G_OPTION_ARG_FILENAME:
438 if (*(gchar **) entry->arg_data)
439 value = g_variant_new_bytestring (*(gchar **) entry->arg_data);
442 case G_OPTION_ARG_STRING_ARRAY:
443 if (*(gchar ***) entry->arg_data)
444 value = g_variant_new_strv (*(const gchar ***) entry->arg_data, -1);
447 case G_OPTION_ARG_FILENAME_ARRAY:
448 if (*(gchar ***) entry->arg_data)
449 value = g_variant_new_bytestring_array (*(const gchar ***) entry->arg_data, -1);
452 case G_OPTION_ARG_DOUBLE:
453 if (*(gdouble *) entry->arg_data)
454 value = g_variant_new_double (*(gdouble *) entry->arg_data);
457 case G_OPTION_ARG_INT64:
458 if (*(gint64 *) entry->arg_data)
459 value = g_variant_new_int64 (*(gint64 *) entry->arg_data);
463 g_assert_not_reached ();
467 g_variant_dict_insert_value (dict, entry->long_name, value);
471 static GVariantDict *
472 g_application_parse_command_line (GApplication *application,
476 gboolean become_service = FALSE;
477 GVariantDict *dict = NULL;
478 GOptionContext *context;
480 /* Due to the memory management of GOptionGroup we can only parse
481 * options once. That's because once you add a group to the
482 * GOptionContext there is no way to get it back again. This is fine:
483 * local_command_line() should never get invoked more than once
484 * anyway. Add a sanity check just to be sure.
486 g_return_val_if_fail (!application->priv->options_parsed, NULL);
488 context = g_option_context_new (NULL);
490 /* If the application has not registered local options and it has
491 * G_APPLICATION_HANDLES_COMMAND_LINE then we have to assume that
492 * their primary instance commandline handler may want to deal with
493 * the arguments. We must therefore ignore them.
495 * We must also ignore --help in this case since some applications
496 * will try to handle this from the remote side. See #737869.
498 if (application->priv->main_options == NULL && (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE))
500 g_option_context_set_ignore_unknown_options (context, TRUE);
501 g_option_context_set_help_enabled (context, FALSE);
504 /* Add the main option group, if it exists */
505 if (application->priv->main_options)
507 /* This consumes the main_options */
508 g_option_context_set_main_group (context, application->priv->main_options);
509 application->priv->main_options = NULL;
512 /* Add any other option groups if they exist. Adding them to the
513 * context will consume them, so we free the list as we go...
515 while (application->priv->option_groups)
517 g_option_context_add_group (context, application->priv->option_groups->data);
518 application->priv->option_groups = g_slist_delete_link (application->priv->option_groups,
519 application->priv->option_groups);
522 /* In the case that we are not explicitly marked as a service or a
523 * launcher then we want to add the "--gapplication-service" option to
524 * allow the process to be made into a service.
526 if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
528 GOptionGroup *option_group;
529 GOptionEntry entries[] = {
530 { "gapplication-service", '\0', 0, G_OPTION_ARG_NONE, &become_service,
531 N_("Enter GApplication service mode (use from D-Bus service files)") },
535 option_group = g_option_group_new ("gapplication",
536 _("GApplication options"), _("Show GApplication options"),
538 g_option_group_set_translation_domain (option_group, GETTEXT_PACKAGE);
539 g_option_group_add_entries (option_group, entries);
541 g_option_context_add_group (context, option_group);
544 /* Now we parse... */
545 if (!g_option_context_parse_strv (context, arguments, error))
548 /* Check for --gapplication-service */
550 application->priv->flags |= G_APPLICATION_IS_SERVICE;
552 dict = g_variant_dict_new (NULL);
553 if (application->priv->packed_options)
555 g_application_pack_option_entries (application, dict);
556 g_hash_table_unref (application->priv->packed_options);
557 application->priv->packed_options = NULL;
561 /* Make sure we don't run again */
562 application->priv->options_parsed = TRUE;
564 g_option_context_free (context);
570 add_packed_option (GApplication *application,
575 case G_OPTION_ARG_NONE:
576 entry->arg_data = g_new (gboolean, 1);
577 *(gboolean *) entry->arg_data = 2;
580 case G_OPTION_ARG_INT:
581 entry->arg_data = g_new0 (gint, 1);
584 case G_OPTION_ARG_STRING:
585 case G_OPTION_ARG_FILENAME:
586 case G_OPTION_ARG_STRING_ARRAY:
587 case G_OPTION_ARG_FILENAME_ARRAY:
588 entry->arg_data = g_new0 (gpointer, 1);
591 case G_OPTION_ARG_INT64:
592 entry->arg_data = g_new0 (gint64, 1);
595 case G_OPTION_ARG_DOUBLE:
596 entry->arg_data = g_new0 (gdouble, 1);
600 g_return_if_reached ();
603 if (!application->priv->packed_options)
604 application->priv->packed_options = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, free_option_entry);
606 g_hash_table_insert (application->priv->packed_options,
607 g_strdup (entry->long_name),
608 g_slice_dup (GOptionEntry, entry));
612 * g_application_add_main_option_entries:
613 * @application: a #GApplication
614 * @entries: (array zero-terminated=1) (element-type GOptionEntry) a
615 * %NULL-terminated list of #GOptionEntrys
617 * Adds main option entries to be handled by @application.
619 * This function is comparable to g_option_context_add_main_entries().
621 * After the commandline arguments are parsed, the
622 * #GApplication::handle-local-options signal will be emitted. At this
623 * point, the application can inspect the values pointed to by @arg_data
624 * in the given #GOptionEntrys.
626 * Unlike #GOptionContext, #GApplication supports giving a %NULL
627 * @arg_data for a non-callback #GOptionEntry. This results in the
628 * argument in question being packed into a #GVariantDict which is also
629 * passed to #GApplication::handle-local-options, where it can be
630 * inspected and modified. If %G_APPLICATION_HANDLES_COMMAND_LINE is
631 * set, then the resulting dictionary is sent to the primary instance,
632 * where g_application_command_line_get_options_dict() will return it.
633 * This "packing" is done according to the type of the argument --
634 * booleans for normal flags, strings for strings, bytestrings for
635 * filenames, etc. The packing only occurs if the flag is given (ie: we
636 * do not pack a "false" #GVariant in the case that a flag is missing).
638 * In general, it is recommended that all commandline arguments are
639 * parsed locally. The options dictionary should then be used to
640 * transmit the result of the parsing to the primary instance, where
641 * g_variant_dict_lookup() can be used. For local options, it is
642 * possible to either use @arg_data in the usual way, or to consult (and
643 * potentially remove) the option from the options dictionary.
645 * This function is new in GLib 2.40. Before then, the only real choice
646 * was to send all of the commandline arguments (options and all) to the
647 * primary instance for handling. #GApplication ignored them completely
648 * on the local side. Calling this function "opts in" to the new
649 * behaviour, and in particular, means that unrecognised options will be
650 * treated as errors. Unrecognised options have never been ignored when
651 * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
653 * If #GApplication::handle-local-options needs to see the list of
654 * filenames, then the use of %G_OPTION_REMAINING is recommended. If
655 * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
656 * the options dictionary. If you do use %G_OPTION_REMAINING then you
657 * need to handle these arguments for yourself because once they are
658 * consumed, they will no longer be visible to the default handling
659 * (which treats them as filenames to be opened).
664 g_application_add_main_option_entries (GApplication *application,
665 const GOptionEntry *entries)
669 g_return_if_fail (G_IS_APPLICATION (application));
670 g_return_if_fail (entries != NULL);
672 if (!application->priv->main_options)
674 application->priv->main_options = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
675 g_option_group_set_translation_domain (application->priv->main_options, NULL);
678 for (i = 0; entries[i].long_name; i++)
680 GOptionEntry my_entries[2] = { { NULL }, { NULL } };
681 my_entries[0] = entries[i];
683 if (!my_entries[0].arg_data)
684 add_packed_option (application, &my_entries[0]);
686 g_option_group_add_entries (application->priv->main_options, my_entries);
691 * g_application_add_main_option:
692 * @application: the #GApplication
693 * @long_name: the long name of an option used to specify it in a commandline
694 * @short_name: the short name of an option
695 * @flags: flags from #GOptionFlags
696 * @arg: the type of the option, as a #GOptionArg
697 * @description: the description for the option in `--help` output
698 * @arg_description: (nullable): the placeholder to use for the extra argument
699 * parsed by the option in `--help` output
701 * Add an option to be handled by @application.
703 * Calling this function is the equivalent of calling
704 * g_application_add_main_option_entries() with a single #GOptionEntry
705 * that has its arg_data member set to %NULL.
707 * The parsed arguments will be packed into a #GVariantDict which
708 * is passed to #GApplication::handle-local-options. If
709 * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also
710 * be sent to the primary instance. See
711 * g_application_add_main_option_entries() for more details.
713 * See #GOptionEntry for more documentation of the arguments.
718 g_application_add_main_option (GApplication *application,
719 const char *long_name,
723 const char *description,
724 const char *arg_description)
727 GOptionEntry my_entry[2] = {
728 { NULL, short_name, flags, arg, NULL, NULL, NULL },
732 g_return_if_fail (G_IS_APPLICATION (application));
733 g_return_if_fail (long_name != NULL);
734 g_return_if_fail (description != NULL);
736 my_entry[0].long_name = dup_string = g_strdup (long_name);
737 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
739 my_entry[0].description = dup_string = g_strdup (description);
740 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
742 my_entry[0].arg_description = dup_string = g_strdup (arg_description);
743 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
745 g_application_add_main_option_entries (application, my_entry);
749 * g_application_add_option_group:
750 * @application: the #GApplication
751 * @group: a #GOptionGroup
753 * Adds a #GOptionGroup to the commandline handling of @application.
755 * This function is comparable to g_option_context_add_group().
757 * Unlike g_application_add_main_option_entries(), this function does
758 * not deal with %NULL @arg_data and never transmits options to the
761 * The reason for that is because, by the time the options arrive at the
762 * primary instance, it is typically too late to do anything with them.
763 * Taking the GTK option group as an example: GTK will already have been
764 * initialised by the time the #GApplication::command-line handler runs.
765 * In the case that this is not the first-running instance of the
766 * application, the existing instance may already have been running for
769 * This means that the options from #GOptionGroup are only really usable
770 * in the case that the instance of the application being run is the
771 * first instance. Passing options like `--display=` or `--gdk-debug=`
772 * on future runs will have no effect on the existing primary instance.
774 * Calling this function will cause the options in the supplied option
775 * group to be parsed, but it does not cause you to be "opted in" to the
776 * new functionality whereby unrecognised options are rejected even if
777 * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
782 g_application_add_option_group (GApplication *application,
785 g_return_if_fail (G_IS_APPLICATION (application));
786 g_return_if_fail (group != NULL);
788 application->priv->option_groups = g_slist_prepend (application->priv->option_groups, group);
791 /* vfunc defaults {{{1 */
793 g_application_real_before_emit (GApplication *application,
794 GVariant *platform_data)
799 g_application_real_after_emit (GApplication *application,
800 GVariant *platform_data)
805 g_application_real_startup (GApplication *application)
807 application->priv->did_startup = TRUE;
811 g_application_real_shutdown (GApplication *application)
813 application->priv->did_shutdown = TRUE;
817 g_application_real_activate (GApplication *application)
819 if (!g_signal_has_handler_pending (application,
820 g_application_signals[SIGNAL_ACTIVATE],
822 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
824 static gboolean warned;
829 g_warning ("Your application does not implement "
830 "g_application_activate() and has no handlers connected "
831 "to the 'activate' signal. It should do one of these.");
837 g_application_real_open (GApplication *application,
842 if (!g_signal_has_handler_pending (application,
843 g_application_signals[SIGNAL_OPEN],
845 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
847 static gboolean warned;
852 g_warning ("Your application claims to support opening files "
853 "but does not implement g_application_open() and has no "
854 "handlers connected to the 'open' signal.");
860 g_application_real_command_line (GApplication *application,
861 GApplicationCommandLine *cmdline)
863 if (!g_signal_has_handler_pending (application,
864 g_application_signals[SIGNAL_COMMAND_LINE],
866 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
868 static gboolean warned;
873 g_warning ("Your application claims to support custom command line "
874 "handling but does not implement g_application_command_line() "
875 "and has no handlers connected to the 'command-line' signal.");
884 g_application_real_handle_local_options (GApplication *application,
885 GVariantDict *options)
891 get_platform_data (GApplication *application,
894 GVariantBuilder *builder;
897 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
900 gchar *cwd = g_get_current_dir ();
901 g_variant_builder_add (builder, "{sv}", "cwd",
902 g_variant_new_bytestring (cwd));
906 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
911 envp = g_get_environ ();
912 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
915 g_variant_builder_add (builder, "{sv}", "environ", array);
919 g_variant_builder_add (builder, "{sv}", "options", options);
921 G_APPLICATION_GET_CLASS (application)->
922 add_platform_data (application, builder);
924 result = g_variant_builder_end (builder);
925 g_variant_builder_unref (builder);
931 g_application_call_command_line (GApplication *application,
932 const gchar * const *arguments,
936 if (application->priv->is_remote)
938 GVariant *platform_data;
940 platform_data = get_platform_data (application, options);
941 *exit_status = g_application_impl_command_line (application->priv->impl, arguments, platform_data);
945 GApplicationCommandLine *cmdline;
948 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
949 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
953 g_signal_emit (application, g_application_signals[SIGNAL_COMMAND_LINE], 0, cmdline, exit_status);
954 g_object_unref (cmdline);
959 g_application_real_local_command_line (GApplication *application,
963 GError *error = NULL;
964 GVariantDict *options;
967 options = g_application_parse_command_line (application, arguments, &error);
970 g_printerr ("%s\n", error->message);
975 g_signal_emit (application, g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS], 0, options, exit_status);
977 if (*exit_status >= 0)
979 g_variant_dict_unref (options);
983 if (!g_application_register (application, NULL, &error))
985 g_printerr ("Failed to register: %s\n", error->message);
986 g_variant_dict_unref (options);
987 g_error_free (error);
992 n_args = g_strv_length (*arguments);
994 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
996 if ((*exit_status = n_args > 1))
998 g_printerr ("GApplication service mode takes no arguments.\n");
999 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
1005 else if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
1007 g_application_call_command_line (application,
1008 (const gchar **) *arguments,
1009 g_variant_dict_end (options),
1016 g_application_activate (application);
1022 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
1024 g_critical ("This application can not open files.");
1033 n_files = n_args - 1;
1034 files = g_new (GFile *, n_files);
1036 for (i = 0; i < n_files; i++)
1037 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
1039 g_application_open (application, files, n_files, "");
1041 for (i = 0; i < n_files; i++)
1042 g_object_unref (files[i]);
1050 g_variant_dict_unref (options);
1056 g_application_real_add_platform_data (GApplication *application,
1057 GVariantBuilder *builder)
1062 g_application_real_dbus_register (GApplication *application,
1063 GDBusConnection *connection,
1064 const gchar *object_path,
1071 g_application_real_dbus_unregister (GApplication *application,
1072 GDBusConnection *connection,
1073 const gchar *object_path)
1077 /* GObject implementation stuff {{{1 */
1079 g_application_set_property (GObject *object,
1081 const GValue *value,
1084 GApplication *application = G_APPLICATION (object);
1088 case PROP_APPLICATION_ID:
1089 g_application_set_application_id (application,
1090 g_value_get_string (value));
1094 g_application_set_flags (application, g_value_get_flags (value));
1097 case PROP_RESOURCE_BASE_PATH:
1098 g_application_set_resource_base_path (application, g_value_get_string (value));
1101 case PROP_INACTIVITY_TIMEOUT:
1102 g_application_set_inactivity_timeout (application,
1103 g_value_get_uint (value));
1106 case PROP_ACTION_GROUP:
1107 g_clear_object (&application->priv->actions);
1108 application->priv->actions = g_value_dup_object (value);
1112 g_assert_not_reached ();
1117 * g_application_set_action_group:
1118 * @application: a #GApplication
1119 * @action_group: (allow-none): a #GActionGroup, or %NULL
1121 * This used to be how actions were associated with a #GApplication.
1122 * Now there is #GActionMap for that.
1126 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
1127 * mix use of this API with use of #GActionMap on the same @application
1128 * or things will go very badly wrong. This function is known to
1129 * introduce buggy behaviour (ie: signals not emitted on changes to the
1130 * action group), so you should really use #GActionMap instead.
1133 g_application_set_action_group (GApplication *application,
1134 GActionGroup *action_group)
1136 g_return_if_fail (G_IS_APPLICATION (application));
1137 g_return_if_fail (!application->priv->is_registered);
1139 if (application->priv->actions != NULL)
1140 g_object_unref (application->priv->actions);
1142 application->priv->actions = action_group;
1144 if (application->priv->actions != NULL)
1145 g_object_ref (application->priv->actions);
1149 g_application_get_property (GObject *object,
1154 GApplication *application = G_APPLICATION (object);
1158 case PROP_APPLICATION_ID:
1159 g_value_set_string (value,
1160 g_application_get_application_id (application));
1164 g_value_set_flags (value,
1165 g_application_get_flags (application));
1168 case PROP_RESOURCE_BASE_PATH:
1169 g_value_set_string (value, g_application_get_resource_base_path (application));
1172 case PROP_IS_REGISTERED:
1173 g_value_set_boolean (value,
1174 g_application_get_is_registered (application));
1177 case PROP_IS_REMOTE:
1178 g_value_set_boolean (value,
1179 g_application_get_is_remote (application));
1182 case PROP_INACTIVITY_TIMEOUT:
1183 g_value_set_uint (value,
1184 g_application_get_inactivity_timeout (application));
1188 g_value_set_boolean (value, g_application_get_is_busy (application));
1192 g_assert_not_reached ();
1197 g_application_constructed (GObject *object)
1199 GApplication *application = G_APPLICATION (object);
1201 if (g_application_get_default () == NULL)
1202 g_application_set_default (application);
1204 /* People should not set properties from _init... */
1205 g_assert (application->priv->resource_path == NULL);
1207 if (application->priv->id != NULL)
1211 application->priv->resource_path = g_strconcat ("/", application->priv->id, NULL);
1213 for (i = 1; application->priv->resource_path[i]; i++)
1214 if (application->priv->resource_path[i] == '.')
1215 application->priv->resource_path[i] = '/';
1220 g_application_finalize (GObject *object)
1222 GApplication *application = G_APPLICATION (object);
1224 g_slist_free_full (application->priv->option_groups, (GDestroyNotify) g_option_group_unref);
1225 if (application->priv->main_options)
1226 g_option_group_unref (application->priv->main_options);
1227 if (application->priv->packed_options)
1229 g_slist_free_full (application->priv->option_strings, g_free);
1230 g_hash_table_unref (application->priv->packed_options);
1232 if (application->priv->impl)
1233 g_application_impl_destroy (application->priv->impl);
1234 g_free (application->priv->id);
1236 if (g_application_get_default () == application)
1237 g_application_set_default (NULL);
1239 if (application->priv->actions)
1240 g_object_unref (application->priv->actions);
1242 if (application->priv->notifications)
1243 g_object_unref (application->priv->notifications);
1245 g_free (application->priv->resource_path);
1247 G_OBJECT_CLASS (g_application_parent_class)
1248 ->finalize (object);
1252 g_application_init (GApplication *application)
1254 application->priv = g_application_get_instance_private (application);
1256 application->priv->actions = g_application_exported_actions_new (application);
1258 /* application->priv->actions is the one and only ref on the group, so when
1259 * we dispose, the action group will die, disconnecting all signals.
1261 g_signal_connect_swapped (application->priv->actions, "action-added",
1262 G_CALLBACK (g_action_group_action_added), application);
1263 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
1264 G_CALLBACK (g_action_group_action_enabled_changed), application);
1265 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
1266 G_CALLBACK (g_action_group_action_state_changed), application);
1267 g_signal_connect_swapped (application->priv->actions, "action-removed",
1268 G_CALLBACK (g_action_group_action_removed), application);
1272 g_application_handle_local_options_accumulator (GSignalInvocationHint *ihint,
1273 GValue *return_accu,
1274 const GValue *handler_return,
1279 value = g_value_get_int (handler_return);
1280 g_value_set_int (return_accu, value);
1286 g_application_class_init (GApplicationClass *class)
1288 GObjectClass *object_class = G_OBJECT_CLASS (class);
1290 object_class->constructed = g_application_constructed;
1291 object_class->finalize = g_application_finalize;
1292 object_class->get_property = g_application_get_property;
1293 object_class->set_property = g_application_set_property;
1295 class->before_emit = g_application_real_before_emit;
1296 class->after_emit = g_application_real_after_emit;
1297 class->startup = g_application_real_startup;
1298 class->shutdown = g_application_real_shutdown;
1299 class->activate = g_application_real_activate;
1300 class->open = g_application_real_open;
1301 class->command_line = g_application_real_command_line;
1302 class->local_command_line = g_application_real_local_command_line;
1303 class->handle_local_options = g_application_real_handle_local_options;
1304 class->add_platform_data = g_application_real_add_platform_data;
1305 class->dbus_register = g_application_real_dbus_register;
1306 class->dbus_unregister = g_application_real_dbus_unregister;
1308 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
1309 g_param_spec_string ("application-id",
1310 P_("Application identifier"),
1311 P_("The unique identifier for the application"),
1312 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
1313 G_PARAM_STATIC_STRINGS));
1315 g_object_class_install_property (object_class, PROP_FLAGS,
1316 g_param_spec_flags ("flags",
1317 P_("Application flags"),
1318 P_("Flags specifying the behaviour of the application"),
1319 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
1320 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1322 g_object_class_install_property (object_class, PROP_RESOURCE_BASE_PATH,
1323 g_param_spec_string ("resource-base-path",
1324 P_("Resource base path"),
1325 P_("The base resource path for the application"),
1326 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1328 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
1329 g_param_spec_boolean ("is-registered",
1330 P_("Is registered"),
1331 P_("If g_application_register() has been called"),
1332 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1334 g_object_class_install_property (object_class, PROP_IS_REMOTE,
1335 g_param_spec_boolean ("is-remote",
1337 P_("If this application instance is remote"),
1338 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1340 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
1341 g_param_spec_uint ("inactivity-timeout",
1342 P_("Inactivity timeout"),
1343 P_("Time (ms) to stay alive after becoming idle"),
1345 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1347 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
1348 g_param_spec_object ("action-group",
1350 P_("The group of actions that the application exports"),
1351 G_TYPE_ACTION_GROUP,
1352 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
1355 * GApplication:is-busy:
1357 * Whether the application is currently marked as busy through
1358 * g_application_mark_busy() or g_application_bind_busy_property().
1362 g_object_class_install_property (object_class, PROP_IS_BUSY,
1363 g_param_spec_boolean ("is-busy",
1365 P_("If this application is currently marked busy"),
1366 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1369 * GApplication::startup:
1370 * @application: the application
1372 * The ::startup signal is emitted on the primary instance immediately
1373 * after registration. See g_application_register().
1375 g_application_signals[SIGNAL_STARTUP] =
1376 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
1377 G_STRUCT_OFFSET (GApplicationClass, startup),
1378 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1381 * GApplication::shutdown:
1382 * @application: the application
1384 * The ::shutdown signal is emitted only on the registered primary instance
1385 * immediately after the main loop terminates.
1387 g_application_signals[SIGNAL_SHUTDOWN] =
1388 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1389 G_STRUCT_OFFSET (GApplicationClass, shutdown),
1390 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1393 * GApplication::activate:
1394 * @application: the application
1396 * The ::activate signal is emitted on the primary instance when an
1397 * activation occurs. See g_application_activate().
1399 g_application_signals[SIGNAL_ACTIVATE] =
1400 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1401 G_STRUCT_OFFSET (GApplicationClass, activate),
1402 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1406 * GApplication::open:
1407 * @application: the application
1408 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
1409 * @n_files: the length of @files
1410 * @hint: a hint provided by the calling instance
1412 * The ::open signal is emitted on the primary instance when there are
1413 * files to open. See g_application_open() for more information.
1415 g_application_signals[SIGNAL_OPEN] =
1416 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1417 G_STRUCT_OFFSET (GApplicationClass, open),
1419 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
1422 * GApplication::command-line:
1423 * @application: the application
1424 * @command_line: a #GApplicationCommandLine representing the
1425 * passed commandline
1427 * The ::command-line signal is emitted on the primary instance when
1428 * a commandline is not handled locally. See g_application_run() and
1429 * the #GApplicationCommandLine documentation for more information.
1431 * Returns: An integer that is set as the exit status for the calling
1432 * process. See g_application_command_line_set_exit_status().
1434 g_application_signals[SIGNAL_COMMAND_LINE] =
1435 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1436 G_STRUCT_OFFSET (GApplicationClass, command_line),
1437 g_signal_accumulator_first_wins, NULL,
1439 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
1442 * GApplication::handle-local-options:
1443 * @application: the application
1444 * @options: the options dictionary
1446 * The ::handle-local-options signal is emitted on the local instance
1447 * after the parsing of the commandline options has occurred.
1449 * You can add options to be recognised during commandline option
1450 * parsing using g_application_add_main_option_entries() and
1451 * g_application_add_option_group().
1453 * Signal handlers can inspect @options (along with values pointed to
1454 * from the @arg_data of an installed #GOptionEntrys) in order to
1455 * decide to perform certain actions, including direct local handling
1456 * (which may be useful for options like --version).
1458 * In the event that the application is marked
1459 * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
1460 * send the @option dictionary to the primary instance where it can be
1461 * read with g_application_command_line_get_options(). The signal
1462 * handler can modify the dictionary before returning, and the
1463 * modified dictionary will be sent.
1465 * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
1466 * "normal processing" will treat the remaining uncollected command
1467 * line arguments as filenames or URIs. If there are no arguments,
1468 * the application is activated by g_application_activate(). One or
1469 * more arguments results in a call to g_application_open().
1471 * If you want to handle the local commandline arguments for yourself
1472 * by converting them to calls to g_application_open() or
1473 * g_action_group_activate_action() then you must be sure to register
1474 * the application first. You should probably not call
1475 * g_application_activate() for yourself, however: just return -1 and
1476 * allow the default handler to do it for you. This will ensure that
1477 * the `--gapplication-service` switch works properly (i.e. no activation
1480 * Note that this signal is emitted from the default implementation of
1481 * local_command_line(). If you override that function and don't
1482 * chain up then this signal will never be emitted.
1484 * You can override local_command_line() if you need more powerful
1485 * capabilities than what is provided here, but this should not
1486 * normally be required.
1488 * Returns: an exit code. If you have handled your options and want
1489 * to exit the process, return a non-negative option, 0 for success,
1490 * and a positive value for failure. To continue, return -1 to let
1491 * the default option processing continue.
1495 g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] =
1496 g_signal_new ("handle-local-options", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1497 G_STRUCT_OFFSET (GApplicationClass, handle_local_options),
1498 g_application_handle_local_options_accumulator, NULL, NULL,
1499 G_TYPE_INT, 1, G_TYPE_VARIANT_DICT);
1503 /* Application ID validity {{{1 */
1506 * g_application_id_is_valid:
1507 * @application_id: a potential application identifier
1509 * Checks if @application_id is a valid application identifier.
1511 * A valid ID is required for calls to g_application_new() and
1512 * g_application_set_application_id().
1514 * For convenience, the restrictions on application identifiers are
1517 * - Application identifiers must contain only the ASCII characters
1518 * "[A-Z][a-z][0-9]_-." and must not begin with a digit.
1520 * - Application identifiers must contain at least one '.' (period)
1521 * character (and thus at least three elements).
1523 * - Application identifiers must not begin or end with a '.' (period)
1526 * - Application identifiers must not contain consecutive '.' (period)
1529 * - Application identifiers must not exceed 255 characters.
1531 * Returns: %TRUE if @application_id is valid
1534 g_application_id_is_valid (const gchar *application_id)
1540 len = strlen (application_id);
1545 if (!g_ascii_isalpha (application_id[0]))
1548 if (application_id[len-1] == '.')
1554 for (; *application_id; application_id++)
1556 if (g_ascii_isalnum (*application_id) ||
1557 (*application_id == '-') ||
1558 (*application_id == '_'))
1562 else if (allow_dot && *application_id == '.')
1577 /* Public Constructor {{{1 */
1579 * g_application_new:
1580 * @application_id: (allow-none): the application id
1581 * @flags: the application flags
1583 * Creates a new #GApplication instance.
1585 * If non-%NULL, the application id must be valid. See
1586 * g_application_id_is_valid().
1588 * If no application ID is given then some features of #GApplication
1589 * (most notably application uniqueness) will be disabled.
1591 * Returns: a new #GApplication instance
1594 g_application_new (const gchar *application_id,
1595 GApplicationFlags flags)
1597 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1599 return g_object_new (G_TYPE_APPLICATION,
1600 "application-id", application_id,
1605 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1607 * g_application_get_application_id:
1608 * @application: a #GApplication
1610 * Gets the unique identifier for @application.
1612 * Returns: the identifier for @application, owned by @application
1617 g_application_get_application_id (GApplication *application)
1619 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1621 return application->priv->id;
1625 * g_application_set_application_id:
1626 * @application: a #GApplication
1627 * @application_id: (allow-none): the identifier for @application
1629 * Sets the unique identifier for @application.
1631 * The application id can only be modified if @application has not yet
1634 * If non-%NULL, the application id must be valid. See
1635 * g_application_id_is_valid().
1640 g_application_set_application_id (GApplication *application,
1641 const gchar *application_id)
1643 g_return_if_fail (G_IS_APPLICATION (application));
1645 if (g_strcmp0 (application->priv->id, application_id) != 0)
1647 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1648 g_return_if_fail (!application->priv->is_registered);
1650 g_free (application->priv->id);
1651 application->priv->id = g_strdup (application_id);
1653 g_object_notify (G_OBJECT (application), "application-id");
1658 * g_application_get_flags:
1659 * @application: a #GApplication
1661 * Gets the flags for @application.
1663 * See #GApplicationFlags.
1665 * Returns: the flags for @application
1670 g_application_get_flags (GApplication *application)
1672 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1674 return application->priv->flags;
1678 * g_application_set_flags:
1679 * @application: a #GApplication
1680 * @flags: the flags for @application
1682 * Sets the flags for @application.
1684 * The flags can only be modified if @application has not yet been
1687 * See #GApplicationFlags.
1692 g_application_set_flags (GApplication *application,
1693 GApplicationFlags flags)
1695 g_return_if_fail (G_IS_APPLICATION (application));
1697 if (application->priv->flags != flags)
1699 g_return_if_fail (!application->priv->is_registered);
1701 application->priv->flags = flags;
1703 g_object_notify (G_OBJECT (application), "flags");
1708 * g_application_get_resource_base_path:
1709 * @application: a #GApplication
1711 * Gets the resource base path of @application.
1713 * See g_application_set_resource_base_path() for more information.
1715 * Returns: (nullable): the base resource path, if one is set
1720 g_application_get_resource_base_path (GApplication *application)
1722 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1724 return application->priv->resource_path;
1728 * g_application_set_resource_base_path:
1729 * @application: a #GApplication
1730 * @resource_path: (nullable): the resource path to use
1732 * Sets (or unsets) the base resource path of @application.
1734 * The path is used to automatically load various [application
1735 * resources][gresource] such as menu layouts and action descriptions.
1736 * The various types of resources will be found at fixed names relative
1737 * to the given base path.
1739 * By default, the resource base path is determined from the application
1740 * ID by prefixing '/' and replacing each '.' with '/'. This is done at
1741 * the time that the #GApplication object is constructed. Changes to
1742 * the application ID after that point will not have an impact on the
1743 * resource base path.
1745 * As an example, if the application has an ID of "org.example.app" then
1746 * the default resource base path will be "/org/example/app". If this
1747 * is a #GtkApplication (and you have not manually changed the path)
1748 * then Gtk will then search for the menus of the application at
1749 * "/org/example/app/gtk/menus.ui".
1751 * See #GResource for more information about adding resources to your
1754 * You can disable automatic resource loading functionality by setting
1755 * the path to %NULL.
1757 * Changing the resource base path once the application is running is
1758 * not recommended. The point at which the resource path is consulted
1759 * for forming paths for various purposes is unspecified.
1764 g_application_set_resource_base_path (GApplication *application,
1765 const gchar *resource_path)
1767 g_return_if_fail (G_IS_APPLICATION (application));
1768 g_return_if_fail (resource_path == NULL || g_str_has_prefix (resource_path, "/"));
1770 if (g_strcmp0 (application->priv->resource_path, resource_path) != 0)
1772 g_free (application->priv->resource_path);
1774 application->priv->resource_path = g_strdup (resource_path);
1776 g_object_notify (G_OBJECT (application), "resource-base-path");
1781 * g_application_get_inactivity_timeout:
1782 * @application: a #GApplication
1784 * Gets the current inactivity timeout for the application.
1786 * This is the amount of time (in milliseconds) after the last call to
1787 * g_application_release() before the application stops running.
1789 * Returns: the timeout, in milliseconds
1794 g_application_get_inactivity_timeout (GApplication *application)
1796 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1798 return application->priv->inactivity_timeout;
1802 * g_application_set_inactivity_timeout:
1803 * @application: a #GApplication
1804 * @inactivity_timeout: the timeout, in milliseconds
1806 * Sets the current inactivity timeout for the application.
1808 * This is the amount of time (in milliseconds) after the last call to
1809 * g_application_release() before the application stops running.
1811 * This call has no side effects of its own. The value set here is only
1812 * used for next time g_application_release() drops the use count to
1813 * zero. Any timeouts currently in progress are not impacted.
1818 g_application_set_inactivity_timeout (GApplication *application,
1819 guint inactivity_timeout)
1821 g_return_if_fail (G_IS_APPLICATION (application));
1823 if (application->priv->inactivity_timeout != inactivity_timeout)
1825 application->priv->inactivity_timeout = inactivity_timeout;
1827 g_object_notify (G_OBJECT (application), "inactivity-timeout");
1830 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
1832 * g_application_get_is_registered:
1833 * @application: a #GApplication
1835 * Checks if @application is registered.
1837 * An application is registered if g_application_register() has been
1838 * successfully called.
1840 * Returns: %TRUE if @application is registered
1845 g_application_get_is_registered (GApplication *application)
1847 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1849 return application->priv->is_registered;
1853 * g_application_get_is_remote:
1854 * @application: a #GApplication
1856 * Checks if @application is remote.
1858 * If @application is remote then it means that another instance of
1859 * application already exists (the 'primary' instance). Calls to
1860 * perform actions on @application will result in the actions being
1861 * performed by the primary instance.
1863 * The value of this property cannot be accessed before
1864 * g_application_register() has been called. See
1865 * g_application_get_is_registered().
1867 * Returns: %TRUE if @application is remote
1872 g_application_get_is_remote (GApplication *application)
1874 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1875 g_return_val_if_fail (application->priv->is_registered, FALSE);
1877 return application->priv->is_remote;
1881 * g_application_get_dbus_connection:
1882 * @application: a #GApplication
1884 * Gets the #GDBusConnection being used by the application, or %NULL.
1886 * If #GApplication is using its D-Bus backend then this function will
1887 * return the #GDBusConnection being used for uniqueness and
1888 * communication with the desktop environment and other instances of the
1891 * If #GApplication is not using D-Bus then this function will return
1892 * %NULL. This includes the situation where the D-Bus backend would
1893 * normally be in use but we were unable to connect to the bus.
1895 * This function must not be called before the application has been
1896 * registered. See g_application_get_is_registered().
1898 * Returns: (transfer none): a #GDBusConnection, or %NULL
1903 g_application_get_dbus_connection (GApplication *application)
1905 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1906 g_return_val_if_fail (application->priv->is_registered, FALSE);
1908 return g_application_impl_get_dbus_connection (application->priv->impl);
1912 * g_application_get_dbus_object_path:
1913 * @application: a #GApplication
1915 * Gets the D-Bus object path being used by the application, or %NULL.
1917 * If #GApplication is using its D-Bus backend then this function will
1918 * return the D-Bus object path that #GApplication is using. If the
1919 * application is the primary instance then there is an object published
1920 * at this path. If the application is not the primary instance then
1921 * the result of this function is undefined.
1923 * If #GApplication is not using D-Bus then this function will return
1924 * %NULL. This includes the situation where the D-Bus backend would
1925 * normally be in use but we were unable to connect to the bus.
1927 * This function must not be called before the application has been
1928 * registered. See g_application_get_is_registered().
1930 * Returns: the object path, or %NULL
1935 g_application_get_dbus_object_path (GApplication *application)
1937 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1938 g_return_val_if_fail (application->priv->is_registered, FALSE);
1940 return g_application_impl_get_dbus_object_path (application->priv->impl);
1946 * g_application_register:
1947 * @application: a #GApplication
1948 * @cancellable: (allow-none): a #GCancellable, or %NULL
1949 * @error: a pointer to a NULL #GError, or %NULL
1951 * Attempts registration of the application.
1953 * This is the point at which the application discovers if it is the
1954 * primary instance or merely acting as a remote for an already-existing
1955 * primary instance. This is implemented by attempting to acquire the
1956 * application identifier as a unique bus name on the session bus using
1959 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1960 * given, then this process will always become the primary instance.
1962 * Due to the internal architecture of GDBus, method calls can be
1963 * dispatched at any time (even if a main loop is not running). For
1964 * this reason, you must ensure that any object paths that you wish to
1965 * register are registered before calling this function.
1967 * If the application has already been registered then %TRUE is
1968 * returned with no work performed.
1970 * The #GApplication::startup signal is emitted if registration succeeds
1971 * and @application is the primary instance (including the non-unique
1974 * In the event of an error (such as @cancellable being cancelled, or a
1975 * failure to connect to the session bus), %FALSE is returned and @error
1976 * is set appropriately.
1978 * Note: the return value of this function is not an indicator that this
1979 * instance is or is not the primary instance of the application. See
1980 * g_application_get_is_remote() for that.
1982 * Returns: %TRUE if registration succeeded
1987 g_application_register (GApplication *application,
1988 GCancellable *cancellable,
1991 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1993 if (!application->priv->is_registered)
1995 if (application->priv->id == NULL)
1996 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
1998 application->priv->impl =
1999 g_application_impl_register (application, application->priv->id,
2000 application->priv->flags,
2001 application->priv->actions,
2002 &application->priv->remote_actions,
2003 cancellable, error);
2005 if (application->priv->impl == NULL)
2008 application->priv->is_remote = application->priv->remote_actions != NULL;
2009 application->priv->is_registered = TRUE;
2011 g_object_notify (G_OBJECT (application), "is-registered");
2013 if (!application->priv->is_remote)
2015 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
2017 if (!application->priv->did_startup)
2018 g_critical ("GApplication subclass '%s' failed to chain up on"
2019 " ::startup (from start of override function)",
2020 G_OBJECT_TYPE_NAME (application));
2027 /* Hold/release {{{1 */
2029 * g_application_hold:
2030 * @application: a #GApplication
2032 * Increases the use count of @application.
2034 * Use this function to indicate that the application has a reason to
2035 * continue to run. For example, g_application_hold() is called by GTK+
2036 * when a toplevel window is on the screen.
2038 * To cancel the hold, call g_application_release().
2041 g_application_hold (GApplication *application)
2043 g_return_if_fail (G_IS_APPLICATION (application));
2045 if (application->priv->inactivity_timeout_id)
2047 g_source_remove (application->priv->inactivity_timeout_id);
2048 application->priv->inactivity_timeout_id = 0;
2051 application->priv->use_count++;
2055 inactivity_timeout_expired (gpointer data)
2057 GApplication *application = G_APPLICATION (data);
2059 application->priv->inactivity_timeout_id = 0;
2061 return G_SOURCE_REMOVE;
2066 * g_application_release:
2067 * @application: a #GApplication
2069 * Decrease the use count of @application.
2071 * When the use count reaches zero, the application will stop running.
2073 * Never call this function except to cancel the effect of a previous
2074 * call to g_application_hold().
2077 g_application_release (GApplication *application)
2079 g_return_if_fail (G_IS_APPLICATION (application));
2080 g_return_if_fail (application->priv->use_count > 0);
2082 application->priv->use_count--;
2084 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
2085 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
2086 inactivity_timeout_expired, application);
2089 /* Activate, Open {{{1 */
2091 * g_application_activate:
2092 * @application: a #GApplication
2094 * Activates the application.
2096 * In essence, this results in the #GApplication::activate signal being
2097 * emitted in the primary instance.
2099 * The application must be registered before calling this function.
2104 g_application_activate (GApplication *application)
2106 g_return_if_fail (G_IS_APPLICATION (application));
2107 g_return_if_fail (application->priv->is_registered);
2109 if (application->priv->is_remote)
2110 g_application_impl_activate (application->priv->impl,
2111 get_platform_data (application, NULL));
2114 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
2118 * g_application_open:
2119 * @application: a #GApplication
2120 * @files: (array length=n_files): an array of #GFiles to open
2121 * @n_files: the length of the @files array
2122 * @hint: a hint (or ""), but never %NULL
2124 * Opens the given files.
2126 * In essence, this results in the #GApplication::open signal being emitted
2127 * in the primary instance.
2129 * @n_files must be greater than zero.
2131 * @hint is simply passed through to the ::open signal. It is
2132 * intended to be used by applications that have multiple modes for
2133 * opening files (eg: "view" vs "edit", etc). Unless you have a need
2134 * for this functionality, you should use "".
2136 * The application must be registered before calling this function
2137 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
2142 g_application_open (GApplication *application,
2147 g_return_if_fail (G_IS_APPLICATION (application));
2148 g_return_if_fail (application->priv->flags &
2149 G_APPLICATION_HANDLES_OPEN);
2150 g_return_if_fail (application->priv->is_registered);
2152 if (application->priv->is_remote)
2153 g_application_impl_open (application->priv->impl,
2154 files, n_files, hint,
2155 get_platform_data (application, NULL));
2158 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
2159 0, files, n_files, hint);
2164 * g_application_run:
2165 * @application: a #GApplication
2166 * @argc: the argc from main() (or 0 if @argv is %NULL)
2167 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
2169 * Runs the application.
2171 * This function is intended to be run from main() and its return value
2172 * is intended to be returned by main(). Although you are expected to pass
2173 * the @argc, @argv parameters from main() to this function, it is possible
2174 * to pass %NULL if @argv is not available or commandline handling is not
2175 * required. Note that on Windows, @argc and @argv are ignored, and
2176 * g_win32_get_command_line() is called internally (for proper support
2177 * of Unicode commandline arguments).
2179 * #GApplication will attempt to parse the commandline arguments. You
2180 * can add commandline flags to the list of recognised options by way of
2181 * g_application_add_main_option_entries(). After this, the
2182 * #GApplication::handle-local-options signal is emitted, from which the
2183 * application can inspect the values of its #GOptionEntrys.
2185 * #GApplication::handle-local-options is a good place to handle options
2186 * such as `--version`, where an immediate reply from the local process is
2187 * desired (instead of communicating with an already-running instance).
2188 * A #GApplication::handle-local-options handler can stop further processing
2189 * by returning a non-negative value, which then becomes the exit status of
2192 * What happens next depends on the flags: if
2193 * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
2194 * commandline arguments are sent to the primary instance, where a
2195 * #GApplication::command-line signal is emitted. Otherwise, the
2196 * remaining commandline arguments are assumed to be a list of files.
2197 * If there are no files listed, the application is activated via the
2198 * #GApplication::activate signal. If there are one or more files, and
2199 * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
2200 * via the #GApplication::open signal.
2202 * If you are interested in doing more complicated local handling of the
2203 * commandline then you should implement your own #GApplication subclass
2204 * and override local_command_line(). In this case, you most likely want
2205 * to return %TRUE from your local_command_line() implementation to
2206 * suppress the default handling. See
2207 * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
2210 * If, after the above is done, the use count of the application is zero
2211 * then the exit status is returned immediately. If the use count is
2212 * non-zero then the default main context is iterated until the use count
2213 * falls to zero, at which point 0 is returned.
2215 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
2216 * run for as much as 10 seconds with a use count of zero while waiting
2217 * for the message that caused the activation to arrive. After that,
2218 * if the use count falls to zero the application will exit immediately,
2219 * except in the case that g_application_set_inactivity_timeout() is in
2222 * This function sets the prgname (g_set_prgname()), if not already set,
2223 * to the basename of argv[0].
2225 * Since 2.40, applications that are not explicitly flagged as services
2226 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
2227 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
2228 * default handler for local_command_line) if "--gapplication-service"
2229 * was given in the command line. If this flag is present then normal
2230 * commandline processing is interrupted and the
2231 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise"
2232 * solution whereby running an application directly from the commandline
2233 * will invoke it in the normal way (which can be useful for debugging)
2234 * while still allowing applications to be D-Bus activated in service
2235 * mode. The D-Bus service file should invoke the executable with
2236 * "--gapplication-service" as the sole commandline argument. This
2237 * approach is suitable for use by most graphical applications but
2238 * should not be used from applications like editors that need precise
2239 * control over when processes invoked via the commandline will exit and
2240 * what their exit status will be.
2242 * Returns: the exit status
2247 g_application_run (GApplication *application,
2254 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
2255 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
2256 g_return_val_if_fail (!application->priv->must_quit_now, 1);
2259 arguments = g_win32_get_command_line ();
2264 arguments = g_new (gchar *, argc + 1);
2265 for (i = 0; i < argc; i++)
2266 arguments[i] = g_strdup (argv[i]);
2267 arguments[i] = NULL;
2271 if (g_get_prgname () == NULL && argc > 0)
2275 prgname = g_path_get_basename (argv[0]);
2276 g_set_prgname (prgname);
2280 if (!G_APPLICATION_GET_CLASS (application)
2281 ->local_command_line (application, &arguments, &status))
2283 GError *error = NULL;
2285 if (!g_application_register (application, NULL, &error))
2287 g_printerr ("Failed to register: %s\n", error->message);
2288 g_error_free (error);
2292 g_application_call_command_line (application, (const gchar **) arguments, NULL, &status);
2295 g_strfreev (arguments);
2297 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
2298 application->priv->is_registered &&
2299 !application->priv->use_count &&
2300 !application->priv->inactivity_timeout_id)
2302 application->priv->inactivity_timeout_id =
2303 g_timeout_add (10000, inactivity_timeout_expired, application);
2306 while (application->priv->use_count || application->priv->inactivity_timeout_id)
2308 if (application->priv->must_quit_now)
2311 g_main_context_iteration (NULL, TRUE);
2315 if (application->priv->is_registered && !application->priv->is_remote)
2317 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
2319 if (!application->priv->did_shutdown)
2320 g_critical ("GApplication subclass '%s' failed to chain up on"
2321 " ::shutdown (from end of override function)",
2322 G_OBJECT_TYPE_NAME (application));
2325 if (application->priv->impl)
2326 g_application_impl_flush (application->priv->impl);
2330 if (!application->priv->must_quit_now)
2331 while (g_main_context_iteration (NULL, FALSE))
2338 g_application_list_actions (GActionGroup *action_group)
2340 GApplication *application = G_APPLICATION (action_group);
2342 g_return_val_if_fail (application->priv->is_registered, NULL);
2344 if (application->priv->remote_actions != NULL)
2345 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
2347 else if (application->priv->actions != NULL)
2348 return g_action_group_list_actions (application->priv->actions);
2351 /* empty string array */
2352 return g_new0 (gchar *, 1);
2356 g_application_query_action (GActionGroup *group,
2357 const gchar *action_name,
2359 const GVariantType **parameter_type,
2360 const GVariantType **state_type,
2361 GVariant **state_hint,
2364 GApplication *application = G_APPLICATION (group);
2366 g_return_val_if_fail (application->priv->is_registered, FALSE);
2368 if (application->priv->remote_actions != NULL)
2369 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
2377 if (application->priv->actions != NULL)
2378 return g_action_group_query_action (application->priv->actions,
2390 g_application_change_action_state (GActionGroup *action_group,
2391 const gchar *action_name,
2394 GApplication *application = G_APPLICATION (action_group);
2396 g_return_if_fail (application->priv->is_remote ||
2397 application->priv->actions != NULL);
2398 g_return_if_fail (application->priv->is_registered);
2400 if (application->priv->remote_actions)
2401 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
2402 action_name, value, get_platform_data (application, NULL));
2405 g_action_group_change_action_state (application->priv->actions, action_name, value);
2409 g_application_activate_action (GActionGroup *action_group,
2410 const gchar *action_name,
2411 GVariant *parameter)
2413 GApplication *application = G_APPLICATION (action_group);
2415 g_return_if_fail (application->priv->is_remote ||
2416 application->priv->actions != NULL);
2417 g_return_if_fail (application->priv->is_registered);
2419 if (application->priv->remote_actions)
2420 g_remote_action_group_activate_action_full (application->priv->remote_actions,
2421 action_name, parameter, get_platform_data (application, NULL));
2424 g_action_group_activate_action (application->priv->actions, action_name, parameter);
2428 g_application_lookup_action (GActionMap *action_map,
2429 const gchar *action_name)
2431 GApplication *application = G_APPLICATION (action_map);
2433 g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
2435 return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
2439 g_application_add_action (GActionMap *action_map,
2442 GApplication *application = G_APPLICATION (action_map);
2444 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2446 g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
2450 g_application_remove_action (GActionMap *action_map,
2451 const gchar *action_name)
2453 GApplication *application = G_APPLICATION (action_map);
2455 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2457 g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
2461 g_application_action_group_iface_init (GActionGroupInterface *iface)
2463 iface->list_actions = g_application_list_actions;
2464 iface->query_action = g_application_query_action;
2465 iface->change_action_state = g_application_change_action_state;
2466 iface->activate_action = g_application_activate_action;
2470 g_application_action_map_iface_init (GActionMapInterface *iface)
2472 iface->lookup_action = g_application_lookup_action;
2473 iface->add_action = g_application_add_action;
2474 iface->remove_action = g_application_remove_action;
2477 /* Default Application {{{1 */
2479 static GApplication *default_app;
2482 * g_application_get_default:
2484 * Returns the default #GApplication instance for this process.
2486 * Normally there is only one #GApplication per process and it becomes
2487 * the default when it is created. You can exercise more control over
2488 * this by using g_application_set_default().
2490 * If there is no default application then %NULL is returned.
2492 * Returns: (transfer none): the default application for this process, or %NULL
2497 g_application_get_default (void)
2503 * g_application_set_default:
2504 * @application: (allow-none): the application to set as default, or %NULL
2506 * Sets or unsets the default application for the process, as returned
2507 * by g_application_get_default().
2509 * This function does not take its own reference on @application. If
2510 * @application is destroyed then the default application will revert
2516 g_application_set_default (GApplication *application)
2518 default_app = application;
2522 * g_application_quit:
2523 * @application: a #GApplication
2525 * Immediately quits the application.
2527 * Upon return to the mainloop, g_application_run() will return,
2528 * calling only the 'shutdown' function before doing so.
2530 * The hold count is ignored.
2532 * The result of calling g_application_run() again after it returns is
2538 g_application_quit (GApplication *application)
2540 g_return_if_fail (G_IS_APPLICATION (application));
2542 application->priv->must_quit_now = TRUE;
2546 * g_application_mark_busy:
2547 * @application: a #GApplication
2549 * Increases the busy count of @application.
2551 * Use this function to indicate that the application is busy, for instance
2552 * while a long running operation is pending.
2554 * The busy state will be exposed to other processes, so a session shell will
2555 * use that information to indicate the state to the user (e.g. with a
2558 * To cancel the busy indication, use g_application_unmark_busy().
2563 g_application_mark_busy (GApplication *application)
2567 g_return_if_fail (G_IS_APPLICATION (application));
2569 was_busy = (application->priv->busy_count > 0);
2570 application->priv->busy_count++;
2574 g_application_impl_set_busy_state (application->priv->impl, TRUE);
2575 g_object_notify (G_OBJECT (application), "is-busy");
2580 * g_application_unmark_busy:
2581 * @application: a #GApplication
2583 * Decreases the busy count of @application.
2585 * When the busy count reaches zero, the new state will be propagated
2586 * to other processes.
2588 * This function must only be called to cancel the effect of a previous
2589 * call to g_application_mark_busy().
2594 g_application_unmark_busy (GApplication *application)
2596 g_return_if_fail (G_IS_APPLICATION (application));
2597 g_return_if_fail (application->priv->busy_count > 0);
2599 application->priv->busy_count--;
2601 if (application->priv->busy_count == 0)
2603 g_application_impl_set_busy_state (application->priv->impl, FALSE);
2604 g_object_notify (G_OBJECT (application), "is-busy");
2609 * g_application_get_is_busy:
2610 * @application: a #GApplication
2612 * Gets the application's current busy state, as set through
2613 * g_application_mark_busy() or g_application_bind_busy_property().
2615 * Returns: %TRUE if @application is currenty marked as busy
2620 g_application_get_is_busy (GApplication *application)
2622 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2624 return application->priv->busy_count > 0;
2627 /* Notifications {{{1 */
2630 * g_application_send_notification:
2631 * @application: a #GApplication
2632 * @id: (allow-none): id of the notification, or %NULL
2633 * @notification: the #GNotification to send
2635 * Sends a notification on behalf of @application to the desktop shell.
2636 * There is no guarantee that the notification is displayed immediately,
2639 * Notifications may persist after the application exits. It will be
2640 * D-Bus-activated when the notification or one of its actions is
2643 * Modifying @notification after this call has no effect. However, the
2644 * object can be reused for a later call to this function.
2646 * @id may be any string that uniquely identifies the event for the
2647 * application. It does not need to be in any special format. For
2648 * example, "new-message" might be appropriate for a notification about
2651 * If a previous notification was sent with the same @id, it will be
2652 * replaced with @notification and shown again as if it was a new
2653 * notification. This works even for notifications sent from a previous
2654 * execution of the application, as long as @id is the same string.
2656 * @id may be %NULL, but it is impossible to replace or withdraw
2657 * notifications without an id.
2659 * If @notification is no longer relevant, it can be withdrawn with
2660 * g_application_withdraw_notification().
2665 g_application_send_notification (GApplication *application,
2667 GNotification *notification)
2669 gchar *generated_id = NULL;
2671 g_return_if_fail (G_IS_APPLICATION (application));
2672 g_return_if_fail (G_IS_NOTIFICATION (notification));
2673 g_return_if_fail (g_application_get_is_registered (application));
2674 g_return_if_fail (!g_application_get_is_remote (application));
2676 if (application->priv->notifications == NULL)
2677 application->priv->notifications = g_notification_backend_new_default (application);
2681 generated_id = g_dbus_generate_guid ();
2685 g_notification_backend_send_notification (application->priv->notifications, id, notification);
2687 g_free (generated_id);
2691 * g_application_withdraw_notification:
2692 * @application: a #GApplication
2693 * @id: id of a previously sent notification
2695 * Withdraws a notification that was sent with
2696 * g_application_send_notification().
2698 * This call does nothing if a notification with @id doesn't exist or
2699 * the notification was never sent.
2701 * This function works even for notifications sent in previous
2702 * executions of this application, as long @id is the same as it was for
2703 * the sent notification.
2705 * Note that notifications are dismissed when the user clicks on one
2706 * of the buttons in a notification or triggers its default action, so
2707 * there is no need to explicitly withdraw the notification in that case.
2712 g_application_withdraw_notification (GApplication *application,
2715 g_return_if_fail (G_IS_APPLICATION (application));
2716 g_return_if_fail (id != NULL);
2718 if (application->priv->notifications == NULL)
2719 application->priv->notifications = g_notification_backend_new_default (application);
2721 g_notification_backend_withdraw_notification (application->priv->notifications, id);
2724 /* Busy binding {{{1 */
2730 } GApplicationBusyBinding;
2733 g_application_busy_binding_destroy (gpointer data,
2736 GApplicationBusyBinding *binding = data;
2738 if (binding->is_busy)
2739 g_application_unmark_busy (binding->app);
2741 g_object_unref (binding->app);
2742 g_slice_free (GApplicationBusyBinding, binding);
2746 g_application_notify_busy_binding (GObject *object,
2750 GApplicationBusyBinding *binding = user_data;
2753 g_object_get (object, pspec->name, &is_busy, NULL);
2755 if (is_busy && !binding->is_busy)
2756 g_application_mark_busy (binding->app);
2757 else if (!is_busy && binding->is_busy)
2758 g_application_unmark_busy (binding->app);
2760 binding->is_busy = is_busy;
2764 * g_application_bind_busy_property:
2765 * @application: a #GApplication
2766 * @object: (type GObject.Object): a #GObject
2767 * @property: the name of a boolean property of @object
2769 * Marks @application as busy (see g_application_mark_busy()) while
2770 * @property on @object is %TRUE.
2772 * The binding holds a reference to @application while it is active, but
2773 * not to @object. Instead, the binding is destroyed when @object is
2779 g_application_bind_busy_property (GApplication *application,
2781 const gchar *property)
2784 GQuark property_quark;
2786 GApplicationBusyBinding *binding;
2789 g_return_if_fail (G_IS_APPLICATION (application));
2790 g_return_if_fail (G_IS_OBJECT (object));
2791 g_return_if_fail (property != NULL);
2793 notify_id = g_signal_lookup ("notify", G_TYPE_OBJECT);
2794 property_quark = g_quark_from_string (property);
2795 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2797 g_return_if_fail (pspec != NULL && pspec->value_type == G_TYPE_BOOLEAN);
2799 if (g_signal_handler_find (object, G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
2800 notify_id, property_quark, NULL, g_application_notify_busy_binding, NULL) > 0)
2802 g_critical ("%s: '%s' is already bound to the busy state of the application", G_STRFUNC, property);
2806 binding = g_slice_new (GApplicationBusyBinding);
2807 binding->app = g_object_ref (application);
2808 binding->is_busy = FALSE;
2810 closure = g_cclosure_new (G_CALLBACK (g_application_notify_busy_binding), binding,
2811 g_application_busy_binding_destroy);
2812 g_signal_connect_closure_by_id (object, notify_id, property_quark, closure, FALSE);
2814 /* fetch the initial value */
2815 g_application_notify_busy_binding (object, pspec, binding);
2819 * g_application_unbind_busy_property:
2820 * @application: a #GApplication
2821 * @object: (type GObject.Object): a #GObject
2822 * @property: the name of a boolean property of @object
2824 * Destroys a binding between @property and the busy state of
2825 * @application that was previously created with
2826 * g_application_bind_busy_property().
2831 g_application_unbind_busy_property (GApplication *application,
2833 const gchar *property)
2836 GQuark property_quark;
2839 g_return_if_fail (G_IS_APPLICATION (application));
2840 g_return_if_fail (G_IS_OBJECT (object));
2841 g_return_if_fail (property != NULL);
2843 notify_id = g_signal_lookup ("notify", G_TYPE_OBJECT);
2844 property_quark = g_quark_from_string (property);
2846 handler_id = g_signal_handler_find (object, G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
2847 notify_id, property_quark, NULL, g_application_notify_busy_binding, NULL);
2848 if (handler_id == 0)
2850 g_critical ("%s: '%s' is not bound to the busy state of the application", G_STRFUNC, property);
2854 g_signal_handler_disconnect (object, handler_id);
2858 /* vim:set foldmethod=marker: */