gtkselection.c 83.7 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 20 21 22
 * The code was written after an intensive study of the equivalent part
 * of John Ousterhout's Tk toolkit, and does many things in much the 
 * 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 34 35 36 37 38 39 40 41 42 43 44
 */

/* Terminology note: when not otherwise specified, the term "incr" below
 * refers to the _sending_ part of the INCR protocol. The receiving
 * portion is referred to just as "retrieval". (Terminology borrowed
 * from Tk, because there is no good opposite to "retrieval" in English.
 * "send" can't be made into a noun gracefully and we're already using
 * "emission" for something else ....)
 */

/* 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 69 70 71 72 73 74 75 76 77
/**
 * 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.
 *
 * Some of the datatypes defined this section are used in
 * the #GtkClipboard and drag-and-drop API's as well. The
 * #GtkTargetEntry structure and #GtkTargetList objects represent
 * 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.
 */

78
#include "config.h"
79 80 81 82

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

Elliot Lee's avatar
Elliot Lee committed
83
#include <stdarg.h>
84
#include <string.h>
85 86
#include "gdk.h"

Elliot Lee's avatar
Elliot Lee committed
87
#include "gtkmain.h"
88
#include "gtkdebug.h"
89
#include "gtktextbufferrichtext.h"
90
#include "gtkintl.h"
91
#include "gdk-pixbuf/gdk-pixbuf.h"
Elliot Lee's avatar
Elliot Lee committed
92

93 94 95 96
#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
#endif

97 98 99 100
#ifdef GDK_WINDOWING_WIN32
#include "win32/gdkwin32.h"
#endif

101
#undef DEBUG_SELECTION
Elliot Lee's avatar
Elliot Lee committed
102 103 104

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
105
#ifdef GDK_WINDOWING_X11
106 107 108 109 110
#define GTK_SELECTION_MAX_SIZE(display)                                 \
  MIN(262144,                                                           \
      XExtendedMaxRequestSize (GDK_DISPLAY_XDISPLAY (display)) == 0     \
       ? XMaxRequestSize (GDK_DISPLAY_XDISPLAY (display)) - 100         \
       : XExtendedMaxRequestSize (GDK_DISPLAY_XDISPLAY (display)) - 100)
111 112 113
#else
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE(display) G_MAXINT
114
#endif
Owen Taylor's avatar
Owen Taylor committed
115

116
#define IDLE_ABORT_TIME 30
Owen Taylor's avatar
Owen Taylor committed
117

Elliot Lee's avatar
Elliot Lee committed
118 119 120 121 122
enum {
  INCR,
  MULTIPLE,
  TARGETS,
  TIMESTAMP,
123
  SAVE_TARGETS,
Elliot Lee's avatar
Elliot Lee committed
124 125 126 127 128 129 130 131 132 133
  LAST_ATOM
};

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

struct _GtkSelectionInfo
{
134 135 136 137
  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
138 139 140 141
};

struct _GtkIncrConversion 
{
142 143
  GdkAtom	    target;	/* Requested target */
  GdkAtom	    property;	/* Property to store in */
Elliot Lee's avatar
Elliot Lee committed
144
  GtkSelectionData  data;	/* The data being supplied */
145
  gint		    offset;	/* Current offset in sent selection.
Elliot Lee's avatar
Elliot Lee committed
146 147
				 *  -1 => All done
				 *  -2 => Only the final (empty) portion
148
				 *	  left to send */
Elliot Lee's avatar
Elliot Lee committed
149 150 151 152 153 154 155
};

struct _GtkIncrInfo
{
  GdkWindow *requestor;		/* Requestor window - we create a GdkWindow
				   so we can receive events */
  GdkAtom    selection;		/* Selection we're sending */
156
  
Elliot Lee's avatar
Elliot Lee committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
  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 */
175
  gint	   offset;		/* Current offset in buffer, -1 indicates
Elliot Lee's avatar
Elliot Lee committed
176
				   not yet started */
177
  guint32 notify_time;		/* Timestamp from SelectionNotify */
Elliot Lee's avatar
Elliot Lee committed
178 179 180
};

/* Local Functions */
181
static void gtk_selection_init              (void);
182 183
static gboolean gtk_selection_incr_timeout      (GtkIncrInfo      *info);
static gboolean gtk_selection_retrieval_timeout (GtkRetrievalInfo *info);
184 185 186 187 188 189 190 191 192 193 194 195
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
196 197 198 199 200 201 202 203

