gtkapplication.c 48.8 KB
Newer Older
Allison Karlitskaya's avatar
Allison Karlitskaya committed
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
Allison Karlitskaya's avatar
Allison Karlitskaya committed
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 15 16 17 18
 *
 * 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
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
Allison Karlitskaya's avatar
Allison Karlitskaya committed
19
 * Author: Ryan Lortie <desrt@desrt.ca>
Matthias Clasen's avatar
Matthias Clasen committed
20 21 22 23
 */

#include "config.h"

24 25
#include "gtkapplication.h"

Matthias Clasen's avatar
Matthias Clasen committed
26
#include <stdlib.h>
Hans Breuer's avatar
Hans Breuer committed
27
#ifdef HAVE_UNISTD_H
Matthias Clasen's avatar
Matthias Clasen committed
28
#include <unistd.h>
Hans Breuer's avatar
Hans Breuer committed
29
#endif
Allison Karlitskaya's avatar
Allison Karlitskaya committed
30
#include <string.h>
Matthias Clasen's avatar
Matthias Clasen committed
31

32
#include "gtkapplicationprivate.h"
33
#include "gtkmarshalers.h"
Matthias Clasen's avatar
Matthias Clasen committed
34
#include "gtkmain.h"
35
#include "gtkaccelmapprivate.h"
36
#include "gactionmuxer.h"
37
#include "gtkintl.h"
38 39 40 41

#ifdef GDK_WINDOWING_QUARTZ
#include "gtkquartz-menu.h"
#import <Cocoa/Cocoa.h>
42 43
#include <Carbon/Carbon.h>
#include <CoreServices/CoreServices.h>
44
#endif
Matthias Clasen's avatar
Matthias Clasen committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

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

/**
 * 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.
 *
60
 * Currently, GtkApplication handles GTK+ initialization, application
Matthias Clasen's avatar
Matthias Clasen committed
61 62 63 64
 * 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.
65 66 67
 *
 * While GtkApplication works fine with plain #GtkWindows, it is recommended
 * to use it together with #GtkApplicationWindow.
Matthias Clasen's avatar
Matthias Clasen committed
68
 *
69 70 71 72 73 74 75 76 77
 * 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.
 *
Matthias Clasen's avatar
Matthias Clasen committed
78
 * To set an application menu on a GtkApplication, use
79
 * gtk_application_set_app_menu(). The #GMenuModel that this function
Matthias Clasen's avatar
Matthias Clasen committed
80 81
 * expects is usually constructed using #GtkBuilder, as seen in the
 * following example. To set a menubar that will be automatically picked
82
 * up by #GApplicationWindows, use gtk_application_set_menubar(). GTK+
Matthias Clasen's avatar
Matthias Clasen committed
83 84 85 86 87 88 89 90 91 92
 * makes these menus appear as expected, depending on the platform
 * 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>
93
 *
94 95 96 97
 * <figure label="Menu integration in Xfce">
 * <graphic fileref="bloatpad-xfce.png" format="PNG"/>
 * </figure>
 *
Matthias Clasen's avatar
Matthias Clasen committed
98 99
 * <example id="gtkapplication"><title>A simple application</title>
 * <programlisting>
100
 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/bloatpad.c">
Matthias Clasen's avatar
Matthias Clasen committed
101 102 103 104
 *  <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
 * </xi:include>
 * </programlisting>
 * </example>
Matthias Clasen's avatar
Matthias Clasen committed
105 106 107 108 109 110 111
 *
 * GtkApplication optionally registers with a session manager
 * of the users session (if you set the #GtkApplication::register-session
 * property) and offers various functionality related to the session
 * life-cycle.
 *
 * An application can be informed when the session is about to end
112
 * by connecting to the #GtkApplication::quit signal.
Matthias Clasen's avatar
Matthias Clasen committed
113 114 115 116 117 118 119 120 121 122 123
 *
 * An application can request the session to be ended by calling
 * gtk_application_end_session().
 *
 * 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
124 125
 */

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

static guint gtk_application_signals[LAST_SIGNAL];

135 136 137 138 139
enum {
  PROP_ZERO,
  PROP_REGISTER_SESSION
};

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
#ifdef GDK_WINDOWING_X11
149
  GDBusConnection *session_bus;
