gtkclipboard.c 63.2 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 25 26
#include <string.h>

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

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

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

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

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

/**
 * SECTION:gtkclipboard
 * @Short_description: Storing data on clipboards
 * @Title: Clipboards
 * @See_also: #GtkSelection
 *
 * 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
 * corresponds to the "CLIPBOARD" atom; another commonly used clipboard
 * is the "PRIMARY" clipboard, which, in X, traditionally contains
 * 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
 * provides the clipboard's contents the contents are simply the
 * 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
 * when the request fails.) If you don't want to deal with providing
 * 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+.)
 */


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

115 116
typedef struct _GtkClipboardClass GtkClipboardClass;

117 118
typedef struct _RequestContentsInfo RequestContentsInfo;
typedef struct _RequestTextInfo RequestTextInfo;
119
typedef struct _RequestRichTextInfo RequestRichTextInfo;
120
typedef struct _RequestImageInfo RequestImageInfo;
121
typedef struct _RequestURIInfo RequestURIInfo;
122
typedef struct _RequestTargetsInfo RequestTargetsInfo;
123 124 125

struct _GtkClipboard 
{
126
  GObject parent_instance;
127

128 129 130 131 132 133 134 135 136 137
  GdkAtom selection;

  GtkClipboardGetFunc get_func;
  GtkClipboardClearFunc clear_func;
  gpointer user_data;
  gboolean have_owner;

  guint32 timestamp;

  gboolean have_selection;
138
  GdkDisplay *display;
139 140 141 142

  GdkAtom *cached_targets;
  gint     n_cached_targets;

143
  gulong     notify_signal_id;
144 145 146 147 148
  gboolean   storing_selection;
  GMainLoop *store_loop;
  guint      store_timeout;
  gint       n_storable_targets;
  GdkAtom   *storable_targets;
149 150
};

151 152 153
struct _GtkClipboardClass
{
  GObjectClass parent_class;
154 155 156

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

159 160 161 162 163 164 165 166 167 168 169 170
struct _RequestContentsInfo
{
  GtkClipboardReceivedFunc callback;
  gpointer user_data;
};

struct _RequestTextInfo
{
  GtkClipboardTextReceivedFunc callback;
  gpointer user_data;
};

171 172 173 174 175 176 177 178 179
struct _RequestRichTextInfo
{
  GtkClipboardRichTextReceivedFunc callback;
  GdkAtom *atoms;
  gint     n_atoms;
  gint     current_atom;
  gpointer user_data;
};

180 181 182 183 184 185
struct _RequestImageInfo
{
  GtkClipboardImageReceivedFunc callback;
  gpointer user_data;
};

186 187 188 189 190 191
struct _RequestURIInfo
{
  GtkClipboardURIReceivedFunc callback;
  gpointer user_data;
};

192 193 194 195 196 197
struct _RequestTargetsInfo
{
  GtkClipboardTargetsReceivedFunc callback;
  gpointer user_data;
};

198 199 200 201 202 203 204 205 206 207 208 209 210 211
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 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);

212

213 214 215 216
enum {
  TARGET_STRING,
  TARGET_TEXT,
  TARGET_COMPOUND_TEXT,
217 218
  TARGET_UTF8_STRING,
  TARGET_SAVE_TARGETS
219 220
};

221
static const gchar request_contents_key[] = "gtk-request-contents";
222 223
static GQuark request_contents_key_id = 0;

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

227
static guint         clipboard_signals[LAST_SIGNAL] = { 0 };
228

Matthias Clasen's avatar
Matthias Clasen committed
229
G_DEFINE_TYPE (GtkClipboard, gtk_clipboard, G_TYPE_OBJECT)
230 231 232

static void
gtk_clipboard_init (GtkClipboard *object)
233 234 235 236 237 238 239 240 241
{
}

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

  gobject_class->finalize = gtk_clipboard_finalize;
242

243
  class->owner_change = gtk_clipboard_owner_change;
244