/* 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];
204
static const char gtk_selection_handler_key[] = "gtk-selection-handlers";
Elliot Lee's avatar
Elliot Lee committed
205

206 207 208 209 210 211 212 213
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

214 215 216

/**
 * gtk_target_list_new:
217 218
 * @targets: (array length=ntargets): Pointer to an array of #GtkTargetEntry
 * @ntargets: number of entries in @targets.
219 220 221
 * 
 * Creates a new #GtkTargetList from an array of #GtkTargetEntry.
 * 
222
 * Return value: (transfer full): the new #GtkTargetList.
223
 **/
224
GtkTargetList *
225 226
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
227
{
228
  GtkTargetList *result = g_slice_new (GtkTargetList);
229 230 231 232 233 234 235 236 237
  result->list = NULL;
  result->ref_count = 1;

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

238 239 240 241 242 243
/**
 * gtk_target_list_ref:
 * @list:  a #GtkTargetList
 * 
 * Increases the reference count of a #GtkTargetList by one.
 *
244
 * Return value: the passed in #GtkTargetList.
245
 **/
246
GtkTargetList *
247 248
gtk_target_list_ref (GtkTargetList *list)
{
249
  g_return_val_if_fail (list != NULL, NULL);
250

251
  list->ref_count++;
252 253

  return list;
254 255
}

256 257 258 259 260 261 262
/**
 * 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.
 **/
263 264 265
void               
gtk_target_list_unref (GtkTargetList *list)
{
266 267 268
  g_return_if_fail (list != NULL);
  g_return_if_fail (list->ref_count > 0);

269 270 271 272 273 274
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
275
	  GtkTargetPair *pair = tmp_list->data;
276
	  g_slice_free (GtkTargetPair, pair);
277 278 279

	  tmp_list = tmp_list->next;
	}
280 281
      
      g_list_free (list->list);
282
      g_slice_free (GtkTargetList, list);
283 284 285
    }
}

286 287 288 289 290 291 292 293 294
/**
 * 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.
 **/
295 296
void 
gtk_target_list_add (GtkTargetList *list,
297 298 299
		     GdkAtom        target,
		     guint          flags,
		     guint          info)
300 301 302 303 304
{
  GtkTargetPair *pair;

  g_return_if_fail (list != NULL);
  
305
  pair = g_slice_new (GtkTargetPair);
306 307 308 309 310 311 312
  pair->target = target;
  pair->flags = flags;
  pair->info = info;

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

313 314 315 316 317 318
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;
319
static GdkAtom text_uri_list_atom;
320 321 322 323 324 325 326 327 328

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

  if (!utf8_atom)
    {
329 330 331 332 333
      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");
334 335 336 337
      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);
338

339
      text_uri_list_atom = gdk_atom_intern_static_string ("text/uri-list");
340 341 342 343 344 345
    }
}

/**
 * gtk_target_list_add_text_targets:
 * @list: a #GtkTargetList
346
 * @info: an ID that will be passed back to the application
347
 * 
348
 * Appends the text targets supported by #GtkSelection to
349
 * the target list. All targets are added with the same @info.
350 351 352 353
 * 
 * Since: 2.6
 **/
void 
354 355
gtk_target_list_add_text_targets (GtkTargetList *list,
				  guint          info)
356 357 358 359 360 361 362
{
  g_return_if_fail (list != NULL);
  
  init_atoms ();

  /* Keep in sync with gtk_selection_data_targets_include_text()
   */
363 364 365 366 367
  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);  
368 369
  if (!g_get_charset (NULL))
    gtk_target_list_add (list, text_plain_locale_atom, 0, info);  
370
  gtk_target_list_add (list, text_plain_atom, 0, info);  
371 372
}

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
/**
 * 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);
}

412 413 414
/**
 * gtk_target_list_add_image_targets:
 * @list: a #GtkTargetList
415
 * @info: an ID that will be passed back to the application
416 417 418
 * @writable: whether to add only targets for which GTK+ knows
 *   how to convert a pixbuf into the format
 * 
419
 * Appends the image targets supported by #GtkSelection to
420
 * the target list. All targets are added with the same @info.
421 422 423 424 425
 * 
 * Since: 2.6
 **/
