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 (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   G_APPLICATION_GET_CLASS (application)->
 575     add_platform_data (application, builder);
 576
 577   result = g_variant_builder_end (builder);
 578   g_variant_builder_unref (builder);
 579
 580   return result;
 581 }
 582
 583 /* Application ID validity {{{1 */
 584
 585 /**
 586  * g_application_id_is_valid:
 587  * @application_id: a potential application identifier
 588  * @returns: %TRUE if @application_id is valid
 589  *
 590  * Checks if @application_id is a valid application identifier.
 591  *
 592  * A valid ID is required for calls to g_application_new() and
 593  * g_application_set_application_id().
 594  *
 595  * For convenience, the restrictions on application identifiers are
 596  * reproduced here:
 597  * <itemizedlist>
 598  *   <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-" and must not begin with a digit.</listitem>
 599  *   <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least two elements).</listitem>
 600  *   <listitem>Application identifiers must not begin with a '.' (period) character.</listitem>
 601  *   <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
 602  *   <listitem>Application identifiers must not exceed 255 characters.</listitem>
 603  * </itemizedlist>
 604  **/
 605 gboolean
 606 g_application_id_is_valid (const gchar *application_id)
 607 {
 608   gboolean allow_dot;
 609
 610   if (strlen (application_id) > 255)
 611     return FALSE;
 612
 613   if (!g_ascii_isalpha (*application_id))
 614     return FALSE;
 615
 616   application_id++;
 617   allow_dot = FALSE;
 618   for (; *application_id; application_id++)
 619     {
 620       if (g_ascii_isalnum (*application_id) ||
 621           (*application_id == '-') ||
 622           (*application_id == '_'))
 623         allow_dot = TRUE;
 624       else if (allow_dot && *application_id == '.')
 625         allow_dot = FALSE;
 626       else
 627         return FALSE;
 628     }
 629
 630   return TRUE;
 631 }
 632
 633 /* Public Constructor {{{1 */
 634 /**
 635  * g_application_new:
 636  * @application_id: the application id
 637  * @flags: the application flags
 638  * @returns: a new #GApplication instance
 639  *
 640  * Creates a new #GApplication instance.
 641  *
 642  * This function calls g_type_init() for you.
 643  *
 644  * The application id must be valid.  See g_application_id_is_valid().
 645  **/
 646 GApplication *
 647 g_application_new (const gchar       *application_id,
 648                    GApplicationFlags  flags)
 649 {
 650   g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
 651
 652   g_type_init ();
 653
 654   return g_object_new (G_TYPE_APPLICATION,
 655                        "application-id", application_id,
 656                        "flags", flags,
 657                        NULL);
 658 }
 659
 660 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
 661 /**
 662  * g_application_get_application_id:
 663  * @application: a #GApplication
 664  * @returns: the identifier for @application, owned by @application
 665  *
 666  * Gets the unique identifier for @application.
 667  *
 668  * Since: 2.28
 669  **/
 670 const gchar *
 671 g_application_get_application_id (GApplication *application)
 672 {
 673   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
 674
 675   return application->priv->id;
 676 }
 677
 678 /**
 679  * g_application_set_application_id:
 680  * @application: a #GApplication
 681  * @application_id: the identifier for @application
 682  *
 683  * Sets the unique identifier for @application.
 684  *
 685  * The application id can only be modified if @application has not yet
 686  * been registered.
 687  *
 688  * The application id must be valid.  See g_application_id_is_valid().
 689  *
 690  * Since: 2.28
 691  **/
 692 void
 693 g_application_set_application_id (GApplication *application,
 694                                   const gchar  *application_id)
 695 {
 696   g_return_if_fail (G_IS_APPLICATION (application));
 697
 698   if (g_strcmp0 (application->priv->id, application_id) != 0)
 699     {
 700       g_return_if_fail (g_application_id_is_valid (application_id));
 701       g_return_if_fail (!application->priv->is_registered);
 702
 703       g_free (application->priv->id);
 704       application->priv->id = g_strdup (application_id);
 705
 706       g_object_notify (G_OBJECT (application), "application-id");
 707     }
 708 }
 709
 710 /**
 711  * g_application_get_flags:
 712  * @application: a #GApplication
 713  * @returns: the flags for @application
 714  *
 715  * Gets the flags for @application.
 716  *
 717  * See #GApplicationFlags.
 718  *
 719  * Since: 2.28
 720  **/
 721 GApplicationFlags
 722 g_application_get_flags (GApplication *application)
 723 {
 724   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
 725
 726   return application->priv->flags;
 727 }
 728
 729 /**
 730  * g_application_set_flags:
 731  * @application: a #GApplication
 732  * @flags: the flags for @application
 733  *
 734  * Sets the flags for @application.
 735  *
 736  * The flags can only be modified if @application has not yet been
 737  * registered.
 738  *
 739  * See #GApplicationFlags.
 740  *
 741  * Since: 2.28
 742  **/
 743 void
 744 g_application_set_flags (GApplication      *application,
 745                          GApplicationFlags  flags)
 746 {
 747   g_return_if_fail (G_IS_APPLICATION (application));
 748
 749   if (application->priv->flags != flags)
 750     {
 751       g_return_if_fail (!application->priv->is_registered);
 752
 753       application->priv->flags = flags;
 754
 755       g_object_notify (G_OBJECT (application), "flags");
 756     }
 757 }
 758
 759 /**
 760  * g_application_get_inactivity_timeout:
 761  * @application: a #GApplication
 762  *
 763  * Gets the current inactivity timeout for the application.
 764  *
 765  * This is the amount of time (in milliseconds) after the last call to
 766  * g_application_release() before the application stops running.
 767  *
 768  * Returns: the timeout, in milliseconds
 769  *
 770  * Since: 2.28
 771  **/
 772 guint
 773 g_application_get_inactivity_timeout (GApplication *application)
 774 {
 775   g_return_val_if_fail (G_IS_APPLICATION (application), 0);
 776
 777   return application->priv->inactivity_timeout;
 778 }
 779
 780 /**
 781  * g_application_set_inactivity_timeout:
 782  * @application: a #GApplication
 783  * @inactivity_timeout: the timeout, in milliseconds
 784  *
 785  * Sets the current inactivity timeout for the application.
 786  *
 787  * This is the amount of time (in milliseconds) after the last call to
 788  * g_application_release() before the application stops running.
 789  *
 790  * This call has no side effects of its own.  The value set here is only
 791  * used for next time g_application_release() drops the use count to
 792  * zero.  Any timeouts currently in progress are not impacted.
 793  *
 794  * Returns: the timeout, in milliseconds
 795  *
 796  * Since: 2.28
 797  **/
 798 void
 799 g_application_set_inactivity_timeout (GApplication *application,
 800                                       guint         inactivity_timeout)
 801 {
 802   g_return_if_fail (G_IS_APPLICATION (application));
 803
 804   if (application->priv->inactivity_timeout != inactivity_timeout)
 805     {
 806       application->priv->inactivity_timeout = inactivity_timeout;
 807
 808       g_object_notify (G_OBJECT (application), "inactivity-timeout");
 809     }
 810 }
 811 /* Read-only property getters (is registered, is remote) {{{1 */
 812 /**
 813  * g_application_get_is_registered:
 814  * @application: a #GApplication
 815  * @returns: %TRUE if @application is registered
 816  *
 817  * Checks if @application is registered.
 818  *
 819  * An application is registered if g_application_register() has been
 820  * successfully called.
 821  *
 822  * Since: 2.28
 823  **/
 824 gboolean
 825 g_application_get_is_registered (GApplication *application)
 826 {
 827   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
 828
 829   return application->priv->is_registered;
 830 }
 831
 832 /**
 833  * g_application_get_is_remote:
 834  * @application: a #GApplication
 835  * @returns: %TRUE if @application is remote
 836  *
 837  * Checks if @application is remote.
 838  *
 839  * If @application is remote then it means that another instance of
 840  * application already exists (the 'primary' instance).  Calls to
 841  * perform actions on @application will result in the actions being
 842  * performed by the primary instance.
 843  *
 844  * The value of this property can not be accessed before
 845  * g_application_register() has been called.  See
 846  * g_application_get_is_registered().
 847  *
 848  * Since: 2.28
 849  **/
 850 gboolean
 851 g_application_get_is_remote (GApplication *application)
 852 {
 853   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
 854   g_return_val_if_fail (application->priv->is_registered, FALSE);
 855
 856   return application->priv->is_remote;
 857 }
 858
 859 /* Register {{{1 */
 860 /**
 861  * g_application_register:
 862  * @application: a #GApplication
 863  * @cancellable: a #GCancellable, or %NULL
 864  * @error: a pointer to a NULL #GError, or %NULL
 865  * @returns: %TRUE if registration succeeded
 866  *
 867  * Attempts registration of the application.
 868  *
 869  * This is the point at which the application discovers if it is the
 870  * primary instance or merely acting as a remote for an already-existing
 871  * primary instance.
 872  *
 873  * If the application has already been registered then %TRUE is
 874  * returned with no work performed.
 875  *
 876  * The #GApplication::startup signal is emitted if registration succeeds
 877  * and @application is the primary instance.
 878  *
 879  * In the event of an error (such as @cancellable being cancelled, or a
 880  * failure to connect to the session bus), %FALSE is returned and @error
 881  * is set appropriately.
 882  *
 883  * Note: the return value of this function is not an indicator that this
 884  * instance is or is not the primary instance of the application.  See
 885  * g_application_get_is_remote() for that.
 886  *
 887  * Since: 2.28
 888  **/
 889 gboolean
 890 g_application_register (GApplication  *application,
 891                         GCancellable  *cancellable,
 892                         GError       **error)
 893 {
 894   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
 895
 896   if (!application->priv->is_registered)
 897     {
 898       application->priv->impl =
 899         g_application_impl_register (application, application->priv->id,
 900                                      application->priv->flags,
 901                                      &application->priv->remote_actions,
 902                                      cancellable, error);
 903
 904       if (application->priv->impl == NULL)
 905         return FALSE;
 906
 907       application->priv->is_remote = application->priv->remote_actions != NULL;
 908       application->priv->is_registered = TRUE;
 909
 910       g_object_notify (G_OBJECT (application), "is-registered");
 911
 912       if (!application->priv->is_remote)
 913         g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
 914     }
 915
 916   return TRUE;
 917 }
 918
 919 /* Hold/release {{{1 */
 920 /**
 921  * g_application_hold:
 922  * @application: a #GApplication
 923  *
 924  * Increases the use count of @application.
 925  *
 926  * Use this function to indicate that the application has a reason to
 927  * continue to run.  For example, g_application_hold() is called by GTK+
 928  * when a toplevel window is on the screen.
 929  *
 930  * To cancel the hold, call g_application_release().
 931  **/
 932 void
 933 g_application_hold (GApplication *application)
 934 {
 935   if (application->priv->inactivity_timeout_id)
 936     {
 937       g_source_remove (application->priv->inactivity_timeout_id);
 938       application->priv->inactivity_timeout_id = 0;
 939     }
 940
 941   application->priv->use_count++;
 942 }
 943
 944 static gboolean
 945 inactivity_timeout_expired (gpointer data)
 946 {
 947   GApplication *application = G_APPLICATION (data);
 948
 949   G_APPLICATION_GET_CLASS (application)
 950     ->quit_mainloop (application);
 951
 952   return FALSE;
 953 }
 954
 955
 956 /**
 957  * g_application_release:
 958  * @application: a #GApplication
 959  *
 960  * Decrease the use count of @application.
 961  *
 962  * When the use count reaches zero, the application will stop running.
 963  *
 964  * Never call this function except to cancel the effect of a previous
 965  * call to g_application_hold().
 966  **/
 967 void
 968 g_application_release (GApplication *application)
 969 {
 970   application->priv->use_count--;
 971
 972   if (application->priv->use_count == 0)
 973     {
 974       if (application->priv->inactivity_timeout)
 975         application->priv->inactivity_timeout_id =
 976           g_timeout_add (application->priv->inactivity_timeout,
 977                          inactivity_timeout_expired, application);
 978
 979       else
 980         G_APPLICATION_GET_CLASS (application)
 981           ->quit_mainloop (application);
 982     }
 983 }
 984
 985 /* Activate, Open {{{1 */
 986 /**
 987  * g_application_activate:
 988  * @application: a #GApplication
 989  *
 990  * Activates the application.
 991  *
 992  * In essence, this results in the #GApplication::activate() signal being
 993  * emitted in the primary instance.
 994  *
 995  * The application must be registered before calling this function.
 996  *
 997  * Since: 2.28
 998  **/
 999 void