Matthias Clasen's avatar
Matthias Clasen committed
245 246 247
  /**
   * GtkClipboard::owner-change:
   * @clipboard: the #GtkClipboard on which the signal is emitted
248
   * @event: (type Gdk.EventOwnerChange): the @GdkEventOwnerChange event
Matthias Clasen's avatar
Matthias Clasen committed
249 250
   *
   * The ::owner-change signal is emitted when GTK+ receives an
251
   * event that indicates that the ownership of the selection
Matthias Clasen's avatar
Matthias Clasen committed
252 253 254
   * associated with @clipboard has changed.
   *
   * Since: 2.6
255
   */
256
  clipboard_signals[OWNER_CHANGE] =
257
    g_signal_new (I_("owner-change"),
258 259 260 261 262 263 264
		  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);
265 266 267
}

static void
268
gtk_clipboard_finalize (GObject *object)
269
{
270
  GtkClipboard *clipboard;
271 272
  GtkWidget *clipboard_widget = NULL;
  GSList *clipboards = NULL;
273 274 275

  clipboard = GTK_CLIPBOARD (object);

276 277 278
  if (clipboard->display)
    {
      clipboards = g_object_get_data (G_OBJECT (clipboard->display), "gtk-clipboard-list");
279

280 281 282 283 284 285 286 287 288 289 290 291 292 293
      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");
    }
294

295
  clipboard_unset (clipboard);
296

297 298 299
  if (clipboard->store_loop && g_main_loop_is_running (clipboard->store_loop))
    g_main_loop_quit (clipboard->store_loop);

300 301 302 303 304
  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);
305

306
  g_free (clipboard->storable_targets);
307
  g_free (clipboard->cached_targets);
308

309
  G_OBJECT_CLASS (gtk_clipboard_parent_class)->finalize (object);
310 311 312 313 314 315 316 317 318 319 320 321
}

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);
322
  g_object_set_data (G_OBJECT (display), I_("gtk-clipboard-list"), clipboards);
323
  g_object_unref (clipboard);
324 325
}

326
/**
327 328
 * gtk_clipboard_get_for_display:
 * @display: the display for which the clipboard is to be retrieved or created
329 330
 * @selection: a #GdkAtom which identifies the clipboard to use.
 *
331
 * Returns the clipboard object for the given selection.
332
 * Cut/copy/paste menu items and keyboard shortcuts should use
333 334 335
 * 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.)
336 337 338 339 340 341 342
 * 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.
 *
 * (Passing #GDK_NONE is the same as using <literal>gdk_atom_intern
343
 * ("CLIPBOARD", FALSE)</literal>. See <ulink
344 345
 * url="http://www.freedesktop.org/Standards/clipboards-spec">
 * http://www.freedesktop.org/Standards/clipboards-spec</ulink>
346 347 348
 * for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY"
 * selections under the X window system. On Win32 the
 * #GDK_SELECTION_PRIMARY clipboard is essentially ignored.)
349 350 351 352 353 354 355
 *
 * It's possible to have arbitrary named clipboards; if you do invent
 * 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,
 * if your application called "Foo" has a special-purpose
 * clipboard, you might call it "_FOO_SPECIAL_CLIPBOARD".
356
 *
357
 * Return value: (transfer none): the appropriate clipboard object. If no
358 359 360
 *   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.
361 362
 *
 * Since: 2.2
363 364
 **/
GtkClipboard *
365 366
gtk_clipboard_get_for_display (GdkDisplay *display, 
			       GdkAtom     selection)
367
{
368
  g_return_val_if_fail (display != NULL, NULL); /* See bgo#463773; this is needed because Flash Player sucks */
369
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
370
  g_return_val_if_fail (!gdk_display_is_closed (display), NULL);
371

372
  return clipboard_peek (display, selection, FALSE);
373 374
}

375

376
/**
Matthias Clasen's avatar
Matthias Clasen committed
377 378 379
 * gtk_clipboard_get:
 * @selection: a #GdkAtom which identifies the clipboard to use
 *
380 381
 * Returns the clipboard object for the given selection.
 * See gtk_clipboard_get_for_display() for complete details.
Matthias Clasen's avatar
Matthias Clasen committed
382
 *
383
 * Return value: (transfer none): the appropriate clipboard object. If no clipboard
Matthias Clasen's avatar
Matthias Clasen committed
384 385 386 387
 *     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.
 */
