2 * Copyright © 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at 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 "gsettings.h"
32 #include "gnotification-private.h"
33 #include "gnotificationbackend.h"
34 #include "gdbusutils.h"
36 #include "gioenumtypes.h"
41 #include "gmarshal-internal.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 * 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 the same as
91 * [D-Bus well-known bus name](https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus).
92 * Examples include: `com.example.MyApp`, `org.example.internal_apps.Calculator`,
93 * `org._7_zip.Archiver`.
94 * For details on valid application identifiers, see g_application_id_is_valid().
96 * On Linux, the application identifier is claimed as a well-known bus name
97 * on the user's session bus. This means that the uniqueness of your
98 * application is scoped to the current session. It also means that your
99 * application may provide additional services (through registration of other
100 * object paths) at that bus name. The registration of these object paths
101 * should be done with the shared GDBus session bus. Note that due to the
102 * internal architecture of GDBus, method calls can be dispatched at any time
103 * (even if a main loop is not running). For this reason, you must ensure that
104 * any object paths that you wish to register are registered before #GApplication
105 * attempts to acquire the bus name of your application (which happens in
106 * g_application_register()). Unfortunately, this means that you cannot use
107 * g_application_get_is_remote() to decide if you want to register object paths.
109 * GApplication also implements the #GActionGroup and #GActionMap
110 * interfaces and lets you easily export actions by adding them with
111 * g_action_map_add_action(). When invoking an action by calling
112 * g_action_group_activate_action() on the application, it is always
113 * invoked in the primary instance. The actions are also exported on
114 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
115 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
116 * for remote access to exported #GMenuModels.
118 * There is a number of different entry points into a GApplication:
120 * - via 'Activate' (i.e. just starting the application)
122 * - via 'Open' (i.e. opening some files)
124 * - by handling a command-line
126 * - via activating an action
128 * The #GApplication::startup signal lets you handle the application
129 * initialization for all of these in a single place.
131 * Regardless of which of these entry points is used to start the
132 * application, GApplication passes some ‘platform data’ from the
133 * launching instance to the primary instance, in the form of a
134 * #GVariant dictionary mapping strings to variants. To use platform
135 * data, override the @before_emit or @after_emit virtual functions
136 * in your #GApplication subclass. When dealing with
137 * #GApplicationCommandLine objects, the platform data is
138 * directly available via g_application_command_line_get_cwd(),
139 * g_application_command_line_get_environ() and
140 * g_application_command_line_get_platform_data().
142 * As the name indicates, the platform data may vary depending on the
143 * operating system, but it always includes the current directory (key
144 * "cwd"), and optionally the environment (ie the set of environment
145 * variables and their values) of the calling process (key "environ").
146 * The environment is only added to the platform data if the
147 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
148 * can add their own platform data by overriding the @add_platform_data
149 * virtual function. For instance, #GtkApplication adds startup notification
152 * To parse commandline arguments you may handle the
153 * #GApplication::command-line signal or override the local_command_line()
154 * vfunc, to parse them in either the primary instance or the local instance,
157 * For an example of opening files with a GApplication, see
158 * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c).
160 * For an example of using actions with GApplication, see
161 * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c).
163 * For an example of using extra D-Bus hooks with GApplication, see
164 * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
170 * #GApplication is an opaque data structure and can only be accessed
171 * using the following functions.
177 * @startup: invoked on the primary instance immediately after registration
178 * @shutdown: invoked only on the registered primary instance immediately
179 * after the main loop terminates
180 * @activate: invoked on the primary instance when an activation occurs
181 * @open: invoked on the primary instance when there are files to open
182 * @command_line: invoked on the primary instance when a command-line is
183 * not handled locally
184 * @local_command_line: invoked (locally). The virtual function has the chance
185 * to inspect (and possibly replace) command line arguments. See
186 * g_application_run() for more information. Also see the
187 * #GApplication::handle-local-options signal, which is a simpler
188 * alternative to handling some commandline options locally
189 * @before_emit: invoked on the primary instance before 'activate', 'open',
190 * 'command-line' or any action invocation, gets the 'platform data' from
191 * the calling instance
192 * @after_emit: invoked on the primary instance after 'activate', 'open',
193 * 'command-line' or any action invocation, gets the 'platform data' from
194 * the calling instance
195 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
196 * the primary instance when activating, opening or invoking actions
197 * @quit_mainloop: Used to be invoked on the primary instance when the use
198 * count of the application drops to zero (and after any inactivity
199 * timeout, if requested). Not used anymore since 2.32
200 * @run_mainloop: Used to be invoked on the primary instance from
201 * g_application_run() if the use-count is non-zero. Since 2.32,
202 * GApplication is iterating the main context directly and is not
203 * using @run_mainloop anymore
204 * @dbus_register: invoked locally during registration, if the application is
205 * using its D-Bus backend. You can use this to export extra objects on the
206 * bus, that need to exist before the application tries to own the bus name.
207 * The function is passed the #GDBusConnection to to session bus, and the
208 * object path that #GApplication will use to export is D-Bus API.
209 * If this function returns %TRUE, registration will proceed; otherwise
210 * registration will abort. Since: 2.34
211 * @dbus_unregister: invoked locally during unregistration, if the application
212 * is using its D-Bus backend. Use this to undo anything done by
213 * the @dbus_register vfunc. Since: 2.34
214 * @handle_local_options: invoked locally after the parsing of the commandline
215 * options has occurred. Since: 2.40
216 * @name_lost: invoked when another instance is taking over the name. Since: 2.60
218 * Virtual function table for #GApplication.
223 struct _GApplicationPrivate
225 GApplicationFlags flags;
227 gchar *resource_path;
229 GActionGroup *actions;
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;
252 gchar *parameter_string;
256 /* Allocated option strings, from g_application_add_main_option() */
257 GSList *option_strings;
265 PROP_RESOURCE_BASE_PATH,
268 PROP_INACTIVITY_TIMEOUT,
281 SIGNAL_HANDLE_LOCAL_OPTIONS,
286 static guint g_application_signals[NR_SIGNALS];
288 static void g_application_action_group_iface_init (GActionGroupInterface *);
289 static void g_application_action_map_iface_init (GActionMapInterface *);
290 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
291 G_ADD_PRIVATE (GApplication)
292 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
293 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
295 /* GApplicationExportedActions {{{1 */
297 /* We create a subclass of GSimpleActionGroup that implements
298 * GRemoteActionGroup and deals with the platform data using
299 * GApplication's before/after_emit vfuncs. This is the action group we
302 * We could implement GRemoteActionGroup on GApplication directly, but
303 * this would be potentially extremely confusing to have exposed as part
304 * of the public API of GApplication. We certainly don't want anyone in
305 * the same process to be calling these APIs...
307 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
310 GSimpleActionGroup parent_instance;
311 GApplication *application;
312 } GApplicationExportedActions;
314 static GType g_application_exported_actions_get_type (void);
315 static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
316 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
317 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
320 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
321 const gchar *action_name,
323 GVariant *platform_data)
325 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
327 G_APPLICATION_GET_CLASS (exported->application)
328 ->before_emit (exported->application, platform_data);
330 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
332 G_APPLICATION_GET_CLASS (exported->application)
333 ->after_emit (exported->application, platform_data);
337 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
338 const gchar *action_name,
340 GVariant *platform_data)
342 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
344 G_APPLICATION_GET_CLASS (exported->application)
345 ->before_emit (exported->application, platform_data);
347 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
349 G_APPLICATION_GET_CLASS (exported->application)
350 ->after_emit (exported->application, platform_data);
354 g_application_exported_actions_init (GApplicationExportedActions *actions)
359 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
361 iface->activate_action_full = g_application_exported_actions_activate_action_full;
362 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
366 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
370 static GActionGroup *
371 g_application_exported_actions_new (GApplication *application)
373 GApplicationExportedActions *actions;
375 actions = g_object_new (g_application_exported_actions_get_type (), NULL);
376 actions->application = application;
378 return G_ACTION_GROUP (actions);
381 /* Command line option handling {{{1 */
384 free_option_entry (gpointer data)
386 GOptionEntry *entry = data;
390 case G_OPTION_ARG_STRING:
391 case G_OPTION_ARG_FILENAME:
392 g_free (*(gchar **) entry->arg_data);
395 case G_OPTION_ARG_STRING_ARRAY:
396 case G_OPTION_ARG_FILENAME_ARRAY:
397 g_strfreev (*(gchar ***) entry->arg_data);
401 /* most things require no free... */
405 /* ...except for the space that we allocated for it ourselves */
406 g_free (entry->arg_data);
408 g_slice_free (GOptionEntry, entry);
412 g_application_pack_option_entries (GApplication *application,
418 g_hash_table_iter_init (&iter, application->priv->packed_options);
419 while (g_hash_table_iter_next (&iter, NULL, &item))
421 GOptionEntry *entry = item;
422 GVariant *value = NULL;
426 case G_OPTION_ARG_NONE:
427 if (*(gboolean *) entry->arg_data != 2)
428 value = g_variant_new_boolean (*(gboolean *) entry->arg_data);
431 case G_OPTION_ARG_STRING:
432 if (*(gchar **) entry->arg_data)
433 value = g_variant_new_string (*(gchar **) entry->arg_data);
436 case G_OPTION_ARG_INT:
437 if (*(gint32 *) entry->arg_data)
438 value = g_variant_new_int32 (*(gint32 *) entry->arg_data);
441 case G_OPTION_ARG_FILENAME:
442 if (*(gchar **) entry->arg_data)
443 value = g_variant_new_bytestring (*(gchar **) entry->arg_data);
446 case G_OPTION_ARG_STRING_ARRAY:
447 if (*(gchar ***) entry->arg_data)
448 value = g_variant_new_strv (*(const gchar ***) entry->arg_data, -1);
451 case G_OPTION_ARG_FILENAME_ARRAY:
452 if (*(gchar ***) entry->arg_data)
453 value = g_variant_new_bytestring_array (*(const gchar ***) entry->arg_data, -1);
456 case G_OPTION_ARG_DOUBLE:
457 if (*(gdouble *) entry->arg_data)
458 value = g_variant_new_double (*(gdouble *) entry->arg_data);
461 case G_OPTION_ARG_INT64:
462 if (*(gint64 *) entry->arg_data)
463 value = g_variant_new_int64 (*(gint64 *) entry->arg_data);
467 g_assert_not_reached ();
471 g_variant_dict_insert_value (dict, entry->long_name, value);
475 static GVariantDict *
476 g_application_parse_command_line (GApplication *application,
480 gboolean become_service = FALSE;
481 gchar *app_id = NULL;
482 gboolean replace = FALSE;
483 GVariantDict *dict = NULL;
484 GOptionContext *context;
485 GOptionGroup *gapplication_group;
487 /* Due to the memory management of GOptionGroup we can only parse
488 * options once. That's because once you add a group to the
489 * GOptionContext there is no way to get it back again. This is fine:
490 * local_command_line() should never get invoked more than once
491 * anyway. Add a sanity check just to be sure.
493 g_return_val_if_fail (!application->priv->options_parsed, NULL);
495 context = g_option_context_new (application->priv->parameter_string);
496 g_option_context_set_summary (context, application->priv->summary);
497 g_option_context_set_description (context, application->priv->description);
499 gapplication_group = g_option_group_new ("gapplication",
500 _("GApplication options"), _("Show GApplication options"),
502 g_option_group_set_translation_domain (gapplication_group, GETTEXT_PACKAGE);
503 g_option_context_add_group (context, gapplication_group);
505 /* If the application has not registered local options and it has
506 * G_APPLICATION_HANDLES_COMMAND_LINE then we have to assume that
507 * their primary instance commandline handler may want to deal with
508 * the arguments. We must therefore ignore them.
510 * We must also ignore --help in this case since some applications
511 * will try to handle this from the remote side. See #737869.
513 if (application->priv->main_options == NULL && (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE))
515 g_option_context_set_ignore_unknown_options (context, TRUE);
516 g_option_context_set_help_enabled (context, FALSE);
519 /* Add the main option group, if it exists */
520 if (application->priv->main_options)
522 /* This consumes the main_options */
523 g_option_context_set_main_group (context, application->priv->main_options);
524 application->priv->main_options = NULL;
527 /* Add any other option groups if they exist. Adding them to the
528 * context will consume them, so we free the list as we go...
530 while (application->priv->option_groups)
532 g_option_context_add_group (context, application->priv->option_groups->data);
533 application->priv->option_groups = g_slist_delete_link (application->priv->option_groups,
534 application->priv->option_groups);
537 /* In the case that we are not explicitly marked as a service or a
538 * launcher then we want to add the "--gapplication-service" option to
539 * allow the process to be made into a service.
541 if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
543 GOptionEntry entries[] = {
544 { "gapplication-service", '\0', 0, G_OPTION_ARG_NONE, &become_service,
545 N_("Enter GApplication service mode (use from D-Bus service files)") },
549 g_option_group_add_entries (gapplication_group, entries);
552 /* Allow overriding the ID if the application allows it */
553 if (application->priv->flags & G_APPLICATION_CAN_OVERRIDE_APP_ID)
555 GOptionEntry entries[] = {
556 { "gapplication-app-id", '\0', 0, G_OPTION_ARG_STRING, &app_id,
557 N_("Override the application’s ID") },
561 g_option_group_add_entries (gapplication_group, entries);
564 /* Allow replacing if the application allows it */
565 if (application->priv->flags & G_APPLICATION_ALLOW_REPLACEMENT)
567 GOptionEntry entries[] = {
568 { "gapplication-replace", '\0', 0, G_OPTION_ARG_NONE, &replace,
569 N_("Replace the running instance") },
573 g_option_group_add_entries (gapplication_group, entries);
576 /* Now we parse... */
577 if (!g_option_context_parse_strv (context, arguments, error))
580 /* Check for --gapplication-service */
582 application->priv->flags |= G_APPLICATION_IS_SERVICE;
584 /* Check for --gapplication-app-id */
586 g_application_set_application_id (application, app_id);
588 /* Check for --gapplication-replace */
590 application->priv->flags |= G_APPLICATION_REPLACE;
592 dict = g_variant_dict_new (NULL);
593 if (application->priv->packed_options)
595 g_application_pack_option_entries (application, dict);
596 g_hash_table_unref (application->priv->packed_options);
597 application->priv->packed_options = NULL;
601 /* Make sure we don't run again */
602 application->priv->options_parsed = TRUE;
604 g_option_context_free (context);
611 add_packed_option (GApplication *application,
616 case G_OPTION_ARG_NONE:
617 entry->arg_data = g_new (gboolean, 1);
618 *(gboolean *) entry->arg_data = 2;
621 case G_OPTION_ARG_INT:
622 entry->arg_data = g_new0 (gint, 1);
625 case G_OPTION_ARG_STRING:
626 case G_OPTION_ARG_FILENAME:
627 case G_OPTION_ARG_STRING_ARRAY:
628 case G_OPTION_ARG_FILENAME_ARRAY:
629 entry->arg_data = g_new0 (gpointer, 1);
632 case G_OPTION_ARG_INT64:
633 entry->arg_data = g_new0 (gint64, 1);
636 case G_OPTION_ARG_DOUBLE:
637 entry->arg_data = g_new0 (gdouble, 1);
641 g_return_if_reached ();
644 if (!application->priv->packed_options)
645 application->priv->packed_options = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, free_option_entry);
647 g_hash_table_insert (application->priv->packed_options,
648 g_strdup (entry->long_name),
649 g_slice_dup (GOptionEntry, entry));
653 * g_application_add_main_option_entries:
654 * @application: a #GApplication
655 * @entries: (array zero-terminated=1) (element-type GOptionEntry) a
656 * %NULL-terminated list of #GOptionEntrys
658 * Adds main option entries to be handled by @application.
660 * This function is comparable to g_option_context_add_main_entries().
662 * After the commandline arguments are parsed, the
663 * #GApplication::handle-local-options signal will be emitted. At this
664 * point, the application can inspect the values pointed to by @arg_data
665 * in the given #GOptionEntrys.
667 * Unlike #GOptionContext, #GApplication supports giving a %NULL
668 * @arg_data for a non-callback #GOptionEntry. This results in the
669 * argument in question being packed into a #GVariantDict which is also
670 * passed to #GApplication::handle-local-options, where it can be
671 * inspected and modified. If %G_APPLICATION_HANDLES_COMMAND_LINE is
672 * set, then the resulting dictionary is sent to the primary instance,
673 * where g_application_command_line_get_options_dict() will return it.
674 * This "packing" is done according to the type of the argument --
675 * booleans for normal flags, strings for strings, bytestrings for
676 * filenames, etc. The packing only occurs if the flag is given (ie: we
677 * do not pack a "false" #GVariant in the case that a flag is missing).
679 * In general, it is recommended that all commandline arguments are
680 * parsed locally. The options dictionary should then be used to
681 * transmit the result of the parsing to the primary instance, where
682 * g_variant_dict_lookup() can be used. For local options, it is
683 * possible to either use @arg_data in the usual way, or to consult (and
684 * potentially remove) the option from the options dictionary.
686 * This function is new in GLib 2.40. Before then, the only real choice
687 * was to send all of the commandline arguments (options and all) to the
688 * primary instance for handling. #GApplication ignored them completely
689 * on the local side. Calling this function "opts in" to the new
690 * behaviour, and in particular, means that unrecognised options will be
691 * treated as errors. Unrecognised options have never been ignored when
692 * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
694 * If #GApplication::handle-local-options needs to see the list of
695 * filenames, then the use of %G_OPTION_REMAINING is recommended. If
696 * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
697 * the options dictionary. If you do use %G_OPTION_REMAINING then you
698 * need to handle these arguments for yourself because once they are
699 * consumed, they will no longer be visible to the default handling
700 * (which treats them as filenames to be opened).
702 * It is important to use the proper GVariant format when retrieving
703 * the options with g_variant_dict_lookup():
704 * - for %G_OPTION_ARG_NONE, use `b`
705 * - for %G_OPTION_ARG_STRING, use `&s`
706 * - for %G_OPTION_ARG_INT, use `i`
707 * - for %G_OPTION_ARG_INT64, use `x`
708 * - for %G_OPTION_ARG_DOUBLE, use `d`
709 * - for %G_OPTION_ARG_FILENAME, use `^&ay`
710 * - for %G_OPTION_ARG_STRING_ARRAY, use `^a&s`
711 * - for %G_OPTION_ARG_FILENAME_ARRAY, use `^a&ay`
716 g_application_add_main_option_entries (GApplication *application,
717 const GOptionEntry *entries)
721 g_return_if_fail (G_IS_APPLICATION (application));
722 g_return_if_fail (entries != NULL);
724 if (!application->priv->main_options)
726 application->priv->main_options = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
727 g_option_group_set_translation_domain (application->priv->main_options, NULL);
730 for (i = 0; entries[i].long_name; i++)
732 GOptionEntry my_entries[2] = { { NULL }, { NULL } };
733 my_entries[0] = entries[i];
735 if (!my_entries[0].arg_data)
736 add_packed_option (application, &my_entries[0]);
738 g_option_group_add_entries (application->priv->main_options, my_entries);
743 * g_application_add_main_option:
744 * @application: the #GApplication
745 * @long_name: the long name of an option used to specify it in a commandline
746 * @short_name: the short name of an option
747 * @flags: flags from #GOptionFlags
748 * @arg: the type of the option, as a #GOptionArg
749 * @description: the description for the option in `--help` output
750 * @arg_description: (nullable): the placeholder to use for the extra argument
751 * parsed by the option in `--help` output
753 * Add an option to be handled by @application.
755 * Calling this function is the equivalent of calling
756 * g_application_add_main_option_entries() with a single #GOptionEntry
757 * that has its arg_data member set to %NULL.
759 * The parsed arguments will be packed into a #GVariantDict which
760 * is passed to #GApplication::handle-local-options. If
761 * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also
762 * be sent to the primary instance. See
763 * g_application_add_main_option_entries() for more details.
765 * See #GOptionEntry for more documentation of the arguments.
770 g_application_add_main_option (GApplication *application,
771 const char *long_name,
775 const char *description,
776 const char *arg_description)
779 GOptionEntry my_entry[2] = {
780 { NULL, short_name, flags, arg, NULL, NULL, NULL },
784 g_return_if_fail (G_IS_APPLICATION (application));
785 g_return_if_fail (long_name != NULL);
786 g_return_if_fail (description != NULL);
788 my_entry[0].long_name = dup_string = g_strdup (long_name);
789 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
791 my_entry[0].description = dup_string = g_strdup (description);
792 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
794 my_entry[0].arg_description = dup_string = g_strdup (arg_description);
795 application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
797 g_application_add_main_option_entries (application, my_entry);
801 * g_application_add_option_group:
802 * @application: the #GApplication
803 * @group: (transfer full): a #GOptionGroup
805 * Adds a #GOptionGroup to the commandline handling of @application.
807 * This function is comparable to g_option_context_add_group().
809 * Unlike g_application_add_main_option_entries(), this function does
810 * not deal with %NULL @arg_data and never transmits options to the
813 * The reason for that is because, by the time the options arrive at the
814 * primary instance, it is typically too late to do anything with them.
815 * Taking the GTK option group as an example: GTK will already have been
816 * initialised by the time the #GApplication::command-line handler runs.
817 * In the case that this is not the first-running instance of the
818 * application, the existing instance may already have been running for
821 * This means that the options from #GOptionGroup are only really usable
822 * in the case that the instance of the application being run is the
823 * first instance. Passing options like `--display=` or `--gdk-debug=`
824 * on future runs will have no effect on the existing primary instance.
826 * Calling this function will cause the options in the supplied option
827 * group to be parsed, but it does not cause you to be "opted in" to the
828 * new functionality whereby unrecognised options are rejected even if
829 * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
834 g_application_add_option_group (GApplication *application,
837 g_return_if_fail (G_IS_APPLICATION (application));
838 g_return_if_fail (group != NULL);
840 application->priv->option_groups = g_slist_prepend (application->priv->option_groups, group);
844 * g_application_set_option_context_parameter_string:
845 * @application: the #GApplication
846 * @parameter_string: (nullable): a string which is displayed
847 * in the first line of `--help` output, after the usage summary `programname [OPTION...]`.
849 * Sets the parameter string to be used by the commandline handling of @application.
851 * This function registers the argument to be passed to g_option_context_new()
852 * when the internal #GOptionContext of @application is created.
854 * See g_option_context_new() for more information about @parameter_string.
859 g_application_set_option_context_parameter_string (GApplication *application,
860 const gchar *parameter_string)
862 g_return_if_fail (G_IS_APPLICATION (application));
864 g_free (application->priv->parameter_string);
865 application->priv->parameter_string = g_strdup (parameter_string);
869 * g_application_set_option_context_summary:
870 * @application: the #GApplication
871 * @summary: (nullable): a string to be shown in `--help` output
872 * before the list of options, or %NULL
874 * Adds a summary to the @application option context.
876 * See g_option_context_set_summary() for more information.
881 g_application_set_option_context_summary (GApplication *application,
882 const gchar *summary)
884 g_return_if_fail (G_IS_APPLICATION (application));
886 g_free (application->priv->summary);
887 application->priv->summary = g_strdup (summary);
891 * g_application_set_option_context_description:
892 * @application: the #GApplication
893 * @description: (nullable): a string to be shown in `--help` output
894 * after the list of options, or %NULL
896 * Adds a description to the @application option context.
898 * See g_option_context_set_description() for more information.
903 g_application_set_option_context_description (GApplication *application,
904 const gchar *description)
906 g_return_if_fail (G_IS_APPLICATION (application));
908 g_free (application->priv->description);
909 application->priv->description = g_strdup (description);
914 /* vfunc defaults {{{1 */
916 g_application_real_before_emit (GApplication *application,
917 GVariant *platform_data)
922 g_application_real_after_emit (GApplication *application,
923 GVariant *platform_data)
928 g_application_real_startup (GApplication *application)
930 application->priv->did_startup = TRUE;
934 g_application_real_shutdown (GApplication *application)
936 application->priv->did_shutdown = TRUE;
940 g_application_real_activate (GApplication *application)
942 if (!g_signal_has_handler_pending (application,
943 g_application_signals[SIGNAL_ACTIVATE],
945 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
947 static gboolean warned;
952 g_warning ("Your application does not implement "
953 "g_application_activate() and has no handlers connected "
954 "to the 'activate' signal. It should do one of these.");
960 g_application_real_open (GApplication *application,
965 if (!g_signal_has_handler_pending (application,
966 g_application_signals[SIGNAL_OPEN],
968 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
970 static gboolean warned;
975 g_warning ("Your application claims to support opening files "
976 "but does not implement g_application_open() and has no "
977 "handlers connected to the 'open' signal.");
983 g_application_real_command_line (GApplication *application,
984 GApplicationCommandLine *cmdline)
986 if (!g_signal_has_handler_pending (application,
987 g_application_signals[SIGNAL_COMMAND_LINE],
989 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
991 static gboolean warned;
996 g_warning ("Your application claims to support custom command line "
997 "handling but does not implement g_application_command_line() "
998 "and has no handlers connected to the 'command-line' signal.");
1007 g_application_real_handle_local_options (GApplication *application,
1008 GVariantDict *options)
1014 get_platform_data (GApplication *application,
1017 GVariantBuilder *builder;
1020 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
1023 gchar *cwd = g_get_current_dir ();
1024 g_variant_builder_add (builder, "{sv}", "cwd",
1025 g_variant_new_bytestring (cwd));
1029 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
1034 envp = g_get_environ ();
1035 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
1038 g_variant_builder_add (builder, "{sv}", "environ", array);
1042 g_variant_builder_add (builder, "{sv}", "options", options);
1044 G_APPLICATION_GET_CLASS (application)->
1045 add_platform_data (application, builder);
1047 result = g_variant_builder_end (builder);
1048 g_variant_builder_unref (builder);
1054 g_application_call_command_line (GApplication *application,
1055 const gchar * const *arguments,
1059 if (application->priv->is_remote)
1061 GVariant *platform_data;
1063 platform_data = get_platform_data (application, options);
1064 *exit_status = g_application_impl_command_line (application->priv->impl, arguments, platform_data);
1068 GApplicationCommandLine *cmdline;
1071 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1072 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1076 g_signal_emit (application, g_application_signals[SIGNAL_COMMAND_LINE], 0, cmdline, exit_status);
1077 g_object_unref (cmdline);
1082 g_application_real_local_command_line (GApplication *application,
1086 GError *error = NULL;
1087 GVariantDict *options;
1090 options = g_application_parse_command_line (application, arguments, &error);
1093 g_printerr ("%s\n", error->message);
1098 g_signal_emit (application, g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS], 0, options, exit_status);
1100 if (*exit_status >= 0)
1102 g_variant_dict_unref (options);
1106 if (!g_application_register (application, NULL, &error))
1108 g_printerr ("Failed to register: %s\n", error->message);
1109 g_variant_dict_unref (options);
1110 g_error_free (error);
1115 n_args = g_strv_length (*arguments);
1117 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
1119 if ((*exit_status = n_args > 1))
1121 g_printerr ("GApplication service mode takes no arguments.\n");
1122 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
1128 else if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
1130 g_application_call_command_line (application,
1131 (const gchar **) *arguments,
1132 g_variant_dict_end (options),
1139 g_application_activate (application);
1145 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
1147 g_critical ("This application can not open files.");
1156 n_files = n_args - 1;
1157 files = g_new (GFile *, n_files);
1159 for (i = 0; i < n_files; i++)
1160 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
1162 g_application_open (application, files, n_files, "");
1164 for (i = 0; i < n_files; i++)
1165 g_object_unref (files[i]);
1173 g_variant_dict_unref (options);
1179 g_application_real_add_platform_data (GApplication *application,
1180 GVariantBuilder *builder)
1185 g_application_real_dbus_register (GApplication *application,
1186 GDBusConnection *connection,
1187 const gchar *object_path,
1194 g_application_real_dbus_unregister (GApplication *application,
1195 GDBusConnection *connection,
1196 const gchar *object_path)
1201 g_application_real_name_lost (GApplication *application)
1203 g_application_quit (application);
1207 /* GObject implementation stuff {{{1 */
1209 g_application_set_property (GObject *object,
1211 const GValue *value,
1214 GApplication *application = G_APPLICATION (object);
1218 case PROP_APPLICATION_ID:
1219 g_application_set_application_id (application,
1220 g_value_get_string (value));
1224 g_application_set_flags (application, g_value_get_flags (value));
1227 case PROP_RESOURCE_BASE_PATH:
1228 g_application_set_resource_base_path (application, g_value_get_string (value));
1231 case PROP_INACTIVITY_TIMEOUT:
1232 g_application_set_inactivity_timeout (application,
1233 g_value_get_uint (value));
1236 case PROP_ACTION_GROUP:
1237 g_clear_object (&application->priv->actions);
1238 application->priv->actions = g_value_dup_object (value);
1242 g_assert_not_reached ();
1247 * g_application_set_action_group:
1248 * @application: a #GApplication
1249 * @action_group: (nullable): a #GActionGroup, or %NULL
1251 * This used to be how actions were associated with a #GApplication.
1252 * Now there is #GActionMap for that.
1256 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
1257 * mix use of this API with use of #GActionMap on the same @application
1258 * or things will go very badly wrong. This function is known to
1259 * introduce buggy behaviour (ie: signals not emitted on changes to the
1260 * action group), so you should really use #GActionMap instead.
1263 g_application_set_action_group (GApplication *application,
1264 GActionGroup *action_group)
1266 g_return_if_fail (G_IS_APPLICATION (application));
1267 g_return_if_fail (!application->priv->is_registered);
1269 if (application->priv->actions != NULL)
1270 g_object_unref (application->priv->actions);
1272 application->priv->actions = action_group;
1274 if (application->priv->actions != NULL)
1275 g_object_ref (application->priv->actions);
1279 g_application_get_property (GObject *object,
1284 GApplication *application = G_APPLICATION (object);
1288 case PROP_APPLICATION_ID:
1289 g_value_set_string (value,
1290 g_application_get_application_id (application));
1294 g_value_set_flags (value,
1295 g_application_get_flags (application));
1298 case PROP_RESOURCE_BASE_PATH:
1299 g_value_set_string (value, g_application_get_resource_base_path (application));
1302 case PROP_IS_REGISTERED:
1303 g_value_set_boolean (value,
1304 g_application_get_is_registered (application));
1307 case PROP_IS_REMOTE:
1308 g_value_set_boolean (value,
1309 g_application_get_is_remote (application));
1312 case PROP_INACTIVITY_TIMEOUT:
1313 g_value_set_uint (value,
1314 g_application_get_inactivity_timeout (application));
1318 g_value_set_boolean (value, g_application_get_is_busy (application));
1322 g_assert_not_reached ();
1327 g_application_constructed (GObject *object)
1329 GApplication *application = G_APPLICATION (object);
1331 if (g_application_get_default () == NULL)
1332 g_application_set_default (application);
1334 /* People should not set properties from _init... */
1335 g_assert (application->priv->resource_path == NULL);
1337 if (application->priv->id != NULL)
1341 application->priv->resource_path = g_strconcat ("/", application->priv->id, NULL);
1343 for (i = 1; application->priv->resource_path[i]; i++)
1344 if (application->priv->resource_path[i] == '.')
1345 application->priv->resource_path[i] = '/';
1350 g_application_dispose (GObject *object)
1352 GApplication *application = G_APPLICATION (object);
1354 if (application->priv->impl != NULL &&
1355 G_APPLICATION_GET_CLASS (application)->dbus_unregister != g_application_real_dbus_unregister)
1357 static gboolean warned;
1361 g_warning ("Your application did not unregister from D-Bus before destruction. "
1362 "Consider using g_application_run().");
1368 G_OBJECT_CLASS (g_application_parent_class)->dispose (object);
1372 g_application_finalize (GObject *object)
1374 GApplication *application = G_APPLICATION (object);
1376 if (application->priv->inactivity_timeout_id)
1377 g_source_remove (application->priv->inactivity_timeout_id);
1379 g_slist_free_full (application->priv->option_groups, (GDestroyNotify) g_option_group_unref);
1380 if (application->priv->main_options)
1381 g_option_group_unref (application->priv->main_options);
1382 if (application->priv->packed_options)
1383 g_hash_table_unref (application->priv->packed_options);
1385 g_free (application->priv->parameter_string);
1386 g_free (application->priv->summary);
1387 g_free (application->priv->description);
1389 g_slist_free_full (application->priv->option_strings, g_free);
1391 if (application->priv->impl)
1392 g_application_impl_destroy (application->priv->impl);
1393 g_free (application->priv->id);
1395 if (g_application_get_default () == application)
1396 g_application_set_default (NULL);
1398 if (application->priv->actions)
1399 g_object_unref (application->priv->actions);
1401 g_clear_object (&application->priv->remote_actions);
1403 if (application->priv->notifications)
1404 g_object_unref (application->priv->notifications);
1406 g_free (application->priv->resource_path);
1408 G_OBJECT_CLASS (g_application_parent_class)
1409 ->finalize (object);
1413 g_application_init (GApplication *application)
1415 application->priv = g_application_get_instance_private (application);
1417 application->priv->actions = g_application_exported_actions_new (application);
1419 /* application->priv->actions is the one and only ref on the group, so when
1420 * we dispose, the action group will die, disconnecting all signals.
1422 g_signal_connect_swapped (application->priv->actions, "action-added",
1423 G_CALLBACK (g_action_group_action_added), application);
1424 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
1425 G_CALLBACK (g_action_group_action_enabled_changed), application);
1426 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
1427 G_CALLBACK (g_action_group_action_state_changed), application);
1428 g_signal_connect_swapped (application->priv->actions, "action-removed",
1429 G_CALLBACK (g_action_group_action_removed), application);
1433 g_application_handle_local_options_accumulator (GSignalInvocationHint *ihint,
1434 GValue *return_accu,
1435 const GValue *handler_return,
1440 value = g_value_get_int (handler_return);
1441 g_value_set_int (return_accu, value);
1447 g_application_class_init (GApplicationClass *class)
1449 GObjectClass *object_class = G_OBJECT_CLASS (class);
1451 object_class->constructed = g_application_constructed;
1452 object_class->dispose = g_application_dispose;
1453 object_class->finalize = g_application_finalize;
1454 object_class->get_property = g_application_get_property;
1455 object_class->set_property = g_application_set_property;
1457 class->before_emit = g_application_real_before_emit;
1458 class->after_emit = g_application_real_after_emit;
1459 class->startup = g_application_real_startup;
1460 class->shutdown = g_application_real_shutdown;
1461 class->activate = g_application_real_activate;
1462 class->open = g_application_real_open;
1463 class->command_line = g_application_real_command_line;
1464 class->local_command_line = g_application_real_local_command_line;
1465 class->handle_local_options = g_application_real_handle_local_options;
1466 class->add_platform_data = g_application_real_add_platform_data;
1467 class->dbus_register = g_application_real_dbus_register;
1468 class->dbus_unregister = g_application_real_dbus_unregister;
1469 class->name_lost = g_application_real_name_lost;
1471 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
1472 g_param_spec_string ("application-id",
1473 P_("Application identifier"),
1474 P_("The unique identifier for the application"),
1475 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
1476 G_PARAM_STATIC_STRINGS));
1478 g_object_class_install_property (object_class, PROP_FLAGS,
1479 g_param_spec_flags ("flags",
1480 P_("Application flags"),
1481 P_("Flags specifying the behaviour of the application"),
1482 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
1483 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1485 g_object_class_install_property (object_class, PROP_RESOURCE_BASE_PATH,
1486 g_param_spec_string ("resource-base-path",
1487 P_("Resource base path"),
1488 P_("The base resource path for the application"),
1489 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1491 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
1492 g_param_spec_boolean ("is-registered",
1493 P_("Is registered"),
1494 P_("If g_application_register() has been called"),
1495 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1497 g_object_class_install_property (object_class, PROP_IS_REMOTE,
1498 g_param_spec_boolean ("is-remote",
1500 P_("If this application instance is remote"),
1501 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1503 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
1504 g_param_spec_uint ("inactivity-timeout",
1505 P_("Inactivity timeout"),
1506 P_("Time (ms) to stay alive after becoming idle"),
1508 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1510 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
1511 g_param_spec_object ("action-group",
1513 P_("The group of actions that the application exports"),
1514 G_TYPE_ACTION_GROUP,
1515 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
1518 * GApplication:is-busy:
1520 * Whether the application is currently marked as busy through
1521 * g_application_mark_busy() or g_application_bind_busy_property().
1525 g_object_class_install_property (object_class, PROP_IS_BUSY,
1526 g_param_spec_boolean ("is-busy",
1528 P_("If this application is currently marked busy"),
1529 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1532 * GApplication::startup:
1533 * @application: the application
1535 * The ::startup signal is emitted on the primary instance immediately
1536 * after registration. See g_application_register().
1538 g_application_signals[SIGNAL_STARTUP] =
1539 g_signal_new (I_("startup"), G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
1540 G_STRUCT_OFFSET (GApplicationClass, startup),
1541 NULL, NULL, NULL, G_TYPE_NONE, 0);
1544 * GApplication::shutdown:
1545 * @application: the application
1547 * The ::shutdown signal is emitted only on the registered primary instance
1548 * immediately after the main loop terminates.
1550 g_application_signals[SIGNAL_SHUTDOWN] =
1551 g_signal_new (I_("shutdown"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1552 G_STRUCT_OFFSET (GApplicationClass, shutdown),
1553 NULL, NULL, NULL, G_TYPE_NONE, 0);
1556 * GApplication::activate:
1557 * @application: the application
1559 * The ::activate signal is emitted on the primary instance when an
1560 * activation occurs. See g_application_activate().
1562 g_application_signals[SIGNAL_ACTIVATE] =
1563 g_signal_new (I_("activate"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1564 G_STRUCT_OFFSET (GApplicationClass, activate),
1565 NULL, NULL, NULL, G_TYPE_NONE, 0);
1569 * GApplication::open:
1570 * @application: the application
1571 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
1572 * @n_files: the length of @files
1573 * @hint: a hint provided by the calling instance
1575 * The ::open signal is emitted on the primary instance when there are
1576 * files to open. See g_application_open() for more information.
1578 g_application_signals[SIGNAL_OPEN] =
1579 g_signal_new (I_("open"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1580 G_STRUCT_OFFSET (GApplicationClass, open),
1582 _g_cclosure_marshal_VOID__POINTER_INT_STRING,
1583 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
1584 g_signal_set_va_marshaller (g_application_signals[SIGNAL_OPEN],
1585 G_TYPE_FROM_CLASS (class),
1586 _g_cclosure_marshal_VOID__POINTER_INT_STRINGv);
1589 * GApplication::command-line:
1590 * @application: the application
1591 * @command_line: a #GApplicationCommandLine representing the
1592 * passed commandline
1594 * The ::command-line signal is emitted on the primary instance when
1595 * a commandline is not handled locally. See g_application_run() and
1596 * the #GApplicationCommandLine documentation for more information.
1598 * Returns: An integer that is set as the exit status for the calling
1599 * process. See g_application_command_line_set_exit_status().
1601 g_application_signals[SIGNAL_COMMAND_LINE] =
1602 g_signal_new (I_("command-line"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1603 G_STRUCT_OFFSET (GApplicationClass, command_line),
1604 g_signal_accumulator_first_wins, NULL,
1605 _g_cclosure_marshal_INT__OBJECT,
1606 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
1607 g_signal_set_va_marshaller (g_application_signals[SIGNAL_COMMAND_LINE],
1608 G_TYPE_FROM_CLASS (class),
1609 _g_cclosure_marshal_INT__OBJECTv);
1612 * GApplication::handle-local-options:
1613 * @application: the application
1614 * @options: the options dictionary
1616 * The ::handle-local-options signal is emitted on the local instance
1617 * after the parsing of the commandline options has occurred.
1619 * You can add options to be recognised during commandline option
1620 * parsing using g_application_add_main_option_entries() and
1621 * g_application_add_option_group().
1623 * Signal handlers can inspect @options (along with values pointed to
1624 * from the @arg_data of an installed #GOptionEntrys) in order to
1625 * decide to perform certain actions, including direct local handling
1626 * (which may be useful for options like --version).
1628 * In the event that the application is marked
1629 * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
1630 * send the @options dictionary to the primary instance where it can be
1631 * read with g_application_command_line_get_options_dict(). The signal
1632 * handler can modify the dictionary before returning, and the
1633 * modified dictionary will be sent.
1635 * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
1636 * "normal processing" will treat the remaining uncollected command
1637 * line arguments as filenames or URIs. If there are no arguments,
1638 * the application is activated by g_application_activate(). One or
1639 * more arguments results in a call to g_application_open().
1641 * If you want to handle the local commandline arguments for yourself
1642 * by converting them to calls to g_application_open() or
1643 * g_action_group_activate_action() then you must be sure to register
1644 * the application first. You should probably not call
1645 * g_application_activate() for yourself, however: just return -1 and
1646 * allow the default handler to do it for you. This will ensure that
1647 * the `--gapplication-service` switch works properly (i.e. no activation
1650 * Note that this signal is emitted from the default implementation of
1651 * local_command_line(). If you override that function and don't
1652 * chain up then this signal will never be emitted.
1654 * You can override local_command_line() if you need more powerful
1655 * capabilities than what is provided here, but this should not
1656 * normally be required.
1658 * Returns: an exit code. If you have handled your options and want
1659 * to exit the process, return a non-negative option, 0 for success,
1660 * and a positive value for failure. To continue, return -1 to let
1661 * the default option processing continue.
1665 g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] =
1666 g_signal_new (I_("handle-local-options"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1667 G_STRUCT_OFFSET (GApplicationClass, handle_local_options),
1668 g_application_handle_local_options_accumulator, NULL,
1669 _g_cclosure_marshal_INT__BOXED,
1670 G_TYPE_INT, 1, G_TYPE_VARIANT_DICT);
1671 g_signal_set_va_marshaller (g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS],
1672 G_TYPE_FROM_CLASS (class),
1673 _g_cclosure_marshal_INT__BOXEDv);
1676 * GApplication::name-lost:
1677 * @application: the application
1679 * The ::name-lost signal is emitted only on the registered primary instance
1680 * when a new instance has taken over. This can only happen if the application
1681 * is using the %G_APPLICATION_ALLOW_REPLACEMENT flag.
1683 * The default handler for this signal calls g_application_quit().
1685 * Returns: %TRUE if the signal has been handled
1689 g_application_signals[SIGNAL_NAME_LOST] =
1690 g_signal_new (I_("name-lost"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1691 G_STRUCT_OFFSET (GApplicationClass, name_lost),
1692 g_signal_accumulator_true_handled, NULL,
1693 _g_cclosure_marshal_BOOLEAN__VOID,
1695 g_signal_set_va_marshaller (g_application_signals[SIGNAL_NAME_LOST],
1696 G_TYPE_FROM_CLASS (class),
1697 _g_cclosure_marshal_BOOLEAN__VOIDv);
1700 /* Application ID validity {{{1 */
1703 * g_application_id_is_valid:
1704 * @application_id: a potential application identifier
1706 * Checks if @application_id is a valid application identifier.
1708 * A valid ID is required for calls to g_application_new() and
1709 * g_application_set_application_id().
1711 * Application identifiers follow the same format as
1712 * [D-Bus well-known bus names](https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus).
1713 * For convenience, the restrictions on application identifiers are
1716 * - Application identifiers are composed of 1 or more elements separated by a
1717 * period (`.`) character. All elements must contain at least one character.
1719 * - Each element must only contain the ASCII characters `[A-Z][a-z][0-9]_-`,
1720 * with `-` discouraged in new application identifiers. Each element must not
1721 * begin with a digit.
1723 * - Application identifiers must contain at least one `.` (period) character
1724 * (and thus at least two elements).
1726 * - Application identifiers must not begin with a `.` (period) character.
1728 * - Application identifiers must not exceed 255 characters.
1730 * Note that the hyphen (`-`) character is allowed in application identifiers,
1731 * but is problematic or not allowed in various specifications and APIs that
1732 * refer to D-Bus, such as
1733 * [Flatpak application IDs](http://docs.flatpak.org/en/latest/introduction.html#identifiers),
1735 * [`DBusActivatable` interface in the Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#dbus),
1736 * and the convention that an application's "main" interface and object path
1737 * resemble its application identifier and bus name. To avoid situations that
1738 * require special-case handling, it is recommended that new application
1739 * identifiers consistently replace hyphens with underscores.
1741 * Like D-Bus interface names, application identifiers should start with the
1742 * reversed DNS domain name of the author of the interface (in lower-case), and
1743 * it is conventional for the rest of the application identifier to consist of
1744 * words run together, with initial capital letters.
1746 * As with D-Bus interface names, if the author's DNS domain name contains
1747 * hyphen/minus characters they should be replaced by underscores, and if it
1748 * contains leading digits they should be escaped by prepending an underscore.
1749 * For example, if the owner of 7-zip.org used an application identifier for an
1750 * archiving application, it might be named `org._7_zip.Archiver`.
1752 * Returns: %TRUE if @application_id is valid
1755 g_application_id_is_valid (const gchar *application_id)
1757 return g_dbus_is_name (application_id) &&
1758 !g_dbus_is_unique_name (application_id);
1761 /* Public Constructor {{{1 */
1763 * g_application_new:
1764 * @application_id: (nullable): the application id
1765 * @flags: the application flags
1767 * Creates a new #GApplication instance.
1769 * If non-%NULL, the application id must be valid. See
1770 * g_application_id_is_valid().
1772 * If no application ID is given then some features of #GApplication
1773 * (most notably application uniqueness) will be disabled.
1775 * Returns: a new #GApplication instance
1778 g_application_new (const gchar *application_id,
1779 GApplicationFlags flags)
1781 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1783 return g_object_new (G_TYPE_APPLICATION,
1784 "application-id", application_id,
1789 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1791 * g_application_get_application_id:
1792 * @application: a #GApplication
1794 * Gets the unique identifier for @application.
1796 * Returns: the identifier for @application, owned by @application
1801 g_application_get_application_id (GApplication *application)
1803 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1805 return application->priv->id;
1809 * g_application_set_application_id:
1810 * @application: a #GApplication
1811 * @application_id: (nullable): the identifier for @application
1813 * Sets the unique identifier for @application.
1815 * The application id can only be modified if @application has not yet
1818 * If non-%NULL, the application id must be valid. See
1819 * g_application_id_is_valid().
1824 g_application_set_application_id (GApplication *application,
1825 const gchar *application_id)
1827 g_return_if_fail (G_IS_APPLICATION (application));
1829 if (g_strcmp0 (application->priv->id, application_id) != 0)
1831 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1832 g_return_if_fail (!application->priv->is_registered);
1834 g_free (application->priv->id);
1835 application->priv->id = g_strdup (application_id);
1837 g_object_notify (G_OBJECT (application), "application-id");
1842 * g_application_get_flags:
1843 * @application: a #GApplication
1845 * Gets the flags for @application.
1847 * See #GApplicationFlags.
1849 * Returns: the flags for @application
1854 g_application_get_flags (GApplication *application)
1856 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1858 return application->priv->flags;
1862 * g_application_set_flags:
1863 * @application: a #GApplication
1864 * @flags: the flags for @application
1866 * Sets the flags for @application.
1868 * The flags can only be modified if @application has not yet been
1871 * See #GApplicationFlags.
1876 g_application_set_flags (GApplication *application,
1877 GApplicationFlags flags)
1879 g_return_if_fail (G_IS_APPLICATION (application));
1881 if (application->priv->flags != flags)
1883 g_return_if_fail (!application->priv->is_registered);
1885 application->priv->flags = flags;
1887 g_object_notify (G_OBJECT (application), "flags");
1892 * g_application_get_resource_base_path:
1893 * @application: a #GApplication
1895 * Gets the resource base path of @application.
1897 * See g_application_set_resource_base_path() for more information.
1899 * Returns: (nullable): the base resource path, if one is set
1904 g_application_get_resource_base_path (GApplication *application)
1906 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1908 return application->priv->resource_path;
1912 * g_application_set_resource_base_path:
1913 * @application: a #GApplication
1914 * @resource_path: (nullable): the resource path to use
1916 * Sets (or unsets) the base resource path of @application.
1918 * The path is used to automatically load various [application
1919 * resources][gresource] such as menu layouts and action descriptions.
1920 * The various types of resources will be found at fixed names relative
1921 * to the given base path.
1923 * By default, the resource base path is determined from the application
1924 * ID by prefixing '/' and replacing each '.' with '/'. This is done at
1925 * the time that the #GApplication object is constructed. Changes to
1926 * the application ID after that point will not have an impact on the
1927 * resource base path.
1929 * As an example, if the application has an ID of "org.example.app" then
1930 * the default resource base path will be "/org/example/app". If this
1931 * is a #GtkApplication (and you have not manually changed the path)
1932 * then Gtk will then search for the menus of the application at
1933 * "/org/example/app/gtk/menus.ui".
1935 * See #GResource for more information about adding resources to your
1938 * You can disable automatic resource loading functionality by setting
1939 * the path to %NULL.
1941 * Changing the resource base path once the application is running is
1942 * not recommended. The point at which the resource path is consulted
1943 * for forming paths for various purposes is unspecified. When writing
1944 * a sub-class of #GApplication you should either set the
1945 * #GApplication:resource-base-path property at construction time, or call
1946 * this function during the instance initialization. Alternatively, you
1947 * can call this function in the #GApplicationClass.startup virtual function,
1948 * before chaining up to the parent implementation.
1953 g_application_set_resource_base_path (GApplication *application,
1954 const gchar *resource_path)
1956 g_return_if_fail (G_IS_APPLICATION (application));
1957 g_return_if_fail (resource_path == NULL || g_str_has_prefix (resource_path, "/"));
1959 if (g_strcmp0 (application->priv->resource_path, resource_path) != 0)
1961 g_free (application->priv->resource_path);
1963 application->priv->resource_path = g_strdup (resource_path);
1965 g_object_notify (G_OBJECT (application), "resource-base-path");
1970 * g_application_get_inactivity_timeout:
1971 * @application: a #GApplication
1973 * Gets the current inactivity timeout for the application.
1975 * This is the amount of time (in milliseconds) after the last call to
1976 * g_application_release() before the application stops running.
1978 * Returns: the timeout, in milliseconds
1983 g_application_get_inactivity_timeout (GApplication *application)
1985 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1987 return application->priv->inactivity_timeout;
1991 * g_application_set_inactivity_timeout:
1992 * @application: a #GApplication
1993 * @inactivity_timeout: the timeout, in milliseconds
1995 * Sets the current inactivity timeout for the application.
1997 * This is the amount of time (in milliseconds) after the last call to
1998 * g_application_release() before the application stops running.
2000 * This call has no side effects of its own. The value set here is only
2001 * used for next time g_application_release() drops the use count to
2002 * zero. Any timeouts currently in progress are not impacted.
2007 g_application_set_inactivity_timeout (GApplication *application,
2008 guint inactivity_timeout)
2010 g_return_if_fail (G_IS_APPLICATION (application));
2012 if (application->priv->inactivity_timeout != inactivity_timeout)
2014 application->priv->inactivity_timeout = inactivity_timeout;
2016 g_object_notify (G_OBJECT (application), "inactivity-timeout");
2019 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
2021 * g_application_get_is_registered:
2022 * @application: a #GApplication
2024 * Checks if @application is registered.
2026 * An application is registered if g_application_register() has been
2027 * successfully called.
2029 * Returns: %TRUE if @application is registered
2034 g_application_get_is_registered (GApplication *application)
2036 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2038 return application->priv->is_registered;
2042 * g_application_get_is_remote:
2043 * @application: a #GApplication
2045 * Checks if @application is remote.
2047 * If @application is remote then it means that another instance of
2048 * application already exists (the 'primary' instance). Calls to
2049 * perform actions on @application will result in the actions being
2050 * performed by the primary instance.
2052 * The value of this property cannot be accessed before
2053 * g_application_register() has been called. See
2054 * g_application_get_is_registered().
2056 * Returns: %TRUE if @application is remote
2061 g_application_get_is_remote (GApplication *application)
2063 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2064 g_return_val_if_fail (application->priv->is_registered, FALSE);
2066 return application->priv->is_remote;
2070 * g_application_get_dbus_connection:
2071 * @application: a #GApplication
2073 * Gets the #GDBusConnection being used by the application, or %NULL.
2075 * If #GApplication is using its D-Bus backend then this function will
2076 * return the #GDBusConnection being used for uniqueness and
2077 * communication with the desktop environment and other instances of the
2080 * If #GApplication is not using D-Bus then this function will return
2081 * %NULL. This includes the situation where the D-Bus backend would
2082 * normally be in use but we were unable to connect to the bus.
2084 * This function must not be called before the application has been
2085 * registered. See g_application_get_is_registered().
2087 * Returns: (transfer none): a #GDBusConnection, or %NULL
2092 g_application_get_dbus_connection (GApplication *application)
2094 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2095 g_return_val_if_fail (application->priv->is_registered, FALSE);
2097 return g_application_impl_get_dbus_connection (application->priv->impl);
2101 * g_application_get_dbus_object_path:
2102 * @application: a #GApplication
2104 * Gets the D-Bus object path being used by the application, or %NULL.
2106 * If #GApplication is using its D-Bus backend then this function will
2107 * return the D-Bus object path that #GApplication is using. If the
2108 * application is the primary instance then there is an object published
2109 * at this path. If the application is not the primary instance then
2110 * the result of this function is undefined.
2112 * If #GApplication is not using D-Bus then this function will return
2113 * %NULL. This includes the situation where the D-Bus backend would
2114 * normally be in use but we were unable to connect to the bus.
2116 * This function must not be called before the application has been
2117 * registered. See g_application_get_is_registered().
2119 * Returns: the object path, or %NULL
2124 g_application_get_dbus_object_path (GApplication *application)
2126 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2127 g_return_val_if_fail (application->priv->is_registered, FALSE);
2129 return g_application_impl_get_dbus_object_path (application->priv->impl);
2135 * g_application_register:
2136 * @application: a #GApplication
2137 * @cancellable: (nullable): a #GCancellable, or %NULL
2138 * @error: a pointer to a NULL #GError, or %NULL
2140 * Attempts registration of the application.
2142 * This is the point at which the application discovers if it is the
2143 * primary instance or merely acting as a remote for an already-existing
2144 * primary instance. This is implemented by attempting to acquire the
2145 * application identifier as a unique bus name on the session bus using
2148 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
2149 * given, then this process will always become the primary instance.
2151 * Due to the internal architecture of GDBus, method calls can be
2152 * dispatched at any time (even if a main loop is not running). For
2153 * this reason, you must ensure that any object paths that you wish to
2154 * register are registered before calling this function.
2156 * If the application has already been registered then %TRUE is
2157 * returned with no work performed.
2159 * The #GApplication::startup signal is emitted if registration succeeds
2160 * and @application is the primary instance (including the non-unique
2163 * In the event of an error (such as @cancellable being cancelled, or a
2164 * failure to connect to the session bus), %FALSE is returned and @error
2165 * is set appropriately.
2167 * Note: the return value of this function is not an indicator that this
2168 * instance is or is not the primary instance of the application. See
2169 * g_application_get_is_remote() for that.
2171 * Returns: %TRUE if registration succeeded
2176 g_application_register (GApplication *application,
2177 GCancellable *cancellable,
2180 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2182 if (!application->priv->is_registered)
2184 if (application->priv->id == NULL)
2185 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
2187 application->priv->impl =
2188 g_application_impl_register (application, application->priv->id,
2189 application->priv->flags,
2190 application->priv->actions,
2191 &application->priv->remote_actions,
2192 cancellable, error);
2194 if (application->priv->impl == NULL)
2197 application->priv->is_remote = application->priv->remote_actions != NULL;
2198 application->priv->is_registered = TRUE;
2200 g_object_notify (G_OBJECT (application), "is-registered");
2202 if (!application->priv->is_remote)
2204 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
2206 if (!application->priv->did_startup)
2207 g_critical ("GApplication subclass '%s' failed to chain up on"
2208 " ::startup (from start of override function)",
2209 G_OBJECT_TYPE_NAME (application));
2216 /* Hold/release {{{1 */
2218 * g_application_hold:
2219 * @application: a #GApplication
2221 * Increases the use count of @application.
2223 * Use this function to indicate that the application has a reason to
2224 * continue to run. For example, g_application_hold() is called by GTK+
2225 * when a toplevel window is on the screen.
2227 * To cancel the hold, call g_application_release().
2230 g_application_hold (GApplication *application)
2232 g_return_if_fail (G_IS_APPLICATION (application));
2234 if (application->priv->inactivity_timeout_id)
2236 g_source_remove (application->priv->inactivity_timeout_id);
2237 application->priv->inactivity_timeout_id = 0;
2240 application->priv->use_count++;
2244 inactivity_timeout_expired (gpointer data)
2246 GApplication *application = G_APPLICATION (data);
2248 application->priv->inactivity_timeout_id = 0;
2250 return G_SOURCE_REMOVE;
2255 * g_application_release:
2256 * @application: a #GApplication
2258 * Decrease the use count of @application.
2260 * When the use count reaches zero, the application will stop running.
2262 * Never call this function except to cancel the effect of a previous
2263 * call to g_application_hold().
2266 g_application_release (GApplication *application)
2268 g_return_if_fail (G_IS_APPLICATION (application));
2269 g_return_if_fail (application->priv->use_count > 0);
2271 application->priv->use_count--;
2273 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
2274 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
2275 inactivity_timeout_expired, application);
2278 /* Activate, Open {{{1 */
2280 * g_application_activate:
2281 * @application: a #GApplication
2283 * Activates the application.
2285 * In essence, this results in the #GApplication::activate signal being
2286 * emitted in the primary instance.
2288 * The application must be registered before calling this function.
2293 g_application_activate (GApplication *application)
2295 g_return_if_fail (G_IS_APPLICATION (application));
2296 g_return_if_fail (application->priv->is_registered);
2298 if (application->priv->is_remote)
2299 g_application_impl_activate (application->priv->impl,
2300 get_platform_data (application, NULL));
2303 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
2307 * g_application_open:
2308 * @application: a #GApplication
2309 * @files: (array length=n_files): an array of #GFiles to open
2310 * @n_files: the length of the @files array
2311 * @hint: a hint (or ""), but never %NULL
2313 * Opens the given files.
2315 * In essence, this results in the #GApplication::open signal being emitted
2316 * in the primary instance.
2318 * @n_files must be greater than zero.
2320 * @hint is simply passed through to the ::open signal. It is
2321 * intended to be used by applications that have multiple modes for
2322 * opening files (eg: "view" vs "edit", etc). Unless you have a need
2323 * for this functionality, you should use "".
2325 * The application must be registered before calling this function
2326 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
2331 g_application_open (GApplication *application,
2336 g_return_if_fail (G_IS_APPLICATION (application));
2337 g_return_if_fail (application->priv->flags &
2338 G_APPLICATION_HANDLES_OPEN);
2339 g_return_if_fail (application->priv->is_registered);
2341 if (application->priv->is_remote)
2342 g_application_impl_open (application->priv->impl,
2343 files, n_files, hint,
2344 get_platform_data (application, NULL));
2347 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
2348 0, files, n_files, hint);
2353 * g_application_run:
2354 * @application: a #GApplication
2355 * @argc: the argc from main() (or 0 if @argv is %NULL)
2356 * @argv: (array length=argc) (element-type filename) (nullable):
2357 * the argv from main(), or %NULL
2359 * Runs the application.
2361 * This function is intended to be run from main() and its return value
2362 * is intended to be returned by main(). Although you are expected to pass
2363 * the @argc, @argv parameters from main() to this function, it is possible
2364 * to pass %NULL if @argv is not available or commandline handling is not
2365 * required. Note that on Windows, @argc and @argv are ignored, and
2366 * g_win32_get_command_line() is called internally (for proper support
2367 * of Unicode commandline arguments).
2369 * #GApplication will attempt to parse the commandline arguments. You
2370 * can add commandline flags to the list of recognised options by way of
2371 * g_application_add_main_option_entries(). After this, the
2372 * #GApplication::handle-local-options signal is emitted, from which the
2373 * application can inspect the values of its #GOptionEntrys.
2375 * #GApplication::handle-local-options is a good place to handle options
2376 * such as `--version`, where an immediate reply from the local process is
2377 * desired (instead of communicating with an already-running instance).
2378 * A #GApplication::handle-local-options handler can stop further processing
2379 * by returning a non-negative value, which then becomes the exit status of
2382 * What happens next depends on the flags: if
2383 * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
2384 * commandline arguments are sent to the primary instance, where a
2385 * #GApplication::command-line signal is emitted. Otherwise, the
2386 * remaining commandline arguments are assumed to be a list of files.
2387 * If there are no files listed, the application is activated via the
2388 * #GApplication::activate signal. If there are one or more files, and
2389 * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
2390 * via the #GApplication::open signal.
2392 * If you are interested in doing more complicated local handling of the
2393 * commandline then you should implement your own #GApplication subclass
2394 * and override local_command_line(). In this case, you most likely want
2395 * to return %TRUE from your local_command_line() implementation to
2396 * suppress the default handling. See
2397 * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
2400 * If, after the above is done, the use count of the application is zero
2401 * then the exit status is returned immediately. If the use count is
2402 * non-zero then the default main context is iterated until the use count
2403 * falls to zero, at which point 0 is returned.
2405 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
2406 * run for as much as 10 seconds with a use count of zero while waiting
2407 * for the message that caused the activation to arrive. After that,
2408 * if the use count falls to zero the application will exit immediately,
2409 * except in the case that g_application_set_inactivity_timeout() is in
2412 * This function sets the prgname (g_set_prgname()), if not already set,
2413 * to the basename of argv[0].
2415 * Much like g_main_loop_run(), this function will acquire the main context
2416 * for the duration that the application is running.
2418 * Since 2.40, applications that are not explicitly flagged as services
2419 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
2420 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
2421 * default handler for local_command_line) if "--gapplication-service"
2422 * was given in the command line. If this flag is present then normal
2423 * commandline processing is interrupted and the
2424 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise"
2425 * solution whereby running an application directly from the commandline
2426 * will invoke it in the normal way (which can be useful for debugging)
2427 * while still allowing applications to be D-Bus activated in service
2428 * mode. The D-Bus service file should invoke the executable with
2429 * "--gapplication-service" as the sole commandline argument. This
2430 * approach is suitable for use by most graphical applications but
2431 * should not be used from applications like editors that need precise
2432 * control over when processes invoked via the commandline will exit and
2433 * what their exit status will be.
2435 * Returns: the exit status
2440 g_application_run (GApplication *application,
2446 GMainContext *context;
2447 gboolean acquired_context;
2449 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
2450 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
2451 g_return_val_if_fail (!application->priv->must_quit_now, 1);
2457 arguments = g_win32_get_command_line ();
2460 * CommandLineToArgvW(), which is called by g_win32_get_command_line(),
2461 * pulls in the whole command line that is used to call the program. This is
2462 * fine in cases where the program is a .exe program, but in the cases where the
2463 * program is a called via a script, such as PyGObject's gtk-demo.py, which is normally
2464 * called using 'python gtk-demo.py' on Windows, the program name (argv[0])
2465 * returned by g_win32_get_command_line() will not be the argv[0] that ->local_command_line()
2466 * would expect, causing the program to fail with "This application can not open files."
2468 new_argc = g_strv_length (arguments);
2470 if (new_argc > argc)
2474 for (i = 0; i < new_argc - argc; i++)
2475 g_free (arguments[i]);
2477 memmove (&arguments[0],
2478 &arguments[new_argc - argc],
2479 sizeof (arguments[0]) * (argc + 1));
2482 #elif defined(__APPLE__)
2487 * OSX adds an unexpected parameter on the format -psn_X_XXXXXX
2488 * when opening the application using Launch Services. In order
2489 * to avoid that GOption fails to parse this parameter we just
2490 * skip it if it was provided.
2491 * See: https://gitlab.gnome.org/GNOME/glib/issues/1784
2493 arguments = g_new (gchar *, argc + 1);
2494 for (i = 0, j = 0; i < argc; i++)
2496 if (!g_str_has_prefix (argv[i], "-psn_"))
2498 arguments[j] = g_strdup (argv[i]);
2502 arguments[j] = NULL;
2508 arguments = g_new (gchar *, argc + 1);
2509 for (i = 0; i < argc; i++)
2510 arguments[i] = g_strdup (argv[i]);
2511 arguments[i] = NULL;
2515 if (g_get_prgname () == NULL && argc > 0)
2519 prgname = g_path_get_basename (argv[0]);
2520 g_set_prgname (prgname);
2524 context = g_main_context_default ();
2525 acquired_context = g_main_context_acquire (context);
2526 g_return_val_if_fail (acquired_context, 0);
2528 if (!G_APPLICATION_GET_CLASS (application)
2529 ->local_command_line (application, &arguments, &status))
2531 GError *error = NULL;
2533 if (!g_application_register (application, NULL, &error))
2535 g_printerr ("Failed to register: %s\n", error->message);
2536 g_error_free (error);
2540 g_application_call_command_line (application, (const gchar **) arguments, NULL, &status);
2543 g_strfreev (arguments);
2545 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
2546 application->priv->is_registered &&
2547 !application->priv->use_count &&
2548 !application->priv->inactivity_timeout_id)
2550 application->priv->inactivity_timeout_id =
2551 g_timeout_add (10000, inactivity_timeout_expired, application);
2554 while (application->priv->use_count || application->priv->inactivity_timeout_id)
2556 if (application->priv->must_quit_now)
2559 g_main_context_iteration (context, TRUE);
2563 if (application->priv->is_registered && !application->priv->is_remote)
2565 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
2567 if (!application->priv->did_shutdown)
2568 g_critical ("GApplication subclass '%s' failed to chain up on"
2569 " ::shutdown (from end of override function)",
2570 G_OBJECT_TYPE_NAME (application));
2573 if (application->priv->impl)
2575 g_application_impl_flush (application->priv->impl);
2576 g_application_impl_destroy (application->priv->impl);
2577 application->priv->impl = NULL;
2582 if (!application->priv->must_quit_now)
2583 while (g_main_context_iteration (context, FALSE))
2586 g_main_context_release (context);
2592 g_application_list_actions (GActionGroup *action_group)
2594 GApplication *application = G_APPLICATION (action_group);
2596 g_return_val_if_fail (application->priv->is_registered, NULL);
2598 if (application->priv->remote_actions != NULL)
2599 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
2601 else if (application->priv->actions != NULL)
2602 return g_action_group_list_actions (application->priv->actions);
2605 /* empty string array */
2606 return g_new0 (gchar *, 1);
2610 g_application_query_action (GActionGroup *group,
2611 const gchar *action_name,
2613 const GVariantType **parameter_type,
2614 const GVariantType **state_type,
2615 GVariant **state_hint,
2618 GApplication *application = G_APPLICATION (group);
2620 g_return_val_if_fail (application->priv->is_registered, FALSE);
2622 if (application->priv->remote_actions != NULL)
2623 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
2631 if (application->priv->actions != NULL)
2632 return g_action_group_query_action (application->priv->actions,
2644 g_application_change_action_state (GActionGroup *action_group,
2645 const gchar *action_name,
2648 GApplication *application = G_APPLICATION (action_group);
2650 g_return_if_fail (application->priv->is_remote ||
2651 application->priv->actions != NULL);
2652 g_return_if_fail (application->priv->is_registered);
2654 if (application->priv->remote_actions)
2655 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
2656 action_name, value, get_platform_data (application, NULL));
2659 g_action_group_change_action_state (application->priv->actions, action_name, value);
2663 g_application_activate_action (GActionGroup *action_group,
2664 const gchar *action_name,
2665 GVariant *parameter)
2667 GApplication *application = G_APPLICATION (action_group);
2669 g_return_if_fail (application->priv->is_remote ||
2670 application->priv->actions != NULL);
2671 g_return_if_fail (application->priv->is_registered);
2673 if (application->priv->remote_actions)
2674 g_remote_action_group_activate_action_full (application->priv->remote_actions,
2675 action_name, parameter, get_platform_data (application, NULL));
2678 g_action_group_activate_action (application->priv->actions, action_name, parameter);
2682 g_application_lookup_action (GActionMap *action_map,
2683 const gchar *action_name)
2685 GApplication *application = G_APPLICATION (action_map);
2687 g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
2689 return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
2693 g_application_add_action (GActionMap *action_map,
2696 GApplication *application = G_APPLICATION (action_map);
2698 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2700 g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
2704 g_application_remove_action (GActionMap *action_map,
2705 const gchar *action_name)
2707 GApplication *application = G_APPLICATION (action_map);
2709 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2711 g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
2715 g_application_action_group_iface_init (GActionGroupInterface *iface)
2717 iface->list_actions = g_application_list_actions;
2718 iface->query_action = g_application_query_action;
2719 iface->change_action_state = g_application_change_action_state;
2720 iface->activate_action = g_application_activate_action;
2724 g_application_action_map_iface_init (GActionMapInterface *iface)
2726 iface->lookup_action = g_application_lookup_action;
2727 iface->add_action = g_application_add_action;
2728 iface->remove_action = g_application_remove_action;
2731 /* Default Application {{{1 */
2733 static GApplication *default_app;
2736 * g_application_get_default:
2738 * Returns the default #GApplication instance for this process.
2740 * Normally there is only one #GApplication per process and it becomes
2741 * the default when it is created. You can exercise more control over
2742 * this by using g_application_set_default().
2744 * If there is no default application then %NULL is returned.
2746 * Returns: (transfer none): the default application for this process, or %NULL
2751 g_application_get_default (void)
2757 * g_application_set_default:
2758 * @application: (nullable): the application to set as default, or %NULL
2760 * Sets or unsets the default application for the process, as returned
2761 * by g_application_get_default().
2763 * This function does not take its own reference on @application. If
2764 * @application is destroyed then the default application will revert
2770 g_application_set_default (GApplication *application)
2772 default_app = application;
2776 * g_application_quit:
2777 * @application: a #GApplication
2779 * Immediately quits the application.
2781 * Upon return to the mainloop, g_application_run() will return,
2782 * calling only the 'shutdown' function before doing so.
2784 * The hold count is ignored.
2785 * Take care if your code has called g_application_hold() on the application and
2786 * is therefore still expecting it to exist.
2787 * (Note that you may have called g_application_hold() indirectly, for example
2788 * through gtk_application_add_window().)
2790 * The result of calling g_application_run() again after it returns is
2796 g_application_quit (GApplication *application)
2798 g_return_if_fail (G_IS_APPLICATION (application));
2800 application->priv->must_quit_now = TRUE;
2804 * g_application_mark_busy:
2805 * @application: a #GApplication
2807 * Increases the busy count of @application.
2809 * Use this function to indicate that the application is busy, for instance
2810 * while a long running operation is pending.
2812 * The busy state will be exposed to other processes, so a session shell will
2813 * use that information to indicate the state to the user (e.g. with a
2816 * To cancel the busy indication, use g_application_unmark_busy().
2821 g_application_mark_busy (GApplication *application)
2825 g_return_if_fail (G_IS_APPLICATION (application));
2827 was_busy = (application->priv->busy_count > 0);
2828 application->priv->busy_count++;
2832 g_application_impl_set_busy_state (application->priv->impl, TRUE);
2833 g_object_notify (G_OBJECT (application), "is-busy");
2838 * g_application_unmark_busy:
2839 * @application: a #GApplication
2841 * Decreases the busy count of @application.
2843 * When the busy count reaches zero, the new state will be propagated
2844 * to other processes.
2846 * This function must only be called to cancel the effect of a previous
2847 * call to g_application_mark_busy().
2852 g_application_unmark_busy (GApplication *application)
2854 g_return_if_fail (G_IS_APPLICATION (application));
2855 g_return_if_fail (application->priv->busy_count > 0);
2857 application->priv->busy_count--;
2859 if (application->priv->busy_count == 0)
2861 g_application_impl_set_busy_state (application->priv->impl, FALSE);
2862 g_object_notify (G_OBJECT (application), "is-busy");
2867 * g_application_get_is_busy:
2868 * @application: a #GApplication
2870 * Gets the application's current busy state, as set through
2871 * g_application_mark_busy() or g_application_bind_busy_property().
2873 * Returns: %TRUE if @application is currently marked as busy
2878 g_application_get_is_busy (GApplication *application)
2880 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2882 return application->priv->busy_count > 0;
2885 /* Notifications {{{1 */
2888 * g_application_send_notification:
2889 * @application: a #GApplication
2890 * @id: (nullable): id of the notification, or %NULL
2891 * @notification: the #GNotification to send
2893 * Sends a notification on behalf of @application to the desktop shell.
2894 * There is no guarantee that the notification is displayed immediately,
2897 * Notifications may persist after the application exits. It will be
2898 * D-Bus-activated when the notification or one of its actions is
2901 * Modifying @notification after this call has no effect. However, the
2902 * object can be reused for a later call to this function.
2904 * @id may be any string that uniquely identifies the event for the
2905 * application. It does not need to be in any special format. For
2906 * example, "new-message" might be appropriate for a notification about
2909 * If a previous notification was sent with the same @id, it will be
2910 * replaced with @notification and shown again as if it was a new
2911 * notification. This works even for notifications sent from a previous
2912 * execution of the application, as long as @id is the same string.
2914 * @id may be %NULL, but it is impossible to replace or withdraw
2915 * notifications without an id.
2917 * If @notification is no longer relevant, it can be withdrawn with
2918 * g_application_withdraw_notification().
2923 g_application_send_notification (GApplication *application,
2925 GNotification *notification)
2927 gchar *generated_id = NULL;
2929 g_return_if_fail (G_IS_APPLICATION (application));
2930 g_return_if_fail (G_IS_NOTIFICATION (notification));
2931 g_return_if_fail (g_application_get_is_registered (application));
2932 g_return_if_fail (!g_application_get_is_remote (application));
2934 if (application->priv->notifications == NULL)
2935 application->priv->notifications = g_notification_backend_new_default (application);
2939 generated_id = g_dbus_generate_guid ();
2943 g_notification_backend_send_notification (application->priv->notifications, id, notification);
2945 g_free (generated_id);
2949 * g_application_withdraw_notification:
2950 * @application: a #GApplication
2951 * @id: id of a previously sent notification
2953 * Withdraws a notification that was sent with
2954 * g_application_send_notification().
2956 * This call does nothing if a notification with @id doesn't exist or
2957 * the notification was never sent.
2959 * This function works even for notifications sent in previous
2960 * executions of this application, as long @id is the same as it was for
2961 * the sent notification.
2963 * Note that notifications are dismissed when the user clicks on one
2964 * of the buttons in a notification or triggers its default action, so
2965 * there is no need to explicitly withdraw the notification in that case.
2970 g_application_withdraw_notification (GApplication *application,
2973 g_return_if_fail (G_IS_APPLICATION (application));
2974 g_return_if_fail (id != NULL);
2976 if (application->priv->notifications == NULL)
2977 application->priv->notifications = g_notification_backend_new_default (application);
2979 g_notification_backend_withdraw_notification (application->priv->notifications, id);
2982 /* Busy binding {{{1 */
2988 } GApplicationBusyBinding;
2991 g_application_busy_binding_destroy (gpointer data,
2994 GApplicationBusyBinding *binding = data;
2996 if (binding->is_busy)
2997 g_application_unmark_busy (binding->app);
2999 g_object_unref (binding->app);
3000 g_slice_free (GApplicationBusyBinding, binding);
3004 g_application_notify_busy_binding (GObject *object,
3008 GApplicationBusyBinding *binding = user_data;
3011 g_object_get (object, pspec->name, &is_busy, NULL);
3013 if (is_busy && !binding->is_busy)
3014 g_application_mark_busy (binding->app);
3015 else if (!is_busy && binding->is_busy)
3016 g_application_unmark_busy (binding->app);
3018 binding->is_busy = is_busy;
3022 * g_application_bind_busy_property:
3023 * @application: a #GApplication
3024 * @object: (type GObject.Object): a #GObject
3025 * @property: the name of a boolean property of @object
3027 * Marks @application as busy (see g_application_mark_busy()) while
3028 * @property on @object is %TRUE.
3030 * The binding holds a reference to @application while it is active, but
3031 * not to @object. Instead, the binding is destroyed when @object is
3037 g_application_bind_busy_property (GApplication *application,
3039 const gchar *property)
3042 GQuark property_quark;
3044 GApplicationBusyBinding *binding;
3047 g_return_if_fail (G_IS_APPLICATION (application));
3048 g_return_if_fail (G_IS_OBJECT (object));
3049 g_return_if_fail (property != NULL);
3051 notify_id = g_signal_lookup ("notify", G_TYPE_OBJECT);
3052 property_quark = g_quark_from_string (property);
3053 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
3055 g_return_if_fail (pspec != NULL && pspec->value_type == G_TYPE_BOOLEAN);
3057 if (g_signal_handler_find (object, G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
3058 notify_id, property_quark, NULL, g_application_notify_busy_binding, NULL) > 0)
3060 g_critical ("%s: '%s' is already bound to the busy state of the application", G_STRFUNC, property);
3064 binding = g_slice_new (GApplicationBusyBinding);
3065 binding->app = g_object_ref (application);
3066 binding->is_busy = FALSE;
3068 closure = g_cclosure_new (G_CALLBACK (g_application_notify_busy_binding), binding,
3069 g_application_busy_binding_destroy);
3070 g_signal_connect_closure_by_id (object, notify_id, property_quark, closure, FALSE);
3072 /* fetch the initial value */
3073 g_application_notify_busy_binding (object, pspec, binding);
3077 * g_application_unbind_busy_property:
3078 * @application: a #GApplication
3079 * @object: (type GObject.Object): a #GObject
3080 * @property: the name of a boolean property of @object
3082 * Destroys a binding between @property and the busy state of
3083 * @application that was previously created with
3084 * g_application_bind_busy_property().
3089 g_application_unbind_busy_property (GApplication *application,
3091 const gchar *property)
3094 GQuark property_quark;
3097 g_return_if_fail (G_IS_APPLICATION (application));
3098 g_return_if_fail (G_IS_OBJECT (object));
3099 g_return_if_fail (property != NULL);
3101 notify_id = g_signal_lookup ("notify", G_TYPE_OBJECT);
3102 property_quark = g_quark_from_string (property);
3104 handler_id = g_signal_handler_find (object, G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
3105 notify_id, property_quark, NULL, g_application_notify_busy_binding, NULL);
3106 if (handler_id == 0)
3108 g_critical ("%s: '%s' is not bound to the busy state of the application", G_STRFUNC, property);
3112 g_signal_handler_disconnect (object, handler_id);
3116 /* vim:set foldmethod=marker: */