gtkselection.c 56.9 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * 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
#include <config.h>
Elliot Lee's avatar
Elliot Lee committed
55
#include <stdarg.h>
56
#include <string.h>
57 58
#include "gdk.h"

59
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
60 61 62
#include "gtkmain.h"
#include "gtkselection.h"

63 64 65 66
#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
#endif

Matthias Clasen's avatar
Matthias Clasen committed
67
#undef DEBUG_SELECTION
Elliot Lee's avatar
Elliot Lee committed
68 69 70

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
71
#ifdef GDK_WINDOWING_X11
72 73 74 75 76
#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)
77 78 79
#else
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE(display) G_MAXINT
80
#endif
Owen Taylor's avatar
Owen Taylor committed
81 82 83

#define IDLE_ABORT_TIME 300

Elliot Lee's avatar
Elliot Lee committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
enum {
  INCR,
  MULTIPLE,
  TARGETS,
  TIMESTAMP,
  LAST_ATOM
};

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

struct _GtkSelectionInfo
{
99 100 101 102
  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
103 104 105 106
};

struct _GtkIncrConversion 
{
107 108
  GdkAtom	    target;	/* Requested target */
  GdkAtom	    property;	/* Property to store in */
Elliot Lee's avatar
Elliot Lee committed
109
  GtkSelectionData  data;	/* The data being supplied */
110
  gint		    offset;	/* Current offset in sent selection.
Elliot Lee's avatar
Elliot Lee committed
111 112
				 *  -1 => All done
				 *  -2 => Only the final (empty) portion
113
				 *	  left to send */
Elliot Lee's avatar
Elliot Lee committed
114 115 116 117 118 119 120
};

struct _GtkIncrInfo
{
  GdkWindow *requestor;		/* Requestor window - we create a GdkWindow
				   so we can receive events */
  GdkAtom    selection;		/* Selection we're sending */
121
  
Elliot Lee's avatar
Elliot Lee committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
  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 */
140
  gint	   offset;		/* Current offset in buffer, -1 indicates
Elliot Lee's avatar
Elliot Lee committed
141
				   not yet started */
142
  guint32 notify_time;		/* Timestamp from SelectionNotify */
Elliot Lee's avatar
Elliot Lee committed
143 144 145
};

/* Local Functions */
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
static void gtk_selection_init              (void);
static gint gtk_selection_incr_timeout      (GtkIncrInfo      *info);
static gint gtk_selection_retrieval_timeout (GtkRetrievalInfo *info);
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
161 162 163 164 165 166 167 168

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

171 172 173 174 175 176 177 178 179
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
180 181
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
182 183 184 185 186 187 188 189 190 191 192 193 194 195
{
  GtkTargetList *result = g_new (GtkTargetList, 1);
  result->list = NULL;
  result->ref_count = 1;

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

void               
gtk_target_list_ref (GtkTargetList *list)
{
196 197
  g_return_if_fail (list != NULL);

198 199 200 201 202 203
  list->ref_count++;
}

void               
gtk_target_list_unref (GtkTargetList *list)
{
204 205 206
  g_return_if_fail (list != NULL);
  g_return_if_fail (list->ref_count > 0);

207 208 209 210 211 212
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
Owen Taylor's avatar
Owen Taylor committed
213 214
	  GtkTargetPair *pair = tmp_list->data;
	  g_free (pair);
215 216 217

	  tmp_list = tmp_list->next;
	}
Owen Taylor's avatar
Owen Taylor committed
218 219
      
      g_list_free (list->list);
220
      g_free (list);
221 222 223 224 225
    }
}

void 
gtk_target_list_add (GtkTargetList *list,
226 227 228
		     GdkAtom        target,
		     guint          flags,
		     guint          info)
229 230 231 232 233 234 235 236 237 238 239 240 241
{
  GtkTargetPair *pair;

  g_return_if_fail (list != NULL);
  
  pair = g_new (GtkTargetPair, 1);
  pair->target = target;
  pair->flags = flags;
  pair->info = info;

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

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
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;

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

  if (!utf8_atom)
    {
      utf8_atom = gdk_atom_intern ("UTF8_STRING", FALSE);
      text_atom = gdk_atom_intern ("TEXT", FALSE);
      ctext_atom = gdk_atom_intern ("COMPOUND_TEXT", FALSE);
      text_plain_atom = gdk_atom_intern ("text/plain", FALSE);
      text_plain_utf8_atom = gdk_atom_intern ("text/plain;charset=utf-8", FALSE);
      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);
    }
}

