gtkclipboard-quartz.c 31 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Anders Carlsson's avatar
Anders Carlsson committed
2 3
 * Copyright (C) 2000 Red Hat, Inc.
 * Copyright (C) 2004 Nokia Corporation
4
 * Copyright (C) 2006-2008 Imendio AB
Anders Carlsson's avatar
Anders Carlsson committed
5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Anders Carlsson's avatar
Anders Carlsson committed
18 19 20
 *
 */

21
#include "config.h"
Anders Carlsson's avatar
Anders Carlsson committed
22 23 24 25 26 27 28 29 30 31
#include <string.h>

#import <Cocoa/Cocoa.h>

#include "gtkclipboard.h"
#include "gtkinvisible.h"
#include "gtkmain.h"
#include "gtkmarshalers.h"
#include "gtkintl.h"
#include "gtktextbuffer.h"
32
#include "gtkselectionprivate.h"
Anders Carlsson's avatar
Anders Carlsson committed
33
#include "gtkquartz.h"
34
#include "../gdk/quartz/gdkquartz.h"
Anders Carlsson's avatar
Anders Carlsson committed
35 36 37 38 39 40

enum {
  OWNER_CHANGE,
  LAST_SIGNAL
};

41 42
@interface GtkClipboardOwner : NSObject {
  GtkClipboard *clipboard;
43
  @public
44 45 46 47 48
  gboolean setting_same_owner;
}

@end

Anders Carlsson's avatar
Anders Carlsson committed
49 50
typedef struct _GtkClipboardClass GtkClipboardClass;

51
struct _GtkClipboard
Anders Carlsson's avatar
Anders Carlsson committed
52 53 54 55
{
  GObject parent_instance;

  NSPasteboard *pasteboard;
56
  GtkClipboardOwner *owner;
57
  NSInteger change_count;
Anders Carlsson's avatar
Anders Carlsson committed
58 59 60 61 62 63 64

  GdkAtom selection;

  GtkClipboardGetFunc get_func;
  GtkClipboardClearFunc clear_func;
  gpointer user_data;
  gboolean have_owner;
65
  GtkTargetList *target_list;
Anders Carlsson's avatar
Anders Carlsson committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88

  gboolean have_selection;
  GdkDisplay *display;

  GdkAtom *cached_targets;
  gint     n_cached_targets;

  guint      notify_signal_id;
  gboolean   storing_selection;
  GMainLoop *store_loop;
  guint      store_timeout;
  gint       n_storable_targets;
  GdkAtom   *storable_targets;
};

struct _GtkClipboardClass
{
  GObjectClass parent_class;

  void (*owner_change) (GtkClipboard        *clipboard,
			GdkEventOwnerChange *event);
};

89 90 91 92 93 94 95 96 97 98
static void gtk_clipboard_class_init   (GtkClipboardClass   *class);
static void gtk_clipboard_finalize     (GObject             *object);
static void gtk_clipboard_owner_change (GtkClipboard        *clipboard,
					GdkEventOwnerChange *event);

static void          clipboard_unset      (GtkClipboard     *clipboard);
static GtkClipboard *clipboard_peek       (GdkDisplay       *display,
					   GdkAtom           selection,
					   gboolean          only_if_exists);

Anders Carlsson's avatar
Anders Carlsson committed
99 100 101 102
@implementation GtkClipboardOwner
-(void)pasteboard:(NSPasteboard *)sender provideDataForType:(NSString *)type
{
  GtkSelectionData selection_data;
103
  guint info;
Anders Carlsson's avatar
Anders Carlsson committed
104

105 106 107 108 109
  if (!clipboard->target_list)
    return;

  memset (&selection_data, 0, sizeof (GtkSelectionData));

Anders Carlsson's avatar
Anders Carlsson committed
110
  selection_data.selection = clipboard->selection;
111
  selection_data.target = gdk_quartz_pasteboard_type_to_atom_libgtk_only (type);
112 113
  selection_data.display = gdk_display_get_default ();
  selection_data.length = -1;
Anders Carlsson's avatar
Anders Carlsson committed
114

115
  if (gtk_target_list_find (clipboard->target_list, selection_data.target, &info))
116 117 118 119
    {
      clipboard->get_func (clipboard, &selection_data,
                           info,
                           clipboard->user_data);
120 121 122 123

      if (selection_data.length >= 0)
        _gtk_quartz_set_selection_data_for_pasteboard (clipboard->pasteboard,
                                                       &selection_data);
Anders Carlsson's avatar
Anders Carlsson committed
124

125 126
      g_free (selection_data.data);
    }
Anders Carlsson's avatar
Anders Carlsson committed
127 128
}

129 130
/*  pasteboardChangedOwner is not called immediately, and it's not called
 *  reliably. It is somehow documented in the apple api docs, but the docs
131
 *  suck and don’t really give clear instructions. Therefore we track
132 133 134
 *  changeCount in several places below and clear the clipboard if it
 *  changed.
 */
Anders Carlsson's avatar
Anders Carlsson committed
135 136
- (void)pasteboardChangedOwner:(NSPasteboard *)sender
{
137 138
  if (! setting_same_owner)
    clipboard_unset (clipboard);
Anders Carlsson's avatar
Anders Carlsson committed
139 140 141 142 143 144
}

- (id)initWithClipboard:(GtkClipboard *)aClipboard
{
  self = [super init];

145
  if (self)
Anders Carlsson's avatar
Anders Carlsson committed
146 147
    {
      clipboard = aClipboard;
148
      setting_same_owner = FALSE;
Anders Carlsson's avatar
Anders Carlsson committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    }

  return self;
}