388 389 390
GtkClipboard *
gtk_clipboard_get (GdkAtom selection)
{
Owen Taylor's avatar
Owen Taylor committed
391
  return gtk_clipboard_get_for_display (gdk_display_get_default (), selection);
392 393
}

394 395 396
static void 
selection_get_cb (GtkWidget          *widget,
		  GtkSelectionData   *selection_data,
397 398
		  guint               info,
		  guint               time)
399
{
400 401 402 403
  GtkClipboard *clipboard;

  clipboard = gtk_widget_get_clipboard (widget,
                                        gtk_selection_data_get_selection (selection_data));
404 405 406 407 408 409 410 411 412

  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)
{
413
  GtkClipboard *clipboard = gtk_widget_get_clipboard (widget, event->selection);
414 415 416 417

  if (clipboard)
    {
      clipboard_unset (clipboard);
418

419 420 421 422 423 424
      return TRUE;
    }

  return FALSE;
}

Havoc Pennington's avatar
Havoc Pennington committed
425
static GtkWidget *
426 427
make_clipboard_widget (GdkDisplay *display, 
		       gboolean    provider)
428
{
429
  GtkWidget *widget = gtk_invisible_new_for_screen (gdk_display_get_default_screen (display));
430

431
  g_signal_connect (widget, "selection-received",
Manish Singh's avatar
Manish Singh committed
432
		    G_CALLBACK (selection_received), NULL);
433 434 435 436 437 438

  if (provider)
    {
      /* We need this for gdk_x11_get_server_time() */
      gtk_widget_add_events (widget, GDK_PROPERTY_CHANGE_MASK);
      
439
      g_signal_connect (widget, "selection-get",
Manish Singh's avatar
Manish Singh committed
440
			G_CALLBACK (selection_get_cb), NULL);
441
      g_signal_connect (widget, "selection-clear-event",
Manish Singh's avatar
Manish Singh committed
442
			G_CALLBACK (selection_clear_event_cb), NULL);
443 444 445 446 447
    }

  return widget;
}

448 449
static GtkWidget *
get_clipboard_widget (GdkDisplay *display)
450
{
451 452 453 454
  GtkWidget *clip_widget = g_object_get_data (G_OBJECT (display), "gtk-clipboard-widget");
  if (!clip_widget)
    {
      clip_widget = make_clipboard_widget (display, TRUE);
455
      g_object_set_data (G_OBJECT (display), I_("gtk-clipboard-widget"), clip_widget);
456 457 458
    }

  return clip_widget;
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
}

/* 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
 * and we won't get selections being rejected just because
 * we are using a correct timestamp from an event, but used
 * CurrentTime previously.
 */
