gtkclipboard.c 66.1 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2
 * Copyright (C) 2000 Red Hat, Inc.
3
 * Copyright (C) 2004 Nokia Corporation
4 5 6 7 8 9 10 11 12 13 14 15
 *
 * 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
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 18 19 20
 *
 * Global clipboard abstraction. 
 */

21
#include "config.h"
22 23 24
#include <string.h>

#include "gtkclipboard.h"
25
#include "gtkclipboardprivate.h"
26 27
#include "gtkinvisible.h"
#include "gtkmain.h"
28
#include "gtkmarshalers.h"
29
#include "gtktextbufferrichtext.h"
30
#include "gtkintl.h"
31 32 33 34 35

#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
#endif

36 37 38 39
#ifdef GDK_WINDOWING_BROADWAY
#include "broadway/gdkbroadway.h"
#endif

40 41 42 43
#ifdef GDK_WINDOWING_WIN32
#include "win32/gdkwin32.h"
#endif

44 45 46 47 48

/**
 * SECTION:gtkclipboard
 * @Short_description: Storing data on clipboards
 * @Title: Clipboards
49
 * @See_also: #GtkSelectionData
50 51 52 53 54 55
 *
 * The #GtkClipboard object represents a clipboard of data shared
 * between different processes or between different widgets in
 * the same process. Each clipboard is identified by a name encoded as a
 * #GdkAtom. (Conversion to and from strings can be done with
 * gdk_atom_intern() and gdk_atom_name().) The default clipboard
56 57
 * corresponds to the “CLIPBOARD” atom; another commonly used clipboard
 * is the “PRIMARY” clipboard, which, in X, traditionally contains
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
 * the currently selected text.
 *
 * To support having a number of different formats on the clipboard
 * at the same time, the clipboard mechanism allows providing
 * callbacks instead of the actual data.  When you set the contents
 * of the clipboard, you can either supply the data directly (via
 * functions like gtk_clipboard_set_text()), or you can supply a
 * callback to be called at a later time when the data is needed (via
 * gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().)
 * Providing a callback also avoids having to make copies of the data
 * when it is not needed.
 *
 * gtk_clipboard_set_with_data() and gtk_clipboard_set_with_owner()
 * are quite similar; the choice between the two depends mostly on
 * which is more convenient in a particular situation.
 * The former is most useful when you want to have a blob of data
 * with callbacks to convert it into the various data types that you
 * advertise. When the @clear_func you provided is called, you
 * simply free the data blob. The latter is more useful when the
 * contents of clipboard reflect the internal state of a #GObject
 * (As an example, for the PRIMARY clipboard, when an entry widget
79
 * provides the clipboard’s contents the contents are simply the
80 81 82 83 84 85 86 87 88 89 90 91 92
 * text within the selected region.) If the contents change, the
 * entry widget can call gtk_clipboard_set_with_owner() to update
 * the timestamp for clipboard ownership, without having to worry
 * about @clear_func being called.
 *
 * Requesting the data from the clipboard is essentially
 * asynchronous. If the contents of the clipboard are provided within
 * the same process, then a direct function call will be made to
 * retrieve the data, but if they are provided by another process,
 * then the data needs to be retrieved from the other process, which
 * may take some time. To avoid blocking the user interface, the call
 * to request the selection, gtk_clipboard_request_contents() takes a
 * callback that will be called when the contents are received (or
93
 * when the request fails.) If you don’t want to deal with providing
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
 * a separate callback, you can also use gtk_clipboard_wait_for_contents().
 * What this does is run the GLib main loop recursively waiting for
 * the contents. This can simplify the code flow, but you still have
 * to be aware that other callbacks in your program can be called
 * while this recursive mainloop is running.
 *
 * Along with the functions to get the clipboard contents as an
 * arbitrary data chunk, there are also functions to retrieve
 * it as text, gtk_clipboard_request_text() and
 * gtk_clipboard_wait_for_text(). These functions take care of
 * determining which formats are advertised by the clipboard
 * provider, asking for the clipboard in the best available format
 * and converting the results into the UTF-8 encoding. (The standard
 * form for representing strings in GTK+.)
 */


111 112 113 114 115
enum {
  OWNER_CHANGE,
  LAST_SIGNAL
};

116 117
typedef struct _RequestContentsInfo RequestContentsInfo;
typedef struct _RequestTextInfo RequestTextInfo;
118
typedef struct _RequestRichTextInfo RequestRichTextInfo;
119
typedef struct _RequestImageInfo RequestImageInfo;
120
typedef struct _RequestURIInfo RequestURIInfo;
121
typedef struct _RequestTargetsInfo RequestTargetsInfo;
122 123 124 125 126 127 128 129 130 131 132 133 134

struct _RequestContentsInfo
{
  GtkClipboardReceivedFunc callback;
  gpointer user_data;
};

struct _RequestTextInfo
{
  GtkClipboardTextReceivedFunc callback;
  gpointer user_data;
};

135 136 137 138 139 140 141 142 143
struct _RequestRichTextInfo
{
  GtkClipboardRichTextReceivedFunc callback;
  GdkAtom *atoms;
  gint     n_atoms;
  gint     current_atom;
  gpointer user_data;
};

144 145 146 147 148 149
struct _RequestImageInfo
{
  GtkClipboardImageReceivedFunc callback;
  gpointer user_data;
};

150 151 152 153 154 155
struct _RequestURIInfo
{
  GtkClipboardURIReceivedFunc callback;
  gpointer user_data;
};

156 157 158 159 160 161
struct _RequestTargetsInfo
{
  GtkClipboardTargetsReceivedFunc callback;
  gpointer user_data;
};

162 163 164 165
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);
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
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);
static void gtk_clipboard_real_clear            (GtkClipboard                   *clipboard);
static void gtk_clipboard_real_request_contents (GtkClipboard                   *clipboard,
                                                 GdkAtom                         target,
                                                 GtkClipboardReceivedFunc        callback,
                                                 gpointer                        user_data);
static void gtk_clipboard_real_set_can_store    (GtkClipboard                   *clipboard,
                                                 const GtkTargetEntry           *targets,
                                                 gint                            n_targets);
static void gtk_clipboard_real_store            (GtkClipboard                   *clipboard);

183 184 185 186 187 188 189 190 191 192

static void          clipboard_unset      (GtkClipboard     *clipboard);
static void          selection_received   (GtkWidget        *widget,
					   GtkSelectionData *selection_data,
					   guint             time);
static GtkClipboard *clipboard_peek       (GdkDisplay       *display,
					   GdkAtom           selection,
					   gboolean          only_if_exists);
static GtkWidget *   get_clipboard_widget (GdkDisplay       *display);

193

194 195 196 197
enum {
  TARGET_STRING,
  TARGET_TEXT,
  TARGET_COMPOUND_TEXT,
198 199
  TARGET_UTF8_STRING,
  TARGET_SAVE_TARGETS
200 201
};

202
static const gchar request_contents_key[] = "gtk-request-contents";
203 204
static GQuark request_contents_key_id = 0;

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

208
static guint         clipboard_signals[LAST_SIGNAL] = { 0 };
209

Matthias Clasen's avatar
Matthias Clasen committed
210
G_DEFINE_TYPE (GtkClipboard, gtk_clipboard, G_TYPE_OBJECT)
211 212 213