@end


static const gchar clipboards_owned_key[] = "gtk-clipboards-owned";
static GQuark clipboards_owned_key_id = 0;

static GObjectClass *parent_class;
static guint         clipboard_signals[LAST_SIGNAL] = { 0 };

GType
gtk_clipboard_get_type (void)
{
  static GType clipboard_type = 0;
167

Anders Carlsson's avatar
Anders Carlsson committed
168 169
  if (!clipboard_type)
    {
170
      const GTypeInfo clipboard_info =
Anders Carlsson's avatar
Anders Carlsson committed
171 172 173 174 175 176 177 178 179 180 181
      {
	sizeof (GtkClipboardClass),
	NULL,           /* base_init */
	NULL,           /* base_finalize */
	(GClassInitFunc) gtk_clipboard_class_init,
	NULL,           /* class_finalize */
	NULL,           /* class_data */
	sizeof (GtkClipboard),
	0,              /* n_preallocs */
	(GInstanceInitFunc) NULL,
      };
182

Anders Carlsson's avatar
Anders Carlsson committed
183 184 185
      clipboard_type = g_type_register_static (G_TYPE_OBJECT, I_("GtkClipboard"),
					       &clipboard_info, 0);
    }
186

Anders Carlsson's avatar
Anders Carlsson committed
187 188 189 190 191 192 193 194 195
  return clipboard_type;
}

static void
gtk_clipboard_class_init (GtkClipboardClass *class)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);

  parent_class = g_type_class_peek_parent (class);
196

Anders Carlsson's avatar
Anders Carlsson committed
197 198 199 200
  gobject_class->finalize = gtk_clipboard_finalize;

  class->owner_change = gtk_clipboard_owner_change;

201 202 203 204 205
  /**
   * GtkClipboard::owner-change:
   * @clipboard:
   * @event: (type GdkEventOwnerChange):
   */
Anders Carlsson's avatar
Anders Carlsson committed
206
  clipboard_signals[OWNER_CHANGE] =
207
    g_signal_new (I_("owner-change"),
Anders Carlsson's avatar
Anders Carlsson committed
208 209 210 211
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkClipboardClass, owner_change),
		  NULL, NULL,
212
		  NULL,
Anders Carlsson's avatar
Anders Carlsson committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
		  G_TYPE_NONE, 1,
		  GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
}

static void
gtk_clipboard_finalize (GObject *object)
{
  GtkClipboard *clipboard;
  GSList *clipboards;

  clipboard = GTK_CLIPBOARD (object);

  clipboards = g_object_get_data (G_OBJECT (clipboard->display), "gtk-clipboard-list");
  if (g_slist_index (clipboards, clipboard) >= 0)
    g_warning ("GtkClipboard prematurely finalized");

  clipboard_unset (clipboard);
230

Anders Carlsson's avatar
Anders Carlsson committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  clipboards = g_object_get_data (G_OBJECT (clipboard->display), "gtk-clipboard-list");
  clipboards = g_slist_remove (clipboards, clipboard);
  g_object_set_data (G_OBJECT (clipboard->display), I_("gtk-clipboard-list"), clipboards);

  if (clipboard->store_loop && g_main_loop_is_running (clipboard->store_loop))
    g_main_loop_quit (clipboard->store_loop);

  if (clipboard->store_timeout != 0)
    g_source_remove (clipboard->store_timeout);

  g_free (clipboard->storable_targets);

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

static void
clipboard_display_closed (GdkDisplay   *display,
			  gboolean      is_error,
			  GtkClipboard *clipboard)
{
  GSList *clipboards;

  clipboards = g_object_get_data (G_OBJECT (display), "gtk-clipboard-list");
  g_object_run_dispose (G_OBJECT (clipboard));
  clipboards = g_slist_remove (clipboards, clipboard);
  g_object_set_data (G_OBJECT (display), I_("gtk-clipboard-list"), clipboards);
  g_object_unref (clipboard);
}

260 261 262 263 264 265 266
/**
 * gtk_clipboard_get_for_display:
 * @display:
 * @selection:
 *
 * Returns: (transfer none):
 */
Anders Carlsson's avatar
Anders Carlsson committed
267
GtkClipboard *
268
gtk_clipboard_get_for_display (GdkDisplay *display,
Anders Carlsson's avatar
Anders Carlsson committed
269 270 271
			       GdkAtom     selection)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
272
  g_return_val_if_fail (!gdk_display_is_closed (display), NULL);
Anders Carlsson's avatar
Anders Carlsson committed
273 274 275 276

  return clipboard_peek (display, selection, FALSE);
}

277 278 279 280 281 282
/**
 * gtk_clipboard_get:
 * @selection:
 *
 * Returns: (transfer none):
 */
Anders Carlsson's avatar
Anders Carlsson committed
283 284 285 286 287 288
GtkClipboard *
gtk_clipboard_get (GdkAtom selection)
{
  return gtk_clipboard_get_for_display (gdk_display_get_default (), selection);
}

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
/**
 * gtk_clipboard_get_default:
 * @display: the #GdkDisplay for which the clipboard is to be retrieved.
 *
 * Returns the default clipboard object for use with cut/copy/paste menu items
 * and keyboard shortcuts.
 *
 * Return value: (transfer none): the default clipboard object.
 *
 * Since: 3.16
 **/
