gtkapplication.c 59.1 KB
Newer Older
1 2
/*
 * Copyright © 2010 Codethink Limited
3
 * Copyright © 2013 Canonical Limited
Matthias Clasen's avatar
Matthias Clasen committed
4 5 6 7
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2 of the licence, or (at your option) any later version.
Matthias Clasen's avatar
Matthias Clasen committed
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Matthias Clasen's avatar
Matthias Clasen committed
17
 *
18
 * Author: Ryan Lortie <desrt@desrt.ca>
Matthias Clasen's avatar
Matthias Clasen committed
19 20 21 22
 */

#include "config.h"

23 24
#include "gtkapplication.h"

Matthias Clasen's avatar
Matthias Clasen committed
25
#include <stdlib.h>
26 27

#ifdef HAVE_UNISTD_H
Matthias Clasen's avatar
Matthias Clasen committed
28
#include <unistd.h>
29 30
#endif

31
#include <string.h>
Matthias Clasen's avatar
Matthias Clasen committed
32

33
#include "gtkapplicationprivate.h"
34
#include "gtkclipboard.h"
35
#include "gtkmarshalers.h"
Matthias Clasen's avatar
Matthias Clasen committed
36
#include "gtkmain.h"
37
#include "gtkrecentmanager.h"
38
#include "gtkaccelmapprivate.h"
39
#include "gtkicontheme.h"
40
#include "gtkbuilder.h"
41
#include "gtkshortcutswindow.h"
42
#include "gtkintl.h"
43

44 45 46
/* NB: please do not add backend-specific GDK headers here.  This should
 * be abstracted via GtkApplicationImpl.
 */
Matthias Clasen's avatar
Matthias Clasen committed
47 48 49 50 51 52 53 54 55 56

/**
 * SECTION:gtkapplication
 * @title: GtkApplication
 * @short_description: Application class
 *
 * #GtkApplication is a class that handles many important aspects
 * of a GTK+ application in a convenient fashion, without enforcing
 * a one-size-fits-all application model.
 *
57
 * Currently, GtkApplication handles GTK+ initialization, application
Matthias Clasen's avatar
Matthias Clasen committed
58 59 60 61
 * uniqueness, session management, provides some basic scriptability and
 * desktop shell integration by exporting actions and menus and manages a
 * list of toplevel windows whose life-cycle is automatically tied to the
 * life-cycle of your application.
62 63 64
 *
 * While GtkApplication works fine with plain #GtkWindows, it is recommended
 * to use it together with #GtkApplicationWindow.
Matthias Clasen's avatar
Matthias Clasen committed
65
 *
66 67 68 69 70 71
 * When GDK threads are enabled, GtkApplication will acquire the GDK
 * lock when invoking actions that arrive from other processes.  The GDK
 * lock is not touched for local action invocations.  In order to have
 * actions invoked in a predictable context it is therefore recommended
 * that the GDK lock be held while invoking actions locally with
 * g_action_group_activate_action().  The same applies to actions
72
 * associated with #GtkApplicationWindow and to the “activate” and
73
 * “open” #GApplication methods.
74
 *
75 76
 * ## Automatic resources ## {#automatic-resources}
 *
77
 * #GtkApplication will automatically load menus from the #GtkBuilder
78
 * resource located at "gtk/menus.ui", relative to the application's
79 80 81 82 83 84 85
 * resource base path (see g_application_set_resource_base_path()).  The
 * menu with the ID "app-menu" is taken as the application's app menu
 * and the menu with the ID "menubar" is taken as the application's
 * menubar.  Additional menus (most interesting submenus) can be named
 * and accessed via gtk_application_get_menu_by_id() which allows for
 * dynamic population of a part of the menu structure.
 *
86
 * If the resources "gtk/menus-appmenu.ui" or "gtk/menus-traditional.ui" are
87 88 89 90 91
 * present then these files will be used in preference, depending on the
 * value of gtk_application_prefers_app_menu().
 *
 * It is also possible to provide the menus manually using
 * gtk_application_set_app_menu() and gtk_application_set_menubar().
Matthias Clasen's avatar
Matthias Clasen committed
92
 *
93 94 95 96 97 98
 * #GtkApplication will also automatically setup an icon search path for
 * the default icon theme by appending "icons" to the resource base
 * path.  This allows your application to easily store its icons as
 * resources.  See gtk_icon_theme_add_resource_path() for more
 * information.
 *
99 100 101 102 103 104
 * If there is a resource located at "gtk/help-overlay.ui" which is
 * defining a #GtkShortcutsWindow with ID "help_overlay" then GtkApplication
 * associates an instance of this shortcuts window with each
 * #GtkApplicationWindow and sets up keyboard accelerators (Control-F1
 * and Control-?) to open it.
 *
105 106
 * ## A simple application ## {#gtkapplication}
 *
107
 * [A simple example](https://git.gnome.org/browse/gtk+/tree/examples/bp/bloatpad.c)
Matthias Clasen's avatar
Matthias Clasen committed
108 109
 *
 * GtkApplication optionally registers with a session manager
110
 * of the users session (if you set the #GtkApplication:register-session
Matthias Clasen's avatar
Matthias Clasen committed
111 112 113 114 115 116 117 118 119 120
 * property) and offers various functionality related to the session
 * life-cycle.
 *
 * An application can block various ways to end the session with
 * the gtk_application_inhibit() function. Typical use cases for
 * this kind of inhibiting are long-running, uninterruptible operations,
 * such as burning a CD or performing a disk backup. The session
 * manager may not honor the inhibitor, but it can be expected to
 * inform the user about the negative consequences of ending the
 * session while inhibitors are present.
121 122
 *
 * ## See Also ## {#seealso}
123 124
 * [HowDoI: Using GtkApplication](https://wiki.gnome.org/HowDoI/GtkApplication),
 * [Getting Started with GTK+: Basics](https://developer.gnome.org/gtk3/stable/gtk-getting-started.html#id-1.2.3.3)
Matthias Clasen's avatar
Matthias Clasen committed
125 126
 */

127 128 129 130 131 132 133 134
enum {
  WINDOW_ADDED,
  WINDOW_REMOVED,
  LAST_SIGNAL
};

static guint gtk_application_signals[LAST_SIGNAL];

135 136
enum {
  PROP_ZERO,
137 138
  PROP_REGISTER_SESSION,
  PROP_APP_MENU,
139
  PROP_MENUBAR,
140 141
  PROP_ACTIVE_WINDOW,
  NUM_PROPERTIES
142 143
};

144 145
static GParamSpec *gtk_application_props[NUM_PROPERTIES];

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
/* Accel handling */
typedef struct
{
  guint           key;
  GdkModifierType modifier;
} AccelKey;

typedef struct
{
  GHashTable *action_to_accels;
  GHashTable *accel_to_actions;
} Accels;

static AccelKey *
accel_key_copy (const AccelKey *source)
{
  AccelKey *dest;

  dest = g_slice_new (AccelKey);
  dest->key = source->key;
  dest->modifier = source->modifier;

  return dest;
}

static void
accel_key_free (gpointer data)
{
  AccelKey *key = data;

  g_slice_free (AccelKey, key);
}

static guint
accel_key_hash (gconstpointer data)
{
  const AccelKey *key = data;

  return key->key + (key->modifier << 16);
}

static gboolean
accel_key_equal (gconstpointer a,
                 gconstpointer b)
{
  const AccelKey *ak = a;
  const AccelKey *bk = b;

  return ak->key == bk->key && ak->modifier == bk->modifier;
}

