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