gtkselection.c 86.1 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * 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
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16 17
 */

18
/* This file implements most of the work of the ICCCM selection protocol.
Elliot Lee's avatar
Elliot Lee committed
19
 * The code was written after an intensive study of the equivalent part
20
 * of John Ousterhout’s Tk toolkit, and does many things in much the 
Elliot Lee's avatar
Elliot Lee committed
21 22
 * same way.
 *
23
 * The one thing in the ICCCM that isn’t fully supported here (or in Tk)
Elliot Lee's avatar
Elliot Lee committed
24 25 26 27 28
 * is side effects targets. For these to be handled properly, MULTIPLE
 * targets need to be done in the order specified. This cannot be
 * guaranteed with the way we do things, since if we are doing INCR
 * transfers, the order will depend on the timing of the requestor.
 *
29
 * By Owen Taylor <owt1@cornell.edu>	      8/16/97
Elliot Lee's avatar
Elliot Lee committed
30 31 32 33
 */

/* Terminology note: when not otherwise specified, the term "incr" below
 * refers to the _sending_ part of the INCR protocol. The receiving
34 35
 * portion is referred to just as “retrieval”. (Terminology borrowed
 * from Tk, because there is no good opposite to “retrieval” in English.
36
 * “send” can’t be made into a noun gracefully and we’re already using
37
 * “emission” for something else ....)
Elliot Lee's avatar
Elliot Lee committed
38 39 40 41 42 43 44
 */

/* The MOTIF entry widget seems to ask for the TARGETS target, then
   (regardless of the reply) ask for the TEXT target. It's slightly
   possible though that it somehow thinks we are responding negatively
   to the TARGETS request, though I don't really think so ... */

45
/*
46
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
47 48 49 50 51
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/**
 * SECTION:gtkselection
 * @Title: Selections
 * @Short_description: Functions for handling inter-process communication
 *     via selections
 * @See_also: #GtkWidget - Much of the operation of selections happens via
 *     signals for #GtkWidget. In particular, if you are using the functions
 *     in this section, you may need to pay attention to
 *     #GtkWidget::selection-get, #GtkWidget::selection-received and
 *     #GtkWidget::selection-clear-event signals
 *
 * The selection mechanism provides the basis for different types
 * of communication between processes. In particular, drag and drop and
 * #GtkClipboard work via selections. You will very seldom or
 * never need to use most of the functions in this section directly;
 * #GtkClipboard provides a nicer interface to the same functionality.
 *
69 70 71 72 73 74 75
 * If an application is expected to exchange image data and work
 * on Windows, it is highly advised to support at least "image/bmp" target
 * for the widest possible compatibility with third-party applications.
 * #GtkClipboard already does that by using gtk_target_list_add_image_targets()
 * and gtk_selection_data_set_pixbuf() or gtk_selection_data_get_pixbuf(),
 * which is one of the reasons why it is advised to use #GtkClipboard.
 *
76
 * Some of the datatypes defined this section are used in
77
 * the #GtkClipboard and drag-and-drop API’s as well. The
78
 * #GtkTargetEntry and #GtkTargetList objects represent
79 80 81 82 83 84
 * lists of data types that are supported when sending or
 * receiving data. The #GtkSelectionData object is used to
 * store a chunk of data along with the data type and other
 * associated information.
 */

85 86 87
/* We are using deprecated API, here, and we know that */
#define GDK_DISABLE_DEPRECATION_WARNINGS

88
#include "config.h"
89 90 91 92

#include "gtkselection.h"
#include "gtkselectionprivate.h"

Elliot Lee's avatar
Elliot Lee committed
93
#include <stdarg.h>
94
#include <string.h>
95 96
#include "gdk.h"

Elliot Lee's avatar
Elliot Lee committed
97
#include "gtkmain.h"
98
#include "gtkdebug.h"
99
#include "gtktextbufferrichtext.h"
100
#include "gtkintl.h"
101
#include "gdk-pixbuf/gdk-pixbuf.h"
Elliot Lee's avatar
Elliot Lee committed
102

103 104 105 106
#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
#endif

107 108 109 110
#ifdef GDK_WINDOWING_WIN32
#include "win32/gdkwin32.h"
#endif

111 112 113 114
#ifdef GDK_WINDOWING_WAYLAND
#include <gdk/wayland/gdkwayland.h>
#endif

115
#undef DEBUG_SELECTION
Elliot Lee's avatar
Elliot Lee committed
116 117 118

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
119
#ifdef GDK_WINDOWING_X11
120
#define GTK_SELECTION_MAX_SIZE(display)                                 \
121
  GDK_IS_X11_DISPLAY (display) ?                                        \
122 123 124
  MIN(262144,                                                           \
      XExtendedMaxRequestSize (GDK_DISPLAY_XDISPLAY (display)) == 0     \
       ? XMaxRequestSize (GDK_DISPLAY_XDISPLAY (display)) - 100         \
125 126
       : XExtendedMaxRequestSize (GDK_DISPLAY_XDISPLAY (display)) - 100)\
  : G_MAXINT
127 128 129
#else
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE(display) G_MAXINT
130
#endif
Owen Taylor's avatar
Owen Taylor committed
131

132
#define IDLE_ABORT_TIME 30
Owen Taylor's avatar
Owen Taylor committed
133

Elliot Lee's avatar
Elliot Lee committed
134 135 136 137 138
enum {
  INCR,
  MULTIPLE,
  TARGETS,
  TIMESTAMP,
139
  SAVE_TARGETS,
Elliot Lee's avatar
Elliot Lee committed
140 141 142 143 144 145 146 147 148 149
  LAST_ATOM
};

typedef struct _GtkSelectionInfo GtkSelectionInfo;
typedef struct _GtkIncrConversion GtkIncrConversion;
typedef struct _GtkIncrInfo GtkIncrInfo;
typedef struct _GtkRetrievalInfo GtkRetrievalInfo;

struct _GtkSelectionInfo
{
150 151 152 153
  GdkAtom	 selection;
  GtkWidget	*widget;	/* widget that owns selection */
  guint32	 time;		/* time used to acquire selection */
  GdkDisplay	*display;	/* needed in gtk_selection_remove_all */    
Elliot Lee's avatar
Elliot Lee committed
154 155 156 157
};

