gtkselection.c 49.7 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 65
#include "gtkmain.h"
#include "gtkselection.h"
#include "gtksignal.h"

/* #define DEBUG_SELECTION */

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
66
#ifdef GDK_WINDOWING_WIN32
67 68 69
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE G_MAXINT
#else
Elliot Lee's avatar
Elliot Lee committed
70
#define GTK_SELECTION_MAX_SIZE 4000
71
#endif
Elliot Lee's avatar
Elliot Lee committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
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
{
87 88 89 90
  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
91 92 93 94
};

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

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

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

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

159 160 161 162 163 164 165 166 167
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

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

186 187 188 189 190 191
  list->ref_count++;
}

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

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

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

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               
231 232 233
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
234 235 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
{
  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);

265
	  list->list = g_list_remove_link (list->list, tmp_list);
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
	  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;
}

296 297 298 299 300 301
/**
 * 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
302
 *
303 304 305 306 307
 * 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 
 */
308
gboolean
309 310 311 312
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
313 314 315
{
  GList *tmp_list;
  GtkWidget *old_owner;
316
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
317
  GdkWindow *window;
318

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

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

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
/**
 * 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)
{
411 412
  GdkDisplay *display;
  
413
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
414 415 416 417 418 419 420 421

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

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

442
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
443

444 445 446 447 448 449 450 451
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

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

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
458
  
459
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
460 461
  while (tmp_list)
    {
462 463 464
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
465 466
      tmp_list = tmp_list->next;
    }
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485

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

  lists = g_list_prepend (lists, sellist);
  gtk_object_set_data (GTK_OBJECT (widget), gtk_selection_handler_key, lists);

  return sellist->list;
}

static void
gtk_selection_target_list_remove (GtkWidget    *widget)
{
  GtkSelectionTargetList *sellist;
  GList *tmp_list;
  GList *lists;

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

  g_list_free (lists);
  gtk_object_set_data (GTK_OBJECT (widget), gtk_selection_handler_key, NULL);
}

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
/**
 * 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;

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
  
  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;
    }
  
  gtk_object_set_data (GTK_OBJECT (widget), gtk_selection_handler_key, lists);
}

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
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 
554 555 556 557
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
558 559 560 561 562
{
  GtkTargetList *list;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
563
  
564 565
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
566 567
}

568

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

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
628 629 630 631 632 633 634 635
}

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

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

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

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

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

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

      if (latin1)
	{
	  gtk_selection_data_set (selection_data,
				  GDK_SELECTION_TYPE_STRING,
				  8, latin1, strlen (latin1));
841
	  g_free (latin1);
842
	  
843
	  result = TRUE;
844 845 846 847 848 849
	}

    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
850
      gchar *tmp;
851 852 853 854
      guchar *text;
      GdkAtom encoding;
      gint format;
      gint new_length;
855 856

      tmp = g_strndup (str, len);
857 858
      if (gdk_utf8_to_compound_text_for_display (selection_data->display, tmp,
						 &encoding, &format, &text, &new_length))
859 860 861
	{
	  gtk_selection_data_set (selection_data, encoding, format, text, new_length);
	  gdk_free_compound_text (text);
862 863

	  result = TRUE;
864
	}
865 866

      g_free (tmp);
867 868
    }
  
869
  return result;
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
}

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

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

  return result;
}

914 915 916 917 918 919 920
/**
 * 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
921
 * Gets the contents of @selection_data as an array of targets.
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
 * 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
961
 * determines if any of the targets in @targets can be used to
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
 * 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
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
/*************************************************************
 * 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);
1007 1008

  initialize = FALSE;
Elliot Lee's avatar
Elliot Lee committed
1009 1010
}

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


/*************************************************************
1059
 * _gtk_selection_request:
Elliot Lee's avatar
Elliot Lee committed
1060 1061 1062 1063 1064 1065 1066
 *     Handler for "selection_request_event" 
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

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

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

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

Elliot Lee's avatar
Elliot Lee committed
1270 1271 1272 1273 1274
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
1275 1276

  g_object_unref (widget);
1277
  
Elliot Lee's avatar
Elliot Lee committed
1278 1279 1280 1281
  return TRUE;
}

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

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

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

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1413 1414
  gboolean retval;

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

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1455 1456 1457
}

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

1470
gboolean
1471 1472
_gtk_selection_notify (GtkWidget	       *widget,
		       GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1473 1474
{
  GList *tmp_list;
1475
  GtkRetrievalInfo *info = NULL;
1476
  guchar  *buffer = NULL;
Elliot Lee's avatar
Elliot Lee committed
1477 1478
  gint length;
  GdkAtom type;
1479
  gint	  format;
Elliot Lee's avatar
Elliot Lee committed
1480 1481
  
#ifdef DEBUG_SELECTION
1482 1483
  g_message ("Initial receipt of selection %ld, target %ld (property = %ld)",
	     event->selection, event->target, event->property);
Elliot Lee's avatar
Elliot Lee committed
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
#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;
    }
1494
  
Elliot Lee's avatar
Elliot Lee committed
1495 1496
  if (!tmp_list)		/* no retrieval in progress */
    return FALSE;
1497 1498 1499 1500

  if (event->property != GDK_NONE)
    length = gdk_selection_property_get (widget->window, &buffer, 
					 &type, &format);
Havoc Pennington's avatar
Havoc Pennington committed
1501 1502 1503
  else
    length = 0; /* silence gcc */
  
1504
  if (event->property == GDK_NONE || buffer == NULL)
Elliot Lee's avatar
Elliot Lee committed
1505 1506 1507 1508 1509
    {
      current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
      g_list_free (tmp_list);
      /* structure will be freed in timeout */
      gtk_selection_retrieval_report (info,
1510
				      GDK_NONE, 0, NULL, -1, event->time);
1511
      
Elliot Lee's avatar
Elliot Lee committed
1512 1513 1514 1515 1516 1517 1518
      return TRUE;
    }
  
  if (type == gtk_selection_atoms[INCR])
    {
      /* The remainder of the selection will come through PropertyNotify
	 events */
1519 1520

      info->notify_time = event->time;
Elliot Lee's avatar
Elliot Lee committed
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
      info->idle_time = 0;
      info->offset = 0;		/* Mark as OK to proceed */
      gdk_window_set_events (widget->window,
			     gdk_window_get_events (widget->window)
			     | GDK_PROPERTY_CHANGE_MASK);
    }
  else
    {
      /* We don't delete the info structure - that will happen in timeout */
      current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
      g_list_free (tmp_list);
1532
      
Elliot Lee's avatar
Elliot Lee committed
1533 1534 1535
      info->offset = length;
      gtk_selection_retrieval_report (info,
				      type, format, 
1536
				      buffer, length, event->time);
Elliot Lee's avatar
Elliot Lee committed
1537
    }
1538
  
Elliot Lee's avatar
Elliot Lee committed
1539
  gdk_property_delete (widget->window, event->property);
1540
  
Elliot Lee's avatar
Elliot Lee committed
1541
  g_free (buffer);