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