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