GtkClipboard *
gtk_clipboard_get_default (GdkDisplay *display)
{
  g_return_val_if_fail (display != NULL, NULL);
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  return gtk_clipboard_get_for_display (display, GDK_SELECTION_CLIPBOARD);
}

Anders Carlsson's avatar
Anders Carlsson committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
static void
clipboard_owner_destroyed (gpointer data)
{
  GSList *clipboards = data;
  GSList *tmp_list;

  tmp_list = clipboards;
  while (tmp_list)
    {
      GtkClipboard *clipboard = tmp_list->data;

      clipboard->get_func = NULL;
      clipboard->clear_func = NULL;
      clipboard->user_data = NULL;
      clipboard->have_owner = FALSE;

325 326 327 328 329 330
      if (clipboard->target_list)
        {
          gtk_target_list_unref (clipboard->target_list);
          clipboard->target_list = NULL;
        }

Anders Carlsson's avatar
Anders Carlsson committed
331 332 333 334
      gtk_clipboard_clear (clipboard);

      tmp_list = tmp_list->next;
    }
335

Anders Carlsson's avatar
Anders Carlsson committed
336 337 338 339 340 341 342 343
  g_slist_free (clipboards);
}

static void
clipboard_add_owner_notify (GtkClipboard *clipboard)
{
  if (!clipboards_owned_key_id)
    clipboards_owned_key_id = g_quark_from_static_string (clipboards_owned_key);
344

Anders Carlsson's avatar
Anders Carlsson committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
  if (clipboard->have_owner)
    g_object_set_qdata_full (clipboard->user_data, clipboards_owned_key_id,
			     g_slist_prepend (g_object_steal_qdata (clipboard->user_data,
								    clipboards_owned_key_id),
					      clipboard),
			     clipboard_owner_destroyed);
}

static void
clipboard_remove_owner_notify (GtkClipboard *clipboard)
{
  if (clipboard->have_owner)
     g_object_set_qdata_full (clipboard->user_data, clipboards_owned_key_id,
			      g_slist_remove (g_object_steal_qdata (clipboard->user_data,
								    clipboards_owned_key_id),
					      clipboard),
			      clipboard_owner_destroyed);
}

static gboolean
gtk_clipboard_set_contents (GtkClipboard         *clipboard,
			    const GtkTargetEntry *targets,
			    guint                 n_targets,
			    GtkClipboardGetFunc   get_func,
			    GtkClipboardClearFunc clear_func,
			    gpointer              user_data,
			    gboolean              have_owner)
{
  GtkClipboardOwner *owner;
374
  NSSet *types;
Richard Hult's avatar
Richard Hult committed
375 376
  NSAutoreleasePool *pool;

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
  if (!(clipboard->have_owner && have_owner) ||
      clipboard->user_data != user_data)
    {
      clipboard_unset (clipboard);

      if (clipboard->get_func)
        {
          /* Calling unset() caused the clipboard contents to be reset!
           * Avoid leaking and return
           */
          if (!(clipboard->have_owner && have_owner) ||
              clipboard->user_data != user_data)
            {
              (*clear_func) (clipboard, user_data);
              return FALSE;
            }
          else
394 395 396
            {
              return TRUE;
            }
397 398 399
        }
    }

400 401 402 403
  pool = [[NSAutoreleasePool alloc] init];

  types = _gtk_quartz_target_entries_to_pasteboard_types (targets, n_targets);

404 405 406
  /*  call declareTypes before setting the clipboard members because
   *  declareTypes might clear the clipboard
   */
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
  if (user_data && user_data == clipboard->user_data)
    {
      owner = [clipboard->owner retain];

      owner->setting_same_owner = TRUE;
      clipboard->change_count = [clipboard->pasteboard declareTypes: [types allObjects]
                                                              owner: owner];
      owner->setting_same_owner = FALSE;
    }
  else
    {
      owner = [[GtkClipboardOwner alloc] initWithClipboard:clipboard];

      clipboard->change_count = [clipboard->pasteboard declareTypes: [types allObjects]
                                                              owner: owner];
    }

  [owner release];
425 426 427
  [types release];
  [pool release];

428
  clipboard->owner = owner;
Anders Carlsson's avatar
Anders Carlsson committed
429 430 431 432 433 434 435
  clipboard->user_data = user_data;
  clipboard->have_owner = have_owner;
  if (have_owner)
    clipboard_add_owner_notify (clipboard);
  clipboard->get_func = get_func;
  clipboard->clear_func = clear_func;

436 437 438 439 440
  if (clipboard->target_list)
    gtk_target_list_unref (clipboard->target_list);
  clipboard->target_list = gtk_target_list_new (targets, n_targets);

  return TRUE;
Anders Carlsson's avatar
Anders Carlsson committed
441 442
}

443 444 445 446 447 448 449 450 451
/**
 * gtk_clipboard_set_with_data: (skip)
 * @clipboard:
 * @targets: (array length=n_targets):
 * @n_targets:
 * @get_func: (scope async):
 * @clear_func: (scope async):
 * @user_data:
 */
Anders Carlsson's avatar
Anders Carlsson committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
gboolean
gtk_clipboard_set_with_data (GtkClipboard          *clipboard,
			     const GtkTargetEntry  *targets,
			     guint                  n_targets,
			     GtkClipboardGetFunc    get_func,
			     GtkClipboardClearFunc  clear_func,
			     gpointer               user_data)
{
  g_return_val_if_fail (clipboard != NULL, FALSE);
  g_return_val_if_fail (targets != NULL, FALSE);
  g_return_val_if_fail (get_func != NULL, FALSE);

  return gtk_clipboard_set_contents (clipboard, targets, n_targets,
				     get_func, clear_func, user_data,
				     FALSE);
}