1000 g_application_activate (GApplication *application)
1001 {
1002   g_return_if_fail (G_IS_APPLICATION (application));
1003   g_return_if_fail (application->priv->is_registered);
1004
1005   if (application->priv->is_remote)
1006     g_application_impl_activate (application->priv->impl,
1007                                  get_platform_data (application));
1008
1009   else
1010     g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1011 }
1012
1013 /**
1014  * g_application_open:
1015  * @application: a #GApplication
1016  * @files: an array of #GFiles to open
1017  * @n_files: the length of the @files array
1018  * @hint: a hint (or ""), but never %NULL
1019  *
1020  * Opens the given files.
1021  *
1022  * In essence, this results in the #GApplication::open signal being emitted
1023  * in the primary instance.
1024  *
1025  * @n_files must be greater than zero.
1026  *
1027  * @hint is simply passed through to the ::open signal.  It is
1028  * intended to be used by applications that have multiple modes for
1029  * opening files (eg: "view" vs "edit", etc).  Unless you have a need
1030  * for this functionality, you should use "".
1031  *
1032  * The application must be registered before calling this function
1033  * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1034  *
1035  * Since: 2.28
1036  **/
1037 void
1038 g_application_open (GApplication  *application,
1039                     GFile        **files,
1040                     gint           n_files,
1041                     const gchar   *hint)
1042 {
1043   g_return_if_fail (G_IS_APPLICATION (application));
1044   g_return_if_fail (application->priv->flags &
1045                     G_APPLICATION_HANDLES_OPEN);
1046   g_return_if_fail (application->priv->is_registered);
1047
1048   if (application->priv->is_remote)
1049     g_application_impl_open (application->priv->impl,
1050                              files, n_files, hint,
1051                              get_platform_data (application));
1052
1053   else
1054     g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1055                    0, files, n_files, hint);
1056 }
1057
1058 /* Run {{{1 */
1059 /**
1060  * g_application_run:
1061  * @application: a #GApplication
1062  * @argc: the argc from main()
1063  * @argv: the argv from main()
1064  * @returns: the exit status
1065  *
1066  * Runs the application.
1067  *
1068  * This function is intended to be run from main() and its return value
1069  * is intended to be returned by main().
1070  *
1071  * First, the local_command_line() virtual function is invoked.  This
1072  * function always runs on the local instance.  If that function returns
1073  * %FALSE then the application is registered and the #GApplication::command-line
1074  * signal is emitted in the primary instance (which may or may not be
1075  * this instance).
1076  *
1077  * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1078  * flag set then the default implementation of local_command_line()
1079  * always returns %FALSE immediately, resulting in the commandline
1080  * always being handled in the primary instance.
1081  *
1082  * Otherwise, the default implementation of local_command_line() tries
1083  * to do a couple of things that are probably reasonable for most
1084  * applications.  First, g_application_register() is called to attempt
1085  * to register the application.  If that works, then the command line
1086  * arguments are inspected.  If no commandline arguments are given, then
1087  * g_application_activate() is called.  If commandline arguments are
1088  * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1089  * are assumed to be filenames and g_application_open() is called.
1090  *
1091  * If you are interested in doing more complicated local handling of the
1092  * commandline then you should implement your own #GApplication subclass
1093  * and override local_command_line(). See
1094  * <xref linkend="gapplication-example-cmdline2"/> for an example.
1095  *
1096  * If, after the above is done, the use count of the application is zero
1097  * then the exit status is returned immediately.  If the use count is
1098  * non-zero then the mainloop is run until the use count falls to zero,
1099  * at which point 0 is returned.
1100  *
1101  * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1102  * use count of zero is delayed for a while (ie: the instance stays
1103  * around to provide its <emphasis>service</emphasis> to others).
1104  *
1105  * Since: 2.28
1106  **/
1107 int
1108 g_application_run (GApplication  *application,
1109                    int            argc,
1110                    char         **argv)
1111 {
1112   gchar **arguments;
1113   int status;
1114   gint i;
1115
1116   g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1117   g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1118
1119   arguments = g_new (gchar *, argc + 1);
1120   for (i = 0; i < argc; i++)
1121     arguments[i] = g_strdup (argv[i]);
1122   arguments[i] = NULL;
1123
1124   if (g_get_prgname () == NULL && argc > 0)
1125     {
1126       gchar *prgname;
1127
1128       prgname = g_path_get_basename (argv[0]);
1129       g_set_prgname (prgname);
1130       g_free (prgname);
1131     }
1132
1133   if (!G_APPLICATION_GET_CLASS (application)
1134         ->local_command_line (application, &arguments, &status))
1135     {
1136       GError *error = NULL;
1137
1138       if (!g_application_register (application, NULL, &error))
1139         {
1140           g_printerr ("%s", error->message);
1141           g_error_free (error);
1142           return 1;
1143         }
1144
1145       if (application->priv->is_remote)
1146         {
1147           GVariant *platform_data;
1148
1149           platform_data = get_platform_data (application);
1150           status = g_application_impl_command_line (application->priv->impl,
1151                                                     arguments, platform_data);
1152         }
1153       else
1154         {
1155           GApplicationCommandLine *cmdline;
1156           GVariant *v;
1157
1158           v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1159           cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1160                                   "arguments", v, NULL);
1161           g_signal_emit (application,
1162                          g_application_signals[SIGNAL_COMMAND_LINE],
1163                          0, cmdline, &status);
1164           g_object_unref (cmdline);
1165         }
1166     }
1167
1168   g_strfreev (arguments);
1169
1170   if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1171       application->priv->is_registered &&
1172       !application->priv->use_count &&
1173       !application->priv->inactivity_timeout_id)
1174     {
1175       application->priv->inactivity_timeout_id =
1176         g_timeout_add (10000, inactivity_timeout_expired, application);
1177     }
1178
1179   if (application->priv->use_count ||
1180       application->priv->inactivity_timeout_id)
1181     {
1182       G_APPLICATION_GET_CLASS (application)
1183         ->run_mainloop (application);
1184       status = 0;
1185     }
1186
1187   if (application->priv->impl)
1188     g_application_impl_flush (application->priv->impl);
1189
1190   return status;
1191 }
1192
1193 static gboolean
1194 g_application_has_action (GActionGroup *action_group,
1195                           const gchar  *action_name)
1196 {
1197   GApplication *application = G_APPLICATION (action_group);
1198
1199   g_return_val_if_fail (application->priv->is_registered, FALSE);
1200
1201   if (application->priv->remote_actions != NULL)
1202     return g_hash_table_lookup (application->priv->remote_actions,
1203                                 action_name) != NULL;
1204
1205   return application->priv->actions &&
1206          g_action_group_has_action (application->priv->actions, action_name);
1207 }
1208
1209 static gchar **
1210 g_application_list_actions (GActionGroup *action_group)
1211 {
1212   GApplication *application = G_APPLICATION (action_group);
1213
1214   g_return_val_if_fail (application->priv->is_registered, NULL);
1215
1216   if (application->priv->remote_actions != NULL)
1217     {
1218       GHashTableIter iter;
1219       gint n, i = 0;
1220       gchar **keys;
1221       gpointer key;
1222
1223       n = g_hash_table_size (application->priv->remote_actions);
1224       keys = g_new (gchar *, n + 1);
1225
1226       g_hash_table_iter_init (&iter, application->priv->remote_actions);
1227       while (g_hash_table_iter_next (&iter, &key, NULL))
1228         keys[i++] = g_strdup (key);
1229       g_assert_cmpint (i, ==, n);
1230       keys[n] = NULL;
1231
1232       return keys;
1233     }
1234
1235   else if (application->priv->actions != NULL)
1236     return g_action_group_list_actions (application->priv->actions);
1237
1238   else
1239     /* empty string array */
1240     return g_new0 (gchar *, 1);
1241 }
1242
1243 static gboolean
1244 g_application_get_action_enabled (GActionGroup *action_group,
1245                                   const gchar  *action_name)
1246 {
1247   GApplication *application = G_APPLICATION (action_group);
1248
1249   g_return_val_if_fail (application->priv->actions != NULL, FALSE);
1250   g_return_val_if_fail (application->priv->is_registered, FALSE);
1251
1252   if (application->priv->remote_actions)
1253     {
1254       RemoteActionInfo *info;
1255
1256       info = g_hash_table_lookup (application->priv->remote_actions,
1257                                   action_name);
1258
1259       return info && info->enabled;
1260     }
1261
1262   return g_action_group_get_action_enabled (application->priv->actions,
1263                                             action_name);
1264 }
1265
1266 static const GVariantType *
1267 g_application_get_action_parameter_type (GActionGroup *action_group,
1268                                          const gchar  *action_name)
1269 {
1270   GApplication *application = G_APPLICATION (action_group);
1271
1272   g_return_val_if_fail (application->priv->actions != NULL, NULL);
1273   g_return_val_if_fail (application->priv->is_registered, NULL);
1274
1275   if (application->priv->remote_actions)
1276     {
1277       RemoteActionInfo *info;
1278
1279       info = g_hash_table_lookup (application->priv->remote_actions,
1280                                   action_name);
1281
1282       if (info)
1283         return info->parameter_type;
1284       else
1285         return NULL;
1286     }
1287
1288   return g_action_group_get_action_parameter_type (application->priv->actions,
1289                                                    action_name);
1290 }
1291
1292 static const GVariantType *
1293 g_application_get_action_state_type (GActionGroup *action_group,
1294                                      const gchar  *action_name)
1295 {
1296   GApplication *application = G_APPLICATION (action_group);
1297
1298   g_return_val_if_fail (application->priv->actions != NULL, NULL);
1299   g_return_val_if_fail (application->priv->is_registered, NULL);
1300
1301   if (application->priv->remote_actions)
1302     {
1303       RemoteActionInfo *info;
1304
1305       info = g_hash_table_lookup (application->priv->remote_actions,
1306                                   action_name);
1307
1308       if (info && info->state)
1309         return g_variant_get_type (info->state);
1310       else
1311         return NULL;
1312     }
1313
1314   return g_action_group_get_action_state_type (application->priv->actions,
1315                                                action_name);
1316 }
1317
1318 static GVariant *
1319 g_application_get_action_state (GActionGroup *action_group,
1320                                 const gchar  *action_name)
1321 {
1322   GApplication *application = G_APPLICATION (action_group);
1323
1324   g_return_val_if_fail (application->priv->actions != NULL, NULL);
1325   g_return_val_if_fail (application->priv->is_registered, NULL);
1326
1327   if (application->priv->remote_actions)
1328     {
1329       RemoteActionInfo *info;
1330
1331       info = g_hash_table_lookup (application->priv->remote_actions,
1332                                   action_name);
1333
1334       if (info && info->state)
1335         return g_variant_ref (info->state);
1336       else
1337         return NULL;
1338     }
1339
1340   return g_action_group_get_action_state (application->priv->actions,
1341                                           action_name);
1342 }
1343
1344 static void
1345 g_application_change_action_state (GActionGroup *action_group,
1346                                    const gchar  *action_name,
1347                                    GVariant     *value)
1348 {
1349   GApplication *application = G_APPLICATION (action_group);
1350
1351   g_return_if_fail (application->priv->is_registered);
1352
1353   if (application->priv->is_remote)
1354     g_application_impl_change_action_state (application->priv->impl,
1355                                             action_name, value,
1356                                             get_platform_data (application));
1357
1358   else
1359     g_action_group_change_action_state (application->priv->actions,
1360                                         action_name, value);
1361 }
1362
1363 static void
1364 g_application_activate_action (GActionGroup *action_group,
1365                                const gchar  *action_name,
1366                                GVariant     *parameter)
1367 {
1368   GApplication *application = G_APPLICATION (action_group);
1369
1370   g_return_if_fail (application->priv->is_registered);
1371
1372   if (application->priv->is_remote)
1373     g_application_impl_activate_action (application->priv->impl,
1374                                         action_name, parameter,
1375                                         get_platform_data (application));
1376
1377   else
1378     g_action_group_activate_action (application->priv->actions,
1379                                     action_name, parameter);
1380 }
1381
1382 static void
1383 g_application_action_group_iface_init (GActionGroupInterface *iface)
1384 {
1385   iface->has_action = g_application_has_action;
1386   iface->list_actions = g_application_list_actions;
1387
1388   iface->get_action_enabled = g_application_get_action_enabled;
1389   iface->get_action_parameter_type = g_application_get_action_parameter_type;
1390   iface->get_action_state_type = g_application_get_action_state_type;
1391   iface->get_action_state = g_application_get_action_state;
1392   iface->change_action_state = g_application_change_action_state;
1393   iface->activate_action = g_application_activate_action;
1394 }
1395
1396 /* Epilogue {{{1 */
1397 /* vim:set foldmethod=marker: */