struct _GtkIncrConversion 
{
158 159
  GdkAtom	    target;	/* Requested target */
  GdkAtom	    property;	/* Property to store in */
Elliot Lee's avatar
Elliot Lee committed
160
  GtkSelectionData  data;	/* The data being supplied */
161
  gint		    offset;	/* Current offset in sent selection.
Elliot Lee's avatar
Elliot Lee committed
162 163
				 *  -1 => All done
				 *  -2 => Only the final (empty) portion
164
				 *	  left to send */
Elliot Lee's avatar
Elliot Lee committed
165 166 167 168 169 170 171
};

struct _GtkIncrInfo
{
  GdkWindow *requestor;		/* Requestor window - we create a GdkWindow
				   so we can receive events */
  GdkAtom    selection;		/* Selection we're sending */
172
  
Elliot Lee's avatar
Elliot Lee committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
  GtkIncrConversion *conversions; /* Information about requested conversions -
				   * With MULTIPLE requests (benighted 1980's
				   * hardware idea), there can be more than
				   * one */
  gint num_conversions;
  gint num_incrs;		/* number of remaining INCR style transactions */
  guint32 idle_time;
};


struct _GtkRetrievalInfo
{
  GtkWidget *widget;
  GdkAtom selection;		/* Selection being retrieved. */
  GdkAtom target;		/* Form of selection that we requested */
  guint32 idle_time;		/* Number of seconds since we last heard
				   from selection owner */
  guchar   *buffer;		/* Buffer in which to accumulate results */
191
  gint	   offset;		/* Current offset in buffer, -1 indicates
Elliot Lee's avatar
Elliot Lee committed
192
				   not yet started */
193
  guint32 notify_time;		/* Timestamp from SelectionNotify */
Elliot Lee's avatar
Elliot Lee committed
194 195 196
};

/* Local Functions */
197
static void gtk_selection_init              (void);
198 199
static gboolean gtk_selection_incr_timeout      (GtkIncrInfo      *info);
static gboolean gtk_selection_retrieval_timeout (GtkRetrievalInfo *info);
200 201 202 203 204 205 206 207 208 209 210 211
static void gtk_selection_retrieval_report  (GtkRetrievalInfo *info,
					     GdkAtom           type,
					     gint              format,
					     guchar           *buffer,
					     gint              length,
					     guint32           time);
static void gtk_selection_invoke_handler    (GtkWidget        *widget,
					     GtkSelectionData *data,
					     guint             time);
static void gtk_selection_default_handler   (GtkWidget        *widget,
					     GtkSelectionData *data);
static int  gtk_selection_bytes_per_item    (gint              format);
Elliot Lee's avatar
Elliot Lee committed
212 213 214 215 216 217 218 219

/* Local Data */
static gint initialize = TRUE;
static GList *current_retrievals = NULL;
static GList *current_incrs = NULL;
static GList *current_selections = NULL;

static GdkAtom gtk_selection_atoms[LAST_ATOM];
220
static const char gtk_selection_handler_key[] = "gtk-selection-handlers";
Elliot Lee's avatar
Elliot Lee committed
221

222 223 224 225 226 227 228 229
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

230 231 232

/**
 * gtk_target_list_new:
233 234
 * @targets: (array length=ntargets) (allow-none): Pointer to an array
 *   of #GtkTargetEntry
235
 * @ntargets: number of entries in @targets.
236 237 238
 * 
 * Creates a new #GtkTargetList from an array of #GtkTargetEntry.
 * 
239
 * Returns: (transfer full): the new #GtkTargetList.
240
 **/
241
GtkTargetList *
242 243
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
244
{
245
  GtkTargetList *result = g_slice_new (GtkTargetList);
246 247 248 249 250 251 252 253 254
  result->list = NULL;
  result->ref_count = 1;

  if (targets)
    gtk_target_list_add_table (result, targets, ntargets);
  
  return result;
}

255 256 257 258 259 260
/**
 * gtk_target_list_ref:
 * @list:  a #GtkTargetList
 * 
 * Increases the reference count of a #GtkTargetList by one.
 *
261
 * Returns: the passed in #GtkTargetList.
262
 **/
263
GtkTargetList *
264 265
gtk_target_list_ref (GtkTargetList *list)
{
266
  g_return_val_if_fail (list != NULL, NULL);
267

268
  list->ref_count++;
269 270

  return list;
271 272
}

273 274 275 276 277 278 279
/**
 * gtk_target_list_unref:
 * @list: a #GtkTargetList
 * 
 * Decreases the reference count of a #GtkTargetList by one.
 * If the resulting reference count is zero, frees the list.
 **/
280 281 282
void               
gtk_target_list_unref (GtkTargetList *list)
{
283 284 285
  g_return_if_fail (list != NULL);
  g_return_if_fail (list->ref_count > 0);

286 287 288 289 290 291
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
292
	  GtkTargetPair *pair = tmp_list->data;
293
	  g_slice_free (GtkTargetPair, pair);
294 295 296

	  tmp_list = tmp_list->next;
	}
297 298
      
      g_list_free (list->list);
299
      g_slice_free (GtkTargetList, list);
300 301 302
    }
}

303 304 305 306 307 308 309 310 311
/**
 * gtk_target_list_add:
 * @list:  a #GtkTargetList
 * @target: the interned atom representing the target
 * @flags: the flags for this target
 * @info: an ID that will be passed back to the application
 * 
 * Appends another target to a #GtkTargetList.
 **/
312 313
void 
gtk_target_list_add (GtkTargetList *list,
314 315 316
		     GdkAtom        target,
		     guint          flags,
		     guint          info)
317 318 319 320 321
{
  GtkTargetPair *pair;

  g_return_if_fail (list != NULL);
  
322
  pair = g_slice_new (GtkTargetPair);
323 324 325 326 327 328 329
  pair->target = target;
  pair->flags = flags;
  pair->info = info;

  list->list = g_list_append (list->list, pair);
}