469 470 471 472 473 474 475 476
/**
 * gtk_clipboard_set_with_owner: (skip)
 * @clipboard:
 * @targets: (array length=n_targets):
 * @get_func: (scope async):
 * @clear_func: (scope async):
 * @owner:
 */
Anders Carlsson's avatar
Anders Carlsson committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
gboolean
gtk_clipboard_set_with_owner (GtkClipboard          *clipboard,
			      const GtkTargetEntry  *targets,
			      guint                  n_targets,
			      GtkClipboardGetFunc    get_func,
			      GtkClipboardClearFunc  clear_func,
			      GObject               *owner)
{
  g_return_val_if_fail (clipboard != NULL, FALSE);
  g_return_val_if_fail (targets != NULL, FALSE);
  g_return_val_if_fail (get_func != NULL, FALSE);
  g_return_val_if_fail (G_IS_OBJECT (owner), FALSE);

  return gtk_clipboard_set_contents (clipboard, targets, n_targets,
				     get_func, clear_func, owner,
				     TRUE);
}

495 496 497 498 499 500
/**
 * gtk_clipboard_get_owner:
 * @clipboard:
 *
 * Returns: (transfer none):
 */
Anders Carlsson's avatar
Anders Carlsson committed
501 502 503 504 505
GObject *
gtk_clipboard_get_owner (GtkClipboard *clipboard)
{
  g_return_val_if_fail (clipboard != NULL, NULL);

506 507 508 509 510 511
  if (clipboard->change_count < [clipboard->pasteboard changeCount])
    {
      clipboard_unset (clipboard);
      clipboard->change_count = [clipboard->pasteboard changeCount];
    }

Anders Carlsson's avatar
Anders Carlsson committed
512 513 514 515 516 517 518 519 520 521 522 523 524
  if (clipboard->have_owner)
    return clipboard->user_data;
  else
    return NULL;
}

static void
clipboard_unset (GtkClipboard *clipboard)
{
  GtkClipboardClearFunc old_clear_func;
  gpointer old_data;
  gboolean old_have_owner;
  gint old_n_storable_targets;
525

Anders Carlsson's avatar
Anders Carlsson committed
526 527 528 529
  old_clear_func = clipboard->clear_func;
  old_data = clipboard->user_data;
  old_have_owner = clipboard->have_owner;
  old_n_storable_targets = clipboard->n_storable_targets;
530

Anders Carlsson's avatar
Anders Carlsson committed
531 532
  if (old_have_owner)
    {
533
      clipboard_remove_owner_notify (clipboard);
Anders Carlsson's avatar
Anders Carlsson committed
534 535 536 537 538 539
      clipboard->have_owner = FALSE;
    }

  clipboard->n_storable_targets = -1;
  g_free (clipboard->storable_targets);
  clipboard->storable_targets = NULL;
540 541

  clipboard->owner = NULL;
Anders Carlsson's avatar
Anders Carlsson committed
542 543 544
  clipboard->get_func = NULL;
  clipboard->clear_func = NULL;
  clipboard->user_data = NULL;
545

Anders Carlsson's avatar
Anders Carlsson committed
546 547 548
  if (old_clear_func)
    old_clear_func (clipboard, old_data);

549 550 551 552 553 554
  if (clipboard->target_list)
    {
      gtk_target_list_unref (clipboard->target_list);
      clipboard->target_list = NULL;
    }

Anders Carlsson's avatar
Anders Carlsson committed
555 556 557 558 559 560 561 562 563 564 565
  /* If we've transferred the clipboard data to the manager,
   * unref the owner
   */
  if (old_have_owner &&
      old_n_storable_targets != -1)
    g_object_unref (old_data);
}

void
gtk_clipboard_clear (GtkClipboard *clipboard)
{
566 567
  clipboard_unset (clipboard);

Anders Carlsson's avatar
Anders Carlsson committed
568 569 570
  [clipboard->pasteboard declareTypes:nil owner:nil];
}

571
static void
Anders Carlsson's avatar
Anders Carlsson committed
572 573 574 575 576 577 578 579
text_get_func (GtkClipboard     *clipboard,
	       GtkSelectionData *selection_data,
	       guint             info,
	       gpointer          data)
{
  gtk_selection_data_set_text (selection_data, data, -1);
}

580
static void
Anders Carlsson's avatar
Anders Carlsson committed
581 582 583 584 585 586
text_clear_func (GtkClipboard *clipboard,
		 gpointer      data)
{
  g_free (data);
}

587
void
Anders Carlsson's avatar
Anders Carlsson committed
588 589 590 591 592 593 594 595
gtk_clipboard_set_text (GtkClipboard *clipboard,
			const gchar  *text,
			gint          len)
{
  GtkTargetEntry target = { "UTF8_STRING", 0, 0 };

  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (text != NULL);
596

Anders Carlsson's avatar
Anders Carlsson committed
597 598
  if (len < 0)
    len = strlen (text);
599 600

  gtk_clipboard_set_with_data (clipboard,
Anders Carlsson's avatar
Anders Carlsson committed
601 602 603 604 605 606 607
			       &target, 1,
			       text_get_func, text_clear_func,
			       g_strndup (text, len));
  gtk_clipboard_set_can_store (clipboard, NULL, 0);
}


