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

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

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

	  gdk_event_free (event);
Elliot Lee's avatar
Elliot Lee committed
391 392 393 394 395 396 397
	}
      return TRUE;
    }
  else
    return FALSE;
}

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

  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
425
      display = gdk_display_get_default ();
426
    }
427
  
428 429
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
430 431
}

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

445
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
446

447 448 449 450 451 452 453 454
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
455
{
456
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
457
  GList *tmp_list;
458 459
  GList *lists;

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

  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
476
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
477 478 479 480 481 482 483 484 485 486 487

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

  g_list_free (lists);
Manish Singh's avatar
Manish Singh committed
502
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, NULL);
503 504
}

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
/**
 * 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;

Manish Singh's avatar
Manish Singh committed
521
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
  
  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
539
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
540 541
}

542 543 544 545 546 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;

  g_return_if_fail (widget != NULL);

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

void 
557 558 559 560
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
561 562 563 564 565
{
  GtkTargetList *list;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
566
  
567 568
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
569 570
}

571

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

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
631 632 633 634 635 636 637 638
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
639
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
640
 *     selection:  Which selection to get
641 642 643
 *     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
644 645 646 647 648 649 650
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

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

  display = gtk_widget_get_display (widget);
  owner_window = gdk_selection_owner_get_for_display (display, selection);
Elliot Lee's avatar
Elliot Lee committed
699 700 701 702 703
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
704
      
Elliot Lee's avatar
Elliot Lee committed
705 706 707 708
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
709
      selection_data.display = display;
710
      
Elliot Lee's avatar
Elliot Lee committed
711
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
712
      
Elliot Lee's avatar
Elliot Lee committed
713 714
      if (owner_widget != NULL)
	{
715
	  gtk_selection_invoke_handler (owner_widget, 
716 717
					&selection_data,
					time);
718
	  
Elliot Lee's avatar
Elliot Lee committed
719 720 721 722
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
723 724
					  selection_data.length,
					  time);
725
	  
Elliot Lee's avatar
Elliot Lee committed
726 727 728 729 730 731 732 733
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
734
  
Elliot Lee's avatar
Elliot Lee committed
735 736 737
  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);
738
  
Elliot Lee's avatar
Elliot Lee committed
739 740 741 742 743 744 745 746 747 748
  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
749 750 751
 *     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
752 753 754 755 756
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
757 758
			GdkAtom		  type,
			gint		  format,
759
			const guchar	 *data,
760
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
761 762 763
{
  if (selection_data->data)
    g_free (selection_data->data);
764
  
Elliot Lee's avatar
Elliot Lee committed
765 766
  selection_data->type = type;
  selection_data->format = format;
767
  
Elliot Lee's avatar
Elliot Lee committed
768 769 770 771 772 773 774
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
775 776 777 778 779 780 781 782
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
783
  
Elliot Lee's avatar
Elliot Lee committed
784 785 786
  selection_data->length = length;
}

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
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
806
 * @len: the length of @str, or -1 if @str is nul-terminated.
807 808 809 810 811
 * 
 * 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
812
 * Return value: %TRUE if the selection was successfully set,
813 814 815 816
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
817 818
			     const gchar          *str,
			     gint                  len)
819
{
820 821 822 823 824
  gboolean result = FALSE;
  
  if (len < 0)
    len = strlen (str);
  
825 826 827 828 829 830
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
831 832
			      8, (guchar *)str, len);
      result = TRUE;
833 834 835
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
836 837 838
      gchar *tmp = g_strndup (str, len);
      gchar *latin1 = gdk_utf8_to_string_target (tmp);
      g_free (tmp);
839 840 841 842 843 844

      if (latin1)
	{
	  gtk_selection_data_set (selection_data,
				  GDK_SELECTION_TYPE_STRING,
				  8, latin1, strlen (latin1));
845
	  g_free (latin1);
846
	  
847
	  result = TRUE;
848 849 850 851 852 853
	}

    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
854
      gchar *tmp;
855 856 857 858
      guchar *text;
      GdkAtom encoding;
      gint format;
      gint new_length;
859 860

      tmp = g_strndup (str, len);
861 862
      if (gdk_utf8_to_compound_text_for_display (selection_data->display, tmp,
						 &encoding, &format, &text, &new_length))
863 864 865
	{
	  gtk_selection_data_set (selection_data, encoding, format, text, new_length);
	  gdk_free_compound_text (text);
866 867

	  result = TRUE;
868
	}
869 870

      g_free (tmp);
871 872
    }
  
873
  return result;
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
}

/**
 * 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;
901 902 903 904 905 906
      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);
907 908 909 910 911 912 913 914 915 916 917
      if (count > 0)
	result = list[0];

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

  return result;
}

918 919 920 921 922 923 924
/**
 * 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
925
 * Gets the contents of @selection_data as an array of targets.
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
 * 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
965
 * determines if any of the targets in @targets can be used to
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
 * 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
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
/*************************************************************
 * 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);
1011 1012

  initialize = FALSE;
Elliot Lee's avatar
Elliot Lee committed
1013 1014
}

1015
/**
Elliot Lee's avatar
Elliot Lee committed
1016
 * gtk_selection_clear:
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
 * @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
 **/