330 331 332 333 334 335
static GdkAtom utf8_atom;
static GdkAtom text_atom;
static GdkAtom ctext_atom;
static GdkAtom text_plain_atom;
static GdkAtom text_plain_utf8_atom;
static GdkAtom text_plain_locale_atom;
336
static GdkAtom text_uri_list_atom;
337 338 339 340 341 342 343 344 345

static void 
init_atoms (void)
{
  gchar *tmp;
  const gchar *charset;

  if (!utf8_atom)
    {
346 347 348 349 350
      utf8_atom = gdk_atom_intern_static_string ("UTF8_STRING");
      text_atom = gdk_atom_intern_static_string ("TEXT");
      ctext_atom = gdk_atom_intern_static_string ("COMPOUND_TEXT");
      text_plain_atom = gdk_atom_intern_static_string ("text/plain");
      text_plain_utf8_atom = gdk_atom_intern_static_string ("text/plain;charset=utf-8");
351 352 353 354
      g_get_charset (&charset);
      tmp = g_strdup_printf ("text/plain;charset=%s", charset);
      text_plain_locale_atom = gdk_atom_intern (tmp, FALSE);
      g_free (tmp);
355

356
      text_uri_list_atom = gdk_atom_intern_static_string ("text/uri-list");
357 358 359 360 361 362
    }
}

/**
 * gtk_target_list_add_text_targets:
 * @list: a #GtkTargetList
363
 * @info: an ID that will be passed back to the application
364
 * 
365
 * Appends the text targets supported by #GtkSelectionData to
366
 * the target list. All targets are added with the same @info.
367 368 369 370
 * 
 * Since: 2.6
 **/
void 
371 372
gtk_target_list_add_text_targets (GtkTargetList *list,
				  guint          info)
373 374 375 376 377 378 379
{
  g_return_if_fail (list != NULL);
  
  init_atoms ();

  /* Keep in sync with gtk_selection_data_targets_include_text()
   */
380 381 382 383 384
  gtk_target_list_add (list, utf8_atom, 0, info);  
  gtk_target_list_add (list, ctext_atom, 0, info);  
  gtk_target_list_add (list, text_atom, 0, info);  
  gtk_target_list_add (list, GDK_TARGET_STRING, 0, info);  
  gtk_target_list_add (list, text_plain_utf8_atom, 0, info);  
385 386
  if (!g_get_charset (NULL))
    gtk_target_list_add (list, text_plain_locale_atom, 0, info);  
387
  gtk_target_list_add (list, text_plain_atom, 0, info);  
388 389
}

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
/**
 * gtk_target_list_add_rich_text_targets:
 * @list: a #GtkTargetList
 * @info: an ID that will be passed back to the application
 * @deserializable: if %TRUE, then deserializable rich text formats
 *                  will be added, serializable formats otherwise.
 * @buffer: a #GtkTextBuffer.
 *
 * Appends the rich text targets registered with
 * gtk_text_buffer_register_serialize_format() or
 * gtk_text_buffer_register_deserialize_format() to the target list. All
 * targets are added with the same @info.
 *
 * Since: 2.10
 **/
void
gtk_target_list_add_rich_text_targets (GtkTargetList  *list,
                                       guint           info,
                                       gboolean        deserializable,
                                       GtkTextBuffer  *buffer)
{
  GdkAtom *atoms;
  gint     n_atoms;
  gint     i;

  g_return_if_fail (list != NULL);
  g_return_if_fail (GTK_IS_TEXT_BUFFER (buffer));

  if (deserializable)
    atoms = gtk_text_buffer_get_deserialize_formats (buffer, &n_atoms);
  else
    atoms = gtk_text_buffer_get_serialize_formats (buffer, &n_atoms);

  for (i = 0; i < n_atoms; i++)
    gtk_target_list_add (list, atoms[i], 0, info);

  g_free (atoms);
}

429 430 431
/**
 * gtk_target_list_add_image_targets:
 * @list: a #GtkTargetList
432
 * @info: an ID that will be passed back to the application
433 434 435
 * @writable: whether to add only targets for which GTK+ knows
 *   how to convert a pixbuf into the format
 * 
436
 * Appends the image targets supported by #GtkSelectionData to
437
 * the target list. All targets are added with the same @info.
438 439 440 441 442
 * 
 * Since: 2.6
 **/
void 
gtk_target_list_add_image_targets (GtkTargetList *list,
443
				   guint          info,
444 445 446 447 448 449 450 451 452 453
				   gboolean       writable)
{
  GSList *formats, *f;
  gchar **mimes, **m;
  GdkAtom atom;

  g_return_if_fail (list != NULL);

  formats = gdk_pixbuf_get_formats ();

454 455 456 457
  /* Make sure png comes first */
  for (f = formats; f; f = f->next)
    {
      GdkPixbufFormat *fmt = f->data;
458 459 460 461
      gchar *name; 
 
      name = gdk_pixbuf_format_get_name (fmt);
      if (strcmp (name, "png") == 0)
462 463 464 465
	{
	  formats = g_slist_delete_link (formats, f);
	  formats = g_slist_prepend (formats, fmt);

466 467
	  g_free (name);

468 469 470
	  break;
	}

471
      g_free (name);
472 473
    }  

474 475 476 477 478 479 480 481 482 483 484
  for (f = formats; f; f = f->next)
    {
      GdkPixbufFormat *fmt = f->data;

      if (writable && !gdk_pixbuf_format_is_writable (fmt))
	continue;
      
      mimes = gdk_pixbuf_format_get_mime_types (fmt);
      for (m = mimes; *m; m++)
	{
	  atom = gdk_atom_intern (*m, FALSE);
485
	  gtk_target_list_add (list, atom, 0, info);  
486 487 488 489 490 491 492
	}
      g_strfreev (mimes);
    }

  g_slist_free (formats);
}

493 494 495 496 497
/**
 * gtk_target_list_add_uri_targets:
 * @list: a #GtkTargetList
 * @info: an ID that will be passed back to the application
 * 
498
 * Appends the URI targets supported by #GtkSelectionData to
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
 * the target list. All targets are added with the same @info.
 * 
 * Since: 2.6
 **/
