GApplication: allow handles_commandline and service
[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, write to the
16  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17  * Boston, MA 02111-1307, USA.
18  *
19  * Authors: Ryan Lortie <desrt@desrt.ca>
20  */
21
22 /* Prologue {{{1 */
23 #include "config.h"
24
25 #include "gapplication.h"
26
27 #include "gapplicationcommandline.h"
28 #include "gsimpleactiongroup.h"
29 #include "gremoteactiongroup.h"
30 #include "gapplicationimpl.h"
31 #include "gactiongroup.h"
32 #include "gactionmap.h"
33 #include "gmenumodel.h"
34 #include "gsettings.h"
35 #include "gnotification-private.h"
36 #include "gnotificationbackend.h"
37 #include "gdbusutils.h"
38
39 #include "gioenumtypes.h"
40 #include "gioenums.h"
41 #include "gfile.h"
42
43 #include "glibintl.h"
44
45 #include <string.h>
46
47 /**
48  * SECTION:gapplication
49  * @title: GApplication
50  * @short_description: Core application class
51  * @include: gio/gio.h
52  *
53  * A #GApplication is the foundation of an application.  It wraps some
54  * low-level platform-specific services and is intended to act as the
55  * foundation for higher-level application classes such as
56  * #GtkApplication or #MxApplication.  In general, you should not use
57  * this class outside of a higher level framework.
58  *
59  * GApplication provides convenient life cycle management by maintaining
60  * a <firstterm>use count</firstterm> for the primary application instance.
61  * The use count can be changed using g_application_hold() and
62  * g_application_release(). If it drops to zero, the application exits.
63  * Higher-level classes such as #GtkApplication employ the use count to
64  * ensure that the application stays alive as long as it has any opened
65  * windows.
66  *
67  * Another feature that GApplication (optionally) provides is process
68  * uniqueness.  Applications can make use of this functionality by
69  * providing a unique application ID.  If given, only one application
70  * with this ID can be running at a time per session.  The session
71  * concept is platform-dependent, but corresponds roughly to a graphical
72  * desktop login.  When your application is launched again, its
73  * arguments are passed through platform communication to the already
74  * running program.  The already running instance of the program is
75  * called the <firstterm>primary instance</firstterm>; for non-unique
76  * applications this is the always the current instance.
77  * On Linux, the D-Bus session bus is used for communication.
78  *
79  * The use of #GApplication differs from some other commonly-used
80  * uniqueness libraries (such as libunique) in important ways.  The
81  * application is not expected to manually register itself and check if
82  * it is the primary instance.  Instead, the <code>main()</code>
83  * function of a #GApplication should do very little more than
84  * instantiating the application instance, possibly connecting signal
85  * handlers, then calling g_application_run().  All checks for
86  * uniqueness are done internally.  If the application is the primary
87  * instance then the startup signal is emitted and the mainloop runs.
88  * If the application is not the primary instance then a signal is sent
89  * to the primary instance and g_application_run() promptly returns.
90  * See the code examples below.
91  *
92  * If used, the expected form of an application identifier is very close
93  * to that of of a
94  * <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
95  * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
96  * For details on valid application identifiers, see g_application_id_is_valid().
97  *
98  * On Linux, the application identifier is claimed as a well-known bus name
99  * on the user's session bus.  This means that the uniqueness of your
100  * application is scoped to the current session.  It also means that your
101  * application may provide additional services (through registration of other
102  * object paths) at that bus name.  The registration of these object paths
103  * should be done with the shared GDBus session bus.  Note that due to the
104  * internal architecture of GDBus, method calls can be dispatched at any time
105  * (even if a main loop is not running).  For this reason, you must ensure that
106  * any object paths that you wish to register are registered before #GApplication
107  * attempts to acquire the bus name of your application (which happens in
108  * g_application_register()).  Unfortunately, this means that you cannot use
109  * g_application_get_is_remote() to decide if you want to register object paths.
110  *
111  * GApplication also implements the #GActionGroup and #GActionMap
112  * interfaces and lets you easily export actions by adding them with
113  * g_action_map_add_action(). When invoking an action by calling
114  * g_action_group_activate_action() on the application, it is always
115  * invoked in the primary instance. The actions are also exported on
116  * the session bus, and GIO provides the #GDBusActionGroup wrapper to
117  * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
118  * for remote access to exported #GMenuModels.
119  *
120  * There is a number of different entry points into a GApplication:
121  * <itemizedlist>
122  * <listitem>via 'Activate' (i.e. just starting the application)</listitem>
123  * <listitem>via 'Open' (i.e. opening some files)</listitem>
124  * <listitem>by handling a command-line</listitem>
125  * <listitem>via activating an action</listitem>
126  * </itemizedlist>
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 application,
131  * GApplication passes some <firstterm id="platform-data">platform
132  * data</firstterm> from the launching instance to the primary instance,
133  * in the form of a #GVariant dictionary mapping strings to variants.
134  * To use platform data, override the @before_emit or @after_emit virtual
135  * functions in your #GApplication subclass. When dealing with
136  * #GApplicationCommandLine objects, the platform data is directly
137  * 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-menu"><title>A GApplication with menus</title>
173  * <programlisting>
174  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-menu.c">
175  *   <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
176  * </xi:include>
177  * </programlisting>
178  * </example>
179  *
180  * <example id="gapplication-example-dbushooks"><title>Using extra D-Bus hooks with a GApplication</title>
181  * <programlisting>
182  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-dbushooks.c">
183  *   <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
184  * </xi:include>
185  * </programlisting>
186  * </example>
187  */
188
189 /**
190  * GApplicationClass:
191  * @startup: invoked on the primary instance immediately after registration
192  * @shutdown: invoked only on the registered primary instance immediately
193  *      after the main loop terminates
194  * @activate: invoked on the primary instance when an activation occurs
195  * @open: invoked on the primary instance when there are files to open
196  * @command_line: invoked on the primary instance when a command-line is
197  *   not handled locally
198  * @local_command_line: invoked (locally) when the process has been invoked
199  *     via commandline execution (as opposed to, say, D-Bus activation - which
200  *     is not currently supported by GApplication). The virtual function has
201  *     the chance to inspect (and possibly replace) the list of command line
202  *     arguments. See g_application_run() for more information.
203  * @before_emit: invoked on the primary instance before 'activate', 'open',
204  *     'command-line' or any action invocation, gets the 'platform data' from
205  *     the calling instance
206  * @after_emit: invoked on the primary instance after 'activate', 'open',
207  *     'command-line' or any action invocation, gets the 'platform data' from
208  *     the calling instance
209  * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
210  *     the primary instance when activating, opening or invoking actions
211  * @quit_mainloop: Used to be invoked on the primary instance when the use
212  *     count of the application drops to zero (and after any inactivity
213  *     timeout, if requested). Not used anymore since 2.32
214  * @run_mainloop: Used to be invoked on the primary instance from
215  *     g_application_run() if the use-count is non-zero. Since 2.32,
216  *     GApplication is iterating the main context directly and is not
217  *     using @run_mainloop anymore
218  * @dbus_register: invoked locally during registration, if the application is
219  *     using its D-Bus backend. You can use this to export extra objects on the
220  *     bus, that need to exist before the application tries to own the bus name.
221  *     The function is passed the #GDBusConnection to to session bus, and the
222  *     object path that #GApplication will use to export is D-Bus API.
223  *     If this function returns %TRUE, registration will proceed; otherwise
224  *     registration will abort. Since: 2.34
225  * @dbus_unregister: invoked locally during unregistration, if the application
226  *     is using its D-Bus backend. Use this to undo anything done by the
227  *     @dbus_register vfunc. Since: 2.34
228  *
229  * Virtual function table for #GApplication.
230  *
231  * Since: 2.28
232  */
233
234 struct _GApplicationPrivate
235 {
236   GApplicationFlags  flags;
237   gchar             *id;
238
239   GActionGroup      *actions;
240   GMenuModel        *app_menu;
241   GMenuModel        *menubar;
242
243   guint              inactivity_timeout_id;
244   guint              inactivity_timeout;
245   guint              use_count;
246   guint              busy_count;
247
248   guint              is_registered : 1;
249   guint              is_remote : 1;
250   guint              did_startup : 1;
251   guint              did_shutdown : 1;
252   guint              must_quit_now : 1;
253
254   GRemoteActionGroup *remote_actions;
255   GApplicationImpl   *impl;
256
257   GNotificationBackend *notifications;
258 };
259
260 enum
261 {
262   PROP_NONE,
263   PROP_APPLICATION_ID,
264   PROP_FLAGS,
265   PROP_IS_REGISTERED,
266   PROP_IS_REMOTE,
267   PROP_INACTIVITY_TIMEOUT,
268   PROP_ACTION_GROUP
269 };
270
271 enum
272 {
273   SIGNAL_STARTUP,
274   SIGNAL_SHUTDOWN,
275   SIGNAL_ACTIVATE,
276   SIGNAL_OPEN,
277   SIGNAL_ACTION,
278   SIGNAL_COMMAND_LINE,
279   NR_SIGNALS
280 };
281
282 static guint g_application_signals[NR_SIGNALS];
283
284 static void g_application_action_group_iface_init (GActionGroupInterface *);
285 static void g_application_action_map_iface_init (GActionMapInterface *);
286 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
287  G_ADD_PRIVATE (GApplication)
288  G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
289  G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
290
291 /* GApplicationExportedActions {{{1 */
292
293 /* We create a subclass of GSimpleActionGroup that implements
294  * GRemoteActionGroup and deals with the platform data using
295  * GApplication's before/after_emit vfuncs.  This is the action group we
296  * will be exporting.
297  *
298  * We could implement GRemoteActionGroup on GApplication directly, but
299  * this would be potentially extremely confusing to have exposed as part
300  * of the public API of GApplication.  We certainly don't want anyone in
301  * the same process to be calling these APIs...
302  */
303 typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
304 typedef struct
305 {
306   GSimpleActionGroup parent_instance;
307   GApplication *application;
308 } GApplicationExportedActions;
309
310 static GType g_application_exported_actions_get_type   (void);
311 static void  g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
312 G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
313                          G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
314
315 static void
316 g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
317                                                      const gchar        *action_name,
318                                                      GVariant           *parameter,
319                                                      GVariant           *platform_data)
320 {
321   GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
322
323   G_APPLICATION_GET_CLASS (exported->application)
324     ->before_emit (exported->application, platform_data);
325
326   g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
327
328   G_APPLICATION_GET_CLASS (exported->application)
329     ->after_emit (exported->application, platform_data);
330 }
331
332 static void
333 g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
334                                                          const gchar        *action_name,
335                                                          GVariant           *value,
336                                                          GVariant           *platform_data)
337 {
338   GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
339
340   G_APPLICATION_GET_CLASS (exported->application)
341     ->before_emit (exported->application, platform_data);
342
343   g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
344
345   G_APPLICATION_GET_CLASS (exported->application)
346     ->after_emit (exported->application, platform_data);
347 }
348
349 static void
350 g_application_exported_actions_init (GApplicationExportedActions *actions)
351 {
352 }
353
354 static void
355 g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
356 {
357   iface->activate_action_full = g_application_exported_actions_activate_action_full;
358   iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
359 }
360
361 static void
362 g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
363 {
364 }
365
366 static GActionGroup *
367 g_application_exported_actions_new (GApplication *application)
368 {
369   GApplicationExportedActions *actions;
370
371   actions = g_object_new (g_application_exported_actions_get_type (), NULL);
372   actions->application = application;
373
374   return G_ACTION_GROUP (actions);
375 }
376
377 /* vfunc defaults {{{1 */
378 static void
379 g_application_real_before_emit (GApplication *application,
380                                 GVariant     *platform_data)
381 {
382 }
383
384 static void
385 g_application_real_after_emit (GApplication *application,
386                                GVariant     *platform_data)
387 {
388 }
389
390 static void
391 g_application_real_startup (GApplication *application)
392 {
393   application->priv->did_startup = TRUE;
394 }
395
396 static void
397 g_application_real_shutdown (GApplication *application)
398 {
399   application->priv->did_shutdown = TRUE;
400 }
401
402 static void
403 g_application_real_activate (GApplication *application)
404 {
405   if (!g_signal_has_handler_pending (application,
406                                      g_application_signals[SIGNAL_ACTIVATE],
407                                      0, TRUE) &&
408       G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
409     {
410       static gboolean warned;
411
412       if (warned)
413         return;
414
415       g_warning ("Your application does not implement "
416                  "g_application_activate() and has no handlers connected "
417                  "to the 'activate' signal.  It should do one of these.");
418       warned = TRUE;
419     }
420 }
421
422 static void
423 g_application_real_open (GApplication  *application,
424                          GFile        **files,
425                          gint           n_files,
426                          const gchar   *hint)
427 {
428   if (!g_signal_has_handler_pending (application,
429                                      g_application_signals[SIGNAL_OPEN],
430                                      0, TRUE) &&
431       G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
432     {
433       static gboolean warned;
434
435       if (warned)
436         return;
437
438       g_warning ("Your application claims to support opening files "
439                  "but does not implement g_application_open() and has no "
440                  "handlers connected to the 'open' signal.");
441       warned = TRUE;
442     }
443 }
444
445 static int
446 g_application_real_command_line (GApplication            *application,
447                                  GApplicationCommandLine *cmdline)
448 {
449   if (!g_signal_has_handler_pending (application,
450                                      g_application_signals[SIGNAL_COMMAND_LINE],
451                                      0, TRUE) &&
452       G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
453     {
454       static gboolean warned;
455
456       if (warned)
457         return 1;
458
459       g_warning ("Your application claims to support custom command line "
460                  "handling but does not implement g_application_command_line() "
461                  "and has no handlers connected to the 'command-line' signal.");
462
463       warned = TRUE;
464     }
465
466     return 1;
467 }
468
469 static gboolean
470 g_application_real_local_command_line (GApplication   *application,
471                                        gchar        ***arguments,
472                                        int            *exit_status)
473 {
474   if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
475     {
476       if ((*arguments)[0] && (*arguments)[1] && g_str_equal ((*arguments)[1], "--gapplication-service"))
477         {
478           GError *error = NULL;
479
480           if ((*arguments)[2])
481             g_warning ("Additional arguments following --gapplication-service are ignored");
482
483           application->priv->flags |= G_APPLICATION_IS_SERVICE;
484           if (!g_application_register (application, NULL, &error))
485             {
486               g_warning ("%s", error->message);
487               g_error_free (error);
488               *exit_status = 1;
489             }
490           else
491             *exit_status = 0;
492
493           return TRUE;
494         }
495     }
496
497   if ((application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE) &&
498       !(application->priv->flags & G_APPLICATION_IS_SERVICE))
499     return FALSE;
500
501   else
502     {
503       GError *error = NULL;
504       gint n_args;
505
506       if (!g_application_register (application, NULL, &error))
507         {
508           g_printerr ("Failed to register: %s\n", error->message);
509           g_error_free (error);
510           *exit_status = 1;
511           return TRUE;
512         }
513
514       n_args = g_strv_length (*arguments);
515
516       if (application->priv->flags & G_APPLICATION_IS_SERVICE)
517         {
518           if ((*exit_status = n_args > 1))
519             {
520               g_printerr ("GApplication service mode takes no arguments.\n");
521               application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
522             }
523
524           return TRUE;
525         }
526
527       if (n_args <= 1)
528         {
529           g_application_activate (application);
530           *exit_status = 0;
531         }
532
533       else
534         {
535           if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
536             {
537               g_critical ("This application can not open files.");
538               *exit_status = 1;
539             }
540           else
541             {
542               GFile **files;
543               gint n_files;
544               gint i;
545
546               n_files = n_args - 1;
547               files = g_new (GFile *, n_files);
548
549               for (i = 0; i < n_files; i++)
550                 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
551
552               g_application_open (application, files, n_files, "");
553
554               for (i = 0; i < n_files; i++)
555                 g_object_unref (files[i]);
556               g_free (files);
557
558               *exit_status = 0;
559             }
560         }
561
562       return TRUE;
563     }
564 }
565
566 static void
567 g_application_real_add_platform_data (GApplication    *application,
568                                       GVariantBuilder *builder)
569 {
570 }
571
572 static gboolean
573 g_application_real_dbus_register (GApplication    *application,
574                                   GDBusConnection *connection,
575                                   const gchar     *object_path,
576                                   GError         **error)
577 {
578   return TRUE;
579 }
580
581 static void
582 g_application_real_dbus_unregister (GApplication    *application,
583                                     GDBusConnection *connection,
584                                     const gchar     *object_path)
585 {
586 }
587
588 /* GObject implementation stuff {{{1 */
589 static void
590 g_application_set_property (GObject      *object,
591                             guint         prop_id,
592                             const GValue *value,
593                             GParamSpec   *pspec)
594 {
595   GApplication *application = G_APPLICATION (object);
596
597   switch (prop_id)
598     {
599     case PROP_APPLICATION_ID:
600       g_application_set_application_id (application,
601                                         g_value_get_string (value));
602       break;
603
604     case PROP_FLAGS:
605       g_application_set_flags (application, g_value_get_flags (value));
606       break;
607
608     case PROP_INACTIVITY_TIMEOUT:
609       g_application_set_inactivity_timeout (application,
610                                             g_value_get_uint (value));
611       break;
612
613     case PROP_ACTION_GROUP:
614       g_clear_object (&application->priv->actions);
615       application->priv->actions = g_value_dup_object (value);
616       break;
617
618     default:
619       g_assert_not_reached ();
620     }
621 }
622
623 /**
624  * g_application_set_action_group:
625  * @application: a #GApplication
626  * @action_group: (allow-none): a #GActionGroup, or %NULL
627  *
628  * This used to be how actions were associated with a #GApplication.
629  * Now there is #GActionMap for that.
630  *
631  * Since: 2.28
632  *
633  * Deprecated:2.32:Use the #GActionMap interface instead.  Never ever
634  * mix use of this API with use of #GActionMap on the same @application
635  * or things will go very badly wrong.  This function is known to
636  * introduce buggy behaviour (ie: signals not emitted on changes to the
637  * action group), so you should really use #GActionMap instead.
638  **/
639 void
640 g_application_set_action_group (GApplication *application,
641                                 GActionGroup *action_group)
642 {
643   g_return_if_fail (G_IS_APPLICATION (application));
644   g_return_if_fail (!application->priv->is_registered);
645
646   if (application->priv->actions != NULL)
647     g_object_unref (application->priv->actions);
648
649   application->priv->actions = action_group;
650
651   if (application->priv->actions != NULL)
652     g_object_ref (application->priv->actions);
653 }
654
655 static void
656 g_application_get_property (GObject    *object,
657                             guint       prop_id,
658                             GValue     *value,
659                             GParamSpec *pspec)
660 {
661   GApplication *application = G_APPLICATION (object);
662
663   switch (prop_id)
664     {
665     case PROP_APPLICATION_ID:
666       g_value_set_string (value,
667                           g_application_get_application_id (application));
668       break;
669
670     case PROP_FLAGS:
671       g_value_set_flags (value,
672                          g_application_get_flags (application));
673       break;
674
675     case PROP_IS_REGISTERED:
676       g_value_set_boolean (value,
677                            g_application_get_is_registered (application));
678       break;
679
680     case PROP_IS_REMOTE:
681       g_value_set_boolean (value,
682                            g_application_get_is_remote (application));
683       break;
684
685     case PROP_INACTIVITY_TIMEOUT:
686       g_value_set_uint (value,
687                         g_application_get_inactivity_timeout (application));
688       break;
689
690     default:
691       g_assert_not_reached ();
692     }
693 }
694
695 static void
696 g_application_constructed (GObject *object)
697 {
698   GApplication *application = G_APPLICATION (object);
699
700   if (g_application_get_default () == NULL)
701     g_application_set_default (application);
702 }
703
704 static void
705 g_application_finalize (GObject *object)
706 {
707   GApplication *application = G_APPLICATION (object);
708
709   if (application->priv->impl)
710     g_application_impl_destroy (application->priv->impl);
711   g_free (application->priv->id);
712
713   if (g_application_get_default () == application)
714     g_application_set_default (NULL);
715
716   if (application->priv->actions)
717     g_object_unref (application->priv->actions);
718
719   if (application->priv->notifications)
720     g_object_unref (application->priv->notifications);
721
722   G_OBJECT_CLASS (g_application_parent_class)
723     ->finalize (object);
724 }
725
726 static void
727 g_application_init (GApplication *application)
728 {
729   application->priv = g_application_get_instance_private (application);
730
731   application->priv->actions = g_application_exported_actions_new (application);
732
733   /* application->priv->actions is the one and only ref on the group, so when
734    * we dispose, the action group will die, disconnecting all signals.
735    */
736   g_signal_connect_swapped (application->priv->actions, "action-added",
737                             G_CALLBACK (g_action_group_action_added), application);
738   g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
739                             G_CALLBACK (g_action_group_action_enabled_changed), application);
740   g_signal_connect_swapped (application->priv->actions, "action-state-changed",
741                             G_CALLBACK (g_action_group_action_state_changed), application);
742   g_signal_connect_swapped (application->priv->actions, "action-removed",
743                             G_CALLBACK (g_action_group_action_removed), application);
744 }
745
746 static void
747 g_application_class_init (GApplicationClass *class)
748 {
749   GObjectClass *object_class = G_OBJECT_CLASS (class);
750
751   object_class->constructed = g_application_constructed;
752   object_class->finalize = g_application_finalize;
753   object_class->get_property = g_application_get_property;
754   object_class->set_property = g_application_set_property;
755
756   class->before_emit = g_application_real_before_emit;
757   class->after_emit = g_application_real_after_emit;
758   class->startup = g_application_real_startup;
759   class->shutdown = g_application_real_shutdown;
760   class->activate = g_application_real_activate;
761   class->open = g_application_real_open;
762   class->command_line = g_application_real_command_line;
763   class->local_command_line = g_application_real_local_command_line;
764   class->add_platform_data = g_application_real_add_platform_data;
765   class->dbus_register = g_application_real_dbus_register;
766   class->dbus_unregister = g_application_real_dbus_unregister;
767
768   g_object_class_install_property (object_class, PROP_APPLICATION_ID,
769     g_param_spec_string ("application-id",
770                          P_("Application identifier"),
771                          P_("The unique identifier for the application"),
772                          NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
773                          G_PARAM_STATIC_STRINGS));
774
775   g_object_class_install_property (object_class, PROP_FLAGS,
776     g_param_spec_flags ("flags",
777                         P_("Application flags"),
778                         P_("Flags specifying the behaviour of the application"),
779                         G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
780                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
781
782   g_object_class_install_property (object_class, PROP_IS_REGISTERED,
783     g_param_spec_boolean ("is-registered",
784                           P_("Is registered"),
785                           P_("If g_application_register() has been called"),
786                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
787
788   g_object_class_install_property (object_class, PROP_IS_REMOTE,
789     g_param_spec_boolean ("is-remote",
790                           P_("Is remote"),
791                           P_("If this application instance is remote"),
792                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
793
794   g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
795     g_param_spec_uint ("inactivity-timeout",
796                        P_("Inactivity timeout"),
797                        P_("Time (ms) to stay alive after becoming idle"),
798                        0, G_MAXUINT, 0,
799                        G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
800
801   g_object_class_install_property (object_class, PROP_ACTION_GROUP,
802     g_param_spec_object ("action-group",
803                          P_("Action group"),
804                          P_("The group of actions that the application exports"),
805                          G_TYPE_ACTION_GROUP,
806                          G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
807
808   /**
809    * GApplication::startup:
810    * @application: the application
811    *
812    * The ::startup signal is emitted on the primary instance immediately
813    * after registration. See g_application_register().
814    */
815   g_application_signals[SIGNAL_STARTUP] =
816     g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
817                   G_STRUCT_OFFSET (GApplicationClass, startup),
818                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
819
820   /**
821    * GApplication::shutdown:
822    * @application: the application
823    *
824    * The ::shutdown signal is emitted only on the registered primary instance
825    * immediately after the main loop terminates.
826    */
827   g_application_signals[SIGNAL_SHUTDOWN] =
828     g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
829                   G_STRUCT_OFFSET (GApplicationClass, shutdown),
830                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
831
832   /**
833    * GApplication::activate:
834    * @application: the application
835    *
836    * The ::activate signal is emitted on the primary instance when an
837    * activation occurs. See g_application_activate().
838    */
839   g_application_signals[SIGNAL_ACTIVATE] =
840     g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
841                   G_STRUCT_OFFSET (GApplicationClass, activate),
842                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
843
844
845   /**
846    * GApplication::open:
847    * @application: the application
848    * @files: (array length=n_files) (element-type GFile): an array of #GFiles
849    * @n_files: the length of @files
850    * @hint: a hint provided by the calling instance
851    *
852    * The ::open signal is emitted on the primary instance when there are
853    * files to open. See g_application_open() for more information.
854    */
855   g_application_signals[SIGNAL_OPEN] =
856     g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
857                   G_STRUCT_OFFSET (GApplicationClass, open),
858                   NULL, NULL, NULL,
859                   G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
860
861   /**
862    * GApplication::command-line:
863    * @application: the application
864    * @command_line: a #GApplicationCommandLine representing the
865    *     passed commandline
866    *
867    * The ::command-line signal is emitted on the primary instance when
868    * a commandline is not handled locally. See g_application_run() and
869    * the #GApplicationCommandLine documentation for more information.
870    *
871    * Returns: An integer that is set as the exit status for the calling
872    *   process. See g_application_command_line_set_exit_status().
873    */
874   g_application_signals[SIGNAL_COMMAND_LINE] =
875     g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
876                   G_STRUCT_OFFSET (GApplicationClass, command_line),
877                   g_signal_accumulator_first_wins, NULL,
878                   NULL,
879                   G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
880 }
881
882 static GVariant *
883 get_platform_data (GApplication *application)
884 {
885   GVariantBuilder *builder;
886   GVariant *result;
887
888   builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
889
890   {
891     gchar *cwd = g_get_current_dir ();
892     g_variant_builder_add (builder, "{sv}", "cwd",
893                            g_variant_new_bytestring (cwd));
894     g_free (cwd);
895   }
896
897   if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
898     {
899       GVariant *array;
900       gchar **envp;
901
902       envp = g_get_environ ();
903       array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
904       g_strfreev (envp);
905
906       g_variant_builder_add (builder, "{sv}", "environ", array);
907     }
908
909   G_APPLICATION_GET_CLASS (application)->
910     add_platform_data (application, builder);
911
912   result = g_variant_builder_end (builder);
913   g_variant_builder_unref (builder);
914
915   return result;
916 }
917
918 /* Application ID validity {{{1 */
919
920 /**
921  * g_application_id_is_valid:
922  * @application_id: a potential application identifier
923  *
924  * Checks if @application_id is a valid application identifier.
925  *
926  * A valid ID is required for calls to g_application_new() and
927  * g_application_set_application_id().
928  *
929  * For convenience, the restrictions on application identifiers are
930  * reproduced here:
931  * <itemizedlist>
932  *   <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-." and must not begin with a digit.</listitem>
933  *   <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least three elements).</listitem>
934  *   <listitem>Application identifiers must not begin or end with a '.' (period) character.</listitem>
935  *   <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
936  *   <listitem>Application identifiers must not exceed 255 characters.</listitem>
937  * </itemizedlist>
938  *
939  * Returns: %TRUE if @application_id is valid
940  **/
941 gboolean
942 g_application_id_is_valid (const gchar *application_id)
943 {
944   gsize len;
945   gboolean allow_dot;
946   gboolean has_dot;
947
948   len = strlen (application_id);
949
950   if (len > 255)
951     return FALSE;
952
953   if (!g_ascii_isalpha (application_id[0]))
954     return FALSE;
955
956   if (application_id[len-1] == '.')
957     return FALSE;
958
959   application_id++;
960   allow_dot = TRUE;
961   has_dot = FALSE;
962   for (; *application_id; application_id++)
963     {
964       if (g_ascii_isalnum (*application_id) ||
965           (*application_id == '-') ||
966           (*application_id == '_'))
967         {
968           allow_dot = TRUE;
969         }
970       else if (allow_dot && *application_id == '.')
971         {
972           has_dot = TRUE;
973           allow_dot = FALSE;
974         }
975       else
976         return FALSE;
977     }
978
979   if (!has_dot)
980     return FALSE;
981
982   return TRUE;
983 }
984
985 /* Public Constructor {{{1 */
986 /**
987  * g_application_new:
988  * @application_id: (allow-none): the application id
989  * @flags: the application flags
990  *
991  * Creates a new #GApplication instance.
992  *
993  * If non-%NULL, the application id must be valid.  See
994  * g_application_id_is_valid().
995  *
996  * If no application ID is given then some features of #GApplication
997  * (most notably application uniqueness) will be disabled.
998  *
999  * Returns: a new #GApplication instance
1000  **/
1001 GApplication *
1002 g_application_new (const gchar       *application_id,
1003                    GApplicationFlags  flags)
1004 {
1005   g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1006
1007   return g_object_new (G_TYPE_APPLICATION,
1008                        "application-id", application_id,
1009                        "flags", flags,
1010                        NULL);
1011 }
1012
1013 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
1014 /**
1015  * g_application_get_application_id:
1016  * @application: a #GApplication
1017  *
1018  * Gets the unique identifier for @application.
1019  *
1020  * Returns: the identifier for @application, owned by @application
1021  *
1022  * Since: 2.28
1023  **/
1024 const gchar *
1025 g_application_get_application_id (GApplication *application)
1026 {
1027   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1028
1029   return application->priv->id;
1030 }
1031
1032 /**
1033  * g_application_set_application_id:
1034  * @application: a #GApplication
1035  * @application_id: (allow-none): the identifier for @application
1036  *
1037  * Sets the unique identifier for @application.
1038  *
1039  * The application id can only be modified if @application has not yet
1040  * been registered.
1041  *
1042  * If non-%NULL, the application id must be valid.  See
1043  * g_application_id_is_valid().
1044  *
1045  * Since: 2.28
1046  **/
1047 void
1048 g_application_set_application_id (GApplication *application,
1049                                   const gchar  *application_id)
1050 {
1051   g_return_if_fail (G_IS_APPLICATION (application));
1052
1053   if (g_strcmp0 (application->priv->id, application_id) != 0)
1054     {
1055       g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1056       g_return_if_fail (!application->priv->is_registered);
1057
1058       g_free (application->priv->id);
1059       application->priv->id = g_strdup (application_id);
1060
1061       g_object_notify (G_OBJECT (application), "application-id");
1062     }
1063 }
1064
1065 /**
1066  * g_application_get_flags:
1067  * @application: a #GApplication
1068  *
1069  * Gets the flags for @application.
1070  *
1071  * See #GApplicationFlags.
1072  *
1073  * Returns: the flags for @application
1074  *
1075  * Since: 2.28
1076  **/
1077 GApplicationFlags
1078 g_application_get_flags (GApplication *application)
1079 {
1080   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1081
1082   return application->priv->flags;
1083 }
1084
1085 /**
1086  * g_application_set_flags:
1087  * @application: a #GApplication
1088  * @flags: the flags for @application
1089  *
1090  * Sets the flags for @application.
1091  *
1092  * The flags can only be modified if @application has not yet been
1093  * registered.
1094  *
1095  * See #GApplicationFlags.
1096  *
1097  * Since: 2.28
1098  **/
1099 void
1100 g_application_set_flags (GApplication      *application,
1101                          GApplicationFlags  flags)
1102 {
1103   g_return_if_fail (G_IS_APPLICATION (application));
1104
1105   if (application->priv->flags != flags)
1106     {
1107       g_return_if_fail (!application->priv->is_registered);
1108
1109       application->priv->flags = flags;
1110
1111       g_object_notify (G_OBJECT (application), "flags");
1112     }
1113 }
1114
1115 /**
1116  * g_application_get_inactivity_timeout:
1117  * @application: a #GApplication
1118  *
1119  * Gets the current inactivity timeout for the application.
1120  *
1121  * This is the amount of time (in milliseconds) after the last call to
1122  * g_application_release() before the application stops running.
1123  *
1124  * Returns: the timeout, in milliseconds
1125  *
1126  * Since: 2.28
1127  **/
1128 guint
1129 g_application_get_inactivity_timeout (GApplication *application)
1130 {
1131   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1132
1133   return application->priv->inactivity_timeout;
1134 }
1135
1136 /**
1137  * g_application_set_inactivity_timeout:
1138  * @application: a #GApplication
1139  * @inactivity_timeout: the timeout, in milliseconds
1140  *
1141  * Sets the current inactivity timeout for the application.
1142  *
1143  * This is the amount of time (in milliseconds) after the last call to
1144  * g_application_release() before the application stops running.
1145  *
1146  * This call has no side effects of its own.  The value set here is only
1147  * used for next time g_application_release() drops the use count to
1148  * zero.  Any timeouts currently in progress are not impacted.
1149  *
1150  * Since: 2.28
1151  **/
1152 void
1153 g_application_set_inactivity_timeout (GApplication *application,
1154                                       guint         inactivity_timeout)
1155 {
1156   g_return_if_fail (G_IS_APPLICATION (application));
1157
1158   if (application->priv->inactivity_timeout != inactivity_timeout)
1159     {
1160       application->priv->inactivity_timeout = inactivity_timeout;
1161
1162       g_object_notify (G_OBJECT (application), "inactivity-timeout");
1163     }
1164 }
1165 /* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
1166 /**
1167  * g_application_get_is_registered:
1168  * @application: a #GApplication
1169  *
1170  * Checks if @application is registered.
1171  *
1172  * An application is registered if g_application_register() has been
1173  * successfully called.
1174  *
1175  * Returns: %TRUE if @application is registered
1176  *
1177  * Since: 2.28
1178  **/
1179 gboolean
1180 g_application_get_is_registered (GApplication *application)
1181 {
1182   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1183
1184   return application->priv->is_registered;
1185 }
1186
1187 /**
1188  * g_application_get_is_remote:
1189  * @application: a #GApplication
1190  *
1191  * Checks if @application is remote.
1192  *
1193  * If @application is remote then it means that another instance of
1194  * application already exists (the 'primary' instance).  Calls to
1195  * perform actions on @application will result in the actions being
1196  * performed by the primary instance.
1197  *
1198  * The value of this property cannot be accessed before
1199  * g_application_register() has been called.  See
1200  * g_application_get_is_registered().
1201  *
1202  * Returns: %TRUE if @application is remote
1203  *
1204  * Since: 2.28
1205  **/
1206 gboolean
1207 g_application_get_is_remote (GApplication *application)
1208 {
1209   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1210   g_return_val_if_fail (application->priv->is_registered, FALSE);
1211
1212   return application->priv->is_remote;
1213 }
1214
1215 /**
1216  * g_application_get_dbus_connection:
1217  * @application: a #GApplication
1218  *
1219  * Gets the #GDBusConnection being used by the application, or %NULL.
1220  *
1221  * If #GApplication is using its D-Bus backend then this function will
1222  * return the #GDBusConnection being used for uniqueness and
1223  * communication with the desktop environment and other instances of the
1224  * application.
1225  *
1226  * If #GApplication is not using D-Bus then this function will return
1227  * %NULL.  This includes the situation where the D-Bus backend would
1228  * normally be in use but we were unable to connect to the bus.
1229  *
1230  * This function must not be called before the application has been
1231  * registered.  See g_application_get_is_registered().
1232  *
1233  * Returns: (transfer none): a #GDBusConnection, or %NULL
1234  *
1235  * Since: 2.34
1236  **/
1237 GDBusConnection *
1238 g_application_get_dbus_connection (GApplication *application)
1239 {
1240   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1241   g_return_val_if_fail (application->priv->is_registered, FALSE);
1242
1243   return g_application_impl_get_dbus_connection (application->priv->impl);
1244 }
1245
1246 /**
1247  * g_application_get_dbus_object_path:
1248  * @application: a #GApplication
1249  *
1250  * Gets the D-Bus object path being used by the application, or %NULL.
1251  *
1252  * If #GApplication is using its D-Bus backend then this function will
1253  * return the D-Bus object path that #GApplication is using.  If the
1254  * application is the primary instance then there is an object published
1255  * at this path.  If the application is not the primary instance then
1256  * the result of this function is undefined.
1257  *
1258  * If #GApplication is not using D-Bus then this function will return
1259  * %NULL.  This includes the situation where the D-Bus backend would
1260  * normally be in use but we were unable to connect to the bus.
1261  *
1262  * This function must not be called before the application has been
1263  * registered.  See g_application_get_is_registered().
1264  *
1265  * Returns: the object path, or %NULL
1266  *
1267  * Since: 2.34
1268  **/
1269 const gchar *
1270 g_application_get_dbus_object_path (GApplication *application)
1271 {
1272   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1273   g_return_val_if_fail (application->priv->is_registered, FALSE);
1274
1275   return g_application_impl_get_dbus_object_path (application->priv->impl);
1276 }
1277
1278 /* Register {{{1 */
1279 /**
1280  * g_application_register:
1281  * @application: a #GApplication
1282  * @cancellable: (allow-none): a #GCancellable, or %NULL
1283  * @error: a pointer to a NULL #GError, or %NULL
1284  *
1285  * Attempts registration of the application.
1286  *
1287  * This is the point at which the application discovers if it is the
1288  * primary instance or merely acting as a remote for an already-existing
1289  * primary instance.  This is implemented by attempting to acquire the
1290  * application identifier as a unique bus name on the session bus using
1291  * GDBus.
1292  *
1293  * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
1294  * given, then this process will always become the primary instance.
1295  *
1296  * Due to the internal architecture of GDBus, method calls can be
1297  * dispatched at any time (even if a main loop is not running).  For
1298  * this reason, you must ensure that any object paths that you wish to
1299  * register are registered before calling this function.
1300  *
1301  * If the application has already been registered then %TRUE is
1302  * returned with no work performed.
1303  *
1304  * The #GApplication::startup signal is emitted if registration succeeds
1305  * and @application is the primary instance (including the non-unique
1306  * case).
1307  *
1308  * In the event of an error (such as @cancellable being cancelled, or a
1309  * failure to connect to the session bus), %FALSE is returned and @error
1310  * is set appropriately.
1311  *
1312  * Note: the return value of this function is not an indicator that this
1313  * instance is or is not the primary instance of the application.  See
1314  * g_application_get_is_remote() for that.
1315  *
1316  * Returns: %TRUE if registration succeeded
1317  *
1318  * Since: 2.28
1319  **/
1320 gboolean
1321 g_application_register (GApplication  *application,
1322                         GCancellable  *cancellable,
1323                         GError       **error)
1324 {
1325   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1326
1327   if (!application->priv->is_registered)
1328     {
1329       if (application->priv->id == NULL)
1330         application->priv->flags |= G_APPLICATION_NON_UNIQUE;
1331
1332       application->priv->impl =
1333         g_application_impl_register (application, application->priv->id,
1334                                      application->priv->flags,
1335                                      application->priv->actions,
1336                                      &application->priv->remote_actions,
1337                                      cancellable, error);
1338
1339       if (application->priv->impl == NULL)
1340         return FALSE;
1341
1342       application->priv->is_remote = application->priv->remote_actions != NULL;
1343       application->priv->is_registered = TRUE;
1344
1345       g_object_notify (G_OBJECT (application), "is-registered");
1346
1347       if (!application->priv->is_remote)
1348         {
1349           g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1350
1351           if (!application->priv->did_startup)
1352             g_critical ("GApplication subclass '%s' failed to chain up on"
1353                         " ::startup (from start of override function)",
1354                         G_OBJECT_TYPE_NAME (application));
1355         }
1356     }
1357
1358   return TRUE;
1359 }
1360
1361 /* Hold/release {{{1 */
1362 /**
1363  * g_application_hold:
1364  * @application: a #GApplication
1365  *
1366  * Increases the use count of @application.
1367  *
1368  * Use this function to indicate that the application has a reason to
1369  * continue to run.  For example, g_application_hold() is called by GTK+
1370  * when a toplevel window is on the screen.
1371  *
1372  * To cancel the hold, call g_application_release().
1373  **/
1374 void
1375 g_application_hold (GApplication *application)
1376 {
1377   g_return_if_fail (G_IS_APPLICATION (application));
1378
1379   if (application->priv->inactivity_timeout_id)
1380     {
1381       g_source_remove (application->priv->inactivity_timeout_id);
1382       application->priv->inactivity_timeout_id = 0;
1383     }
1384
1385   application->priv->use_count++;
1386 }
1387
1388 static gboolean
1389 inactivity_timeout_expired (gpointer data)
1390 {
1391   GApplication *application = G_APPLICATION (data);
1392
1393   application->priv->inactivity_timeout_id = 0;
1394
1395   return G_SOURCE_REMOVE;
1396 }
1397
1398
1399 /**
1400  * g_application_release:
1401  * @application: a #GApplication
1402  *
1403  * Decrease the use count of @application.
1404  *
1405  * When the use count reaches zero, the application will stop running.
1406  *
1407  * Never call this function except to cancel the effect of a previous
1408  * call to g_application_hold().
1409  **/
1410 void
1411 g_application_release (GApplication *application)
1412 {
1413   g_return_if_fail (G_IS_APPLICATION (application));
1414
1415   application->priv->use_count--;
1416
1417   if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
1418     application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
1419                                                               inactivity_timeout_expired, application);
1420 }
1421
1422 /* Activate, Open {{{1 */
1423 /**
1424  * g_application_activate:
1425  * @application: a #GApplication
1426  *
1427  * Activates the application.
1428  *
1429  * In essence, this results in the #GApplication::activate signal being
1430  * emitted in the primary instance.
1431  *
1432  * The application must be registered before calling this function.
1433  *
1434  * Since: 2.28
1435  **/
1436 void
1437 g_application_activate (GApplication *application)
1438 {
1439   g_return_if_fail (G_IS_APPLICATION (application));
1440   g_return_if_fail (application->priv->is_registered);
1441
1442   if (application->priv->is_remote)
1443     g_application_impl_activate (application->priv->impl,
1444                                  get_platform_data (application));
1445
1446   else
1447     g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1448 }
1449
1450 /**
1451  * g_application_open:
1452  * @application: a #GApplication
1453  * @files: (array length=n_files): an array of #GFiles to open
1454  * @n_files: the length of the @files array
1455  * @hint: a hint (or ""), but never %NULL
1456  *
1457  * Opens the given files.
1458  *
1459  * In essence, this results in the #GApplication::open signal being emitted
1460  * in the primary instance.
1461  *
1462  * @n_files must be greater than zero.
1463  *
1464  * @hint is simply passed through to the ::open signal.  It is
1465  * intended to be used by applications that have multiple modes for
1466  * opening files (eg: "view" vs "edit", etc).  Unless you have a need
1467  * for this functionality, you should use "".
1468  *
1469  * The application must be registered before calling this function
1470  * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1471  *
1472  * Since: 2.28
1473  **/
1474 void
1475 g_application_open (GApplication  *application,
1476                     GFile        **files,
1477                     gint           n_files,
1478                     const gchar   *hint)
1479 {
1480   g_return_if_fail (G_IS_APPLICATION (application));
1481   g_return_if_fail (application->priv->flags &
1482                     G_APPLICATION_HANDLES_OPEN);
1483   g_return_if_fail (application->priv->is_registered);
1484
1485   if (application->priv->is_remote)
1486     g_application_impl_open (application->priv->impl,
1487                              files, n_files, hint,
1488                              get_platform_data (application));
1489
1490   else
1491     g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1492                    0, files, n_files, hint);
1493 }
1494
1495 /* Run {{{1 */
1496 /**
1497  * g_application_run:
1498  * @application: a #GApplication
1499  * @argc: the argc from main() (or 0 if @argv is %NULL)
1500  * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1501  *
1502  * Runs the application.
1503  *
1504  * This function is intended to be run from main() and its return value
1505  * is intended to be returned by main(). Although you are expected to pass
1506  * the @argc, @argv parameters from main() to this function, it is possible
1507  * to pass %NULL if @argv is not available or commandline handling is not
1508  * required.
1509  *
1510  * First, the local_command_line() virtual function is invoked.
1511  * This function always runs on the local instance. It gets passed a pointer
1512  * to a %NULL-terminated copy of @argv and is expected to remove the arguments
1513  * that it handled (shifting up remaining arguments). See
1514  * <xref linkend="gapplication-example-cmdline2"/> for an example of
1515  * parsing @argv manually. Alternatively, you may use the #GOptionContext API,
1516  * after setting <literal>argc = g_strv_length (argv);</literal>.
1517  *
1518  * The last argument to local_command_line() is a pointer to the @status
1519  * variable which can used to set the exit status that is returned from
1520  * g_application_run().
1521  *
1522  * If local_command_line() returns %TRUE, the command line is expected
1523  * to be completely handled, including possibly registering as the primary
1524  * instance, calling g_application_activate() or g_application_open(), etc.
1525  *
1526  * If local_command_line() returns %FALSE then the application is registered
1527  * and the #GApplication::command-line signal is emitted in the primary
1528  * instance (which may or may not be this instance). The signal handler
1529  * gets passed a #GApplicationCommandLine object that (among other things)
1530  * contains the remaining commandline arguments that have not been handled
1531  * by local_command_line().
1532  *
1533  * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1534  * flag set then the default implementation of local_command_line()
1535  * always returns %FALSE immediately, resulting in the commandline
1536  * always being handled in the primary instance.
1537  *
1538  * Otherwise, the default implementation of local_command_line() tries
1539  * to do a couple of things that are probably reasonable for most
1540  * applications.  First, g_application_register() is called to attempt
1541  * to register the application.  If that works, then the command line
1542  * arguments are inspected.  If no commandline arguments are given, then
1543  * g_application_activate() is called.  If commandline arguments are
1544  * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1545  * are assumed to be filenames and g_application_open() is called.
1546  *
1547  * If you need to handle commandline arguments that are not filenames,
1548  * and you don't mind commandline handling to happen in the primary
1549  * instance, you should set %G_APPLICATION_HANDLES_COMMAND_LINE and
1550  * process the commandline arguments in your #GApplication::command-line
1551  * signal handler, either manually or using the #GOptionContext API.
1552  *
1553  * If you are interested in doing more complicated local handling of the
1554  * commandline then you should implement your own #GApplication subclass
1555  * and override local_command_line(). In this case, you most likely want
1556  * to return %TRUE from your local_command_line() implementation to
1557  * suppress the default handling. See
1558  * <xref linkend="gapplication-example-cmdline2"/> for an example.
1559  *
1560  * If, after the above is done, the use count of the application is zero
1561  * then the exit status is returned immediately.  If the use count is
1562  * non-zero then the default main context is iterated until the use count
1563  * falls to zero, at which point 0 is returned.
1564  *
1565  * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
1566  * run for as much as 10 seconds with a use count of zero while waiting
1567  * for the message that caused the activation to arrive.  After that,
1568  * if the use count falls to zero the application will exit immediately,
1569  * except in the case that g_application_set_inactivity_timeout() is in
1570  * use.
1571  *
1572  * This function sets the prgname (g_set_prgname()), if not already set,
1573  * to the basename of argv[0].  Since 2.38, if %G_APPLICATION_IS_SERVICE
1574  * is specified, the prgname is set to the application ID.  The main
1575  * impact of this is is that the wmclass of windows created by Gtk+ will
1576  * be set accordingly, which helps the window manager determine which
1577  * application is showing the window.
1578  *
1579  * Since 2.40, applications that are not explicitly flagged as services
1580  * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
1581  * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
1582  * default handler for local_command_line) if "--gapplication-service"
1583  * was given in the command line.  If this flag is present then normal
1584  * commandline processing is interrupted and the
1585  * %G_APPLICATION_IS_SERVICE flag is set.  This provides a "compromise"
1586  * solution whereby running an application directly from the commandline
1587  * will invoke it in the normal way (which can be useful for debugging)
1588  * while still allowing applications to be D-Bus activated in service
1589  * mode.  The D-Bus service file should invoke the executable with
1590  * "--gapplication-service" as the sole commandline argument.  This
1591  * approach is suitable for use by most graphical applications but
1592  * should not be used from applications like editors that need precise
1593  * control over when processes invoked via the commandline will exit and
1594  * what their exit status will be.
1595  *
1596  * Returns: the exit status
1597  *
1598  * Since: 2.28
1599  **/
1600 int
1601 g_application_run (GApplication  *application,
1602                    int            argc,
1603                    char         **argv)
1604 {
1605   gchar **arguments;
1606   int status;
1607   gint i;
1608
1609   g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1610   g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1611   g_return_val_if_fail (!application->priv->must_quit_now, 1);
1612
1613   arguments = g_new (gchar *, argc + 1);
1614   for (i = 0; i < argc; i++)
1615     arguments[i] = g_strdup (argv[i]);
1616   arguments[i] = NULL;
1617
1618   if (g_get_prgname () == NULL)
1619     {
1620       if (application->priv->flags & G_APPLICATION_IS_SERVICE)
1621         {
1622           g_set_prgname (application->priv->id);
1623         }
1624       else if (argc > 0)
1625         {
1626           gchar *prgname;
1627
1628           prgname = g_path_get_basename (argv[0]);
1629           g_set_prgname (prgname);
1630           g_free (prgname);
1631         }
1632     }
1633
1634   if (!G_APPLICATION_GET_CLASS (application)
1635         ->local_command_line (application, &arguments, &status))
1636     {
1637       GError *error = NULL;
1638
1639       if (!g_application_register (application, NULL, &error))
1640         {
1641           g_printerr ("Failed to register: %s\n", error->message);
1642           g_error_free (error);
1643           return 1;
1644         }
1645
1646       if (application->priv->is_remote)
1647         {
1648           GVariant *platform_data;
1649
1650           platform_data = get_platform_data (application);
1651           status = g_application_impl_command_line (application->priv->impl,
1652                                                     arguments, platform_data);
1653         }
1654       else
1655         {
1656           GApplicationCommandLine *cmdline;
1657           GVariant *v;
1658
1659           v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1660           cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1661                                   "arguments", v, NULL);
1662           g_signal_emit (application,
1663                          g_application_signals[SIGNAL_COMMAND_LINE],
1664                          0, cmdline, &status);
1665           g_object_unref (cmdline);
1666         }
1667     }
1668
1669   g_strfreev (arguments);
1670
1671   if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1672       application->priv->is_registered &&
1673       !application->priv->use_count &&
1674       !application->priv->inactivity_timeout_id)
1675     {
1676       application->priv->inactivity_timeout_id =
1677         g_timeout_add (10000, inactivity_timeout_expired, application);
1678     }
1679
1680   while (application->priv->use_count || application->priv->inactivity_timeout_id)
1681     {
1682       if (application->priv->must_quit_now)
1683         break;
1684
1685       g_main_context_iteration (NULL, TRUE);
1686       status = 0;
1687     }
1688
1689   if (application->priv->is_registered && !application->priv->is_remote)
1690     {
1691       g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
1692
1693       if (!application->priv->did_shutdown)
1694         g_critical ("GApplication subclass '%s' failed to chain up on"
1695                     " ::shutdown (from end of override function)",
1696                     G_OBJECT_TYPE_NAME (application));
1697     }
1698
1699   if (application->priv->impl)
1700     g_application_impl_flush (application->priv->impl);
1701
1702   g_settings_sync ();
1703
1704   return status;
1705 }
1706
1707 static gchar **
1708 g_application_list_actions (GActionGroup *action_group)
1709 {
1710   GApplication *application = G_APPLICATION (action_group);
1711
1712   g_return_val_if_fail (application->priv->is_registered, NULL);
1713
1714   if (application->priv->remote_actions != NULL)
1715     return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
1716
1717   else if (application->priv->actions != NULL)
1718     return g_action_group_list_actions (application->priv->actions);
1719
1720   else
1721     /* empty string array */
1722     return g_new0 (gchar *, 1);
1723 }
1724
1725 static gboolean
1726 g_application_query_action (GActionGroup        *group,
1727                             const gchar         *action_name,
1728                             gboolean            *enabled,
1729                             const GVariantType **parameter_type,
1730                             const GVariantType **state_type,
1731                             GVariant           **state_hint,
1732                             GVariant           **state)
1733 {
1734   GApplication *application = G_APPLICATION (group);
1735
1736   g_return_val_if_fail (application->priv->is_registered, FALSE);
1737
1738   if (application->priv->remote_actions != NULL)
1739     return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
1740                                         action_name,
1741                                         enabled,
1742                                         parameter_type,
1743                                         state_type,
1744                                         state_hint,
1745                                         state);
1746
1747   if (application->priv->actions != NULL)
1748     return g_action_group_query_action (application->priv->actions,
1749                                         action_name,
1750                                         enabled,
1751                                         parameter_type,
1752                                         state_type,
1753                                         state_hint,
1754                                         state);
1755
1756   return FALSE;
1757 }
1758
1759 static void
1760 g_application_change_action_state (GActionGroup *action_group,
1761                                    const gchar  *action_name,
1762                                    GVariant     *value)
1763 {
1764   GApplication *application = G_APPLICATION (action_group);
1765
1766   g_return_if_fail (application->priv->is_remote ||
1767                     application->priv->actions != NULL);
1768   g_return_if_fail (application->priv->is_registered);
1769
1770   if (application->priv->remote_actions)
1771     g_remote_action_group_change_action_state_full (application->priv->remote_actions,
1772                                                     action_name, value, get_platform_data (application));
1773
1774   else
1775     g_action_group_change_action_state (application->priv->actions, action_name, value);
1776 }
1777
1778 static void
1779 g_application_activate_action (GActionGroup *action_group,
1780                                const gchar  *action_name,
1781                                GVariant     *parameter)
1782 {
1783   GApplication *application = G_APPLICATION (action_group);
1784
1785   g_return_if_fail (application->priv->is_remote ||
1786                     application->priv->actions != NULL);
1787   g_return_if_fail (application->priv->is_registered);
1788
1789   if (application->priv->remote_actions)
1790     g_remote_action_group_activate_action_full (application->priv->remote_actions,
1791                                                 action_name, parameter, get_platform_data (application));
1792
1793   else
1794     g_action_group_activate_action (application->priv->actions, action_name, parameter);
1795 }
1796
1797 static GAction *
1798 g_application_lookup_action (GActionMap  *action_map,
1799                              const gchar *action_name)
1800 {
1801   GApplication *application = G_APPLICATION (action_map);
1802
1803   g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
1804
1805   return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
1806 }
1807
1808 static void
1809 g_application_add_action (GActionMap *action_map,
1810                           GAction    *action)
1811 {
1812   GApplication *application = G_APPLICATION (action_map);
1813
1814   g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
1815
1816   g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
1817 }
1818
1819 static void
1820 g_application_remove_action (GActionMap  *action_map,
1821                              const gchar *action_name)
1822 {
1823   GApplication *application = G_APPLICATION (action_map);
1824
1825   g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
1826
1827   g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
1828 }
1829
1830 static void
1831 g_application_action_group_iface_init (GActionGroupInterface *iface)
1832 {
1833   iface->list_actions = g_application_list_actions;
1834   iface->query_action = g_application_query_action;
1835   iface->change_action_state = g_application_change_action_state;
1836   iface->activate_action = g_application_activate_action;
1837 }
1838
1839 static void
1840 g_application_action_map_iface_init (GActionMapInterface *iface)
1841 {
1842   iface->lookup_action = g_application_lookup_action;
1843   iface->add_action = g_application_add_action;
1844   iface->remove_action = g_application_remove_action;
1845 }
1846
1847 /* Default Application {{{1 */
1848
1849 static GApplication *default_app;
1850
1851 /**
1852  * g_application_get_default:
1853  *
1854  * Returns the default #GApplication instance for this process.
1855  *
1856  * Normally there is only one #GApplication per process and it becomes
1857  * the default when it is created.  You can exercise more control over
1858  * this by using g_application_set_default().
1859  *
1860  * If there is no default application then %NULL is returned.
1861  *
1862  * Returns: (transfer none): the default application for this process, or %NULL
1863  *
1864  * Since: 2.32
1865  **/
1866 GApplication *
1867 g_application_get_default (void)
1868 {
1869   return default_app;
1870 }
1871
1872 /**
1873  * g_application_set_default:
1874  * @application: (allow-none): the application to set as default, or %NULL
1875  *
1876  * Sets or unsets the default application for the process, as returned
1877  * by g_application_get_default().
1878  *
1879  * This function does not take its own reference on @application.  If
1880  * @application is destroyed then the default application will revert
1881  * back to %NULL.
1882  *
1883  * Since: 2.32
1884  **/
1885 void
1886 g_application_set_default (GApplication *application)
1887 {
1888   default_app = application;
1889 }
1890
1891 /**
1892  * g_application_quit:
1893  * @application: a #GApplication
1894  *
1895  * Immediately quits the application.
1896  *
1897  * Upon return to the mainloop, g_application_run() will return,
1898  * calling only the 'shutdown' function before doing so.
1899  *
1900  * The hold count is ignored.
1901  *
1902  * The result of calling g_application_run() again after it returns is
1903  * unspecified.
1904  *
1905  * Since: 2.32
1906  **/
1907 void
1908 g_application_quit (GApplication *application)
1909 {
1910   g_return_if_fail (G_IS_APPLICATION (application));
1911
1912   application->priv->must_quit_now = TRUE;
1913 }
1914
1915 /**
1916  * g_application_mark_busy:
1917  * @application: a #GApplication
1918  *
1919  * Increases the busy count of @application.
1920  *
1921  * Use this function to indicate that the application is busy, for instance
1922  * while a long running operation is pending.
1923  *
1924  * The busy state will be exposed to other processes, so a session shell will
1925  * use that information to indicate the state to the user (e.g. with a
1926  * spinner).
1927  *
1928  * To cancel the busy indication, use g_application_unmark_busy().
1929  *
1930  * Since: 2.38
1931  **/
1932 void
1933 g_application_mark_busy (GApplication *application)
1934 {
1935   gboolean was_busy;
1936
1937   g_return_if_fail (G_IS_APPLICATION (application));
1938
1939   was_busy = (application->priv->busy_count > 0);
1940   application->priv->busy_count++;
1941
1942   if (!was_busy)
1943     g_application_impl_set_busy_state (application->priv->impl, TRUE);
1944 }
1945
1946 /**
1947  * g_application_unmark_busy:
1948  * @application: a #GApplication
1949  *
1950  * Decreases the busy count of @application.
1951  *
1952  * When the busy count reaches zero, the new state will be propagated
1953  * to other processes.
1954  *
1955  * This function must only be called to cancel the effect of a previous
1956  * call to g_application_mark_busy().
1957  *
1958  * Since: 2.38
1959  **/
1960 void
1961 g_application_unmark_busy (GApplication *application)
1962 {
1963   g_return_if_fail (G_IS_APPLICATION (application));
1964   g_return_if_fail (application->priv->busy_count > 0);
1965
1966   application->priv->busy_count--;
1967
1968   if (application->priv->busy_count == 0)
1969     g_application_impl_set_busy_state (application->priv->impl, FALSE);
1970 }
1971
1972 /* Notifications {{{1 */
1973
1974 /**
1975  * g_application_send_notification:
1976  * @application: a #GApplication
1977  * @id: (allow-none): id of the notification, or %NULL
1978  * @notification: the #GNotification to send
1979  *
1980  * Sends a notification on behalf of @application to the desktop shell.
1981  * There is no guarantee that the notification is displayed immediately,
1982  * or even at all.
1983  *
1984  * Notifications may persist after the application exits. It will be
1985  * D-Bus-activated when the notification or one of its actions is
1986  * activated.
1987  *
1988  * Modifying @notification after this call has no effect. However, the
1989  * object can be reused for a later call to this function.
1990  *
1991  * @id may be any string that uniquely identifies the event for the
1992  * application. It does not need to be in any special format. For
1993  * example, "new-message" might be appropriate for a notification about
1994  * new messages.
1995  *
1996  * If a previous notification was sent with the same @id, it will be
1997  * replaced with @notification and shown again as if it was a new
1998  * notification. This works even for notifications sent from a previous
1999  * execution of the application, as long as @id is the same string.
2000  *
2001  * @id may be %NULL, but it is impossible to replace or withdraw
2002  * notifications without an id.
2003  *
2004  * If @notification is no longer relevant, it can be withdrawn with
2005  * g_application_withdraw_notification().
2006  *
2007  * Since: 2.40
2008  */
2009 void
2010 g_application_send_notification (GApplication  *application,
2011                                  const gchar   *id,
2012                                  GNotification *notification)
2013 {
2014   gchar *generated_id = NULL;
2015
2016   g_return_if_fail (G_IS_APPLICATION (application));
2017   g_return_if_fail (G_IS_NOTIFICATION (notification));
2018   g_return_if_fail (g_application_get_is_registered (application));
2019   g_return_if_fail (!g_application_get_is_remote (application));
2020
2021   if (application->priv->notifications == NULL)
2022     application->priv->notifications = g_notification_backend_new_default (application);
2023
2024   if (id == NULL)
2025     {
2026       generated_id = g_dbus_generate_guid ();
2027       id = generated_id;
2028     }
2029
2030   g_notification_backend_send_notification (application->priv->notifications, id, notification);
2031
2032   g_free (generated_id);
2033 }
2034
2035 /**
2036  * g_application_withdraw_notification:
2037  * @application: a #GApplication
2038  * @id: id of a previously sent notification
2039  *
2040  * Withdraws a notification that was sent with
2041  * g_application_send_notification().
2042  *
2043  * This call does nothing if a notification with @id doesn't exist or
2044  * the notification was never sent.
2045  *
2046  * This function works even for notifications sent in previous
2047  * executions of this application, as long @id is the same as it was for
2048  * the sent notification.
2049  *
2050  * Note that notifications are dismissed when the user clicks on one
2051  * of the buttons in a notification or triggers its default action, so
2052  * there is no need to explicitly withdraw the notification in that case.
2053  *
2054  * Since: 2.40
2055  */
2056 void
2057 g_application_withdraw_notification (GApplication *application,
2058                                      const gchar  *id)
2059 {
2060   g_return_if_fail (G_IS_APPLICATION (application));
2061   g_return_if_fail (id != NULL);
2062
2063   if (application->priv->notifications)
2064     g_notification_backend_withdraw_notification (application->priv->notifications, id);
2065 }
2066
2067 /* Epilogue {{{1 */
2068 /* vim:set foldmethod=marker: */