150 151
  gchar *window_prefix;
  guint next_id;
152 153 154 155 156

  GDBusProxy *sm_proxy;
  GDBusProxy *client_proxy;
  gchar *app_id;
  gchar *client_path;
157
#endif
158 159 160 161

#ifdef GDK_WINDOWING_QUARTZ
  GActionMuxer *muxer;
  GMenu *combined;
162

163 164 165
  GHashTable *inhibitors;
  gint quit_inhibited;
  guint next_cookie;
166
  AppleEvent quit_event, quit_reply;
167
  gboolean quitting;
168
#endif
169
};
Matthias Clasen's avatar
Matthias Clasen committed
170

171 172 173 174 175
#ifdef GDK_WINDOWING_X11
static void
gtk_application_window_added_x11 (GtkApplication *application,
                                  GtkWindow      *window)
{
176
  if (application->priv->session_bus == NULL)
177 178
    return;

179
  if (GTK_IS_APPLICATION_WINDOW (window))
180
    {
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
      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++;
          window_path = g_strdup_printf ("%s%d", application->priv->window_prefix, window_id);
196
          success = gtk_application_window_publish (app_window, application->priv->session_bus, window_path);
197 198 199
          g_free (window_path);
        }
      while (!success);
200 201 202 203 204 205 206
    }
}

static void
gtk_application_window_removed_x11 (GtkApplication *application,
                                    GtkWindow      *window)
{
207
  if (application->priv->session_bus == NULL)
208 209
    return;

210 211
  if (GTK_IS_APPLICATION_WINDOW (window))
    gtk_application_window_unpublish (GTK_APPLICATION_WINDOW (window));
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
}

static gchar *
window_prefix_from_appid (const gchar *appid)
{
  gchar *appid_path, *iter;

  appid_path = g_strconcat ("/", appid, "/windows/", NULL);
  for (iter = appid_path; *iter; iter++)
    {
      if (*iter == '.')
        *iter = '/';

      if (*iter == '-')
        *iter = '_';
    }

  return appid_path;
}

232 233
static void gtk_application_startup_session_dbus (GtkApplication *app);

234 235 236 237 238 239
static void
gtk_application_startup_x11 (GtkApplication *application)
{
  const gchar *application_id;

  application_id = g_application_get_application_id (G_APPLICATION (application));
240
  application->priv->session_bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
241
  application->priv->window_prefix = window_prefix_from_appid (application_id);
242 243

  gtk_application_startup_session_dbus (GTK_APPLICATION (application));
244 245 246 247 248 249 250
}

static void
gtk_application_shutdown_x11 (GtkApplication *application)
{
  g_free (application->priv->window_prefix);
  application->priv->window_prefix = NULL;
251
  g_clear_object (&application->priv->session_bus);
252 253 254 255 256

  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);
257 258 259
}
#endif

260 261 262 263 264 265 266 267 268 269
#ifdef GDK_WINDOWING_QUARTZ
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 ();
270 271
  g_menu_append_submenu (combined, "Application", g_application_get_app_menu (application));
  g_menu_append_section (combined, NULL, gtk_application_get_menubar (application));
272 273 274 275

  gtk_quartz_set_main_menu (G_MENU_MODEL (combined), G_ACTION_OBSERVABLE (application->priv->muxer));
}

276 277
static void gtk_application_startup_session_quartz (GtkApplication *app);

278 279 280 281 282 283 284 285 286 287 288
static void
gtk_application_startup_quartz (GtkApplication *application)
{
  [NSApp finishLaunching];

  application->priv->muxer = g_action_muxer_new ();
  g_action_muxer_insert (application->priv->muxer, "app", G_ACTION_GROUP (application));

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

  gtk_application_startup_session_quartz (application);
291 292 293 294 295 296 297 298 299
}

static void
gtk_application_shutdown_quartz (GtkApplication *application)
{
  g_signal_handlers_disconnect_by_func (application, gtk_application_menu_changed_quartz, NULL);

  g_object_unref (application->priv->muxer);
  application->priv->muxer = NULL;
300 301

  g_hash_table_unref (application->priv->inhibitors);
302 303 304 305 306 307 308 309 310 311 312 313 314
}

