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).
168 * @startup: invoked on the primary instance immediately after registration
169 * @shutdown: invoked only on the registered primary instance immediately
170 * after the main loop terminates
171 * @activate: invoked on the primary instance when an activation occurs
172 * @open: invoked on the primary instance when there are files to open
173 * @command_line: invoked on the primary instance when a command-line is
174 * not handled locally
175 * @local_command_line: invoked (locally) when the process has been invoked
176 * via commandline execution (as opposed to, say, D-Bus activation - which
177 * is not currently supported by GApplication). The virtual function has
178 * the chance to inspect (and possibly replace) the list of command line
179 * arguments. See g_application_run() for more information.
180 * @before_emit: invoked on the primary instance before 'activate', 'open',
181 * 'command-line' or any action invocation, gets the 'platform data' from
182 * the calling instance
183 * @after_emit: invoked on the primary instance after 'activate', 'open',
184 * 'command-line' or any action invocation, gets the 'platform data' from
185 * the calling instance
186 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
187 * the primary instance when activating, opening or invoking actions
188 * @quit_mainloop: Used to be invoked on the primary instance when the use
189 * count of the application drops to zero (and after any inactivity
190 * timeout, if requested). Not used anymore since 2.32
191 * @run_mainloop: Used to be invoked on the primary instance from
192 * g_application_run() if the use-count is non-zero. Since 2.32,
193 * GApplication is iterating the main context directly and is not
194 * using @run_mainloop anymore
195 * @dbus_register: invoked locally during registration, if the application is
196 * using its D-Bus backend. You can use this to export extra objects on the
197 * bus, that need to exist before the application tries to own the bus name.
198 * The function is passed the #GDBusConnection to to session bus, and the
199 * object path that #GApplication will use to export is D-Bus API.
200 * If this function returns %TRUE, registration will proceed; otherwise
201 * registration will abort. Since: 2.34
202 * @dbus_unregister: invoked locally during unregistration, if the application
203 * is using its D-Bus backend. Use this to undo anything done by the
204 * @dbus_register vfunc. Since: 2.34
206 * Virtual function table for #GApplication.
211 struct _GApplicationPrivate
213 GApplicationFlags flags;
215 gchar *resource_path;
217 GActionGroup *actions;
218 GMenuModel *app_menu;
221 guint inactivity_timeout_id;
222 guint inactivity_timeout;
226 guint is_registered : 1;
228 guint did_startup : 1;
229 guint did_shutdown : 1;
230 guint must_quit_now : 1;
232 GRemoteActionGroup *remote_actions;
233 GApplicationImpl *impl;
235 GNotificationBackend *notifications;
237 /* GOptionContext support */
238 GOptionGroup *main_options;
239 GSList *option_groups;
240 GHashTable *packed_options;
241 gboolean options_parsed;
243 /* Allocated option strings, from g_application_add_main_option() */
244 GSList *option_strings;
252 PROP_RESOURCE_BASE_PATH,
255 PROP_INACTIVITY_TIMEOUT,
267 SIGNAL_HANDLE_LOCAL_OPTIONS,
271 static guint g_application_signals[NR_SIGNALS];
273 static void g_application_action_group_iface_init (GActionGroupInterface *);
274 static void g_application_action_map_iface_init (GActionMapInterface *);
275 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
276 G_ADD_PRIVATE (GApplication)
277 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
278 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
280 /* GApplicationExportedActions {{{1 */
282 /* We create a subclass of GSimpleActionGroup that implements
283 * GRemoteActionGroup and deals with the platform data using
284 * GApplication's before/after_emit vfuncs. This is the action group we
287 * We could implement GRemoteActionGroup on GApplication directly, but
288 * this would be potentially extremely confusing to have exposed as part
289 * of the public API of GApplication. We certainly don't want anyone in
290 * the same process to be calling these APIs...
292 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
295 GSimpleActionGroup parent_instance;
296 GApplication *application;
297 } GApplicationExportedActions;
299 static GType g_application_exported_actions_get_type (void);
300 static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
301 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
302 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
305 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
306 const gchar *action_name,
308 GVariant *platform_data)
310 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
312 G_APPLICATION_GET_CLASS (exported->application)
313 ->before_emit (exported->application, platform_data);
315 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
317 G_APPLICATION_GET_CLASS (exported->application)
318 ->after_emit (exported->application, platform_data);
322 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
323 const gchar *action_name,
325 GVariant *platform_data)
327 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
329 G_APPLICATION_GET_CLASS (exported->application)
330 ->before_emit (exported->application, platform_data);
332 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
334 G_APPLICATION_GET_CLASS (exported->application)
335 ->after_emit (exported->application, platform_data);
339 g_application_exported_actions_init (GApplicationExportedActions *actions)
344 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
346 iface->activate_action_full = g_application_exported_actions_activate_action_full;
347 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
351 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
355 static GActionGroup *
356 g_application_exported_actions_new (GApplication *application)
358 GApplicationExportedActions *actions;
360 actions = g_object_new (g_application_exported_actions_get_type (), NULL);
361 actions->application = application;
363 return G_ACTION_GROUP (actions);
366 /* Command line option handling {{{1 */
369 free_option_entry (gpointer data)
371 GOptionEntry *entry = data;
375 case G_OPTION_ARG_STRING:
376 case G_OPTION_ARG_FILENAME:
377 g_free (*(gchar **) entry->arg_data);
380 case G_OPTION_ARG_STRING_ARRAY:
381 case G_OPTION_ARG_FILENAME_ARRAY:
382 g_strfreev (*(gchar ***) entry->arg_data);
386 /* most things require no free... */
390 /* ...except for the space that we allocated for it ourselves */
391 g_free (entry->arg_data);
393 g_slice_free (GOptionEntry, entry);
397 g_application_pack_option_entries (GApplication *application,
403 g_hash_table_iter_init (&iter, application->priv->packed_options);
404 while (g_hash_table_iter_next (&iter, NULL, &item))
406 GOptionEntry *entry = item;
407 GVariant *value = NULL;
411 case G_OPTION_ARG_NONE:
412 if (*(gboolean *) entry->arg_data != 2)
413 value = g_variant_new_boolean (*(gboolean *) entry->arg_data);
416 case G_OPTION_ARG_STRING:
417 if (*(gchar **) entry->arg_data)
418 value = g_variant_new_string (*(gchar **) entry->arg_data);
421 case G_OPTION_ARG_INT:
422 if (*(gint32 *) entry->arg_data)
423 value = g_variant_new_int32 (*(gint32 *) entry->arg_data);
426 case G_OPTION_ARG_FILENAME:
427 if (*(gchar **) entry->arg_data)
428 value = g_variant_new_bytestring (*(gchar **) entry->arg_data);
431 case G_OPTION_ARG_STRING_ARRAY:
432 if (*(gchar ***) entry->arg_data)
433 value = g_variant_new_strv (*(const gchar ***) entry->arg_data, -1);
436 case G_OPTION_ARG_FILENAME_ARRAY:
437 if (*(gchar ***) entry->arg_data)
438 value = g_variant_new_bytestring_array (*(const gchar ***) entry->arg_data, -1);
441 case G_OPTION_ARG_DOUBLE:
442 if (*(gdouble *) entry->arg_data)
443 value = g_variant_new_double (*(gdouble *) entry->arg_data);
446 case G_OPTION_ARG_INT64:
447 if (*(gint64 *) entry->arg_data)
448 value = g_variant_new_int64 (*(gint64 *) entry->arg_data);
452 g_assert_not_reached ();
456 g_variant_dict_insert_value (dict, entry->long_name, value);
460 static GVariantDict *
461 g_application_parse_command_line (GApplication *application,
465 gboolean become_service = FALSE;
466 GVariantDict *dict = NULL;
467 GOptionContext *context;
469 /* Due to the memory management of GOptionGroup we can only parse
470 * options once. That's because once you add a group to the
471 * GOptionContext there is no way to get it back again. This is fine:
472 * local_command_line() should never get invoked more than once
473 * anyway. Add a sanity check just to be sure.
475 g_return_val_if_fail (!application->priv->options_parsed, NULL);
477 context = g_option_context_new (NULL);
479 /* Add the main option group, if it exists */
480 if (application->priv->main_options)
482 /* This consumes the main_options */
483 g_option_context_set_main_group (context, application->priv->main_options);
484 application->priv->main_options = NULL;
487 /* Add any other option groups if they exist. Adding them to the
488 * context will consume them, so we free the list as we go...
490 while (application->priv->option_groups)
492 g_option_context_add_group (context, application->priv->option_groups->data);
493 application->priv->option_groups = g_slist_delete_link (application->priv->option_groups,
494 application->priv->option_groups);
497 /* If the application has not registered local options and it has
498 * G_APPLICATION_HANDLES_COMMAND_LINE then we have to assume that
499 * their primary instance commandline handler may want to deal with
500 * the arguments. We must therefore ignore them.
502 if (application->priv->main_options == NULL && (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE))
503 g_option_context_set_ignore_unknown_options (context, TRUE);
505 /* In the case that we are not explicitly marked as a service or a
506 * launcher then we want to add the "--gapplication-service" option to
507 * allow the process to be made into a service.
509 if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
511 GOptionGroup *option_group;
512 GOptionEntry entries[] = {
513 { "gapplication-service", '\0', 0, G_OPTION_ARG_NONE, &become_service,
514 N_("Enter GApplication service mode (use from D-Bus service files)") },
518 option_group = g_option_group_new ("gapplication",
519 _("GApplication options"), _("Show GApplication options"),
521 g_option_group_set_translation_domain (option_group, GETTEXT_PACKAGE);
522 g_option_group_add_entries (option_group, entries);
524 g_option_context_add_group (context, option_group);
527 /* Now we parse... */
528 if (!g_option_context_parse_strv (context, arguments, error))
531 /* Check for --gapplication-service */
533 application->priv->flags |= G_APPLICATION_IS_SERVICE;
535 dict = g_variant_dict_new (NULL);
536 if (application->priv->packed_options)
538 g_application_pack_option_entries (application, dict);
539 g_hash_table_unref (application->priv->packed_options);
540 application->priv->packed_options = NULL;
544 /* Make sure we don't run again */
545 application->priv->options_parsed = TRUE;
547 g_option_context_free (context);
553 add_packed_option (GApplication *application,
558 case G_OPTION_ARG_NONE:
559 entry->arg_data = g_new (gboolean, 1);
560 *(gboolean *) entry->arg_data = 2;
563 case G_OPTION_ARG_INT:
564 entry->arg_data = g_new0 (gint, 1);
567 case G_OPTION_ARG_STRING:
568 case G_OPTION_ARG_FILENAME:
569 case G_OPTION_ARG_STRING_ARRAY:
570 case G_OPTION_ARG_FILENAME_ARRAY:
571 entry->arg_data = g_new0 (gpointer, 1);
574 case G_OPTION_ARG_INT64:
575 entry->arg_data = g_new0 (gint64, 1);
578 case G_OPTION_ARG_DOUBLE:
579 entry->arg_data = g_new0 (gdouble, 1);
583 g_return_if_reached ();
586 if (!application->priv->packed_options)
587 application->priv->packed_options = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, free_option_entry);
589 g_hash_table_insert (application->priv->packed_options,
590 g_strdup (entry->long_name),
591 g_slice_dup (GOptionEntry, entry));
595 * g_application_add_main_option_entries:
596 * @application: a #GApplication
597 * @entries: (array zero-terminated=1) (element-type GOptionEntry) a
598 * %NULL-terminated list of #GOptionEntrys
600 * Adds main option entries to be handled by @application.
602 * This function is comparable to g_option_context_add_main_entries().
604 * After the commandline arguments are parsed, the
605 * #GApplication::handle-local-options signal will be emitted. At this
606 * point, the application can inspect the values pointed to by @arg_data
607 * in the given #GOptionEntrys.
609 * Unlike #GOptionContext, #GApplication supports giving a %NULL
610 * @arg_data for a non-callback #GOptionEntry. This results in the
611 * argument in question being packed into a #GVariantDict which is also
612 * passed to #GApplication::handle-local-options, where it can be
613 * inspected and modified. If %G_APPLICATION_HANDLES_COMMAND_LINE is
614 * set, then the resulting dictionary is sent to the primary instance,
615 * where g_application_command_line_get_options_dict() will return it.
616 * This "packing" is done according to the type of the argument --
617 * booleans for normal flags, strings for strings, bytestrings for
618 * filenames, etc. The packing only occurs if the flag is given (ie: we
619 * do not pack a "false" #GVariant in the case that a flag is missing).
621 * In general, it is recommended that all commandline arguments are
622 * parsed locally. The options dictionary should then be used to
623 * transmit the result of the parsing to the primary instance, where
624 * g_variant_dict_lookup() can be used. For local options, it is
625 * possible to either use @arg_data in the usual way, or to consult (and
626 * potentially remove) the option from the options dictionary.
628 * This function is new in GLib 2.40. Before then, the only real choice
629 * was to send all of the commandline arguments (options and all) to the
630 * primary instance for handling. #GApplication ignored them completely
631 * on the local side. Calling this function "opts in" to the new
632 * behaviour, and in particular, means that unrecognised options will be
633 * treated as errors. Unrecognised options have never been ignored when
634 * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
636 * If #GApplication::handle-local-options needs to see the list of
637 * filenames, then the use of %G_OPTION_REMAINING is recommended. If
638 * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
639 * the options dictionary. If you do use %G_OPTION_REMAINING then you
640 * need to handle these arguments for yourself because once they are
641 * consumed, they will no longer be visible to the default handling
642 * (which treats them as filenames to be opened).
647 g_application_add_main_option_entries (GApplication *application,
648 const GOptionEntry *entries)
652 g_return_if_fail (G_IS_APPLICATION (application));
653 g_return_if_fail (entries != NULL);
655 if (!application->priv->main_options)
656 application->priv->main_options = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
658 for (i = 0; entries[i].long_name; i++)
660 GOptionEntry my_entries[2] = { { NULL }, { NULL } };
661 my_entries[0] = entries[i];
663 if (!my_entries[0].arg_data)
664 add_packed_option (application, &my_entries[0]);
666 g_option_group_add_entries (application->priv->main_options, my_entries);
671 * g_application_add_main_option:
672 * @application: the #GApplication
673 * @long_name: the long name of an option used to specify it in a commandline
674 * @short_name: the short name of an option
675 * @flags: flags from #GOptionFlags
676 * @arg: the type of the option, as a #GOptionArg
677 * @description: the description for the option in `--help` output
678 * @arg_description: (nullable): the placeholder to use for the extra argument
679 * parsed by the option in `--help` output
681 * Add an option to be handled by @application.
683 * Calling this function is the equivalent of calling
684 * g_application_add_main_option_entries() with a single #GOptionEntry
685 * that has its arg_data member set to %NULL.
687 * The parsed arguments will be packed into a #GVariantDict which
688 * is passed to #GApplication::handle-local-options. If
689 * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also
690 * be sent to the primary instance. See
691 * g_application_add_main_option_entries() for more details.
693 * See #GOptionEntry for more documentation of the arguments.
698 g_application_add_main_option (GApplication *application,
699 const char *long_name,
703 const char *description,
704 const char *arg_description)
707 GOptionEntry my_entry[2] = {
708 { NULL, short_name, flags, arg, NULL, NULL, NULL },
712 g_return_if_fail (G_IS_APPLICATION (application));
713 g_return_if_fail (long_name != NULL);
714 g_return_if_fail (description != NULL);
716 my_entry[0].long_name = dup_string = g_strdup (long_name);
717 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
719 my_entry[0].description = dup_string = g_strdup (description);
720 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
722 my_entry[0].arg_description = dup_string = g_strdup (arg_description);
723 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
725 g_application_add_main_option_entries (application, my_entry);
729 * g_application_add_option_group:
730 * @application: the #GApplication
731 * @group: a #GOptionGroup
733 * Adds a #GOptionGroup to the commandline handling of @application.
735 * This function is comparable to g_option_context_add_group().
737 * Unlike g_application_add_main_option_entries(), this function does
738 * not deal with %NULL @arg_data and never transmits options to the
741 * The reason for that is because, by the time the options arrive at the
742 * primary instance, it is typically too late to do anything with them.
743 * Taking the GTK option group as an example: GTK will already have been
744 * initialised by the time the #GApplication::command-line handler runs.
745 * In the case that this is not the first-running instance of the
746 * application, the existing instance may already have been running for
749 * This means that the options from #GOptionGroup are only really usable
750 * in the case that the instance of the application being run is the
751 * first instance. Passing options like `--display=` or `--gdk-debug=`
752 * on future runs will have no effect on the existing primary instance.
754 * Calling this function will cause the options in the supplied option
755 * group to be parsed, but it does not cause you to be "opted in" to the
756 * new functionality whereby unrecognised options are rejected even if
757 * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
762 g_application_add_option_group (GApplication *application,
765 g_return_if_fail (G_IS_APPLICATION (application));
766 g_return_if_fail (group != NULL);
768 application->priv->option_groups = g_slist_prepend (application->priv->option_groups, group);
771 /* vfunc defaults {{{1 */
773 g_application_real_before_emit (GApplication *application,
774 GVariant *platform_data)
779 g_application_real_after_emit (GApplication *application,
780 GVariant *platform_data)
785 g_application_real_startup (GApplication *application)
787 application->priv->did_startup = TRUE;
791 g_application_real_shutdown (GApplication *application)
793 application->priv->did_shutdown = TRUE;
797 g_application_real_activate (GApplication *application)
799 if (!g_signal_has_handler_pending (application,
800 g_application_signals[SIGNAL_ACTIVATE],
802 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
804 static gboolean warned;
809 g_warning ("Your application does not implement "
810 "g_application_activate() and has no handlers connected "
811 "to the 'activate' signal. It should do one of these.");
817 g_application_real_open (GApplication *application,
822 if (!g_signal_has_handler_pending (application,
823 g_application_signals[SIGNAL_OPEN],
825 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
827 static gboolean warned;
832 g_warning ("Your application claims to support opening files "
833 "but does not implement g_application_open() and has no "
834 "handlers connected to the 'open' signal.");
840 g_application_real_command_line (GApplication *application,
841 GApplicationCommandLine *cmdline)
843 if (!g_signal_has_handler_pending (application,
844 g_application_signals[SIGNAL_COMMAND_LINE],
846 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
848 static gboolean warned;
853 g_warning ("Your application claims to support custom command line "
854 "handling but does not implement g_application_command_line() "
855 "and has no handlers connected to the 'command-line' signal.");
864 g_application_real_handle_local_options (GApplication *application,
865 GVariantDict *options)
871 get_platform_data (GApplication *application,
874 GVariantBuilder *builder;
877 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
880 gchar *cwd = g_get_current_dir ();
881 g_variant_builder_add (builder, "{sv}", "cwd",
882 g_variant_new_bytestring (cwd));
886 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
891 envp = g_get_environ ();
892 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
895 g_variant_builder_add (builder, "{sv}", "environ", array);
899 g_variant_builder_add (builder, "{sv}", "options", options);
901 G_APPLICATION_GET_CLASS (application)->
902 add_platform_data (application, builder);
904 result = g_variant_builder_end (builder);
905 g_variant_builder_unref (builder);
911 g_application_call_command_line (GApplication *application,
912 const gchar * const *arguments,
916 if (application->priv->is_remote)
918 GVariant *platform_data;
920 platform_data = get_platform_data (application, options);
921 *exit_status = g_application_impl_command_line (application->priv->impl, arguments, platform_data);
925 GApplicationCommandLine *cmdline;
928 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
929 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
933 g_signal_emit (application, g_application_signals[SIGNAL_COMMAND_LINE], 0, cmdline, exit_status);
934 g_object_unref (cmdline);
939 g_application_real_local_command_line (GApplication *application,
943 GError *error = NULL;
944 GVariantDict *options;
947 options = g_application_parse_command_line (application, arguments, &error);
950 g_printerr ("%s\n", error->message);
955 g_signal_emit (application, g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS], 0, options, exit_status);
957 if (*exit_status >= 0)
959 g_variant_dict_unref (options);
963 if (!g_application_register (application, NULL, &error))
965 g_printerr ("Failed to register: %s\n", error->message);
966 g_variant_dict_unref (options);
967 g_error_free (error);
972 n_args = g_strv_length (*arguments);
974 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
976 if ((*exit_status = n_args > 1))
978 g_printerr ("GApplication service mode takes no arguments.\n");
979 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
985 else if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
987 g_application_call_command_line (application,
988 (const gchar **) *arguments,
989 g_variant_dict_end (options),
996 g_application_activate (application);
1002 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
1004 g_critical ("This application can not open files.");
1013 n_files = n_args - 1;
1014 files = g_new (GFile *, n_files);
1016 for (i = 0; i < n_files; i++)
1017 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
1019 g_application_open (application, files, n_files, "");
1021 for (i = 0; i < n_files; i++)
1022 g_object_unref (files[i]);
1030 g_variant_dict_unref (options);
1036 g_application_real_add_platform_data (GApplication *application,
1037 GVariantBuilder *builder)
1042 g_application_real_dbus_register (GApplication *application,
1043 GDBusConnection *connection,
1044 const gchar *object_path,
1051 g_application_real_dbus_unregister (GApplication *application,
1052 GDBusConnection *connection,
1053 const gchar *object_path)
1057 /* GObject implementation stuff {{{1 */
1059 g_application_set_property (GObject *object,
1061 const GValue *value,
1064 GApplication *application = G_APPLICATION (object);
1068 case PROP_APPLICATION_ID:
1069 g_application_set_application_id (application,
1070 g_value_get_string (value));
1074 g_application_set_flags (application, g_value_get_flags (value));
1077 case PROP_RESOURCE_BASE_PATH:
1078 g_application_set_resource_base_path (application, g_value_get_string (value));
1081 case PROP_INACTIVITY_TIMEOUT:
1082 g_application_set_inactivity_timeout (application,
1083 g_value_get_uint (value));
1086 case PROP_ACTION_GROUP:
1087 g_clear_object (&application->priv->actions);
1088 application->priv->actions = g_value_dup_object (value);
1092 g_assert_not_reached ();
1097 * g_application_set_action_group:
1098 * @application: a #GApplication
1099 * @action_group: (allow-none): a #GActionGroup, or %NULL
1101 * This used to be how actions were associated with a #GApplication.
1102 * Now there is #GActionMap for that.
1106 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
1107 * mix use of this API with use of #GActionMap on the same @application
1108 * or things will go very badly wrong. This function is known to
1109 * introduce buggy behaviour (ie: signals not emitted on changes to the
1110 * action group), so you should really use #GActionMap instead.
1113 g_application_set_action_group (GApplication *application,
1114 GActionGroup *action_group)
1116 g_return_if_fail (G_IS_APPLICATION (application));
1117 g_return_if_fail (!application->priv->is_registered);
1119 if (application->priv->actions != NULL)
1120 g_object_unref (application->priv->actions);
1122 application->priv->actions = action_group;
1124 if (application->priv->actions != NULL)
1125 g_object_ref (application->priv->actions);
1129 g_application_get_property (GObject *object,
1134 GApplication *application = G_APPLICATION (object);
1138 case PROP_APPLICATION_ID:
1139 g_value_set_string (value,
1140 g_application_get_application_id (application));
1144 g_value_set_flags (value,
1145 g_application_get_flags (application));
1148 case PROP_RESOURCE_BASE_PATH:
1149 g_value_set_string (value, g_application_get_resource_base_path (application));
1152 case PROP_IS_REGISTERED:
1153 g_value_set_boolean (value,
1154 g_application_get_is_registered (application));
1157 case PROP_IS_REMOTE:
1158 g_value_set_boolean (value,
1159 g_application_get_is_remote (application));
1162 case PROP_INACTIVITY_TIMEOUT:
1163 g_value_set_uint (value,
1164 g_application_get_inactivity_timeout (application));
1168 g_assert_not_reached ();
1173 g_application_constructed (GObject *object)
1175 GApplication *application = G_APPLICATION (object);
1177 if (g_application_get_default () == NULL)
1178 g_application_set_default (application);
1180 /* People should not set properties from _init... */
1181 g_assert (application->priv->resource_path == NULL);
1183 if (application->priv->id != NULL)
1187 application->priv->resource_path = g_strconcat ("/", application->priv->id, NULL);
1189 for (i = 1; application->priv->resource_path[i]; i++)
1190 if (application->priv->resource_path[i] == '.')
1191 application->priv->resource_path[i] = '/';
1196 g_application_finalize (GObject *object)
1198 GApplication *application = G_APPLICATION (object);
1200 g_slist_free_full (application->priv->option_groups, (GDestroyNotify) g_option_group_free);
1201 if (application->priv->main_options)
1202 g_option_group_free (application->priv->main_options);
1203 if (application->priv->packed_options)
1205 g_slist_free_full (application->priv->option_strings, g_free);
1206 g_hash_table_unref (application->priv->packed_options);
1208 if (application->priv->impl)
1209 g_application_impl_destroy (application->priv->impl);
1210 g_free (application->priv->id);
1212 if (g_application_get_default () == application)
1213 g_application_set_default (NULL);
1215 if (application->priv->actions)
1216 g_object_unref (application->priv->actions);
1218 if (application->priv->notifications)
1219 g_object_unref (application->priv->notifications);
1221 g_free (application->priv->resource_path);
1223 G_OBJECT_CLASS (g_application_parent_class)
1224 ->finalize (object);
1228 g_application_init (GApplication *application)
1230 application->priv = g_application_get_instance_private (application);
1232 application->priv->actions = g_application_exported_actions_new (application);
1234 /* application->priv->actions is the one and only ref on the group, so when
1235 * we dispose, the action group will die, disconnecting all signals.
1237 g_signal_connect_swapped (application->priv->actions, "action-added",
1238 G_CALLBACK (g_action_group_action_added), application);
1239 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
1240 G_CALLBACK (g_action_group_action_enabled_changed), application);
1241 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
1242 G_CALLBACK (g_action_group_action_state_changed), application);
1243 g_signal_connect_swapped (application->priv->actions, "action-removed",
1244 G_CALLBACK (g_action_group_action_removed), application);
1248 g_application_handle_local_options_accumulator (GSignalInvocationHint *ihint,
1249 GValue *return_accu,
1250 const GValue *handler_return,
1255 value = g_value_get_int (handler_return);
1256 g_value_set_int (return_accu, value);
1262 g_application_class_init (GApplicationClass *class)
1264 GObjectClass *object_class = G_OBJECT_CLASS (class);
1266 object_class->constructed = g_application_constructed;
1267 object_class->finalize = g_application_finalize;
1268 object_class->get_property = g_application_get_property;
1269 object_class->set_property = g_application_set_property;
1271 class->before_emit = g_application_real_before_emit;
1272 class->after_emit = g_application_real_after_emit;
1273 class->startup = g_application_real_startup;
1274 class->shutdown = g_application_real_shutdown;
1275 class->activate = g_application_real_activate;
1276 class->open = g_application_real_open;
1277 class->command_line = g_application_real_command_line;
1278 class->local_command_line = g_application_real_local_command_line;
1279 class->handle_local_options = g_application_real_handle_local_options;
1280 class->add_platform_data = g_application_real_add_platform_data;
1281 class->dbus_register = g_application_real_dbus_register;
1282 class->dbus_unregister = g_application_real_dbus_unregister;
1284 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
1285 g_param_spec_string ("application-id",
1286 P_("Application identifier"),
1287 P_("The unique identifier for the application"),
1288 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
1289 G_PARAM_STATIC_STRINGS));
1291 g_object_class_install_property (object_class, PROP_FLAGS,
1292 g_param_spec_flags ("flags",
1293 P_("Application flags"),
1294 P_("Flags specifying the behaviour of the application"),
1295 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
1296 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1298 g_object_class_install_property (object_class, PROP_RESOURCE_BASE_PATH,
1299 g_param_spec_string ("resource-base-path",
1300 P_("Resource base path"),
1301 P_("The base resource path for the application"),
1302 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1304 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
1305 g_param_spec_boolean ("is-registered",
1306 P_("Is registered"),
1307 P_("If g_application_register() has been called"),
1308 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1310 g_object_class_install_property (object_class, PROP_IS_REMOTE,
1311 g_param_spec_boolean ("is-remote",
1313 P_("If this application instance is remote"),
1314 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1316 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
1317 g_param_spec_uint ("inactivity-timeout",
1318 P_("Inactivity timeout"),
1319 P_("Time (ms) to stay alive after becoming idle"),
1321 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1323 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
1324 g_param_spec_object ("action-group",
1326 P_("The group of actions that the application exports"),
1327 G_TYPE_ACTION_GROUP,
1328 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
1331 * GApplication::startup:
1332 * @application: the application
1334 * The ::startup signal is emitted on the primary instance immediately
1335 * after registration. See g_application_register().
1337 g_application_signals[SIGNAL_STARTUP] =
1338 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
1339 G_STRUCT_OFFSET (GApplicationClass, startup),
1340 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1343 * GApplication::shutdown:
1344 * @application: the application
1346 * The ::shutdown signal is emitted only on the registered primary instance
1347 * immediately after the main loop terminates.
1349 g_application_signals[SIGNAL_SHUTDOWN] =
1350 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1351 G_STRUCT_OFFSET (GApplicationClass, shutdown),
1352 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1355 * GApplication::activate:
1356 * @application: the application
1358 * The ::activate signal is emitted on the primary instance when an
1359 * activation occurs. See g_application_activate().
1361 g_application_signals[SIGNAL_ACTIVATE] =
1362 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1363 G_STRUCT_OFFSET (GApplicationClass, activate),
1364 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1368 * GApplication::open:
1369 * @application: the application
1370 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
1371 * @n_files: the length of @files
1372 * @hint: a hint provided by the calling instance
1374 * The ::open signal is emitted on the primary instance when there are
1375 * files to open. See g_application_open() for more information.
1377 g_application_signals[SIGNAL_OPEN] =
1378 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1379 G_STRUCT_OFFSET (GApplicationClass, open),
1381 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
1384 * GApplication::command-line:
1385 * @application: the application
1386 * @command_line: a #GApplicationCommandLine representing the
1387 * passed commandline
1389 * The ::command-line signal is emitted on the primary instance when
1390 * a commandline is not handled locally. See g_application_run() and
1391 * the #GApplicationCommandLine documentation for more information.
1393 * Returns: An integer that is set as the exit status for the calling
1394 * process. See g_application_command_line_set_exit_status().
1396 g_application_signals[SIGNAL_COMMAND_LINE] =
1397 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1398 G_STRUCT_OFFSET (GApplicationClass, command_line),
1399 g_signal_accumulator_first_wins, NULL,
1401 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
1404 * GApplication::handle-local-options:
1405 * @application: the application
1406 * @options: the options dictionary
1408 * The ::handle-local-options signal is emitted on the local instance
1409 * after the parsing of the commandline options has occurred.
1411 * You can add options to be recognised during commandline option
1412 * parsing using g_application_add_main_option_entries() and
1413 * g_application_add_option_group().
1415 * Signal handlers can inspect @options (along with values pointed to
1416 * from the @arg_data of an installed #GOptionEntrys) in order to
1417 * decide to perform certain actions, including direct local handling
1418 * (which may be useful for options like --version).
1420 * In the event that the application is marked
1421 * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
1422 * send the @option dictionary to the primary instance where it can be
1423 * read with g_application_command_line_get_options(). The signal
1424 * handler can modify the dictionary before returning, and the
1425 * modified dictionary will be sent.
1427 * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
1428 * "normal processing" will treat the remaining uncollected command
1429 * line arguments as filenames or URIs. If there are no arguments,
1430 * the application is activated by g_application_activate(). One or
1431 * more arguments results in a call to g_application_open().
1433 * If you want to handle the local commandline arguments for yourself
1434 * by converting them to calls to g_application_open() or
1435 * g_action_group_activate_action() then you must be sure to register
1436 * the application first. You should probably not call
1437 * g_application_activate() for yourself, however: just return -1 and
1438 * allow the default handler to do it for you. This will ensure that
1439 * the `--gapplication-service` switch works properly (i.e. no activation
1442 * Note that this signal is emitted from the default implementation of
1443 * local_command_line(). If you override that function and don't
1444 * chain up then this signal will never be emitted.
1446 * You can override local_command_line() if you need more powerful
1447 * capabilities than what is provided here, but this should not
1448 * normally be required.
1450 * Returns: an exit code. If you have handled your options and want
1451 * to exit the process, return a non-negative option, 0 for success,
1452 * and a positive value for failure. To continue, return -1 to let
1453 * the default option processing continue.
1457 g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] =
1458 g_signal_new ("handle-local-options", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1459 G_STRUCT_OFFSET (GApplicationClass, handle_local_options),
1460 g_application_handle_local_options_accumulator, NULL, NULL,
1461 G_TYPE_INT, 1, G_TYPE_VARIANT_DICT);
1465 /* Application ID validity {{{1 */
1468 * g_application_id_is_valid:
1469 * @application_id: a potential application identifier
1471 * Checks if @application_id is a valid application identifier.
1473 * A valid ID is required for calls to g_application_new() and
1474 * g_application_set_application_id().
1476 * For convenience, the restrictions on application identifiers are
1479 * - Application identifiers must contain only the ASCII characters
1480 * "[A-Z][a-z][0-9]_-." and must not begin with a digit.
1482 * - Application identifiers must contain at least one '.' (period)
1483 * character (and thus at least three elements).
1485 * - Application identifiers must not begin or end with a '.' (period)
1488 * - Application identifiers must not contain consecutive '.' (period)
1491 * - Application identifiers must not exceed 255 characters.
1493 * Returns: %TRUE if @application_id is valid
1496 g_application_id_is_valid (const gchar *application_id)
1502 len = strlen (application_id);
1507 if (!g_ascii_isalpha (application_id[0]))
1510 if (application_id[len-1] == '.')
1516 for (; *application_id; application_id++)
1518 if (g_ascii_isalnum (*application_id) ||
1519 (*application_id == '-') ||
1520 (*application_id == '_'))
1524 else if (allow_dot && *application_id == '.')
1539 /* Public Constructor {{{1 */
1541 * g_application_new:
1542 * @application_id: (allow-none): the application id
1543 * @flags: the application flags
1545 * Creates a new #GApplication instance.
1547 * If non-%NULL, the application id must be valid. See
1548 * g_application_id_is_valid().
1550 * If no application ID is given then some features of #GApplication
1551 * (most notably application uniqueness) will be disabled.
1553 * Returns: a new #GApplication instance
1556 g_application_new (const gchar *application_id,
1557 GApplicationFlags flags)
1559 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1561 return g_object_new (G_TYPE_APPLICATION,
1562 "application-id", application_id,
1567 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1569 * g_application_get_application_id:
1570 * @application: a #GApplication
1572 * Gets the unique identifier for @application.
1574 * Returns: the identifier for @application, owned by @application
1579 g_application_get_application_id (GApplication *application)
1581 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1583 return application->priv->id;
1587 * g_application_set_application_id:
1588 * @application: a #GApplication
1589 * @application_id: (allow-none): the identifier for @application
1591 * Sets the unique identifier for @application.
1593 * The application id can only be modified if @application has not yet
1596 * If non-%NULL, the application id must be valid. See
1597 * g_application_id_is_valid().
1602 g_application_set_application_id (GApplication *application,
1603 const gchar *application_id)
1605 g_return_if_fail (G_IS_APPLICATION (application));
1607 if (g_strcmp0 (application->priv->id, application_id) != 0)
1609 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1610 g_return_if_fail (!application->priv->is_registered);
1612 g_free (application->priv->id);
1613 application->priv->id = g_strdup (application_id);
1615 g_object_notify (G_OBJECT (application), "application-id");
1620 * g_application_get_flags:
1621 * @application: a #GApplication
1623 * Gets the flags for @application.
1625 * See #GApplicationFlags.
1627 * Returns: the flags for @application
1632 g_application_get_flags (GApplication *application)
1634 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1636 return application->priv->flags;
1640 * g_application_set_flags:
1641 * @application: a #GApplication
1642 * @flags: the flags for @application
1644 * Sets the flags for @application.
1646 * The flags can only be modified if @application has not yet been
1649 * See #GApplicationFlags.
1654 g_application_set_flags (GApplication *application,
1655 GApplicationFlags flags)
1657 g_return_if_fail (G_IS_APPLICATION (application));
1659 if (application->priv->flags != flags)
1661 g_return_if_fail (!application->priv->is_registered);
1663 application->priv->flags = flags;
1665 g_object_notify (G_OBJECT (application), "flags");
1670 * g_application_get_resource_base_path:
1671 * @application: a #GApplication
1673 * Gets the resource base path of @application.
1675 * See g_application_set_resource_base_path() for more information.
1677 * Returns: (nullable): the base resource path, if one is set
1682 g_application_get_resource_base_path (GApplication *application)
1684 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1686 return application->priv->resource_path;
1690 * g_application_set_resource_base_path:
1691 * @application: a #GApplication
1692 * @resource_path: (nullable): the resource path to use
1694 * Sets (or unsets) the base resource path of @application.
1696 * The path is used to automatically load various [application
1697 * resources][gresource] such as menu layouts and action descriptions.
1698 * The various types of resources will be found at fixed names relative
1699 * to the given base path.
1701 * By default, the resource base path is determined from the application
1702 * ID by prefixing '/' and replacing each '.' with '/'. This is done at
1703 * the time that the #GApplication object is constructed. Changes to
1704 * the application ID after that point will not have an impact on the
1705 * resource base path.
1707 * As an example, if the application has an ID of "org.example.app" then
1708 * the default resource base path will be "/org/example/app". If this
1709 * is a #GtkApplication (and you have not manually changed the path)
1710 * then Gtk will then search for the menus of the application at
1711 * "/org/example/app/gtk/menus.ui".
1713 * See #GResource for more information about adding resources to your
1716 * You can disable automatic resource loading functionality by setting
1717 * the path to %NULL.
1719 * Changing the resource base path once the application is running is
1720 * not recommended. The point at which the resource path is consulted
1721 * for forming paths for various purposes is unspecified.
1726 g_application_set_resource_base_path (GApplication *application,
1727 const gchar *resource_path)
1729 g_return_if_fail (G_IS_APPLICATION (application));
1730 g_return_if_fail (resource_path == NULL || g_str_has_prefix (resource_path, "/"));
1732 if (g_strcmp0 (application->priv->resource_path, resource_path) != 0)
1734 g_free (application->priv->resource_path);
1736 application->priv->resource_path = g_strdup (resource_path);
1738 g_object_notify (G_OBJECT (application), "resource-base-path");
1743 * g_application_get_inactivity_timeout:
1744 * @application: a #GApplication
1746 * Gets the current inactivity timeout for the application.
1748 * This is the amount of time (in milliseconds) after the last call to
1749 * g_application_release() before the application stops running.
1751 * Returns: the timeout, in milliseconds
1756 g_application_get_inactivity_timeout (GApplication *application)
1758 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1760 return application->priv->inactivity_timeout;
1764 * g_application_set_inactivity_timeout:
1765 * @application: a #GApplication
1766 * @inactivity_timeout: the timeout, in milliseconds
1768 * Sets the current inactivity timeout for the application.
1770 * This is the amount of time (in milliseconds) after the last call to
1771 * g_application_release() before the application stops running.
1773 * This call has no side effects of its own. The value set here is only
1774 * used for next time g_application_release() drops the use count to
1775 * zero. Any timeouts currently in progress are not impacted.
1780 g_application_set_inactivity_timeout (GApplication *application,
1781 guint inactivity_timeout)
1783 g_return_if_fail (G_IS_APPLICATION (application));
1785 if (application->priv->inactivity_timeout != inactivity_timeout)
1787 application->priv->inactivity_timeout = inactivity_timeout;
1789 g_object_notify (G_OBJECT (application), "inactivity-timeout");
1792 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
1794 * g_application_get_is_registered:
1795 * @application: a #GApplication
1797 * Checks if @application is registered.
1799 * An application is registered if g_application_register() has been
1800 * successfully called.
1802 * Returns: %TRUE if @application is registered
1807 g_application_get_is_registered (GApplication *application)
1809 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1811 return application->priv->is_registered;
1815 * g_application_get_is_remote:
1816 * @application: a #GApplication
1818 * Checks if @application is remote.
1820 * If @application is remote then it means that another instance of
1821 * application already exists (the 'primary' instance). Calls to
1822 * perform actions on @application will result in the actions being
1823 * performed by the primary instance.
1825 * The value of this property cannot be accessed before
1826 * g_application_register() has been called. See
1827 * g_application_get_is_registered().
1829 * Returns: %TRUE if @application is remote
1834 g_application_get_is_remote (GApplication *application)
1836 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1837 g_return_val_if_fail (application->priv->is_registered, FALSE);
1839 return application->priv->is_remote;
1843 * g_application_get_dbus_connection:
1844 * @application: a #GApplication
1846 * Gets the #GDBusConnection being used by the application, or %NULL.
1848 * If #GApplication is using its D-Bus backend then this function will
1849 * return the #GDBusConnection being used for uniqueness and
1850 * communication with the desktop environment and other instances of the
1853 * If #GApplication is not using D-Bus then this function will return
1854 * %NULL. This includes the situation where the D-Bus backend would
1855 * normally be in use but we were unable to connect to the bus.
1857 * This function must not be called before the application has been
1858 * registered. See g_application_get_is_registered().
1860 * Returns: (transfer none): a #GDBusConnection, or %NULL
1865 g_application_get_dbus_connection (GApplication *application)
1867 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1868 g_return_val_if_fail (application->priv->is_registered, FALSE);
1870 return g_application_impl_get_dbus_connection (application->priv->impl);
1874 * g_application_get_dbus_object_path:
1875 * @application: a #GApplication
1877 * Gets the D-Bus object path being used by the application, or %NULL.
1879 * If #GApplication is using its D-Bus backend then this function will
1880 * return the D-Bus object path that #GApplication is using. If the
1881 * application is the primary instance then there is an object published
1882 * at this path. If the application is not the primary instance then
1883 * the result of this function is undefined.
1885 * If #GApplication is not using D-Bus then this function will return
1886 * %NULL. This includes the situation where the D-Bus backend would
1887 * normally be in use but we were unable to connect to the bus.
1889 * This function must not be called before the application has been
1890 * registered. See g_application_get_is_registered().
1892 * Returns: the object path, or %NULL
1897 g_application_get_dbus_object_path (GApplication *application)
1899 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1900 g_return_val_if_fail (application->priv->is_registered, FALSE);
1902 return g_application_impl_get_dbus_object_path (application->priv->impl);
1908 * g_application_register:
1909 * @application: a #GApplication
1910 * @cancellable: (allow-none): a #GCancellable, or %NULL
1911 * @error: a pointer to a NULL #GError, or %NULL
1913 * Attempts registration of the application.
1915 * This is the point at which the application discovers if it is the
1916 * primary instance or merely acting as a remote for an already-existing
1917 * primary instance. This is implemented by attempting to acquire the
1918 * application identifier as a unique bus name on the session bus using
1921 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1922 * given, then this process will always become the primary instance.
1924 * Due to the internal architecture of GDBus, method calls can be
1925 * dispatched at any time (even if a main loop is not running). For
1926 * this reason, you must ensure that any object paths that you wish to
1927 * register are registered before calling this function.
1929 * If the application has already been registered then %TRUE is
1930 * returned with no work performed.
1932 * The #GApplication::startup signal is emitted if registration succeeds
1933 * and @application is the primary instance (including the non-unique
1936 * In the event of an error (such as @cancellable being cancelled, or a
1937 * failure to connect to the session bus), %FALSE is returned and @error
1938 * is set appropriately.
1940 * Note: the return value of this function is not an indicator that this
1941 * instance is or is not the primary instance of the application. See
1942 * g_application_get_is_remote() for that.
1944 * Returns: %TRUE if registration succeeded
1949 g_application_register (GApplication *application,
1950 GCancellable *cancellable,
1953 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1955 if (!application->priv->is_registered)
1957 if (application->priv->id == NULL)
1958 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
1960 application->priv->impl =
1961 g_application_impl_register (application, application->priv->id,
1962 application->priv->flags,
1963 application->priv->actions,
1964 &application->priv->remote_actions,
1965 cancellable, error);
1967 if (application->priv->impl == NULL)
1970 application->priv->is_remote = application->priv->remote_actions != NULL;
1971 application->priv->is_registered = TRUE;
1973 g_object_notify (G_OBJECT (application), "is-registered");
1975 if (!application->priv->is_remote)
1977 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1979 if (!application->priv->did_startup)
1980 g_critical ("GApplication subclass '%s' failed to chain up on"
1981 " ::startup (from start of override function)",
1982 G_OBJECT_TYPE_NAME (application));
1989 /* Hold/release {{{1 */
1991 * g_application_hold:
1992 * @application: a #GApplication
1994 * Increases the use count of @application.
1996 * Use this function to indicate that the application has a reason to
1997 * continue to run. For example, g_application_hold() is called by GTK+
1998 * when a toplevel window is on the screen.
2000 * To cancel the hold, call g_application_release().
2003 g_application_hold (GApplication *application)
2005 g_return_if_fail (G_IS_APPLICATION (application));
2007 if (application->priv->inactivity_timeout_id)
2009 g_source_remove (application->priv->inactivity_timeout_id);
2010 application->priv->inactivity_timeout_id = 0;
2013 application->priv->use_count++;
2017 inactivity_timeout_expired (gpointer data)
2019 GApplication *application = G_APPLICATION (data);
2021 application->priv->inactivity_timeout_id = 0;
2023 return G_SOURCE_REMOVE;
2028 * g_application_release:
2029 * @application: a #GApplication
2031 * Decrease the use count of @application.
2033 * When the use count reaches zero, the application will stop running.
2035 * Never call this function except to cancel the effect of a previous
2036 * call to g_application_hold().
2039 g_application_release (GApplication *application)
2041 g_return_if_fail (G_IS_APPLICATION (application));
2042 g_return_if_fail (application->priv->use_count > 0);
2044 application->priv->use_count--;
2046 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
2047 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
2048 inactivity_timeout_expired, application);
2051 /* Activate, Open {{{1 */
2053 * g_application_activate:
2054 * @application: a #GApplication
2056 * Activates the application.
2058 * In essence, this results in the #GApplication::activate signal being
2059 * emitted in the primary instance.
2061 * The application must be registered before calling this function.
2066 g_application_activate (GApplication *application)
2068 g_return_if_fail (G_IS_APPLICATION (application));
2069 g_return_if_fail (application->priv->is_registered);
2071 if (application->priv->is_remote)
2072 g_application_impl_activate (application->priv->impl,
2073 get_platform_data (application, NULL));
2076 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
2080 * g_application_open:
2081 * @application: a #GApplication
2082 * @files: (array length=n_files): an array of #GFiles to open
2083 * @n_files: the length of the @files array
2084 * @hint: a hint (or ""), but never %NULL
2086 * Opens the given files.
2088 * In essence, this results in the #GApplication::open signal being emitted
2089 * in the primary instance.
2091 * @n_files must be greater than zero.
2093 * @hint is simply passed through to the ::open signal. It is
2094 * intended to be used by applications that have multiple modes for
2095 * opening files (eg: "view" vs "edit", etc). Unless you have a need
2096 * for this functionality, you should use "".
2098 * The application must be registered before calling this function
2099 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
2104 g_application_open (GApplication *application,
2109 g_return_if_fail (G_IS_APPLICATION (application));
2110 g_return_if_fail (application->priv->flags &
2111 G_APPLICATION_HANDLES_OPEN);
2112 g_return_if_fail (application->priv->is_registered);
2114 if (application->priv->is_remote)
2115 g_application_impl_open (application->priv->impl,
2116 files, n_files, hint,
2117 get_platform_data (application, NULL));
2120 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
2121 0, files, n_files, hint);
2126 * g_application_run:
2127 * @application: a #GApplication
2128 * @argc: the argc from main() (or 0 if @argv is %NULL)
2129 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
2131 * Runs the application.
2133 * This function is intended to be run from main() and its return value
2134 * is intended to be returned by main(). Although you are expected to pass
2135 * the @argc, @argv parameters from main() to this function, it is possible
2136 * to pass %NULL if @argv is not available or commandline handling is not
2137 * required. Note that on Windows, @argc and @argv are ignored, and
2138 * g_win32_get_command_line() is called internally (for proper support
2139 * of Unicode commandline arguments).
2141 * #GApplication will attempt to parse the commandline arguments. You
2142 * can add commandline flags to the list of recognised options by way of
2143 * g_application_add_main_option_entries(). After this, the
2144 * #GApplication::handle-local-options signal is emitted, from which the
2145 * application can inspect the values of its #GOptionEntrys.
2147 * #GApplication::handle-local-options is a good place to handle options
2148 * such as `--version`, where an immediate reply from the local process is
2149 * desired (instead of communicating with an already-running instance).
2150 * A #GApplication::handle-local-options handler can stop further processing
2151 * by returning a non-negative value, which then becomes the exit status of
2154 * What happens next depends on the flags: if
2155 * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
2156 * commandline arguments are sent to the primary instance, where a
2157 * #GApplication::command-line signal is emitted. Otherwise, the
2158 * remaining commandline arguments are assumed to be a list of files.
2159 * If there are no files listed, the application is activated via the
2160 * #GApplication::activate signal. If there are one or more files, and
2161 * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
2162 * via the #GApplication::open signal.
2164 * If you are interested in doing more complicated local handling of the
2165 * commandline then you should implement your own #GApplication subclass
2166 * and override local_command_line(). In this case, you most likely want
2167 * to return %TRUE from your local_command_line() implementation to
2168 * suppress the default handling. See
2169 * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
2172 * If, after the above is done, the use count of the application is zero
2173 * then the exit status is returned immediately. If the use count is
2174 * non-zero then the default main context is iterated until the use count
2175 * falls to zero, at which point 0 is returned.
2177 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
2178 * run for as much as 10 seconds with a use count of zero while waiting
2179 * for the message that caused the activation to arrive. After that,
2180 * if the use count falls to zero the application will exit immediately,
2181 * except in the case that g_application_set_inactivity_timeout() is in
2184 * This function sets the prgname (g_set_prgname()), if not already set,
2185 * to the basename of argv[0]. Since 2.38, if %G_APPLICATION_IS_SERVICE
2186 * is specified, the prgname is set to the application ID. The main
2187 * impact of this is is that the wmclass of windows created by Gtk+ will
2188 * be set accordingly, which helps the window manager determine which
2189 * application is showing the window.
2191 * Since 2.40, applications that are not explicitly flagged as services
2192 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
2193 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
2194 * default handler for local_command_line) if "--gapplication-service"
2195 * was given in the command line. If this flag is present then normal
2196 * commandline processing is interrupted and the
2197 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise"
2198 * solution whereby running an application directly from the commandline
2199 * will invoke it in the normal way (which can be useful for debugging)
2200 * while still allowing applications to be D-Bus activated in service
2201 * mode. The D-Bus service file should invoke the executable with
2202 * "--gapplication-service" as the sole commandline argument. This
2203 * approach is suitable for use by most graphical applications but
2204 * should not be used from applications like editors that need precise
2205 * control over when processes invoked via the commandline will exit and
2206 * what their exit status will be.
2208 * Returns: the exit status
2213 g_application_run (GApplication *application,
2220 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
2221 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
2222 g_return_val_if_fail (!application->priv->must_quit_now, 1);
2225 arguments = g_win32_get_command_line ();
2230 arguments = g_new (gchar *, argc + 1);
2231 for (i = 0; i < argc; i++)
2232 arguments[i] = g_strdup (argv[i]);
2233 arguments[i] = NULL;
2237 if (g_get_prgname () == NULL)
2239 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
2241 g_set_prgname (application->priv->id);
2247 prgname = g_path_get_basename (argv[0]);
2248 g_set_prgname (prgname);
2253 if (!G_APPLICATION_GET_CLASS (application)
2254 ->local_command_line (application, &arguments, &status))
2256 GError *error = NULL;
2258 if (!g_application_register (application, NULL, &error))
2260 g_printerr ("Failed to register: %s\n", error->message);
2261 g_error_free (error);
2265 g_application_call_command_line (application, (const gchar **) arguments, NULL, &status);
2268 g_strfreev (arguments);
2270 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
2271 application->priv->is_registered &&
2272 !application->priv->use_count &&
2273 !application->priv->inactivity_timeout_id)
2275 application->priv->inactivity_timeout_id =
2276 g_timeout_add (10000, inactivity_timeout_expired, application);
2279 while (application->priv->use_count || application->priv->inactivity_timeout_id)
2281 if (application->priv->must_quit_now)
2284 g_main_context_iteration (NULL, TRUE);
2288 if (application->priv->is_registered && !application->priv->is_remote)
2290 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
2292 if (!application->priv->did_shutdown)
2293 g_critical ("GApplication subclass '%s' failed to chain up on"
2294 " ::shutdown (from end of override function)",
2295 G_OBJECT_TYPE_NAME (application));
2298 if (application->priv->impl)
2299 g_application_impl_flush (application->priv->impl);
2307 g_application_list_actions (GActionGroup *action_group)
2309 GApplication *application = G_APPLICATION (action_group);
2311 g_return_val_if_fail (application->priv->is_registered, NULL);
2313 if (application->priv->remote_actions != NULL)
2314 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
2316 else if (application->priv->actions != NULL)
2317 return g_action_group_list_actions (application->priv->actions);
2320 /* empty string array */
2321 return g_new0 (gchar *, 1);
2325 g_application_query_action (GActionGroup *group,
2326 const gchar *action_name,
2328 const GVariantType **parameter_type,
2329 const GVariantType **state_type,
2330 GVariant **state_hint,
2333 GApplication *application = G_APPLICATION (group);
2335 g_return_val_if_fail (application->priv->is_registered, FALSE);
2337 if (application->priv->remote_actions != NULL)
2338 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
2346 if (application->priv->actions != NULL)
2347 return g_action_group_query_action (application->priv->actions,
2359 g_application_change_action_state (GActionGroup *action_group,
2360 const gchar *action_name,
2363 GApplication *application = G_APPLICATION (action_group);
2365 g_return_if_fail (application->priv->is_remote ||
2366 application->priv->actions != NULL);
2367 g_return_if_fail (application->priv->is_registered);
2369 if (application->priv->remote_actions)
2370 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
2371 action_name, value, get_platform_data (application, NULL));
2374 g_action_group_change_action_state (application->priv->actions, action_name, value);
2378 g_application_activate_action (GActionGroup *action_group,
2379 const gchar *action_name,
2380 GVariant *parameter)
2382 GApplication *application = G_APPLICATION (action_group);
2384 g_return_if_fail (application->priv->is_remote ||
2385 application->priv->actions != NULL);
2386 g_return_if_fail (application->priv->is_registered);
2388 if (application->priv->remote_actions)
2389 g_remote_action_group_activate_action_full (application->priv->remote_actions,
2390 action_name, parameter, get_platform_data (application, NULL));
2393 g_action_group_activate_action (application->priv->actions, action_name, parameter);
2397 g_application_lookup_action (GActionMap *action_map,
2398 const gchar *action_name)
2400 GApplication *application = G_APPLICATION (action_map);
2402 g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
2404 return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
2408 g_application_add_action (GActionMap *action_map,
2411 GApplication *application = G_APPLICATION (action_map);
2413 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2415 g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
2419 g_application_remove_action (GActionMap *action_map,
2420 const gchar *action_name)
2422 GApplication *application = G_APPLICATION (action_map);
2424 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2426 g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
2430 g_application_action_group_iface_init (GActionGroupInterface *iface)
2432 iface->list_actions = g_application_list_actions;
2433 iface->query_action = g_application_query_action;
2434 iface->change_action_state = g_application_change_action_state;
2435 iface->activate_action = g_application_activate_action;
2439 g_application_action_map_iface_init (GActionMapInterface *iface)
2441 iface->lookup_action = g_application_lookup_action;
2442 iface->add_action = g_application_add_action;
2443 iface->remove_action = g_application_remove_action;
2446 /* Default Application {{{1 */
2448 static GApplication *default_app;
2451 * g_application_get_default:
2453 * Returns the default #GApplication instance for this process.
2455 * Normally there is only one #GApplication per process and it becomes
2456 * the default when it is created. You can exercise more control over
2457 * this by using g_application_set_default().
2459 * If there is no default application then %NULL is returned.
2461 * Returns: (transfer none): the default application for this process, or %NULL
2466 g_application_get_default (void)
2472 * g_application_set_default:
2473 * @application: (allow-none): the application to set as default, or %NULL
2475 * Sets or unsets the default application for the process, as returned
2476 * by g_application_get_default().
2478 * This function does not take its own reference on @application. If
2479 * @application is destroyed then the default application will revert
2485 g_application_set_default (GApplication *application)
2487 default_app = application;
2491 * g_application_quit:
2492 * @application: a #GApplication
2494 * Immediately quits the application.
2496 * Upon return to the mainloop, g_application_run() will return,
2497 * calling only the 'shutdown' function before doing so.
2499 * The hold count is ignored.
2501 * The result of calling g_application_run() again after it returns is
2507 g_application_quit (GApplication *application)
2509 g_return_if_fail (G_IS_APPLICATION (application));
2511 application->priv->must_quit_now = TRUE;
2515 * g_application_mark_busy:
2516 * @application: a #GApplication
2518 * Increases the busy count of @application.
2520 * Use this function to indicate that the application is busy, for instance
2521 * while a long running operation is pending.
2523 * The busy state will be exposed to other processes, so a session shell will
2524 * use that information to indicate the state to the user (e.g. with a
2527 * To cancel the busy indication, use g_application_unmark_busy().
2532 g_application_mark_busy (GApplication *application)
2536 g_return_if_fail (G_IS_APPLICATION (application));
2538 was_busy = (application->priv->busy_count > 0);
2539 application->priv->busy_count++;
2542 g_application_impl_set_busy_state (application->priv->impl, TRUE);
2546 * g_application_unmark_busy:
2547 * @application: a #GApplication
2549 * Decreases the busy count of @application.
2551 * When the busy count reaches zero, the new state will be propagated
2552 * to other processes.
2554 * This function must only be called to cancel the effect of a previous
2555 * call to g_application_mark_busy().
2560 g_application_unmark_busy (GApplication *application)
2562 g_return_if_fail (G_IS_APPLICATION (application));
2563 g_return_if_fail (application->priv->busy_count > 0);
2565 application->priv->busy_count--;
2567 if (application->priv->busy_count == 0)
2568 g_application_impl_set_busy_state (application->priv->impl, FALSE);
2571 /* Notifications {{{1 */
2574 * g_application_send_notification:
2575 * @application: a #GApplication
2576 * @id: (allow-none): id of the notification, or %NULL
2577 * @notification: the #GNotification to send
2579 * Sends a notification on behalf of @application to the desktop shell.
2580 * There is no guarantee that the notification is displayed immediately,
2583 * Notifications may persist after the application exits. It will be
2584 * D-Bus-activated when the notification or one of its actions is
2587 * Modifying @notification after this call has no effect. However, the
2588 * object can be reused for a later call to this function.
2590 * @id may be any string that uniquely identifies the event for the
2591 * application. It does not need to be in any special format. For
2592 * example, "new-message" might be appropriate for a notification about
2595 * If a previous notification was sent with the same @id, it will be
2596 * replaced with @notification and shown again as if it was a new
2597 * notification. This works even for notifications sent from a previous
2598 * execution of the application, as long as @id is the same string.
2600 * @id may be %NULL, but it is impossible to replace or withdraw
2601 * notifications without an id.
2603 * If @notification is no longer relevant, it can be withdrawn with
2604 * g_application_withdraw_notification().
2609 g_application_send_notification (GApplication *application,
2611 GNotification *notification)
2613 gchar *generated_id = NULL;
2615 g_return_if_fail (G_IS_APPLICATION (application));
2616 g_return_if_fail (G_IS_NOTIFICATION (notification));
2617 g_return_if_fail (g_application_get_is_registered (application));
2618 g_return_if_fail (!g_application_get_is_remote (application));
2620 if (application->priv->notifications == NULL)
2621 application->priv->notifications = g_notification_backend_new_default (application);
2625 generated_id = g_dbus_generate_guid ();
2629 g_notification_backend_send_notification (application->priv->notifications, id, notification);
2631 g_free (generated_id);
2635 * g_application_withdraw_notification:
2636 * @application: a #GApplication
2637 * @id: id of a previously sent notification
2639 * Withdraws a notification that was sent with
2640 * g_application_send_notification().
2642 * This call does nothing if a notification with @id doesn't exist or
2643 * the notification was never sent.
2645 * This function works even for notifications sent in previous
2646 * executions of this application, as long @id is the same as it was for
2647 * the sent notification.
2649 * Note that notifications are dismissed when the user clicks on one
2650 * of the buttons in a notification or triggers its default action, so
2651 * there is no need to explicitly withdraw the notification in that case.
2656 g_application_withdraw_notification (GApplication *application,
2659 g_return_if_fail (G_IS_APPLICATION (application));
2660 g_return_if_fail (id != NULL);
2662 if (application->priv->notifications)
2663 g_notification_backend_withdraw_notification (application->priv->notifications, id);
2667 /* vim:set foldmethod=marker: */