gtkapplication.c 51.2 KB
Newer Older
1 2
/*
 * Copyright © 2010 Codethink Limited
Matthias Clasen's avatar
Matthias Clasen committed
3 4 5 6
 *
 * 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
7
 * version 2 of the licence, or (at your option) any later version.
Matthias Clasen's avatar
Matthias Clasen committed
8 9 10 11 12 13 14
 *
 * 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
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Matthias Clasen's avatar
Matthias Clasen committed
16
 *
17
 * Author: Ryan Lortie <desrt@desrt.ca>
Matthias Clasen's avatar
Matthias Clasen committed
18 19 20 21
 */

#include "config.h"

22 23
#include "gtkapplication.h"

Matthias Clasen's avatar
Matthias Clasen committed
24
#include <stdlib.h>
25
#ifdef HAVE_UNISTD_H
Matthias Clasen's avatar
Matthias Clasen committed
26
#include <unistd.h>
27
#endif
28
#include <string.h>
Matthias Clasen's avatar
Matthias Clasen committed
29

30
#include "gtkapplicationprivate.h"
31
#include "gtkclipboard.h"
32
#include "gtkmarshalers.h"
Matthias Clasen's avatar
Matthias Clasen committed
33
#include "gtkmain.h"
34
#include "gtkrecentmanager.h"
35
#include "gtkaccelmapprivate.h"
36
#include "gtkintl.h"
37 38

#ifdef GDK_WINDOWING_QUARTZ
39
#include "gtkmodelmenu-quartz.h"
40
#import <Cocoa/Cocoa.h>
41
#include <Carbon/Carbon.h>
42
#include "gtkmessagedialog.h"
43
#endif
Matthias Clasen's avatar
Matthias Clasen committed
44 45 46 47 48 49

#include <gdk/gdk.h>
#ifdef GDK_WINDOWING_X11
#include <gdk/x11/gdkx.h>
#endif

50 51
extern void _gtk_accessibility_shutdown (void);

Matthias Clasen's avatar
Matthias Clasen committed
52 53 54 55 56 57 58 59 60
/**
 * 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.
 *
61
 * Currently, GtkApplication handles GTK+ initialization, application
Matthias Clasen's avatar
Matthias Clasen committed
62 63 64 65
 * 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.
66 67 68
 *
 * While GtkApplication works fine with plain #GtkWindows, it is recommended
 * to use it together with #GtkApplicationWindow.
Matthias Clasen's avatar
Matthias Clasen committed
69
 *
70 71 72 73 74 75 76 77 78
 * 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
 * associated with #GtkApplicationWindow and to the 'activate' and
 * 'open' #GApplication methods.
 *
79
 * To set an application menu for a GtkApplication, use
80
 * gtk_application_set_app_menu(). The #GMenuModel that this function
Matthias Clasen's avatar
Matthias Clasen committed
81
 * expects is usually constructed using #GtkBuilder, as seen in the
82
 * following example. To specify a menubar that will be shown by
83
 * #GtkApplicationWindows, use gtk_application_set_menubar(). Use the base
84 85 86 87
 * #GActionMap interface to add actions, to respond to the user
 * selecting these menu items.
 *
 * GTK+ displays these menus as expected, depending on the platform
Matthias Clasen's avatar
Matthias Clasen committed
88 89 90 91 92 93 94 95 96
 * the application is running on.
 *
 * <figure label="Menu integration in OS X">
 * <graphic fileref="bloatpad-osx.png" format="PNG"/>
 * </figure>
 *
 * <figure label="Menu integration in GNOME">
 * <graphic fileref="bloatpad-gnome.png" format="PNG"/>
 * </figure>
97
 *
98 99 100 101
 * <figure label="Menu integration in Xfce">
 * <graphic fileref="bloatpad-xfce.png" format="PNG"/>
 * </figure>
 *
Matthias Clasen's avatar
Matthias Clasen committed
102 103
 * <example id="gtkapplication"><title>A simple application</title>
 * <programlisting>
104
 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/bloatpad.c">
Matthias Clasen's avatar
Matthias Clasen committed
105 106 107 108
 *  <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
 * </xi:include>
 * </programlisting>
 * </example>
Matthias Clasen's avatar
Matthias Clasen committed
109 110
 *
 * GtkApplication optionally registers with a session manager
111
 * of the users session (if you set the #GtkApplication:register-session
Matthias Clasen's avatar
Matthias Clasen committed
112 113 114 115 116 117 118 119 120 121
 * 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.
Matthias Clasen's avatar
Matthias Clasen committed
122 123
 */

124 125 126 127 128 129 130 131
enum {
  WINDOW_ADDED,
  WINDOW_REMOVED,
  LAST_SIGNAL
};

static guint gtk_application_signals[LAST_SIGNAL];

132 133
enum {
  PROP_ZERO,
134 135
  PROP_REGISTER_SESSION,
  PROP_APP_MENU,
136 137
  PROP_MENUBAR,
  PROP_ACTIVE_WINDOW
138 139
};

Matthias Clasen's avatar
Matthias Clasen committed
140 141
G_DEFINE_TYPE (GtkApplication, gtk_application, G_TYPE_APPLICATION)

142
struct _GtkApplicationPrivate
Matthias Clasen's avatar
Matthias Clasen committed
143
{
144
  GList *windows;
145

146 147
  gboolean register_session;

148 149 150
  GMenuModel      *app_menu;
  GMenuModel      *menubar;

151
#ifdef GDK_WINDOWING_X11
152
  GDBusConnection *session_bus;
153
  const gchar     *application_id;
154
  const gchar     *object_path;
155 156 157 158 159 160 161

  gchar           *app_menu_path;
  guint            app_menu_id;

  gchar           *menubar_path;
  guint            menubar_id;

162
  guint next_id;
163 164 165 166 167

  GDBusProxy *sm_proxy;
  GDBusProxy *client_proxy;
  gchar *app_id;
  gchar *client_path;
168
#endif
169 170 171

#ifdef GDK_WINDOWING_QUARTZ
  GMenu *combined;
172

173
  GSList *inhibitors;
174
  gint quit_inhibit;
175
  guint next_cookie;
176
#endif
177
};
Matthias Clasen's avatar
Matthias Clasen committed
178