1028
gboolean
1029
gtk_selection_clear (GtkWidget         *widget,
Elliot Lee's avatar
Elliot Lee committed
1030 1031
		     GdkEventSelection *event)
{
1032 1033 1034 1035
  /* 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
1036
  GList *tmp_list;
1037
  GtkSelectionInfo *selection_info = NULL;
1038
  
Elliot Lee's avatar
Elliot Lee committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
  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;
    }
1050
  
1051 1052
  if (tmp_list)
    {
1053 1054 1055
      current_selections = g_list_remove_link (current_selections, tmp_list);
      g_list_free (tmp_list);
      g_free (selection_info);
1056 1057
    }
  
Elliot Lee's avatar
Elliot Lee committed
1058 1059 1060 1061 1062
  return TRUE;
}


/*************************************************************
1063
 * _gtk_selection_request:
Elliot Lee's avatar
Elliot Lee committed
1064 1065 1066 1067 1068 1069 1070
 *     Handler for "selection_request_event" 
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

1071
gboolean
1072 1073
_gtk_selection_request (GtkWidget *widget,
			GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1074 1075 1076 1077 1078
{
  GtkIncrInfo *info;
  GList *tmp_list;
  guchar *mult_atoms;
  int i;
1079
  
1080 1081 1082
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
1083
  /* Check if we own selection */
1084
  
Elliot Lee's avatar
Elliot Lee committed
1085 1086 1087 1088
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
1089
      
Elliot Lee's avatar
Elliot Lee committed
1090 1091 1092
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
1093
      
Elliot Lee's avatar
Elliot Lee committed
1094 1095
      tmp_list = tmp_list->next;
    }
1096
  
Elliot Lee's avatar
Elliot Lee committed
1097 1098 1099
  if (tmp_list == NULL)
    return FALSE;
  
1100
  info = g_new (GtkIncrInfo, 1);
1101 1102

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

  if (info->num_conversions == 1 &&
      info->conversions[0].property == GDK_NONE)
    {
      /* Reject the entire conversion */
1257 1258 1259 1260 1261 1262
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection, 
					     event->target, 
					     GDK_NONE, 
					     event->time);
1263 1264 1265
    }
  else
    {
1266 1267 1268 1269 1270 1271
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection,
					     event->target,
					     event->property, 
					     event->time);
1272
    }
1273

Elliot Lee's avatar
Elliot Lee committed
1274 1275 1276 1277 1278
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
1279 1280

  g_object_unref (widget);
1281
  
Elliot Lee's avatar
Elliot Lee committed
1282 1283 1284 1285
  return TRUE;
}

/*************************************************************
1286
 * _gtk_selection_incr_event:
Elliot Lee's avatar
Elliot Lee committed
1287 1288 1289 1290 1291 1292 1293
 *     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:
1294 1295
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
1296 1297 1298 1299
 *
 *   results:
 *************************************************************/

1300
gboolean
1301 1302
_gtk_selection_incr_event (GdkWindow	   *window,
			   GdkEventProperty *event)