static void
gtk_clipboard_init (GtkClipboard *object)
214 215 216 217 218 219 220 221 222
{
}

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

  gobject_class->finalize = gtk_clipboard_finalize;
223

224 225 226 227 228
  class->set_contents = gtk_clipboard_set_contents;
  class->clear = gtk_clipboard_real_clear;
  class->request_contents = gtk_clipboard_real_request_contents;
  class->set_can_store = gtk_clipboard_real_set_can_store;
  class->store = gtk_clipboard_real_store;
229
  class->owner_change = gtk_clipboard_owner_change;
230

Matthias Clasen's avatar
Matthias Clasen committed
231 232 233
  /**
   * GtkClipboard::owner-change:
   * @clipboard: the #GtkClipboard on which the signal is emitted
234
   * @event: (type Gdk.EventOwnerChange): the @GdkEventOwnerChange event
Matthias Clasen's avatar
Matthias Clasen committed
235 236
   *
   * The ::owner-change signal is emitted when GTK+ receives an
237
   * event that indicates that the ownership of the selection
Matthias Clasen's avatar
Matthias Clasen committed
238 239 240
   * associated with @clipboard has changed.
   *
   * Since: 2.6
241
   */
242
  clipboard_signals[OWNER_CHANGE] =
243
    g_signal_new (I_("owner-change"),
244 245 246 247 248 249 250
		  G_TYPE_FROM_CLASS (gobject_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkClipboardClass, owner_change),
		  NULL, NULL,
		  _gtk_marshal_VOID__BOXED,
		  G_TYPE_NONE, 1,
		  GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
251 252 253
}

static void
254
gtk_clipboard_finalize (GObject *object)
255
{
256
  GtkClipboard *clipboard;
257 258
  GtkWidget *clipboard_widget = NULL;
  GSList *clipboards = NULL;
259 260 261

  clipboard = GTK_CLIPBOARD (object);

262 263 264
  if (clipboard->display)
    {
      clipboards = g_object_get_data (G_OBJECT (clipboard->display), "gtk-clipboard-list");
265

266 267 268 269 270 271 272 273 274 275 276 277 278 279
      if (g_slist_index (clipboards, clipboard) >= 0)
        g_warning ("GtkClipboard prematurely finalized");

      clipboards = g_slist_remove (clipboards, clipboard);

      g_object_set_data (G_OBJECT (clipboard->display), "gtk-clipboard-list", 
                         clipboards);

      /* don't use get_clipboard_widget() here because it would create the
       * widget if it doesn't exist.
       */
      clipboard_widget = g_object_get_data (G_OBJECT (clipboard->display),
                                            "gtk-clipboard-widget");
    }
280

281
  clipboard_unset (clipboard);
282

283 284 285
  if (clipboard->store_loop && g_main_loop_is_running (clipboard->store_loop))
    g_main_loop_quit (clipboard->store_loop);

286 287 288 289 290
  if (clipboard->store_timeout != 0)
    g_source_remove (clipboard->store_timeout);

  if (clipboard->notify_signal_id != 0)
    g_signal_handler_disconnect (clipboard_widget, clipboard->notify_signal_id);
291

292
  g_free (clipboard->storable_targets);
293
  g_free (clipboard->cached_targets);
294

295
  G_OBJECT_CLASS (gtk_clipboard_parent_class)->finalize (object);
296 297 298 299 300 301 302 303 304 305 306 307
}

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);
308
  g_object_set_data (G_OBJECT (display), I_("gtk-clipboard-list"), clipboards);
309
  g_object_unref (clipboard);
310 311
}

312
/**
313
 * gtk_clipboard_get_for_display:
314
 * @display: the #GdkDisplay for which the clipboard is to be retrieved or created.
315 316
 * @selection: a #GdkAtom which identifies the clipboard to use.
 *
317
 * Returns the clipboard object for the given selection.
318
 * Cut/copy/paste menu items and keyboard shortcuts should use
319 320 321
 * the default clipboard, returned by passing %GDK_SELECTION_CLIPBOARD for @selection.
 * (%GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD
 * for backwards compatibility reasons.)
322 323 324 325 326 327
 * The currently-selected object or text should be provided on the clipboard
 * identified by #GDK_SELECTION_PRIMARY. Cut/copy/paste menu items
 * conceptually copy the contents of the #GDK_SELECTION_PRIMARY clipboard
 * to the default clipboard, i.e. they copy the selection to what the
 * user sees as the clipboard.
 *
328
 * (Passing #GDK_NONE is the same as using `gdk_atom_intern
329 330 331 332
 * ("CLIPBOARD", FALSE)`.
 *
 * See the
 * [FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboards-spec)
333
 * for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY”
334 335
 * selections under the X window system. On Win32 the
 * #GDK_SELECTION_PRIMARY clipboard is essentially ignored.)
336
 *
337
 * It’s possible to have arbitrary named clipboards; if you do invent
338 339 340
 * new clipboards, you should prefix the selection name with an
 * underscore (because the ICCCM requires that nonstandard atoms are
 * underscore-prefixed), and namespace it as well. For example,
341 342
 * if your application called “Foo” has a special-purpose
 * clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”.
343
 *
344
 * Returns: (transfer none): the appropriate clipboard object. If no
345 346 347
 *   clipboard already exists, a new one will be created. Once a clipboard
 *   object has been created, it is persistent and, since it is owned by
 *   GTK+, must not be freed or unrefd.
348 349
 *
 * Since: 2.2
350 351
 **/
GtkClipboard *
352 353
gtk_clipboard_get_for_display (GdkDisplay *display, 
			       GdkAtom     selection)
354
{
355
  g_return_val_if_fail (display != NULL, NULL); /* See bgo#463773; this is needed because Flash Player sucks */
356
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
357
  g_return_val_if_fail (!gdk_display_is_closed (display), NULL);
358

359
  return clipboard_peek (display, selection, FALSE);
360 361
}

362

363
/**
Matthias Clasen's avatar
Matthias Clasen committed
364 365 366
 * gtk_clipboard_get:
 * @selection: a #GdkAtom which identifies the clipboard to use
 *
367 368
 * Returns the clipboard object for the given selection.
 * See gtk_clipboard_get_for_display() for complete details.
Matthias Clasen's avatar
Matthias Clasen committed
369
 *
370
 * Returns: (transfer none): the appropriate clipboard object. If no clipboard
Matthias Clasen's avatar
Matthias Clasen committed
371 372 373 374
 *     already exists, a new one will be created. Once a clipboard
 *     object has been created, it is persistent and, since it is
 *     owned by GTK+, must not be freed or unreffed.
 */
375 376 377
GtkClipboard *
gtk_clipboard_get (GdkAtom selection)
{
Owen Taylor's avatar
Owen Taylor committed
378
  return gtk_clipboard_get_for_display (gdk_display_get_default (), selection);
379 380
}

381 382 383
static void 
selection_get_cb (GtkWidget          *widget,
		  GtkSelectionData   *selection_data,
384 385
		  guint               info,
		  guint               time)
386
{
387 388 389 390
  GtkClipboard *clipboard;

  clipboard = gtk_widget_get_clipboard (widget,
                                        gtk_selection_data_get_selection (selection_data));
391 392 393 394 395 396 397 398 399

  if (clipboard && clipboard->get_func)
    clipboard->get_func (clipboard, selection_data, info, clipboard->user_data);
}