static guint32
clipboard_get_timestamp (GtkClipboard *clipboard)
{
479
  GtkWidget *clipboard_widget = get_clipboard_widget (clipboard->display);
480
  guint32 timestamp = gtk_get_current_event_time ();
481
  GdkWindow *window;
482 483 484

  if (timestamp == GDK_CURRENT_TIME)
    {
485
      window = gtk_widget_get_window (clipboard_widget);
486
#ifdef GDK_WINDOWING_X11
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
      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
506
#endif
507 508 509
	{
	  /* No implementation */
	}
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 583 584 585 586 587 588 589 590 591 592 593 594 595
    }
  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)
{
596
  GtkWidget *clipboard_widget = get_clipboard_widget (clipboard->display);
597

598 599 600 601
  if (gtk_selection_owner_set_for_display (clipboard->display,
					   clipboard_widget,
					   clipboard->selection,
					   clipboard_get_timestamp (clipboard)))
602 603 604
    {
      clipboard->have_selection = TRUE;

605 606 607 608 609 610 611
      if (clipboard->n_cached_targets != -1)
        {
          g_free (clipboard->cached_targets);
	  clipboard->cached_targets = NULL;
          clipboard->n_cached_targets = -1;
        }

612 613 614 615 616
      if (!(clipboard->have_owner && have_owner) ||
	  clipboard->user_data != user_data)
	{
	  clipboard_unset (clipboard);

617 618 619 620
	  clipboard->user_data = user_data;
	  clipboard->have_owner = have_owner;
	  if (have_owner)
	      clipboard_add_owner_notify (clipboard);
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
 	}

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

/**
637
 * gtk_clipboard_set_with_data: (skip)
638
 * @clipboard: a #GtkClipboard
639 640
 * @targets: (array length=n_targets): array containing information
 *     about the available forms for the clipboard data
641 642 643 644 645 646 647
 * @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.
 *
648
 * Virtually sets the contents of the specified clipboard by providing
649 650
 * a list of supported formats for the clipboard data and a function
 * to call to get the actual data when it is requested.
651 652 653 654
 *
 * Return value: %TRUE if setting the clipboard data succeeded.
 *    If setting the clipboard data failed the provided callback
 *    functions will be ignored.
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
 **/
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);
}

/**
674
 * gtk_clipboard_set_with_owner: (skip)
675
 * @clipboard: a #GtkClipboard
676 677
 * @targets: (array length=n_targets): array containing information
 *     about the available forms for the clipboard data
678 679 680 681 682 683 684 685
 * @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
 * @owner: an object that "owns" the data. This object will be passed
 *     to the callbacks when called
 *
686
 * Virtually sets the contents of the specified clipboard by providing
687 688 689
 * 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
690
 * The difference between this function and gtk_clipboard_set_with_data()
691
 * is that instead of an generic @user_data pointer, a #GObject is passed
692 693 694 695 696
 * in.
 *
 * Return value: %TRUE if setting the clipboard data succeeded.
 *     If setting the clipboard data failed the provided callback
 *     functions will be ignored.
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
 **/
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);
}

/**
 * gtk_clipboard_get_owner:
 * @clipboard: a #GtkClipboard
719 720 721 722
 *
 * 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
723
 * by gtk_clipboard_set_with_owner().
724 725 726
 *
 * Return value: (transfer none): the owner of the clipboard, if any;
 *     otherwise %NULL.
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
 **/
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;
744 745
  gboolean old_have_owner;
  gint old_n_storable_targets;
746 747 748
  
  old_clear_func = clipboard->clear_func;
  old_data = clipboard->user_data;
749 750 751 752
  old_have_owner = clipboard->have_owner;
  old_n_storable_targets = clipboard->n_storable_targets;
  
  if (old_have_owner)
753 754 755 756
    {
      clipboard_remove_owner_notify (clipboard);
      clipboard->have_owner = FALSE;
    }
757 758 759 760 761

  clipboard->n_storable_targets = -1;
  g_free (clipboard->storable_targets);
  clipboard->storable_targets = NULL;
      
762 763 764 765 766 767
  clipboard->get_func = NULL;
  clipboard->clear_func = NULL;
  clipboard->user_data = NULL;
  
  if (old_clear_func)
    old_clear_func (clipboard, old_data);
768 769 770 771 772 773

  /* If we've transferred the clipboard data to the manager,
   * unref the owner
   */
  if (old_have_owner &&
      old_n_storable_targets != -1)
774
    g_object_unref (old_data);
775 776 777 778 779 780
}

