gtkselection.c 50.2 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 21 22 23 24 25 26 27 28 29 30
 */

/* This file implements most of the work of the ICCM selection protocol.
 * 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.
 *
 * The one thing in the ICCM that isn't fully supported here (or in Tk)
 * 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/. 
 */

Elliot Lee's avatar
Elliot Lee committed
54
#include <stdarg.h>
55
#include <string.h>
56 57
#include "gdk.h"

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

/* #define DEBUG_SELECTION */

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
65
#ifdef GDK_WINDOWING_WIN32
66 67 68
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE G_MAXINT
#else
Elliot Lee's avatar
Elliot Lee committed
69
#define GTK_SELECTION_MAX_SIZE 4000
70
#endif
Owen Taylor's avatar
Owen Taylor committed
71 72 73

#define IDLE_ABORT_TIME 300

Elliot Lee's avatar
Elliot Lee committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
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
{
89 90 91 92
  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
93 94 95 96
};

struct _GtkIncrConversion 
{
97 98
  GdkAtom	    target;	/* Requested target */
  GdkAtom	    property;	/* Property to store in */
Elliot Lee's avatar
Elliot Lee committed
99
  GtkSelectionData  data;	/* The data being supplied */
100
  gint		    offset;	/* Current offset in sent selection.
Elliot Lee's avatar
Elliot Lee committed
101 102
				 *  -1 => All done
				 *  -2 => Only the final (empty) portion
103
				 *	  left to send */
Elliot Lee's avatar
Elliot Lee committed
104 105 106 107 108 109 110
};

struct _GtkIncrInfo
{
  GdkWindow *requestor;		/* Requestor window - we create a GdkWindow
				   so we can receive events */
  GdkAtom    selection;		/* Selection we're sending */
111
  
Elliot Lee's avatar
Elliot Lee committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  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 */
130
  gint	   offset;		/* Current offset in buffer, -1 indicates
Elliot Lee's avatar
Elliot Lee committed
131
				   not yet started */
132
  guint32 notify_time;		/* Timestamp from SelectionNotify */
Elliot Lee's avatar
Elliot Lee committed
133 134 135
};

/* Local Functions */
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
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
151 152 153 154 155 156 157 158

/* 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];
Tim Janik's avatar
Tim Janik committed
159
static const char *gtk_selection_handler_key = "gtk-selection-handlers";
Elliot Lee's avatar
Elliot Lee committed
160

161 162 163 164 165 166 167 168 169
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
170 171
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
172 173 174 175 176 177 178 179 180 181 182 183 184 185
{
  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)
{
186 187
  g_return_if_fail (list != NULL);

188 189 190 191 192 193
  list->ref_count++;
}

void               
gtk_target_list_unref (GtkTargetList *list)
{
194 195 196
  g_return_if_fail (list != NULL);
  g_return_if_fail (list->ref_count > 0);

197 198 199 200 201 202
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
Owen Taylor's avatar
Owen Taylor committed
203 204
	  GtkTargetPair *pair = tmp_list->data;
	  g_free (pair);
205 206 207

	  tmp_list = tmp_list->next;
	}
Owen Taylor's avatar
Owen Taylor committed
208 209
      
      g_list_free (list->list);
210
      g_free (list);
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    }
}

void 
gtk_target_list_add (GtkTargetList *list,
		     GdkAtom            target,
		     guint              flags,
		     guint              info)
{
  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);
}

void               
233 234 235
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
236 237 238 239 240 241 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
{
  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);

267
	  list->list = g_list_remove_link (list->list, tmp_list);
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 297
	  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;
}

298 299 300 301 302
/**
 * 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.
303
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
304
 *
305 306 307 308
 * 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
309 310
 * 
 * Since: 2.2
311
 */
312
gboolean
313 314 315 316
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
317 318 319
{
  GList *tmp_list;
  GtkWidget *old_owner;
320
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
321
  GdkWindow *window;
322

323
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
324
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
325
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
326
  g_return_val_if_fail (widget == NULL || gtk_widget_get_display (widget) == display, FALSE);
327
  
Elliot Lee's avatar
Elliot Lee committed
328 329 330
  if (widget == NULL)
    window = NULL;
  else
331 332
    window = widget->window;

Elliot Lee's avatar
Elliot Lee committed
333 334 335
  tmp_list = current_selections;
  while (tmp_list)
    {
336 337 338 339 340
      if (((GtkSelectionInfo *)tmp_list->data)->selection == selection)
	{
	  selection_info = tmp_list->data;
	  break;
	}
Elliot Lee's avatar
Elliot Lee committed
341 342 343
      
      tmp_list = tmp_list->next;
    }
344
  
345
  if (gdk_selection_owner_set_for_display (display, window, selection, time, TRUE))
Elliot Lee's avatar
Elliot Lee committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
    {
      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;
368 369
	      selection_info->display = display;
	      current_selections = g_list_prepend (current_selections,
370
						   selection_info);
Elliot Lee's avatar
Elliot Lee committed
371 372 373 374 375 376
	    }
	  else
	    {
	      old_owner = selection_info->widget;
	      selection_info->widget = widget;
	      selection_info->time = time;
377
	      selection_info->display = display;
Elliot Lee's avatar
Elliot Lee committed
378 379 380
	    }
	}
      /* If another widget in the application lost the selection,
381 382 383
       *  send it a GDK_SELECTION_CLEAR event.
       */
      if (old_owner && old_owner != widget)
Elliot Lee's avatar
Elliot Lee committed
384
	{
385
	  GdkEvent *event = gdk_event_new (GDK_SELECTION_CLEAR);
Elliot Lee's avatar
Elliot Lee committed
386
	  
387 388 389
	  event->selection.window = g_object_ref (old_owner->window);
	  event->selection.selection = selection;
	  event->selection.time = time;
390
	  
391 392 393
	  gtk_widget_event (old_owner, event);

	  gdk_event_free (event);
Elliot Lee's avatar
Elliot Lee committed
394 395 396 397 398 399 400
	}
      return TRUE;
    }
  else
    return FALSE;
}

401 402 403 404
/**
 * gtk_selection_owner_set:
 * @widget:  a #GtkWidget, or %NULL.
 * @selection:  an interned atom representing the selection to claim
405
 * @time_: timestamp with which to claim the selection
406 407 408 409 410 411 412 413 414 415 416
 * 
 * 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)
{
417 418
  GdkDisplay *display;
  
419
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
420
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
421 422 423 424 425 426 427 428

  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
429
      display = gdk_display_get_default ();
430
    }
431
  
432 433
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
434 435
}

Elliot Lee's avatar
Elliot Lee committed
436
/*************************************************************
437 438
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
439 440
 *
 *   arguments:
441
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
442 443
 *     selection:
 *     target:
444
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
445 446 447 448
 *
 *   results:
 *************************************************************/

449
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
450

451 452 453 454 455 456 457 458
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
459
{
460
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
461
  GList *tmp_list;
462 463
  GList *lists;

Manish Singh's avatar
Manish Singh committed
464
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
465
  
466
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
467 468
  while (tmp_list)
    {
469 470 471
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
472 473
      tmp_list = tmp_list->next;
    }
474 475 476 477 478 479

  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
480
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
481 482 483 484 485 486 487 488 489 490 491

  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
492
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
493
  
494 495
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
496
    {
497 498 499 500 501 502
      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
503
    }
504 505

  g_list_free (lists);
Manish Singh's avatar
Manish Singh committed
506
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, NULL);
507 508
}

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
/**
 * 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;

525 526 527
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);

Manish Singh's avatar
Manish Singh committed
528
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
  
  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
546
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
547 548
}

549 550 551 552 553 554 555 556
void 
gtk_selection_add_target (GtkWidget	    *widget, 
			  GdkAtom	     selection,
			  GdkAtom	     target,
			  guint              info)
{
  GtkTargetList *list;

557 558
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
559 560 561 562 563 564

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

void 
565 566 567 568
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
569 570
{
  GtkTargetList *list;
571 572 573

  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
574
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
575
  
576 577
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
578 579
}

580

Elliot Lee's avatar
Elliot Lee committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
/*************************************************************
 * 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;
598
  
Elliot Lee's avatar
Elliot Lee committed
599
  /* Remove pending requests/incrs for this widget */
600
  
Elliot Lee's avatar
Elliot Lee committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
  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 */
616
  
Elliot Lee's avatar
Elliot Lee committed
617 618 619 620 621 622 623 624
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
625 626 627 628 629
	  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
630 631 632 633 634 635 636
						   tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
      
      tmp_list = next;
    }
637 638 639

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
640 641 642 643 644 645 646 647
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
648
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
649
 *     selection:  Which selection to get
650 651 652
 *     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
653 654 655 656 657 658 659
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

660
gboolean
Elliot Lee's avatar
Elliot Lee committed
661
gtk_selection_convert (GtkWidget *widget, 
662 663 664
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
665 666 667 668
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
669
  GdkDisplay *display;
670
  
671 672
  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
673
  
Elliot Lee's avatar
Elliot Lee committed
674 675 676 677 678
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
679
  
Elliot Lee's avatar
Elliot Lee committed
680 681 682 683 684
  /* 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. */
685
  
Elliot Lee's avatar
Elliot Lee committed
686 687 688 689 690 691 692 693
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
694
  
Elliot Lee's avatar
Elliot Lee committed
695
  info = g_new (GtkRetrievalInfo, 1);
696
  
Elliot Lee's avatar
Elliot Lee committed
697 698 699
  info->widget = widget;
  info->selection = selection;
  info->target = target;
Owen Taylor's avatar
Owen Taylor committed
700
  info->idle_time = 0;
Elliot Lee's avatar
Elliot Lee committed
701 702
  info->buffer = NULL;
  info->offset = -1;
703
  
Elliot Lee's avatar
Elliot Lee committed
704 705
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
706 707 708

  display = gtk_widget_get_display (widget);
  owner_window = gdk_selection_owner_get_for_display (display, selection);
Elliot Lee's avatar
Elliot Lee committed
709 710 711 712 713
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
714
      
Elliot Lee's avatar
Elliot Lee committed
715 716 717 718
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
719
      selection_data.display = display;
720
      
Elliot Lee's avatar
Elliot Lee committed
721
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
722
      
Elliot Lee's avatar
Elliot Lee committed
723 724
      if (owner_widget != NULL)
	{
725
	  gtk_selection_invoke_handler (owner_widget, 
726 727
					&selection_data,
					time);
728
	  
Elliot Lee's avatar
Elliot Lee committed
729 730 731 732
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
733 734
					  selection_data.length,
					  time);
735
	  
Elliot Lee's avatar
Elliot Lee committed
736 737 738 739 740 741 742 743
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
744
  
Elliot Lee's avatar
Elliot Lee committed
745 746 747
  current_retrievals = g_list_append (current_retrievals, info);
  gdk_selection_convert (widget->window, selection, target, time);
  gtk_timeout_add (1000, (GtkFunction) gtk_selection_retrieval_timeout, info);
748
  
Elliot Lee's avatar
Elliot Lee committed
749 750 751 752 753 754 755 756 757 758
  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
759 760 761
 *     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
762 763 764 765 766
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
767 768
			GdkAtom		  type,
			gint		  format,
769
			const guchar	 *data,
770
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
771 772 773
{
  if (selection_data->data)
    g_free (selection_data->data);
774
  
Elliot Lee's avatar
Elliot Lee committed
775 776
  selection_data->type = type;
  selection_data->format = format;
777
  
Elliot Lee's avatar
Elliot Lee committed
778 779 780 781 782 783 784
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
785 786 787 788 789 790 791 792
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
793
  
Elliot Lee's avatar
Elliot Lee committed
794 795 796
  selection_data->length = length;
}

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
static GdkAtom utf8_atom;
static GdkAtom text_atom;
static GdkAtom ctext_atom;

static void 
init_atoms (void)
{
  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);
    }
}

/**
 * gtk_selection_data_set_text:
 * @selection_data: a #GtkSelectionData
 * @str: a UTF-8 string
816
 * @len: the length of @str, or -1 if @str is nul-terminated.
817 818 819 820 821
 * 
 * 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
822
 * Return value: %TRUE if the selection was successfully set,
823 824 825 826
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
827 828
			     const gchar          *str,
			     gint                  len)
829
{
830 831 832 833 834
  gboolean result = FALSE;
  
  if (len < 0)
    len = strlen (str);
  
835 836 837 838 839 840
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
841 842
			      8, (guchar *)str, len);
      result = TRUE;
843 844 845
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
846 847 848
      gchar *tmp = g_strndup (str, len);
      gchar *latin1 = gdk_utf8_to_string_target (tmp);
      g_free (tmp);
849 850 851 852 853 854

      if (latin1)
	{
	  gtk_selection_data_set (selection_data,
				  GDK_SELECTION_TYPE_STRING,
				  8, latin1, strlen (latin1));
855
	  g_free (latin1);
856
	  
857
	  result = TRUE;
858 859 860 861 862 863
	}

    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
864
      gchar *tmp;
865 866 867 868
      guchar *text;
      GdkAtom encoding;
      gint format;
      gint new_length;
869 870

      tmp = g_strndup (str, len);
871 872
      if (gdk_utf8_to_compound_text_for_display (selection_data->display, tmp,
						 &encoding, &format, &text, &new_length))
873 874 875
	{
	  gtk_selection_data_set (selection_data, encoding, format, text, new_length);
	  gdk_free_compound_text (text);
876 877

	  result = TRUE;
878
	}
879 880

      g_free (tmp);
881 882
    }
  
883
  return result;
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
}

/**
 * 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;
911 912 913 914 915 916
      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);
917 918 919 920 921 922 923 924 925 926 927
      if (count > 0)
	result = list[0];

      for (i = 1; i < count; i++)
	g_free (list[i]);
      g_free (list);
    }

  return result;
}

928 929 930 931 932 933 934
/**
 * 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
935
 * Gets the contents of @selection_data as an array of targets.
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
 * 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
975
 * determines if any of the targets in @targets can be used to
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
 * 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;

  if (gtk_selection_data_get_targets (selection_data, &targets, &n_targets))
    {
      for (i=0; i < n_targets; i++)
	{
	  if (targets[i] == gdk_atom_intern ("STRING", FALSE) ||
	      targets[i] == gdk_atom_intern ("TEXT", FALSE) ||
	      targets[i] == gdk_atom_intern ("COMPOUND_TEXT", FALSE) ||
	      targets[i] == gdk_atom_intern ("UTF8_STRING", FALSE))
	    result = TRUE;
	}

      g_free (targets);
    }

  return result;
}
	  
Elliot Lee's avatar
Elliot Lee committed
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
/*************************************************************
 * 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);
1021 1022

  initialize = FALSE;
Elliot Lee's avatar
Elliot Lee committed
1023 1024
}

1025
/**
Elliot Lee's avatar
Elliot Lee committed
1026
 * gtk_selection_clear:
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
 * @widget: a #GtkWidget
 * @event: the event
 * 
 * The default handler for the GtkWidget::selection_clear_event
 * signal. Instead of calling this function, chain up from
 * your selection_clear_event handler. Calling this function
 * from any other context is illegal. This function will
 * be deprecated in future versions of GTK+.
 * 
 * Return value: %TRUE if the event was handled, otherwise false
Matthias Clasen's avatar
Matthias Clasen committed
1037 1038
 * 
 * Since: 2.2
1039
 **/
1040
gboolean
1041
gtk_selection_clear (GtkWidget         *widget,
Elliot Lee's avatar
Elliot Lee committed
1042 1043
		     GdkEventSelection *event)
{
1044 1045 1046 1047
  /* 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
1048
  GList *tmp_list;
1049
  GtkSelectionInfo *selection_info = NULL;
1050
  
Elliot Lee's avatar
Elliot Lee committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
  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;
    }
1062
  
1063 1064
  if (tmp_list)
    {
1065 1066 1067
      current_selections = g_list_remove_link (current_selections, tmp_list);
      g_list_free (tmp_list);
      g_free (selection_info);
1068 1069
    }
  
Elliot Lee's avatar
Elliot Lee committed
1070 1071 1072 1073 1074
  return TRUE;
}


/*************************************************************
1075
 * _gtk_selection_request:
Elliot Lee's avatar
Elliot Lee committed
1076 1077 1078 1079 1080 1081 1082
 *     Handler for "selection_request_event" 
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

1083
gboolean
1084 1085
_gtk_selection_request (GtkWidget *widget,
			GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1086 1087 1088 1089 1090
{
  GtkIncrInfo *info;
  GList *tmp_list;
  guchar *mult_atoms;
  int i;
1091
  
1092 1093 1094
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
1095
  /* Check if we own selection */
1096
  
Elliot Lee's avatar
Elliot Lee committed
1097 1098 1099 1100
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
1101
      
Elliot Lee's avatar
Elliot Lee committed
1102 1103 1104
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
1105
      
Elliot Lee's avatar
Elliot Lee committed
1106 1107
      tmp_list = tmp_list->next;
    }
1108
  
Elliot Lee's avatar
Elliot Lee committed
1109 1110 1111
  if (tmp_list == NULL)
    return FALSE;
  
1112
  info = g_new (GtkIncrInfo, 1);
1113 1114

  g_object_ref (widget);
1115
  
Elliot Lee's avatar
Elliot Lee committed
1116 1117
  info->selection = event->selection;
  info->num_incrs = 0;
1118
  
Elliot Lee's avatar
Elliot Lee committed
1119
  /* Create GdkWindow structure for the requestor */
1120 1121 1122
  
  info->requestor = gdk_window_lookup_for_display (gtk_widget_get_display (widget),
						   event->requestor);
Elliot Lee's avatar
Elliot Lee committed
1123
  if (!info->requestor)
1124 1125
    info->requestor = gdk_window_foreign_new_for_display (gtk_widget_get_display (widget),
							  event->requestor);
Elliot Lee's avatar
Elliot Lee committed
1126 1127
  
  /* Determine conversions we need to perform */
1128
  
Elliot Lee's avatar
Elliot Lee committed
1129 1130 1131 1132 1133
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
      gint     format;
      gint     length;
1134
      
Elliot Lee's avatar
Elliot Lee committed
1135
      mult_atoms = NULL;
1136
      
1137
      gdk_error_trap_push ();
1138
      if (!gdk_property_get (info->requestor, event->property, 0, /* AnyPropertyType */
Elliot Lee's avatar
Elliot Lee committed
1139
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
1140
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
1141
	{
1142 1143 1144 1145 1146 1147
	  gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
						 event->requestor, 
						 event->selection,
						 event->target, 
						 GDK_NONE, 
						 event->time);
Elliot Lee's avatar
Elliot Lee committed
1148 1149 1150 1151
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
1152
      gdk_error_trap_pop ();
1153
      
Elliot Lee's avatar
Elliot Lee committed
1154 1155
      info->num_conversions = length / (2*sizeof (GdkAtom));
      info->conversions = g_new (GtkIncrConversion, info->num_conversions);
1156
      
Elliot Lee's avatar
Elliot Lee committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
      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];
	}
    }
  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;
      mult_atoms = (guchar *)info->conversions;
    }
1171
  
Elliot Lee's avatar
Elliot Lee committed
1172 1173 1174 1175 1176
  /* 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;
1177
      glong items;
1178
      
Elliot Lee's avatar
Elliot Lee committed
1179 1180 1181 1182
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
1183
      data.display = gtk_widget_get_display (widget);
1184
      
Elliot Lee's avatar
Elliot Lee committed
1185
#ifdef DEBUG_SELECTION
1186 1187
      g_message ("Selection %ld, target %ld (%s) requested by 0x%x (property = %ld)",
		 event->selection, info->conversions[i].target,
1188
		 gdk_atom_name (info->conversions[i].target),
1189
		 event->requestor, event->property);
Elliot Lee's avatar
Elliot Lee committed
1190
#endif
1191
      
1192
      gtk_selection_invoke_handler (widget, &data, event->time);
1193
      
Elliot Lee's avatar
Elliot Lee committed
1194 1195 1196 1197 1198 1199
      if (data.length < 0)
	{
	  ((GdkAtom *)mult_atoms)[2*i+1] = GDK_NONE;
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
1200
      
Tim Janik's avatar
GLib:  
Tim Janik committed
1201
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
1202
      
1203
      items = data.length / gtk_selection_bytes_per_item (data.format);
1204
      
Elliot Lee's avatar
Elliot Lee committed
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
      if (data.length > GTK_SELECTION_MAX_SIZE)
	{
	  /* Sending via INCR */
	  
	  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],
1216
			       32,
Elliot Lee's avatar
Elliot Lee committed
1217 1218 1219 1220 1221 1222
			       GDK_PROP_MODE_REPLACE,
			       (guchar *)&items, 1);
	}
      else
	{
	  info->conversions[i].offset = -1;
1223
	  
Elliot Lee's avatar
Elliot Lee committed
1224 1225 1226 1227 1228 1229
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
1230
	  
Elliot Lee's avatar
Elliot Lee committed
1231 1232 1233
	  g_free (data.data);
	}
    }
1234
  
Elliot Lee's avatar
Elliot Lee committed
1235 1236
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
1237
  
Elliot Lee's avatar
Elliot Lee committed
1238 1239 1240 1241
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
1242
      
Elliot Lee's avatar
Elliot Lee committed
1243
#ifdef DEBUG_SELECTION
1244
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
1245
#endif
1246
      
Elliot Lee's avatar
Elliot Lee committed
1247 1248 1249 1250 1251 1252
      gdk_window_set_events (info->requestor,
			     gdk_window_get_events (info->requestor) |
			     GDK_PROPERTY_CHANGE_MASK);
      current_incrs = g_list_append (current_incrs, info);
      gtk_timeout_add (1000, (GtkFunction)gtk_selection_incr_timeout, info);
    }
1253
  
Elliot Lee's avatar
Elliot Lee committed
1254 1255 1256 1257 1258
  /* If it was a MULTIPLE request, set the property to indicate which
     conversions succeeded */
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      gdk_property_change (info->requestor, event->property,
1259
			   gdk_atom_intern ("ATOM_PAIR", FALSE), 32, 
Elliot Lee's avatar
Elliot Lee committed
1260
			   GDK_PROP_MODE_REPLACE,
1261
			   mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
1262 1263
      g_free (mult_atoms);
    }
1264 1265 1266 1267 1268

  if (info->num_conversions == 1 &&
      info->conversions[0].property == GDK_NONE)
    {
      /* Reject the entire conversion */
1269 1270 1271 1272 1273 1274
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection, 
					     event->target, 
					     GDK_NONE, 
					     event->time);
1275 1276 1277
    }
  else
    {
1278 1279 1280 1281 1282 1283
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection,
					     event->target,
					     event->property, 
					     event->time);
1284
    }
1285

Elliot Lee's avatar
Elliot Lee committed
1286 1287 1288 1289 1290
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
1291 1292

  g_object_unref (widget);
1293
  
Elliot Lee's avatar
Elliot Lee committed
1294 1295 1296 1297
  return TRUE;
}

/*************************************************************
1298
 * _gtk_selection_incr_event:
Elliot Lee's avatar
Elliot Lee committed
1299 1300 1301 1302 1303 1304 1305
 *     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:
1306 1307
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
1308 1309 1310 1311
 *
 *   results:
 *************************************************************/

1312
gboolean
1313 1314
_gtk_selection_incr_event (GdkWindow	   *window,
			   GdkEventProperty *event)
Elliot Lee's avatar
Elliot Lee committed
1315 1316
{
  GList *tmp_list;
1317
  GtkIncrInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1318 1319
  gint num_bytes;
  guchar *buffer;
1320
  
Elliot Lee's avatar
Elliot Lee committed
1321 1322 1323 1324
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
1325
  
Elliot Lee's avatar
Elliot Lee committed
1326
#ifdef DEBUG_SELECTION
1327
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
1328
#endif
1329
  
Elliot Lee's avatar
Elliot Lee committed
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
  /* Now find the appropriate ongoing INCR */
  tmp_list = current_incrs;
  while (tmp_list)
    {
      info = (GtkIncrInfo *)tmp_list->data;
      if (info->requestor == event->window)
	break;
      
      tmp_list = tmp_list->next;
    }
1340
  
Elliot Lee's avatar
Elliot Lee committed
1341 1342
  if (tmp_list == NULL)
    return FALSE;
1343
  
Elliot Lee's avatar
Elliot Lee committed
1344 1345 1346 1347 1348 1349
  /* Find out which target this is for */
  for (i=0; i<info->num_conversions; i++)
    {
      if (info->conversions[i].property == event->atom &&
	  info->conversions[i].offset != -1)
	{
1350 1351
	  int bytes_per_item;
	  
Elliot Lee's avatar
Elliot Lee committed
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
	  info->idle_time = 0;
	  
	  if (info->conversions[i].offset == -2) /* only the last 0-length
						    piece*/
	    {
	      num_bytes = 0;
	      buffer = NULL;
	    }
	  else
	    {
	      num_bytes = info->conversions[i].data.length -
		info->conversions[i].offset;
	      buffer = info->conversions[i].data.data + 
		info->conversions[i].offset;
1366
	      
Elliot Lee's avatar
Elliot Lee committed
1367 1368 1369 1370 1371 1372 1373 1374 1375
	      if (num_bytes > GTK_SELECTION_MAX_SIZE)
		{
		  num_bytes = GTK_SELECTION_MAX_SIZE;
		  info->conversions[i].offset += GTK_SELECTION_MAX_SIZE;
		}
	      else
		info->conversions[i].offset = -2;
	    }
#ifdef DEBUG_SELECTION
1376 1377 1378
	  g_message ("INCR: put %d bytes (offset = %d) into window 0x%lx , property %ld",
		     num_bytes, info->conversions[i].offset, 
		     GDK_WINDOW_XWINDOW(info->requestor), event->atom);
Elliot Lee's avatar
Elliot Lee committed
1379
#endif
1380 1381

	  bytes_per_item = gtk_selection_bytes_per_item (info->conversions[i].data.format);
Elliot Lee's avatar
Elliot Lee committed
1382 1383 1384 1385
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
1386 1387
			       buffer,
			       num_bytes / bytes_per_item);
1388
	  
Elliot Lee's avatar
Elliot Lee committed
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
	  if (info->conversions[i].offset == -2)
	    {
	      g_free (info->conversions[i].data.data);
	      info->conversions[i].data.data = NULL;
	    }
	  
	  if (num_bytes == 0)
	    {
	      info->num_incrs--;
	      info->conversions[i].offset = -1;
	    }
	}
      break;
    }
1403
  
Elliot Lee's avatar
Elliot Lee committed
1404
  /* Check if we're finished with all the targets */
1405
  
Elliot Lee's avatar
Elliot Lee committed
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
  if (info->num_incrs == 0)
    {
      current_incrs = g_list_remove_link (current_incrs, tmp_list);
      g_list_free (tmp_list);
      /* Let the timeout free it */
    }
  
  return TRUE;
}

/*************************************************************
 * gtk_selection_incr_timeout:
 *     Timeout callback for the sending portion of the INCR
 *     protocol
 *   arguments:
1421
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
1422 1423 1424 1425 1426 1427 1428
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1429 1430
  gboolean retval;

1431
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1432 1433 1434
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1435
  
Elliot Lee's avatar
Elliot Lee committed
1436 1437 1438 1439 1440 1441 1442 1443 1444
  tmp_list = current_incrs;
  while (tmp_list)
    {
      if (info == (GtkIncrInfo *)tmp_list->data)
	break;
      tmp_list = tmp_list->next;
    }
  
  /* If retrieval is finished */
Owen Taylor's avatar
Owen Taylor committed
1445
  if (!tmp_list || info->idle_time >= IDLE_ABORT_TIME)
Elliot Lee's avatar
Elliot Lee committed
1446
    {
Owen Taylor's avatar
Owen Taylor committed
1447
      if (tmp_list && info->idle_time >= IDLE_ABORT_TIME)
Elliot Lee's avatar
Elliot Lee committed
1448 1449 1450 1451 1452 1453 1454 1455
	{
	  current_incrs = g_list_remove_link (current_incrs, tmp_list);
	  g_list_free (tmp_list);
	}
      
      g_free (info->conversions);
      /* FIXME: we should check if requestor window is still in use,
	 and if not, remove it? */
1456
      
Elliot Lee's avatar
Elliot Lee committed
1457 1458
      g_free (info);
      
1459
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1460 1461 1462 1463 1464
    }
  else
    {
      info->idle_time++;
      
1465
      retval = TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1466
    }
1467
  
1468
  GDK_THREADS_LEAVE ();
1469 1470

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1471 1472 1473
}

/*************************************************************
1474
 * _gtk_selection_notify:
Elliot Lee's avatar
Elliot Lee committed
1475 1476 1477 1478
 *     Handler for "selection_notify_event" signals on windows
 *     where a retrieval is currently in process. The selection
 *     owner has responded to our conversion request.
 *   arguments:
1479 1480 1481
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1482 1483 1484 1485
 *   results:
 *     was event handled?
 *************************************************************/

1486
gboolean
1487 1488
_gtk_selection_notify (GtkWidget	       *widget,
		       GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1489 1490
{
  GList *tmp_list;
1491
  GtkRetrievalInfo *info = NULL;