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