/**
 * gtk_clipboard_clear:
 * @clipboard:  a #GtkClipboard
 * 
781
 * Clears the contents of the clipboard. Generally this should only
782 783
 * be called between the time you call gtk_clipboard_set_with_owner()
 * or gtk_clipboard_set_with_data(),
784 785 786 787 788 789 790 791 792
 * 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);

  if (clipboard->have_selection)
793 794 795 796
    gtk_selection_owner_set_for_display (clipboard->display, 
					 NULL,
					 clipboard->selection,
					 clipboard_get_timestamp (clipboard));
797 798
}

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

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

815

816 817 818 819 820
/**
 * gtk_clipboard_set_text:
 * @clipboard: a #GtkClipboard object
 * @text:      a UTF-8 string.
 * @len:       length of @text, in bytes, or -1, in which case
Matthias Clasen's avatar
Matthias Clasen committed
821
 *             the length will be determined with <function>strlen()</function>.
822
 * 
823
 * Sets the contents of the clipboard to the given UTF-8 string. GTK+ will
824 825 826 827 828 829 830 831 832
 * 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)
{
833 834
  GtkTargetList *list;
  GtkTargetEntry *targets;
835
  gint n_targets;
836 837 838

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

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

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

854
  gtk_target_table_free (targets, n_targets);
855
  gtk_target_list_unref (list);
856 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
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;
892
  gint n_targets;
893 894 895 896 897 898 899

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

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

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

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

912 913 914 915 916 917 918
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
919
  g_object_set_qdata (G_OBJECT (widget), request_contents_key_id, info);
920 921 922 923 924 925 926 927
}

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

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

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

  g_free (request_info);

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

/**
 * gtk_clipboard_request_contents:
 * @clipboard: a #GtkClipboard
952 953 954 955 956
 * @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.
957
 * @user_data: user data to pass to @callback
958
 *
959 960 961 962 963 964 965 966 967 968 969 970
 * 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)
{
  RequestContentsInfo *info;
  GtkWidget *widget;
971
  GtkWidget *clipboard_widget;
972 973 974 975 976

  g_return_if_fail (clipboard != NULL);
  g_return_if_fail (target != GDK_NONE);
  g_return_if_fail (callback != NULL);
  
977
  clipboard_widget = get_clipboard_widget (clipboard->display);
978 979

  if (get_request_contents_info (clipboard_widget))
980
    widget = make_clipboard_widget (clipboard->display, FALSE);
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
  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;

1002
  result = (gchar *) gtk_selection_data_get_text (selection_data);
1003 1004 1005

  if (!result)
    {
1006 1007 1008
      /* 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.
1009
       */
1010 1011 1012
      GdkAtom target = gtk_selection_data_get_target (selection_data);

      if (target == gdk_atom_intern_static_string ("UTF8_STRING"))
1013 1014
	{
	  gtk_clipboard_request_contents (clipboard,
1015
					  gdk_atom_intern_static_string ("COMPOUND_TEXT"), 
1016 1017 1018
					  request_text_received_func, info);
	  return;
	}
1019
      else if (target == gdk_atom_intern_static_string ("COMPOUND_TEXT"))
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
	{
	  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
1036 1037
 * @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.)
1038
 * @user_data: user data to pass to @callback.
1039
 *
1040 1041
 * Requests the contents of the clipboard as text. When the text is
 * later received, it will be converted to UTF-8 if necessary, and
1042
 * @callback will be called.
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
 *
 * 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;

1063
  gtk_clipboard_request_contents (clipboard, gdk_atom_intern_static_string ("UTF8_STRING"),
1064 1065 1066 1067
				  request_text_received_func,
				  info);
}

1068 1069 1070 1071 1072 1073 1074 1075 1076
static void
request_rich_text_received_func (GtkClipboard     *clipboard,
                                 GtkSelectionData *selection_data,
                                 gpointer          data)
{
  RequestRichTextInfo *info = data;
  guint8 *result = NULL;
  gsize length = 0;

1077 1078
  result = (guint8 *) gtk_selection_data_get_data (selection_data);
  length = gtk_selection_data_get_length (selection_data);
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089

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

1090 1091
  info->callback (clipboard, gtk_selection_data_get_target (selection_data),
                  result, length,
1092 1093 1094 1095 1096 1097 1098 1099
                  info->user_data);
  g_free (info->atoms);
  g_free (info);
}

/**
 * gtk_clipboard_request_rich_text:
 * @clipboard: a #GtkClipboard
1100 1101 1102
 * @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.)
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
 * @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
 * parameter will contain @text's length. This function can fail for
 * 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);
}

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
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
1156
       * if we asked for image/gif and didn't get it, try image/bmp;
1157 1158
       * If we asked for anything else and didn't get it, give up.
       */