608
static void
Anders Carlsson's avatar
Anders Carlsson committed
609 610 611 612 613 614 615 616
pixbuf_get_func (GtkClipboard     *clipboard,
		 GtkSelectionData *selection_data,
		 guint             info,
		 gpointer          data)
{
  gtk_selection_data_set_pixbuf (selection_data, data);
}

617
static void
Anders Carlsson's avatar
Anders Carlsson committed
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 644 645 646
pixbuf_clear_func (GtkClipboard *clipboard,
		   gpointer      data)
{
  g_object_unref (data);
}

void
gtk_clipboard_set_image (GtkClipboard *clipboard,
			 GdkPixbuf    *pixbuf)
{
  GtkTargetList *list;
  GList *l;
  GtkTargetEntry *targets;
  gint n_targets, i;

  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (GDK_IS_PIXBUF (pixbuf));

  list = gtk_target_list_new (NULL, 0);
  gtk_target_list_add_image_targets (list, 0, TRUE);

  n_targets = g_list_length (list->list);
  targets = g_new0 (GtkTargetEntry, n_targets);
  for (l = list->list, i = 0; l; l = l->next, i++)
    {
      GtkTargetPair *pair = (GtkTargetPair *)l->data;
      targets[i].target = gdk_atom_name (pair->target);
    }

647
  gtk_clipboard_set_with_data (clipboard,
Anders Carlsson's avatar
Anders Carlsson committed
648 649 650 651 652 653 654 655 656 657 658
			       targets, n_targets,
			       pixbuf_get_func, pixbuf_clear_func,
			       g_object_ref (pixbuf));
  gtk_clipboard_set_can_store (clipboard, NULL, 0);

  for (i = 0; i < n_targets; i++)
    g_free (targets[i].target);
  g_free (targets);
  gtk_target_list_unref (list);
}

659 660 661 662 663 664 665
/**
 * gtk_clipboard_request_contents:
 * @clipboard:
 * @target:
 * @callback: (scope async):
 * @user_data:
 */
666
void
Anders Carlsson's avatar
Anders Carlsson committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680
gtk_clipboard_request_contents (GtkClipboard            *clipboard,
				GdkAtom                  target,
				GtkClipboardReceivedFunc callback,
				gpointer                 user_data)
{
  GtkSelectionData *data;

  data = gtk_clipboard_wait_for_contents (clipboard, target);

  callback (clipboard, data, user_data);

  gtk_selection_data_free (data);
}

681 682 683 684 685 686
/**
 * gtk_clipboard_request_text:
 * @clipboard:
 * @callback: (scope async):
 * @user_data:
 */
687
void
Anders Carlsson's avatar
Anders Carlsson committed
688 689 690 691 692 693 694 695 696 697 698
gtk_clipboard_request_text (GtkClipboard                *clipboard,
			    GtkClipboardTextReceivedFunc callback,
			    gpointer                     user_data)
{
  gchar *data = gtk_clipboard_wait_for_text (clipboard);

  callback (clipboard, data, user_data);

  g_free (data);
}

699 700 701 702 703 704 705
/**
 * gtk_clipboard_request_rich_text:
 * @clipboard:
 * @buffer:
 * @callback: (scope async):
 * @user_data:
 */
Anders Carlsson's avatar
Anders Carlsson committed
706 707 708 709 710 711 712 713 714
void
gtk_clipboard_request_rich_text (GtkClipboard                    *clipboard,
                                 GtkTextBuffer                   *buffer,
                                 GtkClipboardRichTextReceivedFunc callback,
                                 gpointer                         user_data)
{
  /* FIXME: Implement */
}

715

716 717 718 719 720 721 722 723 724
/**
 * gtk_clipboard_wait_for_rich_text:
 * @clipboard:
 * @buffer:
 * @format: (out):
 * @length: (out):
 *
 * Returns: (nullable):
 */
725 726 727 728 729 730 731 732 733 734
guint8 *
gtk_clipboard_wait_for_rich_text (GtkClipboard  *clipboard,
                                  GtkTextBuffer *buffer,
                                  GdkAtom       *format,
                                  gsize         *length)
{
  /* FIXME: Implement */
  return NULL;
}

735 736 737 738 739 740
/**
 * gtk_clipboard_request_image:
 * @clipboard:
 * @callback: (scope async):
 * @user_data:
 */
741
void
Anders Carlsson's avatar
Anders Carlsson committed
742 743 744 745 746 747 748 749 750 751 752 753
gtk_clipboard_request_image (GtkClipboard                  *clipboard,
			     GtkClipboardImageReceivedFunc  callback,
			     gpointer                       user_data)
{
  GdkPixbuf *pixbuf = gtk_clipboard_wait_for_image (clipboard);

  callback (clipboard, pixbuf, user_data);

  if (pixbuf)
    g_object_unref (pixbuf);
}

754 755 756 757 758 759
/**
 * gtk_clipboard_request_uris:
 * @clipboard:
 * @callback: (scope async):
 * @user_data:
 */
760
void
761 762 763 764 765 766 767 768 769 770 771
gtk_clipboard_request_uris (GtkClipboard                *clipboard,
			    GtkClipboardURIReceivedFunc  callback,
			    gpointer                     user_data)
{
  gchar **uris = gtk_clipboard_wait_for_uris (clipboard);

  callback (clipboard, uris, user_data);

  g_strfreev (uris);
}

772 773 774 775 776 777
/**
 * gtk_clipboard_request_targets:
 * @clipboard:
 * @callback: (scope async):
 * @user_data:
 */