void 
gtk_target_list_add_uri_targets (GtkTargetList *list,
				 guint          info)
{
  g_return_if_fail (list != NULL);
  
  init_atoms ();

  gtk_target_list_add (list, text_uri_list_atom, 0, info);  
}

514 515 516
/**
 * gtk_target_list_add_table:
 * @list: a #GtkTargetList
517
 * @targets: (array length=ntargets): the table of #GtkTargetEntry
518 519 520 521
 * @ntargets: number of targets in the table
 * 
 * Prepends a table of #GtkTargetEntry to a target list.
 **/
522
void               
523 524 525
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
526 527 528 529 530
{
  gint i;

  for (i=ntargets-1; i >= 0; i--)
    {
531
      GtkTargetPair *pair = g_slice_new (GtkTargetPair);
532 533 534 535 536 537 538 539
      pair->target = gdk_atom_intern (targets[i].target, FALSE);
      pair->flags = targets[i].flags;
      pair->info = targets[i].info;
      
      list->list = g_list_prepend (list->list, pair);
    }
}

540 541 542 543 544 545 546
/**
 * gtk_target_list_remove:
 * @list: a #GtkTargetList
 * @target: the interned atom representing the target
 * 
 * Removes a target from a target list.
 **/
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
void 
gtk_target_list_remove (GtkTargetList *list,
			GdkAtom            target)
{
  GList *tmp_list;

  g_return_if_fail (list != NULL);

  tmp_list = list->list;
  while (tmp_list)
    {
      GtkTargetPair *pair = tmp_list->data;
      
      if (pair->target == target)
	{
562
	  g_slice_free (GtkTargetPair, pair);
563

564
	  list->list = g_list_remove_link (list->list, tmp_list);
565 566 567 568 569 570 571 572 573
	  g_list_free_1 (tmp_list);

	  return;
	}
      
      tmp_list = tmp_list->next;
    }
}

574 575 576 577
/**
 * gtk_target_list_find:
 * @list: a #GtkTargetList
 * @target: an interned atom representing the target to search for
578 579
 * @info: (out) (allow-none): a pointer to the location to store
 *        application info for target, or %NULL
580
 *
581
 * Looks up a given target in a #GtkTargetList.
582
 *
583
 * Returns: %TRUE if the target was found, otherwise %FALSE
584
 **/
585 586 587 588 589
gboolean
gtk_target_list_find (GtkTargetList *list,
		      GdkAtom        target,
		      guint         *info)
{
590 591
  GList *tmp_list;

592
  g_return_val_if_fail (list != NULL, FALSE);
593 594

  tmp_list = list->list;
595 596 597 598 599 600
  while (tmp_list)
    {
      GtkTargetPair *pair = tmp_list->data;

      if (pair->target == target)
	{
601 602 603
          if (info)
            *info = pair->info;

604 605
	  return TRUE;
	}
606

607 608 609 610 611 612
      tmp_list = tmp_list->next;
    }

  return FALSE;
}

613 614 615
/**
 * gtk_target_table_new_from_list:
 * @list: a #GtkTargetList
616
 * @n_targets: (out): return location for the number ot targets in the table
617 618 619 620 621 622
 *
 * This function creates an #GtkTargetEntry array that contains the
 * same targets as the passed %list. The returned table is newly
 * allocated and should be freed using gtk_target_table_free() when no
 * longer needed.
 *
623
 * Returns: (array length=n_targets) (transfer full): the new table.
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
 *
 * Since: 2.10
 **/
GtkTargetEntry *
gtk_target_table_new_from_list (GtkTargetList *list,
                                gint          *n_targets)
{
  GtkTargetEntry *targets;
  GList          *tmp_list;
  gint            i;

  g_return_val_if_fail (list != NULL, NULL);
  g_return_val_if_fail (n_targets != NULL, NULL);

  *n_targets = g_list_length (list->list);
  targets = g_new0 (GtkTargetEntry, *n_targets);

641
  for (tmp_list = list->list, i = 0; tmp_list; tmp_list = tmp_list->next, i++)
642 643 644 645 646 647 648 649 650 651 652 653 654
    {
      GtkTargetPair *pair = tmp_list->data;

      targets[i].target = gdk_atom_name (pair->target);
      targets[i].flags  = pair->flags;
      targets[i].info   = pair->info;
    }

  return targets;
}

/**
 * gtk_target_table_free:
655
 * @targets: (array length=n_targets): a #GtkTargetEntry array
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
 * @n_targets: the number of entries in the array
 *
 * This function frees a target table as returned by
 * gtk_target_table_new_from_list()
 *
 * Since: 2.10
 **/
void
gtk_target_table_free (GtkTargetEntry *targets,
                       gint            n_targets)
{
  gint i;

  g_return_if_fail (targets == NULL || n_targets > 0);

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

  g_free (targets);
}

677 678
/**
 * gtk_selection_owner_set_for_display:
679 680
 * @display: the #GdkDisplay where the selection is set
 * @widget: (allow-none): new selection owner (a #GtkWidget), or %NULL.
681
 * @selection: an interned atom representing the selection to claim.
682
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
683
 *
684 685 686
 * Claim ownership of a given selection for a particular widget, or,
 * if @widget is %NULL, release ownership of the selection.
 *
687
 * Returns: TRUE if the operation succeeded 
688 689
 * 
 * Since: 2.2
690
 */
691
gboolean
692 693 694 695
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
696 697 698
{
  GList *tmp_list;
  GtkWidget *old_owner;
699
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
700
  GdkWindow *window;
701

702
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
703
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
704
  g_return_val_if_fail (widget == NULL || gtk_widget_get_realized (widget), FALSE);
705
  g_return_val_if_fail (widget == NULL || gtk_widget_get_display (widget) == display, FALSE);
706
  
Elliot Lee's avatar
Elliot Lee committed
707 708 709
  if (widget == NULL)
    window = NULL;
  else
710
    window = gtk_widget_get_window (widget);
711

Elliot Lee's avatar
Elliot Lee committed
712 713 714
  tmp_list = current_selections;
  while (tmp_list)
    {
715 716 717 718 719
      if (((GtkSelectionInfo *)tmp_list->data)->selection == selection)
	{
	  selection_info = tmp_list->data;
	  break;
	}
Elliot Lee's avatar
Elliot Lee committed
720 721 722
      
      tmp_list = tmp_list->next;
    }
723
  
724
  if (gdk_selection_owner_set_for_display (display, window, selection, time, TRUE))
Elliot Lee's avatar
Elliot Lee committed
725 726 727 728 729 730 731 732 733 734 735
    {
      old_owner = NULL;
      
      if (widget == NULL)
	{
	  if (selection_info)
	    {
	      old_owner = selection_info->widget;
	      current_selections = g_list_remove_link (current_selections,
						       tmp_list);
	      g_list_free (tmp_list);
736
	      g_slice_free (GtkSelectionInfo, selection_info);
Elliot Lee's avatar
Elliot Lee committed
737 738 739 740 741 742
	    }
	}
      else
	{
	  if (selection_info == NULL)
	    {
743
	      selection_info = g_slice_new (GtkSelectionInfo);
Elliot Lee's avatar
Elliot Lee committed
744 745 746
	      selection_info->selection = selection;
	      selection_info->widget = widget;
	      selection_info->time = time;
747 748
	      selection_info->display = display;
	      current_selections = g_list_prepend (current_selections,
749
						   selection_info);
Elliot Lee's avatar
Elliot Lee committed
750 751 752 753 754 755
	    }
	  else
	    {
	      old_owner = selection_info->widget;
	      selection_info->widget = widget;
	      selection_info->time = time;
756
	      selection_info->display = display;
Elliot Lee's avatar
Elliot Lee committed
757 758 759
	    }
	}
      /* If another widget in the application lost the selection,
760 761 762
       *  send it a GDK_SELECTION_CLEAR event.
       */
      if (old_owner && old_owner != widget)
Elliot Lee's avatar
Elliot Lee committed
763
	{
764
	  GdkEvent *event = gdk_event_new (GDK_SELECTION_CLEAR);
765 766

          event->selection.window = g_object_ref (gtk_widget_get_window (old_owner));
767 768
	  event->selection.selection = selection;
	  event->selection.time = time;
769
	  
770 771 772
	  gtk_widget_event (old_owner, event);

	  gdk_event_free (event);
Elliot Lee's avatar
Elliot Lee committed
773 774 775 776 777 778 779
	}
      return TRUE;
    }
  else
    return FALSE;
}

780 781
/**
 * gtk_selection_owner_set:
782
 * @widget: (allow-none):  a #GtkWidget, or %NULL.
783
 * @selection:  an interned atom representing the selection to claim
784
 * @time_: timestamp with which to claim the selection
785 786 787 788
 * 
 * Claims ownership of a given selection for a particular widget,
 * or, if @widget is %NULL, release ownership of the selection.
 * 
789
 * Returns: %TRUE if the operation succeeded
790 791 792 793 794 795
 **/
gboolean
gtk_selection_owner_set (GtkWidget *widget,
			 GdkAtom    selection,
			 guint32    time)
{
796 797
  GdkDisplay *display;
  
798
  g_return_val_if_fail (widget == NULL || gtk_widget_get_realized (widget), FALSE);
799
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
800 801 802 803 804 805 806 807

  if (widget)
    display = gtk_widget_get_display (widget);
  else
    {
      GTK_NOTE (MULTIHEAD,
		g_warning ("gtk_selection_owner_set (NULL,...) is not multihead safe"));
		 
Owen Taylor's avatar
Owen Taylor committed
808
      display = gdk_display_get_default ();
809
    }
810
  
811 812
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
813 814
}

815
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
816

817 818 819 820 821 822 823 824
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
825
{
826
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
827
  GList *tmp_list;
828 829
  GList *lists;

Manish Singh's avatar
Manish Singh committed
830
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
831
  
832
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
833 834
  while (tmp_list)
    {
835 836 837
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
838 839
      tmp_list = tmp_list->next;
    }
840

841
  sellist = g_slice_new (GtkSelectionTargetList);
842 843 844 845
  sellist->selection = selection;
  sellist->list = gtk_target_list_new (NULL, 0);

  lists = g_list_prepend (lists, sellist);
846
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), lists);
847 848 849 850 851 852 853 854 855 856 857

  return sellist->list;
}

static void
gtk_selection_target_list_remove (GtkWidget    *widget)
{
  GtkSelectionTargetList *sellist;
  GList *tmp_list;
  GList *lists;

Manish Singh's avatar
Manish Singh committed
858
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
859
  
860 861
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
862
    {
863 864 865 866
      sellist = tmp_list->data;

      gtk_target_list_unref (sellist->list);

867
      g_slice_free (GtkSelectionTargetList, sellist);
868
      tmp_list = tmp_list->next;
Elliot Lee's avatar
Elliot Lee committed
869
    }
870 871

  g_list_free (lists);
872
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), NULL);
873 874
}

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
/**
 * gtk_selection_clear_targets:
 * @widget:    a #GtkWidget
 * @selection: an atom representing a selection
 *
 * Remove all targets registered for the given selection for the
 * widget.
 **/
void 
gtk_selection_clear_targets (GtkWidget *widget,
			     GdkAtom    selection)
{
  GtkSelectionTargetList *sellist;
  GList *tmp_list;
  GList *lists;

891 892 893
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);

894 895
#ifdef GDK_WINDOWING_WAYLAND
  if (GDK_IS_WAYLAND_DISPLAY (gtk_widget_get_display (widget)))
896
    gdk_wayland_selection_clear_targets (gtk_widget_get_display (widget), selection);
LRN's avatar
LRN committed
897 898 899 900
#endif
#ifdef GDK_WINDOWING_WIN32
  if (GDK_IS_WIN32_DISPLAY (gtk_widget_get_display (widget)))
    gdk_win32_selection_clear_targets (gtk_widget_get_display (widget), selection);
901 902
#endif

Manish Singh's avatar
Manish Singh committed
903
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
904 905 906 907 908 909 910 911 912
  
  tmp_list = lists;
  while (tmp_list)
    {
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	{
	  lists = g_list_delete_link (lists, tmp_list);
	  gtk_target_list_unref (sellist->list);
913
	  g_slice_free (GtkSelectionTargetList, sellist);
914 915 916 917 918 919 920

	  break;
	}
      
      tmp_list = tmp_list->next;
    }
  