static void
gtk_application_focus_changed (GtkApplication *application,
                               GtkWindow      *window)
{
  if (G_IS_ACTION_GROUP (window))
    g_action_muxer_insert (application->priv->muxer, "win", G_ACTION_GROUP (window));
  else
    g_action_muxer_remove (application->priv->muxer, "win");
}
#endif

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
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);
    }

331 332 333 334
#ifdef GDK_WINDOWING_QUARTZ
  gtk_application_focus_changed (application, window);
#endif

335 336 337
  return FALSE;
}

Matthias Clasen's avatar
Matthias Clasen committed
338
static void
Allison Karlitskaya's avatar
Allison Karlitskaya committed
339
gtk_application_startup (GApplication *application)
340
{
341 342 343
  G_APPLICATION_CLASS (gtk_application_parent_class)
    ->startup (application);

Allison Karlitskaya's avatar
Allison Karlitskaya committed
344
  gtk_init (0, 0);
345 346 347 348

#ifdef GDK_WINDOWING_X11
  gtk_application_startup_x11 (GTK_APPLICATION (application));
#endif
349 350 351 352

#ifdef GDK_WINDOWING_QUARTZ
  gtk_application_startup_quartz (GTK_APPLICATION (application));
#endif
353 354
}

355 356 357
static void
gtk_application_shutdown (GApplication *application)
{
358 359 360 361
#ifdef GDK_WINDOWING_X11
  gtk_application_shutdown_x11 (GTK_APPLICATION (application));
#endif

362 363 364 365
#ifdef GDK_WINDOWING_QUARTZ
  gtk_application_shutdown_quartz (GTK_APPLICATION (application));
#endif

366 367 368 369
  G_APPLICATION_CLASS (gtk_application_parent_class)
    ->shutdown (application);
}

Matthias Clasen's avatar
Matthias Clasen committed
370
static void
Allison Karlitskaya's avatar
Allison Karlitskaya committed
371 372
gtk_application_add_platform_data (GApplication    *application,
                                   GVariantBuilder *builder)
Matthias Clasen's avatar
Matthias Clasen committed
373
{
Allison Karlitskaya's avatar
Allison Karlitskaya committed
374
  const gchar *startup_id;
Matthias Clasen's avatar
Matthias Clasen committed
375

Allison Karlitskaya's avatar
Allison Karlitskaya committed
376 377 378 379 380
  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
381 382 383
}

static void
Allison Karlitskaya's avatar
Allison Karlitskaya committed
384 385
gtk_application_before_emit (GApplication *application,
                             GVariant     *platform_data)
Matthias Clasen's avatar
Matthias Clasen committed
386
{
Allison Karlitskaya's avatar
Allison Karlitskaya committed
387 388 389
  GVariantIter iter;
  const gchar *key;
  GVariant *value;
Matthias Clasen's avatar
Matthias Clasen committed
390

391 392
  gdk_threads_enter ();

Allison Karlitskaya's avatar
Allison Karlitskaya committed
393 394
  g_variant_iter_init (&iter, platform_data);
  while (g_variant_iter_loop (&iter, "{&sv}", &key, &value))
Matthias Clasen's avatar
Matthias Clasen committed
395
    {
Matthias Clasen's avatar
Matthias Clasen committed
396
#ifdef GDK_WINDOWING_X11
Allison Karlitskaya's avatar
Allison Karlitskaya committed
397 398 399 400 401 402 403
      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
404 405
          if (GDK_IS_X11_DISPLAY (display))
            gdk_x11_display_set_startup_notification_id (display, id);
Allison Karlitskaya's avatar
Allison Karlitskaya committed
406
       }
Matthias Clasen's avatar
Matthias Clasen committed
407
#endif
Matthias Clasen's avatar
Matthias Clasen committed
408 409 410 411
    }
}

static void
Allison Karlitskaya's avatar
Allison Karlitskaya committed
412 413
gtk_application_after_emit (GApplication *application,
                            GVariant     *platform_data)
Matthias Clasen's avatar
Matthias Clasen committed
414
{
Allison Karlitskaya's avatar
Allison Karlitskaya committed
415
  gdk_notify_startup_complete ();
416 417

  gdk_threads_leave ();
Matthias Clasen's avatar
Matthias Clasen committed
418 419 420 421 422
}

