Imported Upstream version 2.53.3
[platform/upstream/glib.git] / gio / gapplication.c
1 /*
2  * Copyright © 2010 Codethink Limited
3  *
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.
8  *
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.
13  *
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/>.
16  *
17  * Authors: Ryan Lortie <desrt@desrt.ca>
18  */
19
20 /* Prologue {{{1 */
21 #include "config.h"
22
23 #include "gapplication.h"
24
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"
35
36 #include "gioenumtypes.h"
37 #include "gioenums.h"
38 #include "gfile.h"
39
40 #include "glibintl.h"
41
42 #include <string.h>
43
44 /**
45  * SECTION:gapplication
46  * @title: GApplication
47  * @short_description: Core application class
48  * @include: gio/gio.h
49  *
50  * A #GApplication is the foundation of an application.  It wraps some
51  * low-level platform-specific services and is intended to act as the
52  * foundation for higher-level application classes such as
53  * #GtkApplication or #MxApplication.  In general, you should not use
54  * this class outside of a higher level framework.
55  *
56  * GApplication provides convenient life cycle management by maintaining
57  * a "use count" for the primary application instance. The use count can
58  * be changed using g_application_hold() and g_application_release(). If
59  * it drops to zero, the application exits. Higher-level classes such as
60  * #GtkApplication employ the use count to ensure that the application
61  * stays alive as long as it has any opened windows.
62  *
63  * Another feature that GApplication (optionally) provides is process
64  * uniqueness. Applications can make use of this functionality by
65  * providing a unique application ID. If given, only one application
66  * with this ID can be running at a time per session. The session
67  * concept is platform-dependent, but corresponds roughly to a graphical
68  * desktop login. When your application is launched again, its
69  * arguments are passed through platform communication to the already
70  * running program. The already running instance of the program is
71  * called the "primary instance"; for non-unique applications this is
72  * the always the current instance. On Linux, the D-Bus session bus
73  * is used for communication.
74  *
75  * The use of #GApplication differs from some other commonly-used
76  * uniqueness libraries (such as libunique) in important ways. The
77  * application is not expected to manually register itself and check
78  * if it is the primary instance. Instead, the main() function of a
79  * #GApplication should do very little more than instantiating the
80  * application instance, possibly connecting signal handlers, then
81  * calling g_application_run(). All checks for uniqueness are done
82  * internally. If the application is the primary instance then the
83  * startup signal is emitted and the mainloop runs. If the application
84  * is not the primary instance then a signal is sent to the primary
85  * instance and g_application_run() promptly returns. See the code
86  * examples below.
87  *
88  * If used, the expected form of an application identifier is very close
89  * to that of of a
90  * [D-Bus bus name](http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface).
91  * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
92  * For details on valid application identifiers, see g_application_id_is_valid().
93  *
94  * On Linux, the application identifier is claimed as a well-known bus name
95  * on the user's session bus.  This means that the uniqueness of your
96  * application is scoped to the current session.  It also means that your
97  * application may provide additional services (through registration of other
98  * object paths) at that bus name.  The registration of these object paths
99  * should be done with the shared GDBus session bus.  Note that due to the
100  * internal architecture of GDBus, method calls can be dispatched at any time
101  * (even if a main loop is not running).  For this reason, you must ensure that
102  * any object paths that you wish to register are registered before #GApplication
103  * attempts to acquire the bus name of your application (which happens in
104  * g_application_register()).  Unfortunately, this means that you cannot use
105  * g_application_get_is_remote() to decide if you want to register object paths.
106  *
107  * GApplication also implements the #GActionGroup and #GActionMap
108  * interfaces and lets you easily export actions by adding them with
109  * g_action_map_add_action(). When invoking an action by calling
110  * g_action_group_activate_action() on the application, it is always
111  * invoked in the primary instance. The actions are also exported on
112  * the session bus, and GIO provides the #GDBusActionGroup wrapper to
113  * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
114  * for remote access to exported #GMenuModels.
115  *
116  * There is a number of different entry points into a GApplication:
117  *
118  * - via 'Activate' (i.e. just starting the application)
119  *
120  * - via 'Open' (i.e. opening some files)
121  *
122  * - by handling a command-line
123  *
124  * - via activating an action
125  *
126  * The #GApplication::startup signal lets you handle the application
127  * initialization for all of these in a single place.
128  *
129  * Regardless of which of these entry points is used to start the
130  * application, GApplication passes some "platform data from the
131  * launching instance to the primary instance, in the form of a
132  * #GVariant dictionary mapping strings to variants. To use platform
133  * data, override the @before_emit or @after_emit virtual functions
134  * in your #GApplication subclass. When dealing with
135  * #GApplicationCommandLine objects, the platform data is
136  * directly available via g_application_command_line_get_cwd(),
137  * g_application_command_line_get_environ() and
138  * g_application_command_line_get_platform_data().
139  *
140  * As the name indicates, the platform data may vary depending on the
141  * operating system, but it always includes the current directory (key
142  * "cwd"), and optionally the environment (ie the set of environment
143  * variables and their values) of the calling process (key "environ").
144  * The environment is only added to the platform data if the
145  * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
146  * can add their own platform data by overriding the @add_platform_data
147  * virtual function. For instance, #GtkApplication adds startup notification
148  * data in this way.
149  *
150  * To parse commandline arguments you may handle the
151  * #GApplication::command-line signal or override the local_command_line()
152  * vfunc, to parse them in either the primary instance or the local instance,
153  * respectively.
154  *
155  * For an example of opening files with a GApplication, see
156  * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c).
157  *
158  * For an example of using actions with GApplication, see
159  * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c).
160  *
161  * For an example of using extra D-Bus hooks with GApplication, see
162  * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
163  */
164
165 /**
166  * GApplication:
167  *
168  * #GApplication is an opaque data structure and can only be accessed
169  * using the following functions.
170  * Since: 2.28
171  */
172
173 /**
174  * GApplicationClass:
175  * @startup: invoked on the primary instance immediately after registration
176  * @shutdown: invoked only on the registered primary instance immediately
177  *      after the main loop terminates
178  * @activate: invoked on the primary instance when an activation occurs
179  * @open: invoked on the primary instance when there are files to open
180  * @command_line: invoked on the primary instance when a command-line is
181  *   not handled locally
182  * @local_command_line: invoked (locally). The virtual function has the chance
183  *     to inspect (and possibly replace) command line arguments. See
184  *     g_application_run() for more information. Also see the
185  *     #GApplication::handle-local-options signal, which is a simpler
186  *     alternative to handling some commandline options locally
187  * @before_emit: invoked on the primary instance before 'activate', 'open',
188  *     'command-line' or any action invocation, gets the 'platform data' from
189  *     the calling instance
190  * @after_emit: invoked on the primary instance after 'activate', 'open',
191  *     'command-line' or any action invocation, gets the 'platform data' from
192  *     the calling instance
193  * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
194  *     the primary instance when activating, opening or invoking actions
195  * @quit_mainloop: Used to be invoked on the primary instance when the use
196  *     count of the application drops to zero (and after any inactivity
197  *     timeout, if requested). Not used anymore since 2.32
198  * @run_mainloop: Used to be invoked on the primary instance from
199  *     g_application_run() if the use-count is non-zero. Since 2.32,
200  *     GApplication is iterating the main context directly and is not
201  *     using @run_mainloop anymore
202  * @dbus_register: invoked locally during registration, if the application is
203  *     using its D-Bus backend. You can use this to export extra objects on the
204  *     bus, that need to exist before the application tries to own the bus name.
205  *     The function is passed the #GDBusConnection to to session bus, and the
206  *     object path that #GApplication will use to export is D-Bus API.
207  *     If this function returns %TRUE, registration will proceed; otherwise
208  *     registration will abort. Since: 2.34
209  * @dbus_unregister: invoked locally during unregistration, if the application
210  *     is using its D-Bus backend. Use this to undo anything done by the
211  *     @dbus_register vfunc. Since: 2.34
212  * @handle_local_options: invoked locally after the parsing of the commandline
213  *  options has occurred. Since: 2.40
214  *
215  * Virtual function table for #GApplication.
216  *
217  * Since: 2.28
218  */
219
220 struct _GApplicationPrivate
221 {
222   GApplicationFlags  flags;
223   gchar             *id;
224   gchar             *resource_path;
225
226   GActionGroup      *actions;
227
228   guint              inactivity_timeout_id;
229   guint              inactivity_timeout;
230   guint              use_count;
231   guint              busy_count;
232
233   guint              is_registered : 1;
234   guint              is_remote : 1;
235   guint              did_startup : 1;
236   guint              did_shutdown : 1;
237   guint              must_quit_now : 1;
238
239   GRemoteActionGroup *remote_actions;
240   GApplicationImpl   *impl;
241
242   GNotificationBackend *notifications;
243
244   /* GOptionContext support */
245   GOptionGroup       *main_options;
246   GSList             *option_groups;
247   GHashTable         *packed_options;
248   gboolean            options_parsed;
249
250   /* Allocated option strings, from g_application_add_main_option() */
251   GSList             *option_strings;
252 };
253
254 enum
255 {
256   PROP_NONE,
257   PROP_APPLICATION_ID,
258   PROP_FLAGS,
259   PROP_RESOURCE_BASE_PATH,
260   PROP_IS_REGISTERED,
261   PROP_IS_REMOTE,
262   PROP_INACTIVITY_TIMEOUT,
263   PROP_ACTION_GROUP,
264   PROP_IS_BUSY
265 };
266
267 enum
268 {
269   SIGNAL_STARTUP,
270   SIGNAL_SHUTDOWN,
271   SIGNAL_ACTIVATE,
272   SIGNAL_OPEN,
273   SIGNAL_ACTION,
274   SIGNAL_COMMAND_LINE,
275   SIGNAL_HANDLE_LOCAL_OPTIONS,
276   NR_SIGNALS
277 };
278
279 static guint g_application_signals[NR_SIGNALS];
280
281 static void g_application_action_group_iface_init (GActionGroupInterface *);
282 static void g_application_action_map_iface_init (GActionMapInterface *);
283 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
284  G_ADD_PRIVATE (GApplication)
285  G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
286  G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
287
288 /* GApplicationExportedActions {{{1 */
289
290 /* We create a subclass of GSimpleActionGroup that implements
291  * GRemoteActionGroup and deals with the platform data using
292  * GApplication's before/after_emit vfuncs.  This is the action group we
293  * will be exporting.
294  *
295  * We could implement GRemoteActionGroup on GApplication directly, but
296  * this would be potentially extremely confusing to have exposed as part
297  * of the public API of GApplication.  We certainly don't want anyone in
298  * the same process to be calling these APIs...
299  */
300 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
301 typedef struct
302 {
303   GSimpleActionGroup parent_instance;
304   GApplication *application;
305 } GApplicationExportedActions;
306
307 static GType g_application_exported_actions_get_type   (void);
308 static void  g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
309 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
310                          G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
311
312 static void
313 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
314                                                      const gchar        *action_name,
315                                                      GVariant           *parameter,
316                                                      GVariant           *platform_data)
317 {
318   GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
319
320   G_APPLICATION_GET_CLASS (exported->application)
321     ->before_emit (exported->application, platform_data);
322
323   g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
324
325   G_APPLICATION_GET_CLASS (exported->application)
326     ->after_emit (exported->application, platform_data);
327 }
328
329 static void
330 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
331                                                          const gchar        *action_name,
332                                                          GVariant           *value,
333                                                          GVariant           *platform_data)
334 {
335   GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
336
337   G_APPLICATION_GET_CLASS (exported->application)
338     ->before_emit (exported->application, platform_data);
339
340   g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
341
342   G_APPLICATION_GET_CLASS (exported->application)
343     ->after_emit (exported->application, platform_data);
344 }
345
346 static void
347 g_application_exported_actions_init (GApplicationExportedActions *actions)
348 {
349 }
350
351 static void
352 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
353 {
354   iface->activate_action_full = g_application_exported_actions_activate_action_full;
355   iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
356 }
357
358 static void
359 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
360 {
361 }
362
363 static GActionGroup *
364 g_application_exported_actions_new (GApplication *application)
365 {
366   GApplicationExportedActions *actions;
367
368   actions = g_object_new (g_application_exported_actions_get_type (), NULL);
369   actions->application = application;
370
371   return G_ACTION_GROUP (actions);
372 }
373
374 /* Command line option handling {{{1 */
375
376 static void
377 free_option_entry (gpointer data)
378 {
379   GOptionEntry *entry = data;
380
381   switch (entry->arg)
382     {
383     case G_OPTION_ARG_STRING:
384     case G_OPTION_ARG_FILENAME:
385       g_free (*(gchar **) entry->arg_data);
386       break;
387
388     case G_OPTION_ARG_STRING_ARRAY:
389     case G_OPTION_ARG_FILENAME_ARRAY:
390       g_strfreev (*(gchar ***) entry->arg_data);
391       break;
392
393     default:
394       /* most things require no free... */
395       break;
396     }
397
398   /* ...except for the space that we allocated for it ourselves */
399   g_free (entry->arg_data);
400
401   g_slice_free (GOptionEntry, entry);
402 }
403
404 static void
405 g_application_pack_option_entries (GApplication *application,
406                                    GVariantDict *dict)
407 {
408   GHashTableIter iter;
409   gpointer item;
410
411   g_hash_table_iter_init (&iter, application->priv->packed_options);
412   while (g_hash_table_iter_next (&iter, NULL, &item))
413     {
414       GOptionEntry *entry = item;
415       GVariant *value = NULL;
416
417       switch (entry->arg)
418         {
419         case G_OPTION_ARG_NONE:
420           if (*(gboolean *) entry->arg_data != 2)
421             value = g_variant_new_boolean (*(gboolean *) entry->arg_data);
422           break;
423
424         case G_OPTION_ARG_STRING:
425           if (*(gchar **) entry->arg_data)
426             value = g_variant_new_string (*(gchar **) entry->arg_data);
427           break;
428
429         case G_OPTION_ARG_INT:
430           if (*(gint32 *) entry->arg_data)
431             value = g_variant_new_int32 (*(gint32 *) entry->arg_data);
432           break;
433
434         case G_OPTION_ARG_FILENAME:
435           if (*(gchar **) entry->arg_data)
436             value = g_variant_new_bytestring (*(gchar **) entry->arg_data);
437           break;
438
439         case G_OPTION_ARG_STRING_ARRAY:
440           if (*(gchar ***) entry->arg_data)
441             value = g_variant_new_strv (*(const gchar ***) entry->arg_data, -1);
442           break;
443
444         case G_OPTION_ARG_FILENAME_ARRAY:
445           if (*(gchar ***) entry->arg_data)
446             value = g_variant_new_bytestring_array (*(const gchar ***) entry->arg_data, -1);
447           break;
448
449         case G_OPTION_ARG_DOUBLE:
450           if (*(gdouble *) entry->arg_data)
451             value = g_variant_new_double (*(gdouble *) entry->arg_data);
452           break;
453
454         case G_OPTION_ARG_INT64:
455           if (*(gint64 *) entry->arg_data)
456             value = g_variant_new_int64 (*(gint64 *) entry->arg_data);
457           break;
458
459         default:
460           g_assert_not_reached ();
461         }
462
463       if (value)
464         g_variant_dict_insert_value (dict, entry->long_name, value);
465     }
466 }
467
468 static GVariantDict *
469 g_application_parse_command_line (GApplication   *application,
470                                   gchar        ***arguments,
471                                   GError        **error)
472 {
473   gboolean become_service = FALSE;
474   gchar *app_id = NULL;
475   GVariantDict *dict = NULL;
476   GOptionContext *context;
477   GOptionGroup *gapplication_group;
478
479   /* Due to the memory management of GOptionGroup we can only parse
480    * options once.  That's because once you add a group to the
481    * GOptionContext there is no way to get it back again.  This is fine:
482    * local_command_line() should never get invoked more than once
483    * anyway.  Add a sanity check just to be sure.
484    */
485   g_return_val_if_fail (!application->priv->options_parsed, NULL);
486
487   context = g_option_context_new (NULL);
488
489   gapplication_group = g_option_group_new ("gapplication",
490                                            _("GApplication options"), _("Show GApplication options"),
491                                            NULL, NULL);
492   g_option_group_set_translation_domain (gapplication_group, GETTEXT_PACKAGE);
493   g_option_context_add_group (context, gapplication_group);
494
495   /* If the application has not registered local options and it has
496    * G_APPLICATION_HANDLES_COMMAND_LINE then we have to assume that
497    * their primary instance commandline handler may want to deal with
498    * the arguments.  We must therefore ignore them.
499    *
500    * We must also ignore --help in this case since some applications
501    * will try to handle this from the remote side.  See #737869.
502    */
503   if (application->priv->main_options == NULL && (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE))
504     {
505       g_option_context_set_ignore_unknown_options (context, TRUE);
506       g_option_context_set_help_enabled (context, FALSE);
507     }
508
509   /* Add the main option group, if it exists */
510   if (application->priv->main_options)
511     {
512       /* This consumes the main_options */
513       g_option_context_set_main_group (context, application->priv->main_options);
514       application->priv->main_options = NULL;
515     }
516
517   /* Add any other option groups if they exist.  Adding them to the
518    * context will consume them, so we free the list as we go...
519    */
520   while (application->priv->option_groups)
521     {
522       g_option_context_add_group (context, application->priv->option_groups->data);
523       application->priv->option_groups = g_slist_delete_link (application->priv->option_groups,
524                                                               application->priv->option_groups);
525     }
526
527   /* In the case that we are not explicitly marked as a service or a
528    * launcher then we want to add the "--gapplication-service" option to
529    * allow the process to be made into a service.
530    */
531   if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
532     {
533       GOptionEntry entries[] = {
534         { "gapplication-service", '\0', 0, G_OPTION_ARG_NONE, &become_service,
535           N_("Enter GApplication service mode (use from D-Bus service files)") },
536         { NULL }
537       };
538
539       g_option_group_add_entries (gapplication_group, entries);
540     }
541
542   /* Allow overriding the ID if the application allows it */
543   if (application->priv->flags & G_APPLICATION_CAN_OVERRIDE_APP_ID)
544     {
545       GOptionEntry entries[] = {
546         { "gapplication-app-id", '\0', 0, G_OPTION_ARG_STRING, &app_id,
547           N_("Override the application’s ID") },
548         { NULL }
549       };
550
551       g_option_group_add_entries (gapplication_group, entries);
552     }
553
554   /* Now we parse... */
555   if (!g_option_context_parse_strv (context, arguments, error))
556     goto out;
557
558   /* Check for --gapplication-service */
559   if (become_service)
560     application->priv->flags |= G_APPLICATION_IS_SERVICE;
561
562   /* Check for --gapplication-app-id */
563   if (app_id)
564     g_application_set_application_id (application, app_id);
565
566   dict = g_variant_dict_new (NULL);
567   if (application->priv->packed_options)
568     {
569       g_application_pack_option_entries (application, dict);
570       g_hash_table_unref (application->priv->packed_options);
571       application->priv->packed_options = NULL;
572     }
573
574 out:
575   /* Make sure we don't run again */
576   application->priv->options_parsed = TRUE;
577
578   g_option_context_free (context);
579   g_free (app_id);
580
581   return dict;
582 }
583
584 static void
585 add_packed_option (GApplication *application,
586                    GOptionEntry *entry)
587 {
588   switch (entry->arg)
589     {
590     case G_OPTION_ARG_NONE:
591       entry->arg_data = g_new (gboolean, 1);
592       *(gboolean *) entry->arg_data = 2;
593       break;
594
595     case G_OPTION_ARG_INT:
596       entry->arg_data = g_new0 (gint, 1);
597       break;
598
599     case G_OPTION_ARG_STRING:
600     case G_OPTION_ARG_FILENAME:
601     case G_OPTION_ARG_STRING_ARRAY:
602     case G_OPTION_ARG_FILENAME_ARRAY:
603       entry->arg_data = g_new0 (gpointer, 1);
604       break;
605
606     case G_OPTION_ARG_INT64:
607       entry->arg_data = g_new0 (gint64, 1);
608       break;
609
610     case G_OPTION_ARG_DOUBLE:
611       entry->arg_data = g_new0 (gdouble, 1);
612       break;
613
614     default:
615       g_return_if_reached ();
616     }
617
618   if (!application->priv->packed_options)
619     application->priv->packed_options = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, free_option_entry);
620
621   g_hash_table_insert (application->priv->packed_options,
622                        g_strdup (entry->long_name),
623                        g_slice_dup (GOptionEntry, entry));
624 }
625
626 /**
627  * g_application_add_main_option_entries:
628  * @application: a #GApplication
629  * @entries: (array zero-terminated=1) (element-type GOptionEntry) a
630  *           %NULL-terminated list of #GOptionEntrys
631  *
632  * Adds main option entries to be handled by @application.
633  *
634  * This function is comparable to g_option_context_add_main_entries().
635  *
636  * After the commandline arguments are parsed, the
637  * #GApplication::handle-local-options signal will be emitted.  At this
638  * point, the application can inspect the values pointed to by @arg_data
639  * in the given #GOptionEntrys.
640  *
641  * Unlike #GOptionContext, #GApplication supports giving a %NULL
642  * @arg_data for a non-callback #GOptionEntry.  This results in the
643  * argument in question being packed into a #GVariantDict which is also
644  * passed to #GApplication::handle-local-options, where it can be
645  * inspected and modified.  If %G_APPLICATION_HANDLES_COMMAND_LINE is
646  * set, then the resulting dictionary is sent to the primary instance,
647  * where g_application_command_line_get_options_dict() will return it.
648  * This "packing" is done according to the type of the argument --
649  * booleans for normal flags, strings for strings, bytestrings for
650  * filenames, etc.  The packing only occurs if the flag is given (ie: we
651  * do not pack a "false" #GVariant in the case that a flag is missing).
652  *
653  * In general, it is recommended that all commandline arguments are
654  * parsed locally.  The options dictionary should then be used to
655  * transmit the result of the parsing to the primary instance, where
656  * g_variant_dict_lookup() can be used.  For local options, it is
657  * possible to either use @arg_data in the usual way, or to consult (and
658  * potentially remove) the option from the options dictionary.
659  *
660  * This function is new in GLib 2.40.  Before then, the only real choice
661  * was to send all of the commandline arguments (options and all) to the
662  * primary instance for handling.  #GApplication ignored them completely
663  * on the local side.  Calling this function "opts in" to the new
664  * behaviour, and in particular, means that unrecognised options will be
665  * treated as errors.  Unrecognised options have never been ignored when
666  * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
667  *
668  * If #GApplication::handle-local-options needs to see the list of
669  * filenames, then the use of %G_OPTION_REMAINING is recommended.  If
670  * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
671  * the options dictionary.  If you do use %G_OPTION_REMAINING then you
672  * need to handle these arguments for yourself because once they are
673  * consumed, they will no longer be visible to the default handling
674  * (which treats them as filenames to be opened).
675  *
676  * It is important to use the proper GVariant format when retrieving
677  * the options with g_variant_dict_lookup():
678  * - for %G_OPTION_ARG_NONE, use b
679  * - for %G_OPTION_ARG_STRING, use &s
680  * - for %G_OPTION_ARG_INT, use i
681  * - for %G_OPTION_ARG_INT64, use x
682  * - for %G_OPTION_ARG_DOUBLE, use d
683  * - for %G_OPTION_ARG_FILENAME, use ^ay
684  * - for %G_OPTION_ARG_STRING_ARRAY, use &as
685  * - for %G_OPTION_ARG_FILENAME_ARRAY, use ^aay
686  *
687  * Since: 2.40
688  */
689 void
690 g_application_add_main_option_entries (GApplication       *application,
691                                        const GOptionEntry *entries)
692 {
693   gint i;
694
695   g_return_if_fail (G_IS_APPLICATION (application));
696   g_return_if_fail (entries != NULL);
697
698   if (!application->priv->main_options)
699     {
700       application->priv->main_options = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
701       g_option_group_set_translation_domain (application->priv->main_options, NULL);
702     }
703
704   for (i = 0; entries[i].long_name; i++)
705     {
706       GOptionEntry my_entries[2] = { { NULL }, { NULL } };
707       my_entries[0] = entries[i];
708
709       if (!my_entries[0].arg_data)
710         add_packed_option (application, &my_entries[0]);
711
712       g_option_group_add_entries (application->priv->main_options, my_entries);
713     }
714 }
715
716 /**
717  * g_application_add_main_option:
718  * @application: the #GApplication
719  * @long_name: the long name of an option used to specify it in a commandline
720  * @short_name: the short name of an option
721  * @flags: flags from #GOptionFlags
722  * @arg: the type of the option, as a #GOptionArg
723  * @description: the description for the option in `--help` output
724  * @arg_description: (nullable): the placeholder to use for the extra argument
725  *    parsed by the option in `--help` output
726  *
727  * Add an option to be handled by @application.
728  *
729  * Calling this function is the equivalent of calling
730  * g_application_add_main_option_entries() with a single #GOptionEntry
731  * that has its arg_data member set to %NULL.
732  *
733  * The parsed arguments will be packed into a #GVariantDict which
734  * is passed to #GApplication::handle-local-options. If
735  * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also
736  * be sent to the primary instance. See
737  * g_application_add_main_option_entries() for more details.
738  *
739  * See #GOptionEntry for more documentation of the arguments.
740  *
741  * Since: 2.42
742  **/
743 void
744 g_application_add_main_option (GApplication *application,
745                                const char   *long_name,
746                                char          short_name,
747                                GOptionFlags  flags,
748                                GOptionArg    arg,
749                                const char   *description,
750                                const char   *arg_description)
751 {
752   gchar *dup_string;
753   GOptionEntry my_entry[2] = {
754     { NULL, short_name, flags, arg, NULL, NULL, NULL },
755     { NULL }
756   };
757
758   g_return_if_fail (G_IS_APPLICATION (application));
759   g_return_if_fail (long_name != NULL);
760   g_return_if_fail (description != NULL);
761
762   my_entry[0].long_name = dup_string = g_strdup (long_name);
763   application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
764
765   my_entry[0].description = dup_string = g_strdup (description);
766   application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
767
768   my_entry[0].arg_description = dup_string = g_strdup (arg_description);
769   application->priv->option_strings = g_slist_prepend (application->priv->option_strings, dup_string);
770
771   g_application_add_main_option_entries (application, my_entry);
772 }
773
774 /**
775  * g_application_add_option_group:
776  * @application: the #GApplication
777  * @group: (transfer full): a #GOptionGroup
778  *
779  * Adds a #GOptionGroup to the commandline handling of @application.
780  *
781  * This function is comparable to g_option_context_add_group().
782  *
783  * Unlike g_application_add_main_option_entries(), this function does
784  * not deal with %NULL @arg_data and never transmits options to the
785  * primary instance.
786  *
787  * The reason for that is because, by the time the options arrive at the
788  * primary instance, it is typically too late to do anything with them.
789  * Taking the GTK option group as an example: GTK will already have been
790  * initialised by the time the #GApplication::command-line handler runs.
791  * In the case that this is not the first-running instance of the
792  * application, the existing instance may already have been running for
793  * a very long time.
794  *
795  * This means that the options from #GOptionGroup are only really usable
796  * in the case that the instance of the application being run is the
797  * first instance.  Passing options like `--display=` or `--gdk-debug=`
798  * on future runs will have no effect on the existing primary instance.
799  *
800  * Calling this function will cause the options in the supplied option
801  * group to be parsed, but it does not cause you to be "opted in" to the
802  * new functionality whereby unrecognised options are rejected even if
803  * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
804  *
805  * Since: 2.40
806  **/
807 void
808 g_application_add_option_group (GApplication *application,
809                                 GOptionGroup *group)
810 {
811   g_return_if_fail (G_IS_APPLICATION (application));
812   g_return_if_fail (group != NULL);
813
814   application->priv->option_groups = g_slist_prepend (application->priv->option_groups, group);
815 }
816
817 /* vfunc defaults {{{1 */
818 static void
819 g_application_real_before_emit (GApplication *application,
820                                 GVariant     *platform_data)
821 {
822 }
823
824 static void
825 g_application_real_after_emit (GApplication *application,
826                                GVariant     *platform_data)
827 {
828 }
829
830 static void
831 g_application_real_startup (GApplication *application)
832 {
833   application->priv->did_startup = TRUE;
834 }
835
836 static void
837 g_application_real_shutdown (GApplication *application)
838 {
839   application->priv->did_shutdown = TRUE;
840 }
841
842 static void
843 g_application_real_activate (GApplication *application)
844 {
845   if (!g_signal_has_handler_pending (application,
846                                      g_application_signals[SIGNAL_ACTIVATE],
847                                      0, TRUE) &&
848       G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
849     {
850       static gboolean warned;
851
852       if (warned)
853         return;
854
855       g_warning ("Your application does not implement "
856                  "g_application_activate() and has no handlers connected "
857                  "to the 'activate' signal.  It should do one of these.");
858       warned = TRUE;
859     }
860 }
861
862 static void
863 g_application_real_open (GApplication  *application,
864                          GFile        **files,
865                          gint           n_files,
866                          const gchar   *hint)
867 {
868   if (!g_signal_has_handler_pending (application,
869                                      g_application_signals[SIGNAL_OPEN],
870                                      0, TRUE) &&
871       G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
872     {
873       static gboolean warned;
874
875       if (warned)
876         return;
877
878       g_warning ("Your application claims to support opening files "
879                  "but does not implement g_application_open() and has no "
880                  "handlers connected to the 'open' signal.");
881       warned = TRUE;
882     }
883 }
884
885 static int
886 g_application_real_command_line (GApplication            *application,
887                                  GApplicationCommandLine *cmdline)
888 {
889   if (!g_signal_has_handler_pending (application,
890                                      g_application_signals[SIGNAL_COMMAND_LINE],
891                                      0, TRUE) &&
892       G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
893     {
894       static gboolean warned;
895
896       if (warned)
897         return 1;
898
899       g_warning ("Your application claims to support custom command line "
900                  "handling but does not implement g_application_command_line() "
901                  "and has no handlers connected to the 'command-line' signal.");
902
903       warned = TRUE;
904     }
905
906     return 1;
907 }
908
909 static gint
910 g_application_real_handle_local_options (GApplication *application,
911                                          GVariantDict *options)
912 {
913   return -1;
914 }
915
916 static GVariant *
917 get_platform_data (GApplication *application,
918                    GVariant     *options)
919 {
920   GVariantBuilder *builder;
921   GVariant *result;
922
923   builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
924
925   {
926     gchar *cwd = g_get_current_dir ();
927     g_variant_builder_add (builder, "{sv}", "cwd",
928                            g_variant_new_bytestring (cwd));
929     g_free (cwd);
930   }
931
932   if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
933     {
934       GVariant *array;
935       gchar **envp;
936
937       envp = g_get_environ ();
938       array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
939       g_strfreev (envp);
940
941       g_variant_builder_add (builder, "{sv}", "environ", array);
942     }
943
944   if (options)
945     g_variant_builder_add (builder, "{sv}", "options", options);
946
947   G_APPLICATION_GET_CLASS (application)->
948     add_platform_data (application, builder);
949
950   result = g_variant_builder_end (builder);
951   g_variant_builder_unref (builder);
952
953   return result;
954 }
955
956 static void
957 g_application_call_command_line (GApplication        *application,
958                                  const gchar * const *arguments,
959                                  GVariant            *options,
960                                  gint                *exit_status)
961 {
962   if (application->priv->is_remote)
963     {
964       GVariant *platform_data;
965
966       platform_data = get_platform_data (application, options);
967       *exit_status = g_application_impl_command_line (application->priv->impl, arguments, platform_data);
968     }
969   else
970     {
971       GApplicationCommandLine *cmdline;
972       GVariant *v;
973
974       v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
975       cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
976                               "arguments", v,
977                               "options", options,
978                               NULL);
979       g_signal_emit (application, g_application_signals[SIGNAL_COMMAND_LINE], 0, cmdline, exit_status);
980       g_object_unref (cmdline);
981     }
982 }
983
984 static gboolean
985 g_application_real_local_command_line (GApplication   *application,
986                                        gchar        ***arguments,
987                                        int            *exit_status)
988 {
989   GError *error = NULL;
990   GVariantDict *options;
991   gint n_args;
992
993   options = g_application_parse_command_line (application, arguments, &error);
994   if (!options)
995     {
996       g_printerr ("%s\n", error->message);
997       *exit_status = 1;
998       return TRUE;
999     }
1000
1001   g_signal_emit (application, g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS], 0, options, exit_status);
1002
1003   if (*exit_status >= 0)
1004     {
1005       g_variant_dict_unref (options);
1006       return TRUE;
1007     }
1008
1009   if (!g_application_register (application, NULL, &error))
1010     {
1011       g_printerr ("Failed to register: %s\n", error->message);
1012       g_variant_dict_unref (options);
1013       g_error_free (error);
1014       *exit_status = 1;
1015       return TRUE;
1016     }
1017
1018   n_args = g_strv_length (*arguments);
1019
1020   if (application->priv->flags & G_APPLICATION_IS_SERVICE)
1021     {
1022       if ((*exit_status = n_args > 1))
1023         {
1024           g_printerr ("GApplication service mode takes no arguments.\n");
1025           application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
1026           *exit_status = 1;
1027         }
1028       else
1029         *exit_status = 0;
1030     }
1031   else if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
1032     {
1033       g_application_call_command_line (application,
1034                                        (const gchar **) *arguments,
1035                                        g_variant_dict_end (options),
1036                                        exit_status);
1037     }
1038   else
1039     {
1040       if (n_args <= 1)
1041         {
1042           g_application_activate (application);
1043           *exit_status = 0;
1044         }
1045
1046       else
1047         {
1048           if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
1049             {
1050               g_critical ("This application can not open files.");
1051               *exit_status = 1;
1052             }
1053           else
1054             {
1055               GFile **files;
1056               gint n_files;
1057               gint i;
1058
1059               n_files = n_args - 1;
1060               files = g_new (GFile *, n_files);
1061
1062               for (i = 0; i < n_files; i++)
1063                 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
1064
1065               g_application_open (application, files, n_files, "");
1066
1067               for (i = 0; i < n_files; i++)
1068                 g_object_unref (files[i]);
1069               g_free (files);
1070
1071               *exit_status = 0;
1072             }
1073         }
1074     }
1075
1076   g_variant_dict_unref (options);
1077
1078   return TRUE;
1079 }
1080
1081 static void
1082 g_application_real_add_platform_data (GApplication    *application,
1083                                       GVariantBuilder *builder)
1084 {
1085 }
1086
1087 static gboolean
1088 g_application_real_dbus_register (GApplication    *application,
1089                                   GDBusConnection *connection,
1090                                   const gchar     *object_path,
1091                                   GError         **error)
1092 {
1093   return TRUE;
1094 }
1095
1096 static void
1097 g_application_real_dbus_unregister (GApplication    *application,
1098                                     GDBusConnection *connection,
1099                                     const gchar     *object_path)
1100 {
1101 }
1102
1103 /* GObject implementation stuff {{{1 */
1104 static void
1105 g_application_set_property (GObject      *object,
1106                             guint         prop_id,
1107                             const GValue *value,
1108                             GParamSpec   *pspec)
1109 {
1110   GApplication *application = G_APPLICATION (object);
1111
1112   switch (prop_id)
1113     {
1114     case PROP_APPLICATION_ID:
1115       g_application_set_application_id (application,
1116                                         g_value_get_string (value));
1117       break;
1118
1119     case PROP_FLAGS:
1120       g_application_set_flags (application, g_value_get_flags (value));
1121       break;
1122
1123     case PROP_RESOURCE_BASE_PATH:
1124       g_application_set_resource_base_path (application, g_value_get_string (value));
1125       break;
1126
1127     case PROP_INACTIVITY_TIMEOUT:
1128       g_application_set_inactivity_timeout (application,
1129                                             g_value_get_uint (value));
1130       break;
1131
1132     case PROP_ACTION_GROUP:
1133       g_clear_object (&application->priv->actions);
1134       application->priv->actions = g_value_dup_object (value);
1135       break;
1136
1137     default:
1138       g_assert_not_reached ();
1139     }
1140 }
1141
1142 /**
1143  * g_application_set_action_group:
1144  * @application: a #GApplication
1145  * @action_group: (nullable): a #GActionGroup, or %NULL
1146  *
1147  * This used to be how actions were associated with a #GApplication.
1148  * Now there is #GActionMap for that.
1149  *
1150  * Since: 2.28
1151  *
1152  * Deprecated:2.32:Use the #GActionMap interface instead.  Never ever
1153  * mix use of this API with use of #GActionMap on the same @application
1154  * or things will go very badly wrong.  This function is known to
1155  * introduce buggy behaviour (ie: signals not emitted on changes to the
1156  * action group), so you should really use #GActionMap instead.
1157  **/
1158 void
1159 g_application_set_action_group (GApplication *application,
1160                                 GActionGroup *action_group)
1161 {
1162   g_return_if_fail (G_IS_APPLICATION (application));
1163   g_return_if_fail (!application->priv->is_registered);
1164
1165   if (application->priv->actions != NULL)
1166     g_object_unref (application->priv->actions);
1167
1168   application->priv->actions = action_group;
1169
1170   if (application->priv->actions != NULL)
1171     g_object_ref (application->priv->actions);
1172 }
1173
1174 static void
1175 g_application_get_property (GObject    *object,
1176                             guint       prop_id,
1177                             GValue     *value,
1178                             GParamSpec *pspec)
1179 {
1180   GApplication *application = G_APPLICATION (object);
1181
1182   switch (prop_id)
1183     {
1184     case PROP_APPLICATION_ID:
1185       g_value_set_string (value,
1186                           g_application_get_application_id (application));
1187       break;
1188
1189     case PROP_FLAGS:
1190       g_value_set_flags (value,
1191                          g_application_get_flags (application));
1192       break;
1193
1194     case PROP_RESOURCE_BASE_PATH:
1195       g_value_set_string (value, g_application_get_resource_base_path (application));
1196       break;
1197
1198     case PROP_IS_REGISTERED:
1199       g_value_set_boolean (value,
1200                            g_application_get_is_registered (application));
1201       break;
1202
1203     case PROP_IS_REMOTE:
1204       g_value_set_boolean (value,
1205                            g_application_get_is_remote (application));
1206       break;
1207
1208     case PROP_INACTIVITY_TIMEOUT:
1209       g_value_set_uint (value,
1210                         g_application_get_inactivity_timeout (application));
1211       break;
1212
1213     case PROP_IS_BUSY:
1214       g_value_set_boolean (value, g_application_get_is_busy (application));
1215       break;
1216
1217     default:
1218       g_assert_not_reached ();
1219     }
1220 }
1221
1222 static void
1223 g_application_constructed (GObject *object)
1224 {
1225   GApplication *application = G_APPLICATION (object);
1226
1227   if (g_application_get_default () == NULL)
1228     g_application_set_default (application);
1229
1230   /* People should not set properties from _init... */
1231   g_assert (application->priv->resource_path == NULL);
1232
1233   if (application->priv->id != NULL)
1234     {
1235       gint i;
1236
1237       application->priv->resource_path = g_strconcat ("/", application->priv->id, NULL);
1238
1239       for (i = 1; application->priv->resource_path[i]; i++)
1240         if (application->priv->resource_path[i] == '.')
1241           application->priv->resource_path[i] = '/';
1242     }
1243 }
1244
1245 static void
1246 g_application_finalize (GObject *object)
1247 {
1248   GApplication *application = G_APPLICATION (object);
1249
1250   g_slist_free_full (application->priv->option_groups, (GDestroyNotify) g_option_group_unref);
1251   if (application->priv->main_options)
1252     g_option_group_unref (application->priv->main_options);
1253   if (application->priv->packed_options)
1254     g_hash_table_unref (application->priv->packed_options);
1255
1256   g_slist_free_full (application->priv->option_strings, g_free);
1257
1258   if (application->priv->impl)
1259     g_application_impl_destroy (application->priv->impl);
1260   g_free (application->priv->id);
1261
1262   if (g_application_get_default () == application)
1263     g_application_set_default (NULL);
1264
1265   if (application->priv->actions)
1266     g_object_unref (application->priv->actions);
1267
1268   if (application->priv->notifications)
1269     g_object_unref (application->priv->notifications);
1270
1271   g_free (application->priv->resource_path);
1272
1273   G_OBJECT_CLASS (g_application_parent_class)
1274     ->finalize (object);
1275 }
1276
1277 static void
1278 g_application_init (GApplication *application)
1279 {
1280   application->priv = g_application_get_instance_private (application);
1281
1282   application->priv->actions = g_application_exported_actions_new (application);
1283
1284   /* application->priv->actions is the one and only ref on the group, so when
1285    * we dispose, the action group will die, disconnecting all signals.
1286    */
1287   g_signal_connect_swapped (application->priv->actions, "action-added",
1288                             G_CALLBACK (g_action_group_action_added), application);
1289   g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
1290                             G_CALLBACK (g_action_group_action_enabled_changed), application);
1291   g_signal_connect_swapped (application->priv->actions, "action-state-changed",
1292                             G_CALLBACK (g_action_group_action_state_changed), application);
1293   g_signal_connect_swapped (application->priv->actions, "action-removed",
1294                             G_CALLBACK (g_action_group_action_removed), application);
1295 }
1296
1297 static gboolean
1298 g_application_handle_local_options_accumulator (GSignalInvocationHint *ihint,
1299                                                 GValue                *return_accu,
1300                                                 const GValue          *handler_return,
1301                                                 gpointer               dummy)
1302 {
1303   gint value;
1304
1305   value = g_value_get_int (handler_return);
1306   g_value_set_int (return_accu, value);
1307
1308   return value < 0;
1309 }
1310
1311 static void
1312 g_application_class_init (GApplicationClass *class)
1313 {
1314   GObjectClass *object_class = G_OBJECT_CLASS (class);
1315
1316   object_class->constructed = g_application_constructed;
1317   object_class->finalize = g_application_finalize;
1318   object_class->get_property = g_application_get_property;
1319   object_class->set_property = g_application_set_property;
1320
1321   class->before_emit = g_application_real_before_emit;
1322   class->after_emit = g_application_real_after_emit;
1323   class->startup = g_application_real_startup;
1324   class->shutdown = g_application_real_shutdown;
1325   class->activate = g_application_real_activate;
1326   class->open = g_application_real_open;
1327   class->command_line = g_application_real_command_line;
1328   class->local_command_line = g_application_real_local_command_line;
1329   class->handle_local_options = g_application_real_handle_local_options;
1330   class->add_platform_data = g_application_real_add_platform_data;
1331   class->dbus_register = g_application_real_dbus_register;
1332   class->dbus_unregister = g_application_real_dbus_unregister;
1333
1334   g_object_class_install_property (object_class, PROP_APPLICATION_ID,
1335     g_param_spec_string ("application-id",
1336                          P_("Application identifier"),
1337                          P_("The unique identifier for the application"),
1338                          NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
1339                          G_PARAM_STATIC_STRINGS));
1340
1341   g_object_class_install_property (object_class, PROP_FLAGS,
1342     g_param_spec_flags ("flags",
1343                         P_("Application flags"),
1344                         P_("Flags specifying the behaviour of the application"),
1345                         G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
1346                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1347
1348   g_object_class_install_property (object_class, PROP_RESOURCE_BASE_PATH,
1349     g_param_spec_string ("resource-base-path",
1350                          P_("Resource base path"),
1351                          P_("The base resource path for the application"),
1352                          NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1353
1354   g_object_class_install_property (object_class, PROP_IS_REGISTERED,
1355     g_param_spec_boolean ("is-registered",
1356                           P_("Is registered"),
1357                           P_("If g_application_register() has been called"),
1358                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1359
1360   g_object_class_install_property (object_class, PROP_IS_REMOTE,
1361     g_param_spec_boolean ("is-remote",
1362                           P_("Is remote"),
1363                           P_("If this application instance is remote"),
1364                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1365
1366   g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
1367     g_param_spec_uint ("inactivity-timeout",
1368                        P_("Inactivity timeout"),
1369                        P_("Time (ms) to stay alive after becoming idle"),
1370                        0, G_MAXUINT, 0,
1371                        G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1372
1373   g_object_class_install_property (object_class, PROP_ACTION_GROUP,
1374     g_param_spec_object ("action-group",
1375                          P_("Action group"),
1376                          P_("The group of actions that the application exports"),
1377                          G_TYPE_ACTION_GROUP,
1378                          G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
1379
1380   /**
1381    * GApplication:is-busy:
1382    *
1383    * Whether the application is currently marked as busy through
1384    * g_application_mark_busy() or g_application_bind_busy_property().
1385    *
1386    * Since: 2.44
1387    */
1388   g_object_class_install_property (object_class, PROP_IS_BUSY,
1389     g_param_spec_boolean ("is-busy",
1390                           P_("Is busy"),
1391                           P_("If this application is currently marked busy"),
1392                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1393
1394   /**
1395    * GApplication::startup:
1396    * @application: the application
1397    *
1398    * The ::startup signal is emitted on the primary instance immediately
1399    * after registration. See g_application_register().
1400    */
1401   g_application_signals[SIGNAL_STARTUP] =
1402     g_signal_new (I_("startup"), G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
1403                   G_STRUCT_OFFSET (GApplicationClass, startup),
1404                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1405
1406   /**
1407    * GApplication::shutdown:
1408    * @application: the application
1409    *
1410    * The ::shutdown signal is emitted only on the registered primary instance
1411    * immediately after the main loop terminates.
1412    */
1413   g_application_signals[SIGNAL_SHUTDOWN] =
1414     g_signal_new (I_("shutdown"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1415                   G_STRUCT_OFFSET (GApplicationClass, shutdown),
1416                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1417
1418   /**
1419    * GApplication::activate:
1420    * @application: the application
1421    *
1422    * The ::activate signal is emitted on the primary instance when an
1423    * activation occurs. See g_application_activate().
1424    */
1425   g_application_signals[SIGNAL_ACTIVATE] =
1426     g_signal_new (I_("activate"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1427                   G_STRUCT_OFFSET (GApplicationClass, activate),
1428                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
1429
1430
1431   /**
1432    * GApplication::open:
1433    * @application: the application
1434    * @files: (array length=n_files) (element-type GFile): an array of #GFiles
1435    * @n_files: the length of @files
1436    * @hint: a hint provided by the calling instance
1437    *
1438    * The ::open signal is emitted on the primary instance when there are
1439    * files to open. See g_application_open() for more information.
1440    */
1441   g_application_signals[SIGNAL_OPEN] =
1442     g_signal_new (I_("open"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1443                   G_STRUCT_OFFSET (GApplicationClass, open),
1444                   NULL, NULL, NULL,
1445                   G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
1446
1447   /**
1448    * GApplication::command-line:
1449    * @application: the application
1450    * @command_line: a #GApplicationCommandLine representing the
1451    *     passed commandline
1452    *
1453    * The ::command-line signal is emitted on the primary instance when
1454    * a commandline is not handled locally. See g_application_run() and
1455    * the #GApplicationCommandLine documentation for more information.
1456    *
1457    * Returns: An integer that is set as the exit status for the calling
1458    *   process. See g_application_command_line_set_exit_status().
1459    */
1460   g_application_signals[SIGNAL_COMMAND_LINE] =
1461     g_signal_new (I_("command-line"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1462                   G_STRUCT_OFFSET (GApplicationClass, command_line),
1463                   g_signal_accumulator_first_wins, NULL,
1464                   NULL,
1465                   G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
1466
1467   /**
1468    * GApplication::handle-local-options:
1469    * @application: the application
1470    * @options: the options dictionary
1471    *
1472    * The ::handle-local-options signal is emitted on the local instance
1473    * after the parsing of the commandline options has occurred.
1474    *
1475    * You can add options to be recognised during commandline option
1476    * parsing using g_application_add_main_option_entries() and
1477    * g_application_add_option_group().
1478    *
1479    * Signal handlers can inspect @options (along with values pointed to
1480    * from the @arg_data of an installed #GOptionEntrys) in order to
1481    * decide to perform certain actions, including direct local handling
1482    * (which may be useful for options like --version).
1483    *
1484    * In the event that the application is marked
1485    * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
1486    * send the @options dictionary to the primary instance where it can be
1487    * read with g_application_command_line_get_options_dict().  The signal
1488    * handler can modify the dictionary before returning, and the
1489    * modified dictionary will be sent.
1490    *
1491    * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
1492    * "normal processing" will treat the remaining uncollected command
1493    * line arguments as filenames or URIs.  If there are no arguments,
1494    * the application is activated by g_application_activate().  One or
1495    * more arguments results in a call to g_application_open().
1496    *
1497    * If you want to handle the local commandline arguments for yourself
1498    * by converting them to calls to g_application_open() or
1499    * g_action_group_activate_action() then you must be sure to register
1500    * the application first.  You should probably not call
1501    * g_application_activate() for yourself, however: just return -1 and
1502    * allow the default handler to do it for you.  This will ensure that
1503    * the `--gapplication-service` switch works properly (i.e. no activation
1504    * in that case).
1505    *
1506    * Note that this signal is emitted from the default implementation of
1507    * local_command_line().  If you override that function and don't
1508    * chain up then this signal will never be emitted.
1509    *
1510    * You can override local_command_line() if you need more powerful
1511    * capabilities than what is provided here, but this should not
1512    * normally be required.
1513    *
1514    * Returns: an exit code. If you have handled your options and want
1515    * to exit the process, return a non-negative option, 0 for success,
1516    * and a positive value for failure. To continue, return -1 to let
1517    * the default option processing continue.
1518    *
1519    * Since: 2.40
1520    **/
1521   g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] =
1522     g_signal_new (I_("handle-local-options"), G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
1523                   G_STRUCT_OFFSET (GApplicationClass, handle_local_options),
1524                   g_application_handle_local_options_accumulator, NULL, NULL,
1525                   G_TYPE_INT, 1, G_TYPE_VARIANT_DICT);
1526
1527 }
1528
1529 /* Application ID validity {{{1 */
1530
1531 /**
1532  * g_application_id_is_valid:
1533  * @application_id: a potential application identifier
1534  *
1535  * Checks if @application_id is a valid application identifier.
1536  *
1537  * A valid ID is required for calls to g_application_new() and
1538  * g_application_set_application_id().
1539  *
1540  * For convenience, the restrictions on application identifiers are
1541  * reproduced here:
1542  *
1543  * - Application identifiers must contain only the ASCII characters
1544  *   "[A-Z][a-z][0-9]_-." and must not begin with a digit.
1545  *
1546  * - Application identifiers must contain at least one '.' (period)
1547  *   character (and thus at least three elements).
1548  *
1549  * - Application identifiers must not begin or end with a '.' (period)
1550  *   character.
1551  *
1552  * - Application identifiers must not contain consecutive '.' (period)
1553  *   characters.
1554  *
1555  * - Application identifiers must not exceed 255 characters.
1556  *
1557  * Returns: %TRUE if @application_id is valid
1558  */
1559 gboolean
1560 g_application_id_is_valid (const gchar *application_id)
1561 {
1562   gsize len;
1563   gboolean allow_dot;
1564   gboolean has_dot;
1565
1566   len = strlen (application_id);
1567
1568   if (len > 255)
1569     return FALSE;
1570
1571   if (!g_ascii_isalpha (application_id[0]))
1572     return FALSE;
1573
1574   if (application_id[len-1] == '.')
1575     return FALSE;
1576
1577   application_id++;
1578   allow_dot = TRUE;
1579   has_dot = FALSE;
1580   for (; *application_id; application_id++)
1581     {
1582       if (g_ascii_isalnum (*application_id) ||
1583           (*application_id == '-') ||
1584           (*application_id == '_'))
1585         {
1586           allow_dot = TRUE;
1587         }
1588       else if (allow_dot && *application_id == '.')
1589         {
1590           has_dot = TRUE;
1591           allow_dot = FALSE;
1592         }
1593       else
1594         return FALSE;
1595     }
1596
1597   if (!has_dot)
1598     return FALSE;
1599
1600   return TRUE;
1601 }
1602
1603 /* Public Constructor {{{1 */
1604 /**
1605  * g_application_new:
1606  * @application_id: (nullable): the application id
1607  * @flags: the application flags
1608  *
1609  * Creates a new #GApplication instance.
1610  *
1611  * If non-%NULL, the application id must be valid.  See
1612  * g_application_id_is_valid().
1613  *
1614  * If no application ID is given then some features of #GApplication
1615  * (most notably application uniqueness) will be disabled.
1616  *
1617  * Returns: a new #GApplication instance
1618  **/
1619 GApplication *
1620 g_application_new (const gchar       *application_id,
1621                    GApplicationFlags  flags)
1622 {
1623   g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1624
1625   return g_object_new (G_TYPE_APPLICATION,
1626                        "application-id", application_id,
1627                        "flags", flags,
1628                        NULL);
1629 }
1630
1631 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1632 /**
1633  * g_application_get_application_id:
1634  * @application: a #GApplication
1635  *
1636  * Gets the unique identifier for @application.
1637  *
1638  * Returns: the identifier for @application, owned by @application
1639  *
1640  * Since: 2.28
1641  **/
1642 const gchar *
1643 g_application_get_application_id (GApplication *application)
1644 {
1645   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1646
1647   return application->priv->id;
1648 }
1649
1650 /**
1651  * g_application_set_application_id:
1652  * @application: a #GApplication
1653  * @application_id: (nullable): the identifier for @application
1654  *
1655  * Sets the unique identifier for @application.
1656  *
1657  * The application id can only be modified if @application has not yet
1658  * been registered.
1659  *
1660  * If non-%NULL, the application id must be valid.  See
1661  * g_application_id_is_valid().
1662  *
1663  * Since: 2.28
1664  **/
1665 void
1666 g_application_set_application_id (GApplication *application,
1667                                   const gchar  *application_id)
1668 {
1669   g_return_if_fail (G_IS_APPLICATION (application));
1670
1671   if (g_strcmp0 (application->priv->id, application_id) != 0)
1672     {
1673       g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1674       g_return_if_fail (!application->priv->is_registered);
1675
1676       g_free (application->priv->id);
1677       application->priv->id = g_strdup (application_id);
1678
1679       g_object_notify (G_OBJECT (application), "application-id");
1680     }
1681 }
1682
1683 /**
1684  * g_application_get_flags:
1685  * @application: a #GApplication
1686  *
1687  * Gets the flags for @application.
1688  *
1689  * See #GApplicationFlags.
1690  *
1691  * Returns: the flags for @application
1692  *
1693  * Since: 2.28
1694  **/
1695 GApplicationFlags
1696 g_application_get_flags (GApplication *application)
1697 {
1698   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1699
1700   return application->priv->flags;
1701 }
1702
1703 /**
1704  * g_application_set_flags:
1705  * @application: a #GApplication
1706  * @flags: the flags for @application
1707  *
1708  * Sets the flags for @application.
1709  *
1710  * The flags can only be modified if @application has not yet been
1711  * registered.
1712  *
1713  * See #GApplicationFlags.
1714  *
1715  * Since: 2.28
1716  **/
1717 void
1718 g_application_set_flags (GApplication      *application,
1719                          GApplicationFlags  flags)
1720 {
1721   g_return_if_fail (G_IS_APPLICATION (application));
1722
1723   if (application->priv->flags != flags)
1724     {
1725       g_return_if_fail (!application->priv->is_registered);
1726
1727       application->priv->flags = flags;
1728
1729       g_object_notify (G_OBJECT (application), "flags");
1730     }
1731 }
1732
1733 /**
1734  * g_application_get_resource_base_path:
1735  * @application: a #GApplication
1736  *
1737  * Gets the resource base path of @application.
1738  *
1739  * See g_application_set_resource_base_path() for more information.
1740  *
1741  * Returns: (nullable): the base resource path, if one is set
1742  *
1743  * Since: 2.42
1744  */
1745 const gchar *
1746 g_application_get_resource_base_path (GApplication *application)
1747 {
1748   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1749
1750   return application->priv->resource_path;
1751 }
1752
1753 /**
1754  * g_application_set_resource_base_path:
1755  * @application: a #GApplication
1756  * @resource_path: (nullable): the resource path to use
1757  *
1758  * Sets (or unsets) the base resource path of @application.
1759  *
1760  * The path is used to automatically load various [application
1761  * resources][gresource] such as menu layouts and action descriptions.
1762  * The various types of resources will be found at fixed names relative
1763  * to the given base path.
1764  *
1765  * By default, the resource base path is determined from the application
1766  * ID by prefixing '/' and replacing each '.' with '/'.  This is done at
1767  * the time that the #GApplication object is constructed.  Changes to
1768  * the application ID after that point will not have an impact on the
1769  * resource base path.
1770  *
1771  * As an example, if the application has an ID of "org.example.app" then
1772  * the default resource base path will be "/org/example/app".  If this
1773  * is a #GtkApplication (and you have not manually changed the path)
1774  * then Gtk will then search for the menus of the application at
1775  * "/org/example/app/gtk/menus.ui".
1776  *
1777  * See #GResource for more information about adding resources to your
1778  * application.
1779  *
1780  * You can disable automatic resource loading functionality by setting
1781  * the path to %NULL.
1782  *
1783  * Changing the resource base path once the application is running is
1784  * not recommended.  The point at which the resource path is consulted
1785  * for forming paths for various purposes is unspecified.  When writing
1786  * a sub-class of #GApplication you should either set the
1787  * #GApplication:resource-base-path property at construction time, or call
1788  * this function during the instance initialization. Alternatively, you
1789  * can call this function in the #GApplicationClass.startup virtual function,
1790  * before chaining up to the parent implementation.
1791  *
1792  * Since: 2.42
1793  */
1794 void
1795 g_application_set_resource_base_path (GApplication *application,
1796                                       const gchar  *resource_path)
1797 {
1798   g_return_if_fail (G_IS_APPLICATION (application));
1799   g_return_if_fail (resource_path == NULL || g_str_has_prefix (resource_path, "/"));
1800
1801   if (g_strcmp0 (application->priv->resource_path, resource_path) != 0)
1802     {
1803       g_free (application->priv->resource_path);
1804
1805       application->priv->resource_path = g_strdup (resource_path);
1806
1807       g_object_notify (G_OBJECT (application), "resource-base-path");
1808     }
1809 }
1810
1811 /**
1812  * g_application_get_inactivity_timeout:
1813  * @application: a #GApplication
1814  *
1815  * Gets the current inactivity timeout for the application.
1816  *
1817  * This is the amount of time (in milliseconds) after the last call to
1818  * g_application_release() before the application stops running.
1819  *
1820  * Returns: the timeout, in milliseconds
1821  *
1822  * Since: 2.28
1823  **/
1824 guint
1825 g_application_get_inactivity_timeout (GApplication *application)
1826 {
1827   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1828
1829   return application->priv->inactivity_timeout;
1830 }
1831
1832 /**
1833  * g_application_set_inactivity_timeout:
1834  * @application: a #GApplication
1835  * @inactivity_timeout: the timeout, in milliseconds
1836  *
1837  * Sets the current inactivity timeout for the application.
1838  *
1839  * This is the amount of time (in milliseconds) after the last call to
1840  * g_application_release() before the application stops running.
1841  *
1842  * This call has no side effects of its own.  The value set here is only
1843  * used for next time g_application_release() drops the use count to
1844  * zero.  Any timeouts currently in progress are not impacted.
1845  *
1846  * Since: 2.28
1847  **/
1848 void
1849 g_application_set_inactivity_timeout (GApplication *application,
1850                                       guint         inactivity_timeout)
1851 {
1852   g_return_if_fail (G_IS_APPLICATION (application));
1853
1854   if (application->priv->inactivity_timeout != inactivity_timeout)
1855     {
1856       application->priv->inactivity_timeout = inactivity_timeout;
1857
1858       g_object_notify (G_OBJECT (application), "inactivity-timeout");
1859     }
1860 }
1861 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
1862 /**
1863  * g_application_get_is_registered:
1864  * @application: a #GApplication
1865  *
1866  * Checks if @application is registered.
1867  *
1868  * An application is registered if g_application_register() has been
1869  * successfully called.
1870  *
1871  * Returns: %TRUE if @application is registered
1872  *
1873  * Since: 2.28
1874  **/
1875 gboolean
1876 g_application_get_is_registered (GApplication *application)
1877 {
1878   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1879
1880   return application->priv->is_registered;
1881 }
1882
1883 /**
1884  * g_application_get_is_remote:
1885  * @application: a #GApplication
1886  *
1887  * Checks if @application is remote.
1888  *
1889  * If @application is remote then it means that another instance of
1890  * application already exists (the 'primary' instance).  Calls to
1891  * perform actions on @application will result in the actions being
1892  * performed by the primary instance.
1893  *
1894  * The value of this property cannot be accessed before
1895  * g_application_register() has been called.  See
1896  * g_application_get_is_registered().
1897  *
1898  * Returns: %TRUE if @application is remote
1899  *
1900  * Since: 2.28
1901  **/
1902 gboolean
1903 g_application_get_is_remote (GApplication *application)
1904 {
1905   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1906   g_return_val_if_fail (application->priv->is_registered, FALSE);
1907
1908   return application->priv->is_remote;
1909 }
1910
1911 /**
1912  * g_application_get_dbus_connection:
1913  * @application: a #GApplication
1914  *
1915  * Gets the #GDBusConnection being used by the application, or %NULL.
1916  *
1917  * If #GApplication is using its D-Bus backend then this function will
1918  * return the #GDBusConnection being used for uniqueness and
1919  * communication with the desktop environment and other instances of the
1920  * application.
1921  *
1922  * If #GApplication is not using D-Bus then this function will return
1923  * %NULL.  This includes the situation where the D-Bus backend would
1924  * normally be in use but we were unable to connect to the bus.
1925  *
1926  * This function must not be called before the application has been
1927  * registered.  See g_application_get_is_registered().
1928  *
1929  * Returns: (transfer none): a #GDBusConnection, or %NULL
1930  *
1931  * Since: 2.34
1932  **/
1933 GDBusConnection *
1934 g_application_get_dbus_connection (GApplication *application)
1935 {
1936   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1937   g_return_val_if_fail (application->priv->is_registered, FALSE);
1938
1939   return g_application_impl_get_dbus_connection (application->priv->impl);
1940 }
1941
1942 /**
1943  * g_application_get_dbus_object_path:
1944  * @application: a #GApplication
1945  *
1946  * Gets the D-Bus object path being used by the application, or %NULL.
1947  *
1948  * If #GApplication is using its D-Bus backend then this function will
1949  * return the D-Bus object path that #GApplication is using.  If the
1950  * application is the primary instance then there is an object published
1951  * at this path.  If the application is not the primary instance then
1952  * the result of this function is undefined.
1953  *
1954  * If #GApplication is not using D-Bus then this function will return
1955  * %NULL.  This includes the situation where the D-Bus backend would
1956  * normally be in use but we were unable to connect to the bus.
1957  *
1958  * This function must not be called before the application has been
1959  * registered.  See g_application_get_is_registered().
1960  *
1961  * Returns: the object path, or %NULL
1962  *
1963  * Since: 2.34
1964  **/
1965 const gchar *
1966 g_application_get_dbus_object_path (GApplication *application)
1967 {
1968   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1969   g_return_val_if_fail (application->priv->is_registered, FALSE);
1970
1971   return g_application_impl_get_dbus_object_path (application->priv->impl);
1972 }
1973
1974
1975 /* Register {{{1 */
1976 /**
1977  * g_application_register:
1978  * @application: a #GApplication
1979  * @cancellable: (nullable): a #GCancellable, or %NULL
1980  * @error: a pointer to a NULL #GError, or %NULL
1981  *
1982  * Attempts registration of the application.
1983  *
1984  * This is the point at which the application discovers if it is the
1985  * primary instance or merely acting as a remote for an already-existing
1986  * primary instance.  This is implemented by attempting to acquire the
1987  * application identifier as a unique bus name on the session bus using
1988  * GDBus.
1989  *
1990  * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1991  * given, then this process will always become the primary instance.
1992  *
1993  * Due to the internal architecture of GDBus, method calls can be
1994  * dispatched at any time (even if a main loop is not running).  For
1995  * this reason, you must ensure that any object paths that you wish to
1996  * register are registered before calling this function.
1997  *
1998  * If the application has already been registered then %TRUE is
1999  * returned with no work performed.
2000  *
2001  * The #GApplication::startup signal is emitted if registration succeeds
2002  * and @application is the primary instance (including the non-unique
2003  * case).
2004  *
2005  * In the event of an error (such as @cancellable being cancelled, or a
2006  * failure to connect to the session bus), %FALSE is returned and @error
2007  * is set appropriately.
2008  *
2009  * Note: the return value of this function is not an indicator that this
2010  * instance is or is not the primary instance of the application.  See
2011  * g_application_get_is_remote() for that.
2012  *
2013  * Returns: %TRUE if registration succeeded
2014  *
2015  * Since: 2.28
2016  **/
2017 gboolean
2018 g_application_register (GApplication  *application,
2019                         GCancellable  *cancellable,
2020                         GError       **error)
2021 {
2022   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2023
2024   if (!application->priv->is_registered)
2025     {
2026       if (application->priv->id == NULL)
2027         application->priv->flags |= G_APPLICATION_NON_UNIQUE;
2028
2029       application->priv->impl =
2030         g_application_impl_register (application, application->priv->id,
2031                                      application->priv->flags,
2032                                      application->priv->actions,
2033                                      &application->priv->remote_actions,
2034                                      cancellable, error);
2035
2036       if (application->priv->impl == NULL)
2037         return FALSE;
2038
2039       application->priv->is_remote = application->priv->remote_actions != NULL;
2040       application->priv->is_registered = TRUE;
2041
2042       g_object_notify (G_OBJECT (application), "is-registered");
2043
2044       if (!application->priv->is_remote)
2045         {
2046           g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
2047
2048           if (!application->priv->did_startup)
2049             g_critical ("GApplication subclass '%s' failed to chain up on"
2050                         " ::startup (from start of override function)",
2051                         G_OBJECT_TYPE_NAME (application));
2052         }
2053     }
2054
2055   return TRUE;
2056 }
2057
2058 /* Hold/release {{{1 */
2059 /**
2060  * g_application_hold:
2061  * @application: a #GApplication
2062  *
2063  * Increases the use count of @application.
2064  *
2065  * Use this function to indicate that the application has a reason to
2066  * continue to run.  For example, g_application_hold() is called by GTK+
2067  * when a toplevel window is on the screen.
2068  *
2069  * To cancel the hold, call g_application_release().
2070  **/
2071 void
2072 g_application_hold (GApplication *application)
2073 {
2074   g_return_if_fail (G_IS_APPLICATION (application));
2075
2076   if (application->priv->inactivity_timeout_id)
2077     {
2078       g_source_remove (application->priv->inactivity_timeout_id);
2079       application->priv->inactivity_timeout_id = 0;
2080     }
2081
2082   application->priv->use_count++;
2083 }
2084
2085 static gboolean
2086 inactivity_timeout_expired (gpointer data)
2087 {
2088   GApplication *application = G_APPLICATION (data);
2089
2090   application->priv->inactivity_timeout_id = 0;
2091
2092   return G_SOURCE_REMOVE;
2093 }
2094
2095
2096 /**
2097  * g_application_release:
2098  * @application: a #GApplication
2099  *
2100  * Decrease the use count of @application.
2101  *
2102  * When the use count reaches zero, the application will stop running.
2103  *
2104  * Never call this function except to cancel the effect of a previous
2105  * call to g_application_hold().
2106  **/
2107 void
2108 g_application_release (GApplication *application)
2109 {
2110   g_return_if_fail (G_IS_APPLICATION (application));
2111   g_return_if_fail (application->priv->use_count > 0);
2112
2113   application->priv->use_count--;
2114
2115   if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
2116     application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
2117                                                               inactivity_timeout_expired, application);
2118 }
2119
2120 /* Activate, Open {{{1 */
2121 /**
2122  * g_application_activate:
2123  * @application: a #GApplication
2124  *
2125  * Activates the application.
2126  *
2127  * In essence, this results in the #GApplication::activate signal being
2128  * emitted in the primary instance.
2129  *
2130  * The application must be registered before calling this function.
2131  *
2132  * Since: 2.28
2133  **/
2134 void
2135 g_application_activate (GApplication *application)
2136 {
2137   g_return_if_fail (G_IS_APPLICATION (application));
2138   g_return_if_fail (application->priv->is_registered);
2139
2140   if (application->priv->is_remote)
2141     g_application_impl_activate (application->priv->impl,
2142                                  get_platform_data (application, NULL));
2143
2144   else
2145     g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
2146 }
2147
2148 /**
2149  * g_application_open:
2150  * @application: a #GApplication
2151  * @files: (array length=n_files): an array of #GFiles to open
2152  * @n_files: the length of the @files array
2153  * @hint: a hint (or ""), but never %NULL
2154  *
2155  * Opens the given files.
2156  *
2157  * In essence, this results in the #GApplication::open signal being emitted
2158  * in the primary instance.
2159  *
2160  * @n_files must be greater than zero.
2161  *
2162  * @hint is simply passed through to the ::open signal.  It is
2163  * intended to be used by applications that have multiple modes for
2164  * opening files (eg: "view" vs "edit", etc).  Unless you have a need
2165  * for this functionality, you should use "".
2166  *
2167  * The application must be registered before calling this function
2168  * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
2169  *
2170  * Since: 2.28
2171  **/
2172 void
2173 g_application_open (GApplication  *application,
2174                     GFile        **files,
2175                     gint           n_files,
2176                     const gchar   *hint)
2177 {
2178   g_return_if_fail (G_IS_APPLICATION (application));
2179   g_return_if_fail (application->priv->flags &
2180                     G_APPLICATION_HANDLES_OPEN);
2181   g_return_if_fail (application->priv->is_registered);
2182
2183   if (application->priv->is_remote)
2184     g_application_impl_open (application->priv->impl,
2185                              files, n_files, hint,
2186                              get_platform_data (application, NULL));
2187
2188   else
2189     g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
2190                    0, files, n_files, hint);
2191 }
2192
2193 /* Run {{{1 */
2194 /**
2195  * g_application_run:
2196  * @application: a #GApplication
2197  * @argc: the argc from main() (or 0 if @argv is %NULL)
2198  * @argv: (array length=argc) (nullable): the argv from main(), or %NULL
2199  *
2200  * Runs the application.
2201  *
2202  * This function is intended to be run from main() and its return value
2203  * is intended to be returned by main(). Although you are expected to pass
2204  * the @argc, @argv parameters from main() to this function, it is possible
2205  * to pass %NULL if @argv is not available or commandline handling is not
2206  * required.  Note that on Windows, @argc and @argv are ignored, and
2207  * g_win32_get_command_line() is called internally (for proper support
2208  * of Unicode commandline arguments).
2209  *
2210  * #GApplication will attempt to parse the commandline arguments.  You
2211  * can add commandline flags to the list of recognised options by way of
2212  * g_application_add_main_option_entries().  After this, the
2213  * #GApplication::handle-local-options signal is emitted, from which the
2214  * application can inspect the values of its #GOptionEntrys.
2215  *
2216  * #GApplication::handle-local-options is a good place to handle options
2217  * such as `--version`, where an immediate reply from the local process is
2218  * desired (instead of communicating with an already-running instance).
2219  * A #GApplication::handle-local-options handler can stop further processing
2220  * by returning a non-negative value, which then becomes the exit status of
2221  * the process.
2222  *
2223  * What happens next depends on the flags: if
2224  * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
2225  * commandline arguments are sent to the primary instance, where a
2226  * #GApplication::command-line signal is emitted.  Otherwise, the
2227  * remaining commandline arguments are assumed to be a list of files.
2228  * If there are no files listed, the application is activated via the
2229  * #GApplication::activate signal.  If there are one or more files, and
2230  * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
2231  * via the #GApplication::open signal.
2232  *
2233  * If you are interested in doing more complicated local handling of the
2234  * commandline then you should implement your own #GApplication subclass
2235  * and override local_command_line(). In this case, you most likely want
2236  * to return %TRUE from your local_command_line() implementation to
2237  * suppress the default handling. See
2238  * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
2239  * for an example.
2240  *
2241  * If, after the above is done, the use count of the application is zero
2242  * then the exit status is returned immediately.  If the use count is
2243  * non-zero then the default main context is iterated until the use count
2244  * falls to zero, at which point 0 is returned.
2245  *
2246  * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
2247  * run for as much as 10 seconds with a use count of zero while waiting
2248  * for the message that caused the activation to arrive.  After that,
2249  * if the use count falls to zero the application will exit immediately,
2250  * except in the case that g_application_set_inactivity_timeout() is in
2251  * use.
2252  *
2253  * This function sets the prgname (g_set_prgname()), if not already set,
2254  * to the basename of argv[0].
2255  *
2256  * Much like g_main_loop_run(), this function will acquire the main context
2257  * for the duration that the application is running.
2258  *
2259  * Since 2.40, applications that are not explicitly flagged as services
2260  * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
2261  * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
2262  * default handler for local_command_line) if "--gapplication-service"
2263  * was given in the command line.  If this flag is present then normal
2264  * commandline processing is interrupted and the
2265  * %G_APPLICATION_IS_SERVICE flag is set.  This provides a "compromise"
2266  * solution whereby running an application directly from the commandline
2267  * will invoke it in the normal way (which can be useful for debugging)
2268  * while still allowing applications to be D-Bus activated in service
2269  * mode.  The D-Bus service file should invoke the executable with
2270  * "--gapplication-service" as the sole commandline argument.  This
2271  * approach is suitable for use by most graphical applications but
2272  * should not be used from applications like editors that need precise
2273  * control over when processes invoked via the commandline will exit and
2274  * what their exit status will be.
2275  *
2276  * Returns: the exit status
2277  *
2278  * Since: 2.28
2279  **/
2280 int
2281 g_application_run (GApplication  *application,
2282                    int            argc,
2283                    char         **argv)
2284 {
2285   gchar **arguments;
2286   int status;
2287   GMainContext *context;
2288   gboolean acquired_context;
2289
2290   g_return_val_if_fail (G_IS_APPLICATION (application), 1);
2291   g_return_val_if_fail (argc == 0 || argv != NULL, 1);
2292   g_return_val_if_fail (!application->priv->must_quit_now, 1);
2293
2294 #ifdef G_OS_WIN32
2295   {
2296     gint new_argc = 0;
2297
2298     arguments = g_win32_get_command_line ();
2299
2300     /*
2301      * CommandLineToArgvW(), which is called by g_win32_get_command_line(),
2302      * pulls in the whole command line that is used to call the program.  This is
2303      * fine in cases where the program is a .exe program, but in the cases where the
2304      * program is a called via a script, such as PyGObject's gtk-demo.py, which is normally
2305      * called using 'python gtk-demo.py' on Windows, the program name (argv[0])
2306      * returned by g_win32_get_command_line() will not be the argv[0] that ->local_command_line()
2307      * would expect, causing the program to fail with "This application can not open files."
2308      */
2309     new_argc = g_strv_length (arguments);
2310
2311     if (new_argc > argc)
2312       {
2313         gint i;
2314
2315         for (i = 0; i < new_argc - argc; i++)
2316           g_free (arguments[i]);
2317
2318         memmove (&arguments[0],
2319                  &arguments[new_argc - argc],
2320                  sizeof (arguments[0]) * (argc + 1));
2321       }
2322   }
2323 #else
2324   {
2325     gint i;
2326
2327     arguments = g_new (gchar *, argc + 1);
2328     for (i = 0; i < argc; i++)
2329       arguments[i] = g_strdup (argv[i]);
2330     arguments[i] = NULL;
2331   }
2332 #endif
2333
2334   if (g_get_prgname () == NULL && argc > 0)
2335     {
2336       gchar *prgname;
2337
2338       prgname = g_path_get_basename (argv[0]);
2339       g_set_prgname (prgname);
2340       g_free (prgname);
2341     }
2342
2343   context = g_main_context_default ();
2344   acquired_context = g_main_context_acquire (context);
2345   g_return_val_if_fail (acquired_context, 0);
2346
2347   if (!G_APPLICATION_GET_CLASS (application)
2348         ->local_command_line (application, &arguments, &status))
2349     {
2350       GError *error = NULL;
2351
2352       if (!g_application_register (application, NULL, &error))
2353         {
2354           g_printerr ("Failed to register: %s\n", error->message);
2355           g_error_free (error);
2356           return 1;
2357         }
2358
2359       g_application_call_command_line (application, (const gchar **) arguments, NULL, &status);
2360     }
2361
2362   g_strfreev (arguments);
2363
2364   if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
2365       application->priv->is_registered &&
2366       !application->priv->use_count &&
2367       !application->priv->inactivity_timeout_id)
2368     {
2369       application->priv->inactivity_timeout_id =
2370         g_timeout_add (10000, inactivity_timeout_expired, application);
2371     }
2372
2373   while (application->priv->use_count || application->priv->inactivity_timeout_id)
2374     {
2375       if (application->priv->must_quit_now)
2376         break;
2377
2378       g_main_context_iteration (context, TRUE);
2379       status = 0;
2380     }
2381
2382   if (application->priv->is_registered && !application->priv->is_remote)
2383     {
2384       g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
2385
2386       if (!application->priv->did_shutdown)
2387         g_critical ("GApplication subclass '%s' failed to chain up on"
2388                     " ::shutdown (from end of override function)",
2389                     G_OBJECT_TYPE_NAME (application));
2390     }
2391
2392   if (application->priv->impl)
2393     {
2394       g_application_impl_flush (application->priv->impl);
2395       g_application_impl_destroy (application->priv->impl);
2396       application->priv->impl = NULL;
2397     }
2398
2399   g_settings_sync ();
2400
2401   if (!application->priv->must_quit_now)
2402     while (g_main_context_iteration (context, FALSE))
2403       ;
2404
2405   g_main_context_release (context);
2406
2407   return status;
2408 }
2409
2410 static gchar **
2411 g_application_list_actions (GActionGroup *action_group)
2412 {
2413   GApplication *application = G_APPLICATION (action_group);
2414
2415   g_return_val_if_fail (application->priv->is_registered, NULL);
2416
2417   if (application->priv->remote_actions != NULL)
2418     return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
2419
2420   else if (application->priv->actions != NULL)
2421     return g_action_group_list_actions (application->priv->actions);
2422
2423   else
2424     /* empty string array */
2425     return g_new0 (gchar *, 1);
2426 }
2427
2428 static gboolean
2429 g_application_query_action (GActionGroup        *group,
2430                             const gchar         *action_name,
2431                             gboolean            *enabled,
2432                             const GVariantType **parameter_type,
2433                             const GVariantType **state_type,
2434                             GVariant           **state_hint,
2435                             GVariant           **state)
2436 {
2437   GApplication *application = G_APPLICATION (group);
2438
2439   g_return_val_if_fail (application->priv->is_registered, FALSE);
2440
2441   if (application->priv->remote_actions != NULL)
2442     return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
2443                                         action_name,
2444                                         enabled,
2445                                         parameter_type,
2446                                         state_type,
2447                                         state_hint,
2448                                         state);
2449
2450   if (application->priv->actions != NULL)
2451     return g_action_group_query_action (application->priv->actions,
2452                                         action_name,
2453                                         enabled,
2454                                         parameter_type,
2455                                         state_type,
2456                                         state_hint,
2457                                         state);
2458
2459   return FALSE;
2460 }
2461
2462 static void
2463 g_application_change_action_state (GActionGroup *action_group,
2464                                    const gchar  *action_name,
2465                                    GVariant     *value)
2466 {
2467   GApplication *application = G_APPLICATION (action_group);
2468
2469   g_return_if_fail (application->priv->is_remote ||
2470                     application->priv->actions != NULL);
2471   g_return_if_fail (application->priv->is_registered);
2472
2473   if (application->priv->remote_actions)
2474     g_remote_action_group_change_action_state_full (application->priv->remote_actions,
2475                                                     action_name, value, get_platform_data (application, NULL));
2476
2477   else
2478     g_action_group_change_action_state (application->priv->actions, action_name, value);
2479 }
2480
2481 static void
2482 g_application_activate_action (GActionGroup *action_group,
2483                                const gchar  *action_name,
2484                                GVariant     *parameter)
2485 {
2486   GApplication *application = G_APPLICATION (action_group);
2487
2488   g_return_if_fail (application->priv->is_remote ||
2489                     application->priv->actions != NULL);
2490   g_return_if_fail (application->priv->is_registered);
2491
2492   if (application->priv->remote_actions)
2493     g_remote_action_group_activate_action_full (application->priv->remote_actions,
2494                                                 action_name, parameter, get_platform_data (application, NULL));
2495
2496   else
2497     g_action_group_activate_action (application->priv->actions, action_name, parameter);
2498 }
2499
2500 static GAction *
2501 g_application_lookup_action (GActionMap  *action_map,
2502                              const gchar *action_name)
2503 {
2504   GApplication *application = G_APPLICATION (action_map);
2505
2506   g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
2507
2508   return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
2509 }
2510
2511 static void
2512 g_application_add_action (GActionMap *action_map,
2513                           GAction    *action)
2514 {
2515   GApplication *application = G_APPLICATION (action_map);
2516
2517   g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2518
2519   g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
2520 }
2521
2522 static void
2523 g_application_remove_action (GActionMap  *action_map,
2524                              const gchar *action_name)
2525 {
2526   GApplication *application = G_APPLICATION (action_map);
2527
2528   g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2529
2530   g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
2531 }
2532
2533 static void
2534 g_application_action_group_iface_init (GActionGroupInterface *iface)
2535 {
2536   iface->list_actions = g_application_list_actions;
2537   iface->query_action = g_application_query_action;
2538   iface->change_action_state = g_application_change_action_state;
2539   iface->activate_action = g_application_activate_action;
2540 }
2541
2542 static void
2543 g_application_action_map_iface_init (GActionMapInterface *iface)
2544 {
2545   iface->lookup_action = g_application_lookup_action;
2546   iface->add_action = g_application_add_action;
2547   iface->remove_action = g_application_remove_action;
2548 }
2549
2550 /* Default Application {{{1 */
2551
2552 static GApplication *default_app;
2553
2554 /**
2555  * g_application_get_default:
2556  *
2557  * Returns the default #GApplication instance for this process.
2558  *
2559  * Normally there is only one #GApplication per process and it becomes
2560  * the default when it is created.  You can exercise more control over
2561  * this by using g_application_set_default().
2562  *
2563  * If there is no default application then %NULL is returned.
2564  *
2565  * Returns: (transfer none): the default application for this process, or %NULL
2566  *
2567  * Since: 2.32
2568  **/
2569 GApplication *
2570 g_application_get_default (void)
2571 {
2572   return default_app;
2573 }
2574
2575 /**
2576  * g_application_set_default:
2577  * @application: (nullable): the application to set as default, or %NULL
2578  *
2579  * Sets or unsets the default application for the process, as returned
2580  * by g_application_get_default().
2581  *
2582  * This function does not take its own reference on @application.  If
2583  * @application is destroyed then the default application will revert
2584  * back to %NULL.
2585  *
2586  * Since: 2.32
2587  **/
2588 void
2589 g_application_set_default (GApplication *application)
2590 {
2591   default_app = application;
2592 }
2593
2594 /**
2595  * g_application_quit:
2596  * @application: a #GApplication
2597  *
2598  * Immediately quits the application.
2599  *
2600  * Upon return to the mainloop, g_application_run() will return,
2601  * calling only the 'shutdown' function before doing so.
2602  *
2603  * The hold count is ignored.
2604  *
2605  * The result of calling g_application_run() again after it returns is
2606  * unspecified.
2607  *
2608  * Since: 2.32
2609  **/
2610 void
2611 g_application_quit (GApplication *application)
2612 {
2613   g_return_if_fail (G_IS_APPLICATION (application));
2614
2615   application->priv->must_quit_now = TRUE;
2616 }
2617
2618 /**
2619  * g_application_mark_busy:
2620  * @application: a #GApplication
2621  *
2622  * Increases the busy count of @application.
2623  *
2624  * Use this function to indicate that the application is busy, for instance
2625  * while a long running operation is pending.
2626  *
2627  * The busy state will be exposed to other processes, so a session shell will
2628  * use that information to indicate the state to the user (e.g. with a
2629  * spinner).
2630  *
2631  * To cancel the busy indication, use g_application_unmark_busy().
2632  *
2633  * Since: 2.38
2634  **/
2635 void
2636 g_application_mark_busy (GApplication *application)
2637 {
2638   gboolean was_busy;
2639
2640   g_return_if_fail (G_IS_APPLICATION (application));
2641
2642   was_busy = (application->priv->busy_count > 0);
2643   application->priv->busy_count++;
2644
2645   if (!was_busy)
2646     {
2647       g_application_impl_set_busy_state (application->priv->impl, TRUE);
2648       g_object_notify (G_OBJECT (application), "is-busy");
2649     }
2650 }
2651
2652 /**
2653  * g_application_unmark_busy:
2654  * @application: a #GApplication
2655  *
2656  * Decreases the busy count of @application.
2657  *
2658  * When the busy count reaches zero, the new state will be propagated
2659  * to other processes.
2660  *
2661  * This function must only be called to cancel the effect of a previous
2662  * call to g_application_mark_busy().
2663  *
2664  * Since: 2.38
2665  **/
2666 void
2667 g_application_unmark_busy (GApplication *application)
2668 {
2669   g_return_if_fail (G_IS_APPLICATION (application));
2670   g_return_if_fail (application->priv->busy_count > 0);
2671
2672   application->priv->busy_count--;
2673
2674   if (application->priv->busy_count == 0)
2675     {
2676       g_application_impl_set_busy_state (application->priv->impl, FALSE);
2677       g_object_notify (G_OBJECT (application), "is-busy");
2678     }
2679 }
2680
2681 /**
2682  * g_application_get_is_busy:
2683  * @application: a #GApplication
2684  *
2685  * Gets the application's current busy state, as set through
2686  * g_application_mark_busy() or g_application_bind_busy_property().
2687  *
2688  * Returns: %TRUE if @application is currenty marked as busy
2689  *
2690  * Since: 2.44
2691  */
2692 gboolean
2693 g_application_get_is_busy (GApplication *application)
2694 {
2695   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2696
2697   return application->priv->busy_count > 0;
2698 }
2699
2700 /* Notifications {{{1 */
2701
2702 /**
2703  * g_application_send_notification:
2704  * @application: a #GApplication
2705  * @id: (nullable): id of the notification, or %NULL
2706  * @notification: the #GNotification to send
2707  *
2708  * Sends a notification on behalf of @application to the desktop shell.
2709  * There is no guarantee that the notification is displayed immediately,
2710  * or even at all.
2711  *
2712  * Notifications may persist after the application exits. It will be
2713  * D-Bus-activated when the notification or one of its actions is
2714  * activated.
2715  *
2716  * Modifying @notification after this call has no effect. However, the
2717  * object can be reused for a later call to this function.
2718  *
2719  * @id may be any string that uniquely identifies the event for the
2720  * application. It does not need to be in any special format. For
2721  * example, "new-message" might be appropriate for a notification about
2722  * new messages.
2723  *
2724  * If a previous notification was sent with the same @id, it will be
2725  * replaced with @notification and shown again as if it was a new
2726  * notification. This works even for notifications sent from a previous
2727  * execution of the application, as long as @id is the same string.
2728  *
2729  * @id may be %NULL, but it is impossible to replace or withdraw
2730  * notifications without an id.
2731  *
2732  * If @notification is no longer relevant, it can be withdrawn with
2733  * g_application_withdraw_notification().
2734  *
2735  * Since: 2.40
2736  */
2737 void
2738 g_application_send_notification (GApplication  *application,
2739                                  const gchar   *id,
2740                                  GNotification *notification)
2741 {
2742   gchar *generated_id = NULL;
2743
2744   g_return_if_fail (G_IS_APPLICATION (application));
2745   g_return_if_fail (G_IS_NOTIFICATION (notification));
2746   g_return_if_fail (g_application_get_is_registered (application));
2747   g_return_if_fail (!g_application_get_is_remote (application));
2748
2749   if (application->priv->notifications == NULL)
2750     application->priv->notifications = g_notification_backend_new_default (application);
2751
2752   if (id == NULL)
2753     {
2754       generated_id = g_dbus_generate_guid ();
2755       id = generated_id;
2756     }
2757
2758   g_notification_backend_send_notification (application->priv->notifications, id, notification);
2759
2760   g_free (generated_id);
2761 }
2762
2763 /**
2764  * g_application_withdraw_notification:
2765  * @application: a #GApplication
2766  * @id: id of a previously sent notification
2767  *
2768  * Withdraws a notification that was sent with
2769  * g_application_send_notification().
2770  *
2771  * This call does nothing if a notification with @id doesn't exist or
2772  * the notification was never sent.
2773  *
2774  * This function works even for notifications sent in previous
2775  * executions of this application, as long @id is the same as it was for
2776  * the sent notification.
2777  *
2778  * Note that notifications are dismissed when the user clicks on one
2779  * of the buttons in a notification or triggers its default action, so
2780  * there is no need to explicitly withdraw the notification in that case.
2781  *
2782  * Since: 2.40
2783  */
2784 void
2785 g_application_withdraw_notification (GApplication *application,
2786                                      const gchar  *id)
2787 {
2788   g_return_if_fail (G_IS_APPLICATION (application));
2789   g_return_if_fail (id != NULL);
2790
2791   if (application->priv->notifications == NULL)
2792     application->priv->notifications = g_notification_backend_new_default (application);
2793
2794   g_notification_backend_withdraw_notification (application->priv->notifications, id);
2795 }
2796
2797 /* Busy binding {{{1 */
2798
2799 typedef struct
2800 {
2801   GApplication *app;
2802   gboolean is_busy;
2803 } GApplicationBusyBinding;
2804
2805 static void
2806 g_application_busy_binding_destroy (gpointer  data,
2807                                     GClosure *closure)
2808 {
2809   GApplicationBusyBinding *binding = data;
2810
2811   if (binding->is_busy)
2812     g_application_unmark_busy (binding->app);
2813
2814   g_object_unref (binding->app);
2815   g_slice_free (GApplicationBusyBinding, binding);
2816 }
2817
2818 static void
2819 g_application_notify_busy_binding (GObject    *object,
2820                                    GParamSpec *pspec,
2821                                    gpointer    user_data)
2822 {
2823   GApplicationBusyBinding *binding = user_data;
2824   gboolean is_busy;
2825
2826   g_object_get (object, pspec->name, &is_busy, NULL);
2827
2828   if (is_busy && !binding->is_busy)
2829     g_application_mark_busy (binding->app);
2830   else if (!is_busy && binding->is_busy)
2831     g_application_unmark_busy (binding->app);
2832
2833   binding->is_busy = is_busy;
2834 }
2835
2836 /**
2837  * g_application_bind_busy_property:
2838  * @application: a #GApplication
2839  * @object: (type GObject.Object): a #GObject
2840  * @property: the name of a boolean property of @object
2841  *
2842  * Marks @application as busy (see g_application_mark_busy()) while
2843  * @property on @object is %TRUE.
2844  *
2845  * The binding holds a reference to @application while it is active, but
2846  * not to @object. Instead, the binding is destroyed when @object is
2847  * finalized.
2848  *
2849  * Since: 2.44
2850  */
2851 void
2852 g_application_bind_busy_property (GApplication *application,
2853                                   gpointer      object,
2854                                   const gchar  *property)
2855 {
2856   guint notify_id;
2857   GQuark property_quark;
2858   GParamSpec *pspec;
2859   GApplicationBusyBinding *binding;
2860   GClosure *closure;
2861
2862   g_return_if_fail (G_IS_APPLICATION (application));
2863   g_return_if_fail (G_IS_OBJECT (object));
2864   g_return_if_fail (property != NULL);
2865
2866   notify_id = g_signal_lookup ("notify", G_TYPE_OBJECT);
2867   property_quark = g_quark_from_string (property);
2868   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2869
2870   g_return_if_fail (pspec != NULL && pspec->value_type == G_TYPE_BOOLEAN);
2871
2872   if (g_signal_handler_find (object, G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
2873                              notify_id, property_quark, NULL, g_application_notify_busy_binding, NULL) > 0)
2874     {
2875       g_critical ("%s: '%s' is already bound to the busy state of the application", G_STRFUNC, property);
2876       return;
2877     }
2878
2879   binding = g_slice_new (GApplicationBusyBinding);
2880   binding->app = g_object_ref (application);
2881   binding->is_busy = FALSE;
2882
2883   closure = g_cclosure_new (G_CALLBACK (g_application_notify_busy_binding), binding,
2884                             g_application_busy_binding_destroy);
2885   g_signal_connect_closure_by_id (object, notify_id, property_quark, closure, FALSE);
2886
2887   /* fetch the initial value */
2888   g_application_notify_busy_binding (object, pspec, binding);
2889 }
2890
2891 /**
2892  * g_application_unbind_busy_property:
2893  * @application: a #GApplication
2894  * @object: (type GObject.Object): a #GObject
2895  * @property: the name of a boolean property of @object
2896  *
2897  * Destroys a binding between @property and the busy state of
2898  * @application that was previously created with
2899  * g_application_bind_busy_property().
2900  *
2901  * Since: 2.44
2902  */
2903 void
2904 g_application_unbind_busy_property (GApplication *application,
2905                                     gpointer      object,
2906                                     const gchar  *property)
2907 {
2908   guint notify_id;
2909   GQuark property_quark;
2910   gulong handler_id;
2911
2912   g_return_if_fail (G_IS_APPLICATION (application));
2913   g_return_if_fail (G_IS_OBJECT (object));
2914   g_return_if_fail (property != NULL);
2915
2916   notify_id = g_signal_lookup ("notify", G_TYPE_OBJECT);
2917   property_quark = g_quark_from_string (property);
2918
2919   handler_id = g_signal_handler_find (object, G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
2920                                       notify_id, property_quark, NULL, g_application_notify_busy_binding, NULL);
2921   if (handler_id == 0)
2922     {
2923       g_critical ("%s: '%s' is not bound to the busy state of the application", G_STRFUNC, property);
2924       return;
2925     }
2926
2927   g_signal_handler_disconnect (object, handler_id);
2928 }
2929
2930 /* Epilogue {{{1 */
2931 /* vim:set foldmethod=marker: */