2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 * Authors: Ryan Lortie <desrt@desrt.ca>
23 #include "gapplication.h"
25 #include "gapplicationcommandline.h"
26 #include "gsimpleactiongroup.h"
27 #include "gremoteactiongroup.h"
28 #include "gapplicationimpl.h"
29 #include "gactiongroup.h"
30 #include "gactionmap.h"
31 #include "gmenumodel.h"
32 #include "gsettings.h"
33 #include "gnotification-private.h"
34 #include "gnotificationbackend.h"
35 #include "gdbusutils.h"
37 #include "gioenumtypes.h"
46 * SECTION:gapplication
47 * @title: GApplication
48 * @short_description: Core application class
51 * A #GApplication is the foundation of an application. It wraps some
52 * low-level platform-specific services and is intended to act as the
53 * foundation for higher-level application classes such as
54 * #GtkApplication or #MxApplication. In general, you should not use
55 * this class outside of a higher level framework.
57 * GApplication provides convenient life cycle management by maintaining
58 * a "use count" for the primary application instance. The use count can
59 * be changed using g_application_hold() and g_application_release(). If
60 * it drops to zero, the application exits. Higher-level classes such as
61 * #GtkApplication employ the use count to ensure that the application
62 * stays alive as long as it has any opened windows.
64 * Another feature that GApplication (optionally) provides is process
65 * uniqueness. Applications can make use of this functionality by
66 * providing a unique application ID. If given, only one application
67 * with this ID can be running at a time per session. The session
68 * concept is platform-dependent, but corresponds roughly to a graphical
69 * desktop login. When your application is launched again, its
70 * arguments are passed through platform communication to the already
71 * running program. The already running instance of the program is
72 * called the "primary instance"; for non-unique applications this is
73 * the always the current instance. On Linux, the D-Bus session bus
74 * is used for communication.
76 * The use of #GApplication differs from some other commonly-used
77 * uniqueness libraries (such as libunique) in important ways. The
78 * application is not expected to manually register itself and check
79 * if it is the primary instance. Instead, the main() function of a
80 * #GApplication should do very little more than instantiating the
81 * application instance, possibly connecting signal handlers, then
82 * calling g_application_run(). All checks for uniqueness are done
83 * internally. If the application is the primary instance then the
84 * startup signal is emitted and the mainloop runs. If the application
85 * is not the primary instance then a signal is sent to the primary
86 * instance and g_application_run() promptly returns. See the code
89 * If used, the expected form of an application identifier is very close
91 * [DBus bus name](http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface).
92 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
93 * For details on valid application identifiers, see g_application_id_is_valid().
95 * On Linux, the application identifier is claimed as a well-known bus name
96 * on the user's session bus. This means that the uniqueness of your
97 * application is scoped to the current session. It also means that your
98 * application may provide additional services (through registration of other
99 * object paths) at that bus name. The registration of these object paths
100 * should be done with the shared GDBus session bus. Note that due to the
101 * internal architecture of GDBus, method calls can be dispatched at any time
102 * (even if a main loop is not running). For this reason, you must ensure that
103 * any object paths that you wish to register are registered before #GApplication
104 * attempts to acquire the bus name of your application (which happens in
105 * g_application_register()). Unfortunately, this means that you cannot use
106 * g_application_get_is_remote() to decide if you want to register object paths.
108 * GApplication also implements the #GActionGroup and #GActionMap
109 * interfaces and lets you easily export actions by adding them with
110 * g_action_map_add_action(). When invoking an action by calling
111 * g_action_group_activate_action() on the application, it is always
112 * invoked in the primary instance. The actions are also exported on
113 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
114 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
115 * for remote access to exported #GMenuModels.
117 * There is a number of different entry points into a GApplication:
119 * - via 'Activate' (i.e. just starting the application)
121 * - via 'Open' (i.e. opening some files)
123 * - by handling a command-line
125 * - via activating an action
127 * The #GApplication::startup signal lets you handle the application
128 * initialization for all of these in a single place.
130 * Regardless of which of these entry points is used to start the
131 * application, GApplication passes some "platform data from the
132 * launching instance to the primary instance, in the form of a
133 * #GVariant dictionary mapping strings to variants. To use platform
134 * data, override the @before_emit or @after_emit virtual functions
135 * in your #GApplication subclass. When dealing with
136 * #GApplicationCommandLine objects, the platform data is
137 * directly available via g_application_command_line_get_cwd(),
138 * g_application_command_line_get_environ() and
139 * g_application_command_line_get_platform_data().
141 * As the name indicates, the platform data may vary depending on the
142 * operating system, but it always includes the current directory (key
143 * "cwd"), and optionally the environment (ie the set of environment
144 * variables and their values) of the calling process (key "environ").
145 * The environment is only added to the platform data if the
146 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
147 * can add their own platform data by overriding the @add_platform_data
148 * virtual function. For instance, #GtkApplication adds startup notification
151 * To parse commandline arguments you may handle the
152 * #GApplication::command-line signal or override the local_command_line()
153 * vfunc, to parse them in either the primary instance or the local instance,
156 * For an example of opening files with a GApplication, see
157 * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c).
159 * For an example of using actions with GApplication, see
160 * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c).
162 * For an example of using extra D-Bus hooks with GApplication, see
163 * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
168 * @startup: invoked on the primary instance immediately after registration
169 * @shutdown: invoked only on the registered primary instance immediately
170 * after the main loop terminates
171 * @activate: invoked on the primary instance when an activation occurs
172 * @open: invoked on the primary instance when there are files to open
173 * @command_line: invoked on the primary instance when a command-line is
174 * not handled locally
175 * @local_command_line: invoked (locally) when the process has been invoked
176 * via commandline execution (as opposed to, say, D-Bus activation - which
177 * is not currently supported by GApplication). The virtual function has
178 * the chance to inspect (and possibly replace) the list of command line
179 * arguments. See g_application_run() for more information.
180 * @before_emit: invoked on the primary instance before 'activate', 'open',
181 * 'command-line' or any action invocation, gets the 'platform data' from
182 * the calling instance
183 * @after_emit: invoked on the primary instance after 'activate', 'open',
184 * 'command-line' or any action invocation, gets the 'platform data' from
185 * the calling instance
186 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
187 * the primary instance when activating, opening or invoking actions
188 * @quit_mainloop: Used to be invoked on the primary instance when the use
189 * count of the application drops to zero (and after any inactivity
190 * timeout, if requested). Not used anymore since 2.32
191 * @run_mainloop: Used to be invoked on the primary instance from
192 * g_application_run() if the use-count is non-zero. Since 2.32,
193 * GApplication is iterating the main context directly and is not
194 * using @run_mainloop anymore
195 * @dbus_register: invoked locally during registration, if the application is
196 * using its D-Bus backend. You can use this to export extra objects on the
197 * bus, that need to exist before the application tries to own the bus name.
198 * The function is passed the #GDBusConnection to to session bus, and the
199 * object path that #GApplication will use to export is D-Bus API.
200 * If this function returns %TRUE, registration will proceed; otherwise
201 * registration will abort. Since: 2.34
202 * @dbus_unregister: invoked locally during unregistration, if the application
203 * is using its D-Bus backend. Use this to undo anything done by the
204 * @dbus_register vfunc. Since: 2.34
206 * Virtual function table for #GApplication.
211 struct _GApplicationPrivate
213 GApplicationFlags flags;
216 GActionGroup *actions;
217 GMenuModel *app_menu;
220 guint inactivity_timeout_id;
221 guint inactivity_timeout;
225 guint is_registered : 1;
227 guint did_startup : 1;
228 guint did_shutdown : 1;
229 guint must_quit_now : 1;
231 GRemoteActionGroup *remote_actions;
232 GApplicationImpl *impl;
234 GNotificationBackend *notifications;
236 /* GOptionContext support */
237 GOptionGroup *main_options;
238 GSList *option_groups;
239 GHashTable *packed_options;
240 gboolean options_parsed;
250 PROP_INACTIVITY_TIMEOUT,
262 SIGNAL_HANDLE_LOCAL_OPTIONS,
266 static guint g_application_signals[NR_SIGNALS];
268 static void g_application_action_group_iface_init (GActionGroupInterface *);
269 static void g_application_action_map_iface_init (GActionMapInterface *);
270 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
271 G_ADD_PRIVATE (GApplication)
272 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
273 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
275 /* GApplicationExportedActions {{{1 */
277 /* We create a subclass of GSimpleActionGroup that implements
278 * GRemoteActionGroup and deals with the platform data using
279 * GApplication's before/after_emit vfuncs. This is the action group we
282 * We could implement GRemoteActionGroup on GApplication directly, but
283 * this would be potentially extremely confusing to have exposed as part
284 * of the public API of GApplication. We certainly don't want anyone in
285 * the same process to be calling these APIs...
287 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
290 GSimpleActionGroup parent_instance;
291 GApplication *application;
292 } GApplicationExportedActions;
294 static GType g_application_exported_actions_get_type (void);
295 static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
296 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
297 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
300 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
301 const gchar *action_name,
303 GVariant *platform_data)
305 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
307 G_APPLICATION_GET_CLASS (exported->application)
308 ->before_emit (exported->application, platform_data);
310 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
312 G_APPLICATION_GET_CLASS (exported->application)
313 ->after_emit (exported->application, platform_data);
317 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
318 const gchar *action_name,
320 GVariant *platform_data)
322 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
324 G_APPLICATION_GET_CLASS (exported->application)
325 ->before_emit (exported->application, platform_data);
327 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
329 G_APPLICATION_GET_CLASS (exported->application)
330 ->after_emit (exported->application, platform_data);
334 g_application_exported_actions_init (GApplicationExportedActions *actions)
339 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
341 iface->activate_action_full = g_application_exported_actions_activate_action_full;
342 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
346 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
350 static GActionGroup *
351 g_application_exported_actions_new (GApplication *application)
353 GApplicationExportedActions *actions;
355 actions = g_object_new (g_application_exported_actions_get_type (), NULL);
356 actions->application = application;
358 return G_ACTION_GROUP (actions);
361 /* Command line option handling {{{1 */
364 free_option_entry (gpointer data)
366 GOptionEntry *entry = data;
370 case G_OPTION_ARG_STRING:
371 case G_OPTION_ARG_FILENAME:
372 g_free (*(gchar **) entry->arg_data);
375 case G_OPTION_ARG_STRING_ARRAY:
376 case G_OPTION_ARG_FILENAME_ARRAY:
377 g_strfreev (*(gchar ***) entry->arg_data);
381 /* most things require no free... */
385 /* ...except for the space that we allocated for it ourselves */
386 g_free (entry->arg_data);
388 g_slice_free (GOptionEntry, entry);
392 g_application_pack_option_entries (GApplication *application,
398 g_hash_table_iter_init (&iter, application->priv->packed_options);
399 while (g_hash_table_iter_next (&iter, NULL, &item))
401 GOptionEntry *entry = item;
402 GVariant *value = NULL;
406 case G_OPTION_ARG_NONE:
407 if (*(gboolean *) entry->arg_data != 2)
408 value = g_variant_new_boolean (*(gboolean *) entry->arg_data);
411 case G_OPTION_ARG_STRING:
412 if (*(gchar **) entry->arg_data)
413 value = g_variant_new_string (*(gchar **) entry->arg_data);
416 case G_OPTION_ARG_INT:
417 if (*(gint32 *) entry->arg_data)
418 value = g_variant_new_int32 (*(gint32 *) entry->arg_data);
421 case G_OPTION_ARG_FILENAME:
422 if (*(gchar **) entry->arg_data)
423 value = g_variant_new_bytestring (*(gchar **) entry->arg_data);
426 case G_OPTION_ARG_STRING_ARRAY:
427 if (*(gchar ***) entry->arg_data)
428 value = g_variant_new_strv (*(const gchar ***) entry->arg_data, -1);
431 case G_OPTION_ARG_FILENAME_ARRAY:
432 if (*(gchar ***) entry->arg_data)
433 value = g_variant_new_bytestring_array (*(const gchar ***) entry->arg_data, -1);
436 case G_OPTION_ARG_DOUBLE:
437 if (*(gdouble *) entry->arg_data)
438 value = g_variant_new_double (*(gdouble *) entry->arg_data);
441 case G_OPTION_ARG_INT64:
442 if (*(gint64 *) entry->arg_data)
443 value = g_variant_new_int64 (*(gint64 *) entry->arg_data);
447 g_assert_not_reached ();
451 g_variant_dict_insert_value (dict, entry->long_name, value);
455 static GVariantDict *
456 g_application_parse_command_line (GApplication *application,
460 gboolean become_service = FALSE;
461 GVariantDict *dict = NULL;
462 GOptionContext *context;
464 /* Due to the memory management of GOptionGroup we can only parse
465 * options once. That's because once you add a group to the
466 * GOptionContext there is no way to get it back again. This is fine:
467 * local_command_line() should never get invoked more than once
468 * anyway. Add a sanity check just to be sure.
470 g_return_val_if_fail (!application->priv->options_parsed, NULL);
472 context = g_option_context_new (NULL);
474 /* Add the main option group, if it exists */
475 if (application->priv->main_options)
477 /* This consumes the main_options */
478 g_option_context_set_main_group (context, application->priv->main_options);
479 application->priv->main_options = NULL;
482 /* Add any other option groups if they exist. Adding them to the
483 * context will consume them, so we free the list as we go...
485 while (application->priv->option_groups)
487 g_option_context_add_group (context, application->priv->option_groups->data);
488 application->priv->option_groups = g_slist_delete_link (application->priv->option_groups,
489 application->priv->option_groups);
492 /* If the application has not registered local options and it has
493 * G_APPLICATION_HANDLES_COMMAND_LINE then we have to assume that
494 * their primary instance commandline handler may want to deal with
495 * the arguments. We must therefore ignore them.
497 if (application->priv->main_options == NULL && (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE))
498 g_option_context_set_ignore_unknown_options (context, TRUE);
500 /* In the case that we are not explicitly marked as a service or a
501 * launcher then we want to add the "--gapplication-service" option to
502 * allow the process to be made into a service.
504 if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
506 GOptionGroup *option_group;
507 GOptionEntry entries[] = {
508 { "gapplication-service", '\0', 0, G_OPTION_ARG_NONE, &become_service,
509 N_("Enter GApplication service mode (use from D-Bus service files)") },
513 option_group = g_option_group_new ("gapplication",
514 _("GApplication options"), _("Show GApplication options"),
516 g_option_group_set_translation_domain (option_group, GETTEXT_PACKAGE);
517 g_option_group_add_entries (option_group, entries);
519 g_option_context_add_group (context, option_group);
522 /* Now we parse... */
523 if (!g_option_context_parse_strv (context, arguments, error))
526 /* Check for --gapplication-service */
528 application->priv->flags |= G_APPLICATION_IS_SERVICE;
530 dict = g_variant_dict_new (NULL);
531 if (application->priv->packed_options)
533 g_application_pack_option_entries (application, dict);
534 g_hash_table_unref (application->priv->packed_options);
535 application->priv->packed_options = NULL;
539 /* Make sure we don't run again */
540 application->priv->options_parsed = TRUE;
542 g_option_context_free (context);
548 add_packed_option (GApplication *application,
553 case G_OPTION_ARG_NONE:
554 entry->arg_data = g_new (gboolean, 1);
555 *(gboolean *) entry->arg_data = 2;
558 case G_OPTION_ARG_INT:
559 entry->arg_data = g_new0 (gint, 1);
562 case G_OPTION_ARG_STRING:
563 case G_OPTION_ARG_FILENAME:
564 case G_OPTION_ARG_STRING_ARRAY:
565 case G_OPTION_ARG_FILENAME_ARRAY:
566 entry->arg_data = g_new0 (gpointer, 1);
569 case G_OPTION_ARG_INT64:
570 entry->arg_data = g_new0 (gint64, 1);
573 case G_OPTION_ARG_DOUBLE:
574 entry->arg_data = g_new0 (gdouble, 1);
578 g_return_if_reached ();
581 if (!application->priv->packed_options)
582 application->priv->packed_options = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, free_option_entry);
584 g_hash_table_insert (application->priv->packed_options,
585 g_strdup (entry->long_name),
586 g_slice_dup (GOptionEntry, entry));
590 * g_application_add_main_option_entries:
591 * @application: a #GApplication
592 * @entries: (array zero-terminated=1) (element-type GOptionEntry) a
593 * %NULL-terminated list of #GOptionEntrys
595 * Adds main option entries to be handled by @application.
597 * This function is comparable to g_option_context_add_main_entries().
599 * After the commandline arguments are parsed, the
600 * #GApplication::handle-local-options signal will be emitted. At this
601 * point, the application can inspect the values pointed to by @arg_data
602 * in the given #GOptionEntrys.
604 * Unlike #GOptionContext, #GApplication supports giving a %NULL
605 * @arg_data for a non-callback #GOptionEntry. This results in the
606 * argument in question being packed into a #GVariantDict which is also
607 * passed to #GApplication::handle-local-options, where it can be
608 * inspected and modified. If %G_APPLICATION_HANDLES_COMMAND_LINE is
609 * set, then the resulting dictionary is sent to the primary instance,
610 * where g_application_command_line_get_options_dict() will return it.
611 * This "packing" is done according to the type of the argument --
612 * booleans for normal flags, strings for strings, bytestrings for
613 * filenames, etc. The packing only occurs if the flag is given (ie: we
614 * do not pack a "false" #GVariant in the case that a flag is missing).
616 * In general, it is recommended that all commandline arguments are
617 * parsed locally. The options dictionary should then be used to
618 * transmit the result of the parsing to the primary instance, where
619 * g_variant_dict_lookup() can be used. For local options, it is
620 * possible to either use @arg_data in the usual way, or to consult (and
621 * potentially remove) the option from the options dictionary.
623 * This function is new in GLib 2.40. Before then, the only real choice
624 * was to send all of the commandline arguments (options and all) to the
625 * primary instance for handling. #GApplication ignored them completely
626 * on the local side. Calling this function "opts in" to the new
627 * behaviour, and in particular, means that unrecognised options will be
628 * treated as errors. Unrecognised options have never been ignored when
629 * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
631 * If #GApplication::handle-local-options needs to see the list of
632 * filenames, then the use of %G_OPTION_REMAINING is recommended. If
633 * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
634 * the options dictionary. If you do use %G_OPTION_REMAINING then you
635 * need to handle these arguments for yourself because once they are
636 * consumed, they will no longer be visible to the default handling
637 * (which treats them as filenames to be opened).
642 g_application_add_main_option_entries (GApplication *application,
643 const GOptionEntry *entries)
647 g_return_if_fail (G_IS_APPLICATION (application));
648 g_return_if_fail (entries != NULL);
650 if (!application->priv->main_options)
651 application->priv->main_options = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
653 for (i = 0; entries[i].long_name; i++)
655 GOptionEntry my_entries[2] = { entries[i], { NULL } };
657 if (!my_entries[0].arg_data)
658 add_packed_option (application, &my_entries[0]);
660 g_option_group_add_entries (application->priv->main_options, my_entries);
665 * g_application_add_option_group:
666 * @application: the #GApplication
667 * @group: a #GOptionGroup
669 * Adds a #GOptionGroup to the commandline handling of @application.
671 * This function is comparable to g_option_context_add_group().
673 * Unlike g_application_add_main_option_entries(), this function does
674 * not deal with %NULL @arg_data and never transmits options to the
677 * The reason for that is because, by the time the options arrive at the
678 * primary instance, it is typically too late to do anything with them.
679 * Taking the GTK option group as an example: GTK will already have been
680 * initialised by the time the #GApplication::command-line handler runs.
681 * In the case that this is not the first-running instance of the
682 * application, the existing instance may already have been running for
685 * This means that the options from #GOptionGroup are only really usable
686 * in the case that the instance of the application being run is the
687 * first instance. Passing options like `--display=` or `--gdk-debug=`
688 * on future runs will have no effect on the existing primary instance.
690 * Calling this function will cause the options in the supplied option
691 * group to be parsed, but it does not cause you to be "opted in" to the
692 * new functionality whereby unrecognised options are rejected even if
693 * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
698 g_application_add_option_group (GApplication *application,
701 g_return_if_fail (G_IS_APPLICATION (application));
702 g_return_if_fail (group != NULL);
704 application->priv->option_groups = g_slist_prepend (application->priv->option_groups, group);
707 /* vfunc defaults {{{1 */
709 g_application_real_before_emit (GApplication *application,
710 GVariant *platform_data)
715 g_application_real_after_emit (GApplication *application,
716 GVariant *platform_data)
721 g_application_real_startup (GApplication *application)
723 application->priv->did_startup = TRUE;
727 g_application_real_shutdown (GApplication *application)
729 application->priv->did_shutdown = TRUE;
733 g_application_real_activate (GApplication *application)
735 if (!g_signal_has_handler_pending (application,
736 g_application_signals[SIGNAL_ACTIVATE],
738 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
740 static gboolean warned;
745 g_warning ("Your application does not implement "
746 "g_application_activate() and has no handlers connected "
747 "to the 'activate' signal. It should do one of these.");
753 g_application_real_open (GApplication *application,
758 if (!g_signal_has_handler_pending (application,
759 g_application_signals[SIGNAL_OPEN],
761 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
763 static gboolean warned;
768 g_warning ("Your application claims to support opening files "
769 "but does not implement g_application_open() and has no "
770 "handlers connected to the 'open' signal.");
776 g_application_real_command_line (GApplication *application,
777 GApplicationCommandLine *cmdline)
779 if (!g_signal_has_handler_pending (application,
780 g_application_signals[SIGNAL_COMMAND_LINE],
782 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
784 static gboolean warned;
789 g_warning ("Your application claims to support custom command line "
790 "handling but does not implement g_application_command_line() "
791 "and has no handlers connected to the 'command-line' signal.");
800 g_application_real_handle_local_options (GApplication *application,
801 GVariantDict *options)
807 get_platform_data (GApplication *application,
810 GVariantBuilder *builder;
813 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
816 gchar *cwd = g_get_current_dir ();
817 g_variant_builder_add (builder, "{sv}", "cwd",
818 g_variant_new_bytestring (cwd));
822 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
827 envp = g_get_environ ();
828 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
831 g_variant_builder_add (builder, "{sv}", "environ", array);
835 g_variant_builder_add (builder, "{sv}", "options", options);
837 G_APPLICATION_GET_CLASS (application)->
838 add_platform_data (application, builder);
840 result = g_variant_builder_end (builder);
841 g_variant_builder_unref (builder);
847 g_application_call_command_line (GApplication *application,
848 const gchar * const *arguments,
852 if (application->priv->is_remote)
854 GVariant *platform_data;
856 platform_data = get_platform_data (application, options);
857 *exit_status = g_application_impl_command_line (application->priv->impl, arguments, platform_data);
861 GApplicationCommandLine *cmdline;
864 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
865 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
869 g_signal_emit (application, g_application_signals[SIGNAL_COMMAND_LINE], 0, cmdline, exit_status);
870 g_object_unref (cmdline);
875 g_application_real_local_command_line (GApplication *application,
879 GError *error = NULL;
880 GVariantDict *options;
883 options = g_application_parse_command_line (application, arguments, &error);
886 g_printerr ("%s\n", error->message);
891 g_signal_emit (application, g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS], 0, options, exit_status);
893 if (*exit_status >= 0)
895 g_variant_dict_unref (options);
899 if (!g_application_register (application, NULL, &error))
901 g_printerr ("Failed to register: %s\n", error->message);
902 g_variant_dict_unref (options);
903 g_error_free (error);
908 n_args = g_strv_length (*arguments);
910 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
912 if ((*exit_status = n_args > 1))
914 g_printerr ("GApplication service mode takes no arguments.\n");
915 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
921 else if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
923 g_application_call_command_line (application,
924 (const gchar **) *arguments,
925 g_variant_dict_end (options),
932 g_application_activate (application);
938 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
940 g_critical ("This application can not open files.");
949 n_files = n_args - 1;
950 files = g_new (GFile *, n_files);
952 for (i = 0; i < n_files; i++)
953 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
955 g_application_open (application, files, n_files, "");
957 for (i = 0; i < n_files; i++)
958 g_object_unref (files[i]);
966 g_variant_dict_unref (options);
972 g_application_real_add_platform_data (GApplication *application,
973 GVariantBuilder *builder)
978 g_application_real_dbus_register (GApplication *application,
979 GDBusConnection *connection,
980 const gchar *object_path,
987 g_application_real_dbus_unregister (GApplication *application,
988 GDBusConnection *connection,
989 const gchar *object_path)
993 /* GObject implementation stuff {{{1 */
995 g_application_set_property (GObject *object,
1000 GApplication *application = G_APPLICATION (object);
1004 case PROP_APPLICATION_ID:
1005 g_application_set_application_id (application,
1006 g_value_get_string (value));
1010 g_application_set_flags (application, g_value_get_flags (value));
1013 case PROP_INACTIVITY_TIMEOUT:
1014 g_application_set_inactivity_timeout (application,
1015 g_value_get_uint (value));
1018 case PROP_ACTION_GROUP:
1019 g_clear_object (&application->priv->actions);
1020 application->priv->actions = g_value_dup_object (value);
1024 g_assert_not_reached ();
1029 * g_application_set_action_group:
1030 * @application: a #GApplication
1031 * @action_group: (allow-none): a #GActionGroup, or %NULL
1033 * This used to be how actions were associated with a #GApplication.
1034 * Now there is #GActionMap for that.
1038 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
1039 * mix use of this API with use of #GActionMap on the same @application
1040 * or things will go very badly wrong. This function is known to
1041 * introduce buggy behaviour (ie: signals not emitted on changes to the
1042 * action group), so you should really use #GActionMap instead.
1045 g_application_set_action_group (GApplication *application,
1046 GActionGroup *action_group)
1048 g_return_if_fail (G_IS_APPLICATION (application));
1049 g_return_if_fail (!application->priv->is_registered);
1051 if (application->priv->actions != NULL)
1052 g_object_unref (application->priv->actions);
1054 application->priv->actions = action_group;
1056 if (application->priv->actions != NULL)
1057 g_object_ref (application->priv->actions);
1061 g_application_get_property (GObject *object,
1066 GApplication *application = G_APPLICATION (object);
1070 case PROP_APPLICATION_ID:
1071 g_value_set_string (value,
1072 g_application_get_application_id (application));
1076 g_value_set_flags (value,
1077 g_application_get_flags (application));
1080 case PROP_IS_REGISTERED:
1081 g_value_set_boolean (value,
1082 g_application_get_is_registered (application));
1085 case PROP_IS_REMOTE:
1086 g_value_set_boolean (value,
1087 g_application_get_is_remote (application));
1090 case PROP_INACTIVITY_TIMEOUT:
1091 g_value_set_uint (value,
1092 g_application_get_inactivity_timeout (application));
1096 g_assert_not_reached ();
1101 g_application_constructed (GObject *object)
1103 GApplication *application = G_APPLICATION (object);
1105 if (g_application_get_default () == NULL)
1106 g_application_set_default (application);
1110 g_application_finalize (GObject *object)
1112 GApplication *application = G_APPLICATION (object);
1114 g_slist_free_full (application->priv->option_groups, (GDestroyNotify) g_option_group_free);
1115 if (application->priv->main_options)
1116 g_option_group_free (application->priv->main_options);
1117 if (application->priv->packed_options)
1118 g_hash_table_unref (application->priv->packed_options);
1120 if (application->priv->impl)
1121 g_application_impl_destroy (application->priv->impl);
1122 g_free (application->priv->id);
1124 if (g_application_get_default () == application)
1125 g_application_set_default (NULL);
1127 if (application->priv->actions)
1128 g_object_unref (application->priv->actions);
1130 if (application->priv->notifications)
1131 g_object_unref (application->priv->notifications);
1133 G_OBJECT_CLASS (g_application_parent_class)
1134 ->finalize (object);
1138 g_application_init (GApplication *application)
1140 application->priv = g_application_get_instance_private (application);
1142 application->priv->actions = g_application_exported_actions_new (application);
1144 /* application->priv->actions is the one and only ref on the group, so when
1145 * we dispose, the action group will die, disconnecting all signals.
1147 g_signal_connect_swapped (application->priv->actions, "action-added",
1148 G_CALLBACK (g_action_group_action_added), application);
1149 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
1150 G_CALLBACK (g_action_group_action_enabled_changed), application);
1151 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
1152 G_CALLBACK (g_action_group_action_state_changed), application);
1153 g_signal_connect_swapped (application->priv->actions, "action-removed",
1154 G_CALLBACK (g_action_group_action_removed), application);
1158 g_application_handle_local_options_accumulator (GSignalInvocationHint *ihint,
1159 GValue *return_accu,
1160 const GValue *handler_return,
1165 value = g_value_get_int (handler_return);
1166 g_value_set_int (return_accu, value);
1172 g_application_class_init (GApplicationClass *class)
1174 GObjectClass *object_class = G_OBJECT_CLASS (class);
1176 object_class->constructed = g_application_constructed;
1177 object_class->finalize = g_application_finalize;
1178 object_class->get_property = g_application_get_property;
1179 object_class->set_property = g_application_set_property;
1181 class->before_emit = g_application_real_before_emit;
1182 class->after_emit = g_application_real_after_emit;
1183 class->startup = g_application_real_startup;
1184 class->shutdown = g_application_real_shutdown;
1185 class->activate = g_application_real_activate;
1186 class->open = g_application_real_open;
1187 class->command_line = g_application_real_command_line;
1188 class->local_command_line = g_application_real_local_command_line;
1189 class->handle_local_options = g_application_real_handle_local_options;
1190 class->add_platform_data = g_application_real_add_platform_data;
1191 class->dbus_register = g_application_real_dbus_register;
1192 class->dbus_unregister = g_application_real_dbus_unregister;
1194 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
1195 g_param_spec_string ("application-id",
1196 P_("Application identifier"),
1197 P_("The unique identifier for the application"),
1198 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
1199 G_PARAM_STATIC_STRINGS));
1201 g_object_class_install_property (object_class, PROP_FLAGS,
1202 g_param_spec_flags ("flags",
1203 P_("Application flags"),
1204 P_("Flags specifying the behaviour of the application"),
1205 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
1206 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1208 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
1209 g_param_spec_boolean ("is-registered",
1210 P_("Is registered"),
1211 P_("If g_application_register() has been called"),
1212 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1214 g_object_class_install_property (object_class, PROP_IS_REMOTE,
1215 g_param_spec_boolean ("is-remote",
1217 P_("If this application instance is remote"),
1218 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1220 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
1221 g_param_spec_uint ("inactivity-timeout",
1222 P_("Inactivity timeout"),
1223 P_("Time (ms) to stay alive after becoming idle"),
1225 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1227 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
1228 g_param_spec_object ("action-group",
1230 P_("The group of actions that the application exports"),
1231 G_TYPE_ACTION_GROUP,
1232 G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
1235 * GApplication::startup:
1236 * @application: the application
1238 * The ::startup signal is emitted on the primary instance immediately
1239 * after registration. See g_application_register().
1241 g_application_signals[SIGNAL_STARTUP] =
1242 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
1243 G_STRUCT_OFFSET (GApplicationClass, startup),
1244 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1247 * GApplication::shutdown:
1248 * @application: the application
1250 * The ::shutdown signal is emitted only on the registered primary instance
1251 * immediately after the main loop terminates.
1253 g_application_signals[SIGNAL_SHUTDOWN] =
1254 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1255 G_STRUCT_OFFSET (GApplicationClass, shutdown),
1256 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1259 * GApplication::activate:
1260 * @application: the application
1262 * The ::activate signal is emitted on the primary instance when an
1263 * activation occurs. See g_application_activate().
1265 g_application_signals[SIGNAL_ACTIVATE] =
1266 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1267 G_STRUCT_OFFSET (GApplicationClass, activate),
1268 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1272 * GApplication::open:
1273 * @application: the application
1274 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
1275 * @n_files: the length of @files
1276 * @hint: a hint provided by the calling instance
1278 * The ::open signal is emitted on the primary instance when there are
1279 * files to open. See g_application_open() for more information.
1281 g_application_signals[SIGNAL_OPEN] =
1282 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1283 G_STRUCT_OFFSET (GApplicationClass, open),
1285 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
1288 * GApplication::command-line:
1289 * @application: the application
1290 * @command_line: a #GApplicationCommandLine representing the
1291 * passed commandline
1293 * The ::command-line signal is emitted on the primary instance when
1294 * a commandline is not handled locally. See g_application_run() and
1295 * the #GApplicationCommandLine documentation for more information.
1297 * Returns: An integer that is set as the exit status for the calling
1298 * process. See g_application_command_line_set_exit_status().
1300 g_application_signals[SIGNAL_COMMAND_LINE] =
1301 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1302 G_STRUCT_OFFSET (GApplicationClass, command_line),
1303 g_signal_accumulator_first_wins, NULL,
1305 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
1308 * GApplication::handle-local-options:
1309 * @application: the application
1310 * @options: the options dictionary
1312 * The ::handle-local-options signal is emitted on the local instance
1313 * after the parsing of the commandline options has occurred.
1315 * You can add options to be recognised during commandline option
1316 * parsing using g_application_add_main_option_entries() and
1317 * g_application_add_option_group().
1319 * Signal handlers can inspect @options (along with values pointed to
1320 * from the @arg_data of an installed #GOptionEntrys) in order to
1321 * decide to perform certain actions, including direct local handling
1322 * (which may be useful for options like --version).
1324 * If the options have been "handled" then a non-negative value should
1325 * be returned. In this case, the return value is the exit status: 0
1326 * for success and a positive value for failure. -1 means to continue
1327 * normal processing.
1329 * In the event that the application is marked
1330 * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
1331 * send the @option dictionary to the primary instance where it can be
1332 * read with g_application_command_line_get_options(). The signal
1333 * handler can modify the dictionary before returning, and the
1334 * modified dictionary will be sent.
1336 * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
1337 * "normal processing" will treat the remaining uncollected command
1338 * line arguments as filenames or URIs. If there are no arguments,
1339 * the application is activated by g_application_activate(). One or
1340 * more arguments results in a call to g_application_open().
1342 * If you want to handle the local commandline arguments for yourself
1343 * by converting them to calls to g_application_open() or
1344 * g_action_group_activate_action() then you must be sure to register
1345 * the application first. You should probably not call
1346 * g_application_activate() for yourself, however: just return -1 and
1347 * allow the default handler to do it for you. This will ensure that
1348 * the `--gapplication-service` switch works properly (i.e. no activation
1351 * Note that this signal is emitted from the default implementation of
1352 * local_command_line(). If you override that function and don't
1353 * chain up then this signal will never be emitted.
1355 * You can override local_command_line() if you need more powerful
1356 * capabilities than what is provided here, but this should not
1357 * normally be required.
1361 g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] =
1362 g_signal_new ("handle-local-options", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1363 G_STRUCT_OFFSET (GApplicationClass, handle_local_options),
1364 g_application_handle_local_options_accumulator, NULL, NULL,
1365 G_TYPE_INT, 1, G_TYPE_VARIANT_DICT);
1369 /* Application ID validity {{{1 */
1372 * g_application_id_is_valid:
1373 * @application_id: a potential application identifier
1375 * Checks if @application_id is a valid application identifier.
1377 * A valid ID is required for calls to g_application_new() and
1378 * g_application_set_application_id().
1380 * For convenience, the restrictions on application identifiers are
1383 * - Application identifiers must contain only the ASCII characters
1384 * "[A-Z][a-z][0-9]_-." and must not begin with a digit.
1386 * - Application identifiers must contain at least one '.' (period)
1387 * character (and thus at least three elements).
1389 * - Application identifiers must not begin or end with a '.' (period)
1392 * - Application identifiers must not contain consecutive '.' (period)
1395 * - Application identifiers must not exceed 255 characters.
1397 * Returns: %TRUE if @application_id is valid
1400 g_application_id_is_valid (const gchar *application_id)
1406 len = strlen (application_id);
1411 if (!g_ascii_isalpha (application_id[0]))
1414 if (application_id[len-1] == '.')
1420 for (; *application_id; application_id++)
1422 if (g_ascii_isalnum (*application_id) ||
1423 (*application_id == '-') ||
1424 (*application_id == '_'))
1428 else if (allow_dot && *application_id == '.')
1443 /* Public Constructor {{{1 */
1445 * g_application_new:
1446 * @application_id: (allow-none): the application id
1447 * @flags: the application flags
1449 * Creates a new #GApplication instance.
1451 * If non-%NULL, the application id must be valid. See
1452 * g_application_id_is_valid().
1454 * If no application ID is given then some features of #GApplication
1455 * (most notably application uniqueness) will be disabled.
1457 * Returns: a new #GApplication instance
1460 g_application_new (const gchar *application_id,
1461 GApplicationFlags flags)
1463 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1465 return g_object_new (G_TYPE_APPLICATION,
1466 "application-id", application_id,
1471 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1473 * g_application_get_application_id:
1474 * @application: a #GApplication
1476 * Gets the unique identifier for @application.
1478 * Returns: the identifier for @application, owned by @application
1483 g_application_get_application_id (GApplication *application)
1485 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1487 return application->priv->id;
1491 * g_application_set_application_id:
1492 * @application: a #GApplication
1493 * @application_id: (allow-none): the identifier for @application
1495 * Sets the unique identifier for @application.
1497 * The application id can only be modified if @application has not yet
1500 * If non-%NULL, the application id must be valid. See
1501 * g_application_id_is_valid().
1506 g_application_set_application_id (GApplication *application,
1507 const gchar *application_id)
1509 g_return_if_fail (G_IS_APPLICATION (application));
1511 if (g_strcmp0 (application->priv->id, application_id) != 0)
1513 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1514 g_return_if_fail (!application->priv->is_registered);
1516 g_free (application->priv->id);
1517 application->priv->id = g_strdup (application_id);
1519 g_object_notify (G_OBJECT (application), "application-id");
1524 * g_application_get_flags:
1525 * @application: a #GApplication
1527 * Gets the flags for @application.
1529 * See #GApplicationFlags.
1531 * Returns: the flags for @application
1536 g_application_get_flags (GApplication *application)
1538 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1540 return application->priv->flags;
1544 * g_application_set_flags:
1545 * @application: a #GApplication
1546 * @flags: the flags for @application
1548 * Sets the flags for @application.
1550 * The flags can only be modified if @application has not yet been
1553 * See #GApplicationFlags.
1558 g_application_set_flags (GApplication *application,
1559 GApplicationFlags flags)
1561 g_return_if_fail (G_IS_APPLICATION (application));
1563 if (application->priv->flags != flags)
1565 g_return_if_fail (!application->priv->is_registered);
1567 application->priv->flags = flags;
1569 g_object_notify (G_OBJECT (application), "flags");
1574 * g_application_get_inactivity_timeout:
1575 * @application: a #GApplication
1577 * Gets the current inactivity timeout for the application.
1579 * This is the amount of time (in milliseconds) after the last call to
1580 * g_application_release() before the application stops running.
1582 * Returns: the timeout, in milliseconds
1587 g_application_get_inactivity_timeout (GApplication *application)
1589 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1591 return application->priv->inactivity_timeout;
1595 * g_application_set_inactivity_timeout:
1596 * @application: a #GApplication
1597 * @inactivity_timeout: the timeout, in milliseconds
1599 * Sets the current inactivity timeout for the application.
1601 * This is the amount of time (in milliseconds) after the last call to
1602 * g_application_release() before the application stops running.
1604 * This call has no side effects of its own. The value set here is only
1605 * used for next time g_application_release() drops the use count to
1606 * zero. Any timeouts currently in progress are not impacted.
1611 g_application_set_inactivity_timeout (GApplication *application,
1612 guint inactivity_timeout)
1614 g_return_if_fail (G_IS_APPLICATION (application));
1616 if (application->priv->inactivity_timeout != inactivity_timeout)
1618 application->priv->inactivity_timeout = inactivity_timeout;
1620 g_object_notify (G_OBJECT (application), "inactivity-timeout");
1623 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
1625 * g_application_get_is_registered:
1626 * @application: a #GApplication
1628 * Checks if @application is registered.
1630 * An application is registered if g_application_register() has been
1631 * successfully called.
1633 * Returns: %TRUE if @application is registered
1638 g_application_get_is_registered (GApplication *application)
1640 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1642 return application->priv->is_registered;
1646 * g_application_get_is_remote:
1647 * @application: a #GApplication
1649 * Checks if @application is remote.
1651 * If @application is remote then it means that another instance of
1652 * application already exists (the 'primary' instance). Calls to
1653 * perform actions on @application will result in the actions being
1654 * performed by the primary instance.
1656 * The value of this property cannot be accessed before
1657 * g_application_register() has been called. See
1658 * g_application_get_is_registered().
1660 * Returns: %TRUE if @application is remote
1665 g_application_get_is_remote (GApplication *application)
1667 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1668 g_return_val_if_fail (application->priv->is_registered, FALSE);
1670 return application->priv->is_remote;
1674 * g_application_get_dbus_connection:
1675 * @application: a #GApplication
1677 * Gets the #GDBusConnection being used by the application, or %NULL.
1679 * If #GApplication is using its D-Bus backend then this function will
1680 * return the #GDBusConnection being used for uniqueness and
1681 * communication with the desktop environment and other instances of the
1684 * If #GApplication is not using D-Bus then this function will return
1685 * %NULL. This includes the situation where the D-Bus backend would
1686 * normally be in use but we were unable to connect to the bus.
1688 * This function must not be called before the application has been
1689 * registered. See g_application_get_is_registered().
1691 * Returns: (transfer none): a #GDBusConnection, or %NULL
1696 g_application_get_dbus_connection (GApplication *application)
1698 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1699 g_return_val_if_fail (application->priv->is_registered, FALSE);
1701 return g_application_impl_get_dbus_connection (application->priv->impl);
1705 * g_application_get_dbus_object_path:
1706 * @application: a #GApplication
1708 * Gets the D-Bus object path being used by the application, or %NULL.
1710 * If #GApplication is using its D-Bus backend then this function will
1711 * return the D-Bus object path that #GApplication is using. If the
1712 * application is the primary instance then there is an object published
1713 * at this path. If the application is not the primary instance then
1714 * the result of this function is undefined.
1716 * If #GApplication is not using D-Bus then this function will return
1717 * %NULL. This includes the situation where the D-Bus backend would
1718 * normally be in use but we were unable to connect to the bus.
1720 * This function must not be called before the application has been
1721 * registered. See g_application_get_is_registered().
1723 * Returns: the object path, or %NULL
1728 g_application_get_dbus_object_path (GApplication *application)
1730 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1731 g_return_val_if_fail (application->priv->is_registered, FALSE);
1733 return g_application_impl_get_dbus_object_path (application->priv->impl);
1738 * g_application_register:
1739 * @application: a #GApplication
1740 * @cancellable: (allow-none): a #GCancellable, or %NULL
1741 * @error: a pointer to a NULL #GError, or %NULL
1743 * Attempts registration of the application.
1745 * This is the point at which the application discovers if it is the
1746 * primary instance or merely acting as a remote for an already-existing
1747 * primary instance. This is implemented by attempting to acquire the
1748 * application identifier as a unique bus name on the session bus using
1751 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1752 * given, then this process will always become the primary instance.
1754 * Due to the internal architecture of GDBus, method calls can be
1755 * dispatched at any time (even if a main loop is not running). For
1756 * this reason, you must ensure that any object paths that you wish to
1757 * register are registered before calling this function.
1759 * If the application has already been registered then %TRUE is
1760 * returned with no work performed.
1762 * The #GApplication::startup signal is emitted if registration succeeds
1763 * and @application is the primary instance (including the non-unique
1766 * In the event of an error (such as @cancellable being cancelled, or a
1767 * failure to connect to the session bus), %FALSE is returned and @error
1768 * is set appropriately.
1770 * Note: the return value of this function is not an indicator that this
1771 * instance is or is not the primary instance of the application. See
1772 * g_application_get_is_remote() for that.
1774 * Returns: %TRUE if registration succeeded
1779 g_application_register (GApplication *application,
1780 GCancellable *cancellable,
1783 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1785 if (!application->priv->is_registered)
1787 if (application->priv->id == NULL)
1788 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
1790 application->priv->impl =
1791 g_application_impl_register (application, application->priv->id,
1792 application->priv->flags,
1793 application->priv->actions,
1794 &application->priv->remote_actions,
1795 cancellable, error);
1797 if (application->priv->impl == NULL)
1800 application->priv->is_remote = application->priv->remote_actions != NULL;
1801 application->priv->is_registered = TRUE;
1803 g_object_notify (G_OBJECT (application), "is-registered");
1805 if (!application->priv->is_remote)
1807 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1809 if (!application->priv->did_startup)
1810 g_critical ("GApplication subclass '%s' failed to chain up on"
1811 " ::startup (from start of override function)",
1812 G_OBJECT_TYPE_NAME (application));
1819 /* Hold/release {{{1 */
1821 * g_application_hold:
1822 * @application: a #GApplication
1824 * Increases the use count of @application.
1826 * Use this function to indicate that the application has a reason to
1827 * continue to run. For example, g_application_hold() is called by GTK+
1828 * when a toplevel window is on the screen.
1830 * To cancel the hold, call g_application_release().
1833 g_application_hold (GApplication *application)
1835 g_return_if_fail (G_IS_APPLICATION (application));
1837 if (application->priv->inactivity_timeout_id)
1839 g_source_remove (application->priv->inactivity_timeout_id);
1840 application->priv->inactivity_timeout_id = 0;
1843 application->priv->use_count++;
1847 inactivity_timeout_expired (gpointer data)
1849 GApplication *application = G_APPLICATION (data);
1851 application->priv->inactivity_timeout_id = 0;
1853 return G_SOURCE_REMOVE;
1858 * g_application_release:
1859 * @application: a #GApplication
1861 * Decrease the use count of @application.
1863 * When the use count reaches zero, the application will stop running.
1865 * Never call this function except to cancel the effect of a previous
1866 * call to g_application_hold().
1869 g_application_release (GApplication *application)
1871 g_return_if_fail (G_IS_APPLICATION (application));
1873 application->priv->use_count--;
1875 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
1876 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
1877 inactivity_timeout_expired, application);
1880 /* Activate, Open {{{1 */
1882 * g_application_activate:
1883 * @application: a #GApplication
1885 * Activates the application.
1887 * In essence, this results in the #GApplication::activate signal being
1888 * emitted in the primary instance.
1890 * The application must be registered before calling this function.
1895 g_application_activate (GApplication *application)
1897 g_return_if_fail (G_IS_APPLICATION (application));
1898 g_return_if_fail (application->priv->is_registered);
1900 if (application->priv->is_remote)
1901 g_application_impl_activate (application->priv->impl,
1902 get_platform_data (application, NULL));
1905 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1909 * g_application_open:
1910 * @application: a #GApplication
1911 * @files: (array length=n_files): an array of #GFiles to open
1912 * @n_files: the length of the @files array
1913 * @hint: a hint (or ""), but never %NULL
1915 * Opens the given files.
1917 * In essence, this results in the #GApplication::open signal being emitted
1918 * in the primary instance.
1920 * @n_files must be greater than zero.
1922 * @hint is simply passed through to the ::open signal. It is
1923 * intended to be used by applications that have multiple modes for
1924 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1925 * for this functionality, you should use "".
1927 * The application must be registered before calling this function
1928 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1933 g_application_open (GApplication *application,
1938 g_return_if_fail (G_IS_APPLICATION (application));
1939 g_return_if_fail (application->priv->flags &
1940 G_APPLICATION_HANDLES_OPEN);
1941 g_return_if_fail (application->priv->is_registered);
1943 if (application->priv->is_remote)
1944 g_application_impl_open (application->priv->impl,
1945 files, n_files, hint,
1946 get_platform_data (application, NULL));
1949 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1950 0, files, n_files, hint);
1955 * g_application_run:
1956 * @application: a #GApplication
1957 * @argc: the argc from main() (or 0 if @argv is %NULL)
1958 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1960 * Runs the application.
1962 * This function is intended to be run from main() and its return value
1963 * is intended to be returned by main(). Although you are expected to pass
1964 * the @argc, @argv parameters from main() to this function, it is possible
1965 * to pass %NULL if @argv is not available or commandline handling is not
1966 * required. Note that on Windows, @argc and @argv are ignored, and
1967 * g_win32_get_command_line() is called internally (for proper support
1968 * of Unicode commandline arguments).
1970 * #GApplication will attempt to parse the commandline arguments. You
1971 * can add commandline flags to the list of recognised options by way of
1972 * g_application_add_main_option_entries(). After this, the
1973 * #GApplication::handle-local-options signal is emitted, from which the
1974 * application can inspect the values of its #GOptionEntrys.
1976 * #GApplication::handle-local-options is a good place to handle options
1977 * such as `--version`, where an immediate reply from the local process is
1978 * desired (instead of communicating with an already-running instance).
1979 * A #GApplication::handle-local-options handler can stop further processing
1980 * by returning a non-negative value, which then becomes the exit status of
1983 * What happens next depends on the flags: if
1984 * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
1985 * commandline arguments are sent to the primary instance, where a
1986 * #GApplication::command-line signal is emitted. Otherwise, the
1987 * remaining commandline arguments are assumed to be a list of files.
1988 * If there are no files listed, the application is activated via the
1989 * #GApplication::activate signal. If there are one or more files, and
1990 * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
1991 * via the #GApplication::open signal.
1993 * If you are interested in doing more complicated local handling of the
1994 * commandline then you should implement your own #GApplication subclass
1995 * and override local_command_line(). In this case, you most likely want
1996 * to return %TRUE from your local_command_line() implementation to
1997 * suppress the default handling. See
1998 * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
2001 * If, after the above is done, the use count of the application is zero
2002 * then the exit status is returned immediately. If the use count is
2003 * non-zero then the default main context is iterated until the use count
2004 * falls to zero, at which point 0 is returned.
2006 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
2007 * run for as much as 10 seconds with a use count of zero while waiting
2008 * for the message that caused the activation to arrive. After that,
2009 * if the use count falls to zero the application will exit immediately,
2010 * except in the case that g_application_set_inactivity_timeout() is in
2013 * This function sets the prgname (g_set_prgname()), if not already set,
2014 * to the basename of argv[0]. Since 2.38, if %G_APPLICATION_IS_SERVICE
2015 * is specified, the prgname is set to the application ID. The main
2016 * impact of this is is that the wmclass of windows created by Gtk+ will
2017 * be set accordingly, which helps the window manager determine which
2018 * application is showing the window.
2020 * Since 2.40, applications that are not explicitly flagged as services
2021 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
2022 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
2023 * default handler for local_command_line) if "--gapplication-service"
2024 * was given in the command line. If this flag is present then normal
2025 * commandline processing is interrupted and the
2026 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise"
2027 * solution whereby running an application directly from the commandline
2028 * will invoke it in the normal way (which can be useful for debugging)
2029 * while still allowing applications to be D-Bus activated in service
2030 * mode. The D-Bus service file should invoke the executable with
2031 * "--gapplication-service" as the sole commandline argument. This
2032 * approach is suitable for use by most graphical applications but
2033 * should not be used from applications like editors that need precise
2034 * control over when processes invoked via the commandline will exit and
2035 * what their exit status will be.
2037 * Returns: the exit status
2042 g_application_run (GApplication *application,
2049 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
2050 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
2051 g_return_val_if_fail (!application->priv->must_quit_now, 1);
2054 arguments = g_win32_get_command_line ();
2059 arguments = g_new (gchar *, argc + 1);
2060 for (i = 0; i < argc; i++)
2061 arguments[i] = g_strdup (argv[i]);
2062 arguments[i] = NULL;
2066 if (g_get_prgname () == NULL)
2068 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
2070 g_set_prgname (application->priv->id);
2076 prgname = g_path_get_basename (argv[0]);
2077 g_set_prgname (prgname);
2082 if (!G_APPLICATION_GET_CLASS (application)
2083 ->local_command_line (application, &arguments, &status))
2085 GError *error = NULL;
2087 if (!g_application_register (application, NULL, &error))
2089 g_printerr ("Failed to register: %s\n", error->message);
2090 g_error_free (error);
2094 g_application_call_command_line (application, (const gchar **) arguments, NULL, &status);
2097 g_strfreev (arguments);
2099 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
2100 application->priv->is_registered &&
2101 !application->priv->use_count &&
2102 !application->priv->inactivity_timeout_id)
2104 application->priv->inactivity_timeout_id =
2105 g_timeout_add (10000, inactivity_timeout_expired, application);
2108 while (application->priv->use_count || application->priv->inactivity_timeout_id)
2110 if (application->priv->must_quit_now)
2113 g_main_context_iteration (NULL, TRUE);
2117 if (application->priv->is_registered && !application->priv->is_remote)
2119 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
2121 if (!application->priv->did_shutdown)
2122 g_critical ("GApplication subclass '%s' failed to chain up on"
2123 " ::shutdown (from end of override function)",
2124 G_OBJECT_TYPE_NAME (application));
2127 if (application->priv->impl)
2128 g_application_impl_flush (application->priv->impl);
2136 g_application_list_actions (GActionGroup *action_group)
2138 GApplication *application = G_APPLICATION (action_group);
2140 g_return_val_if_fail (application->priv->is_registered, NULL);
2142 if (application->priv->remote_actions != NULL)
2143 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
2145 else if (application->priv->actions != NULL)
2146 return g_action_group_list_actions (application->priv->actions);
2149 /* empty string array */
2150 return g_new0 (gchar *, 1);
2154 g_application_query_action (GActionGroup *group,
2155 const gchar *action_name,
2157 const GVariantType **parameter_type,
2158 const GVariantType **state_type,
2159 GVariant **state_hint,
2162 GApplication *application = G_APPLICATION (group);
2164 g_return_val_if_fail (application->priv->is_registered, FALSE);
2166 if (application->priv->remote_actions != NULL)
2167 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
2175 if (application->priv->actions != NULL)
2176 return g_action_group_query_action (application->priv->actions,
2188 g_application_change_action_state (GActionGroup *action_group,
2189 const gchar *action_name,
2192 GApplication *application = G_APPLICATION (action_group);
2194 g_return_if_fail (application->priv->is_remote ||
2195 application->priv->actions != NULL);
2196 g_return_if_fail (application->priv->is_registered);
2198 if (application->priv->remote_actions)
2199 g_remote_action_group_change_action_state_full (application->priv->remote_actions,
2200 action_name, value, get_platform_data (application, NULL));
2203 g_action_group_change_action_state (application->priv->actions, action_name, value);
2207 g_application_activate_action (GActionGroup *action_group,
2208 const gchar *action_name,
2209 GVariant *parameter)
2211 GApplication *application = G_APPLICATION (action_group);
2213 g_return_if_fail (application->priv->is_remote ||
2214 application->priv->actions != NULL);
2215 g_return_if_fail (application->priv->is_registered);
2217 if (application->priv->remote_actions)
2218 g_remote_action_group_activate_action_full (application->priv->remote_actions,
2219 action_name, parameter, get_platform_data (application, NULL));
2222 g_action_group_activate_action (application->priv->actions, action_name, parameter);
2226 g_application_lookup_action (GActionMap *action_map,
2227 const gchar *action_name)
2229 GApplication *application = G_APPLICATION (action_map);
2231 g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
2233 return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
2237 g_application_add_action (GActionMap *action_map,
2240 GApplication *application = G_APPLICATION (action_map);
2242 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2244 g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
2248 g_application_remove_action (GActionMap *action_map,
2249 const gchar *action_name)
2251 GApplication *application = G_APPLICATION (action_map);
2253 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2255 g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
2259 g_application_action_group_iface_init (GActionGroupInterface *iface)
2261 iface->list_actions = g_application_list_actions;
2262 iface->query_action = g_application_query_action;
2263 iface->change_action_state = g_application_change_action_state;
2264 iface->activate_action = g_application_activate_action;
2268 g_application_action_map_iface_init (GActionMapInterface *iface)
2270 iface->lookup_action = g_application_lookup_action;
2271 iface->add_action = g_application_add_action;
2272 iface->remove_action = g_application_remove_action;
2275 /* Default Application {{{1 */
2277 static GApplication *default_app;
2280 * g_application_get_default:
2282 * Returns the default #GApplication instance for this process.
2284 * Normally there is only one #GApplication per process and it becomes
2285 * the default when it is created. You can exercise more control over
2286 * this by using g_application_set_default().
2288 * If there is no default application then %NULL is returned.
2290 * Returns: (transfer none): the default application for this process, or %NULL
2295 g_application_get_default (void)
2301 * g_application_set_default:
2302 * @application: (allow-none): the application to set as default, or %NULL
2304 * Sets or unsets the default application for the process, as returned
2305 * by g_application_get_default().
2307 * This function does not take its own reference on @application. If
2308 * @application is destroyed then the default application will revert
2314 g_application_set_default (GApplication *application)
2316 default_app = application;
2320 * g_application_quit:
2321 * @application: a #GApplication
2323 * Immediately quits the application.
2325 * Upon return to the mainloop, g_application_run() will return,
2326 * calling only the 'shutdown' function before doing so.
2328 * The hold count is ignored.
2330 * The result of calling g_application_run() again after it returns is
2336 g_application_quit (GApplication *application)
2338 g_return_if_fail (G_IS_APPLICATION (application));
2340 application->priv->must_quit_now = TRUE;
2344 * g_application_mark_busy:
2345 * @application: a #GApplication
2347 * Increases the busy count of @application.
2349 * Use this function to indicate that the application is busy, for instance
2350 * while a long running operation is pending.
2352 * The busy state will be exposed to other processes, so a session shell will
2353 * use that information to indicate the state to the user (e.g. with a
2356 * To cancel the busy indication, use g_application_unmark_busy().
2361 g_application_mark_busy (GApplication *application)
2365 g_return_if_fail (G_IS_APPLICATION (application));
2367 was_busy = (application->priv->busy_count > 0);
2368 application->priv->busy_count++;
2371 g_application_impl_set_busy_state (application->priv->impl, TRUE);
2375 * g_application_unmark_busy:
2376 * @application: a #GApplication
2378 * Decreases the busy count of @application.
2380 * When the busy count reaches zero, the new state will be propagated
2381 * to other processes.
2383 * This function must only be called to cancel the effect of a previous
2384 * call to g_application_mark_busy().
2389 g_application_unmark_busy (GApplication *application)
2391 g_return_if_fail (G_IS_APPLICATION (application));
2392 g_return_if_fail (application->priv->busy_count > 0);
2394 application->priv->busy_count--;
2396 if (application->priv->busy_count == 0)
2397 g_application_impl_set_busy_state (application->priv->impl, FALSE);
2400 /* Notifications {{{1 */
2403 * g_application_send_notification:
2404 * @application: a #GApplication
2405 * @id: (allow-none): id of the notification, or %NULL
2406 * @notification: the #GNotification to send
2408 * Sends a notification on behalf of @application to the desktop shell.
2409 * There is no guarantee that the notification is displayed immediately,
2412 * Notifications may persist after the application exits. It will be
2413 * D-Bus-activated when the notification or one of its actions is
2416 * Modifying @notification after this call has no effect. However, the
2417 * object can be reused for a later call to this function.
2419 * @id may be any string that uniquely identifies the event for the
2420 * application. It does not need to be in any special format. For
2421 * example, "new-message" might be appropriate for a notification about
2424 * If a previous notification was sent with the same @id, it will be
2425 * replaced with @notification and shown again as if it was a new
2426 * notification. This works even for notifications sent from a previous
2427 * execution of the application, as long as @id is the same string.
2429 * @id may be %NULL, but it is impossible to replace or withdraw
2430 * notifications without an id.
2432 * If @notification is no longer relevant, it can be withdrawn with
2433 * g_application_withdraw_notification().
2438 g_application_send_notification (GApplication *application,
2440 GNotification *notification)
2442 gchar *generated_id = NULL;
2444 g_return_if_fail (G_IS_APPLICATION (application));
2445 g_return_if_fail (G_IS_NOTIFICATION (notification));
2446 g_return_if_fail (g_application_get_is_registered (application));
2447 g_return_if_fail (!g_application_get_is_remote (application));
2449 if (application->priv->notifications == NULL)
2450 application->priv->notifications = g_notification_backend_new_default (application);
2454 generated_id = g_dbus_generate_guid ();
2458 g_notification_backend_send_notification (application->priv->notifications, id, notification);
2460 g_free (generated_id);
2464 * g_application_withdraw_notification:
2465 * @application: a #GApplication
2466 * @id: id of a previously sent notification
2468 * Withdraws a notification that was sent with
2469 * g_application_send_notification().
2471 * This call does nothing if a notification with @id doesn't exist or
2472 * the notification was never sent.
2474 * This function works even for notifications sent in previous
2475 * executions of this application, as long @id is the same as it was for
2476 * the sent notification.
2478 * Note that notifications are dismissed when the user clicks on one
2479 * of the buttons in a notification or triggers its default action, so
2480 * there is no need to explicitly withdraw the notification in that case.
2485 g_application_withdraw_notification (GApplication *application,
2488 g_return_if_fail (G_IS_APPLICATION (application));
2489 g_return_if_fail (id != NULL);
2491 if (application->priv->notifications)
2492 g_notification_backend_withdraw_notification (application->priv->notifications, id);
2496 /* vim:set foldmethod=marker: */