/**
 * gtk_target_list_add_text_targets:
 * @list: a #GtkTargetList
 * 
 * Adds the text targets supported by #GtkSelection to
 * the target list. The targets are added with both flags
 * and info being zero.
 * 
 * Since: 2.6
 **/
void 
gtk_target_list_add_text_targets (GtkTargetList *list)
{
  g_return_if_fail (list != NULL);
  
  init_atoms ();

  /* Keep in sync with gtk_selection_data_targets_include_text()
   */
  gtk_target_list_add (list, utf8_atom, 0, 0);  
  gtk_target_list_add (list, ctext_atom, 0, 0);  
  gtk_target_list_add (list, text_atom, 0, 0);  
  gtk_target_list_add (list, GDK_TARGET_STRING, 0, 0);  
  gtk_target_list_add (list, text_plain_utf8_atom, 0, 0);  
  gtk_target_list_add (list, text_plain_locale_atom, 0, 0);  
  gtk_target_list_add (list, text_plain_atom, 0, 0);  
}

297
void               
298 299 300
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
{
  gint i;

  for (i=ntargets-1; i >= 0; i--)
    {
      GtkTargetPair *pair = g_new (GtkTargetPair, 1);
      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);
    }
}

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)
	{
	  g_free (pair);

332
	  list->list = g_list_remove_link (list->list, tmp_list);
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
	  g_list_free_1 (tmp_list);

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

gboolean
gtk_target_list_find (GtkTargetList *list,
		      GdkAtom        target,
		      guint         *info)
{
  GList *tmp_list = list->list;
  while (tmp_list)
    {
      GtkTargetPair *pair = tmp_list->data;

      if (pair->target == target)
	{
	  *info = pair->info;
	  return TRUE;
	}
      tmp_list = tmp_list->next;
    }

  return FALSE;
}

363 364 365 366 367
/**
 * gtk_selection_owner_set_for_display:
 * @display: the #Gdkdisplay where the selection is set 
 * @widget: new selection owner (a #GdkWidget), or %NULL.
 * @selection: an interned atom representing the selection to claim.
368
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
369
 *
370 371 372 373
 * 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 
Matthias Clasen's avatar
Matthias Clasen committed
374 375
 * 
 * Since: 2.2
376
 */
377
gboolean
378 379 380 381
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
382 383 384
{
  GList *tmp_list;
  GtkWidget *old_owner;
385
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
386
  GdkWindow *window;
387

388
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
389
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
390
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
391
  g_return_val_if_fail (widget == NULL || gtk_widget_get_display (widget) == display, FALSE);
392
  
Elliot Lee's avatar
Elliot Lee committed
393 394 395
  if (widget == NULL)
    window = NULL;
  else
396 397
    window = widget->window;

Elliot Lee's avatar
Elliot Lee committed
398 399 400
  tmp_list = current_selections;
  while (tmp_list)
    {
401 402 403 404 405
      if (((GtkSelectionInfo *)tmp_list->data)->selection == selection)
	{
	  selection_info = tmp_list->data;
	  break;
	}
Elliot Lee's avatar
Elliot Lee committed
406 407 408
      
      tmp_list = tmp_list->next;
    }
409
  
410
  if (gdk_selection_owner_set_for_display (display, window, selection, time, TRUE))
Elliot Lee's avatar
Elliot Lee committed
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    {
      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);
	      g_free (selection_info);
	    }
	}
      else
	{
	  if (selection_info == NULL)
	    {
	      selection_info = g_new (GtkSelectionInfo, 1);
	      selection_info->selection = selection;
	      selection_info->widget = widget;
	      selection_info->time = time;
433 434
	      selection_info->display = display;
	      current_selections = g_list_prepend (current_selections,
435
						   selection_info);
Elliot Lee's avatar
Elliot Lee committed
436 437 438 439 440 441
	    }
	  else
	    {
	      old_owner = selection_info->widget;
	      selection_info->widget = widget;
	      selection_info->time = time;
442
	      selection_info->display = display;
Elliot Lee's avatar
Elliot Lee committed
443 444 445
	    }
	}
      /* If another widget in the application lost the selection,
446 447 448
       *  send it a GDK_SELECTION_CLEAR event.
       */
      if (old_owner && old_owner != widget)
Elliot Lee's avatar
Elliot Lee committed
449
	{
450
	  GdkEvent *event = gdk_event_new (GDK_SELECTION_CLEAR);
Elliot Lee's avatar
Elliot Lee committed
451
	  
452 453 454
	  event->selection.window = g_object_ref (old_owner->window);
	  event->selection.selection = selection;
	  event->selection.time = time;
455
	  
456 457 458
	  gtk_widget_event (old_owner, event);

	  gdk_event_free (event);
Elliot Lee's avatar
Elliot Lee committed
459 460 461 462 463 464 465
	}
      return TRUE;
    }
  else
    return FALSE;
}

