gtkselection.c 83.6 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
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18 19
 */

20
/* This file implements most of the work of the ICCCM selection protocol.
Elliot Lee's avatar
Elliot Lee committed
21 22 23 24
 * 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.
 *
25
 * The one thing in the ICCCM that isn't fully supported here (or in Tk)
Elliot Lee's avatar
Elliot Lee committed
26 27 28 29 30
 * 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.
 *
31
 * By Owen Taylor <owt1@cornell.edu>	      8/16/97
Elliot Lee's avatar
Elliot Lee committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
 */

/* 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 ... */

47
/*
48
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
49 50 51 52 53
 * 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/. 
 */

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
/**
 * 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.
 */

80
#include "config.h"
81 82 83 84

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

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

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

95 96 97 98
#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
#endif

99 100 101 102
#ifdef GDK_WINDOWING_WIN32
#include "win32/gdkwin32.h"
#endif

103
#undef DEBUG_SELECTION
Elliot Lee's avatar
Elliot Lee committed
104 105 106

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
107
#ifdef GDK_WINDOWING_X11
108 109 110 111 112
#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)
113 114 115
#else
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE(display) G_MAXINT
116
#endif
Owen Taylor's avatar
Owen Taylor committed
117

118
#define IDLE_ABORT_TIME 30
Owen Taylor's avatar
Owen Taylor committed
119

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

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

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

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

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

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

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

208 209 210 211 212 213 214 215
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

216 217 218 219 220 221 222 223

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

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

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

253
  list->ref_count++;
254 255

  return list;
256 257
}

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

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

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

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

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

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

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

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

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

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

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

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

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

  g_return_if_fail (list != NULL);

  formats = gdk_pixbuf_get_formats ();

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

451 452
	  g_free (name);

453 454 455
	  break;
	}

456
      g_free (name);
457 458
    }  

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

  g_slist_free (formats);
}

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

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

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

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

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

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

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

577
  g_return_val_if_fail (list != NULL, FALSE);
578 579

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

      if (pair->target == target)
	{
586 587 588
          if (info)
            *info = pair->info;

589 590
	  return TRUE;
	}
591

592 593 594 595 596 597
      tmp_list = tmp_list->next;
    }

  return FALSE;
}

598 599 600 601 602 603 604 605 606 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 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/**
 * gtk_target_table_new_from_list:
 * @list: a #GtkTargetList
 * @n_targets: return location for the number ot targets in the table
 *
 * 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.
 *
 * Return value: the new table.
 *
 * 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:
 * @targets: a #GtkTargetEntry array
 * @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);
}

664 665
/**
 * gtk_selection_owner_set_for_display:
666 667
 * @display: the #Gdkdisplay where the selection is set
 * @widget: (allow-none): new selection owner (a #GdkWidget), or %NULL.
668
 * @selection: an interned atom representing the selection to claim.
669
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
670
 *
671 672 673 674
 * 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 
675 676
 * 
 * Since: 2.2
677
 */