static void
gtk_application_init (GtkApplication *application)
{
423 424 425
  application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
                                                   GTK_TYPE_APPLICATION,
                                                   GtkApplicationPrivate);
Matthias Clasen's avatar
Matthias Clasen committed
426 427
}

428 429 430 431 432 433 434 435 436 437 438 439 440
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);
441 442 443 444

#ifdef GDK_WINDOWING_X11
  gtk_application_window_added_x11 (application, window);
#endif
445 446 447 448 449 450 451 452
}

static void
gtk_application_window_removed (GtkApplication *application,
                                GtkWindow      *window)
{
  GtkApplicationPrivate *priv = application->priv;

453 454 455 456
#ifdef GDK_WINDOWING_X11
  gtk_application_window_removed_x11 (application, window);
#endif

457 458 459 460 461 462
  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);
463
  gtk_window_set_application (window, NULL);
464 465
}

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
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);
    }
}

static void
gtk_application_notify (GObject    *object,
                        GParamSpec *pspec)
{
  if (strcmp (pspec->name, "app-menu") == 0 ||
      strcmp (pspec->name, "menubar") == 0)
    {
      GMenuModel *model;
      g_object_get (object, pspec->name, &model, NULL);
      if (model)
        {
          extract_accels_from_menu (model, GTK_APPLICATION (object));
          g_object_unref (model);
        }
    }

  if (G_OBJECT_CLASS (gtk_application_parent_class)->notify)
    G_OBJECT_CLASS (gtk_application_parent_class)->notify (object, pspec);
}

541 542 543 544 545 546 547 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
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;

    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;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

581 582 583 584 585 586 587
static void
gtk_application_quit (GtkApplication *app)
{
  /* we are asked to quit, so don't linger */
  g_application_set_inactivity_timeout (G_APPLICATION (app), 0);
}

Matthias Clasen's avatar
Matthias Clasen committed
588
static void
Allison Karlitskaya's avatar
Allison Karlitskaya committed
589
gtk_application_class_init (GtkApplicationClass *class)
Matthias Clasen's avatar
Matthias Clasen committed
590
{
591
  GObjectClass *object_class = G_OBJECT_CLASS (class);
Allison Karlitskaya's avatar
Allison Karlitskaya committed
592
  GApplicationClass *application_class = G_APPLICATION_CLASS (class);
Matthias Clasen's avatar
Matthias Clasen committed
593

594 595
  object_class->get_property = gtk_application_get_property;
  object_class->set_property = gtk_application_set_property;
596 597
  object_class->notify = gtk_application_notify;

Allison Karlitskaya's avatar
Allison Karlitskaya committed
598 599 600 601
  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;
602
  application_class->shutdown = gtk_application_shutdown;
603

604 605
  class->window_added = gtk_application_window_added;
  class->window_removed = gtk_application_window_removed;
606
  class->quit = gtk_application_quit;
607

608
  g_type_class_add_private (class, sizeof (GtkApplicationPrivate));
609 610 611 612 613 614 615

  /**
   * GtkApplication::window-added:
   * @application: the #GtkApplication which emitted the signal
   * @window: the newly-added #GtkWindow
   *
   * Emitted when a #GtkWindow is added to @application through
616
   * gtk_application_add_window().
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
   *
   * 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);
644

Matthias Clasen's avatar
Matthias Clasen committed
645 646 647 648 649 650 651 652 653
  /**
   * GtkApplication::quit:
   * @application: the #GtkApplication
   *
   * Emitted when the session manager wants the application to quit
   * (generally because the user is logging out). The application
   * should exit as soon as possible after receiving this signal; if
   * it does not, the session manager may choose to forcibly kill it.
   *
654 655 656
   * Normally, an application would only be sent a ::quit if there
   * are no inhibitors (see gtk_application_inhibit()).
   * However, this is not guaranteed; in some situations the
Matthias Clasen's avatar
Matthias Clasen committed
657 658 659 660 661 662 663 664 665
   * session manager may decide to end the session without giving
   * applications a chance to object.
   *
   * To receive this signal, you need to set the
   * #GtkApplication::register-session property
   * when creating the application object.
   *
   * Since: 3.4
   */
666
  gtk_application_signals[QUIT] =
667
    g_signal_new ("quit", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
668 669 670
                  G_STRUCT_OFFSET (GtkApplicationClass, quit),
                  NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);

671 672 673 674 675 676 677 678 679
  /**
   * GtkApplication::register-session:
   *
   * Set this property to %TRUE to register with the session manager
   * and receive the #GtkApplication::quit signal when the session
   * is about to end.
   *
   * Since: 3.4
   */
680 681 682 683 684
  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));