static gboolean
selection_clear_event_cb (GtkWidget	    *widget,
			  GdkEventSelection *event)
{
400
  GtkClipboard *clipboard = gtk_widget_get_clipboard (widget, event->selection);
401 402 403 404

  if (clipboard)
    {
      clipboard_unset (clipboard);
405

406 407 408 409 410 411
      return TRUE;
    }

  return FALSE;
}

Havoc Pennington's avatar
Havoc Pennington committed
412
static GtkWidget *
413 414
make_clipboard_widget (GdkDisplay *display, 
		       gboolean    provider)
415
{
416
  GtkWidget *widget = gtk_invisible_new_for_screen (gdk_display_get_default_screen (display));
417

418
  g_signal_connect (widget, "selection-received",
Manish Singh's avatar
Manish Singh committed
419
		    G_CALLBACK (selection_received), NULL);
420 421 422 423 424 425

  if (provider)
    {
      /* We need this for gdk_x11_get_server_time() */
      gtk_widget_add_events (widget, GDK_PROPERTY_CHANGE_MASK);
      
426
      g_signal_connect (widget, "selection-get",
Manish Singh's avatar
Manish Singh committed
427
			G_CALLBACK (selection_get_cb), NULL);
428
      g_signal_connect (widget, "selection-clear-event",
Manish Singh's avatar
Manish Singh committed
429
			G_CALLBACK (selection_clear_event_cb), NULL);
430 431 432 433 434
    }

  return widget;
}

435 436
static GtkWidget *
get_clipboard_widget (GdkDisplay *display)
437
{
438 439 440 441
  GtkWidget *clip_widget = g_object_get_data (G_OBJECT (display), "gtk-clipboard-widget");
  if (!clip_widget)
    {
      clip_widget = make_clipboard_widget (display, TRUE);
442
      g_object_set_data (G_OBJECT (display), I_("gtk-clipboard-widget"), clip_widget);
443 444 445
    }

  return clip_widget;
446 447 448 449 450 451 452 453 454 455 456 457 458
}

/* This function makes a very good guess at what the correct
 * timestamp for a selection request should be. If there is
 * a currently processed event, it uses the timestamp for that
 * event, otherwise it uses the current server time. However,
 * if the time resulting from that is older than the time used
 * last time, it uses the time used last time instead.
 *
 * In order implement this correctly, we never use CurrentTime,
 * but actually retrieve the actual timestamp from the server.
 * This is a little slower but allows us to make the guarantee
 * that the times used by this application will always ascend
459
 * and we won’t get selections being rejected just because
460 461 462 463 464 465
 * we are using a correct timestamp from an event, but used
 * CurrentTime previously.
 */
static guint32
clipboard_get_timestamp (GtkClipboard *clipboard)
{
466
  GtkWidget *clipboard_widget = get_clipboard_widget (clipboard->display);
467
  guint32 timestamp = gtk_get_current_event_time ();
468
  GdkWindow *window;
469 470 471

  if (timestamp == GDK_CURRENT_TIME)
    {
472
      window = gtk_widget_get_window (clipboard_widget);
473
#ifdef GDK_WINDOWING_X11
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
      if (GDK_IS_X11_WINDOW (window))
	{
	  timestamp = gdk_x11_get_server_time (gtk_widget_get_window (clipboard_widget));
	}
      else
#endif
#if defined GDK_WINDOWING_WIN32
      if (GDK_IS_WIN32_WINDOW (window))
	{
	  timestamp = GetMessageTime ();
	}
      else
#endif
#if defined GDK_WINDOWING_BROADWAY
      if (GDK_IS_BROADWAY_WINDOW (window))
	{
	  timestamp = gdk_broadway_get_last_seen_time (window);
	}
      else
493
#endif
494 495 496
	{
	  /* No implementation */
	}
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 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 581 582
    }
  else
    {
      if (clipboard->timestamp != GDK_CURRENT_TIME)
	{
	  /* Check to see if clipboard->timestamp is newer than
	   * timestamp, accounting for wraparound.
	   */

	  guint32 max = timestamp + 0x80000000;

	  if ((max > timestamp &&
	       (clipboard->timestamp > timestamp &&
		clipboard->timestamp <= max)) ||
	      (max <= timestamp &&
	       (clipboard->timestamp > timestamp ||
		clipboard->timestamp <= max)))
	    {
	      timestamp = clipboard->timestamp;
	    }
	}
    }

  clipboard->timestamp = timestamp;

  return timestamp;
}

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;

      gtk_clipboard_clear (clipboard);

      tmp_list = tmp_list->next;
    }
  
  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);
  
  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)
{
583
  GtkWidget *clipboard_widget = get_clipboard_widget (clipboard->display);
584

585 586 587 588
  if (gtk_selection_owner_set_for_display (clipboard->display,
					   clipboard_widget,
					   clipboard->selection,
					   clipboard_get_timestamp (clipboard)))
589 590 591
    {
      clipboard->have_selection = TRUE;

592 593 594 595 596 597 598
      if (clipboard->n_cached_targets != -1)
        {
          g_free (clipboard->cached_targets);
	  clipboard->cached_targets = NULL;
          clipboard->n_cached_targets = -1;
        }

599 600 601 602 603
      if (!(clipboard->have_owner && have_owner) ||
	  clipboard->user_data != user_data)
	{
	  clipboard_unset (clipboard);

604 605 606 607
	  clipboard->user_data = user_data;
	  clipboard->have_owner = have_owner;
	  if (have_owner)
	      clipboard_add_owner_notify (clipboard);
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
 	}

      clipboard->get_func = get_func;
      clipboard->clear_func = clear_func;

      gtk_selection_clear_targets (clipboard_widget, clipboard->selection);
      gtk_selection_add_targets (clipboard_widget, clipboard->selection,
				 targets, n_targets);

      return TRUE;
    }
  else
    return FALSE;
}

/**
624
 * gtk_clipboard_set_with_data: (skip)
625
 * @clipboard: a #GtkClipboard
626 627
 * @targets: (array length=n_targets): array containing information
 *     about the available forms for the clipboard data
628 629 630 631 632 633 634
 * @n_targets: number of elements in @targets
 * @get_func: (scope async): function to call to get the actual clipboard data
 * @clear_func: (scope async): when the clipboard contents are set again,
 *     this function will be called, and @get_func will not be subsequently
 *     called.
 * @user_data: user data to pass to @get_func and @clear_func.
 *
635
 * Virtually sets the contents of the specified clipboard by providing
636 637
 * a list of supported formats for the clipboard data and a function
 * to call to get the actual data when it is requested.
638
 *
639
 * Returns: %TRUE if setting the clipboard data succeeded.
640 641
 *    If setting the clipboard data failed the provided callback
 *    functions will be ignored.
642 643 644 645 646 647 648 649 650 651 652 653 654
 **/
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);

655 656 657 658 659 660 661
  return GTK_CLIPBOARD_GET_CLASS (clipboard)->set_contents (clipboard,
                                                            targets,
                                                            n_targets,
				                            get_func,
                                                            clear_func,
                                                            user_data,
				                            FALSE);
662 663 664
}