void 
gtk_target_list_add_image_targets (GtkTargetList *list,
426
				   guint          info,
427 428 429 430 431 432 433 434 435 436
				   gboolean       writable)
{
  GSList *formats, *f;
  gchar **mimes, **m;
  GdkAtom atom;

  g_return_if_fail (list != NULL);

  formats = gdk_pixbuf_get_formats ();

437 438 439 440
  /* Make sure png comes first */
  for (f = formats; f; f = f->next)
    {
      GdkPixbufFormat *fmt = f->data;
441 442 443 444
      gchar *name; 
 
      name = gdk_pixbuf_format_get_name (fmt);
      if (strcmp (name, "png") == 0)
445 446 447 448
	{
	  formats = g_slist_delete_link (formats, f);
	  formats = g_slist_prepend (formats, fmt);

449 450
	  g_free (name);

451 452 453
	  break;
	}

454
      g_free (name);
455 456
    }  

457 458 459 460 461 462 463 464 465 466 467
  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);
468
	  gtk_target_list_add (list, atom, 0, info);  
469 470 471 472 473 474 475
	}
      g_strfreev (mimes);
    }

  g_slist_free (formats);
}

476 477 478 479 480
/**
 * gtk_target_list_add_uri_targets:
 * @list: a #GtkTargetList
 * @info: an ID that will be passed back to the application
 * 
481
 * Appends the URI targets supported by #GtkSelection to
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
 * 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);  
}

497 498 499
/**
 * gtk_target_list_add_table:
 * @list: a #GtkTargetList
500
 * @targets: (array length=ntargets): the table of #GtkTargetEntry
501 502 503 504
 * @ntargets: number of targets in the table
 * 
 * Prepends a table of #GtkTargetEntry to a target list.
 **/
505
void               
506 507 508
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
509 510 511 512 513
{
  gint i;

  for (i=ntargets-1; i >= 0; i--)
    {
514
      GtkTargetPair *pair = g_slice_new (GtkTargetPair);
515 516 517 518 519 520 521 522
      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);
    }
}

523 524 525 526 527 528 529
/**
 * gtk_target_list_remove:
 * @list: a #GtkTargetList
 * @target: the interned atom representing the target
 * 
 * Removes a target from a target list.
 **/
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
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)
	{
545
	  g_slice_free (GtkTargetPair, pair);
546

547
	  list->list = g_list_remove_link (list->list, tmp_list);
548 549 550 551 552 553 554 555 556
	  g_list_free_1 (tmp_list);

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

557 558 559 560
/**
 * gtk_target_list_find:
 * @list: a #GtkTargetList
 * @target: an interned atom representing the target to search for
561 562 563
 * @info: a pointer to the location to store application info for target,
 *        or %NULL
 *
564
 * Looks up a given target in a #GtkTargetList.
565
 *
566 567
 * Return value: %TRUE if the target was found, otherwise %FALSE
 **/
568 569 570 571 572
gboolean
gtk_target_list_find (GtkTargetList *list,
		      GdkAtom        target,
		      guint         *info)
{
573 574
  GList *tmp_list;

575
  g_return_val_if_fail (list != NULL, FALSE);
576 577

  tmp_list = list->list;
578 579 580 581 582 583
  while (tmp_list)
    {
      GtkTargetPair *pair = tmp_list->data;

      if (pair->target == target)
	{
584 585 586
          if (info)
            *info = pair->info;

587 588
	  return TRUE;
	}
589

590 591 592 593 594 595
      tmp_list = tmp_list->next;
    }

  return FALSE;
}

596 597 598
/**
 * gtk_target_table_new_from_list:
 * @list: a #GtkTargetList
599
 * @n_targets: (out): return location for the number ot targets in the table
600 601 602 603 604 605
 *
 * 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.
 *
606
 * Return value: (array length=n_targets) (transfer full): the new table.
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
 *
 * 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);

  for (i = 0, tmp_list = list->list;
       i < *n_targets;
       i++, tmp_list = g_list_next (tmp_list))
    {
      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:
640
 * @targets: (array length=n_targets): a #GtkTargetEntry array
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
 * @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);
}

662 663
/**
 * gtk_selection_owner_set_for_display:
664 665
 * @display: the #GdkDisplay where the selection is set
 * @widget: (allow-none): new selection owner (a #GtkWidget), or %NULL.
666
 * @selection: an interned atom representing the selection to claim.
667
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
668
 *
669 670 671 672
 * Claim ownership of a given selection for a particular widget, or,
 * if @widget is %NULL, release ownership of the selection.
 *
 * Return value: TRUE if the operation succeeded 
673 674
 * 
 * Since: 2.2
675
 */
676
gboolean
677 678 679 680
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
681 682 683
{
  GList *tmp_list;
  GtkWidget *old_owner;
684
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
685
  GdkWindow *window;
686

687
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
688
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
689
  g_return_val_if_fail (widget == NULL || gtk_widget_get_realized (widget), FALSE);
690
  g_return_val_if_fail (widget == NULL || gtk_widget_get_display (widget) == display, FALSE);
691
  
Elliot Lee's avatar
Elliot Lee committed
692 693 694
  if (widget == NULL)
    window = NULL;
  else
695
    window = gtk_widget_get_window (widget);
696

Elliot Lee's avatar
Elliot Lee committed
697 698 699
  tmp_list = current_selections;
  while (tmp_list)
    {
700 701 702 703 704
      if (((GtkSelectionInfo *)tmp_list->data)->selection == selection)
	{
	  selection_info = tmp_list->data;
	  break;
	}
Elliot Lee's avatar
Elliot Lee committed
705 706 707
      
      tmp_list = tmp_list->next;
    }
708
  
709
  if (gdk_selection_owner_set_for_display (display, window, selection, time, TRUE))
Elliot Lee's avatar
Elliot Lee committed
710 711 712 713 714 715 716 717 718 719 720
    {
      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);
721
	      g_slice_free (GtkSelectionInfo, selection_info);
Elliot Lee's avatar
Elliot Lee committed
722 723 724 725 726 727
	    }
	}
      else
	{
	  if (selection_info == NULL)
	    {
728
	      selection_info = g_slice_new (GtkSelectionInfo);
Elliot Lee's avatar
Elliot Lee committed
729 730 731
	      selection_info->selection = selection;
	      selection_info->widget = widget;
	      selection_info->time = time;
732 733
	      selection_info->display = display;
	      current_selections = g_list_prepend (current_selections,
734
						   selection_info);
Elliot Lee's avatar
Elliot Lee committed
735 736 737 738 739 740
	    }
	  else
	    {
	      old_owner = selection_info->widget;
	      selection_info->widget = widget;
	      selection_info->time = time;
741
	      selection_info->display = display;
Elliot Lee's avatar
Elliot Lee committed
742 743 744
	    }
	}
      /* If another widget in the application lost the selection,
745 746 747
       *  send it a GDK_SELECTION_CLEAR event.
       */
      if (old_owner && old_owner != widget)