466 467 468 469
/**
 * gtk_selection_owner_set:
 * @widget:  a #GtkWidget, or %NULL.
 * @selection:  an interned atom representing the selection to claim
470
 * @time_: timestamp with which to claim the selection
471 472 473 474 475 476 477 478 479 480 481
 * 
 * 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)
{
482 483
  GdkDisplay *display;
  
484
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
485
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
486 487 488 489 490 491 492 493

  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
494
      display = gdk_display_get_default ();
495
    }
496
  
497 498
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
499 500
}

Elliot Lee's avatar
Elliot Lee committed
501
/*************************************************************
502 503
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
504 505
 *
 *   arguments:
506
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
507 508
 *     selection:
 *     target:
509
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
510 511 512 513
 *
 *   results:
 *************************************************************/

514
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
515

516 517 518 519 520 521 522 523
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
524
{
525
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
526
  GList *tmp_list;
527 528
  GList *lists;

Manish Singh's avatar
Manish Singh committed
529
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
530
  
531
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
532 533
  while (tmp_list)
    {
534 535 536
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
537 538
      tmp_list = tmp_list->next;
    }
539 540 541 542 543 544

  sellist = g_new (GtkSelectionTargetList, 1);
  sellist->selection = selection;
  sellist->list = gtk_target_list_new (NULL, 0);

  lists = g_list_prepend (lists, sellist);
Manish Singh's avatar
Manish Singh committed
545
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
546 547 548 549 550 551 552 553 554 555 556

  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
557
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
558
  
559 560
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
561
    {
562 563 564 565 566 567
      sellist = tmp_list->data;

      gtk_target_list_unref (sellist->list);

      g_free (sellist);
      tmp_list = tmp_list->next;
Elliot Lee's avatar
Elliot Lee committed
568
    }
569 570

  g_list_free (lists);
Manish Singh's avatar
Manish Singh committed
571
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, NULL);
572 573
}

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
/**
 * 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;

590 591 592
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);

Manish Singh's avatar
Manish Singh committed
593
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
  
  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);
	  g_free (sellist);

	  break;
	}
      
      tmp_list = tmp_list->next;
    }
  
Manish Singh's avatar
Manish Singh committed
611
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
612 613
}

614 615 616 617 618 619 620 621
void 
gtk_selection_add_target (GtkWidget	    *widget, 
			  GdkAtom	     selection,
			  GdkAtom	     target,
			  guint              info)
{
  GtkTargetList *list;

622 623
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
624 625 626 627 628 629

  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add (list, target, 0, info);
}

void 
630 631 632 633
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
634 635
{
  GtkTargetList *list;
636 637 638

  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
639
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
640
  
641 642
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
643 644
}

645

Elliot Lee's avatar
Elliot Lee committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
/*************************************************************
 * gtk_selection_remove_all:
 *     Removes all handlers and unsets ownership of all 
 *     selections for a widget. Called when widget is being
 *     destroyed
 *     
 *   arguments:
 *     widget:	  The widget
 *   results:
 *************************************************************/

void
gtk_selection_remove_all (GtkWidget *widget)
{
  GList *tmp_list;
  GList *next;
  GtkSelectionInfo *selection_info;
663
  
Elliot Lee's avatar
Elliot Lee committed
664
  /* Remove pending requests/incrs for this widget */
665
  
Elliot Lee's avatar
Elliot Lee committed
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
  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 */
681
  
Elliot Lee's avatar
Elliot Lee committed
682 683 684 685 686 687 688 689
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
690 691 692 693 694
	  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
695 696 697 698 699 700 701
						   tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
      
      tmp_list = next;
    }
702 703 704

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
705 706 707 708 709 710 711 712
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
713
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
714
 *     selection:  Which selection to get
715 716 717
 *     target:	   Form of information desired (e.g., STRING)
 *     time:	   Time of request (usually of triggering event)
 *		   In emergency, you could use GDK_CURRENT_TIME
Elliot Lee's avatar
Elliot Lee committed
718 719 720 721 722 723 724
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