179
#ifdef GDK_WINDOWING_X11
180 181 182 183 184 185 186 187 188
static void
gtk_application_x11_publish_menu (GtkApplication  *application,
                                  const gchar     *type,
                                  GMenuModel      *model,
                                  guint           *id,
                                  gchar          **path)
{
  gint i;

189 190 191
  if (application->priv->session_bus == NULL)
    return;

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
  /* unexport any existing menu */
  if (*id)
    {
      g_dbus_connection_unexport_menu_model (application->priv->session_bus, *id);
      g_free (*path);
      *path = NULL;
      *id = 0;
    }

  /* export the new menu, if there is one */
  if (model != NULL)
    {
      /* try getting the preferred name */
      *path = g_strconcat (application->priv->object_path, "/menus/", type, NULL);
      *id = g_dbus_connection_export_menu_model (application->priv->session_bus, *path, model, NULL);

      /* keep trying until we get a working name... */
      for (i = 0; *id == 0; i++)
        {
          g_free (*path);
          *path = g_strdup_printf ("%s/menus/%s%d", application->priv->object_path, type, i);
          *id = g_dbus_connection_export_menu_model (application->priv->session_bus, *path, model, NULL);
        }
    }
}

static void
gtk_application_set_app_menu_x11 (GtkApplication *application,
                                  GMenuModel     *app_menu)
{
  gtk_application_x11_publish_menu (application, "appmenu", app_menu,
                                    &application->priv->app_menu_id,
                                    &application->priv->app_menu_path);
}

static void
gtk_application_set_menubar_x11 (GtkApplication *application,
                                 GMenuModel     *menubar)
{
  gtk_application_x11_publish_menu (application, "menubar", menubar,
                                    &application->priv->menubar_id,
                                    &application->priv->menubar_path);
}

236 237 238 239
static void
gtk_application_window_added_x11 (GtkApplication *application,
                                  GtkWindow      *window)
{
240
  if (application->priv->session_bus == NULL)
241 242
    return;

243
  if (GTK_IS_APPLICATION_WINDOW (window))
244
    {
245 246 247 248 249 250 251 252 253 254 255 256 257 258
      GtkApplicationWindow *app_window = GTK_APPLICATION_WINDOW (window);
      gboolean success;

      /* GtkApplicationWindow associates with us when it is first created,
       * so surely it's not realized yet...
       */
      g_assert (!gtk_widget_get_realized (GTK_WIDGET (window)));

      do
        {
          gchar *window_path;
          guint window_id;

          window_id = application->priv->next_id++;
259 260
          window_path = g_strdup_printf ("%s/window/%u", application->priv->object_path, window_id);
          success = gtk_application_window_publish (app_window, application->priv->session_bus, window_path, window_id);
261 262 263
          g_free (window_path);
        }
      while (!success);
264 265 266 267 268 269 270
    }
}

static void
gtk_application_window_removed_x11 (GtkApplication *application,
                                    GtkWindow      *window)
{
271
  if (application->priv->session_bus == NULL)
272 273
    return;

274 275
  if (GTK_IS_APPLICATION_WINDOW (window))
    gtk_application_window_unpublish (GTK_APPLICATION_WINDOW (window));
276 277
}

278 279
static void gtk_application_startup_session_dbus (GtkApplication *app);

280 281 282
static void
gtk_application_startup_x11 (GtkApplication *application)
{
283 284
  application->priv->session_bus = g_application_get_dbus_connection (G_APPLICATION (application));
  application->priv->object_path = g_application_get_dbus_object_path (G_APPLICATION (application));
285 286

  gtk_application_startup_session_dbus (GTK_APPLICATION (application));
287 288 289 290 291
}

static void
gtk_application_shutdown_x11 (GtkApplication *application)
{
292 293 294
  gtk_application_set_app_menu_x11 (application, NULL);
  gtk_application_set_menubar_x11 (application, NULL);

295 296 297
  application->priv->session_bus = NULL;
  application->priv->object_path = NULL;

298 299 300 301
  g_clear_object (&application->priv->sm_proxy);
  g_clear_object (&application->priv->client_proxy);
  g_free (application->priv->app_id);
  g_free (application->priv->client_path);
302
}
303 304 305 306 307 308 309 310 311 312 313 314 315

const gchar *
gtk_application_get_app_menu_object_path (GtkApplication *application)
{
  return application->priv->app_menu_path;
}

const gchar *
gtk_application_get_menubar_object_path (GtkApplication *application)
{
  return application->priv->menubar_path;
}

316 317
#endif

318
#ifdef GDK_WINDOWING_QUARTZ
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334

typedef struct {
  guint cookie;
  GtkApplicationInhibitFlags flags;
  char *reason;
  GtkWindow *window;
} GtkApplicationQuartzInhibitor;

static void
gtk_application_quartz_inhibitor_free (GtkApplicationQuartzInhibitor *inhibitor)
{
  g_free (inhibitor->reason);
  g_clear_object (&inhibitor->window);
  g_slice_free (GtkApplicationQuartzInhibitor, inhibitor);
}