778
void
Anders Carlsson's avatar
Anders Carlsson committed
779 780 781 782 783 784 785 786 787 788 789 790
gtk_clipboard_request_targets (GtkClipboard                *clipboard,
			       GtkClipboardTargetsReceivedFunc callback,
			       gpointer                     user_data)
{
  GdkAtom *targets;
  gint n_targets;

  gtk_clipboard_wait_for_targets (clipboard, &targets, &n_targets);

  callback (clipboard, targets, n_targets, user_data);
}

791 792 793 794 795 796 797
/**
 * gtk_clipboard_wait_for_contents:
 * @clipboard:
 * @target:
 *
 * Returns: (nullable):
 */
Anders Carlsson's avatar
Anders Carlsson committed
798 799 800 801 802 803 804
GtkSelectionData *
gtk_clipboard_wait_for_contents (GtkClipboard *clipboard,
				 GdkAtom       target)
{
  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
  GtkSelectionData *selection_data = NULL;

805 806 807 808 809 810
  if (clipboard->change_count < [clipboard->pasteboard changeCount])
    {
      clipboard_unset (clipboard);
      clipboard->change_count = [clipboard->pasteboard changeCount];
    }

811
  if (target == gdk_atom_intern_static_string ("TARGETS"))
Anders Carlsson's avatar
Anders Carlsson committed
812 813
    {
      NSArray *types = [clipboard->pasteboard types];
814
      int i, length;
Anders Carlsson's avatar
Anders Carlsson committed
815 816 817
      GList *atom_list, *l;
      GdkAtom *atoms;

818
      length = [types count] * sizeof (GdkAtom);
819

820
      selection_data = g_slice_new0 (GtkSelectionData);
Anders Carlsson's avatar
Anders Carlsson committed
821 822
      selection_data->selection = clipboard->selection;
      selection_data->target = target;
823 824
      if (!selection_data->display)
	selection_data->display = gdk_display_get_default ();
Anders Carlsson's avatar
Anders Carlsson committed
825

826 827 828
      atoms = g_malloc (length);

      atom_list = _gtk_quartz_pasteboard_types_to_atom_list (types);
Anders Carlsson's avatar
Anders Carlsson committed
829 830
      for (l = atom_list, i = 0; l ; l = l->next, i++)
	atoms[i] = GDK_POINTER_TO_ATOM (l->data);
831
      g_list_free (atom_list);
Anders Carlsson's avatar
Anders Carlsson committed
832

833 834 835
      gtk_selection_data_set (selection_data,
                              GDK_SELECTION_TYPE_ATOM, 32,
                              (guchar *)atoms, length);
Anders Carlsson's avatar
Anders Carlsson committed
836 837 838 839 840 841 842 843 844 845 846

      [pool release];

      return selection_data;
    }

  selection_data = _gtk_quartz_get_selection_data_from_pasteboard (clipboard->pasteboard,
								   target,
								   clipboard->selection);

  [pool release];
847

Anders Carlsson's avatar
Anders Carlsson committed
848 849 850
  return selection_data;
}

851 852 853 854 855 856 857
/**
 * gtk_clipboard_wait_for_text:
 * @clipboard:
 * @target:
 *
 * Returns: (nullable):
 */
Anders Carlsson's avatar
Anders Carlsson committed
858 859 860 861 862 863
gchar *
gtk_clipboard_wait_for_text (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gchar *result;

864
  data = gtk_clipboard_wait_for_contents (clipboard,
Anders Carlsson's avatar
Anders Carlsson committed
865 866 867 868 869 870 871 872 873
					  gdk_atom_intern_static_string ("UTF8_STRING"));

  result = (gchar *)gtk_selection_data_get_text (data);

  gtk_selection_data_free (data);

  return result;
}

874 875 876 877 878 879
/**
 * gtk_clipboard_wait_for_image:
 * @clipboard:
 *
 * Returns: (nullable) (transfer full):
 */
Anders Carlsson's avatar
Anders Carlsson committed
880 881 882
GdkPixbuf *
gtk_clipboard_wait_for_image (GtkClipboard *clipboard)
{
John Ralls's avatar
John Ralls committed
883
  GdkAtom target = gdk_atom_intern_static_string("image/tiff");
Anders Carlsson's avatar
Anders Carlsson committed
884 885 886
  int i;
  GtkSelectionData *data;

887
  data = gtk_clipboard_wait_for_contents (clipboard, target);
Anders Carlsson's avatar
Anders Carlsson committed
888

889 890 891 892 893 894
  if (data && data->data)
    {
      GdkPixbuf *pixbuf = gtk_selection_data_get_pixbuf (data);
      gtk_selection_data_free (data);
      return pixbuf;
    }
Anders Carlsson's avatar
Anders Carlsson committed
895 896 897 898

  return NULL;
}

899 900 901 902 903 904
/**
 * gtk_clipboard_wait_for_uris:
 * @clipboard:
 *
 * Returns: (nullable) (array zero-terminated=1):
 */
905 906 907 908 909 910 911 912 913 914 915 916 917 918
gchar **
gtk_clipboard_wait_for_uris (GtkClipboard *clipboard)
{
  GtkSelectionData *data;

  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("text/uri-list"));
  if (data)
    {
      gchar **uris;

      uris = gtk_selection_data_get_uris (data);
      gtk_selection_data_free (data);

      return uris;
919
    }
920 921 922 923

  return NULL;
}

924 925 926 927 928 929
/**
 * gtk_clipboard_get_display:
 * @clipboard:
 *
 * Returns: (transfer none):
 */
Anders Carlsson's avatar
Anders Carlsson committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
GdkDisplay *
gtk_clipboard_get_display (GtkClipboard *clipboard)
{
  g_return_val_if_fail (clipboard != NULL, NULL);

  return clipboard->display;
}

gboolean
gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"));
  if (data)
    {
      result = gtk_selection_data_targets_include_text (data);
      gtk_selection_data_free (data);
    }

  return result;
}

gboolean
gtk_clipboard_wait_is_rich_text_available (GtkClipboard  *clipboard,
                                           GtkTextBuffer *buffer)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

  g_return_val_if_fail (GTK_IS_CLIPBOARD (clipboard), FALSE);
  g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);

  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"));
  if (data)
    {
      result = gtk_selection_data_targets_include_rich_text (data, buffer);
      gtk_selection_data_free (data);
    }

  return result;
}

gboolean
gtk_clipboard_wait_is_image_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

980
  data = gtk_clipboard_wait_for_contents (clipboard,
Anders Carlsson's avatar
Anders Carlsson committed
981 982 983 984 985 986 987 988 989 990
					  gdk_atom_intern_static_string ("TARGETS"));
  if (data)
    {
      result = gtk_selection_data_targets_include_image (data, FALSE);
      gtk_selection_data_free (data);
    }

  return result;
}

991 992 993 994 995 996
gboolean
gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

997
  data = gtk_clipboard_wait_for_contents (clipboard,
998 999 1000 1001 1002 1003 1004 1005 1006 1007
					  gdk_atom_intern_static_string ("TARGETS"));
  if (data)
    {
      result = gtk_selection_data_targets_include_uri (data);
      gtk_selection_data_free (data);
    }

  return result;
}

1008 1009 1010 1011 1012 1013
/**
 * gtk_clipboard_wait_for_targets:
 * @clipboard:
 * @targets: (out) (array length=n_targets):
 * @n_targets: (out):
 */
Anders Carlsson's avatar
Anders Carlsson committed
1014
gboolean
1015
gtk_clipboard_wait_for_targets (GtkClipboard  *clipboard,
Anders Carlsson's avatar
Anders Carlsson committed
1016 1017 1018 1019 1020
				GdkAtom      **targets,
				gint          *n_targets)
{
  GtkSelectionData *data;
  gboolean result = FALSE;
1021

Anders Carlsson's avatar
Anders Carlsson committed
1022 1023 1024 1025 1026 1027 1028 1029
  g_return_val_if_fail (clipboard != NULL, FALSE);

  /* If the display supports change notification we cache targets */
  if (gdk_display_supports_selection_notification (gtk_clipboard_get_display (clipboard)) &&
      clipboard->n_cached_targets != -1)
    {
      if (n_targets)
 	*n_targets = clipboard->n_cached_targets;
1030

Anders Carlsson's avatar
Anders Carlsson committed
1031 1032 1033 1034 1035 1036
      if (targets)
 	*targets = g_memdup (clipboard->cached_targets,
 			     clipboard->n_cached_targets * sizeof (GdkAtom));

       return TRUE;
    }
1037

Anders Carlsson's avatar
Anders Carlsson committed
1038 1039
  if (n_targets)
    *n_targets = 0;
1040

Anders Carlsson's avatar
Anders Carlsson committed
1041
  if (targets)
1042
    *targets = NULL;
Anders Carlsson's avatar
Anders Carlsson committed
1043 1044 1045 1046 1047 1048 1049

  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"));

  if (data)
    {
      GdkAtom *tmp_targets;
      gint tmp_n_targets;
1050

Anders Carlsson's avatar
Anders Carlsson committed
1051
      result = gtk_selection_data_get_targets (data, &tmp_targets, &tmp_n_targets);
1052

Anders Carlsson's avatar
Anders Carlsson committed
1053 1054 1055 1056 1057 1058
      if (gdk_display_supports_selection_notification (gtk_clipboard_get_display (clipboard)))
 	{
 	  clipboard->n_cached_targets = tmp_n_targets;
 	  clipboard->cached_targets = g_memdup (tmp_targets,
 						tmp_n_targets * sizeof (GdkAtom));
 	}
1059

Anders Carlsson's avatar
Anders Carlsson committed
1060 1061
      if (n_targets)
 	*n_targets = tmp_n_targets;
1062

Anders Carlsson's avatar
Anders Carlsson committed
1063 1064 1065 1066
      if (targets)
 	*targets = tmp_targets;
      else
 	g_free (tmp_targets);
1067

Anders Carlsson's avatar
Anders Carlsson committed
1068 1069 1070 1071 1072 1073 1074
      gtk_selection_data_free (data);
    }

  return result;
}

static GtkClipboard *
1075
clipboard_peek (GdkDisplay *display,
Anders Carlsson's avatar
Anders Carlsson committed
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
		GdkAtom     selection,
		gboolean    only_if_exists)
{
  GtkClipboard *clipboard = NULL;
  GSList *clipboards;
  GSList *tmp_list;

  if (selection == GDK_NONE)
    selection = GDK_SELECTION_CLIPBOARD;

  clipboards = g_object_get_data (G_OBJECT (display), "gtk-clipboard-list");

  tmp_list = clipboards;
  while (tmp_list)
    {
      clipboard = tmp_list->data;
      if (clipboard->selection == selection)
	break;

      tmp_list = tmp_list->next;
    }

  if (!tmp_list && !only_if_exists)
    {
      NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
      NSString *pasteboard_name;
      clipboard = g_object_new (GTK_TYPE_CLIPBOARD, NULL);

1104
      if (selection == GDK_SELECTION_CLIPBOARD)
Anders Carlsson's avatar
Anders Carlsson committed
1105
	pasteboard_name = NSGeneralPboard;
1106
      else
Anders Carlsson's avatar
Anders Carlsson committed
1107 1108 1109
	{
	  char *atom_string = gdk_atom_name (selection);

1110
	  pasteboard_name = [NSString stringWithFormat:@"_GTK_%@",
Anders Carlsson's avatar
Anders Carlsson committed
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
			     [NSString stringWithUTF8String:atom_string]];
	  g_free (atom_string);
	}

      clipboard->pasteboard = [NSPasteboard pasteboardWithName:pasteboard_name];

      [pool release];

      clipboard->selection = selection;
      clipboard->display = display;
      clipboard->n_cached_targets = -1;
      clipboard->n_storable_targets = -1;
      clipboards = g_slist_prepend (clipboards, clipboard);
      g_object_set_data (G_OBJECT (display), I_("gtk-clipboard-list"), clipboards);
      g_signal_connect (display, "closed",
			G_CALLBACK (clipboard_display_closed), clipboard);
      gdk_display_request_selection_notification (display, selection);
    }
1129

Anders Carlsson's avatar
Anders Carlsson committed
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
  return clipboard;
}

static void
gtk_clipboard_owner_change (GtkClipboard        *clipboard,
			    GdkEventOwnerChange *event)
{
  if (clipboard->n_cached_targets != -1)
    {
      clipboard->n_cached_targets = -1;
      g_free (clipboard->cached_targets);
    }
}

gboolean
gtk_clipboard_wait_is_target_available (GtkClipboard *clipboard,
					GdkAtom       target)
{
  GdkAtom *targets;
  gint i, n_targets;
  gboolean retval = FALSE;
1151

Anders Carlsson's avatar
Anders Carlsson committed
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
  if (!gtk_clipboard_wait_for_targets (clipboard, &targets, &n_targets))
    return FALSE;

  for (i = 0; i < n_targets; i++)
    {
      if (targets[i] == target)
	{
	  retval = TRUE;
	  break;
	}
    }

  g_free (targets);
1165

Anders Carlsson's avatar
Anders Carlsson committed
1166 1167 1168
  return retval;
}

1169
void
Anders Carlsson's avatar
Anders Carlsson committed
1170 1171 1172 1173
_gtk_clipboard_handle_event (GdkEventOwnerChange *event)
{
}

1174 1175 1176 1177 1178 1179
/**
 * gtk_clipboard_set_can_store:
 * @clipboard:
 * @targets: (allow-none) (array length=n_targets):
 * @n_targets:
 */
Anders Carlsson's avatar
Anders Carlsson committed
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
void
gtk_clipboard_set_can_store (GtkClipboard         *clipboard,
 			     const GtkTargetEntry *targets,
 			     gint                  n_targets)
{
  /* FIXME: Implement */
}

void
gtk_clipboard_store (GtkClipboard *clipboard)
{
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 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
  int i;
  int n_targets = 0;
  GtkTargetEntry *targets;

  g_return_if_fail (GTK_IS_CLIPBOARD (clipboard));

  if (!clipboard->target_list || !clipboard->get_func)
    return;

  /* We simply store all targets into the OS X clipboard. We should be
   * using the functions gdk_display_supports_clipboard_persistence() and
   * gdk_display_store_clipboard(), but since for OS X the clipboard support
   * was implemented in GTK+ and not through GdkSelections, we do it this
   * way. Doing this properly could be worthwhile to implement in the future.
   */

  targets = gtk_target_table_new_from_list (clipboard->target_list,
                                            &n_targets);
  for (i = 0; i < n_targets; i++)
    {
      GtkSelectionData selection_data;

      /* in each loop iteration, check if the content is still
       * there, because calling get_func() can do anything to
       * the clipboard
       */
      if (!clipboard->target_list || !clipboard->get_func)
        break;

      memset (&selection_data, 0, sizeof (GtkSelectionData));

      selection_data.selection = clipboard->selection;
      selection_data.target = gdk_atom_intern_static_string (targets[i].target);
      selection_data.display = gdk_display_get_default ();
      selection_data.length = -1;

      clipboard->get_func (clipboard, &selection_data,
                           targets[i].info, clipboard->user_data);

      if (selection_data.length >= 0)
        _gtk_quartz_set_selection_data_for_pasteboard (clipboard->pasteboard,
                                                       &selection_data);

      g_free (selection_data.data);
    }

  if (targets)
    gtk_target_table_free (targets, n_targets);
Anders Carlsson's avatar
Anders Carlsson committed
1239 1240 1241 1242 1243
}

void
_gtk_clipboard_store_all (void)
{
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
  GtkClipboard *clipboard;
  GSList *displays, *list;

  displays = gdk_display_manager_list_displays (gdk_display_manager_get ());

  list = displays;
  while (list)
    {
      GdkDisplay *display = list->data;

      clipboard = clipboard_peek (display, GDK_SELECTION_CLIPBOARD, TRUE);

      if (clipboard)
        gtk_clipboard_store (clipboard);

      list = list->next;
    }
Anders Carlsson's avatar
Anders Carlsson committed
1261
}
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275

/**
 * gtk_clipboard_get_selection:
 * @clipboard:
 *
 * Since: 3.22
 */
GdkAtom
gtk_clipboard_get_selection (GtkClipboard *clipboard)
{
  g_return_val_if_fail (GTK_IS_CLIPBOARD (clipboard), GDK_NONE);

  return clipboard->selection;
}