Elliot Lee's avatar
Elliot Lee committed
1303 1304
{
  GList *tmp_list;
1305
  GtkIncrInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1306 1307
  gint num_bytes;
  guchar *buffer;
1308
  
Elliot Lee's avatar
Elliot Lee committed
1309 1310 1311 1312
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
1313
  
Elliot Lee's avatar
Elliot Lee committed
1314
#ifdef DEBUG_SELECTION
1315
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
1316
#endif
1317
  
Elliot Lee's avatar
Elliot Lee committed
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
  /* 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;
    }
1328
  
Elliot Lee's avatar
Elliot Lee committed
1329 1330
  if (tmp_list == NULL)
    return FALSE;
1331
  
Elliot Lee's avatar
Elliot Lee committed
1332 1333 1334 1335 1336 1337
  /* 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)
	{
1338 1339
	  int bytes_per_item;
	  
Elliot Lee's avatar
Elliot Lee committed
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
	  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;
1354
	      
Elliot Lee's avatar
Elliot Lee committed
1355 1356 1357 1358 1359 1360 1361 1362 1363
	      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
1364 1365 1366
	  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
1367
#endif
1368 1369

	  bytes_per_item = gtk_selection_bytes_per_item (info->conversions[i].data.format);
Elliot Lee's avatar
Elliot Lee committed
1370 1371 1372 1373
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
1374 1375
			       buffer,
			       num_bytes / bytes_per_item);
1376
	  
Elliot Lee's avatar
Elliot Lee committed
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
	  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;
    }
1391
  
Elliot Lee's avatar
Elliot Lee committed
1392
  /* Check if we're finished with all the targets */
1393
  
Elliot Lee's avatar
Elliot Lee committed
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
  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:
1409
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
1410 1411 1412 1413 1414 1415 1416
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1417 1418
  gboolean retval;

1419
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1420 1421 1422
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1423
  
Elliot Lee's avatar
Elliot Lee committed
1424 1425 1426 1427 1428 1429 1430 1431 1432
  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
1433
  if (!tmp_list || info->idle_time >= IDLE_ABORT_TIME)
Elliot Lee's avatar
Elliot Lee committed
1434
    {
Owen Taylor's avatar
Owen Taylor committed
1435
      if (tmp_list && info->idle_time >= IDLE_ABORT_TIME)
Elliot Lee's avatar
Elliot Lee committed
1436 1437 1438 1439 1440 1441 1442 1443
	{
	  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? */
1444
      
Elliot Lee's avatar
Elliot Lee committed
1445 1446
      g_free (info);
      
1447
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1448 1449 1450 1451 1452
    }
  else
    {
      info->idle_time++;
      
1453
      retval = TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1454
    }
1455
  
1456
  GDK_THREADS_LEAVE ();
1457 1458

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1459 1460 1461
}

/*************************************************************
1462
 * _gtk_selection_notify:
Elliot Lee's avatar
Elliot Lee committed
1463 1464 1465 1466
 *     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:
1467 1468 1469
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1470 1471 1472 1473
 *   results:
 *     was event handled?
 *************************************************************/

1474
gboolean
1475 1476
_gtk_selection_notify (GtkWidget	       *widget,
		       GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1477 1478
{
  GList *tmp_list;
1479
  GtkRetrievalInfo *info = NULL;
1480
  guchar  *buffer = NULL;
Elliot Lee's avatar
Elliot Lee committed
1481 1482
  gint length;
  GdkAtom type;
1483
  gint	  format;
Elliot Lee's avatar
Elliot Lee committed
1484 1485
  
#ifdef DEBUG_SELECTION
1486 1487
  g_message ("Initial receipt of selection %ld, target %ld (property = %ld)",
	     event->selection, event->target, event->property);
Elliot Lee's avatar
Elliot Lee committed
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget && info->selection == event->selection)
	break;
      tmp_list = tmp_list->next;
    }
1498
  
Elliot Lee's avatar
Elliot Lee committed
1499 1500
  if (!tmp_list)		/* no retrieval in progress */
    return FALSE;
1501 1502 1503 1504

  if (event->property != GDK_NONE)
    length = gdk_selection_property_get (widget->window, &buffer, 
					 &type, &format);
Havoc Pennington's avatar
Havoc Pennington committed
1505 1506 1507
  else
    length = 0; /* silence gcc */
  
1508
  if (event->property == GDK_NONE || buffer == NULL)
Elliot Lee's avatar
Elliot Lee committed
1509 1510 1511 1512 1513
    {
      current_retrievals = g_list_remove_l