335 336 337 338 339 340 341 342 343
static void
gtk_application_menu_changed_quartz (GObject    *object,
                                     GParamSpec *pspec,
                                     gpointer    user_data)
{
  GtkApplication *application = GTK_APPLICATION (object);
  GMenu *combined;

  combined = g_menu_new ();
344
  g_menu_append_submenu (combined, "Application", gtk_application_get_app_menu (application));
345
  g_menu_append_section (combined, NULL, gtk_application_get_menubar (application));
346

347 348 349
  gtk_quartz_set_main_menu (G_MENU_MODEL (combined), application);

  g_object_unref (combined);
350 351
}

352 353
static void gtk_application_startup_session_quartz (GtkApplication *app);

354 355 356 357 358 359 360 361
static void
gtk_application_startup_quartz (GtkApplication *application)
{
  [NSApp finishLaunching];

  g_signal_connect (application, "notify::app-menu", G_CALLBACK (gtk_application_menu_changed_quartz), NULL);
  g_signal_connect (application, "notify::menubar", G_CALLBACK (gtk_application_menu_changed_quartz), NULL);
  gtk_application_menu_changed_quartz (G_OBJECT (application), NULL, NULL);
362 363

  gtk_application_startup_session_quartz (application);
364 365 366 367 368
}

static void
gtk_application_shutdown_quartz (GtkApplication *application)
{
369
  gtk_quartz_clear_main_menu ();
370

371
  g_signal_handlers_disconnect_by_func (application, gtk_application_menu_changed_quartz, NULL);
372

373 374 375
  g_slist_free_full (application->priv->inhibitors,
		     (GDestroyNotify) gtk_application_quartz_inhibitor_free);
  application->priv->inhibitors = NULL;
376 377 378
}
#endif

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
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);
    }

395 396
  g_object_notify (G_OBJECT (application), "active-window");

397 398 399
  return FALSE;
}

Matthias Clasen's avatar
Matthias Clasen committed
400
static void
401
gtk_application_startup (GApplication *application)
402
{
403 404 405
  G_APPLICATION_CLASS (gtk_application_parent_class)
    ->startup (application);

406
  gtk_init (0, 0);
407 408 409 410

#ifdef GDK_WINDOWING_X11
  gtk_application_startup_x11 (GTK_APPLICATION (application));
#endif
411 412 413 414

#ifdef GDK_WINDOWING_QUARTZ
  gtk_application_startup_quartz (GTK_APPLICATION (application));
#endif
415 416
}

417 418 419
static void
gtk_application_shutdown (GApplication *application)
{
420 421 422 423
#ifdef GDK_WINDOWING_X11
  gtk_application_shutdown_x11 (GTK_APPLICATION (application));
#endif

424 425 426 427
#ifdef GDK_WINDOWING_QUARTZ
  gtk_application_shutdown_quartz (GTK_APPLICATION (application));
#endif

428 429
  /* Keep this section in sync with gtk_main() */

430 431 432 433 434 435
  /* Try storing all clipboard data we have */
  _gtk_clipboard_store_all ();

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

436 437
  _gtk_accessibility_shutdown ();

438 439 440 441
  G_APPLICATION_CLASS (gtk_application_parent_class)
    ->shutdown (application);
}

Matthias Clasen's avatar
Matthias Clasen committed
442
static void
443 444
gtk_application_add_platform_data (GApplication    *application,
                                   GVariantBuilder *builder)
Matthias Clasen's avatar
Matthias Clasen committed
445
{
446
  const gchar *startup_id;
Matthias Clasen's avatar
Matthias Clasen committed
447

448 449 450 451 452
  startup_id = getenv ("DESKTOP_STARTUP_ID");
  
  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
453 454 455
}

static void
456 457
gtk_application_before_emit (GApplication *application,
                             GVariant     *platform_data)
Matthias Clasen's avatar
Matthias Clasen committed
458
{
459 460 461
  GVariantIter iter;
  const gchar *key;
  GVariant *value;
Matthias Clasen's avatar
Matthias Clasen committed
462

463 464
  gdk_threads_enter ();

465 466
  g_variant_iter_init (&iter, platform_data);
  while (g_variant_iter_loop (&iter, "{&sv}", &key, &value))
Matthias Clasen's avatar
Matthias Clasen committed
467
    {
Matthias Clasen's avatar
Matthias Clasen committed
468
#ifdef GDK_WINDOWING_X11
469 470 471 472 473 474 475
      if (strcmp (key, "desktop-startup-id") == 0)
        {
          GdkDisplay *display;
          const gchar *id;

          display = gdk_display_get_default ();
          id = g_variant_get_string (value, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
476 477
          if (GDK_IS_X11_DISPLAY (display))
            gdk_x11_display_set_startup_notification_id (display, id);
478
       }
Matthias Clasen's avatar
Matthias Clasen committed
479
#endif
Matthias Clasen's avatar
Matthias Clasen committed
480 481 482 483
    }
}

static void
484 485
gtk_application_after_emit (GApplication *application,
                            GVariant     *platform_data)
Matthias Clasen's avatar
Matthias Clasen committed
486
{
487
  gdk_notify_startup_complete ();
488 489

  gdk_threads_leave ();
Matthias Clasen's avatar
Matthias Clasen committed
490 491 492 493 494
}

static void
gtk_application_init (GtkApplication *application)
{
495 496 497
  application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
                                                   GTK_TYPE_APPLICATION,
                                                   GtkApplicationPrivate);
498

499
#ifdef GDK_WINDOWING_X11
500
  application->priv->next_id = 1;
501
#endif
Matthias Clasen's avatar
Matthias Clasen committed
502 503
}

504 505 506 507 508 509 510 511 512 513 514 515 516
static void
gtk_application_window_added (GtkApplication *application,
                              GtkWindow      *window)
{
  GtkApplicationPrivate *priv = application->priv;

  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);
517 518 519 520

#ifdef GDK_WINDOWING_X11
  gtk_application_window_added_x11 (application, window);