/**
665
 * gtk_clipboard_set_with_owner: (skip)
666
 * @clipboard: a #GtkClipboard
667 668
 * @targets: (array length=n_targets): array containing information
 *     about the available forms for the clipboard data
669 670 671 672 673
 * @n_targets: number of elements in @targets
 * @get_func: (scope async): function to call to get the actual clipboard data
 * @clear_func: (scope async): when the clipboard contents are set again,
 *     this function will be called, and @get_func will not be subsequently
 *     called
674
 * @owner: an object that “owns” the data. This object will be passed
675 676
 *     to the callbacks when called
 *
677
 * Virtually sets the contents of the specified clipboard by providing
678 679 680
 * a list of supported formats for the clipboard data and a function
 * to call to get the actual data when it is requested.
 *
Matthias Clasen's avatar
Matthias Clasen committed
681
 * The difference between this function and gtk_clipboard_set_with_data()
682
 * is that instead of an generic @user_data pointer, a #GObject is passed
683 684
 * in.
 *
685
 * Returns: %TRUE if setting the clipboard data succeeded.
686 687
 *     If setting the clipboard data failed the provided callback
 *     functions will be ignored.
688 689 690 691 692 693 694 695 696 697 698 699 700 701
 **/
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);

702 703 704 705 706 707 708
  return GTK_CLIPBOARD_GET_CLASS (clipboard)->set_contents (clipboard,
                                                            targets,
                                                            n_targets,
				                            get_func,
                                                            clear_func,
                                                            owner,
				                            TRUE);
709 710 711 712 713
}

/**
 * gtk_clipboard_get_owner:
 * @clipboard: a #GtkClipboard
714 715 716 717
 *
 * If the clipboard contents callbacks were set with
 * gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or
 * gtk_clipboard_clear() has not subsequently called, returns the owner set
Matthias Clasen's avatar
Matthias Clasen committed
718
 * by gtk_clipboard_set_with_owner().
719
 *
720
 * Returns: (transfer none): the owner of the clipboard, if any;
721
 *     otherwise %NULL.
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
 **/
GObject *
gtk_clipboard_get_owner (GtkClipboard *clipboard)
{
  g_return_val_if_fail (clipboard != NULL, NULL);

  if (clipboard->have_owner)
    return clipboard->user_data;
  else
    return NULL;
}

static void
clipboard_unset (GtkClipboard *clipboard)
{
  GtkClipboardClearFunc old_clear_func;
  gpointer old_data;
739 740
  gboolean old_have_owner;
  gint old_n_storable_targets;
741 742 743
  
  old_clear_func = clipboard->clear_func;
  old_data = clipboard->user_data;
744 745 746 747
  old_have_owner = clipboard->have_owner;
  old_n_storable_targets = clipboard->n_storable_targets;
  
  if (old_have_owner)
748 749 750 751
    {
      clipboard_remove_owner_notify (clipboard);
      clipboard->have_owner = FALSE;
    }
752 753 754 755 756

  clipboard->n_storable_targets = -1;
  g_free (clipboard->storable_targets);
  clipboard->storable_targets = NULL;
      
757 758 759 760 761 762
  clipboard->get_func = NULL;
  clipboard->clear_func = NULL;
  clipboard->user_data = NULL;
  
  if (old_clear_func)
    old_clear_func (clipboard, old_data);
763 764 765 766 767 768

  /* If we've transferred the clipboard data to the manager,
   * unref the owner
   */
  if (old_have_owner &&
      old_n_storable_targets != -1)
769
    g_object_unref (old_data);
770 771 772 773 774 775
}

/**
 * gtk_clipboard_clear:
 * @clipboard:  a #GtkClipboard
 * 
776
 * Clears the contents of the clipboard. Generally this should only
777 778
 * be called between the time you call gtk_clipboard_set_with_owner()
 * or gtk_clipboard_set_with_data(),
779 780 781 782 783 784 785 786
 * and when the @clear_func you supplied is called. Otherwise, the
 * clipboard may be owned by someone else.
 **/
void
gtk_clipboard_clear (GtkClipboard *clipboard)
{
  g_return_if_fail (clipboard != NULL);

787 788 789 790 791 792
  GTK_CLIPBOARD_GET_CLASS (clipboard)->clear (clipboard);
}

static void
gtk_clipboard_real_clear (GtkClipboard *clipboard)
{
793
  if (clipboard->have_selection)
794 795 796 797
    gtk_selection_owner_set_for_display (clipboard->display, 
					 NULL,
					 clipboard->selection,
					 clipboard_get_timestamp (clipboard));
798 799
}

Havoc Pennington's avatar
Havoc Pennington committed
800
static void 
801 802 803 804 805
text_get_func (GtkClipboard     *clipboard,
	       GtkSelectionData *selection_data,
	       guint             info,
	       gpointer          data)
{
806
  gtk_selection_data_set_text (selection_data, data, -1);
807 808
}

Havoc Pennington's avatar
Havoc Pennington committed
809
static void 
810 811 812 813 814 815
text_clear_func (GtkClipboard *clipboard,
		 gpointer      data)
{
  g_free (data);
}

816

817 818 819 820 821
/**
 * gtk_clipboard_set_text:
 * @clipboard: a #GtkClipboard object
 * @text:      a UTF-8 string.
 * @len:       length of @text, in bytes, or -1, in which case
822
 *             the length will be determined with strlen().
823
 * 
824
 * Sets the contents of the clipboard to the given UTF-8 string. GTK+ will
825 826 827 828 829 830 831 832 833
 * make a copy of the text and take responsibility for responding
 * for requests for the text, and for converting the text into
 * the requested format.
 **/
void 
gtk_clipboard_set_text (GtkClipboard *clipboard,
			const gchar  *text,
			gint          len)
{
834 835
  GtkTargetList *list;
  GtkTargetEntry *targets;
836
  gint n_targets;
837 838 839

  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (text != NULL);
840 841 842 843

  list = gtk_target_list_new (NULL, 0);
  gtk_target_list_add_text_targets (list, 0);

844
  targets = gtk_target_table_new_from_list (list, &n_targets);
845
  
846 847 848 849
  if (len < 0)
    len = strlen (text);
  
  gtk_clipboard_set_with_data (clipboard, 
850
			       targets, n_targets,
851 852
			       text_get_func, text_clear_func,
			       g_strndup (text, len));
853
  gtk_clipboard_set_can_store (clipboard, NULL, 0);
854

855
  gtk_target_table_free (targets, n_targets);
856
  gtk_target_list_unref (list);
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 887 888 889 890 891 892
static void 
pixbuf_get_func (GtkClipboard     *clipboard,
		 GtkSelectionData *selection_data,
		 guint             info,
		 gpointer          data)
{
  gtk_selection_data_set_pixbuf (selection_data, data);
}

static void 
pixbuf_clear_func (GtkClipboard *clipboard,
		   gpointer      data)
{
  g_object_unref (data);
}

/**
 * gtk_clipboard_set_image:
 * @clipboard: a #GtkClipboard object
 * @pixbuf:    a #GdkPixbuf 
 * 
 * Sets the contents of the clipboard to the given #GdkPixbuf. 
 * GTK+ will take responsibility for responding for requests 
 * for the image, and for converting the image into the 
 * requested format.
 * 
 * Since: 2.6
 **/
void
gtk_clipboard_set_image (GtkClipboard *clipboard,
			  GdkPixbuf    *pixbuf)
{
  GtkTargetList *list;
  GtkTargetEntry *targets;
893
  gint n_targets;
894 895 896 897 898 899 900

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

901
  targets = gtk_target_table_new_from_list (list, &n_targets);
902 903 904 905 906 907 908

  gtk_clipboard_set_with_data (clipboard, 
			       targets, n_targets,
			       pixbuf_get_func, pixbuf_clear_func,
			       g_object_ref (pixbuf));
  gtk_clipboard_set_can_store (clipboard, NULL, 0);

909
  gtk_target_table_free (targets, n_targets);
910 911 912
  gtk_target_list_unref (list);
}

913 914 915 916 917 918 919
static void
set_request_contents_info (GtkWidget           *widget,
			   RequestContentsInfo *info)
{
  if (!request_contents_key_id)
    request_contents_key_id = g_quark_from_static_string (request_contents_key);

Manish Singh's avatar
Manish Singh committed
920
  g_object_set_qdata (G_OBJECT (widget), request_contents_key_id, info);
921 922 923 924 925 926 927 928
}

static RequestContentsInfo *
get_request_contents_info (GtkWidget *widget)
{
  if (!request_contents_key_id)
    return NULL;
  else
Manish Singh's avatar
Manish Singh committed
929
    return g_object_get_qdata (G_OBJECT (widget), request_contents_key_id);
930 931 932 933 934 935 936 937 938
}

static void 
selection_received (GtkWidget            *widget,
		    GtkSelectionData     *selection_data,
		    guint                 time)
{
  RequestContentsInfo *request_info = get_request_contents_info (widget);
  set_request_contents_info (widget, NULL);
939 940

  request_info->callback (gtk_widget_get_clipboard (widget, gtk_selection_data_get_selection (selection_data)),
941 942 943 944 945
			  selection_data,
			  request_info->user_data);

  g_free (request_info);

946
  if (widget != get_clipboard_widget (gtk_widget_get_display (widget)))
947 948 949 950 951 952
    gtk_widget_destroy (widget);
}

/**
 * gtk_clipboard_request_contents:
 * @clipboard: a #GtkClipboard
953 954 955 956 957
 * @target: an atom representing the form into which the clipboard
 *     owner should convert the selection.
 * @callback: (scope async): A function to call when the results are received
 *     (or the retrieval fails). If the retrieval fails the length field of
 *     @selection_data will be negative.
958
 * @user_data: user data to pass to @callback
959
 *
960 961 962 963 964 965 966 967 968
 * Requests the contents of clipboard as the given target.
 * When the results of the result are later received the supplied callback
 * will be called.
 **/
void 
gtk_clipboard_request_contents (GtkClipboard            *clipboard,
				GdkAtom                  target,
				GtkClipboardReceivedFunc callback,
				gpointer                 user_data)
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
{
  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (target != GDK_NONE);
  g_return_if_fail (callback != NULL);

  GTK_CLIPBOARD_GET_CLASS (clipboard)->request_contents (clipboard,
                                                         target,
                                                         callback,
                                                         user_data);
}

static void 
gtk_clipboard_real_request_contents (GtkClipboard            *clipboard,
                                     GdkAtom                  target,
                                     GtkClipboardReceivedFunc callback,
                                     gpointer                 user_data)
985 986 987
{
  RequestContentsInfo *info;
  GtkWidget *widget;
988
  GtkWidget *clipboard_widget;
989

990
  clipboard_widget = get_clipboard_widget (clipboard->display);
991 992

  if (get_request_contents_info (clipboard_widget))
993
    widget = make_clipboard_widget (clipboard->display, FALSE);
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  else
    widget = clipboard_widget;

  info = g_new (RequestContentsInfo, 1);
  info->callback = callback;
  info->user_data = user_data;

  set_request_contents_info (widget, info);

  gtk_selection_convert (widget, clipboard->selection, target,
			 clipboard_get_timestamp (clipboard));
}

static void 
request_text_received_func (GtkClipboard     *clipboard,
			    GtkSelectionData *selection_data,
			    gpointer          data)
{
  RequestTextInfo *info = data;
  gchar *result = NULL;

1015
  result = (gchar *) gtk_selection_data_get_text (selection_data);
1016 1017 1018

  if (!result)
    {
1019 1020 1021
      /* If we asked for UTF8 and didn't get it, try compound_text;
       * if we asked for compound_text and didn't get it, try string;
       * If we asked for anything else and didn't get it, give up.
1022
       */
1023 1024 1025
      GdkAtom target = gtk_selection_data_get_target (selection_data);

      if (target == gdk_atom_intern_static_string ("UTF8_STRING"))
1026 1027
	{
	  gtk_clipboard_request_contents (clipboard,
1028
					  gdk_atom_intern_static_string ("COMPOUND_TEXT"), 
1029 1030 1031
					  request_text_received_func, info);
	  return;
	}
1032
      else if (target == gdk_atom_intern_static_string ("COMPOUND_TEXT"))
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
	{
	  gtk_clipboard_request_contents (clipboard,
					  GDK_TARGET_STRING, 
					  request_text_received_func, info);
	  return;
	}
    }

  info->callback (clipboard, result, info->user_data);
  g_free (info);
  g_free (result);
}

/**
 * gtk_clipboard_request_text:
 * @clipboard: a #GtkClipboard
1049 1050
 * @callback: (scope async): a function to call when the text is received,
 *     or the retrieval fails. (It will always be called one way or the other.)
1051
 * @user_data: user data to pass to @callback.
1052
 *
1053 1054
 * Requests the contents of the clipboard as text. When the text is
 * later received, it will be converted to UTF-8 if necessary, and
1055
 * @callback will be called.
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
 *
 * The @text parameter to @callback will contain the resulting text if
 * the request succeeded, or %NULL if it failed. This could happen for
 * various reasons, in particular if the clipboard was empty or if the
 * contents of the clipboard could not be converted into text form.
 **/
void 
gtk_clipboard_request_text (GtkClipboard                *clipboard,
			    GtkClipboardTextReceivedFunc callback,
			    gpointer                     user_data)
{
  RequestTextInfo *info;
  
  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (callback != NULL);
  
  info = g_new (RequestTextInfo, 1);
  info->callback = callback;
  info->user_data = user_data;

1076
  gtk_clipboard_request_contents (clipboard, gdk_atom_intern_static_string ("UTF8_STRING"),
1077 1078 1079 1080
				  request_text_received_func,
				  info);
}

1081 1082 1083 1084 1085 1086 1087 1088 1089
static void
request_rich_text_received_func (GtkClipboard     *clipboard,
                                 GtkSelectionData *selection_data,
                                 gpointer          data)
{
  RequestRichTextInfo *info = data;
  guint8 *result = NULL;
  gsize length = 0;

1090 1091
  result = (guint8 *) gtk_selection_data_get_data (selection_data);
  length = gtk_selection_data_get_length (selection_data);
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102

  info->current_atom++;

  if ((!result || length < 1) && (info->current_atom < info->n_atoms))
    {
      gtk_clipboard_request_contents (clipboard, info->atoms[info->current_atom],
                                      request_rich_text_received_func,
                                      info);
      return;
    }

1103 1104
  info->callback (clipboard, gtk_selection_data_get_target (selection_data),
                  result, length,
1105 1106 1107 1108 1109 1110 1111 1112
                  info->user_data);
  g_free (info->atoms);
  g_free (info);
}

/**
 * gtk_clipboard_request_rich_text:
 * @clipboard: a #GtkClipboard
1113 1114 1115
 * @buffer: a #GtkTextBuffer
 * @callback: (scope async): a function to call when the text is received,
 *     or the retrieval fails. (It will always be called one way or the other.)
1116 1117 1118 1119 1120 1121 1122
 * @user_data: user data to pass to @callback.
 *
 * Requests the contents of the clipboard as rich text. When the rich
 * text is later received, @callback will be called.
 *
 * The @text parameter to @callback will contain the resulting rich
 * text if the request succeeded, or %NULL if it failed. The @length
1123
 * parameter will contain @text’s length. This function can fail for
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
 * various reasons, in particular if the clipboard was empty or if the
 * contents of the clipboard could not be converted into rich text form.
 *
 * Since: 2.10
 **/
void
gtk_clipboard_request_rich_text (GtkClipboard                    *clipboard,
                                 GtkTextBuffer                   *buffer,
                                 GtkClipboardRichTextReceivedFunc callback,
                                 gpointer                         user_data)
{
  RequestRichTextInfo *info;

  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));
  g_return_if_fail (callback != NULL);

  info = g_new (RequestRichTextInfo, 1);
  info->callback = callback;
  info->atoms = NULL;
  info->n_atoms = 0;
  info->current_atom = 0;
  info->user_data = user_data;

  info->atoms = gtk_text_buffer_get_deserialize_formats (buffer, &info->n_atoms);

  gtk_clipboard_request_contents (clipboard, info->atoms[info->current_atom],
				  request_rich_text_received_func,
				  info);
}

1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
static void 
request_image_received_func (GtkClipboard     *clipboard,
			     GtkSelectionData *selection_data,
			     gpointer          data)
{
  RequestImageInfo *info = data;
  GdkPixbuf *result = NULL;

  result = gtk_selection_data_get_pixbuf (selection_data);

  if (!result)
    {
      /* If we asked for image/png and didn't get it, try image/jpeg;
       * if we asked for image/jpeg and didn't get it, try image/gif;
Matthias Clasen's avatar
Matthias Clasen committed
1169
       * if we asked for image/gif and didn't get it, try image/bmp;
1170 1171
       * If we asked for anything else and didn't get it, give up.
       */
1172 1173 1174
      GdkAtom target = gtk_selection_data_get_target (selection_data);

      if (target == gdk_atom_intern_static_string ("image/png"))
1175 1176
	{
	  gtk_clipboard_request_contents (clipboard,
1177
					  gdk_atom_intern_static_string ("image/jpeg"), 
1178 1179 1180
					  request_image_received_func, info);
	  return;
	}
1181
      else if (target == gdk_atom_intern_static_string ("image/jpeg"))
1182 1183
	{
	  gtk_clipboard_request_contents (clipboard,
1184
					  gdk_atom_intern_static_string ("image/gif"), 
Matthias Clasen's avatar
Matthias Clasen committed
1185 1186 1187
					  request_image_received_func, info);
	  return;
	}
1188
      else if (target == gdk_atom_intern_static_string ("image/gif"))
Matthias Clasen's avatar
Matthias Clasen committed
1189 1190
	{
	  gtk_clipboard_request_contents (clipboard,
1191
					  gdk_atom_intern_static_string ("image/bmp"), 
Matthias Clasen's avatar
Matthias Clasen committed
1192
					  request_image_received_func, info);
1193 1194 1195 1196 1197 1198
	  return;
	}
    }

  info->callback (clipboard, result, info->user_data);
  g_free (info);
1199 1200 1201

  if (result)
    g_object_unref (result);
1202 1203 1204 1205 1206
}

/**
 * gtk_clipboard_request_image:
 * @clipboard: a #GtkClipboard
1207 1208
 * @callback: (scope async): a function to call when the image is received,
 *     or the retrieval fails. (It will always be called one way or the other.)
1209
 * @user_data: user data to pass to @callback.
1210
 *
1211 1212
 * Requests the contents of the clipboard as image. When the image is
 * later received, it will be converted to a #GdkPixbuf, and
1213
 * @callback will be called.
1214
 *
1215 1216 1217 1218
 * The @pixbuf parameter to @callback will contain the resulting
 * #GdkPixbuf if the request succeeded, or %NULL if it failed. This
 * could happen for various reasons, in particular if the clipboard
 * was empty or if the contents of the clipboard could not be
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
 * converted into an image.
 *
 * Since: 2.6
 **/
void 
gtk_clipboard_request_image (GtkClipboard                  *clipboard,
			     GtkClipboardImageReceivedFunc  callback,
			     gpointer                       user_data)
{
  RequestImageInfo *info;
  
  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (callback != NULL);
  
  info = g_new (RequestImageInfo, 1);
  info->callback = callback;
  info->user_data = user_data;

  gtk_clipboard_request_contents (clipboard, 
1238
				  gdk_atom_intern_static_string ("image/png"),
1239 1240 1241 1242
				  request_image_received_func,
				  info);
}

1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
static void 
request_uris_received_func (GtkClipboard     *clipboard,
			    GtkSelectionData *selection_data,
			    gpointer          data)
{
  RequestURIInfo *info = data;
  gchar **uris;

  uris = gtk_selection_data_get_uris (selection_data);
  info->callback (clipboard, uris, info->user_data);
  g_strfreev (uris);

  g_slice_free (RequestURIInfo, info);
}

/**
 * gtk_clipboard_request_uris:
 * @clipboard: a #GtkClipboard
1261 1262
 * @callback: (scope async): a function to call when the URIs are received,
 *     or the retrieval fails. (It will always be called one way or the other.)
1263
 * @user_data: user data to pass to @callback.
1264
 *
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
 * Requests the contents of the clipboard as URIs. When the URIs are
 * later received @callback will be called.
 *
 * The @uris parameter to @callback will contain the resulting array of
 * URIs if the request succeeded, or %NULL if it failed. This could happen
 * for various reasons, in particular if the clipboard was empty or if the
 * contents of the clipboard could not be converted into URI form.
 *
 * Since: 2.14
 **/
void 
gtk_clipboard_request_uris (GtkClipboard                *clipboard,
			    GtkClipboardURIReceivedFunc  callback,
			    gpointer                     user_data)
{
  RequestURIInfo *info;
  
  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (callback != NULL);
  
  info = g_slice_new (RequestURIInfo);
  info->callback = callback;
  info->user_data = user_data;

  gtk_clipboard_request_contents (clipboard, gdk_atom_intern_static_string ("text/uri-list"),
				  request_uris_received_func,
				  info);
}

1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
static void 
request_targets_received_func (GtkClipboard     *clipboard,
			       GtkSelectionData *selection_data,
			       gpointer          data)
{
  RequestTargetsInfo *info = data;
  GdkAtom *targets = NULL;
  gint n_targets = 0;

  gtk_selection_data_get_targets (selection_data, &targets, &n_targets);

  info->callback (clipboard, targets, n_targets, info->user_data);

  g_free (info);
  g_free (targets);
}

/**
 * gtk_clipboard_request_targets:
 * @clipboard: a #GtkClipboard
1314 1315 1316
 * @callback: (scope async): a function to call when the targets are
 *     received, or the retrieval fails. (It will always be called
 *     one way or the other.)
1317
 * @user_data: user data to pass to @callback.
1318 1319 1320
 *
 * Requests the contents of the clipboard as list of supported targets.
 * When the list is later received, @callback will be called.
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
 *
 * The @targets parameter to @callback will contain the resulting targets if
 * the request succeeded, or %NULL if it failed.
 *
 * Since: 2.4
 **/
void 
gtk_clipboard_request_targets (GtkClipboard                *clipboard,
			       GtkClipboardTargetsReceivedFunc callback,
			       gpointer                     user_data)
{
  RequestTargetsInfo *info;
  
  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (callback != NULL);
1336 1337 1338 1339 1340 1341 1342 1343

  /* 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)
    {
      (* callback) (clipboard, clipboard->cached_targets, clipboard->n_cached_targets, user_data);
      return;
    }
1344 1345 1346 1347 1348
  
  info = g_new (RequestTargetsInfo, 1);
  info->callback = callback;
  info->user_data = user_data;

1349
  gtk_clipboard_request_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"),
1350 1351 1352
				  request_targets_received_func,
				  info);
}
1353 1354 1355 1356 1357

typedef struct
{
  GMainLoop *loop;
  gpointer data;
1358 1359
  GdkAtom format; /* used by rich text */
  gsize length; /* used by rich text */
1360 1361 1362 1363 1364 1365 1366 1367 1368
} WaitResults;

static void 
clipboard_received_func (GtkClipboard     *clipboard,
			 GtkSelectionData *selection_data,
			 gpointer          data)
{
  WaitResults *results = data;

1369
  if (gtk_selection_data_get_length (selection_data) >= 0)
1370 1371
    results->data = gtk_selection_data_copy (selection_data);
  
Manish Singh's avatar
Manish Singh committed
1372
  g_main_loop_quit (results->loop);
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
}

/**
 * gtk_clipboard_wait_for_contents:
 * @clipboard: a #GtkClipboard
 * @target: an atom representing the form into which the clipboard
 *          owner should convert the selection.
 * 
 * Requests the contents of the clipboard using the given target.
 * This function waits for the data to be received using the main 
 * loop, so events, timeouts, etc, may be dispatched during the wait.
 * 
1385
 * Returns: (nullable): a newly-allocated #GtkSelectionData object or %NULL
1386
 *               if retrieving the given target failed. If non-%NULL,
Matthias Clasen's avatar
Matthias Clasen committed
1387 1388
 *               this value must be freed with gtk_selection_data_free() 
 *               when you are finished with it.
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
 **/
GtkSelectionData *
gtk_clipboard_wait_for_contents (GtkClipboard *clipboard,
				 GdkAtom       target)
{
  WaitResults results;

  g_return_val_if_fail (clipboard != NULL, NULL);
  g_return_val_if_fail (target != GDK_NONE, NULL);
  
  results.data = NULL;
Manish Singh's avatar
Manish Singh committed
1400
  results.loop = g_main_loop_new (NULL, TRUE);
1401 1402 1403 1404 1405

  gtk_clipboard_request_contents (clipboard, target, 
				  clipboard_received_func,
				  &results);

Manish Singh's avatar
Manish Singh committed
1406
  if (g_main_loop_is_running (results.loop))
1407
    {
1408
      gdk_threads_leave ();
Manish Singh's avatar
Manish Singh committed
1409
      g_main_loop_run (results.loop);
1410
      gdk_threads_enter ();
1411
    }
1412

Manish Singh's avatar
Manish Singh committed
1413
  g_main_loop_unref (results.loop);
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425

  return results.data;
}

static void 
clipboard_text_received_func (GtkClipboard *clipboard,
			      const gchar  *text,
			      gpointer      data)
{
  WaitResults *results = data;

  results->data = g_strdup (text);
Manish Singh's avatar
Manish Singh committed
1426
  g_main_loop_quit (results->loop);
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
}

/**
 * gtk_clipboard_wait_for_text:
 * @clipboard: a #GtkClipboard
 * 
 * Requests the contents of the clipboard as text and converts
 * the result to UTF-8 if necessary. This function waits for
 * the data to be received using the main loop, so events,
 * timeouts, etc, may be dispatched during the wait.
 * 
1438
 * Returns: (nullable): a newly-allocated UTF-8 string which must
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
 *               be freed with g_free(), or %NULL if retrieving
 *               the selection data failed. (This could happen
 *               for various reasons, in particular if the
 *               clipboard was empty or if the contents of the
 *               clipboard could not be converted into text form.)
 **/
gchar *
gtk_clipboard_wait_for_text (GtkClipboard *clipboard)
{
  WaitResults results;

  g_return_val_if_fail (clipboard != NULL, NULL);
  
  results.data = NULL;
Manish Singh's avatar
Manish Singh committed
1453
  results.loop = g_main_loop_new (NULL, TRUE);
1454 1455 1456 1457 1458

  gtk_clipboard_request_text (clipboard,
			      clipboard_text_received_func,
			      &results);

Manish Singh's avatar
Manish Singh committed
1459
  if (g_main_loop_is_running (results.loop))
1460
    {
1461
      gdk_threads_leave ();
Manish Singh's avatar
Manish Singh committed
1462
      g_main_loop_run (results.loop);
1463
      gdk_threads_enter ();
1464
    }
1465

Manish Singh's avatar
Manish Singh committed
1466
  g_main_loop_unref (results.loop);
1467 1468 1469

  return results.data;
}
1470

1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
static void
clipboard_rich_text_received_func (GtkClipboard *clipboard,
                                   GdkAtom       format,
                                   const guint8 *text,
                                   gsize         length,
                                   gpointer      data)
{
  WaitResults *results = data;

  results->data = g_memdup (text, length);
  results->format = format;
  results->length = length;
  g_main_loop_quit (results->loop);
}

/**
 * gtk_clipboard_wait_for_rich_text:
 * @clipboard: a #GtkClipboard
 * @buffer: a #GtkTextBuffer
1490
 * @format: (out): return location for the format of the returned data
1491
 * @length: (out): return location for the length of the returned data
1492 1493 1494 1495 1496
 *
 * Requests the contents of the clipboard as rich text.  This function
 * waits for the data to be received using the main loop, so events,
 * timeouts, etc, may be dispatched during the wait.
 *
1497
 * Returns: (nullable) (array length=length) (transfer full): a
1498 1499 1500 1501 1502 1503
 *               newly-allocated binary block of data which must be
 *               freed with g_free(), or %NULL if retrieving the
 *               selection data failed. (This could happen for various
 *               reasons, in particular if the clipboard was empty or
 *               if the contents of the clipboard could not be
 *               converted into text form.)
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
 *
 * Since: 2.10
 **/
guint8 *
gtk_clipboard_wait_for_rich_text (GtkClipboard  *clipboard,
                                  GtkTextBuffer *buffer,
                                  GdkAtom       *format,
                                  gsize         *length)
{
  WaitResults results;

  g_return_val_if_fail (clipboard != NULL, NULL);
  g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
  g_return_val_if_fail (format != NULL, NULL);
  g_return_val_if_fail (length != NULL, NULL);

  results.data = NULL;
  results.loop = g_main_loop_new (NULL, TRUE);

  gtk_clipboard_request_rich_text (clipboard, buffer,
                                   clipboard_rich_text_received_func,
                                   &results);

  if (g_main_loop_is_running (results.loop))
    {
1529
      gdk_threads_leave ();
1530
      g_main_loop_run (results.loop);
1531
      gdk_threads_enter ();
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
    }

  g_main_loop_unref (results.loop);

  *format = results.format;
  *length = results.length;

  return results.data;
}

1542 1543 1544 1545 1546 1547 1548
static void 
clipboard_image_received_func (GtkClipboard *clipboard,
			       GdkPixbuf    *pixbuf,
			       gpointer      data)
{
  WaitResults *results = data;

1549 1550 1551
  if (pixbuf)
    results->data = g_object_ref (pixbuf);

1552 1553 1554 1555 1556 1557
  g_main_loop_quit (results->loop);
}

/**
 * gtk_clipboard_wait_for_image:
 * @clipboard: a #GtkClipboard
1558
 *
1559 1560 1561 1562
 * Requests the contents of the clipboard as image and converts
 * the result to a #GdkPixbuf. This function waits for
 * the data to be received using the main loop, so events,
 * timeouts, etc, may be dispatched during the wait.
1563
 *
1564
 * Returns: (nullable) (transfer full): a newly-allocated #GdkPixbuf
1565 1566 1567 1568 1569
 *     object which must be disposed with g_object_unref(), or
 *     %NULL if retrieving the selection data failed. (This could
 *     happen for various reasons, in particular if the clipboard
 *     was empty or if the contents of the clipboard could not be
 *     converted into an image.)
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
 *
 * Since: 2.6
 **/
GdkPixbuf *
gtk_clipboard_wait_for_image (GtkClipboard *clipboard)
{
  WaitResults results;

  g_return_val_if_fail (clipboard != NULL, NULL);
  
  results.data = NULL;
  results.loop = g_main_loop_new (NULL, TRUE);

  gtk_clipboard_request_image (clipboard,
			       clipboard_image_received_func,
			       &results);

  if (g_main_loop_is_running (results.loop))
    {
1589
      gdk_threads_leave ();
1590
      g_main_loop_run (results.loop);
1591
      gdk_threads_enter ();
1592 1593 1594 1595 1596 1597 1598
    }

  g_main_loop_unref (results.loop);

  return results.data;
}

1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
static void 
clipboard_uris_received_func (GtkClipboard *clipboard,
			      gchar       **uris,
			      gpointer      data)
{
  WaitResults *results = data;

  results->data = g_strdupv (uris);
  g_main_loop_quit (results->loop);
}

/**
 * gtk_clipboard_wait_for_uris:
 * @clipboard: a #GtkClipboard
 * 
 * Requests the contents of the clipboard as URIs. This function waits
 * for the data to be received using the main loop, so events,
 * timeouts, etc, may be dispatched during the wait.
1617
 *
1618 1619 1620 1621 1622 1623
 * Returns: (nullable) (array zero-terminated=1) (element-type utf8) (transfer full):
 *     a newly-allocated %NULL-terminated array of strings which must
 *     be freed with g_strfreev(), or %NULL if retrieving the
 *     selection data failed. (This could happen for various reasons,
 *     in particular if the clipboard was empty or if the contents of
 *     the clipboard could not be converted into URI form.)
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
 *
 * Since: 2.14
 **/
gchar **
gtk_clipboard_wait_for_uris (GtkClipboard *clipboard)
{
  WaitResults results;

  g_return_val_if_fail (clipboard != NULL, NULL);
  
  results.data = NULL;
  results.loop = g_main_loop_new (NULL, TRUE);

  gtk_clipboard_request_uris (clipboard,
			      clipboard_uris_received_func,
			      &results);

  if (g_main_loop_is_running (results.loop))
    {
1643
      gdk_threads_leave ();
1644
      g_main_loop_run (results.loop);
1645
      gdk_threads_enter ();
1646 1647 1648 1649 1650 1651 1652
    }

  g_main_loop_unref (results.loop);

  return results.data;
}

1653 1654 1655 1656 1657 1658
/**
 * gtk_clipboard_get_display:
 * @clipboard: a #GtkClipboard
 *
 * Gets the #GdkDisplay associated with @clipboard
 *
1659
 * Returns: (transfer none): the #GdkDisplay associated with @clipboard
1660 1661
 *
 * Since: 2.2
1662 1663 1664 1665 1666 1667 1668 1669
 **/
GdkDisplay *
gtk_clipboard_get_display (GtkClipboard *clipboard)
{
  g_return_val_if_fail (clipboard != NULL, NULL);

  return clipboard->display;
}
1670

1671 1672 1673 1674 1675 1676
/**
 * gtk_clipboard_wait_is_text_available:
 * @clipboard: a #GtkClipboard
 * 
 * Test to see if there is text available to be pasted
 * This is done by requesting the TARGETS atom and checking
1677 1678 1679
 * if it contains any of the supported text targets. This function 
 * waits for the data to be received using the main loop, so events, 
 * timeouts, etc, may be dispatched during the wait.
1680 1681
 *
 * This function is a little faster than calling
1682
 * gtk_clipboard_wait_for_text() since it doesn’t need to retrieve
1683 1684
 * the actual text.
 * 
1685
 * Returns: %TRUE is there is text available, %FALSE otherwise.
1686 1687 1688 1689 1690 1691 1692
 **/
gboolean
gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

1693
  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"));
1694 1695 1696 1697 1698 1699 1700 1701
  if (data)
    {
      result = gtk_selection_data_targets_include_text (data);
      gtk_selection_data_free (data);
    }

  return result;
}
1702

1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
/**
 * gtk_clipboard_wait_is_rich_text_available:
 * @clipboard: a #GtkClipboard
 * @buffer: a #GtkTextBuffer
 *
 * Test to see if there is rich text available to be pasted
 * This is done by requesting the TARGETS atom and checking
 * if it contains any of the supported rich text targets. This function
 * waits for the data to be received using the main loop, so events,
 * timeouts, etc, may be dispatched during the wait.
 *
 * This function is a little faster than calling
1715
 * gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve
1716 1717
 * the actual text.
 *
1718
 * Returns: %TRUE is there is rich text available, %FALSE otherwise.
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
 *
 * Since: 2.10
 **/
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;
}

1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
/**
 * gtk_clipboard_wait_is_image_available:
 * @clipboard: a #GtkClipboard
 * 
 * Test to see if there is an image available to be pasted
 * This is done by requesting the TARGETS atom and checking
 * if it contains any of the supported image targets. This function 
 * waits for the data to be received using the main loop, so events, 
 * timeouts, etc, may be dispatched during the wait.
 *
 * This function is a little faster than calling
1753
 * gtk_clipboard_wait_for_image() since it doesn’t need to retrieve
1754 1755
 * the actual image data.
 * 
1756
 * Returns: %TRUE is there is an image available, %FALSE otherwise.
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
 *
 * Since: 2.6
 **/
gboolean
gtk_clipboard_wait_is_image_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

  data = gtk_clipboard_wait_for_contents (clipboard, 
1767