Elliot Lee's avatar
Elliot Lee committed
748
	{
749
	  GdkEvent *event = gdk_event_new (GDK_SELECTION_CLEAR);
750 751

          event->selection.window = g_object_ref (gtk_widget_get_window (old_owner));
752 753
	  event->selection.selection = selection;
	  event->selection.time = time;
754
	  
755 756 757
	  gtk_widget_event (old_owner, event);

	  gdk_event_free (event);
Elliot Lee's avatar
Elliot Lee committed
758 759 760 761 762 763 764
	}
      return TRUE;
    }
  else
    return FALSE;
}

765 766
/**
 * gtk_selection_owner_set:
767
 * @widget: (allow-none):  a #GtkWidget, or %NULL.
768
 * @selection:  an interned atom representing the selection to claim
769
 * @time_: timestamp with which to claim the selection
770 771 772 773 774 775 776 777 778 779 780
 * 
 * Claims ownership of a given selection for a particular widget,
 * or, if @widget is %NULL, release ownership of the selection.
 * 
 * Return value: %TRUE if the operation succeeded
 **/
gboolean
gtk_selection_owner_set (GtkWidget *widget,
			 GdkAtom    selection,
			 guint32    time)
{
781 782
  GdkDisplay *display;
  
783
  g_return_val_if_fail (widget == NULL || gtk_widget_get_realized (widget), FALSE);
784
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
785 786 787 788 789 790 791 792

  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
793
      display = gdk_display_get_default ();
794
    }
795
  
796 797
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
798 799
}

800
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
801

802 803 804 805 806 807 808 809
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
810
{
811
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
812
  GList *tmp_list;
813 814
  GList *lists;

Manish Singh's avatar
Manish Singh committed
815
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
816
  
817
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
818 819
  while (tmp_list)
    {
820 821 822
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
823 824
      tmp_list = tmp_list->next;
    }
825

826
  sellist = g_slice_new (GtkSelectionTargetList);
827 828 829 830
  sellist->selection = selection;
  sellist->list = gtk_target_list_new (NULL, 0);

  lists = g_list_prepend (lists, sellist);
831
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), lists);
832 833 834 835 836 837 838 839 840 841 842

  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