static void
accels_foreach_key (Accels                   *accels,
                    GtkWindow                *window,
                    GtkWindowKeysForeachFunc  callback,
                    gpointer                  user_data)
{
  GHashTableIter iter;
  gpointer key;

  g_hash_table_iter_init (&iter, accels->accel_to_actions);
  while (g_hash_table_iter_next (&iter, &key, NULL))
    {
      AccelKey *accel_key = key;

      (* callback) (window, accel_key->key, accel_key->modifier, FALSE, user_data);
    }
}

static gboolean
accels_activate (Accels          *accels,
                 GActionGroup    *action_group,
                 guint            key,
                 GdkModifierType  modifier)
{
  AccelKey accel_key = { key, modifier };
  const gchar **actions;
  gint i;

  actions = g_hash_table_lookup (accels->accel_to_actions, &accel_key);

  if (actions == NULL)
    return FALSE;

  /* We may have more than one action on a given accel.  This could be
   * the case if we have different types of windows with different
   * actions in each.
   *
   * Find the first one that will successfully activate and use it.
   */
  for (i = 0; actions[i]; i++)
    {
      const GVariantType *parameter_type;
      const gchar *action_name;
      const gchar *sep;
      gboolean enabled;
      GVariant *target;

      sep = strrchr (actions[i], '|');
      action_name = sep + 1;

      if (!g_action_group_query_action (action_group, action_name, &enabled, &parameter_type, NULL, NULL, NULL))
        continue;

      if (!enabled)
        continue;

      /* We found an action with the correct name and it's enabled.
       * This is the action that we are going to try to invoke.
       *
       * There is still the possibility that the target value doesn't
       * match the expected parameter type.  In that case, we will print
       * a warning.
       *
       * Note: we want to hold a ref on the target while we're invoking
       * the action to prevent trouble if someone uninstalls the accel
       * from the handler.  That's not a problem since we're parsing it.
       */
      if (actions[i] != sep) /* if it has a target... */
        {
          GError *error = NULL;

          if (parameter_type == NULL)
            {
              gchar *accel_str = gtk_accelerator_name (key, modifier);
              g_warning ("Accelerator '%s' tries to invoke action '%s' with target, but action has no parameter",
                         accel_str, action_name);
              g_free (accel_str);
              return TRUE;
            }

          target = g_variant_parse (NULL, actions[i], sep, NULL, &error);
          g_assert_no_error (error);
          g_assert (target);

          if (!g_variant_is_of_type (target, parameter_type))
            {
              gchar *accel_str = gtk_accelerator_name (key, modifier);
              gchar *typestr = g_variant_type_dup_string (parameter_type);
              gchar *targetstr = g_variant_print (target, TRUE);
              g_warning ("Accelerator '%s' tries to invoke action '%s' with target '%s',"
                         " but action expects parameter with type '%s'", accel_str, action_name, targetstr, typestr);
              g_variant_unref (target);
              g_free (targetstr);
              g_free (accel_str);
              g_free (typestr);
              return TRUE;
            }
        }
      else
        {
          if (parameter_type != NULL)
            {
              gchar *accel_str = gtk_accelerator_name (key, modifier);
              gchar *typestr = g_variant_type_dup_string (parameter_type);
              g_warning ("Accelerator '%s' tries to invoke action '%s' without target,"
                         " but action expects parameter with type '%s'", accel_str, action_name, typestr);
              g_free (accel_str);
              g_free (typestr);
              return TRUE;
            }

          target = NULL;
        }

      g_action_group_activate_action (action_group, action_name, target);

      if (target)
        g_variant_unref (target);

      return TRUE;
    }

  return FALSE;
}

static void
accels_add_entry (Accels         *accels,
                  AccelKey       *key,
                  const gchar    *action_and_target)
{
  const gchar **old;
  const gchar **new;
  gint n;

  old = g_hash_table_lookup (accels->accel_to_actions, key);
  if (old != NULL)
    for (n = 0; old[n]; n++)  /* find the length */
      ;
  else
    n = 0;

  new = g_new (const gchar *, n + 1 + 1);
  memcpy (new, old, n * sizeof (const gchar *));
  new[n] = action_and_target;
  new[n + 1] = NULL;

  g_hash_table_insert (accels->accel_to_actions, accel_key_copy (key), new);
}

static void
accels_remove_entry (Accels         *accels,
                     AccelKey       *key,
                     const gchar    *action_and_target)
{
  const gchar **old;
  const gchar **new;
  gint n, i;

  /* if we can't find the entry then something has gone very wrong... */
  old = g_hash_table_lookup (accels->accel_to_actions, key);
  g_assert (old != NULL);

  for (n = 0; old[n]; n++)  /* find the length */
    ;
  g_assert_cmpint (n, >, 0);

  if (n == 1)
    {
      /* The simple case of removing the last action for an accel. */
      g_assert_cmpstr (old[0], ==, action_and_target);
      g_hash_table_remove (accels->accel_to_actions, key);
      return;
    }

  for (i = 0; i < n; i++)
    if (g_str_equal (old[i], action_and_target))
      break;

  /* We must have found it... */
  g_assert_cmpint (i, <, n);

  new = g_new (const gchar *, n - 1 + 1);
  memcpy (new, old, i * sizeof (const gchar *));
  memcpy (new + i, old + i + 1, (n - (i + 1)) * sizeof (const gchar *));
  new[n - 1] = NULL;

  g_hash_table_insert (accels->accel_to_actions, accel_key_copy (key), new);
}

static void
accels_set_accels_for_action (Accels              *accels,
                              const gchar         *action_and_target,
                              const gchar * const *accelerators)
{
  AccelKey *keys, *old_keys;
  gint i, n;

  n = accelerators ? g_strv_length ((gchar **) accelerators) : 0;

  if (n > 0)
    {
      keys = g_new0 (AccelKey, n + 1);

      for (i = 0; i < n; i++)
        {
          gtk_accelerator_parse (accelerators[i], &keys[i].key, &keys[i].modifier);

          if (keys[i].key == 0)
            {
              g_warning ("Unable to parse accelerator '%s': ignored request to install %d accelerators",
                         accelerators[i], n);
              g_free (keys);
              return;
            }
        }
    }
  else
    keys = NULL;

  old_keys = g_hash_table_lookup (accels->action_to_accels, action_and_target);
  if (old_keys)
    {
      /* We need to remove accel entries from existing keys */
      for (i = 0; old_keys[i].key; i++)
        accels_remove_entry (accels, &old_keys[i], action_and_target);
    }

  if (keys)
    {
      gchar *my_key;

      my_key = g_strdup (action_and_target);

      g_hash_table_replace (accels->action_to_accels, my_key, keys);

      for (i = 0; i < n; i++)
        accels_add_entry (accels, &keys[i], my_key);
    }
  else
    g_hash_table_remove (accels->action_to_accels, action_and_target);
}

439
static gchar **
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
accels_get_accels_for_action (Accels      *accels,
                              const gchar *action_and_target)
{
  AccelKey *keys;
  gchar **result;
  gint n, i = 0;

  keys = g_hash_table_lookup (accels->action_to_accels, action_and_target);
  if (!keys)
    return g_new0 (gchar *, 0 + 1);

  for (n = 0; keys[n].key; n++)
    ;

  result = g_new0 (gchar *, n + 1);

  for (i = 0; i < n; i++)
    result[i] = gtk_accelerator_name (keys[i].key, keys[i].modifier);

  return result;
}

462 463 464 465 466 467 468
static const gchar * const *
accels_get_actions_for_accel (Accels         *accels,
                              const AccelKey *accel_key)
{
  return g_hash_table_lookup (accels->accel_to_actions, accel_key);
}

469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
static void
accels_init (Accels *accels)
{
  accels->accel_to_actions = g_hash_table_new_full (accel_key_hash, accel_key_equal,
                                                    accel_key_free, g_free);
  accels->action_to_accels = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
}