#endif
521 522

  g_object_notify (G_OBJECT (application), "active-window");
523 524 525 526 527 528 529
}

static void
gtk_application_window_removed (GtkApplication *application,
                                GtkWindow      *window)
{
  GtkApplicationPrivate *priv = application->priv;
530 531 532
  gpointer old_active;

  old_active = priv->windows;
533

534 535 536 537
#ifdef GDK_WINDOWING_X11
  gtk_application_window_removed_x11 (application, window);
#endif

538 539 540 541 542 543
  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);
544
  gtk_window_set_application (window, NULL);
545 546 547

  if (priv->windows != old_active)
    g_object_notify (G_OBJECT (application), "active-window");
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 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
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);

  if (accel && action)
    gtk_application_add_accelerator (app, accel, action, target);

  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);
    }
}

605 606 607 608 609 610 611 612 613 614 615 616 617 618
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;

619 620 621 622 623 624 625 626
    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;

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
    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;

647 648 649 650 651 652 653 654
    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;

655 656 657 658 659 660
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

661 662 663 664 665 666 667 668 669 670 671 672
static void
gtk_application_finalize (GObject *object)
{
  GtkApplication *application = GTK_APPLICATION (object);

  g_clear_object (&application->priv->app_menu);
  g_clear_object (&application->priv->menubar);

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

Matthias Clasen's avatar
Matthias Clasen committed
673
static void
674
gtk_application_class_init (GtkApplicationClass *class)
Matthias Clasen's avatar
Matthias Clasen committed
675
{
676
  GObjectClass *object_class = G_OBJECT_CLASS (class);
677
  GApplicationClass *application_class = G_APPLICATION_CLASS (class);
Matthias Clasen's avatar
Matthias Clasen committed
678

679 680
  object_class->get_property = gtk_application_get_property;
  object_class->set_property = gtk_application_set_property;
681
  object_class->finalize = gtk_application_finalize;
682

683 684 685 686
  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;
687
  application_class->shutdown = gtk_application_shutdown;
688

689 690 691
  class->window_added = gtk_application_window_added;
  class->window_removed = gtk_application_window_removed;

692
  g_type_class_add_private (class, sizeof (GtkApplicationPrivate));
693 694 695 696 697 698 699

  /**
   * GtkApplication::window-added:
   * @application: the #GtkApplication which emitted the signal
   * @window: the newly-added #GtkWindow
   *
   * Emitted when a #GtkWindow is added to @application through
700
   * gtk_application_add_window().
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
   *
   * Since: 3.2
   */
  gtk_application_signals[WINDOW_ADDED] =
    g_signal_new ("window-added", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
                  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] =
    g_signal_new ("window-removed", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (GtkApplicationClass, window_removed),
                  NULL, NULL,
                  g_cclosure_marshal_VOID__OBJECT,
                  G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
728

729
  /**
730
   * GtkApplication:register-session:
731
   *
732
   * Set this property to %TRUE to register with the session manager.
733 734 735
   *
   * Since: 3.4
   */
736 737 738 739 740
  g_object_class_install_property (object_class, PROP_REGISTER_SESSION,
    g_param_spec_boolean ("register-session",
                          P_("Register session"),
                          P_("Register with the session manager"),
                          FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
741 742 743 744 745 746 747 748 749 750 751 752 753 754

  g_object_class_install_property (object_class, PROP_APP_MENU,
    g_param_spec_object ("app-menu",
                         P_("Application menu"),
                         P_("The GMenuModel for the application menu"),
                         G_TYPE_MENU_MODEL,
                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));

  g_object_class_install_property (object_class, PROP_MENUBAR,
    g_param_spec_object ("menubar",
                         P_("Menubar"),
                         P_("The GMenuModel for the menubar"),
                         G_TYPE_MENU_MODEL,
                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
755 756 757 758 759 760 761

  g_object_class_install_property (object_class, PROP_ACTIVE_WINDOW,
    g_param_spec_object ("active-window",
                         P_("Active window"),
                         P_("The window which most recently had focus"),
                         GTK_TYPE_WINDOW,
                         G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
762 763
}

764 765
/**
 * gtk_application_new:
766
 * @application_id: (allow-none): The application ID.
767 768 769 770
 * @flags: the application flags
 *
 * Creates a new #GtkApplication instance.
 *
771 772 773
 * 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.
774
 *
775
 * Concretely, gtk_init() is called in the default handler for the
776
 * #GApplication::startup signal. Therefore, #GtkApplication subclasses should
777
 * chain up in their #GApplication:startup handler before using any GTK+ API.
778
 *
779 780 781
 * 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
Matthias Clasen's avatar
Matthias Clasen committed
782
 * such as <envar>G_DEBUG</envar>, so this should not be a big
783 784 785 786
 * problem. If you absolutely must support GTK+ commandline arguments,
 * you can explicitly call gtk_init() before creating the application
 * instance.
 *
787 788 789 790 791 792
 * 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.
793 794
 *
 * Returns: a new #GtkApplication instance
795 796
 *
 * Since: 3.0
797
 */
798 799 800 801
GtkApplication *
gtk_application_new (const gchar       *application_id,
                     GApplicationFlags  flags)
{
802
  g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
803 804 805 806 807 808 809 810

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

/**
811
 * gtk_application_add_window:
812 813 814
 * @application: a #GtkApplication
 * @window: a #GtkWindow
 *
815
 * Adds a window to @application.
816
 *
817
 * This call is equivalent to setting the #GtkWindow:application
818 819
 * property of @window to @application.
 *
820 821 822 823 824 825 826
 * 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().
 *
 * GTK+ will keep the application running as long as it has
 * any windows.
 *
827 828 829 830 831 832 833 834
 * Since: 3.0
 **/
void
gtk_application_add_window (GtkApplication *application,
                            GtkWindow      *window)
{
  g_return_if_fail (GTK_IS_APPLICATION (application));

835 836 837
  if (!g_list_find (application->priv->windows, window))
    g_signal_emit (application,
                   gtk_application_signals[WINDOW_ADDED], 0, window);
838 839 840 841 842 843 844 845 846 847
}

/**
 * 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
848
 * setting the #GtkWindow:application property of @window to
849 850 851 852 853 854 855 856 857 858 859 860 861
 * %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));

862 863 864
  if (g_list_find (application->priv->windows, window))
    g_signal_emit (application,
                   gtk_application_signals[WINDOW_REMOVED], 0, window);
865 866 867 868 869 870
}

/**
 * gtk_application_get_windows:
 * @application: a #GtkApplication
 *
Matthias Clasen's avatar
Matthias Clasen committed
871
 * Gets a list of the #GtkWindows associated with @application.
872
 *
873
 * The list is sorted by most recently focused window, such that the first
Matthias Clasen's avatar
Matthias Clasen committed
874
 * element is the currently focused window. (Useful for choosing a parent
875 876 877 878 879
 * 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.
880
 *
881
 * Returns: (element-type GtkWindow) (transfer none): a #GList of #GtkWindow
882 883 884 885 886 887 888 889 890
 *
 * 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
891
}
892

893 894 895 896 897
/**
 * gtk_application_get_window_by_id:
 * @application: a #GtkApplication
 * @id: an identifier number
 *
898 899 900
 * Returns the #GtkApplicationWindow with the given ID.
 *
 * Returns: (transfer none): the window with ID @id, or
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
 *   %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;
}

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
/**
 * gtk_application_get_active_window:
 * @application: a #GtkApplication
 *
 * Gets the "active" window for the application.
 *
 * The active window is the one that was most recently focused (within
 * the application).  This window may not have the focus at the moment
 * if another application has it -- this is just the most
 * 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;
}

946 947 948 949 950 951 952 953 954 955 956 957 958
/**
 * 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.
 *
 * @accelerator must be a string that can be parsed by
959 960
 * gtk_accelerator_parse(), e.g. "&lt;Primary&gt;q" or
 * "&lt;Control&gt;&lt;Alt&gt;p".
961 962 963 964 965 966
 *
 * @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
 * are referred to with an "app." prefix, and window-specific actions
 * with a "win." prefix.
 *
967
 * GtkApplication also extracts accelerators out of 'accel' attributes
968 969
 * in the #GMenuModels passed to gtk_application_set_app_menu() and
 * gtk_application_set_menubar(), which is usually more convenient
970 971
 * than calling this function for each accelerator.
 *
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
 * Since: 3.4
 */
void
gtk_application_add_accelerator (GtkApplication *application,
                                 const gchar    *accelerator,
                                 const gchar    *action_name,
                                 GVariant       *parameter)
{
  gchar *accel_path;
  guint accel_key;
  GdkModifierType accel_mods;

  g_return_if_fail (GTK_IS_APPLICATION (application));

  /* Call this here, since gtk_init() is only getting called in startup() */
  _gtk_accel_map_init ();

  gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);

  if (accel_key == 0)
    {
      g_warning ("Failed to parse accelerator: '%s'\n", accelerator);
      return;
    }

997
  accel_path = _gtk_accel_path_for_action (action_name, parameter);
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

  if (gtk_accel_map_lookup_entry (accel_path, NULL))
    gtk_accel_map_change_entry (accel_path, accel_key, accel_mods, TRUE);
  else
    gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);

  g_free (accel_path);
}

/**
 * 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
 */
void
gtk_application_remove_accelerator (GtkApplication *application,
                                    const gchar    *action_name,
                                    GVariant       *parameter)
{
  gchar *accel_path;

  g_return_if_fail (GTK_IS_APPLICATION (application));

1028
  accel_path = _gtk_accel_path_for_action (action_name, parameter);
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

  if (!gtk_accel_map_lookup_entry (accel_path, NULL))
    {
      g_warning ("No accelerator found for '%s'\n", accel_path);
      g_free (accel_path);
      return;
    }

  gtk_accel_map_change_entry (accel_path, 0, 0, FALSE);
  g_free (accel_path);
}
1040 1041 1042 1043

/**
 * gtk_application_set_app_menu:
 * @application: a #GtkApplication
1044
 * @app_menu: (allow-none): a #GMenuModel, or %NULL
1045 1046 1047
 *
 * Sets or unsets the application menu for @application.
 *
1048 1049 1050 1051
 * This can only be done in the primary instance of the application,
 * after it has been registered.  #GApplication:startup is a good place
 * to call this.
 *
1052 1053 1054 1055 1056 1057 1058 1059 1060
 * 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
 * "Preferences" or "Quit" in an application menu, but not "Save" or
 * "Print".
 *
 * If supported, the application menu will be rendered by the desktop
 * environment.
 *
1061 1062 1063
 * Use the base #GActionMap interface to add actions, to respond to the user
 * selecting these menu items.
 *
1064 1065 1066 1067
 * Since: 3.4
 */
void
gtk_application_set_app_menu (GtkApplication *application,
1068
                              GMenuModel     *app_menu)
1069
{
1070
  g_return_if_fail (GTK_IS_APPLICATION (application));
1071 1072
  g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
  g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

  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);

1084 1085
      if (app_menu)
        extract_accels_from_menu (app_menu, application);
1086 1087 1088 1089 1090 1091 1092

#ifdef GDK_WINDOWING_X11
      gtk_application_set_app_menu_x11 (application, app_menu);
#endif

      g_object_notify (G_OBJECT (application), "app-menu");
    }
1093 1094 1095 1096 1097 1098 1099
}

/**
 * gtk_application_get_app_menu:
 * @application: a #GtkApplication
 *
 * Returns the menu model that has been set with
1100
 * gtk_application_set_app_menu().
1101
 *
1102
 * Returns: (transfer none): the application menu of @application
1103 1104 1105 1106 1107 1108
 *
 * Since: 3.4
 */
GMenuModel *
gtk_application_get_app_menu (GtkApplication *application)
{
1109
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1110

1111
  return application->priv->app_menu;
1112 1113 1114 1115 1116
}

/**
 * gtk_application_set_menubar:
 * @application: a #GtkApplication
1117
 * @menubar: (allow-none): a #GMenuModel, or %NULL
1118 1119 1120 1121 1122
 *
 * Sets or unsets the menubar for windows of @application.
 *
 * This is a menubar in the traditional sense.
 *
1123 1124 1125 1126
 * This can only be done in the primary instance of the application,
 * after it has been registered.  #GApplication:startup is a good place
 * to call this.
 *
1127 1128 1129 1130 1131 1132 1133 1134
 * 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.
 * 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.
 *
1135 1136 1137
 * Use the base #GActionMap interface to add actions, to respond to the user
 * selecting these menu items.
 *
1138 1139 1140 1141
 * Since: 3.4
 */
void
gtk_application_set_menubar (GtkApplication *application,
1142
                             GMenuModel     *menubar)
1143
{
1144
  g_return_if_fail (GTK_IS_APPLICATION (application));
1145 1146
  g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
  g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157

  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);

1158 1159
      if (menubar)
        extract_accels_from_menu (menubar, application);
1160 1161 1162 1163 1164 1165 1166

#ifdef GDK_WINDOWING_X11
      gtk_application_set_menubar_x11 (application, menubar);
#endif

      g_object_notify (G_OBJECT (application), "menubar");
    }
1167 1168 1169 1170 1171 1172 1173
}

/**
 * gtk_application_get_menubar:
 * @application: a #GtkApplication
 *
 * Returns the menu model that has been set with
1174
 * gtk_application_set_menubar().
1175
 *
1176
 * Returns: (transfer none): the menubar for windows of @application
1177 1178 1179 1180 1181 1182
 *
 * Since: 3.4
 */
GMenuModel *
gtk_application_get_menubar (GtkApplication *application)
{
1183
  g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1184

1185
  return application->priv->menubar;
1186
}
1187

1188 1189
#if defined(GDK_WINDOWING_X11)

1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
/* D-Bus Session Management
 *
 * The protocol and the D-Bus API are described here:
 * http://live.gnome.org/SessionManagement/GnomeSession
 * http://people.gnome.org/~mccann/gnome-session/docs/gnome-session.html
 */

static void
unregister_client (GtkApplication *app)
{
  GError *error = NULL;

  g_debug ("Unregistering client");

  g_dbus_proxy_call_sync (app->priv->sm_proxy,
                          "UnregisterClient",
                          g_variant_new ("(o)", app->priv->client_path),
                          G_DBUS_CALL_FLAGS_NONE,
                          G_MAXINT,
                          NULL,
                          &error);

  if (error)
    {
      g_warning ("Failed to unregister client: %s", error->message);
      g_error_free (error);
    }

  g_clear_object (&app->priv->client_proxy);

  g_free (app->priv->client_path);
  app->priv->client_path = NULL;
}

1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
static void
gtk_application_quit_response (GtkApplication *application,
                               gboolean        will_quit,
                               const gchar    *reason)
{
  g_debug ("Calling EndSessionResponse %d '%s'", will_quit, reason);

  g_dbus_proxy_call (application->priv->client_proxy,
                     "EndSessionResponse",
                     g_variant_new ("(bs)", will_quit, reason ? reason : ""),
                     G_DBUS_CALL_FLAGS_NONE,
                     G_MAXINT,
                     NULL, NULL, NULL);
}
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
static void
client_proxy_signal (GDBusProxy     *proxy,
                     const gchar    *sender_name,
                     const gchar    *signal_name,
                     GVariant       *parameters,
                     GtkApplication *app)
{
  if (strcmp (signal_name, "QueryEndSession") == 0)
    {
      g_debug ("Received QueryEndSession");
1248 1249 1250 1251 1252
      gtk_application_quit_response (app, TRUE, NULL);
    }
  else if (strcmp (signal_name, "CancelEndSession") == 0)
    {
      g_debug ("Received CancelEndSession");
1253 1254 1255 1256 1257 1258
    }
  else if (strcmp (signal_name, "EndSession") == 0)
    {
      g_debug ("Received EndSession");
      gtk_application_quit_response (app, TRUE, NULL);
      unregister_client (app);
1259
      g_application_quit (G_APPLICATION (app));
1260 1261 1262 1263 1264
    }
  else if (strcmp (signal_name, "Stop") == 0)
    {
      g_debug ("Received Stop");
      unregister_client (app);
1265
      g_application_quit (G_APPLICATION (app));
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 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
    }
}

static void
gtk_application_startup_session_dbus (GtkApplication *app)
{
  static gchar *client_id;
  GError *error = NULL;
  GVariant *res;

  if (app->priv->session_bus == NULL)
    return;

  if (client_id == NULL)
    {
      const gchar *desktop_autostart_id;

      desktop_autostart_id = g_getenv ("DESKTOP_AUTOSTART_ID");
      /* Unset DESKTOP_AUTOSTART_ID in order to avoid child processes to
       * use the same client id.
       */
      g_unsetenv ("DESKTOP_AUTOSTART_ID");
      client_id = g_strdup (desktop_autostart_id ? desktop_autostart_id : "");
    }

  g_debug ("Connecting to session manager");

  app->priv->sm_proxy = g_dbus_proxy_new_sync (app->priv->session_bus,
                                               G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
                                               G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
                                               NULL,
                                               "org.gnome.SessionManager",
                                               "/org/gnome/SessionManager",
                                               "org.gnome.SessionManager",
                                               NULL,
                                               &error);
  if (error)
    {
      g_warning ("Failed to get a session proxy: %s", error->message);
      g_error_free (error);
      return;
    }

  /* FIXME: should we reuse the D-Bus application id here ? */
  app->priv->app_id = g_strdup (g_get_prgname ());

  if (!app->priv->register_session)
    return;

  g_debug ("Registering client '%s' '%s'", app->priv->app_id, client_id);

  res = g_dbus_proxy_call_sync (app->priv->sm_proxy,
                                "RegisterClient",
                                g_variant_new ("(ss)", app->priv->app_id, client_id),
                                G_DBUS_CALL_FLAGS_NONE,
                                G_MAXINT,
                                NULL,
                                &error);

  if (error)
    {
      g_warning ("Failed to register client: %s", error->message);
      g_error_free (error);
      g_clear_object (&app->priv->sm_proxy);
      return;
    }

  g_variant_get (res, "(o)", &app->priv->client_path);
  g_variant_unref (res);

  g_debug ("Registered client at '%s'", app->priv->client_path);
1337

1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
  app->priv->client_proxy = g_dbus_proxy_new_sync (app->priv->session_bus, 0,
                                                   NULL,
                                                   "org.gnome.SessionManager",
                                                   app->priv->client_path,
                                                   "org.gnome.SessionManager.ClientPrivate",
                                                   NULL,
                                                   &error);
  if (error)
    {
      g_warning ("Failed to get client proxy: %s", error->message);
      g_error_free (error);
      g_clear_object (&app->priv->sm_proxy);
      g_free (app->priv->client_path);
      app->priv->client_path = NULL;
      return;
    }

  g_signal_connect (app->priv->client_proxy, "g-signal", G_CALLBACK (client_proxy_signal), app);
}



1360 1361
/**
 * GtkApplicationInhibitFlags:
1362 1363
 * @GTK_APPLICATION_INHIBIT_LOGOUT: Inhibit ending the user session
 *     by logging out or by shutting down the computer
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
 * @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
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
/**
 * gtk_application_inhibit:
 * @application: the #GApplication
 * @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
1391
 * call gtk_application_uninhibit() to remove the inhibitor. Note that
1392 1393 1394
 * 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
1395 1396 1397 1398 1399 1400 1401
 *
 * 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.
 *
1402
 * If @window is given, the session manager may point the user to
Matthias Clasen's avatar
Matthias Clasen committed
1403 1404 1405
 * this window to find out more about why the action is inhibited.
 *
 * Returns: A non-zero cookie that is used to uniquely identify this
1406
 *     request. It should be used as an argument to gtk_application_uninhibit()
Matthias Clasen's avatar
Matthias Clasen committed
1407 1408 1409 1410 1411
 *     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
 */
1412 1413 1414 1415 1416 1417 1418 1419 1420
guint
gtk_application_inhibit (GtkApplication             *application,
                         GtkWindow                  *window,
                         GtkApplicationInhibitFlags  flags,
                         const gchar                *reason)
{
  GVariant *res;
  GError *error = NULL;
  guint cookie;
1421
  guint xid = 0;
1422 1423 1424 1425 1426 1427

  g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
  g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), 0);
  g_return_val_if_fail (application->priv->sm_proxy != NULL, 0);

  if (window != NULL)
1428 1429 1430 1431 1432 1433
    {
      GdkWindow *gdkwindow;

      gdkwindow = gtk_widget_get_window (GTK_WIDGET (window));
      if (gdkwindow == NULL)
        g_warning ("Inhibit called with an unrealized window");
1434 1435
#ifdef GDK_WINDOWING_X11
      else if (GDK_IS_X11_WINDOW (gdkwindow))
1436
        xid = GDK_WINDOW_XID (gdkwindow);
1437
#endif
1438
    }
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452

  res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
                                "Inhibit",
                                g_variant_new ("(susu)",
                                               application->priv->app_id,
                                               xid,
                                               reason,
                                               flags),
                                G_DBUS_CALL_FLAGS_NONE,
                                G_MAXINT,
                                NULL,
                                &error);
 if (error)
    {
1453
      g_warning ("Calling Inhibit failed: %s", error->message);
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
      g_error_free (error);
      return 0;
    }

  g_variant_get (res, "(u)", &cookie);
  g_variant_unref (res);

  return cookie;
}