843
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
844
  
845 846
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
847
    {
848 849 850 851
      sellist = tmp_list->data;

      gtk_target_list_unref (sellist->list);

852
      g_slice_free (GtkSelectionTargetList, sellist);
853
      tmp_list = tmp_list->next;
Elliot Lee's avatar
Elliot Lee committed
854
    }
855 856

  g_list_free (lists);
857
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), NULL);
858 859
}

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
/**
 * 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;

876 877 878
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);

Manish Singh's avatar
Manish Singh committed
879
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
880 881 882 883 884 885 886 887 888
  
  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);
889
	  g_slice_free (GtkSelectionTargetList, sellist);
890 891 892 893 894 895 896

	  break;
	}
      
      tmp_list = tmp_list->next;
    }
  
897
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), lists);
898 899
}

900 901 902 903 904 905 906 907 908 909
/**
 * gtk_selection_add_target:
 * @widget:  a #GtkTarget
 * @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.
 **/
910 911 912 913 914 915 916 917
void 
gtk_selection_add_target (GtkWidget	    *widget, 
			  GdkAtom	     selection,
			  GdkAtom	     target,
			  guint              info)
{
  GtkTargetList *list;

918 919
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
920 921 922

  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add (list, target, 0, info);
923
#ifdef GDK_WINDOWING_WIN32
924
  gdk_win32_selection_add_targets (gtk_widget_get_window (widget), selection, 1, &target);
925
#endif
926 927
}

928 929 930 931
/**
 * gtk_selection_add_targets:
 * @widget: a #GtkWidget
 * @selection: the selection
932
 * @targets: (array length=ntargets): a table of targets to add
933 934 935 936 937
 * @ntargets:  number of entries in @targets
 * 
 * Prepends a table of targets to the list of supported targets
 * for a given widget and selection.
 **/
938
void 
939 940 941 942
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
943 944
{
  GtkTargetList *list;
945 946 947

  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
948
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
949
  
950 951
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
952 953 954 955 956 957 958 959

#ifdef GDK_WINDOWING_WIN32
  {
    int i;
    GdkAtom *atoms = g_new (GdkAtom, ntargets);

    for (i = 0; i < ntargets; ++i)
      atoms[i] = gdk_atom_intern (targets[i].target, FALSE);
960
    gdk_win32_selection_add_targets (gtk_widget_get_window (widget), selection, ntargets, atoms);
961 962 963
    g_free (atoms);
  }
#endif
Elliot Lee's avatar
Elliot Lee committed
964 965
}

966

967
/**
Elliot Lee's avatar
Elliot Lee committed
968
 * gtk_selection_remove_all:
969 970 971 972 973 974 975
 * @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
976 977 978 979 980 981
void
gtk_selection_remove_all (GtkWidget *widget)
{
  GList *tmp_list;
  GList *next;
  GtkSelectionInfo *selection_info;
982 983 984

  g_return_if_fail (GTK_IS_WIDGET (widget));

Elliot Lee's avatar
Elliot Lee committed
985
  /* Remove pending requests/incrs for this widget */
986
  
Elliot Lee's avatar
Elliot Lee committed
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
  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 */
1002
  
Elliot Lee's avatar
Elliot Lee committed
1003 1004 1005 1006 1007 1008 1009 1010
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
1011 1012 1013 1014 1015
	  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
1016 1017
						   tmp_list);
	  g_list_free (tmp_list);
1018
	  g_slice_free (GtkSelectionInfo, selection_info);
Elliot Lee's avatar
Elliot Lee committed
1019 1020 1021 1022
	}
      
      tmp_list = next;
    }
1023 1024 1025

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
1026 1027 1028
}


1029 1030 1031 1032 1033 1034 1035 1036 1037
/**
 * 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, 
1038
 * a "selection-received" signal will be generated.
1039 1040 1041 1042 1043
 * 
 * Return value: %TRUE if requested succeeded. %FALSE if we could not process
 *          request. (e.g., there was already a request in process for
 *          this widget).
 **/
1044
gboolean
Elliot Lee's avatar
Elliot Lee committed
1045
gtk_selection_convert (GtkWidget *widget, 
1046 1047
		       GdkAtom	  selection, 
		       GdkAtom	  target,
1048
		       guint32	  time_)