921
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), lists);
922 923
}

924 925
/**
 * gtk_selection_add_target:
926
 * @widget:  a #GtkWidget
927 928 929 930 931 932 933
 * @selection: the selection
 * @target: target to add.
 * @info: A unsigned integer which will be passed back to the application.
 * 
 * Appends a specified target to the list of supported targets for a 
 * given widget and selection.
 **/
934 935 936 937 938 939 940 941
void 
gtk_selection_add_target (GtkWidget	    *widget, 
			  GdkAtom	     selection,
			  GdkAtom	     target,
			  guint              info)
{
  GtkTargetList *list;

942 943
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
944 945 946

  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add (list, target, 0, info);
947 948 949 950
#ifdef GDK_WINDOWING_WAYLAND
  if (GDK_IS_WAYLAND_DISPLAY (gtk_widget_get_display (widget)))
    gdk_wayland_selection_add_targets (gtk_widget_get_window (widget), selection, 1, &target);
#endif
951
#ifdef GDK_WINDOWING_WIN32
952 953
  if (GDK_IS_WIN32_DISPLAY (gtk_widget_get_display (widget)))
    gdk_win32_selection_add_targets (gtk_widget_get_window (widget), selection, 1, &target);
954
#endif
955 956
}

957 958 959 960
/**
 * gtk_selection_add_targets:
 * @widget: a #GtkWidget
 * @selection: the selection
961
 * @targets: (array length=ntargets): a table of targets to add
962 963 964 965 966
 * @ntargets:  number of entries in @targets
 * 
 * Prepends a table of targets to the list of supported targets
 * for a given widget and selection.
 **/
967
void 
968 969 970 971
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
972 973
{
  GtkTargetList *list;
974 975 976

  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
977
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
978
  
979 980
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
981

982 983 984 985 986 987 988 989 990 991 992 993 994 995
#ifdef GDK_WINDOWING_WAYLAND
  if (GDK_IS_WAYLAND_DISPLAY (gtk_widget_get_display (widget)))
    {
      GdkAtom *atoms = g_new (GdkAtom, ntargets);
      guint i;

      for (i = 0; i < ntargets; i++)
        atoms[i] = gdk_atom_intern (targets[i].target, FALSE);

      gdk_wayland_selection_add_targets (gtk_widget_get_window (widget), selection, ntargets, atoms);
      g_free (atoms);
    }
#endif

996
#ifdef GDK_WINDOWING_WIN32
997 998 999 1000 1001 1002 1003 1004 1005 1006
  if (GDK_IS_WIN32_DISPLAY (gtk_widget_get_display (widget)))
    {
      int i;
      GdkAtom *atoms = g_new (GdkAtom, ntargets);

      for (i = 0; i < ntargets; ++i)
        atoms[i] = gdk_atom_intern (targets[i].target, FALSE);
      gdk_win32_selection_add_targets (gtk_widget_get_window (widget), selection, ntargets, atoms);
      g_free (atoms);
    }
1007
#endif
Elliot Lee's avatar
Elliot Lee committed
1008 1009
}

1010

1011
/**
Elliot Lee's avatar
Elliot Lee committed
1012
 * gtk_selection_remove_all:
1013 1014 1015 1016 1017 1018 1019
 * @widget: a #GtkWidget 
 * 
 * Removes all handlers and unsets ownership of all 
 * selections for a widget. Called when widget is being
 * destroyed. This function will not generally be
 * called by applications.
 **/
Elliot Lee's avatar
Elliot Lee committed
1020 1021 1022 1023 1024 1025
void
gtk_selection_remove_all (GtkWidget *widget)
{
  GList *tmp_list;
  GList *next;
  GtkSelectionInfo *selection_info;
1026 1027 1028

  g_return_if_fail (GTK_IS_WIDGET (widget));

Elliot Lee's avatar
Elliot Lee committed
1029
  /* Remove pending requests/incrs for this widget */
1030
  
Elliot Lee's avatar
Elliot Lee committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      next = tmp_list->next;
      if (((GtkRetrievalInfo *)tmp_list->data)->widget == widget)
	{
	  current_retrievals = g_list_remove_link (current_retrievals, 
						   tmp_list);
	  /* structure will be freed in timeout */
	  g_list_free (tmp_list);
	}
      tmp_list = next;
    }
  
  /* Disclaim ownership of any selections */
1046
  
Elliot Lee's avatar
Elliot Lee committed
1047 1048 1049 1050 1051 1052 1053 1054
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
1055 1056 1057 1058 1059
	  gdk_selection_owner_set_for_display (selection_info->display,
					       NULL, 
					       selection_info->selection,
				               GDK_CURRENT_TIME, FALSE);
	  current_selections = g_list_remove_link (current_selections,
Elliot Lee's avatar
Elliot Lee committed
1060 1061
						   tmp_list);
	  g_list_free (tmp_list);
1062
	  g_slice_free (GtkSelectionInfo, selection_info);
Elliot Lee's avatar
Elliot Lee committed
1063 1064 1065 1066
	}
      
      tmp_list = next;
    }
1067 1068 1069

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
1070 1071 1072
}


1073 1074 1075 1076 1077 1078 1079 1080 1081
/**
 * gtk_selection_convert:
 * @widget: The widget which acts as requestor
 * @selection: Which selection to get
 * @target: Form of information desired (e.g., STRING)
 * @time_: Time of request (usually of triggering event)
       In emergency, you could use #GDK_CURRENT_TIME
 * 
 * Requests the contents of a selection. When received, 
1082
 * a “selection-received” signal will be generated.
1083
 * 
1084
 * Returns: %TRUE if requested succeeded. %FALSE if we could not process
1085 1086 1087
 *          request. (e.g., there was already a request in process for
 *          this widget).
 **/
1088
gboolean
Elliot Lee's avatar
Elliot Lee committed
1089
gtk_selection_convert (GtkWidget *widget, 
1090 1091
		       GdkAtom	  selection, 
		       GdkAtom	  target,
1092
		       guint32	  time_)
Elliot Lee's avatar
Elliot Lee committed
1093 1094 1095 1096
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
1097
  GdkDisplay *display;
1098
  guint id;
1099
  
1100 1101
  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
1102
  
Elliot Lee's avatar
Elliot Lee committed
1103 1104 1105
  if (initialize)
    gtk_selection_init ();
  
1106
  if (!gtk_widget_get_realized (widget))
Elliot Lee's avatar
Elliot Lee committed
1107
    gtk_widget_realize (widget);
1108
  
Elliot Lee's avatar
Elliot Lee committed
1109 1110 1111 1112 1113
  /* Check to see if there are already any retrievals in progress for
     this widget. If we changed GDK to use the selection for the 
     window property in which to store the retrieved information, then
     we could support multiple retrievals for different selections.
     This might be useful for DND. */
1114
  
Elliot Lee's avatar
Elliot Lee committed
1115 1116 1117 1118 1119 1120 1121 1122
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
1123
  
1124
  info = g_slice_new (GtkRetrievalInfo);
1125
  
Elliot Lee's avatar
Elliot Lee committed
1126 1127 1128
  info->widget = widget;
  info->selection = selection;
  info->target = target;
Owen Taylor's avatar
Owen Taylor committed
1129
  info->idle_time = 0;
Elliot Lee's avatar
Elliot Lee committed
1130 1131
  info->buffer = NULL;
  info->offset = -1;
1132
  
Elliot Lee's avatar
Elliot Lee committed
1133 1134
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
1135 1136 1137

  display = gtk_widget_get_display (widget);
  owner_window = gdk_selection_owner_get_for_display (display, selection);
Elliot Lee's avatar
Elliot Lee committed
1138
  
1139 1140 1141 1142 1143 1144 1145 1146 1147
#ifdef GDK_WINDOWING_WIN32
  /* Special handling for DELETE requests,
   * make sure this goes down into GDK layer.
   */
  if (GDK_IS_WIN32_DISPLAY (display) &&
      target == gdk_atom_intern_static_string ("DELETE"))
    owner_window = NULL;
#endif

Elliot Lee's avatar
Elliot Lee committed
1148 1149 1150
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
1151
      gpointer owner_widget_ptr;
1152
      GtkSelectionData selection_data = {0};
1153
      
Elliot Lee's avatar
Elliot Lee committed
1154 1155 1156
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.length = -1;
1157
      selection_data.display = display;
1158
      
1159 1160
      gdk_window_get_user_data (owner_window, &owner_widget_ptr);
      owner_widget = owner_widget_ptr;
1161
      
Elliot Lee's avatar
Elliot Lee committed
1162 1163
      if (owner_widget != NULL)
	{
1164
	  gtk_selection_invoke_handler (owner_widget, 
1165
					&selection_data,
1166
					time_);
1167
	  
Elliot Lee's avatar
Elliot Lee committed
1168 1169 1170 1171
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
1172
					  selection_data.length,
1173
					  time_);
1174
	  
Elliot Lee's avatar
Elliot Lee committed
1175
	  g_free (selection_data.data);
1176 1177
          selection_data.data = NULL;
          selection_data.length = -1;
Elliot Lee's avatar
Elliot Lee committed
1178
	  
1179
	  g_slice_free (GtkRetrievalInfo, info);
Elliot Lee's avatar
Elliot Lee committed
1180 1181 1182 1183 1184
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
1185
  
Elliot Lee's avatar
Elliot Lee committed
1186
  current_retrievals = g_list_append (current_retrievals, info);
1187
  gdk_selection_convert (gtk_widget_get_window (widget), selection, target, time_);
1188
  id = gdk_threads_add_timeout (1000,
1189
      (GSourceFunc) gtk_selection_retrieval_timeout, info);
1190
  g_source_set_name_by_id (id, "[gtk+] gtk_selection_retrieval_timeout");
1191
  
Elliot Lee's avatar
Elliot Lee committed
1192 1193 1194
  return TRUE;
}

1195 1196
/**
 * gtk_selection_data_get_selection:
1197
 * @selection_data: a pointer to a #GtkSelectionData-struct.
1198 1199 1200
 *
 * Retrieves the selection #GdkAtom of the selection data.
 *
1201
 * Returns: (transfer none): the selection #GdkAtom of the selection data.
1202 1203 1204 1205
 *
 * Since: 2.16
 **/
GdkAtom
1206
gtk_selection_data_get_selection (const GtkSelectionData *selection_data)
1207 1208 1209 1210 1211 1212
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->selection;
}

Tim Janik's avatar
Tim Janik committed
1213 1214
/**
 * gtk_selection_data_get_target:
1215
 * @selection_data: a pointer to a #GtkSelectionData-struct.
Tim Janik's avatar
Tim Janik committed
1216 1217 1218
 *
 * Retrieves the target of the selection.
 *
1219
 * Returns: (transfer none): the target of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1220
 *
1221
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1222
 **/
1223
GdkAtom
1224
gtk_selection_data_get_target (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1225 1226 1227 1228 1229 1230 1231 1232
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->target;
}

/**
 * gtk_selection_data_get_data_type:
1233
 * @selection_data: a pointer to a #GtkSelectionData-struct.
Tim Janik's avatar
Tim Janik committed
1234 1235 1236
 *
 * Retrieves the data type of the selection.
 *
1237
 * Returns: (transfer none): the data type of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1238
 *
1239
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1240
 **/
1241
GdkAtom
1242
gtk_selection_data_get_data_type (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1243 1244 1245 1246 1247 1248 1249 1250
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->type;
}

/**
 * gtk_selection_data_get_format:
1251
 * @selection_data: a pointer to a #GtkSelectionData-struct.
Tim Janik's avatar
Tim Janik committed
1252 1253 1254
 *
 * Retrieves the format of the selection.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1255 1256
 * Returns: the format of the selection.
 *
1257
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1258
 **/
1259
gint
1260
gtk_selection_data_get_format (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1261 1262 1263 1264 1265 1266 1267
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->format;
}

/**
1268
 * gtk_selection_data_get_data: (skip)
1269
 * @selection_data: a pointer to a
1270
 *   #GtkSelectionData-struct.
Tim Janik's avatar
Tim Janik committed
1271 1272 1273
 *
 * Retrieves the raw data of the selection.
 *
1274
 * Returns: (array) (element-type guint8): the raw data of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1275
 *
1276
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1277
 **/
1278
const guchar*
1279
gtk_selection_data_get_data (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1280 1281 1282
{
  g_return_val_if_fail (selection_data != NULL, NULL);

1283
  return selection_data->data;
Tim Janik's avatar
Tim Janik committed
1284
}
Elliot Lee's avatar
Elliot Lee committed
1285

1286 1287
/**
 * gtk_selection_data_get_length:
1288
 * @selection_data: a pointer to a #GtkSelectionData-struct.
1289 1290 1291 1292 1293 1294 1295 1296
 *
 * Retrieves the length of the raw data of the selection.
 *
 * Returns: the length of the data of the selection.
 *
 * Since: 2.14
 */
gint
1297
gtk_selection_data_get_length (const GtkSelectionData *selection_data)
1298 1299 1300 1301 1302 1303
{
  g_return_val_if_fail (selection_data != NULL, -1);

  return selection_data->length;
}

1304
/**
Jasper St. Pierre's avatar
Jasper St. Pierre committed
1305
 * gtk_selection_data_get_data_with_length: (rename-to gtk_selection_data_get_data)
1306
 * @selection_data: a pointer to a #GtkSelectionData-struct.
1307
 * @length: (out): return location for length of the data segment
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
 *
 * Retrieves the raw data of the selection along with its length.
 *
 * Returns: (array length=length): the raw data of the selection
 *
 * Since: 3.0
 */
const guchar*
gtk_selection_data_get_data_with_length (const GtkSelectionData *selection_data,
                                         gint                   *length)
{
  g_return_val_if_fail (selection_data != NULL, NULL);

  *length = selection_data->length;

  return selection_data->data;
}

1326 1327
/**
 * gtk_selection_data_get_display:
1328
 * @selection_data: a pointer to a #GtkSelectionData-struct.
1329 1330 1331
 *
 * Retrieves the display of the selection.
 *
1332
 * Returns: (transfer none): the display of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1333
 *
1334
 * Since: 2.14
1335 1336
 **/
GdkDisplay *
1337
gtk_selection_data_get_display (const GtkSelectionData *selection_data)
1338 1339 1340 1341 1342 1343
{
  g_return_val_if_fail (selection_data != NULL, NULL);

  return selection_data->display;
}

1344 1345
/**
 * gtk_selection_data_set:
1346
 * @selection_data: a pointer to a #GtkSelectionData-struct.
1347 1348
 * @type: the type of selection data
 * @format: format (number of bits in a unit)
1349
 * @data: (array length=length): pointer to the data (will be copied)
1350 1351 1352
 * @length: length of the data
 * 
 * Stores new data into a #GtkSelectionData object. Should
1353
 * only be called from a selection handler callback.
1354 1355
 * Zero-terminates the stored data.
 **/
Elliot Lee's avatar
Elliot Lee committed
1356 1357
void 
gtk_selection_data_set (GtkSelectionData *selection_data,
1358 1359
			GdkAtom		  type,
			gint		  format,
1360
			const guchar	 *data,
1361
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
1362
{
1363 1364
  g_return_if_fail (selection_data != NULL);

1365
  g_free (selection_data->data);
1366
  
Elliot Lee's avatar
Elliot Lee committed
1367 1368
  selection_data->type = type;
  selection_data->format = format;
1369
  
Elliot Lee's avatar
Elliot Lee committed
1370 1371 1372 1373 1374 1375 1376
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
1377 1378 1379 1380 1381 1382
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
1383
	selection_data->data = (guchar *) g_strdup ("");
1384
    }
1385
  
Elliot Lee's avatar
Elliot Lee committed
1386 1387 1388
  selection_data->length = length;
}

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
static gboolean
selection_set_string (GtkSelectionData *selection_data,
		      const gchar      *str,
		      gint              len)
{
  gchar *tmp = g_strndup (str, len);
  gchar *latin1 = gdk_utf8_to_string_target (tmp);
  g_free (tmp);
  
  if (latin1)
    {
      gtk_selection_data_set (selection_data,
			      GDK_SELECTION_TYPE_STRING,
1402
			      8, (guchar *) latin1, strlen (latin1));
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
      g_free (latin1);
      
      return TRUE;
    }
  else
    return FALSE;
}

static gboolean
selection_set_compound_text (GtkSelectionData *selection_data,
			     const gchar      *str,
			     gint              len)
{
1416 1417 1418
  gboolean result = FALSE;

#ifdef GDK_WINDOWING_X11
1419 1420 1421 1422 1423
  gchar *tmp;
  guchar *text;
  GdkAtom encoding;
  gint format;
  gint new_length;
1424

1425
  if (GDK_IS_X11_DISPLAY (selection_data->display))
1426
    {
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
      tmp = g_strndup (str, len);
      if (gdk_x11_display_utf8_to_compound_text (selection_data->display, tmp,
                                                 &encoding, &format, &text, &new_length))
        {
          gtk_selection_data_set (selection_data, encoding, format, text, new_length);
          gdk_x11_free_compound_text (text);

          result = TRUE;
        }
      g_free (tmp);
1437
    }
1438
#endif
1439 1440 1441 1442

  return result;
}

1443 1444 1445 1446 1447 1448 1449 1450
/* Normalize \r and \n into \r\n
 */
static gchar *
normalize_to_crlf (const gchar *str, 
		   gint         len)
{
  GString *result = g_string_sized_new (len);
  const gchar *p = str;
1451
  const gchar *end = str + len;
1452

1453
  while (p < end)
1454 1455 1456 1457 1458 1459 1460 1461
    {
      if (*p == '\n')
	g_string_append_c (result, '\r');

      if (*p == '\r')
	{
	  g_string_append_c (result, *p);
	  p++;
1462
	  if (p == end || *p != '\n')
1463
	    g_string_append_c (result, '\n');
1464 1465
	  if (p == end)
	    break;
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496