Matthias Clasen's avatar
Matthias Clasen committed
1464 1465 1466
/**
 * gtk_application_uninhibit:
 * @application: the #GApplication
1467
 * @cookie: a cookie that was returned by gtk_application_inhibit()
Matthias Clasen's avatar
Matthias Clasen committed
1468
 *
1469
 * Removes an inhibitor that has been established with gtk_application_inhibit().
Matthias Clasen's avatar
Matthias Clasen committed
1470 1471 1472 1473
 * Inhibitors are also cleared when the application exits.
 *
 * Since: 3.4
 */
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
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)));
  g_return_if_fail (application->priv->sm_proxy != NULL);

  g_dbus_proxy_call (application->priv->sm_proxy,
                     "Uninhibit",
                     g_variant_new ("(u)", cookie),
                     G_DBUS_CALL_FLAGS_NONE,
                     G_MAXINT,
                     NULL, NULL, NULL);
}

Matthias Clasen's avatar
Matthias Clasen committed
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
/**
 * gtk_application_is_inhibited:
 * @application: the #GApplication
 * @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
 */
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
gboolean
gtk_application_is_inhibited (GtkApplication             *application,
                              GtkApplicationInhibitFlags  flags)
{
  GVariant *res;
  GError *error = NULL;
  gboolean inhibited;

  g_return_val_if_fail (GTK_IS_APPLICATION (application), FALSE);
  g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), FALSE);
  g_return_val_if_fail (application->priv->sm_proxy != NULL, FALSE);

  res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
                                "IsInhibited",
                                g_variant_new ("(u)", flags),
                                G_DBUS_CALL_FLAGS_NONE,
                                G_MAXINT,
                                NULL,
                                &error);
  if (error)
    {
1523
      g_warning ("Calling IsInhibited failed: %s", error->message);
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
      g_error_free (error);
      return FALSE;
    }

  g_variant_get (res, "(b)", &inhibited);
  g_variant_unref (res);

  return inhibited;
}

1534 1535
#elif defined(GDK_WINDOWING_QUARTZ)

1536 1537 1538
/* OS X implementation copied from EggSMClient, but simplified since
 * it doesn't need to interact with the user.
 */
1539 1540 1541 1542 1543 1544

static gboolean
idle_will_quit (gpointer data)
{
  GtkApplication *app = data;

1545
  if (app->priv->quit_inhibit == 0)
1546
    g_application_quit (G_APPLICATION (app));
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
  else
    {
      GtkApplicationQuartzInhibitor *inhibitor;
      GSList *iter;
      GtkWidget *dialog;

      for (iter = app->priv->inhibitors; iter; iter = iter->next)
	{
	  inhibitor = iter->data;
	  if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
	    break;
        }
      g_assert (inhibitor != NULL);

      dialog = gtk_message_dialog_new (inhibitor->window,
				       GTK_DIALOG_MODAL,
				       GTK_MESSAGE_ERROR,
				       GTK_BUTTONS_OK,
				       _("%s cannot quit at this time:\n\n%s"),
				       g_get_application_name (),
				       inhibitor->reason);
1568 1569 1570 1571 1572
      g_signal_connect_swapped (dialog,
                                "response",
                                G_CALLBACK (gtk_widget_destroy),
                                dialog);
      gtk_widget_show_all (dialog);
1573
    }
1574

1575
  return G_SOURCE_REMOVE;
1576 1577
}

1578 1579 1580 1581
static pascal OSErr
quit_requested (const AppleEvent *aevt,
                AppleEvent       *reply,
                long              refcon)
1582
{
1583
  GtkApplication *app = GSIZE_TO_POINTER ((gsize)refcon);
1584

1585 1586
  /* Don't emit the "quit" signal immediately, since we're
   * called from a weird point in the guts of gdkeventloop-quartz.c
1587
   */
1588
  g_idle_add_full (G_PRIORITY_DEFAULT, idle_will_quit, app, NULL);
1589

1590
  return app->priv->quit_inhibit == 0 ? noErr : userCanceledErr;
1591 1592 1593 1594 1595 1596 1597 1598 1599
}

static void
gtk_application_startup_session_quartz (GtkApplication *app)
{
  if (app->priv->register_session)
    AEInstallEventHandler (kCoreEventClass, kAEQuitApplication,
                           NewAEEventHandlerUPP (quit_requested),
                           (long)GPOINTER_TO_SIZE (app), false);
1600 1601 1602 1603 1604 1605 1606 1607
}

guint
gtk_application_inhibit (GtkApplication             *application,
                         GtkWindow                  *window,
                         GtkApplicationInhibitFlags  flags,
                         const gchar                *reason)
{
1608
  GtkApplicationQuartzInhibitor *inhibitor;
1609 1610 1611 1612

  g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
  g_return_val_if_fail (flags != 0, 0);

1613 1614 1615 1616 1617
  inhibitor = g_slice_new (GtkApplicationQuartzInhibitor);
  inhibitor->cookie = ++application->priv->next_cookie;
  inhibitor->flags = flags;
  inhibitor->reason = g_strdup (reason);
  inhibitor->window = window ? g_object_ref (window) : NULL;
1618

1619
  application->priv->inhibitors = g_slist_prepend (application->priv->inhibitors, inhibitor);
1620 1621 1622 1623

  if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
    application->priv->quit_inhibit++;

1624
  return inhibitor->cookie;
1625 1626 1627 1628 1629 1630
}

void
gtk_application_uninhibit (GtkApplication *application,
                           guint           cookie)
{
1631
  GSList *iter;
1632

1633
  for (iter = application->priv->inhibitors; iter; iter = iter->next)
1634
    {
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
      GtkApplicationQuartzInhibitor *inhibitor = iter->data;

      if (inhibitor->cookie == cookie)
	{
	  if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
	    application->priv->quit_inhibit--;
	  gtk_application_quartz_inhibitor_free (inhibitor);
	  application->priv->inhibitors = g_slist_delete_link (application->priv->inhibitors, iter);
	  return;
	}
1645 1646
    }

1647
  g_warning ("Invalid inhibitor cookie");
1648 1649 1650 1651 1652 1653
}

gboolean
gtk_application_is_inhibited (GtkApplication             *application,
                              GtkApplicationInhibitFlags  flags)
{
1654 1655 1656
  if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
    return application->priv->quit_inhibit > 0;

1657 1658 1659
  return FALSE;
}

1660 1661 1662 1663
#else

/* Trivial implementation.
 *
1664
 * For the inhibit API on Windows, see
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
 * http://msdn.microsoft.com/en-us/library/ms700677%28VS.85%29.aspx
 */

guint
gtk_application_inhibit (GtkApplication             *application,
                         GtkWindow                  *window,
                         GtkApplicationInhibitFlags  flags,
                         const gchar                *reason)
{
  return 0;
}

void
gtk_application_uninhibit (GtkApplication *application,
                           guint           cookie)
{
}

gboolean
gtk_application_is_inhibited (GtkApplication             *application,
                              GtkApplicationInhibitFlags  flags)
{
  return FALSE;
}

1690
#endif