static void
accels_finalize (Accels *accels)
{
  g_hash_table_unref (accels->accel_to_actions);
  g_hash_table_unref (accels->action_to_accels);
}

484
struct _GtkApplicationPrivate
Matthias Clasen's avatar
Matthias Clasen committed
485
{
486 487
  GtkApplicationImpl *impl;

488
  GList *windows;
489

490 491
  GMenuModel      *app_menu;
  GMenuModel      *menubar;
492
  Accels           accels;
493
  guint            last_window_id;
494

495
  gboolean         register_session;
496
  GtkActionMuxer  *muxer;
497
  GtkBuilder      *menus_builder;
498
  gchar           *help_overlay_path;
499
};
Matthias Clasen's avatar
Matthias Clasen committed
500

501 502
G_DEFINE_TYPE_WITH_PRIVATE (GtkApplication, gtk_application, G_TYPE_APPLICATION)

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
static gboolean
gtk_application_focus_in_event_cb (GtkWindow      *window,
                                   GdkEventFocus  *event,
                                   GtkApplication *application)
{
  GtkApplicationPrivate *priv = application->priv;
  GList *link;

  /* Keep the window list sorted by most-recently-focused. */
  link = g_list_find (priv->windows, window);
  if (link != NULL && link != priv->windows)
    {
      priv->windows = g_list_remove_link (priv->windows, link);
      priv->windows = g_list_concat (link, priv->windows);
    }

519 520 521
  if (application->priv->impl)
    gtk_application_impl_active_window_changed (application->priv->impl, window);

522
  g_object_notify_by_pspec (G_OBJECT (application), gtk_application_props[PROP_ACTIVE_WINDOW]);
523

524 525 526
  return FALSE;
}

527 528 529 530 531 532 533 534 535 536
static void
gtk_application_load_resources (GtkApplication *application)
{
  const gchar *base_path;

  base_path = g_application_get_resource_base_path (G_APPLICATION (application));

  if (base_path == NULL)
    return;

537 538 539 540 541 542 543 544 545 546 547
  /* Expand the icon search path */
  {
    GtkIconTheme *default_theme;
    gchar *iconspath;

    default_theme = gtk_icon_theme_get_default ();
    iconspath = g_strconcat (base_path, "/icons", NULL);
    gtk_icon_theme_add_resource_path (default_theme, iconspath);
    g_free (iconspath);
  }

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
  /* Load the menus */
  {
    gchar *menuspath;

    /* If the user has given a specific file for the variant of menu
     * that we are looking for, use it with preference.
     */
    if (gtk_application_prefers_app_menu (application))
      menuspath = g_strconcat (base_path, "/gtk/menus-appmenu.ui", NULL);
    else
      menuspath = g_strconcat (base_path, "/gtk/menus-traditional.ui", NULL);

    if (g_resources_get_info (menuspath, G_RESOURCE_LOOKUP_FLAGS_NONE, NULL, NULL, NULL))
      application->priv->menus_builder = gtk_builder_new_from_resource (menuspath);
    g_free (menuspath);

    /* If we didn't get the specific file, fall back. */
    if (application->priv->menus_builder == NULL)
      {
        menuspath = g_strconcat (base_path, "/gtk/menus.ui", NULL);
        if (g_resources_get_info (menuspath, G_RESOURCE_LOOKUP_FLAGS_NONE, NULL, NULL, NULL))
          application->priv->menus_builder = gtk_builder_new_from_resource (menuspath);
        g_free (menuspath);
      }

573 574 575 576 577 578 579 580 581 582 583 584 585 586
    /* Always load from -common as well, if we have it */
    menuspath = g_strconcat (base_path, "/gtk/menus-common.ui", NULL);
    if (g_resources_get_info (menuspath, G_RESOURCE_LOOKUP_FLAGS_NONE, NULL, NULL, NULL))
      {
        GError *error = NULL;

        if (application->priv->menus_builder == NULL)
          application->priv->menus_builder = gtk_builder_new ();

        if (!gtk_builder_add_from_resource (application->priv->menus_builder, menuspath, &error))
          g_error ("failed to load menus-common.ui: %s", error->message);
      }
    g_free (menuspath);

587 588 589 590 591 592 593 594 595 596 597 598
    if (application->priv->menus_builder)
      {
        GObject *menu;

        menu = gtk_builder_get_object (application->priv->menus_builder, "app-menu");
        if (menu != NULL && G_IS_MENU_MODEL (menu))
          gtk_application_set_app_menu (application, G_MENU_MODEL (menu));
        menu = gtk_builder_get_object (application->priv->menus_builder, "menubar");
        if (menu != NULL && G_IS_MENU_MODEL (menu))
          gtk_application_set_menubar (application, G_MENU_MODEL (menu));
      }
  }
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614

  /* Help overlay */
  {
    gchar *path;

    path = g_strconcat (base_path, "/gtk/help-overlay.ui", NULL);
    if (g_resources_get_info (path, G_RESOURCE_LOOKUP_FLAGS_NONE, NULL, NULL, NULL))
    {
      const gchar * const accels[] = { "<Primary>F1", "<Primary>question", NULL };

      application->priv->help_overlay_path = path;
      gtk_application_set_accels_for_action (application, "win.show-help-overlay", accels);
    }
  else
    g_free (path);
  }
615 616 617
}


Matthias Clasen's avatar
Matthias Clasen committed
618
static void
619
gtk_application_startup (GApplication *g_application)
620
{
621 622
  GtkApplication *application = GTK_APPLICATION (g_application);

623
  G_APPLICATION_CLASS (gtk_application_parent_class)
624 625 626
    ->startup (g_application);

  gtk_action_muxer_insert (application->priv->muxer, "app", G_ACTION_GROUP (application));
627

628
  gtk_init (0, 0);
629

630 631
  application->priv->impl = gtk_application_impl_new (application, gdk_display_get_default ());
  gtk_application_impl_startup (application->priv->impl, application->priv->register_session);
632 633

  gtk_application_load_resources (application);
634 635
}

636
static void
637
gtk_application_shutdown (GApplication *g_application)
638
{
639
  GtkApplication *application = GTK_APPLICATION (g_application);
640

641 642
  gtk_application_impl_shutdown (application->priv->impl);
  g_clear_object (&application->priv->impl);
643

644 645
  gtk_action_muxer_remove (application->priv->muxer, "app");

646 647
  /* Keep this section in sync with gtk_main() */

648 649 650 651 652 653
  /* Try storing all clipboard data we have */
  _gtk_clipboard_store_all ();

  /* Synchronize the recent manager singleton */
  _gtk_recent_manager_sync ();

654
  G_APPLICATION_CLASS (gtk_application_parent_class)
655
    ->shutdown (g_application);
656 657
}

658 659 660 661 662 663 664 665 666 667
static gboolean
gtk_application_local_command_line (GApplication   *application,
                                    gchar        ***arguments,
                                    gint           *exit_status)
{
  g_application_add_option_group (application, gtk_get_option_group (FALSE));

  return G_APPLICATION_CLASS (gtk_application_parent_class)->local_command_line (application, arguments, exit_status);
}

Matthias Clasen's avatar
Matthias Clasen committed
668
static void
669 670
gtk_application_add_platform_data (GApplication    *application,
                                   GVariantBuilder *builder)
Matthias Clasen's avatar
Matthias Clasen committed
671
{
672
  const gchar *startup_id;
Matthias Clasen's avatar
Matthias Clasen committed
673

674 675 676 677 678 679 680
  /* This is slightly evil.
   *
   * We don't have an impl here because we're remote so we can't figure
   * out what to do on a per-display-server basis.
   *
   * So we do all the things... which currently is just one thing.
   */
681
  startup_id = getenv ("DESKTOP_STARTUP_ID");
682

683 684 685
  if (startup_id && g_utf8_validate (startup_id, -1, NULL))
    g_variant_builder_add (builder, "{sv}", "desktop-startup-id",
                           g_variant_new_string (startup_id));
Matthias Clasen's avatar
Matthias Clasen committed
686 687 688
}