725
gboolean
Elliot Lee's avatar
Elliot Lee committed
726
gtk_selection_convert (GtkWidget *widget, 
727 728 729
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
730 731 732 733
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
734
  GdkDisplay *display;
735
  
736 737
  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
738
  
Elliot Lee's avatar
Elliot Lee committed
739 740 741 742 743
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
744
  
Elliot Lee's avatar
Elliot Lee committed
745 746 747 748 749
  /* 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. */
750
  
Elliot Lee's avatar
Elliot Lee committed
751 752 753 754 755 756 757 758
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
759
  
Elliot Lee's avatar
Elliot Lee committed
760
  info = g_new (GtkRetrievalInfo, 1);
761
  
Elliot Lee's avatar
Elliot Lee committed
762 763 764
  info->widget = widget;
  info->selection = selection;
  info->target = target;
Owen Taylor's avatar
Owen Taylor committed
765
  info->idle_time = 0;
Elliot Lee's avatar
Elliot Lee committed
766 767
  info->buffer = NULL;
  info->offset = -1;
768
  
Elliot Lee's avatar
Elliot Lee committed
769 770
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
771 772 773

  display = gtk_widget_get_display (widget);
  owner_window = gdk_selection_owner_get_for_display (display, selection);
Elliot Lee's avatar
Elliot Lee committed
774 775 776 777 778
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
779
      
Elliot Lee's avatar
Elliot Lee committed
780 781 782 783
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
784
      selection_data.display = display;
785
      
Elliot Lee's avatar
Elliot Lee committed
786
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
787
      
Elliot Lee's avatar
Elliot Lee committed
788 789
      if (owner_widget != NULL)
	{
790
	  gtk_selection_invoke_handler (owner_widget, 
791 792
					&selection_data,
					time);
793
	  
Elliot Lee's avatar
Elliot Lee committed
794 795 796 797
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
798 799
					  selection_data.length,
					  time);
800
	  
Elliot Lee's avatar
Elliot Lee committed
801 802 803 804 805 806 807 808
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
809
  
Elliot Lee's avatar
Elliot Lee committed
810 811
  current_retrievals = g_list_append (current_retrievals, info);
  gdk_selection_convert (widget->window, selection, target, time);
812
  g_timeout_add (1000, (GSourceFunc) gtk_selection_retrieval_timeout, info);
813
  
Elliot Lee's avatar
Elliot Lee committed
814 815 816 817 818 819 820 821 822 823
  return TRUE;
}

/*************************************************************
 * gtk_selection_data_set:
 *     Store new data into a GtkSelectionData object. Should
 *     _only_ by called from a selection handler callback.
 *     Null terminates the stored data.
 *   arguments:
 *     type:	the type of selection data
824 825 826
 *     format:	format (number of bits in a unit)
 *     data:	pointer to the data (will be copied)
 *     length:	length of the data
Elliot Lee's avatar
Elliot Lee committed
827 828 829 830 831
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
832 833
			GdkAtom		  type,
			gint		  format,
834
			const guchar	 *data,
835
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
836 837 838
{
  if (selection_data->data)
    g_free (selection_data->data);
839
  
Elliot Lee's avatar
Elliot Lee committed
840 841
  selection_data->type = type;
  selection_data->format = format;
842
  
Elliot Lee's avatar
Elliot Lee committed
843 844 845 846 847 848 849
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
850 851 852 853 854 855 856 857
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
858
  
Elliot Lee's avatar
Elliot Lee committed
859 860 861
  selection_data->length = length;
}

862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
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,
			      8, latin1, strlen (latin1));
      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;
  
  tmp = g_strndup (str, len);
  if (gdk_utf8_to_compound_text_for_display (selection_data->display, tmp,
					     &encoding, &format, &text, &new_length))
    {
      gtk_selection_data_set (selection_data, encoding, format, text, new_length);
      gdk_free_compound_text (text);
      
      result = TRUE;
    }

  g_free (tmp);

  return result;
}

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
/* 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;

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

      if (*p == '\r')
	{
	  g_string_append_c (result, *p);
	  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);  
}

/* 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)
    {
      g_warning ("Error converting from UTF-8 to %s: %s",
		 charset, error->message);
      g_error_free (error);
      
      return FALSE;
    }
  
  gtk_selection_data_set (selection_data,
			  selection_data->target, 
			  8, result, strlen (result));
  g_free (result);
  
  return TRUE;
}

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

  str = g_strdup (selection_data->data);
  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, 
				     charset, "UTF-8", 
				     NULL, NULL, &len, &error);
      g_free (tmp);
    }

  if (!str)
    {
      g_warning ("Error converting from %s to UTF-8: %s",
		 charset, error->message);
      g_error_free (error);
      
      return NULL;
    }


  result = normalize_to_lf (str, len);

  g_free (str);

  return result;
}

1054 1055 1056 1057
/**
 * gtk_selection_data_set_text:
 * @selection_data: a #GtkSelectionData
 * @str: a UTF-8 string
1058
 * @len: the length of @str, or -1 if @str is nul-terminated.
1059 1060 1061 1062 1063
 * 
 * Sets the contents of the selection from a UTF-8 encoded string.
 * The string is converted to the form determined by
 * @selection_data->target.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
1064
 * Return value: %TRUE if the selection was successfully set,
1065 1066 1067 1068
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
1069 1070
			     const gchar          *str,
			     gint                  len)
1071
{
1072 1073 1074
  if (len < 0)
    len = strlen (str);
  
1075 1076 1077 1078 1079 1080
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
1081
			      8, (guchar *)str, len);
1082
      return TRUE;
1083 1084 1085
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
1086
      return selection_set_string (selection_data, str, len);
1087 1088 1089 1090
    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
1091 1092 1093 1094
      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);
1095
    }
1096 1097 1098 1099 1100 1101
  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);
    }
1102 1103

  return FALSE;
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
}

/**
 * gtk_selection_data_get_text:
 * @selection_data: a #GtkSelectionData
 * 
 * Gets the contents of the selection data as a UTF-8 string.
 * 
 * Return value: 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.
 *   If the result is non-%NULL it must be freed with g_free().
 **/
guchar *
gtk_selection_data_get_text (GtkSelectionData *selection_data)
{
  guchar *result = NULL;

  init_atoms ();
  
  if (selection_data->length >= 0 &&
      (selection_data->type == GDK_TARGET_STRING ||
       selection_data->type == ctext_atom ||
       selection_data->type == utf8_atom))
    {
      gchar **list;
      gint i;
1131 1132 1133 1134 1135 1136
      gint count = gdk_text_property_to_utf8_list_for_display (selection_data->display,
      							       selection_data->type,
						   	       selection_data->format, 
						               selection_data->data,
						               selection_data->length,
						               &list);
1137 1138 1139 1140 1141 1142 1143
      if (count > 0)
	result = list[0];

      for (i = 1; i < count; i++)
	g_free (list[i]);
      g_free (list);
    }
1144 1145 1146 1147 1148 1149 1150
  else if (selection_data->length >= 0 &&
	   (selection_data->type == text_plain_atom ||
	    selection_data->type == text_plain_utf8_atom ||
	    selection_data->type == text_plain_locale_atom))
    {
      result = selection_get_text_plain (selection_data);
    }
1151 1152 1153 1154

  return result;
}

1155 1156 1157 1158 1159 1160 1161
/**
 * gtk_selection_data_get_targets:
 * @selection_data: a #GtkSelectionData object
 * @targets: location to store an array of targets. The result
 *           stored here must be freed with g_free().
 * @n_atoms: location to store number of items in @targets.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
1162
 * Gets the contents of @selection_data as an array of targets.
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
 * This can be used to interpret the results of getting
 * the standard TARGETS target that is always supplied for
 * any selection.
 * 
 * Return value: %TRUE if @selection_data contains a valid
 *    array of targets, otherwise %FALSE.
 **/
gboolean
gtk_selection_data_get_targets (GtkSelectionData  *selection_data,
				GdkAtom          **targets,
				gint              *n_atoms)
{
  if (selection_data->length >= 0 &&
      selection_data->format == 32 &&
      selection_data->type == GDK_SELECTION_TYPE_ATOM)
    {
      if (targets)
	*targets = g_memdup (selection_data->data, selection_data->length);
      if (n_atoms)
	*n_atoms = selection_data->length / sizeof (GdkAtom);

      return TRUE;
    }
  else
    {
      if (targets)
	*targets = NULL;
      if (n_atoms)
	*n_atoms = -1;

      return FALSE;
    }
}

/**
 * gtk_selection_data_targets_include_text:
 * @selection_data: a #GtkSelectionData object
 * 
 * Given a #GtkSelectionData object holding a list of targets,
Matthias Clasen's avatar
Matthias Clasen committed
1202
 * determines if any of the targets in @targets can be used to
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
 * provide text.
 * 
 * Return value: %TRUE if @selection_data holds a list of targets,
 *   and a suitable target for text is included, otherwise %FALSE.
 **/
gboolean
gtk_selection_data_targets_include_text (GtkSelectionData *selection_data)
{
  GdkAtom *targets;
  gint n_targets;
  gint i;
  gboolean result = FALSE;

1216 1217
  init_atoms ();

1218 1219 1220 1221
  if (gtk_selection_data_get_targets (selection_data, &targets, &n_targets))
    {
      for (i=0; i < n_targets; i++)
	{
1222 1223 1224 1225 1226 1227 1228
	  if (targets[i] == utf8_atom ||
	      targets[i] == text_atom ||
	      targets[i] == GDK_TARGET_STRING ||
	      targets[i] == ctext_atom ||
	      targets[i] == text_plain_atom ||
	      targets[i] == text_plain_utf8_atom ||
	      targets[i] == text_plain_locale_atom)
1229 1230 1231 1232 1233 1234 1235 1236 1237
	    result = TRUE;
	}

      g_free (targets);
    }

  return result;
}
	  
Elliot Lee's avatar
Elliot Lee committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
/*************************************************************
 * gtk_selection_init:
 *     Initialize local variables
 *   arguments:
 *     
 *   results:
 *************************************************************/

static void
gtk_selection_init (void)
{
  gtk_selection_atoms[INCR] = gdk_atom_intern ("INCR", FALSE);
  gtk_selection_atoms[MULTIPLE] = gdk_atom_intern ("MULTIPLE", FALSE);
  gtk_selection_atoms[TIMESTAMP] = gdk_atom_intern ("TIMESTAMP", FALSE);
  gtk_selection_atoms[TARGETS] = gdk_atom_intern ("TARGETS", FALSE);
1253 1254

  initialize = FALSE;
Elliot Lee's avatar
Elliot Lee committed
1255 1256
}

1257
/**
Elliot Lee's avatar
Elliot Lee committed
1258
 * gtk_selection_clear:
1259 1260 1261 1262
 * @widget: a #GtkWidget
 * @event: the event
 * 
 * The default handler for the GtkWidget::selection_clear_event
Matthias Clasen's avatar
Matthias Clasen committed
1263
 * signal. 
1264 1265
 * 
 * Return value: %TRUE if the event was handled, otherwise false
Matthias Clasen's avatar
Matthias Clasen committed
1266 1267
 * 
 * Since: 2.2
Matthias Clasen's avatar
Matthias Clasen committed
1268 1269 1270 1271
 *
 * Deprecated: Instead of calling this function, chain up from
 * your selection_clear_event handler. Calling this function
 * from any other context is illegal. 
1272
 **/
1273
gboolean
1274
gtk_selection_clear (GtkWidget         *widget,
Elliot Lee's avatar
Elliot Lee committed
1275 1276
		     GdkEventSelection *event)
{
1277 1278 1279 1280
  /* Note that we filter clear events in gdkselection-x11.c, so
   * that we only will get here if the clear event actually
   * represents a change that we didn't do ourself.
   */
Elliot Lee's avatar
Elliot Lee committed
1281
  GList *tmp_list;
1282
  GtkSelectionInfo *selection_info = NULL;
1283
  
Elliot Lee's avatar
Elliot Lee committed
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
  tmp_list = current_selections;
  while (tmp_list)
    {
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
      
      tmp_list = tmp_list->next;
    }
1295
  
1296 1297
  if (tmp_list)
    {
1298 1299 1300
      current_selections = g_list_remove_link (current_selections, tmp_list);
      g_list_free (tmp_list);
      g_free (selection_info);
1301 1302
    }
  
Elliot Lee's avatar
Elliot Lee committed
1303 1304 1305 1306 1307
  return TRUE;
}


/*************************************************************
1308
 * _gtk_selection_request:
Elliot Lee's avatar
Elliot Lee committed
1309 1310 1311 1312 1313 1314 1315
 *     Handler for "selection_request_event" 
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

1316
gboolean
1317 1318
_gtk_selection_request (GtkWidget *widget,
			GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1319
{
1320
  GdkDisplay *display = gtk_widget_get_display (widget);
Elliot Lee's avatar
Elliot Lee committed
1321 1322 1323
  GtkIncrInfo *info;
  GList *tmp_list;
  int i;
1324 1325
  gulong selection_max_size;

1326 1327 1328
  if (initialize)
    gtk_selection_init ();
  
1329 1330
  selection_max_size = GTK_SELECTION_MAX_SIZE (display);

Elliot Lee's avatar
Elliot Lee committed
1331
  /* Check if we own selection */
1332
  
Elliot Lee's avatar
Elliot Lee committed
1333 1334 1335 1336
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
1337
      
Elliot Lee's avatar
Elliot Lee committed
1338 1339 1340
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
1341
      
Elliot Lee's avatar
Elliot Lee committed
1342 1343
      tmp_list = tmp_list->next;
    }
1344
  
Elliot Lee's avatar
Elliot Lee committed
1345 1346 1347
  if (tmp_list == NULL)
    return FALSE;
  
1348
  info = g_new (GtkIncrInfo, 1);
1349 1350

  g_object_ref (widget);
1351
  
Elliot Lee's avatar
Elliot Lee committed
1352 1353
  info->selection = event->selection;
  info->num_incrs = 0;
1354
  
Elliot Lee's avatar
Elliot Lee committed
1355
  /* Create GdkWindow structure for the requestor */
1356
  
1357
  info->requestor = gdk_window_lookup_for_display (display,
1358
						   event->requestor);
Elliot Lee's avatar
Elliot Lee committed
1359
  if (!info->requestor)
1360
    info->requestor = gdk_window_foreign_new_for_display (display,
1361
							  event->requestor);
Elliot Lee's avatar
Elliot Lee committed
1362 1363
  
  /* Determine conversions we need to perform */
1364
  
Elliot Lee's avatar
Elliot Lee committed
1365 1366 1367
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
1368
      guchar  *mult_atoms;
Elliot Lee's avatar
Elliot Lee committed
1369 1370
      gint     format;
      gint     length;
1371
      
Elliot Lee's avatar
Elliot Lee committed
1372
      mult_atoms = NULL;
1373
      
1374
      gdk_error_trap_push ();
1375
      if (!gdk_property_get (info->requestor, event->property, GDK_NONE, /* AnyPropertyType */
1376
			     0, selection_max_size, FALSE,
1377
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
1378
	{
1379
	  gdk_selection_send_notify_for_display (display,
1380 1381 1382 1383 1384
						 event->requestor, 
						 event->selection,
						 event->target, 
						 GDK_NONE, 
						 event->time);
Elliot Lee's avatar
Elliot Lee committed
1385 1386 1387 1388
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
1389
      gdk_error_trap_pop ();
1390 1391 1392 1393 1394 1395 1396 1397

      /* This is annoying; the ICCCM doesn't specify the property type
       * used for the property contents, so the autoconversion for
       * ATOM / ATOM_PAIR in GDK doesn't work properly.
       */
#ifdef GDK_WINDOWING_X11
      if (type != GDK_SELECTION_TYPE_ATOM &&
	  type != gdk_atom_intern ("ATOM_PAIR", FALSE))
Elliot Lee's avatar
Elliot Lee committed
1398
	{
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
	  info->num_conversions = length / (2*sizeof (glong));
	  info->conversions = g_new (GtkIncrConversion, info->num_conversions);
	  
	  for (i=0; i<info->num_conversions; i++)
	    {
	      info->conversions[i].target = gdk_x11_xatom_to_atom_for_display (display,
									       ((glong *)mult_atoms)[2*i]);
	      info->conversions[i].property = gdk_x11_xatom_to_atom_for_display (display,
										 ((glong *)mult_atoms)[2*i + 1]);
	    }
	}
      else
#endif
	{
	  info->num_conversions = length / (2*sizeof (GdkAtom));
	  info->conversions = g_new (GtkIncrConversion, info->num_conversions);
	  
	  for (i=0; i<info->num_conversions; i++)
	    {
	      info->conversions[i].target = ((GdkAtom *)mult_atoms)[2*i];
	      info->conversions[i].property = ((GdkAtom *)mult_atoms)[2*i+1];
	    }
Elliot Lee's avatar
Elliot Lee committed
1421 1422 1423 1424 1425 1426 1427 1428 1429
	}
    }
  else				/* only a single conversion */
    {
      info->conversions = g_new (GtkIncrConversion, 1);
      info->num_conversions = 1;
      info->conversions[0].target = event->target;
      info->conversions[0].property = event->property;
    }
1430
  
Elliot Lee's avatar
Elliot Lee committed
1431 1432 1433 1434 1435
  /* Loop through conversions and determine which of these are big
     enough to require doing them via INCR */
  for (i=0; i<info->num_conversions; i++)
    {
      GtkSelectionData data;
1436
      glong items;
1437
      
Elliot Lee's avatar
Elliot Lee committed
1438 1439 1440 1441
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
1442
      data.display = gtk_widget_get_display (widget);
1443
      
Elliot Lee's avatar
Elliot Lee committed
1444
#ifdef DEBUG_SELECTION
1445
      g_message ("Selection %ld, target %ld (%s) requested by 0x%x (property = %ld)",
1446 1447
		 event->selection, 
		 info->conversions[i].target,
1448
		 gdk_atom_name (info->conversions[i].target),
1449
		 event->requestor, info->conversions[i].property);
Elliot Lee's avatar
Elliot Lee committed
1450
#endif
1451
      
1452
      gtk_selection_invoke_handler (widget, &data, event->time);
1453
      
Elliot Lee's avatar
Elliot Lee committed
1454 1455 1456 1457 1458
      if (data.length < 0)
	{
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
1459
      
Tim Janik's avatar
GLib:  
Tim Janik committed
1460
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
1461
      
1462
      items = data.length / gtk_selection_bytes_per_item (data.format);
1463
      
1464
      if (data.length > selection_max_size)
Elliot Lee's avatar
Elliot Lee committed
1465 1466
	{
	  /* Sending via INCR */
1467 1468 1469 1470
#ifdef DEBUG_SELECTION
	  g_message ("Target larger (%d) than max. request size (%ld), sending incrementally\n",
		     data.length, selection_max_size);
#endif
Elliot Lee's avatar
Elliot Lee committed
1471 1472 1473 1474 1475 1476 1477 1478
	  
	  info->conversions[i].offset = 0;
	  info->conversions[i].data = data;
	  info->num_incrs++;
	  
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       gtk_selection_atoms[INCR],
1479
			       32,
Elliot Lee's avatar
Elliot Lee committed
1480 1481 1482 1483 1484 1485
			       GDK_PROP_MODE_REPLACE,
			       (guchar *)&items, 1);
	}
      else
	{
	  info->conversions[i].offset = -1;
1486
	  
Elliot Lee's avatar
Elliot Lee committed
1487 1488 1489 1490 1491 1492
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
1493
	  
Elliot Lee's avatar
Elliot Lee committed
1494 1495 1496
	  g_free (data.data);
	}
    }
1497
  
Elliot Lee's avatar
Elliot Lee committed
1498 1499
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
1500
  
Elliot Lee's avatar
Elliot Lee committed
1501 1502 1503 1504
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
1505
      
Elliot Lee's avatar
Elliot Lee committed
1506
#ifdef DEBUG_SELECTION
1507
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
1508
#endif
1509
      
Elliot Lee's avatar
Elliot Lee committed
1510 1511 1512 1513
      gdk_window_set_events (info->requestor,
			     gdk_window_get_events (info->requestor) |
			     GDK_PROPERTY_CHANGE_MASK);
      current_incrs = g_list_append (current_incrs, info);
1514
      g_timeout_add (1000, (GSourceFunc) gtk_selection_incr_timeout, info);
Elliot Lee's avatar
Elliot Lee committed
1515
    }
1516
  
Elliot Lee's avatar
Elliot Lee committed
1517 1518 1519 1520
  /* If it was a MULTIPLE request, set the property to indicate which
     conversions succeeded */
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
1521 1522 1523 1524 1525 1526 1527
      GdkAtom *mult_atoms = g_new (GdkAtom, 2 * info->num_conversions);
      for (i = 0; i < info->num_conversions; i++)
	{
	  mult_atoms[2*i] = info->conversions[i].target;
	  mult_atoms[2*i+1] = info->conversions[i].property;
	}
      
Elliot Lee's avatar
Elliot Lee committed
1528
      gdk_property_change (info->requestor, event->property,
1529
			   gdk_atom_intern ("ATOM_PAIR", FALSE), 32, 
Elliot Lee's avatar
Elliot Lee committed
1530
			   GDK_PROP_MODE_REPLACE,
1531
			   (guchar *)mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
1532 1533
      g_free (mult_atoms);
    }
1534 1535 1536 1537 1538

  if (info->num_conversions == 1 &&
      info->conversions[0].property == GDK_NONE)
    {
      /* Reject the entire conversion */
1539 1540 1541 1542 1543 1544
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection, 
					     event->target, 
					     GDK_NONE, 
					     event->time);
1545 1546 1547
    }
  else
    {
1548 1549 1550 1551 1552 1553
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection,
					     event->target,
					     event->property, 
					     event->time);
1554
    }
1555

Elliot Lee's avatar
Elliot Lee committed
1556 1557 1558 1559 1560
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
1561 1562

  g_object_unref (widget);
1563
  
Elliot Lee's avatar
Elliot Lee committed
1564 1565 1566 1567
  return TRUE;
}

/*************************************************************
1568
 * _gtk_selection_incr_event:
Elliot Lee's avatar
Elliot Lee committed
1569 1570 1571 1572 1573 1574 1575
 *     Called whenever an PropertyNotify event occurs for an 
 *     GdkWindow with user_data == NULL. These will be notifications
 *     that a window we are sending the selection to via the
 *     INCR protocol has deleted a property and is ready for
 *     more data.
 *
 *   arguments:
1576 1577
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
1578 1579 1580 1581
 *
 *   results:
 *************************************************************/