685 686
}

687 688 689 690 691 692 693 694 695 696
/**
 * gtk_application_new:
 * @application_id: the application id
 * @flags: the application flags
 *
 * Creates a new #GtkApplication instance.
 *
 * This function calls g_type_init() for you. gtk_init() is called
 * as soon as the application gets registered as the primary instance.
 *
697 698 699 700 701 702 703 704
 * 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
 * such as <envvar>G_DEBUG</envvar>, so this should not be a big
 * problem. If you absolutely must support GTK+ commandline arguments,
 * you can explicitly call gtk_init() before creating the application
 * instance.
 *
705 706 707 708
 * The application id must be valid. See g_application_id_is_valid().
 *
 * Returns: a new #GtkApplication instance
 */
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
GtkApplication *
gtk_application_new (const gchar       *application_id,
                     GApplicationFlags  flags)
{
  g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);

  g_type_init ();

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

/**
Javier Jardón's avatar
Javier Jardón committed
724
 * gtk_application_add_window:
725 726 727 728 729
 * @application: a #GtkApplication
 * @window: a #GtkWindow
 *
 * Adds a window from @application.
 *
Javier Jardón's avatar
Javier Jardón committed
730
 * This call is equivalent to setting the #GtkWindow:application
731 732
 * property of @window to @application.
 *
733 734 735 736 737 738 739
 * 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.
 *
740 741 742 743 744 745 746 747
 * Since: 3.0
 **/
void
gtk_application_add_window (GtkApplication *application,
                            GtkWindow      *window)
{
  g_return_if_fail (GTK_IS_APPLICATION (application));

748 749 750
  if (!g_list_find (application->priv->windows, window))
    g_signal_emit (application,
                   gtk_application_signals[WINDOW_ADDED], 0, window);
751 752 753 754 755 756 757 758 759 760
}

/**
 * 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
Javier Jardón's avatar
Javier Jardón committed
761
 * setting the #GtkWindow:application property of @window to
762 763 764 765 766 767 768 769 770 771 772 773 774
 * %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));

775 776 777
  if (g_list_find (application->priv->windows, window))
    g_signal_emit (application,
                   gtk_application_signals[WINDOW_REMOVED], 0, window);
778 779 780 781 782 783
}

/**
 * gtk_application_get_windows:
 * @application: a #GtkApplication
 *
Matthias Clasen's avatar
Matthias Clasen committed
784
 * Gets a list of the #GtkWindows associated with @application.
785
 *
786
 * The list is sorted by most recently focused window, such that the first
Matthias Clasen's avatar
Matthias Clasen committed
787
 * element is the currently focused window. (Useful for choosing a parent
788 789 790 791 792
 * 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.
793
 *
794
 * Returns: (element-type GtkWindow) (transfer none): a #GList of #GtkWindow
795 796 797 798 799 800 801 802 803
 *
 * 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
804
}
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

/**
 * 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
 * gtk_accelerator_parse(), e.g. "<Primary>q" or "<Control><Alt>p".
 *
 * @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.
 *
Matthias Clasen's avatar
Matthias Clasen committed
826
 * GtkApplication also extracts accelerators out of 'accel' attributes
827 828
 * in the #GMenuModels passed to gtk_application_set_app_menu() and
 * gtk_application_set_menubar(), which is usually more convenient
Matthias Clasen's avatar
Matthias Clasen committed
829 830
 * than calling this function for each accelerator.
 *
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
 * 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;
    }

856
  accel_path = _gtk_accel_path_for_action (action_name, parameter);
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886

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

887
  accel_path = _gtk_accel_path_for_action (action_name, parameter);
888 889 890 891 892 893 894 895 896 897 898

  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);
}
899 900 901 902

/**
 * gtk_application_set_app_menu:
 * @application: a #GtkApplication
903
 * @model: (allow-none): a #GMenuModel, or %NULL
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
 *
 * Sets or unsets the application menu for @application.
 *
 * 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.
 *
 * Since: 3.4
 */
void
gtk_application_set_app_menu (GtkApplication *application,
920
                              GMenuModel     *model)
921
{
922
  g_object_set (application, "app-menu", model, NULL);
923 924 925 926 927 928 929
}

/**
 * gtk_application_get_app_menu:
 * @application: a #GtkApplication
 *
 * Returns the menu model that has been set with
930
 * gtk_application_set_app_menu().
931
 *
932
 * Returns: (transfer none): the application menu of @application
933 934 935 936 937 938
 *
 * Since: 3.4
 */
GMenuModel *
gtk_application_get_app_menu (GtkApplication *application)
{
939
  GMenuModel *app_menu = NULL;
940 941

  g_object_get (application, "app-menu", &app_menu, NULL);
942 943 944

  if (app_menu)
    g_object_unref (app_menu);
945 946 947 948 949 950 951

  return app_menu;
}

/**
 * gtk_application_set_menubar:
 * @application: a #GtkApplication
952
 * @model: (allow-none): a #GMenuModel, or %NULL
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
 *
 * Sets or unsets the menubar for windows of @application.
 *
 * This is a menubar in the traditional sense.
 *
 * 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.
 *
 * Since: 3.4
 */
void
gtk_application_set_menubar (GtkApplication *application,
970
                             GMenuModel     *model)
971
{
972
  g_object_set (application, "menubar", model, NULL);
973 974 975 976 977 978 979
}

/**
 * gtk_application_get_menubar:
 * @application: a #GtkApplication
 *
 * Returns the menu model that has been set with
980
 * gtk_application_set_menubar().
981
 *
982
 * Returns: (transfer none): the menubar for windows of @application
983 984 985 986 987 988
 *
 * Since: 3.4
 */
GMenuModel *
gtk_application_get_menubar (GtkApplication *application)
{
989
  GMenuModel *menubar = NULL;
990 991

  g_object_get (application, "menubar", &menubar, NULL);
992 993 994

  if (menubar)
    g_object_unref (menubar);
995 996 997

  return menubar;
}
998

999 1000
#if defined(GDK_WINDOWING_X11)

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 1028 1029 1030 1031 1032 1033 1034
/* 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;
}

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
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);
}
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
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");
1059 1060 1061 1062 1063
      gtk_application_quit_response (app, TRUE, NULL);
    }
  else if (strcmp (signal_name, "CancelEndSession") == 0)
    {
      g_debug ("Received CancelEndSession");
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
    }
  else if (strcmp (signal_name, "EndSession") == 0)
    {
      g_debug ("Received EndSession");
      gtk_application_quit_response (app, TRUE, NULL);
      unregister_client (app);
      g_signal_emit (app, gtk_application_signals[QUIT], 0);
    }
  else if (strcmp (signal_name, "Stop") == 0)
    {
      g_debug ("Received Stop");
      unregister_client (app);
      g_signal_emit (app, gtk_application_signals[QUIT], 0);
    }
}

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

1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
  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);
}



1171 1172
/**
 * GtkApplicationInhibitFlags:
1173 1174
 * @GTK_APPLICATION_INHIBIT_LOGOUT: Inhibit ending the user session
 *     by logging out or by shutting down the computer
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
 * @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
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
/**
 * 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
1202 1203 1204 1205
 * call g_application_uninhibit() to remove the inhibitor. Note that
 * 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
1206 1207 1208 1209 1210 1211 1212
 *
 * 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.
 *
1213
 * If @window is given, the session manager may point the user to
Matthias Clasen's avatar
Matthias Clasen committed
1214 1215 1216 1217 1218 1219 1220 1221 1222
 * this window to find out more about why the action is inhibited.
 *
 * Returns: A non-zero cookie that is used to uniquely identify this
 *     request. It should be used as an argument to g_application_uninhibit()
 *     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
 */
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
guint
gtk_application_inhibit (GtkApplication             *application,
                         GtkWindow                  *window,
                         GtkApplicationInhibitFlags  flags,
                         const gchar                *reason)
{
  GVariant *res;
  GError *error = NULL;
  guint cookie;
  guint xid;

  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)
    xid = GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (window)));
  else
    xid = 0;

  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)
    {
1256
      g_warning ("Calling Inhibit failed: %s", error->message);
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
      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
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
/**
 * gtk_application_uninhibit:
 * @application: the #GApplication
 * @cookie: a cookie that was returned by g_application_inhibit()
 *
 * Removes an inhibitor that has been established with g_application_inhibit().
 * Inhibitors are also cleared when the application exits.
 *
 * Since: 3.4
 */
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
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
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
/**
 * 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
 */
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
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)
    {
1326
      g_warning ("Calling IsInhibited failed: %s", error->message);
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
      g_error_free (error);
      return FALSE;
    }

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

  return inhibited;
}

Matthias Clasen's avatar
Matthias Clasen committed
1337
/**
1338 1339 1340 1341
 * GtkApplicationEndSessionStyle:
 * @GTK_APPLICATION_LOGOUT: End the session by logging out
 * @GTK_APPLICATION_REBOOT: Restart the computer
 * @GTK_APPLICATION_SHUTDOWN: Shut the computer down
Matthias Clasen's avatar
Matthias Clasen committed
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
 *
 * Different ways to end a user session, for use with
 * gtk_application_end_session().
 */

/**
 * gtk_application_end_session:
 * @application: the #GtkApplication
 * @style: the desired kind of session end
 * @request_confirmation: whether or not the user should get a chance
 *     to confirm the action
 *
 * Requests that the session manager end the current session.
 * @style indicates how the session should be ended, and
 * @request_confirmation indicates whether or not the user should be
1357 1358
 * given a chance to confirm the action. Both of these parameters are
 * merely hints though; the session manager may choose to ignore them.
Matthias Clasen's avatar
Matthias Clasen committed
1359 1360 1361 1362 1363 1364
 *
 * Return value: %TRUE if the request was sent; %FALSE if it could not
 *     be sent (eg, because it could not connect to the session manager)
 *
 * Since: 3.4
 */
1365
gboolean
1366 1367 1368
gtk_application_end_session (GtkApplication                *application,
                             GtkApplicationEndSessionStyle  style,
                             gboolean                       request_confirmation)
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
{
  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);

  switch (style)
    {
    case GTK_APPLICATION_LOGOUT:
      g_dbus_proxy_call (application->priv->sm_proxy,
                         "Logout",
1379
                         g_variant_new ("(u)", request_confirmation ? 0 : 1),
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
                         G_DBUS_CALL_FLAGS_NONE,
                         G_MAXINT,
                         NULL, NULL, NULL);
      break;
    case GTK_APPLICATION_REBOOT:
    case GTK_APPLICATION_SHUTDOWN:
      g_dbus_proxy_call (application->priv->sm_proxy,
                         "Shutdown",
                         NULL,
                         G_DBUS_CALL_FLAGS_NONE,
                         G_MAXINT,
                         NULL, NULL, NULL);
      break;
    }
Benjamin Otte's avatar
Benjamin Otte committed
1394 1395

  return TRUE;
1396
}
1397

1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
#elif defined(GDK_WINDOWING_QUARTZ)

/* OS X implementation copied from EggSMClient */

static pascal OSErr
quit_requested_resumed (const AppleEvent *aevt,
                        AppleEvent       *reply,
                        long              refcon)
{
  GtkApplication *app = GSIZE_TO_POINTER ((gsize)refcon);

1409
  return app->priv->quit_inhibit == 0 ? noErr : userCanceledErr;
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
}

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

  /* Resume the event with a new handler that will return
   * a value to the system
   */
  AEResumeTheCurrentEvent (&app->priv->quit_event, &app->priv->quit_reply,
                           NewAEEventHandlerUPP (quit_requested_resumed),
                           (long)GPOINTER_TO_SIZE (app));

  AEDisposeDesc (&app->quit->quit_event);
  AEDisposeDesc (&app->quit->quit_reply);

1427
  if (app->priv->quit_inhibit == 0)
1428 1429 1430 1431 1432
    g_signal_emit (app, gtk_application_signals[QUIT], 0);

  return FALSE;
}

1433 1434 1435 1436
static pascal OSErr
quit_requested (const AppleEvent *aevt,
                AppleEvent       *reply,
                long              refcon)