678
gboolean
679 680 681 682
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
683 684 685
{
  GList *tmp_list;
  GtkWidget *old_owner;
686
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
687
  GdkWindow *window;
688

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

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

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

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

767 768
/**
 * gtk_selection_owner_set:
769
 * @widget: (allow-none):  a #GtkWidget, or %NULL.
770
 * @selection:  an interned atom representing the selection to claim
771
 * @time_: timestamp with which to claim the selection
772 773 774 775 776 777 778 779 780 781 782
 * 
 * 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)
{
783 784
  GdkDisplay *display;
  
785
  g_return_val_if_fail (widget == NULL || gtk_widget_get_realized (widget), FALSE);
786
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
787 788 789 790 791 792 793 794

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

802
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
803

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

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

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

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

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

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

      gtk_target_list_unref (sellist->list);

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

  g_list_free (lists);
859
  g_object_set_data (G_OBJECT (widget), I_(gtk_selection_handler_key), NULL);
860 861
}

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

878 879 880
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);

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

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

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

920 921
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
922 923 924

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

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

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

#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);
962
    gdk_win32_selection_add_targets (gtk_widget_get_window (widget), selection, ntargets, atoms);
963 964 965
    g_free (atoms);
  }
#endif
Elliot Lee's avatar
Elliot Lee committed
966 967
}

968

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

  g_return_if_fail (GTK_IS_WIDGET (widget));

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

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


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

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

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

  return selection_data->selection;
}

Tim Janik's avatar
Tim Janik committed
1161 1162 1163 1164 1165 1166
/**
 * gtk_selection_data_get_target:
 * @selection_data: a pointer to a #GtkSelectionData structure.
 *
 * Retrieves the target of the selection.
 *
1167
 * Returns: (transfer none): the target of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1168
 *
1169
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1170
 **/
1171
GdkAtom
1172
gtk_selection_data_get_target (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
{
  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.
 *
1185
 * Returns: (transfer none): the data type of the selection.
Matthias Clasen's avatar
Matthias Clasen committed
1186
 *
1187
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1188
 **/
1189
GdkAtom
1190
gtk_selection_data_get_data_type (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
{
  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
1203 1204
 * Returns: the format of the selection.
 *
1205
 * Since: 2.14
Tim Janik's avatar
Tim Janik committed
1206
 **/
1207
gint
1208
gtk_selection_data_get_format (const GtkSelectionData *selection_data)
Tim Janik's avatar
Tim Janik committed
1209 1210 1211 1212 1213 1214 1215
{
  g_return_val_if_fail (selection_data != NULL, 0);

  return selection_data->format;
}

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

1230
  return selection_data->data;
Tim Janik's avatar
Tim Janik committed
1231
}
Elliot Lee's avatar
Elliot Lee committed
1232

1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
/**
 * 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
1244
gtk_selection_data_get_length (const GtkSelectionData *selection_data)
1245 1246 1247 1248 1249 1250
{
  g_return_val_if_fail (selection_data != NULL, -1);

  return selection_data->length;
}

1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
/**
 * gtk_selection_data_get_data_with_length:
 * @selection_data: a pointer to a #GtkSelectionData structure
 * @length: return location for length of the data segment
 *
 * 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;
}

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

  return selection_data->display;
}

1292 1293 1294 1295 1296
/**
 * 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)
1297
 * @data: (array length=length): pointer to the data (will be copied)
1298 1299 1300 1301 1302 1303
 * @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
1304 1305
void 
gtk_selection_data_set (GtkSelectionData *selection_data,
1306 1307
			GdkAtom		  type,
			gint		  format,
1308
			const guchar	 *data,
1309
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
1310
{
1311 1312
  g_return_if_fail (selection_data != NULL);

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

1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
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,
1350
			      8, (guchar *) latin1, strlen (latin1));
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
      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;
1370 1371

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

  return result;
}

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

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

      if (*p == '\r')
	{
	  g_string_append_c (result, *p);
	  p++;
1409
	  if (p == end || *p != '\n')
1410
	    g_string_append_c (result, '\n');
1411 1412
	  if (p == end)
	    break;
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 1473 1474 1475
	}

      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)
    {
1476 1477
      g_warning ("Error converting from %s to %s: %s",
		 "UTF-8", charset, error->message);
1478 1479 1480 1481 1482 1483 1484
      g_error_free (error);
      
      return FALSE;
    }
  
  gtk_selection_data_set (selection_data,
			  selection_data->target, 
1485
			  8, (guchar *) result, strlen (result));
1486 1487 1488 1489 1490
  g_free (result);
  
  return TRUE;
}

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

1499
  str = g_strdup ((const gchar *) selection_data->data);
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
  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, 
1511
				     "UTF-8", charset,
1512 1513 1514
				     NULL, NULL, &len, &error);
      g_free (tmp);

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

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

1530 1531 1532 1533 1534 1535
      return NULL;
    }

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

1536
  return (guchar *) result;
1537 1538
}

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

1559 1560 1561
  if (len < 0)
    len = strlen (str);
  
1562 1563 1564 1565 1566 1567
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
1568
			      8, (guchar *)str, len);
1569
      return TRUE;
1570 1571 1572
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
1573
      return selection_set_string (selection_data, str, len);
1574 1575 1576 1577
    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
1578 1579 1580 1581
      if (selection_set_compound_text (selection_data, str, len))
	return TRUE;
      else if (selection_data->target == text_atom)
	return selection_set_string (selection_data, str, len);
1582
    }
1583 1584 1585 1586 1587 1588
  else if (selection_data->target == text_plain_atom ||
	   selection_data->target == text_plain_utf8_atom ||
	   selection_data->target == text_plain_locale_atom)
    {
      return selection_set_text_plain (selection_data, str, len);
    }
1589 1590

  return FALSE;
1591 1592 1593 1594 1595 1596 1597 1598
}

/**
 * gtk_selection_data_get_text:
 * @selection_data: a #GtkSelectionData
 * 
 * Gets the contents of the selection data as a UTF-8 string.
 * 
1599 1600 1601
 * Return value: (type utf8): if the selection data contained a
 *   recognized text type and it could be converted to UTF-8, a newly
 *   allocated string containing the converted text, otherwise %NULL.
1602 1603 1604
 *   If the result is non-%NULL it must be freed with g_free().
 **/
guchar *
1605
gtk_selection_data_get_text (const GtkSelectionData *selection_data)
1606 1607 1608
{
  guchar *result = NULL;