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 "gapplicationimpl.h"
  29 #include "gactiongroup.h"
  30
  31 #include "gioenumtypes.h"
  32 #include "gio-marshal.h"
  33 #include "gioenums.h"
  34 #include "gfile.h"
  35
  36 #include "glibintl.h"
  37
  38 #include <string.h>
  39
  40 /**
  41  * SECTION: gapplication
  42  * @title: GApplication
  43  * @short_description: Core application class
  44  *
  45  * A #GApplication is the foundation of an application, unique for a
  46  * given application identifier.  The GApplication class wraps some
  47  * low-level platform-specific services and is intended to act as the
  48  * foundation for higher-level application classes such as
  49  * #GtkApplication or #MxApplication.  In general, you should not use
  50  * this class outside of a higher level framework.
  51  *
  52  * One of the core features that GApplication provides is process
  53  * uniqueness, in the context of a "session".  The session concept is
  54  * platform-dependent, but corresponds roughly to a graphical desktop
  55  * login.  When your application is launched again, its arguments
  56  * are passed through platform communication to the already running
  57  * program. The already running instance of the program is called the
  58  * <firstterm>primary instance</firstterm>.
  59  *
  60  * Before using GApplication, you must choose an "application identifier".
  61  * The expected form of an application identifier is very close to that of
  62  * of a <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
  63  * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
  64  * For details on valid application identifiers, see
  65  * g_application_id_is_valid().
  66  *
  67  * GApplication provides convenient life cycle management by maintaining
  68  * a <firstterm>use count</firstterm> for the primary application instance.
  69  * The use count can be changed using g_application_hold() and
  70  * g_application_release(). If it drops to zero, the application exits.
  71  *
  72  * <example id="gapplication-example-open"><title>Opening files with a GApplication</title>
  73  * <programlisting>
  74  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-open.c">
  75  *   <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
  76  * </xi:include>
  77  * </programlisting>
  78  * </example>
  79  */
  80
  81 struct _GApplicationPrivate
  82 {
  83   GApplicationFlags  flags;
  84   gchar             *id;
  85
  86   GActionGroup      *actions;
  87   GMainLoop         *mainloop;
  88
  89   guint              inactivity_timeout_id;
  90   guint              inactivity_timeout;
  91   guint              use_count;
  92
  93   guint              is_registered : 1;
  94   guint              is_remote : 1;
  95
  96   GHashTable        *remote_actions;  /* string -> RemoteActionInfo */
  97   GApplicationImpl  *impl;
  98 };
  99
 100 enum
 101 {
 102   PROP_NONE,
 103   PROP_APPLICATION_ID,
 104   PROP_FLAGS,
 105   PROP_IS_REGISTERED,
 106   PROP_IS_REMOTE,
 107   PROP_INACTIVITY_TIMEOUT,
 108   PROP_ACTION_GROUP
 109 };
 110
 111 enum
 112 {
 113   SIGNAL_STARTUP,
 114   SIGNAL_ACTIVATE,
 115   SIGNAL_OPEN,
 116   SIGNAL_ACTION,
 117   SIGNAL_COMMAND_LINE,
 118   NR_SIGNALS
 119 };
 120
 121 static guint g_application_signals[NR_SIGNALS];
 122
 123 static void g_application_action_group_iface_init (GActionGroupInterface *);
 124 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
 125  G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP,
 126    g_application_action_group_iface_init))
 127
 128 /* vfunc defaults {{{1 */
 129 static void
 130 g_application_real_before_emit (GApplication *application,
 131                                 GVariant     *platform_data)
 132 {
 133 }
 134
 135 static void
 136 g_application_real_after_emit (GApplication *application,
 137                                GVariant     *platform_data)
 138 {
 139 }
 140
 141 static void
 142 g_application_real_startup (GApplication *application)
 143 {
 144 }
 145
 146 static void
 147 g_application_real_activate (GApplication *application)
 148 {
 149   if (!g_signal_has_handler_pending (application,
 150                                      g_application_signals[SIGNAL_ACTIVATE],
 151                                      0, TRUE))
 152     {
 153       static gboolean warned;
 154
 155       if (warned)
 156         return;
 157
 158       g_warning ("Your application does not implement "
 159                  "g_application_activate() and has no handlers connected "
 160                  "to the 'activate' signal.  It should do one of these.");
 161       warned = TRUE;
 162     }
 163 }
 164
 165 static void
 166 g_application_real_open (GApplication  *application,
 167                          GFile        **files,
 168                          gint           n_files,
 169                          const gchar   *hint)
 170 {
 171   if (!g_signal_has_handler_pending (application,
 172                                      g_application_signals[SIGNAL_OPEN],
 173                                      0, TRUE))
 174     {
 175       static gboolean warned;
 176
 177       if (warned)
 178         return;
 179
 180       g_warning ("Your application claims to support opening files "
 181                  "but does not implement g_application_open() and has no "
 182                  "handlers connected to the 'open' signal.");
 183       warned = TRUE;
 184     }
 185 }
 186
 187 static int
 188 g_application_real_command_line (GApplication            *application,
 189                                  GApplicationCommandLine *cmdline)
 190 {
 191   static gboolean warned;
 192
 193   if (warned)
 194     return 1;
 195
 196   g_warning ("Your application claims to support custom command line "
 197              "handling but does not implement g_application_command_line() "
 198              "and has no handlers connected to the 'command-line' signal.");
 199
 200   warned = TRUE;
 201
 202   return 1;
 203 }
 204
 205 static gboolean
 206 g_application_real_local_command_line (GApplication   *application,
 207                                        gchar        ***arguments,
 208                                        int            *exit_status)
 209 {
 210   if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
 211     return FALSE;
 212
 213   else
 214     {
 215       GError *error = NULL;
 216       gint n_args;
 217
 218       if (!g_application_register (application, NULL, &error))
 219         {
 220           g_critical ("%s", error->message);
 221           g_error_free (error);
 222           *exit_status = 1;
 223           return TRUE;
 224         }
 225
 226       n_args = g_strv_length (*arguments);
 227
 228       if (application->priv->flags & G_APPLICATION_IS_SERVICE)
 229         {
 230           if ((*exit_status = n_args > 1))
 231             {
 232               g_printerr ("GApplication service mode takes no arguments.\n");
 233               application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
 234             }
 235
 236           return TRUE;
 237         }
 238
 239       if (n_args <= 1)
 240         {
 241           g_application_activate (application);
 242           *exit_status = 0;
 243         }
 244
 245       else
 246         {
 247           if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
 248             {
 249               g_critical ("This application can not open files.");
 250               *exit_status = 1;
 251             }
 252           else
 253             {
 254               GFile **files;
 255               gint n_files;
 256               gint i;
 257
 258               n_files = n_args - 1;
 259               files = g_new (GFile *, n_files);
 260
 261               for (i = 0; i < n_files; i++)
 262                 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
 263
 264               g_application_open (application, files, n_files, "");
 265
 266               for (i = 0; i < n_files; i++)
 267                 g_object_unref (files[i]);
 268               g_free (files);
 269
 270               *exit_status = 0;
 271             }
 272         }
 273
 274       return TRUE;
 275     }
 276 }
 277
 278 static void
 279 g_application_real_add_platform_data (GApplication    *application,
 280                                       GVariantBuilder *builder)
 281 {
 282 }
 283
 284 static void
 285 g_application_real_quit_mainloop (GApplication *application)
 286 {
 287   if (application->priv->mainloop != NULL)
 288     g_main_loop_quit (application->priv->mainloop);
 289 }
 290
 291 static void
 292 g_application_real_run_mainloop (GApplication *application)
 293 {
 294   if (application->priv->mainloop == NULL)
 295     application->priv->mainloop = g_main_loop_new (NULL, FALSE);
 296
 297   g_main_loop_run (application->priv->mainloop);
 298 }
 299
 300 /* GObject implementation stuff {{{1 */
 301 static void
 302 g_application_set_property (GObject      *object,
 303                             guint         prop_id,
 304                             const GValue *value,
 305                             GParamSpec   *pspec)
 306 {
 307   GApplication *application = G_APPLICATION (object);
 308
 309   switch (prop_id)
 310     {
 311     case PROP_APPLICATION_ID:
 312       g_application_set_application_id (application,
 313                                         g_value_get_string (value));
 314       break;
 315
 316     case PROP_FLAGS:
 317       g_application_set_flags (application, g_value_get_flags (value));
 318       break;
 319
 320     case PROP_INACTIVITY_TIMEOUT:
 321       g_application_set_inactivity_timeout (application,
 322                                             g_value_get_uint (value));
 323       break;
 324
 325     case PROP_ACTION_GROUP:
 326       g_application_set_action_group (application,
 327                                       g_value_get_object (value));
 328       break;
 329
 330     default:
 331       g_assert_not_reached ();
 332     }
 333 }
 334
 335 /**
 336  * g_application_set_action_group:
 337  * @application: a #GApplication
 338  * @action_group: a #GActionGroup, or %NULL
 339  *
 340  * Sets or unsets the group of actions associated with the application.
 341  *
 342  * These actions are the actions that can be remotely invoked.
 343  *
 344  * It is an error to call this function after the application has been
 345  * registered.
 346  *
 347  * Since: 2.28
 348  **/
 349 void
 350 g_application_set_action_group (GApplication *application,
 351                                 GActionGroup *action_group)
 352 {
 353   g_return_if_fail (G_IS_APPLICATION (application));
 354   g_return_if_fail (!application->priv->is_registered);
 355
 356   if (application->priv->actions != NULL)
 357     g_object_unref (application->priv->actions);
 358
 359   application->priv->actions = action_group;
 360
 361   if (application->priv->actions != NULL)
 362     g_object_ref (application->priv->actions);
 363 }
 364
 365 static void
 366 g_application_get_property (GObject    *object,
 367                             guint       prop_id,
 368                             GValue     *value,
 369                             GParamSpec *pspec)
 370 {
 371   GApplication *application = G_APPLICATION (object);
 372
 373   switch (prop_id)
 374     {
 375     case PROP_APPLICATION_ID:
 376       g_value_set_string (value,
 377                           g_application_get_application_id (application));
 378       break;
 379
 380     case PROP_FLAGS:
 381       g_value_set_flags (value,
 382                          g_application_get_flags (application));
 383       break;
 384
 385     case PROP_IS_REGISTERED:
 386       g_value_set_boolean (value,
 387                            g_application_get_is_registered (application));
 388       break;
 389
 390     case PROP_IS_REMOTE:
 391       g_value_set_boolean (value,
 392                            g_application_get_is_remote (application));
 393       break;
 394
 395     case PROP_INACTIVITY_TIMEOUT:
 396       g_value_set_uint (value,
 397                         g_application_get_inactivity_timeout (application));
 398       break;
 399
 400     default:
 401       g_assert_not_reached ();
 402     }
 403 }
 404
 405 static void
 406 g_application_constructed (GObject *object)
 407 {
 408   GApplication *application = G_APPLICATION (object);
 409
 410   g_assert (application->priv->id != NULL);
 411 }
 412
 413 static void
 414 g_application_finalize (GObject *object)
 415 {
 416   GApplication *application = G_APPLICATION (object);
 417
 418   if (application->priv->impl)
 419     g_application_impl_destroy (application->priv->impl);
 420   g_free (application->priv->id);
 421
 422   if (application->priv->mainloop)
 423     g_main_loop_unref (application->priv->mainloop);
 424
 425   G_OBJECT_CLASS (g_application_parent_class)
 426     ->finalize (object);
 427 }
 428
 429 static void
 430 g_application_init (GApplication *application)
 431 {
 432   application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
 433                                                    G_TYPE_APPLICATION,
 434                                                    GApplicationPrivate);
 435 }
 436
 437 static void
 438 g_application_class_init (GApplicationClass *class)
 439 {
 440   GObjectClass *object_class = G_OBJECT_CLASS (class);
 441
 442   object_class->constructed = g_application_constructed;
 443   object_class->finalize = g_application_finalize;
 444   object_class->get_property = g_application_get_property;
 445   object_class->set_property = g_application_set_property;
 446
 447   class->before_emit = g_application_real_before_emit;
 448   class->after_emit = g_application_real_after_emit;
 449   class->startup = g_application_real_startup;
 450   class->activate = g_application_real_activate;
 451   class->open = g_application_real_open;
 452   class->command_line = g_application_real_command_line;
 453   class->local_command_line = g_application_real_local_command_line;
 454   class->add_platform_data = g_application_real_add_platform_data;
 455   class->quit_mainloop = g_application_real_quit_mainloop;
 456   class->run_mainloop = g_application_real_run_mainloop;
 457
 458   g_object_class_install_property (object_class, PROP_APPLICATION_ID,
 459     g_param_spec_string ("application-id",
 460                          P_("Application identifier"),
 461                          P_("The unique identifier for the application"),
 462                          NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
 463                          G_PARAM_STATIC_STRINGS));
 464
 465   g_object_class_install_property (object_class, PROP_FLAGS,
 466     g_param_spec_flags ("flags",
 467                         P_("Application flags"),
 468                         P_("Flags specifying the behaviour of the application"),
 469                         G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
 470                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 471
 472   g_object_class_install_property (object_class, PROP_IS_REGISTERED,
 473     g_param_spec_boolean ("is-registered",
 474                           P_("Is registered"),
 475                           P_("If g_application_register() has been called"),
 476                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 477
 478   g_object_class_install_property (object_class, PROP_IS_REMOTE,
 479     g_param_spec_boolean ("is-remote",
 480                           P_("Is remote"),
 481                           P_("If this application instance is remote"),
 482                           FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 483
 484   g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
 485     g_param_spec_uint ("inactivity-timeout",
 486                        P_("Inactivity timeout"),
 487                        P_("Iime (ms) to stay alive after becoming idle"),
 488                        0, G_MAXUINT, 0,
 489                        G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 490
 491   g_object_class_install_property (object_class, PROP_ACTION_GROUP,
 492     g_param_spec_object ("action-group",
 493                          P_("Action group"),
 494                          P_("The group of actions that the application exports"),
 495                          G_TYPE_ACTION_GROUP,
 496                          G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
 497
 498   /**
 499    * GApplication::startup:
 500    * @application: the application
 501    *
 502    * The ::startup signal is emitted on the primary instance immediately
 503    * after registration. See g_activation_register().
 504    */
 505   g_application_signals[SIGNAL_STARTUP] =
 506     g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
 507                   G_STRUCT_OFFSET (GApplicationClass, startup),
 508                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 509
 510   /**
 511    * GApplication::activate:
 512    * @application: the application
 513    *
 514    * The ::activate signal is emitted on the primary instance when an
 515    * activation occurs. See g_application_activate().
 516    */
 517   g_application_signals[SIGNAL_ACTIVATE] =
 518     g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
 519                   G_STRUCT_OFFSET (GApplicationClass, activate),
 520                   NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 521
 522
 523   /**
 524    * GApplication::open:
 525    * @application: the application
 526    * @files: an array of #GFile objects
 527    * @n_files: the length of @files
 528    * @hint: a hint provided by the calling instance
 529    *
 530    * The ::open signal is emitted on the primary instance when there are
 531    * files to open. See g_application_open() for more information.
 532    */
 533   g_application_signals[SIGNAL_OPEN] =
 534     g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
 535                   G_STRUCT_OFFSET (GApplicationClass, open),
 536                   NULL, NULL, _gio_marshal_VOID__POINTER_INT_STRING,
 537                   G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
 538
 539   /**
 540    * GApplication::command-line:
 541    * @application: the application
 542    * @command_line: a #GApplicationCommandLine representing the
 543    *     passed commandline
 544    *
 545    * The ::command-line signal is emitted on the primary instance when
 546    * a commandline is not handled locally. See g_application_run() for
 547    * more information.
 548    */
 549   g_application_signals[SIGNAL_COMMAND_LINE] =
 550     g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
 551                   G_STRUCT_OFFSET (GApplicationClass, command_line),
 552                   g_signal_accumulator_first_wins, NULL,
 553                   _gio_marshal_INT__OBJECT,
 554                   G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
 555
 556   g_type_class_add_private (class, sizeof (GApplicationPrivate));
 557 }
 558
 559 static GVariant *
 560 get_platform_data (GApplication *application)
 561 {
 562   GVariantBuilder *builder;
 563   GVariant *result;
 564
 565   builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
 566
 567   {
 568     gchar *cwd = g_get_current_dir ();
 569     g_variant_builder_add (builder, "{sv}", "cwd",
 570                            g_variant_new_bytestring (cwd));
 571     g_free (cwd);
 572   }
 573
 574   if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
 575     {
 576       GVariant *array;
 577       gchar **envp;
 578
 579       envp = g_get_environ ();
 580       array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
 581       g_strfreev (envp);
 582
 583       g_variant_builder_add (builder, "{sv}", "environ", array);
 584     }
 585
 586   G_APPLICATION_GET_CLASS (application)->
 587     add_platform_data (application, builder);
 588
 589   result = g_variant_builder_end (builder);
 590   g_variant_builder_unref (builder);
 591
 592   return result;
 593 }
 594
 595 /* Application ID validity {{{1 */
 596
 597 /**
 598  * g_application_id_is_valid:
 599  * @application_id: a potential application identifier
 600  * @returns: %TRUE if @application_id is valid
 601  *
 602  * Checks if @application_id is a valid application identifier.
 603  *
 604  * A valid ID is required for calls to g_application_new() and
 605  * g_application_set_application_id().
 606  *
 607  * For convenience, the restrictions on application identifiers are
 608  * reproduced here:
 609  * <itemizedlist>
 610  *   <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-" and must not begin with a digit.</listitem>
 611  *   <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least two elements).</listitem>
 612  *   <listitem>Application identifiers must not begin with a '.' (period) character.</listitem>
 613  *   <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
 614  *   <listitem>Application identifiers must not exceed 255 characters.</listitem>
 615  * </itemizedlist>
 616  **/
 617 gboolean
 618 g_application_id_is_valid (const gchar *application_id)
 619 {
 620   gboolean allow_dot;
 621
 622   if (strlen (application_id) > 255)
 623     return FALSE;
 624
 625   if (!g_ascii_isalpha (*application_id))
 626     return FALSE;
 627
 628   application_id++;
 629   allow_dot = FALSE;
 630   for (; *application_id; application_id++)
 631     {
 632       if (g_ascii_isalnum (*application_id) ||
 633           (*application_id == '-') ||
 634           (*application_id == '_'))
 635         allow_dot = TRUE;
 636       else if (allow_dot && *application_id == '.')
 637         allow_dot = FALSE;
 638       else
 639         return FALSE;
 640     }
 641
 642   return TRUE;
 643 }
 644
 645 /* Public Constructor {{{1 */
 646 /**
 647  * g_application_new:
 648  * @application_id: the application id
 649  * @flags: the application flags
 650  * @returns: a new #GApplication instance
 651  *
 652  * Creates a new #GApplication instance.
 653  *
 654  * This function calls g_type_init() for you.
 655  *
 656  * The application id must be valid.  See g_application_id_is_valid().
 657  **/
 658 GApplication *
 659 g_application_new (const gchar       *application_id,
 660                    GApplicationFlags  flags)
 661 {
 662   g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
 663
 664   g_type_init ();
 665
 666   return g_object_new (G_TYPE_APPLICATION,
 667                        "application-id", application_id,
 668                        "flags", flags,
 669                        NULL);
 670 }
 671
 672 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
 673 /**
 674  * g_application_get_application_id:
 675  * @application: a #GApplication
 676  * @returns: the identifier for @application, owned by @application
 677  *
 678  * Gets the unique identifier for @application.
 679  *
 680  * Since: 2.28
 681  **/
 682 const gchar *
 683 g_application_get_application_id (GApplication *application)
 684 {
 685   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
 686
 687   return application->priv->id;
 688 }
 689
 690 /**
 691  * g_application_set_application_id:
 692  * @application: a #GApplication
 693  * @application_id: the identifier for @application
 694  *
 695  * Sets the unique identifier for @application.
 696  *
 697  * The application id can only be modified if @application has not yet
 698  * been registered.
 699  *
 700  * The application id must be valid.  See g_application_id_is_valid().
 701  *
 702  * Since: 2.28
 703  **/
 704 void
 705 g_application_set_application_id (GApplication *application,
 706                                   const gchar  *application_id)
 707 {
 708   g_return_if_fail (G_IS_APPLICATION (application));
 709
 710   if (g_strcmp0 (application->priv->id, application_id) != 0)
 711     {
 712       g_return_if_fail (g_application_id_is_valid (application_id));
 713       g_return_if_fail (!application->priv->is_registered);
 714
 715       g_free (application->priv->id);
 716       application->priv->id = g_strdup (application_id);
 717
 718       g_object_notify (G_OBJECT (application), "application-id");
 719     }
 720 }
 721
 722 /**
 723  * g_application_get_flags:
 724  * @application: a #GApplication
 725  * @returns: the flags for @application
 726  *
 727  * Gets the flags for @application.
 728  *
 729  * See #GApplicationFlags.
 730  *
 731  * Since: 2.28
 732  **/
 733 GApplicationFlags
 734 g_application_get_flags (GApplication *application)
 735 {
 736   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
 737
 738   return application->priv->flags;
 739 }
 740
 741 /**
 742  * g_application_set_flags:
 743  * @application: a #GApplication
 744  * @flags: the flags for @application
 745  *
 746  * Sets the flags for @application.
 747  *
 748  * The flags can only be modified if @application has not yet been
 749  * registered.
 750  *
 751  * See #GApplicationFlags.
 752  *
 753  * Since: 2.28
 754  **/
 755 void
 756 g_application_set_flags (GApplication      *application,
 757                          GApplicationFlags  flags)
 758 {
 759   g_return_if_fail (G_IS_APPLICATION (application));
 760
 761   if (application->priv->flags != flags)
 762     {
 763       g_return_if_fail (!application->priv->is_registered);
 764
 765       application->priv->flags = flags;
 766
 767       g_object_notify (G_OBJECT (application), "flags");
 768     }
 769 }
 770
 771 /**
 772  * g_application_get_inactivity_timeout:
 773  * @application: a #GApplication
 774  *
 775  * Gets the current inactivity timeout for the application.
 776  *
 777  * This is the amount of time (in milliseconds) after the last call to
 778  * g_application_release() before the application stops running.
 779  *
 780  * Returns: the timeout, in milliseconds
 781  *
 782  * Since: 2.28
 783  **/
 784 guint
 785 g_application_get_inactivity_timeout (GApplication *application)
 786 {
 787   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
 788
 789   return application->priv->inactivity_timeout;
 790 }
 791
 792 /**
 793  * g_application_set_inactivity_timeout:
 794  * @application: a #GApplication
 795  * @inactivity_timeout: the timeout, in milliseconds
 796  *
 797  * Sets the current inactivity timeout for the application.
 798  *
 799  * This is the amount of time (in milliseconds) after the last call to
 800  * g_application_release() before the application stops running.
 801  *
 802  * This call has no side effects of its own.  The value set here is only
 803  * used for next time g_application_release() drops the use count to
 804  * zero.  Any timeouts currently in progress are not impacted.
 805  *
 806  * Returns: the timeout, in milliseconds
 807  *
 808  * Since: 2.28
 809  **/
 810 void
 811 g_application_set_inactivity_timeout (GApplication *application,
 812                                       guint         inactivity_timeout)
 813 {
 814   g_return_if_fail (G_IS_APPLICATION (application));
 815
 816   if (application->priv->inactivity_timeout != inactivity_timeout)
 817     {
 818       application->priv->inactivity_timeout = inactivity_timeout;
 819
 820       g_object_notify (G_OBJECT (application), "inactivity-timeout");
 821     }
 822 }
 823 /* Read-only property getters (is registered, is remote) {{{1 */
 824 /**
 825  * g_application_get_is_registered:
 826  * @application: a #GApplication
 827  * @returns: %TRUE if @application is registered
 828  *
 829  * Checks if @application is registered.
 830  *
 831  * An application is registered if g_application_register() has been
 832  * successfully called.
 833  *
 834  * Since: 2.28
 835  **/
 836 gboolean
 837 g_application_get_is_registered (GApplication *application)
 838 {
 839   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
 840
 841   return application->priv->is_registered;
 842 }
 843
 844 /**
 845  * g_application_get_is_remote:
 846  * @application: a #GApplication
 847  * @returns: %TRUE if @application is remote
 848  *
 849  * Checks if @application is remote.
 850  *
 851  * If @application is remote then it means that another instance of
 852  * application already exists (the 'primary' instance).  Calls to
 853  * perform actions on @application will result in the actions being
 854  * performed by the primary instance.
 855  *
 856  * The value of this property can not be accessed before
 857  * g_application_register() has been called.  See
 858  * g_application_get_is_registered().
 859  *
 860  * Since: 2.28
 861  **/
 862 gboolean
 863 g_application_get_is_remote (GApplication *application)
 864 {
 865   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
 866   g_return_val_if_fail (application->priv->is_registered, FALSE);
 867
 868   return application->priv->is_remote;
 869 }
 870
 871 /* Register {{{1 */
 872 /**
 873  * g_application_register:
 874  * @application: a #GApplication
 875  * @cancellable: a #GCancellable, or %NULL
 876  * @error: a pointer to a NULL #GError, or %NULL
 877  * @returns: %TRUE if registration succeeded
 878  *
 879  * Attempts registration of the application.
 880  *
 881  * This is the point at which the application discovers if it is the
 882  * primary instance or merely acting as a remote for an already-existing
 883  * primary instance.
 884  *
 885  * If the application has already been registered then %TRUE is
 886  * returned with no work performed.
 887  *
 888  * The #GApplication::startup signal is emitted if registration succeeds
 889  * and @application is the primary instance.
 890  *
 891  * In the event of an error (such as @cancellable being cancelled, or a
 892  * failure to connect to the session bus), %FALSE is returned and @error
 893  * is set appropriately.
 894  *
 895  * Note: the return value of this function is not an indicator that this
 896  * instance is or is not the primary instance of the application.  See
 897  * g_application_get_is_remote() for that.
 898  *
 899  * Since: 2.28
 900  **/
 901 gboolean
 902 g_application_register (GApplication  *application,
 903                         GCancellable  *cancellable,
 904                         GError       **error)
 905 {
 906   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
 907
 908   if (!application->priv->is_registered)
 909     {
 910       application->priv->impl =
 911         g_application_impl_register (application, application->priv->id,
 912                                      application->priv->flags,
 913                                      &application->priv->remote_actions,
 914                                      cancellable, error);
 915
 916       if (application->priv->impl == NULL)
 917         return FALSE;
 918
 919       application->priv->is_remote = application->priv->remote_actions != NULL;
 920       application->priv->is_registered = TRUE;
 921
 922       g_object_notify (G_OBJECT (application), "is-registered");
 923
 924       if (!application->priv->is_remote)
 925         g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
 926     }
 927
 928   return TRUE;
 929 }
 930
 931 /* Hold/release {{{1 */
 932 /**
 933  * g_application_hold:
 934  * @application: a #GApplication
 935  *
 936  * Increases the use count of @application.
 937  *
 938  * Use this function to indicate that the application has a reason to
 939  * continue to run.  For example, g_application_hold() is called by GTK+
 940  * when a toplevel window is on the screen.
 941  *
 942  * To cancel the hold, call g_application_release().
 943  **/
 944 void
 945 g_application_hold (GApplication *application)
 946 {
 947   if (application->priv->inactivity_timeout_id)
 948     {
 949       g_source_remove (application->priv->inactivity_timeout_id);
 950       application->priv->inactivity_timeout_id = 0;
 951     }
 952
 953   application->priv->use_count++;
 954 }
 955
 956 static gboolean
 957 inactivity_timeout_expired (gpointer data)
 958 {
 959   GApplication *application = G_APPLICATION (data);
 960
 961   G_APPLICATION_GET_CLASS (application)
 962     ->quit_mainloop (application);
 963
 964   return FALSE;
 965 }
 966
 967
 968 /**
 969  * g_application_release:
 970  * @application: a #GApplication
 971  *
 972  * Decrease the use count of @application.
 973  *
 974  * When the use count reaches zero, the application will stop running.
 975  *
 976  * Never call this function except to cancel the effect of a previous
 977  * call to g_application_hold().
 978  **/
 979 void
 980 g_application_release (GApplication *application)
 981 {
 982   application->priv->use_count--;
 983
 984   if (application->priv->use_count == 0)
 985     {
 986       if (application->priv->inactivity_timeout)
 987         application->priv->inactivity_timeout_id =
 988           g_timeout_add (application->priv->inactivity_timeout,
 989                          inactivity_timeout_expired, application);
 990
 991       else
 992         G_APPLICATION_GET_CLASS (application)
 993           ->quit_mainloop (application);
 994     }
 995 }
 996
 997 /* Activate, Open {{{1 */
 998 /**
 999  * g_application_activate:
1000  * @application: a #GApplication
1001  *
1002  * Activates the application.
1003  *
1004  * In essence, this results in the #GApplication::activate() signal being
1005  * emitted in the primary instance.
1006  *
1007  * The application must be registered before calling this function.
1008  *
1009  * Since: 2.28
1010  **/
1011 void
1012 g_application_activate (GApplication *application)
1013 {
1014   g_return_if_fail (G_IS_APPLICATION (application));
1015   g_return_if_fail (application->priv->is_registered);
1016
1017   if (application->priv->is_remote)
1018     g_application_impl_activate (application->priv->impl,
1019                                  get_platform_data (application));
1020
1021   else
1022     g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1023 }
1024
1025 /**
1026  * g_application_open:
1027  * @application: a #GApplication
1028  * @files: an array of #GFiles to open
1029  * @n_files: the length of the @files array
1030  * @hint: a hint (or ""), but never %NULL
1031  *
1032  * Opens the given files.
1033  *
1034  * In essence, this results in the #GApplication::open signal being emitted
1035  * in the primary instance.
1036  *
1037  * @n_files must be greater than zero.
1038  *
1039  * @hint is simply passed through to the ::open signal.  It is
1040  * intended to be used by applications that have multiple modes for
1041  * opening files (eg: "view" vs "edit", etc).  Unless you have a need
1042  * for this functionality, you should use "".
1043  *
1044  * The application must be registered before calling this function
1045  * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1046  *
1047  * Since: 2.28
1048  **/
1049 void
1050 g_application_open (GApplication  *application,
1051                     GFile        **files,
1052                     gint           n_files,
1053                     const gchar   *hint)
1054 {
1055   g_return_if_fail (G_IS_APPLICATION (application));
1056   g_return_if_fail (application->priv->flags &
1057                     G_APPLICATION_HANDLES_OPEN);
1058   g_return_if_fail (application->priv->is_registered);
1059
1060   if (application->priv->is_remote)
1061     g_application_impl_open (application->priv->impl,
1062                              files, n_files, hint,
1063                              get_platform_data (application));
1064
1065   else
1066     g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1067                    0, files, n_files, hint);
1068 }
1069
1070 /* Run {{{1 */
1071 /**
1072  * g_application_run:
1073  * @application: a #GApplication
1074  * @argc: the argc from main()
1075  * @argv: the argv from main()
1076  * @returns: the exit status
1077  *
1078  * Runs the application.
1079  *
1080  * This function is intended to be run from main() and its return value
1081  * is intended to be returned by main().
1082  *
1083  * First, the local_command_line() virtual function is invoked.  This
1084  * function always runs on the local instance.  If that function returns
1085  * %FALSE then the application is registered and the #GApplication::command-line
1086  * signal is emitted in the primary instance (which may or may not be
1087  * this instance).
1088  *
1089  * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1090  * flag set then the default implementation of local_command_line()
1091  * always returns %FALSE immediately, resulting in the commandline
1092  * always being handled in the primary instance.
1093  *
1094  * Otherwise, the default implementation of local_command_line() tries
1095  * to do a couple of things that are probably reasonable for most
1096  * applications.  First, g_application_register() is called to attempt
1097  * to register the application.  If that works, then the command line
1098  * arguments are inspected.  If no commandline arguments are given, then
1099  * g_application_activate() is called.  If commandline arguments are
1100  * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1101  * are assumed to be filenames and g_application_open() is called.
1102  *
1103  * If you are interested in doing more complicated local handling of the
1104  * commandline then you should implement your own #GApplication subclass
1105  * and override local_command_line(). See
1106  * <xref linkend="gapplication-example-cmdline2"/> for an example.
1107  *
1108  * If, after the above is done, the use count of the application is zero
1109  * then the exit status is returned immediately.  If the use count is
1110  * non-zero then the mainloop is run until the use count falls to zero,
1111  * at which point 0 is returned.
1112  *
1113  * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1114  * use count of zero is delayed for a while (ie: the instance stays
1115  * around to provide its <emphasis>service</emphasis> to others).
1116  *
1117  * Since: 2.28
1118  **/
1119 int
1120 g_application_run (GApplication  *application,
1121                    int            argc,
1122                    char         **argv)
1123 {
1124   gchar **arguments;
1125   int status;
1126   gint i;
1127
1128   g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1129   g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1130
1131   arguments = g_new (gchar *, argc + 1);
1132   for (i = 0; i < argc; i++)
1133     arguments[i] = g_strdup (argv[i]);
1134   arguments[i] = NULL;
1135
1136   if (g_get_prgname () == NULL && argc > 0)
1137     {
1138       gchar *prgname;
1139
1140       prgname = g_path_get_basename (argv[0]);
1141       g_set_prgname (prgname);
1142       g_free (prgname);
1143     }
1144
1145   if (!G_APPLICATION_GET_CLASS (application)
1146         ->local_command_line (application, &arguments, &status))
1147     {
1148       GError *error = NULL;
1149
1150       if (!g_application_register (application, NULL, &error))
1151         {
1152           g_printerr ("%s", error->message);
1153           g_error_free (error);
1154           return 1;
1155         }
1156
1157       if (application->priv->is_remote)
1158         {
1159           GVariant *platform_data;
1160
1161           platform_data = get_platform_data (application);
1162           status = g_application_impl_command_line (application->priv->impl,
1163                                                     arguments, platform_data);
1164         }
1165       else
1166         {
1167           GApplicationCommandLine *cmdline;
1168           GVariant *v;
1169
1170           v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1171           cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1172                                   "arguments", v, NULL);
1173           g_signal_emit (application,
1174                          g_application_signals[SIGNAL_COMMAND_LINE],
1175                          0, cmdline, &status);
1176           g_object_unref (cmdline);
1177         }
1178     }
1179
1180   g_strfreev (arguments);
1181
1182   if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1183       application->priv->is_registered &&
1184       !application->priv->use_count &&
1185       !application->priv->inactivity_timeout_id)
1186     {
1187       application->priv->inactivity_timeout_id =
1188         g_timeout_add (10000, inactivity_timeout_expired, application);
1189     }
1190
1191   if (application->priv->use_count ||
1192       application->priv->inactivity_timeout_id)
1193     {
1194       G_APPLICATION_GET_CLASS (application)
1195         ->run_mainloop (application);
1196       status = 0;
1197     }
1198
1199   if (application->priv->impl)
1200     g_application_impl_flush (application->priv->impl);
1201
1202   return status;
1203 }
1204
1205 static gboolean
1206 g_application_has_action (GActionGroup *action_group,
1207                           const gchar  *action_name)
1208 {
1209   GApplication *application = G_APPLICATION (action_group);
1210
1211   g_return_val_if_fail (application->priv->is_registered, FALSE);
1212
1213   if (application->priv->remote_actions != NULL)
1214     return g_hash_table_lookup (application->priv->remote_actions,
1215                                 action_name) != NULL;
1216
1217   return application->priv->actions &&
1218          g_action_group_has_action (application->priv->actions, action_name);
1219 }
1220
1221 static gchar **
1222 g_application_list_actions (GActionGroup *action_group)
1223 {
1224   GApplication *application = G_APPLICATION (action_group);
1225
1226   g_return_val_if_fail (application->priv->is_registered, NULL);
1227
1228   if (application->priv->remote_actions != NULL)
1229     {
1230       GHashTableIter iter;
1231       gint n, i = 0;
1232       gchar **keys;
1233       gpointer key;
1234
1235       n = g_hash_table_size (application->priv->remote_actions);
1236       keys = g_new (gchar *, n + 1);
1237
1238       g_hash_table_iter_init (&iter, application->priv->remote_actions);
1239       while (g_hash_table_iter_next (&iter, &key, NULL))
1240         keys[i++] = g_strdup (key);
1241       g_assert_cmpint (i, ==, n);
1242       keys[n] = NULL;
1243
1244       return keys;
1245     }
1246
1247   else if (application->priv->actions != NULL)
1248     return g_action_group_list_actions (application->priv->actions);
1249
1250   else
1251     /* empty string array */
1252     return g_new0 (gchar *, 1);
1253 }
1254
1255 static gboolean
1256 g_application_get_action_enabled (GActionGroup *action_group,
1257                                   const gchar  *action_name)
1258 {
1259   GApplication *application = G_APPLICATION (action_group);
1260
1261   g_return_val_if_fail (application->priv->actions != NULL, FALSE);
1262   g_return_val_if_fail (application->priv->is_registered, FALSE);
1263
1264   if (application->priv->remote_actions)
1265     {
1266       RemoteActionInfo *info;
1267
1268       info = g_hash_table_lookup (application->priv->remote_actions,
1269                                   action_name);
1270
1271       return info && info->enabled;
1272     }
1273
1274   return g_action_group_get_action_enabled (application->priv->actions,
1275                                             action_name);
1276 }
1277
1278 static const GVariantType *
1279 g_application_get_action_parameter_type (GActionGroup *action_group,
1280                                          const gchar  *action_name)
1281 {
1282   GApplication *application = G_APPLICATION (action_group);
1283
1284   g_return_val_if_fail (application->priv->actions != NULL, NULL);
1285   g_return_val_if_fail (application->priv->is_registered, NULL);
1286
1287   if (application->priv->remote_actions)
1288     {
1289       RemoteActionInfo *info;
1290
1291       info = g_hash_table_lookup (application->priv->remote_actions,
1292                                   action_name);
1293
1294       if (info)
1295         return info->parameter_type;
1296       else
1297         return NULL;
1298     }
1299
1300   return g_action_group_get_action_parameter_type (application->priv->actions,
1301                                                    action_name);
1302 }
1303
1304 static const GVariantType *
1305 g_application_get_action_state_type (GActionGroup *action_group,
1306                                      const gchar  *action_name)
1307 {
1308   GApplication *application = G_APPLICATION (action_group);
1309
1310   g_return_val_if_fail (application->priv->actions != NULL, NULL);
1311   g_return_val_if_fail (application->priv->is_registered, NULL);
1312
1313   if (application->priv->remote_actions)
1314     {
1315       RemoteActionInfo *info;
1316
1317       info = g_hash_table_lookup (application->priv->remote_actions,
1318                                   action_name);
1319
1320       if (info && info->state)
1321         return g_variant_get_type (info->state);
1322       else
1323         return NULL;
1324     }
1325
1326   return g_action_group_get_action_state_type (application->priv->actions,
1327                                                action_name);
1328 }
1329
1330 static GVariant *
1331 g_application_get_action_state (GActionGroup *action_group,
1332                                 const gchar  *action_name)
1333 {
1334   GApplication *application = G_APPLICATION (action_group);
1335
1336   g_return_val_if_fail (application->priv->actions != NULL, NULL);
1337   g_return_val_if_fail (application->priv->is_registered, NULL);
1338
1339   if (application->priv->remote_actions)
1340     {
1341       RemoteActionInfo *info;
1342
1343       info = g_hash_table_lookup (application->priv->remote_actions,
1344                                   action_name);
1345
1346       if (info && info->state)
1347         return g_variant_ref (info->state);
1348       else
1349         return NULL;
1350     }
1351
1352   return g_action_group_get_action_state (application->priv->actions,
1353                                           action_name);
1354 }
1355
1356 static void
1357 g_application_change_action_state (GActionGroup *action_group,
1358                                    const gchar  *action_name,
1359                                    GVariant     *value)
1360 {
1361   GApplication *application = G_APPLICATION (action_group);
1362
1363   g_return_if_fail (application->priv->is_registered);
1364
1365   if (application->priv->is_remote)
1366     g_application_impl_change_action_state (application->priv->impl,
1367                                             action_name, value,
1368                                             get_platform_data (application));
1369
1370   else
1371     g_action_group_change_action_state (application->priv->actions,
1372                                         action_name, value);
1373 }
1374
1375 static void
1376 g_application_activate_action (GActionGroup *action_group,
1377                                const gchar  *action_name,
1378                                GVariant     *parameter)
1379 {
1380   GApplication *application = G_APPLICATION (action_group);
1381
1382   g_return_if_fail (application->priv->is_registered);
1383
1384   if (application->priv->is_remote)
1385     g_application_impl_activate_action (application->priv->impl,
1386                                         action_name, parameter,
1387                                         get_platform_data (application));
1388
1389   else
1390     g_action_group_activate_action (application->priv->actions,
1391                                     action_name, parameter);
1392 }
1393
1394 static void
1395 g_application_action_group_iface_init (GActionGroupInterface *iface)
1396 {
1397   iface->has_action = g_application_has_action;
1398   iface->list_actions = g_application_list_actions;
1399
1400   iface->get_action_enabled = g_application_get_action_enabled;
1401   iface->get_action_parameter_type = g_application_get_action_parameter_type;
1402   iface->get_action_state_type = g_application_get_action_state_type;
1403   iface->get_action_state = g_application_get_action_state;
1404   iface->change_action_state = g_application_change_action_state;
1405   iface->activate_action = g_application_activate_action;
1406 }
1407
1408 /* Epilogue {{{1 */
1409 /* vim:set foldmethod=marker: */