1437
{
1438
  GtkApplication *app = GSIZE_TO_POINTER ((gsize)refcon);
1439

1440 1441 1442 1443
  /* FIXME AEInteractWithUser? */
  AEDuplicateDesc (aevt, &app->priv->quit_event);
  AEDuplicateDesc (reply, &app->priv->quit_reply);
  AESuspendTheCurrentEvent (aevt);
1444

1445 1446
  /* Don't emit the "quit" signal immediately, since we're
   * called from a weird point in the guts of gdkeventloop-quartz.c
1447
   */
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
  g_idle_add (idle_will_quit, app);

  return noErr;
}

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

  app->priv->inhibitors = g_hash_table_new (NULL, NULL);
1462 1463 1464 1465 1466 1467 1468 1469
}

guint
gtk_application_inhibit (GtkApplication             *application,
                         GtkWindow                  *window,
                         GtkApplicationInhibitFlags  flags,
                         const gchar                *reason)
{
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
  guint cookie;

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

  application->priv->next_cookie++;
  cookie = application->priv->next_cookie;

  g_hash_table_insert (application->priv->inhibitors,
                       GUINT_TO_POINTER (cookie),
                       GUINT_TO_POINTER (flags));

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

  return cookie;
1486 1487 1488 1489 1490 1491
}

void
gtk_application_uninhibit (GtkApplication *application,
                           guint           cookie)
{
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
  GApplicationInhibitFlags flags;

  flags = GPOINTER_TO_UINT (g_hash_table_lookup (application->priv->inhibitors, GUINT_TO_POINTER (cookie)));

  if (flags == 0)
    {
      g_warning ("Invalid inhibitor cookie");
      return;
    }

  g_hash_table_remove (application->priv->inhibitors, GUINT_TO_POINTER (cookie));

  if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
    application->priv->quit_inhibit--;
1506 1507 1508 1509 1510 1511
}

gboolean
gtk_application_is_inhibited (GtkApplication             *application,
                              GtkApplicationInhibitFlags  flags)
{
1512 1513 1514
  if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
    return application->priv->quit_inhibit > 0;

1515 1516 1517 1518
  return FALSE;
}

gboolean
1519 1520 1521
gtk_application_end_session (GtkApplication                *application,
                             GtkApplicationEndSessionStyle *style,
                             gboolean                       request_confirmation)
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
{
  static const ProcessSerialNumber loginwindow_psn = { 0, kSystemProcess };
  AppleEvent event = { typeNull, NULL };
  AppleEvent reply = { typeNull, NULL };
  AEAddressDesc target;
  AEEventID id;
  OSErr err;

  switch (style)
    {
    case GTK_APPLICATION_LOGOUT:
      id = request_confirmation ? kAELogOut : kAEReallyLogOut;
      break;
    case GTK_APPLICATION_REBOOT:
      id = request_confirmation ? kAEShowRestartDialog : kAERestart;
      break;
    case GTK_APPLICATION_SHUTDOWN:
      id = request_confirmation ? kAEShowShutdownDialog : kAEShutDown;
      break;
    }

  err = AECreateDesc (typeProcessSerialNumber, &loginwindow_psn,
                      sizeof (loginwindow_psn), &target);
  if (err != noErr)
    {
      g_warning ("Could not create descriptor for loginwindow: %d", err);
      return FALSE;
    }

  err = AECreateAppleEvent (kCoreEventClass, id, &target,
                            kAutoGenerateReturnID, kAnyTransactionID,
                            &event);
  AEDisposeDesc (&target);
  if (err != noErr)
    {
      g_warning ("Could not create logout AppleEvent: %d", err);
      return FALSE;
    }

  err = AESend (&event, &reply, kAENoReply, kAENormalPriority,
                kAEDefaultTimeout, NULL, NULL);
  AEDisposeDesc (&event);
 if (err == noErr)
    AEDisposeDesc (&reply);

  return err == noErr;
}

1570 1571 1572 1573
#else

/* Trivial implementation.
 *
1574
 * For the inhibit API on Windows, see
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
 * 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;
}

gboolean
1601 1602 1603
gtk_application_end_session (GtkApplication                *application,
                             GtkApplicationEndSessionStyle  style,
                             gboolean                       request_confirmation)
1604 1605
{
  return FALSE;
1606 1607
}

1608
#endif