static void
689
gtk_application_before_emit (GApplication *g_application,
690
                             GVariant     *platform_data)
Matthias Clasen's avatar
Matthias Clasen committed
691
{
692
  GtkApplication *application = GTK_APPLICATION (g_application);
Matthias Clasen's avatar
Matthias Clasen committed
693

694 695
  gdk_threads_enter ();

696
  gtk_application_impl_before_emit (application->priv->impl, platform_data);
Matthias Clasen's avatar
Matthias Clasen committed
697 698 699
}

static void
700 701
gtk_application_after_emit (GApplication *application,
                            GVariant     *platform_data)
Matthias Clasen's avatar
Matthias Clasen committed
702
{
703
  gdk_notify_startup_complete ();
704 705

  gdk_threads_leave ();
Matthias Clasen's avatar
Matthias Clasen committed
706 707 708 709 710
}

static void
gtk_application_init (GtkApplication *application)
{
711
  application->priv = gtk_application_get_instance_private (application);
712

713 714 715
  application->priv->muxer = gtk_action_muxer_new ();

  accels_init (&application->priv->accels);
Matthias Clasen's avatar
Matthias Clasen committed
716 717
}

718 719 720 721 722 723
static void
gtk_application_window_added (GtkApplication *application,
                              GtkWindow      *window)
{
  GtkApplicationPrivate *priv = application->priv;

724
  if (GTK_IS_APPLICATION_WINDOW (window))
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    {
      gtk_application_window_set_id (GTK_APPLICATION_WINDOW (window), ++priv->last_window_id);
      if (priv->help_overlay_path)
        {
          GtkBuilder *builder;
          GtkWidget *help_overlay;

          builder = gtk_builder_new_from_resource (priv->help_overlay_path);
          help_overlay = GTK_WIDGET (gtk_builder_get_object (builder, "help_overlay"));
          if (GTK_IS_SHORTCUTS_WINDOW (help_overlay))
            gtk_application_window_set_help_overlay (GTK_APPLICATION_WINDOW (window),
                                                     GTK_SHORTCUTS_WINDOW (help_overlay));
          g_object_unref (builder);
        }
    }
740

741 742 743 744 745 746 747
  priv->windows = g_list_prepend (priv->windows, window);
  gtk_window_set_application (window, application);
  g_application_hold (G_APPLICATION (application));

  g_signal_connect (window, "focus-in-event",
                    G_CALLBACK (gtk_application_focus_in_event_cb),
                    application);
748

749 750 751
  gtk_application_impl_window_added (priv->impl, window);

  gtk_application_impl_active_window_changed (priv->impl, window);
752

753
  g_object_notify_by_pspec (G_OBJECT (application), gtk_application_props[PROP_ACTIVE_WINDOW]);
754 755 756 757 758 759 760
}