Elliot Lee's avatar
Elliot Lee committed
1049 1050 1051 1052
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
1053
  GdkDisplay *display;
1054
  
1055 1056
  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
1057
  
Elliot Lee's avatar
Elliot Lee committed
1058 1059 1060
  if (initialize)
    gtk_selection_init ();
  
1061
  if (!gtk_widget_get_realized (widget))
Elliot Lee's avatar
Elliot Lee committed
1062
    gtk_widget_realize (widget);
1063
  
Elliot Lee's avatar
Elliot Lee committed
1064 1065 1066 1067 1068
  /* 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. */
1069
  
Elliot Lee's avatar
Elliot Lee committed
1070 1071 1072 1073 1074 1075 1076 1077
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
1078
  
1079
  info = g_slice_new (GtkRetrievalInfo);
1080
  
Elliot Lee's avatar
Elliot Lee committed
1081 1082 1083
  info->widget = widget;
  info->selection = selection;
  info->target = target;
Owen Taylor's avatar
Owen Taylor committed
1084
  info->idle_time = 0;
Elliot Lee's avatar
Elliot Lee committed
1085 1086
  info->buffer = NULL;
  info->offset = -1;
1087
  
Elliot Lee's avatar
Elliot Lee committed
1088 1089
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
1090 1091 1092

  display = gtk_widget_get_display (widget);
  owner_window = gdk_selection_owner_get_for_display (display, selection);
Elliot Lee's avatar
Elliot Lee committed
1093 1094 1095 1096
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
1097
      gpointer owner_widget_ptr;
1098
      GtkSelectionData selection_data = {0};
1099
      
Elliot Lee's avatar
Elliot Lee committed
1100 1101 1102
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.length = -1;
1103
      selection_data.display = display;
1104
      
1105 1106
      gdk_window_get_user_data (owner_window, &owner_widget_ptr);
      owner_widget = owner_widget_ptr;
1107
      
Elliot Lee's avatar
Elliot Lee committed
1108 1109
      if (owner_widget != NULL)
	{
1110
	  gtk_selection_invoke_handler (owner_widget, 
1111
					&selection_data,
1112
					time_);
1113
	  
Elliot Lee's avatar
Elliot Lee committed
1114 1115 1116 1117
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
1118
					  selection_data.length,
1119
					  time_);
1120
	  
Elliot Lee's avatar
Elliot Lee committed
1121
	  g_free (selection_data.data);
1122 1123
          selection_data.data = NULL;
          selection_data.length = -1;
Elliot Lee's avatar
Elliot Lee committed
1124
	  
1125
	  g_slice_free (GtkRetrievalInfo, info);
Elliot Lee's avatar
Elliot Lee committed
1126 1127 1128 1129 1130
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
1131
  
Elliot Lee's avatar
Elliot Lee committed
1132
  current_retrievals = g_list_append (current_retrievals, info);
1133
  gdk_selection_convert (gtk_widget_get_window (widget), selection, target, time_);
1134 1135
  gdk_threads_add_timeout (1000,
      (GSourceFunc) gtk_selection_retrieval_timeout, info);
1136
  
Elliot Lee's avatar
Elliot Lee committed
1137 1138 1139
  return TRUE;
}

1140 1141 1142 1143 1144 1145
/**
 * gtk_selection_data_get_selection:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the selection #GdkAtom of the selection data.
 *
1146
 * Returns: (transfer none): the selection #GdkAtom of the selection data.
1147 1148 1149 1150
 *
 * Since: 2.16
 **/
GdkAtom
1151
gtk_selection_data_get_selection (const GtkSelectionData *selection_data)
1152 1153 1154 1155 1156 1157
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->selection;
}

Tim Janik's avatar
Tim Janik committed
1158 1159 1160 1161 1162 1163
/**
 * gtk_selection_data_get_target:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the target of the selection.
 *
1164
 * Returns: (transfer none): the target of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1165
 *
1166
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1167
 **/
1168
GdkAtom
1169
gtk_selection_data_get_target (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->target;
}

/**
 * gtk_selection_data_get_data_type:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the data type of the selection.
 *
1182
 * Returns: (transfer none): the data type of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1183
 *
1184
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1185
 **/
1186
GdkAtom
1187
gtk_selection_data_get_data_type (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->type;
}

/**
 * gtk_selection_data_get_format:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the format of the selection.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1200 1201
 * Returns: the format of the selection.
 *
1202
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1203
 **/