1159 1160 1161
      GdkAtom target = gtk_selection_data_get_target (selection_data);

      if (target == gdk_atom_intern_static_string ("image/png"))
1162 1163
	{
	  gtk_clipboard_request_contents (clipboard,
1164
					  gdk_atom_intern_static_string ("image/jpeg"), 
1165 1166 1167
					  request_image_received_func, info);
	  return;
	}
1168
      else if (target == gdk_atom_intern_static_string ("image/jpeg"))
1169 1170
	{
	  gtk_clipboard_request_contents (clipboard,
1171
					  gdk_atom_intern_static_string ("image/gif"), 
Matthias Clasen's avatar
Matthias Clasen committed
1172 1173 1174
					  request_image_received_func, info);
	  return;
	}
1175
      else if (target == gdk_atom_intern_static_string ("image/gif"))
Matthias Clasen's avatar
Matthias Clasen committed
1176 1177
	{
	  gtk_clipboard_request_contents (clipboard,
1178
					  gdk_atom_intern_static_string ("image/bmp"), 
Matthias Clasen's avatar
Matthias Clasen committed
1179
					  request_image_received_func, info);
1180 1181 1182 1183 1184 1185
	  return;
	}
    }

  info->callback (clipboard, result, info->user_data);
  g_free (info);
1186 1187 1188

  if (result)
    g_object_unref (result);
1189 1190 1191 1192 1193
}

/**
 * gtk_clipboard_request_image:
 * @clipboard: a #GtkClipboard
1194 1195
 * @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.)
1196
 * @user_data: user data to pass to @callback.
1197
 *
1198 1199
 * Requests the contents of the clipboard as image. When the image is
 * later received, it will be converted to a #GdkPixbuf, and
1200
 * @callback will be called.
1201
 *
1202 1203 1204 1205
 * 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
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
 * 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, 
1225
				  gdk_atom_intern_static_string ("image/png"),
1226 1227 1228 1229
				  request_image_received_func,
				  info);
}

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
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
1248 1249
 * @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.)
1250
 * @user_data: user data to pass to @callback.
1251
 *
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
 * 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);
}

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
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
1301 1302 1303
 * @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.)
1304
 * @user_data: user data to pass to @callback.
1305 1306 1307
 *
 * Requests the contents of the clipboard as list of supported targets.
 * When the list is later received, @callback will be called.
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
 *
 * 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);
1323 1324 1325 1326 1327 1328 1329 1330

  /* 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;
    }
1331 1332 1333 1334 1335
  
  info = g_new (RequestTargetsInfo, 1);
  info->callback = callback;
  info->user_data = user_data;

1336
  gtk_clipboard_request_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"),
1337 1338 1339
				  request_targets_received_func,
				  info);
}
1340 1341 1342 1343 1344

typedef struct
{
  GMainLoop *loop;
  gpointer data;
1345 1346
  GdkAtom format; /* used by rich text */
  gsize length; /* used by rich text */
1347 1348 1349 1350 1351 1352 1353 1354 1355
} WaitResults;

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

1356
  if (gtk_selection_data_get_length (selection_data) >= 0)
1357 1358
    results->data = gtk_selection_data_copy (selection_data);
  
Manish Singh's avatar
Manish Singh committed
1359
  g_main_loop_quit (results->loop);
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
}

/**
 * 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.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
1372
 * Return value: a newly-allocated #GtkSelectionData object or %NULL
1373
 *               if retrieving the given target failed. If non-%NULL,
Matthias Clasen's avatar
Matthias Clasen committed
1374 1375
 *               this value must be freed with gtk_selection_data_free() 
 *               when you are finished with it.
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
 **/
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
1387
  results.loop = g_main_loop_new (NULL, TRUE);
1388 1389 1390 1391 1392

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

Manish Singh's avatar
Manish Singh committed
1393
  if (g_main_loop_is_running (results.loop))
1394
    {
1395
      gdk_threads_leave ();
Manish Singh's avatar
Manish Singh committed
1396
      g_main_loop_run (results.loop);
1397
      gdk_threads_enter ();
1398
    }
1399

Manish Singh's avatar
Manish Singh committed
1400
  g_main_loop_unref (results.loop);
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412

  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
1413
  g_main_loop_quit (results->loop);
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
}

/**
 * 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.
 * 
1425
 * Return value: a newly-allocated UTF-8 string which must
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
 *               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
1440
  results.loop = g_main_loop_new (NULL, TRUE);
1441 1442 1443 1444 1445

  gtk_clipboard_request_text (clipboard,
			      clipboard_text_received_func,
			      &results);

Manish Singh's avatar
Manish Singh committed
1446
  if (g_main_loop_is_running (results.loop))
1447
    {
1448
      gdk_threads_leave ();
Manish Singh's avatar
Manish Singh committed
1449
      g_main_loop_run (results.loop);
1450
      gdk_threads_enter ();
1451
    }
1452

Manish Singh's avatar
Manish Singh committed
1453
  g_main_loop_unref (results.loop);
1454 1455 1456

  return results.data;
}
1457

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
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
1477
 * @format: (out): return location for the format of the returned data
1478 1479 1480 1481 1482 1483
 * @length: return location for the length of the returned data
 *
 * 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.
 *
1484 1485 1486 1487 1488 1489 1490
 * Return value: (array length=length) (transfer full): a
 *               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.)
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
 *
 * 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))
    {
1516
      gdk_threads_leave ();
1517
      g_main_loop_run (results.loop);
1518
      gdk_threads_enter ();
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
    }

  g_main_loop_unref (results.loop);

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

  return results.data;
}

1529 1530 1531 1532 1533 1534 1535
static void 
clipboard_image_received_func (GtkClipboard *clipboard,
			       GdkPixbuf    *pixbuf,
			       gpointer      data)
{
  WaitResults *results = data;

1536 1537 1538
  if (pixbuf)
    results->data = g_object_ref (pixbuf);

1539 1540 1541 1542 1543 1544
  g_main_loop_quit (results->loop);
}

/**
 * gtk_clipboard_wait_for_image:
 * @clipboard: a #GtkClipboard
1545
 *
1546 1547 1548 1549
 * 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.
1550 1551 1552 1553 1554 1555 1556
 *
 * Return value: (transfer full): a newly-allocated #GdkPixbuf
 *     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.)
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
 *
 * 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))
    {
1576
      gdk_threads_leave ();
1577
      g_main_loop_run (results.loop);
1578
      gdk_threads_enter ();
1579 1580 1581 1582 1583 1584 1585
    }

  g_main_loop_unref (results.loop);

  return results.data;
}

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
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.
1604 1605 1606
 *
 * Return value: (array zero-terminated=1) (element-type utf8) (transfer full): a newly-allocated
 * 		 %NULL-terminated array of strings which must
1607
 *               be freed with g_strfreev(), or %NULL if
1608 1609 1610
 *               retrieving the selection data failed. (This
 *               could happen for various reasons, in particular
 *               if the clipboard was empty or if the contents of
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
 *               the clipboard could not be converted into URI form.)
 *
 * 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))
    {
1631
      gdk_threads_leave ();
1632
      g_main_loop_run (results.loop);
1633
      gdk_threads_enter ();
1634 1635 1636 1637 1638 1639 1640
    }

  g_main_loop_unref (results.loop);

  return results.data;
}

1641 1642 1643 1644 1645 1646
/**
 * gtk_clipboard_get_display:
 * @clipboard: a #GtkClipboard
 *
 * Gets the #GdkDisplay associated with @clipboard
 *
1647
 * Return value: (transfer none): the #GdkDisplay associated with @clipboard
1648 1649
 *
 * Since: 2.2
1650 1651 1652 1653 1654 1655 1656 1657
 **/
GdkDisplay *
gtk_clipboard_get_display (GtkClipboard *clipboard)
{
  g_return_val_if_fail (clipboard != NULL, NULL);

  return clipboard->display;
}
1658

1659 1660 1661 1662 1663 1664
/**
 * 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
1665 1666 1667
 * 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.
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
 *
 * This function is a little faster than calling
 * gtk_clipboard_wait_for_text() since it doesn't need to retrieve
 * the actual text.
 * 
 * Return value: %TRUE is there is text available, %FALSE otherwise.
 **/
gboolean
gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

1681
  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"));
1682 1683 1684 1685 1686 1687 1688 1689
  if (data)
    {
      result = gtk_selection_data_targets_include_text (data);
      gtk_selection_data_free (data);
    }

  return result;
}
1690

1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
/**
 * 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
 * gtk_clipboard_wait_for_rich_text() since it doesn't need to retrieve
 * the actual text.
 *
 * Return value: %TRUE is there is rich text available, %FALSE otherwise.
 *
 * 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;
}

1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
/**
 * 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
 * gtk_clipboard_wait_for_image() since it doesn't need to retrieve
 * the actual image data.
 * 
 * Return value: %TRUE is there is an image available, %FALSE otherwise.
 *
 * Since: 2.6
 **/
gboolean
gtk_clipboard_wait_is_image_available (GtkClipboard *clipboard)
{
  GtkSelectionData *data;
  gboolean result = FALSE;

  data = gtk_clipboard_wait_for_contents (clipboard, 
1755
					  gdk_atom_intern_static_string ("TARGETS"));
1756 1757 1758 1759 1760 1761 1762 1763 1764
  if (data)
    {
      result = gtk_selection_data_targets_include_image (data, FALSE);
      gtk_selection_data_free (data);
    }

  return result;
}

1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
/**
 * gtk_clipboard_wait_is_uris_available:
 * @clipboard: a #GtkClipboard
 * 
 * Test to see if there is a list of URIs available to be pasted
 * This is done by requesting the TARGETS atom and checking
 * if it contains the URI 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
 * gtk_clipboard_wait_for_uris() since it doesn't need to retrieve
 * the actual URI data.
 * 
 * Return value: %TRUE is there is an URI list available, %FALSE otherwise.
 *
 * Since: 2.14
 **/
gboolean
gtk_clipboard_wait_is_uris_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_uri (data);
      gtk_selection_data_free (data);
    }

  return result;
}

1800
/**
1801
 * gtk_clipboard_wait_for_targets:
1802
 * @clipboard: a #GtkClipboard
1803 1804 1805
 * @targets: (out) (array length=n_targets) (transfer container): location
 *           to store an array of targets. The result stored here must
 *           be freed with g_free().
1806 1807 1808
 * @n_targets: location to store number of items in @targets.
 *
 * Returns a list of targets that are present on the clipboard, or %NULL
1809
 * if there aren't any targets available. The returned list must be
1810
 * freed with g_free().
1811
 * This function waits for the data to be received using the main
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
 * loop, so events, timeouts, etc, may be dispatched during the wait.
 *
 * Return value: %TRUE if any targets are present on the clipboard,
 *               otherwise %FALSE.
 *
 * Since: 2.4
 */
gboolean
gtk_clipboard_wait_for_targets (GtkClipboard  *clipboard, 
				GdkAtom      **targets,
				gint          *n_targets)
{
  GtkSelectionData *data;
  gboolean result = FALSE;
  
  g_return_val_if_fail (clipboard != NULL, FALSE);

1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
  /* 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;
 
      if (targets)
 	*targets = g_memdup (clipboard->cached_targets,
 			     clipboard->n_cached_targets * sizeof (GdkAtom));

       return TRUE;
    }
  
1843 1844 1845
  if (n_targets)
    *n_targets = 0;
      
1846 1847
  if (targets)
    *targets = NULL;      
1848

1849
  data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern_static_string ("TARGETS"));
1850 1851 1852

  if (data)
    {
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
      GdkAtom *tmp_targets;
      gint tmp_n_targets;
       
      result = gtk_selection_data_get_targets (data, &