static void
gtk_application_window_removed (GtkApplication *application,
                                GtkWindow      *window)
{
  GtkApplicationPrivate *priv = application->priv;
761 762 763
  gpointer old_active;

  old_active = priv->windows;
764

765 766
  if (priv->impl)
    gtk_application_impl_window_removed (priv->impl, window);
767

768 769 770 771 772 773
  g_signal_handlers_disconnect_by_func (window,
                                        gtk_application_focus_in_event_cb,
                                        application);

  g_application_release (G_APPLICATION (application));
  priv->windows = g_list_remove (priv->windows, window);
774
  gtk_window_set_application (window, NULL);
775

776
  if (priv->windows != old_active && priv->impl)
777
    {
778
      gtk_application_impl_active_window_changed (priv->impl, priv->windows ? priv->windows->data : NULL);
779
      g_object_notify_by_pspec (G_OBJECT (application), gtk_application_props[PROP_ACTIVE_WINDOW]);
780
    }
781 782
}

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
static void
extract_accel_from_menu_item (GMenuModel     *model,
                              gint            item,
                              GtkApplication *app)
{
  GMenuAttributeIter *iter;
  const gchar *key;
  GVariant *value;
  const gchar *accel = NULL;
  const gchar *action = NULL;
  GVariant *target = NULL;

  iter = g_menu_model_iterate_item_attributes (model, item);
  while (g_menu_attribute_iter_get_next (iter, &key, &value))
    {
      if (g_str_equal (key, "action") && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
        action = g_variant_get_string (value, NULL);
      else if (g_str_equal (key, "accel") && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
        accel = g_variant_get_string (value, NULL);
      else if (g_str_equal (key, "target"))
        target = g_variant_ref (value);
      g_variant_unref (value);
    }
  g_object_unref (iter);

808
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS
809 810
  if (accel && action)
    gtk_application_add_accelerator (app, accel, action, target);
811
  G_GNUC_END_IGNORE_DEPRECATIONS
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839

  if (target)
    g_variant_unref (target);
}

static void
extract_accels_from_menu (GMenuModel     *model,
                          GtkApplication *app)
{
  gint i;
  GMenuLinkIter *iter;
  const gchar *key;
  GMenuModel *m;

  for (i = 0; i < g_menu_model_get_n_items (model); i++)
    {
      extract_accel_from_menu_item (model, i, app);

      iter = g_menu_model_iterate_item_links (model, i);
      while (g_menu_link_iter_get_next (iter, &key, &m))
        {
          extract_accels_from_menu (m, app);
          g_object_unref (m);
        }
      g_object_unref (iter);
    }
}

840 841 842 843 844 845 846 847 848 849 850 851 852 853
static void
gtk_application_get_property (GObject    *object,
                              guint       prop_id,
                              GValue     *value,
                              GParamSpec *pspec)
{
  GtkApplication *application = GTK_APPLICATION (object);

  switch (prop_id)
    {
    case PROP_REGISTER_SESSION:
      g_value_set_boolean (value, application->priv->register_session);
      break;

854 855 856 857 858 859 860 861
    case PROP_APP_MENU:
      g_value_set_object (value, gtk_application_get_app_menu (application));
      break;

    case PROP_MENUBAR:
      g_value_set_object (value, gtk_application_get_menubar (application));
      break;

862 863 864 865
    case PROP_ACTIVE_WINDOW:
      g_value_set_object (value, gtk_application_get_active_window (application));
      break;

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_application_set_property (GObject      *object,
                              guint         prop_id,
                              const GValue *value,
                              GParamSpec   *pspec)
{
  GtkApplication *application = GTK_APPLICATION (object);

  switch (prop_id)
    {
    case PROP_REGISTER_SESSION:
      application->priv->register_session = g_value_get_boolean (value);
      break;

886 887 888 889 890 891 892 893
    case PROP_APP_MENU:
      gtk_application_set_app_menu (application, g_value_get_object (value));
      break;

    case PROP_MENUBAR:
      gtk_application_set_menubar (application, g_value_get_object (value));
      break;

894 895 896 897 898 899
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

900 901 902 903 904
static void
gtk_application_finalize (GObject *object)
{
  GtkApplication *application = GTK_APPLICATION (object);

905
  g_clear_object (&application->priv->menus_builder);
906 907
  g_clear_object (&application->priv->app_menu);
  g_clear_object (&application->priv->menubar);
908
  g_clear_object (&application->priv->muxer);
909

910 911
  accels_finalize (&application->priv->accels);

912 913 914
  g_free (application->priv->help_overlay_path);

  G_OBJECT_CLASS (gtk_application_parent_class)->finalize (object);
915 916
}

Matthias Clasen's avatar
Matthias Clasen committed
917
static void
918
gtk_application_class_init (GtkApplicationClass *class)
Matthias Clasen's avatar
Matthias Clasen committed
919
{
920
  GObjectClass *object_class = G_OBJECT_CLASS (class);
921
  GApplicationClass *application_class = G_APPLICATION_CLASS (class);
Matthias Clasen's avatar
Matthias Clasen committed
922

923 924
  object_class->get_property = gtk_application_get_property;
  object_class->set_property = gtk_application_set_property;
925
  object_class->finalize = gtk_application_finalize;
926

927
  application_class->local_command_line = gtk_application_local_command_line;
928 929 930 931
  application_class->add_platform_data = gtk_application_add_platform_data;
  application_class->before_emit = gtk_application_before_emit;
  application_class->after_emit = gtk_application_after_emit;
  application_class->startup = gtk_application_startup;
932
  application_class->shutdown = gtk_application_shutdown;
933

934 935 936 937 938 939 940 941 942
  class->window_added = gtk_application_window_added;
  class->window_removed = gtk_application_window_removed;

  /**
   * GtkApplication::window-added:
   * @application: the #GtkApplication which emitted the signal
   * @window: the newly-added #GtkWindow
   *
   * Emitted when a #GtkWindow is added to @application through
943
   * gtk_application_add_window().
944 945 946 947
   *
   * Since: 3.2
   */
  gtk_application_signals[WINDOW_ADDED] =
948
    g_signal_new (I_("window-added"), GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
                  G_STRUCT_OFFSET (GtkApplicationClass, window_added),
                  NULL, NULL,
                  g_cclosure_marshal_VOID__OBJECT,
                  G_TYPE_NONE, 1, GTK_TYPE_WINDOW);

  /**
   * GtkApplication::window-removed:
   * @application: the #GtkApplication which emitted the signal
   * @window: the #GtkWindow that is being removed
   *
   * Emitted when a #GtkWindow is removed from @application,
   * either as a side-effect of being destroyed or explicitly
   * through gtk_application_remove_window().
   *
   * Since: 3.2
   */
  gtk_application_signals[WINDOW_REMOVED] =
966
    g_signal_new (I_("window-removed"), GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
967 968 969 970
                  G_STRUCT_OFFSET (GtkApplicationClass, window_removed),
                  NULL, NULL,
                  g_cclosure_marshal_VOID__OBJECT,
                  G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
971

972
  /**
973
   * GtkApplication:register-session:
974
   *
975
   * Set this property to %TRUE to register with the session manager.
976 977 978
   *
   * Since: 3.4
   */
979
  gtk_application_props[PROP_REGISTER_SESSION] =
980 981 982
    g_param_spec_boolean ("register-session",
                          P_("Register session"),
                          P_("Register with the session manager"),
983 984
                          FALSE,
                          G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS);
985

986
  gtk_application_props[PROP_APP_MENU] =
987 988 989 990
    g_param_spec_object ("app-menu",
                         P_("Application menu"),
                         P_("The GMenuModel for the application menu"),
                         G_TYPE_MENU_MODEL,
991
                         G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS);
992

993
  gtk_application_props[PROP_MENUBAR] =
994 995 996 997
    g_param_spec_object ("menubar",
                         P_("Menubar"),
                         P_("The GMenuModel for the menubar"),
                         G_TYPE_MENU_MODEL,
998
                         G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS);
999

1000
  gtk_application_props[PROP_ACTIVE_WINDOW] =
1001 1002 1003 1004
    g_param_spec_object ("active-window",
                         P_("Active window"),
                         P_("The window which most recently had focus"),
                         GTK_TYPE_WINDOW,
1005 1006 1007
                         G_PARAM_READABLE|G_PARAM_STATIC_STRINGS);

  g_object_class_install_properties (object_class, NUM_PROPERTIES, gtk_application_props);
1008 1009
}

1010 1011
/**
 * gtk_application_new:
1012
 * @application_id: (allow-none): The application ID.
1013 1014 1015 1016
 * @flags: the application flags
 *
 * Creates a new #GtkApplication instance.
 *
1017 1018 1019
 * When using #GtkApplication, it is not necessary to call gtk_init()
 * manually. It is called as soon as the application gets registered as
 * the primary instance.
1020
 *
1021
 * Concretely, gtk_init() is called in the default handler for the
1022
 * #GApplication::startup signal. Therefore, #GtkApplication subclasses should
1023
 * chain up in their #GApplication::startup handler before using any GTK+ API.
1024
 *
1025 1026 1027
 * Note that commandline arguments are not passed to gtk_init().
 * All GTK+ functionality that is available via commandline arguments
 * can also be achieved by setting suitable environment variables
1028
 * such as `G_DEBUG`, so this should not be a big
1029 1030 1031 1032
 * problem. If you absolutely must support GTK+ commandline arguments,
 * you can explicitly call gtk_init() before creating the application
 * instance.
 *
1033 1034 1035 1036 1037 1038
 * If non-%NULL, the application ID must be valid.  See
 * g_application_id_is_valid().
 *
 * If no application ID is given then some features (most notably application 
 * uniqueness) will be disabled. A null application ID is only allowed with 
 * GTK+ 3.6 or later.
1039 1040
 *
 * Returns: a new #GtkApplication instance
1041 1042
 *
 * Since: 3.0
1043
 */
1044 1045 1046 1047
GtkApplication *
gtk_application_new (const gchar       *application_id,
                     GApplicationFlags  flags)
{
1048
  g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1049 1050 1051 1052 1053 1054 1055 1056

  return g_object_new (GTK_TYPE_APPLICATION,
                       "application-id", application_id,
                       "flags", flags,
                       NULL);
}

/**
1057
 * gtk_application_add_window:
1058 1059 1060
 * @application: a #GtkApplication
 * @window: a #GtkWindow
 *
1061
 * Adds a window to @application.
1062
 *
1063 1064 1065 1066
 * This call can only happen after the @application has started;
 * typically, you should add new application windows in response
 * to the emission of the #GApplication::activate signal.
 *
1067
 * This call is equivalent to setting the #GtkWindow:application
1068 1069
 * property of @window to @application.
 *
1070 1071 1072 1073
 * Normally, the connection between the application and the window
 * will remain until the window is destroyed, but you can explicitly
 * remove it with gtk_application_remove_window().
 *
1074
 * GTK+ will keep the @application running as long as it has
1075 1076
 * any windows.
 *
1077 1078 1079 1080 1081 1082 1083 1084
 * Since: 3.0
 **/
void
gtk_application_add_window (GtkApplication *application,
                            GtkWindow      *window)
{
  g_return_if_fail (GTK_IS_APPLICATION (application));

1085 1086 1087 1088 1089 1090 1091
  if (!g_application_get_is_registered (G_APPLICATION (application)))
    {
      g_critical ("New application windows must be added after the "
                  "GApplication::startup signal has been emitted.");
      return;
    }

1092 1093 1094
  if (!g_list_find (application->priv->windows, window))
    g_signal_emit (application,
                   gtk_application_signals[WINDOW_ADDED], 0, window);
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
}

/**
 * gtk_application_remove_window:
 * @application: a #GtkApplication
 * @window: a #GtkWindow
 *
 * Remove a window from @application.
 *
 * If @window belongs to @application then this call is equivalent to
1105
 * setting the #GtkWindow:application property of @window to
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
 * %NULL.
 *
 * The application may stop running as a result of a call to this
 * function.
 *
 * Since: 3.0
 **/
void
gtk_application_remove_window (GtkApplication *application,
                               GtkWindow      *window)
{
  g_return_if_fail (GTK_IS_APPLICATION (application));

1119 1120 1121
  if (g_list_find (application->priv->windows, window))
    g_signal_emit (application,
                   gtk_application_signals[WINDOW_REMOVED], 0, window);
1122 1123 1124 1125 1126 1127
}

/**
 * gtk_application_get_windows:
 * @application: a #GtkApplication
 *
Matthias Clasen's avatar
Matthias Clasen committed
1128
 * Gets a list of the #GtkWindows associated with @application.
1129
 *
1130
 * The list is sorted by most recently focused window, such that the first
Matthias Clasen's avatar
Matthias Clasen committed
1131
 * element is the currently focused window. (Useful for choosing a parent
1132 1133 1134 1135 1136
 * for a transient window.)
 *
 * The list that is returned should not be modified in any way. It will
 * only remain valid until the next focus change or window creation or
 * deletion.
1137
 *
1138
 * Returns: (element-type GtkWindow) (transfer none): a #GList of #GtkWindow
1139 1140 1141 1142 1143 1144 1145 1146 1147
 *
 * Since: 3.0
 **/
GList *
gtk_application_get_windows (GtkApplication *application)
{
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);

  return application->priv->windows;
Matthias Clasen's avatar
Matthias Clasen committed
1148
}
1149

1150 1151 1152 1153 1154
/**
 * gtk_application_get_window_by_id:
 * @application: a #GtkApplication
 * @id: an identifier number
 *
1155 1156 1157
 * Returns the #GtkApplicationWindow with the given ID.
 *
 * Returns: (transfer none): the window with ID @id, or
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
 *   %NULL if there is no window with this ID
 *
 * Since: 3.6
 */
GtkWindow *
gtk_application_get_window_by_id (GtkApplication *application,
                                  guint           id)
{
  GList *l;

  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);

  for (l = application->priv->windows; l != NULL; l = l->next) 
    {
      if (GTK_IS_APPLICATION_WINDOW (l->data) &&
          gtk_application_window_get_id (GTK_APPLICATION_WINDOW (l->data)) == id)
        return l->data;
    }

  return NULL;
}

1180 1181 1182 1183
/**
 * gtk_application_get_active_window:
 * @application: a #GtkApplication
 *
1184
 * Gets the “active” window for the application.
1185 1186 1187
 *
 * The active window is the one that was most recently focused (within
 * the application).  This window may not have the focus at the moment
1188
 * if another application has it — this is just the most
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
 * recently-focused window within this application.
 *
 * Returns: (transfer none): the active window
 *
 * Since: 3.6
 **/
GtkWindow *
gtk_application_get_active_window (GtkApplication *application)
{
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);

  return application->priv->windows ? application->priv->windows->data : NULL;
}

1203 1204 1205 1206 1207 1208 1209 1210 1211
static void
gtk_application_update_accels (GtkApplication *application)
{
  GList *l;

  for (l = application->priv->windows; l != NULL; l = l->next)
    _gtk_window_notify_keys_changed (l->data);
}

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
/**
 * gtk_application_add_accelerator:
 * @application: a #GtkApplication
 * @accelerator: accelerator string
 * @action_name: the name of the action to activate
 * @parameter: (allow-none): parameter to pass when activating the action,
 *   or %NULL if the action does not accept an activation parameter
 *
 * Installs an accelerator that will cause the named action
 * to be activated when the key combination specificed by @accelerator
 * is pressed.
 *
1224 1225
 * @accelerator must be a string that can be parsed by gtk_accelerator_parse(),
 * e.g. "<Primary>q" or “<Control><Alt>p”.
1226 1227 1228
 *
 * @action_name must be the name of an action as it would be used
 * in the app menu, i.e. actions that have been added to the application
1229 1230
 * are referred to with an “app.” prefix, and window-specific actions
 * with a “win.” prefix.
1231
 *
1232
 * GtkApplication also extracts accelerators out of “accel” attributes
1233 1234
 * in the #GMenuModels passed to gtk_application_set_app_menu() and
 * gtk_application_set_menubar(), which is usually more convenient
1235 1236
 * than calling this function for each accelerator.
 *
1237
 * Since: 3.4
1238 1239
 *
 * Deprecated: 3.14: Use gtk_application_set_accels_for_action() instead
1240 1241 1242 1243 1244 1245 1246
 */
void
gtk_application_add_accelerator (GtkApplication *application,
                                 const gchar    *accelerator,
                                 const gchar    *action_name,
                                 GVariant       *parameter)
{
1247 1248
  const gchar *accelerators[2] = { accelerator, NULL };
  gchar *action_and_target;
1249 1250

  g_return_if_fail (GTK_IS_APPLICATION (application));
1251 1252 1253 1254 1255 1256 1257 1258
  g_return_if_fail (action_name != NULL);
  g_return_if_fail (accelerator != NULL);

  action_and_target = gtk_print_action_and_target (NULL, action_name, parameter);
  accels_set_accels_for_action (&application->priv->accels, action_and_target, accelerators);
  gtk_action_muxer_set_primary_accel (application->priv->muxer, action_and_target, accelerator);
  gtk_application_update_accels (application);
  g_free (action_and_target);
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
}

/**
 * gtk_application_remove_accelerator:
 * @application: a #GtkApplication
 * @action_name: the name of the action to activate
 * @parameter: (allow-none): parameter to pass when activating the action,
 *   or %NULL if the action does not accept an activation parameter
 *
 * Removes an accelerator that has been previously added
 * with gtk_application_add_accelerator().
 *
 * Since: 3.4
1272 1273
 *
 * Deprecated: 3.14: Use gtk_application_set_accels_for_action() instead
1274 1275 1276 1277 1278 1279
 */
void
gtk_application_remove_accelerator (GtkApplication *application,
                                    const gchar    *action_name,
                                    GVariant       *parameter)
{
1280
  gchar *action_and_target;
1281 1282

  g_return_if_fail (GTK_IS_APPLICATION (application));
1283
  g_return_if_fail (action_name != NULL);
1284

1285 1286 1287 1288 1289
  action_and_target = gtk_print_action_and_target (NULL, action_name, parameter);
  accels_set_accels_for_action (&application->priv->accels, action_and_target, NULL);
  gtk_action_muxer_set_primary_accel (application->priv->muxer, action_and_target, NULL);
  gtk_application_update_accels (application);
  g_free (action_and_target);
1290
}
1291

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
/**
 * gtk_application_prefers_app_menu:
 * @application: a #GtkApplication
 *
 * Determines if the desktop environment in which the application is
 * running would prefer an application menu be shown.
 *
 * If this function returns %TRUE then the application should call
 * gtk_application_set_app_menu() with the contents of an application
 * menu, which will be shown by the desktop environment.  If it returns
 * %FALSE then you should consider using an alternate approach, such as
 * a menubar.
 *
 * The value returned by this function is purely advisory and you are
 * free to ignore it.  If you call gtk_application_set_app_menu() even
 * if the desktop environment doesn't support app menus, then a fallback
 * will be provided.
 *
 * Applications are similarly free not to set an app menu even if the
 * desktop environment wants to show one.  In that case, a fallback will
 * also be created by the desktop environment (GNOME, for example, uses
 * a menu with only a "Quit" item in it).
 *
 * The value returned by this function never changes.  Once it returns a
 * particular value, it is guaranteed to always return the same value.
 *
 * You may only call this function after the application has been
 * registered and after the base startup handler has run.  You're most
 * likely to want to use this from your own startup handler.  It may
 * also make sense to consult this function while constructing UI (in
 * activate, open or an action activation handler) in order to determine
 * if you should show a gear menu or not.
 *
 * This function will return %FALSE on Mac OS and a default app menu
 * will be created automatically with the "usual" contents of that menu
 * typical to most Mac OS applications.  If you call
 * gtk_application_set_app_menu() anyway, then this menu will be
 * replaced with your own.
 *
 * Returns: %TRUE if you should set an app menu
 *
 * Since: 3.14
 **/
gboolean
gtk_application_prefers_app_menu (GtkApplication *application)
{
  g_return_val_if_fail (application->priv->impl != NULL, FALSE);

  return gtk_application_impl_prefers_app_menu (application->priv->impl);
}

1343 1344 1345
/**
 * gtk_application_set_app_menu:
 * @application: a #GtkApplication
1346
 * @app_menu: (allow-none): a #GMenuModel, or %NULL
1347 1348 1349
 *
 * Sets or unsets the application menu for @application.
 *
1350
 * This can only be done in the primary instance of the application,
1351
 * after it has been registered.  #GApplication::startup is a good place
1352 1353
 * to call this.
 *
1354 1355 1356
 * The application menu is a single menu containing items that typically
 * impact the application as a whole, rather than acting on a specific
 * window or document.  For example, you would expect to see
1357 1358
 * “Preferences” or “Quit” in an application menu, but not “Save” or
 * “Print”.
1359 1360 1361 1362
 *
 * If supported, the application menu will be rendered by the desktop
 * environment.
 *
1363 1364 1365
 * Use the base #GActionMap interface to add actions, to respond to the user
 * selecting these menu items.
 *
1366 1367 1368 1369
 * Since: 3.4
 */
void
gtk_application_set_app_menu (GtkApplication *application,
1370
                              GMenuModel     *app_menu)
1371
{
1372
  g_return_if_fail (GTK_IS_APPLICATION (application));
1373 1374
  g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
  g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385

  if (app_menu != application->priv->app_menu)
    {
      if (application->priv->app_menu != NULL)
        g_object_unref (application->priv->app_menu);

      application->priv->app_menu = app_menu;

      if (application->priv->app_menu != NULL)
        g_object_ref (application->priv->app_menu);

1386 1387
      if (app_menu)
        extract_accels_from_menu (app_menu, application);
1388

1389
      gtk_application_impl_set_app_menu (application->priv->impl, app_menu);
1390

1391
      g_object_notify_by_pspec (G_OBJECT (application), gtk_application_props[PROP_APP_MENU]);
1392
    }
1393 1394 1395 1396 1397 1398 1399
}

/**
 * gtk_application_get_app_menu:
 * @application: a #GtkApplication
 *
 * Returns the menu model that has been set with
1400
 * gtk_application_set_app_menu().
1401
 *
1402
 * Returns: (transfer none): the application menu of @application
1403 1404 1405 1406 1407 1408
 *
 * Since: 3.4
 */
GMenuModel *
gtk_application_get_app_menu (GtkApplication *application)
{
1409
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1410

1411
  return application->priv->app_menu;
1412 1413 1414 1415 1416
}

/**
 * gtk_application_set_menubar:
 * @application: a #GtkApplication
1417
 * @menubar: (allow-none): a #GMenuModel, or %NULL
1418 1419 1420 1421 1422
 *
 * Sets or unsets the menubar for windows of @application.
 *
 * This is a menubar in the traditional sense.
 *
1423
 * This can only be done in the primary instance of the application,
1424
 * after it has been registered.  #GApplication::startup is a good place
1425 1426
 * to call this.
 *
1427 1428 1429 1430
 * Depending on the desktop environment, this may appear at the top of
 * each window, or at the top of the screen.  In some environments, if
 * both the application menu and the menubar are set, the application
 * menu will be presented as if it were the first item of the menubar.
1431 1432 1433
 * Other environments treat the two as completely separate — for example,
 * the application menu may be rendered by the desktop shell while the
 * menubar (if set) remains in each individual window.
1434
 *
1435 1436
 * Use the base #GActionMap interface to add actions, to respond to the
 * user selecting these menu items.
1437
 *
1438 1439 1440 1441
 * Since: 3.4
 */
void
gtk_application_set_menubar (GtkApplication *application,
1442
                             GMenuModel     *menubar)
1443
{
1444
  g_return_if_fail (GTK_IS_APPLICATION (application));
1445 1446
  g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
  g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457

  if (menubar != application->priv->menubar)
    {
      if (application->priv->menubar != NULL)
        g_object_unref (application->priv->menubar);

      application->priv->menubar = menubar;

      if (application->priv->menubar != NULL)
        g_object_ref (application->priv->menubar);

1458 1459
      if (menubar)
        extract_accels_from_menu (menubar, application);
1460

1461
      gtk_application_impl_set_menubar (application->priv->impl, menubar);
1462

1463
      g_object_notify_by_pspec (G_OBJECT (application), gtk_application_props[PROP_MENUBAR]);
1464
    }
1465 1466 1467 1468 1469 1470 1471
}

/**
 * gtk_application_get_menubar:
 * @application: a #GtkApplication
 *
 * Returns the menu model that has been set with
1472
 * gtk_application_set_menubar().
1473
 *
1474
 * Returns: (transfer none): the menubar for windows of @application
1475 1476 1477 1478 1479 1480
 *
 * Since: 3.4
 */
GMenuModel *
gtk_application_get_menubar (GtkApplication *application)
{
1481
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1482

1483
  return application->priv->menubar;
1484
}
1485

1486 1487
/**
 * GtkApplicationInhibitFlags:
1488 1489
 * @GTK_APPLICATION_INHIBIT_LOGOUT: Inhibit ending the user session
 *     by logging out or by shutting down the computer
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
 * @GTK_APPLICATION_INHIBIT_SWITCH: Inhibit user switching
 * @GTK_APPLICATION_INHIBIT_SUSPEND: Inhibit suspending the
 *     session or computer
 * @GTK_APPLICATION_INHIBIT_IDLE: Inhibit the session being
 *     marked as idle (and possibly locked)
 *
 * Types of user actions that may be blocked by gtk_application_inhibit().
 *
 * Since: 3.4
 */

Matthias Clasen's avatar
Matthias Clasen committed
1501 1502
/**
 * gtk_application_inhibit:
1503
 * @application: the #GtkApplication
Matthias Clasen's avatar
Matthias Clasen committed
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
 * @window: (allow-none): a #GtkWindow, or %NULL
 * @flags: what types of actions should be inhibited
 * @reason: (allow-none): a short, human-readable string that explains
 *     why these operations are inhibited
 *
 * Inform the session manager that certain types of actions should be
 * inhibited. This is not guaranteed to work on all platforms and for
 * all types of actions.
 *
 * Applications should invoke this method when they begin an operation
 * that should not be interrupted, such as creating a CD or DVD. The
 * types of actions that may be blocked are specified by the @flags
 * parameter. When the application completes the operation it should
1517
 * call gtk_application_uninhibit() to remove the inhibitor. Note that
1518 1519 1520
 * an application can have multiple inhibitors, and all of the must
 * be individually removed. Inhibitors are also cleared when the
 * application exits.
Matthias Clasen's avatar
Matthias Clasen committed
1521 1522 1523 1524 1525 1526 1527
 *
 * Applications should not expect that they will always be able to block
 * the action. In most cases, users will be given the option to force
 * the action to take place.
 *
 * Reasons should be short and to the point.
 *
1528
 * If @window is given, the session manager may point the user to
Matthias Clasen's avatar
Matthias Clasen committed
1529 1530 1531
 * this window to find out more about why the action is inhibited.
 *
 * Returns: A non-zero cookie that is used to uniquely identify this
1532
 *     request. It should be used as an argument to gtk_application_uninhibit()
Matthias Clasen's avatar
Matthias Clasen committed
1533 1534 1535 1536 1537
 *     in order to remove the request. If the platform does not support
 *     inhibiting or the request failed for some reason, 0 is returned.
 *
 * Since: 3.4
 */
1538 1539 1540 1541 1542 1543 1544 1545
guint
gtk_application_inhibit (GtkApplication             *application,
                         GtkWindow                  *window,
                         GtkApplicationInhibitFlags  flags,
                         const gchar                *reason)
{
  g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
  g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), 0);
1546

1547
  return gtk_application_impl_inhibit (application->priv->impl, window, flags, reason);
1548 1549
}

Matthias Clasen's avatar
Matthias Clasen committed
1550 1551
/**
 * gtk_application_uninhibit:
1552
 * @application: the #GtkApplication
1553
 * @cookie: a cookie that was returned by gtk_application_inhibit()
Matthias Clasen's avatar
Matthias Clasen committed
1554
 *
1555
 * Removes an inhibitor that has been established with gtk_application_inhibit().
Matthias Clasen's avatar
Matthias Clasen committed
1556 1557 1558 1559
 * Inhibitors are also cleared when the application exits.
 *
 * Since: 3.4
 */
1560 1561 1562 1563 1564 1565
void
gtk_application_uninhibit (GtkApplication *application,
                           guint           cookie)
{
  g_return_if_fail (GTK_IS_APPLICATION (application));
  g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1566 1567
  g_return_if_fail (cookie > 0);

1568
  gtk_application_impl_uninhibit (application->priv->impl, cookie);
1569 1570
}

Matthias Clasen's avatar
Matthias Clasen committed
1571 1572
/**
 * gtk_application_is_inhibited:
1573
 * @application: the #GtkApplication
Matthias Clasen's avatar
Matthias Clasen committed
1574 1575 1576 1577 1578 1579 1580 1581 1582
 * @flags: what types of actions should be queried
 *
 * Determines if any of the actions specified in @flags are
 * currently inhibited (possibly by another application).
 *
 * Returns: %TRUE if any of the actions specified in @flags are inhibited
 *
 * Since: 3.4
 */
1583 1584 1585 1586 1587 1588
gboolean
gtk_application_is_inhibited (GtkApplication             *application,
                              GtkApplicationInhibitFlags  flags)
{
  g_return_val_if_fail (GTK_IS_APPLICATION (application), FALSE);
  g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), FALSE);
1589

1590
  return gtk_application_impl_is_inhibited (application->priv->impl, flags);
1591 1592
}

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
GtkActionMuxer *
gtk_application_get_parent_muxer_for_window (GtkWindow *window)
{
  GtkApplication *application;

  application = gtk_window_get_application (window);

  if (!application)
    return NULL;

  return application->priv->muxer;
}
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623

gboolean
gtk_application_activate_accel (GtkApplication  *application,
                                GActionGroup    *action_group,
                                guint            key,
                                GdkModifierType  modifier)
{
  return accels_activate (&application->priv->accels, action_group, key, modifier);
}

void
gtk_application_foreach_accel_keys (GtkApplication           *application,
                                    GtkWindow                *window,
                                    GtkWindowKeysForeachFunc  callback,
                                    gpointer                  user_data)
{
  accels_foreach_key (&application->priv->accels, window, callback, user_data);
}

Matthias Clasen's avatar
Matthias Clasen committed
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
/**
 * gtk_application_list_action_descriptions:
 * @application: a #GtkApplication
 *
 * Lists the detailed action names which have associated accelerators.
 * See gtk_application_set_accels_for_action().
 *
 * Returns: (transfer full): a %NULL-terminated array of strings,
 *     free with g_strfreev() when done
 *
 * Since: 3.12
 */
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
gchar **
gtk_application_list_action_descriptions (GtkApplication *application)
{
  GHashTableIter iter;
  gchar **result;
  gint n, i = 0;
  gpointer key;

  n = g_hash_table_size (application->priv->accels.action_to_accels);
  result = g_new (gchar *, n + 1);

  g_hash_table_iter_init (&iter, application->priv->accels.action_to_accels);
  while (g_hash_table_iter_next (&iter, &key, NULL))
    {
      const gchar *action_and_target = key;
      const gchar *sep;
      GVariant *target;

      sep = strrchr (action_and_target, '|');
      target = g_variant_parse (NULL, action_and_target, sep, NULL, NULL);
      result[i++] = g_action_print_detailed_name (sep + 1, target);
      if (target)
        g_variant_unref (target);
    }
  g_assert_cmpint (i, ==, n);
  result[i] = NULL;

  return result;
}

1666
static gchar *
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
normalise_detailed_name (const gchar *detailed_action_name)
{
  GError *error = NULL;
  gchar *action_and_target;
  gchar *action_name;
  GVariant *target;

  g_action_parse_detailed_name (detailed_action_name, &action_name, &target, &error);
  g_assert_no_error (error);

  action_and_target = gtk_print_action_and_target (NULL, action_name, target);

  if (target)
    g_variant_unref (target);

  g_free (action_name);

  return action_and_target;
}

Matthias Clasen's avatar
Matthias Clasen committed
1687 1688 1689
/**
 * gtk_application_set_accels_for_action:
 * @application: a #GtkApplication
1690
 * @detailed_action_name: a detailed action name, specifying an action
Matthias Clasen's avatar
Matthias Clasen committed
1691
 *     and target to associate accelerators with
1692 1693
 * @accels: (array zero-terminated=1): a list of accelerators in the format
 *     understood by gtk_accelerator_parse()
Matthias Clasen's avatar
Matthias Clasen committed
1694
 *
1695
 * Sets zero or more keyboard accelerators that will trigger the
1696
 * given action. The first item in @accels will be the primary
Matthias Clasen's avatar
Matthias Clasen committed
1697 1698
 * accelerator, which may be displayed in the UI.
 *
1699 1700 1701
 * To remove all accelerators for an action, use an empty, zero-terminated
 * array for @accels.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1702 1703
 * Since: 3.12
 */
1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
void
gtk_application_set_accels_for_action (GtkApplication      *application,
                                       const gchar         *detailed_action_name,
                                       const gchar * const *accels)
{
  gchar *action_and_target;

  g_return_if_fail (GTK_IS_APPLICATION (application));
  g_return_if_fail (detailed_action_name != NULL);

  action_and_target = normalise_detailed_name (detailed_action_name);
  accels_set_accels_for_action (&application->priv->accels, action_and_target, accels);
  gtk_action_muxer_set_primary_accel (application->priv->muxer, action_and_target, accels[0]);
  gtk_application_update_accels (application);
  g_free (action_and_target);
}

Matthias Clasen's avatar
Matthias Clasen committed
1721 1722 1723
/**
 * gtk_application_get_accels_for_action:
 * @application: a #GtkApplication
1724
 * @detailed_action_name: a detailed action name, specifying an action
Matthias Clasen's avatar
Matthias Clasen committed
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
 *     and target to obtain accelerators for
 *
 * Gets the accelerators that are currently associated with
 * the given action.
 *
 * Returns: (transfer full): accelerators for @detailed_action_name, as
 *     a %NULL-terminated array. Free with g_strfreev() when no longer needed
 *
 * Since: 3.12
 */
1735 1736 1737 1738 1739 1740 1741
gchar **
gtk_application_get_accels_for_action (GtkApplication *application,
                                       const gchar    *detailed_action_name)
{
  gchar *action_and_target;
  gchar **accels;

1742 1743
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
  g_return_val_if_fail (detailed_action_name != NULL, NULL);
1744 1745 1746 1747 1748 1749 1750

  action_and_target = normalise_detailed_name (detailed_action_name);
  accels = accels_get_accels_for_action (&application->priv->accels, action_and_target);
  g_free (action_and_target);

  return accels;
}
1751

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817