1204
gint
1205
gtk_selection_data_get_format (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1206 1207 1208 1209 1210 1211 1212
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->format;
}

/**
1213
 * gtk_selection_data_get_data: (skip)
Tim Janik's avatar
Tim Janik committed
1214 1215 1216 1217
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the raw data of the selection.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1218 1219
 * Returns: the raw data of the selection.
 *
1220
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1221
 **/
1222
const guchar*
1223
gtk_selection_data_get_data (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1224 1225 1226
{
  g_return_val_if_fail (selection_data != NULL, NULL);

1227
  return selection_data->data;
Tim Janik's avatar
Tim Janik committed
1228
}
Elliot Lee's avatar
Elliot Lee committed
1229

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
/**
 * gtk_selection_data_get_length:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the length of the raw data of the selection.
 *
 * Returns: the length of the data of the selection.
 *
 * Since: 2.14
 */
gint
1241
gtk_selection_data_get_length (const GtkSelectionData *selection_data)
1242 1243 1244 1245 1246 1247
{
  g_return_val_if_fail (selection_data != NULL, -1);

  return selection_data->length;
}

1248 1249 1250
/**
 * gtk_selection_data_get_data_with_length:
 * @selection_data: a pointer to a #GtkSelectionData structure
1251
 * @length: (out): return location for length of the data segment
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
 *
 * Retrieves the raw data of the selection along with its length.
 *
 * Returns: (array length=length): the raw data of the selection
 *
 * Rename to: gtk_selection_data_get_data
 * 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;
}

1271 1272 1273 1274 1275 1276
/**
 * gtk_selection_data_get_display:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the display of the selection.
 *
1277
 * Returns: (transfer none): the display of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1278
 *
1279
 * Since: 2.14
1280 1281
 **/
GdkDisplay *
1282
gtk_selection_data_get_display (const GtkSelectionData *selection_data)
1283 1284 1285 1286 1287 1288
{
  g_return_val_if_fail (selection_data != NULL, NULL);

  return selection_data->display;
}

1289 1290 1291 1292 1293
/**
 * gtk_selection_data_set:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 * @type: the type of selection data
 * @format: format (number of bits in a unit)
1294
 * @data: (array length=length): pointer to the data (will be copied)
1295 1296 1297 1298 1299 1300
 * @length: length of the data
 * 
 * Stores new data into a #GtkSelectionData object. Should
 * <emphasis>only</emphasis> be called from a selection handler callback.
 * Zero-terminates the stored data.
 **/
Elliot Lee's avatar
Elliot Lee committed
1301 1302
void 
gtk_selection_data_set (GtkSelectionData *selection_data,
1303 1304
			GdkAtom		  type,
			gint		  format,
1305
			const guchar	 *data,
1306
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
1307
{
1308 1309
  g_return_if_fail (selection_data != NULL);

1310
  g_free (selection_data->data);
1311
  
Elliot Lee's avatar
Elliot Lee committed
1312 1313
  selection_data->type = type;
  selection_data->format = format;
1314
  
Elliot Lee's avatar
Elliot Lee committed
1315 1316 1317 1318 1319 1320 1321
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
1322 1323 1324 1325 1326 1327
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
1328
	selection_data->data = (guchar *) g_strdup ("");
1329
    }
1330
  
Elliot Lee's avatar
Elliot Lee committed
1331 1332 1333
  selection_data->length = length;
}

1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
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,
1347
			      8, (guchar *) latin1, strlen (latin1));
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
      g_free (latin1);
      
      return TRUE;
    }
  else
    return FALSE;
}

static gboolean
selection_set_compound_text (GtkSelectionData *selection_data,
			     const gchar      *str,
			     gint              len)
{
  gchar *tmp;
  guchar *text;
  GdkAtom encoding;
  gint format;
  gint new_length;
  gboolean result = FALSE;
1367 1368

#ifdef GDK_WINDOWING_X11
1369
  if (GDK_IS_X11_DISPLAY (selection_data->display))
1370
    {
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
      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);
1381
    }
1382
#endif
1383 1384 1385 1386

  return result;
}

1387 1388 1389 1390 1391 1392 1393 1394
/* 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;
1395
  const gchar *end = str + len;
1396

1397
  while (p < end)
1398 1399 1400 1401 1402 1403 1404 1405
    {
      if (*p == '\n')
	g_string_append_c (result, '\r');

      if (*p == '\r')
	{
	  g_string_append_c (result, *p);
	  p++;
1406
	  if (p == end || *p != '\n')
1407
	    g_string_append_c (result, '\n');
1408 1409
	  if (p == end)
	    break;
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
	}

      g_string_append_c (result, *p);
      p++;
    }

  return g_string_free (result, FALSE);  
}

/* Normalize \r and \r\n into \n
 */
static gchar *
normalize_to_lf (gchar *str, 
		 gint   len)
{
  GString *result = g_string_sized_new (len);
  const gchar *p = str;

  while (1)
    {
      if (*p == '\r')
	{
	  p++;
	  if (*p != '\n')
	    g_string_append_c (result, '\n');
	}

      if (*p == '\0')
	break;

      g_string_append_c (result, *p);
      p++;
    }

  return g_string_free (result, FALSE);  
}

static gboolean
selection_set_text_plain (GtkSelectionData *selection_data,
			  const gchar      *str,
			  gint              len)
{
  const gchar *charset = NULL;
  gchar *result;
  GError *error = NULL;

  result = normalize_to_crlf (str, len);
  if (selection_data->target == text_plain_atom)
    charset = "ASCII";
  else if (selection_data->target == text_plain_locale_atom)
    g_get_charset (&charset);

  if (charset)
    {
      gchar *tmp = result;
      result = g_convert_with_fallback (tmp, -1, 
					charset, "UTF-8", 
					NULL, NULL, NULL, &error);
      g_free (tmp);
    }

  if (!result)
    {
1473 1474
      g_warning ("Error converting from %s to %s: %s",
		 "UTF-8", charset, error->message);
1475 1476 1477 1478 1479 1480 1481
      g_error_free (error);
      
      return FALSE;
    }
  
  gtk_selection_data_set (selection_data,
			  selection_data->target, 
1482
			  8, (guchar *) result, strlen (result));
1483 1484 1485 1486 1487
  g_free (result);
  
  return TRUE;
}

1488
static guchar *
1489
selection_get_text_plain (const GtkSelectionData *selection_data)
1490 1491 1492
{
  const gchar *charset = NULL;
  gchar *str, *result;
1493
  gsize len;
1494 1495
  GError *error = NULL;

1496
  str = g_strdup ((const gchar *) selection_data->data);
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
  len = selection_data->length;
  
  if (selection_data->type == text_plain_atom)
    charset = "ISO-8859-1";
  else if (selection_data->type == text_plain_locale_atom)
    g_get_charset (&charset);

  if (charset)
    {
      gchar *tmp = str;
      str = g_convert_with_fallback (tmp, len, 
1508
				     "UTF-8", charset,
1509 1510 1511
				     NULL, NULL, &len, &error);
      g_free (tmp);

1512 1513
      if (!str)
	{
1514 1515
	  g_warning ("Error converting from %s to %s: %s",
		     charset, "UTF-8", error->message);
1516 1517 1518 1519 1520 1521
	  g_error_free (error);

	  return NULL;
	}
    }
  else if (!g_utf8_validate (str, -1, NULL))
1522
    {
1523 1524
      g_warning ("Error converting from %s to %s: %s",
		 "text/plain;charset=utf-8", "UTF-8", "invalid UTF-8");
1525 1526
      g_free (str);

1527 1528 1529 1530 1531 1532
      return NULL;
    }

  result = normalize_to_lf (str, len);
  g_free (str);

1533
  return (guchar *) result;
1534 1535
}

1536 1537 1538 1539
/**
 * gtk_selection_data_set_text:
 * @selection_data: a #GtkSelectionData
 * @str: a UTF-8 string
1540
 * @len: the length of @str, or -1 if @str is nul-terminated.
1541 1542 1543 1544 1545
 * 
 * Sets the contents of the selection from a UTF-8 encoded string.
 * The string is converted to the form determined by
 * @selection_data->target.
 * 
1546
 * Return value: %TRUE if the selection was successfully set,
1547 1548 1549 1550
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
1551 1552
			     const gchar          *str,
			     gint                  len)
1553
{
1554 1555
  g_return_val_if_fail (selection_data != NULL, FALSE);

1556 1557 1558
  if (len < 0)
    len = strlen (str);
  
1559 1560 1561 1562 1563 1564
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
1565
			      8, (guchar *)str, len);
1566
      return TRUE;
1567 1568 1569
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
1570
      return selection_set_string (selection_data, str, len);
1571 1572 1573 1574
    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {