gtkselection.c 40.6 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4 5 6 7 8 9 10
/* 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
 * modify it under the terms of the GNU Library General Public
 * 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
Elliot Lee's avatar
Elliot Lee committed
12 13 14
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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 49 50 51 52 53
/*
 * Modified by the GTK+ Team and others 1997-1999.  See the AUTHORS
 * 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
#include "gdkx.h"		/* For gdk_window_lookup() */
Elliot Lee's avatar
Elliot Lee committed
57 58 59 60 61 62 63 64
#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 */
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
Elliot Lee's avatar
Elliot Lee committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
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
{
  GdkAtom    selection;
  GtkWidget *widget;		/* widget that owns selection */
  guint32    time;		/* time used to acquire selection */
};

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

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

/* Local Functions */
133 134 135 136
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,
Elliot Lee's avatar
Elliot Lee committed
137
						  GdkAtom type, gint format, 
138 139
						  guchar *buffer, gint length,
						  guint32 time);
140
static void gtk_selection_invoke_handler	 (GtkWidget	   *widget,
141 142
						  GtkSelectionData *data,
						  guint             time);
143
static void gtk_selection_default_handler	 (GtkWidget	  *widget,
Elliot Lee's avatar
Elliot Lee committed
144 145 146 147 148 149 150 151 152
						  GtkSelectionData *data);

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

155 156 157 158 159 160 161 162 163
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
164 165
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
{
  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)
{
  list->ref_count++;
}

void               
gtk_target_list_unref (GtkTargetList *list)
{
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
Owen Taylor's avatar
Owen Taylor committed
192 193
	  GtkTargetPair *pair = tmp_list->data;
	  g_free (pair);
194 195 196

	  tmp_list = tmp_list->next;
	}
Owen Taylor's avatar
Owen Taylor committed
197 198
      
      g_list_free (list->list);
199
      g_free (list);
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
    }
}

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               
222 223 224
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
225 226 227 228 229 230 231 232 233 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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
{
  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);

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


Elliot Lee's avatar
Elliot Lee committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/*************************************************************
 * gtk_selection_owner_set:
 *     Claim ownership of a selection.
 *   arguments:
 *     widget:		new selection owner
 *     selection:	which selection
 *     time:		time (use GDK_CURRENT_TIME only if necessary)
 *
 *   results:
 *************************************************************/

gint
gtk_selection_owner_set (GtkWidget *widget,
			 GdkAtom    selection,
			 guint32    time)
{
  GList *tmp_list;
  GtkWidget *old_owner;
306
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
307
  GdkWindow *window;
308
  
Elliot Lee's avatar
Elliot Lee committed
309 310 311 312 313 314 315 316 317
  if (widget == NULL)
    window = NULL;
  else
    {
      if (!GTK_WIDGET_REALIZED (widget))
	gtk_widget_realize (widget);
      
      window = widget->window;
    }
318
  
Elliot Lee's avatar
Elliot Lee committed
319 320 321 322 323 324 325 326 327 328
  tmp_list = current_selections;
  while (tmp_list)
    {
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->selection == selection)
	break;
      
      tmp_list = tmp_list->next;
    }
329
  
Elliot Lee's avatar
Elliot Lee committed
330 331 332 333 334
  if (tmp_list == NULL)
    selection_info = NULL;
  else
    if (selection_info->widget == widget)
      return TRUE;
335
  
Elliot Lee's avatar
Elliot Lee committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
  if (gdk_selection_owner_set (window, selection, time, TRUE))
    {
      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;
	      current_selections = g_list_append (current_selections, 
						  selection_info);
	    }
	  else
	    {
	      old_owner = selection_info->widget;
	      selection_info->widget = widget;
	      selection_info->time = time;
	    }
	}
      /* If another widget in the application lost the selection,
       *  send it a GDK_SELECTION_CLEAR event, unless we're setting
       *  the owner to None, in which case an event will be sent */
      if (old_owner && (widget != NULL))
	{
	  GdkEventSelection event;
	  
	  event.type = GDK_SELECTION_CLEAR;
	  event.window = old_owner->window;
	  event.selection = selection;
	  event.time = time;
380
	  
381
	  gtk_widget_event (old_owner, (GdkEvent *) &event);
Elliot Lee's avatar
Elliot Lee committed
382 383 384 385 386 387 388 389
	}
      return TRUE;
    }
  else
    return FALSE;
}

/*************************************************************
390 391
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
392 393
 *
 *   arguments:
394
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
395 396
 *     selection:
 *     target:
397
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
398 399 400 401
 *
 *   results:
 *************************************************************/

402
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
403

404 405 406 407 408 409 410 411
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
412
{
413
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
414
  GList *tmp_list;
415 416 417
  GList *lists;

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
418
  
419
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
420 421
  while (tmp_list)
    {
422 423 424
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
425 426
      tmp_list = tmp_list->next;
    }
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

  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);
446
  
447 448
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
449
    {
450 451 452 453 454 455
      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
456
    }
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

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

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 
477 478 479 480
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
481 482 483 484 485
{
  GtkTargetList *list;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
486
  
487 488
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
}

/*************************************************************
 * 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;
508
  
Elliot Lee's avatar
Elliot Lee committed
509
  /* Remove pending requests/incrs for this widget */
510
  
Elliot Lee's avatar
Elliot Lee committed
511 512 513 514 515 516 517 518 519 520 521 522
  tmp_list = current_incrs;
  while (tmp_list)
    {
      next = tmp_list->next;
      if (((GtkIncrInfo *)tmp_list->data)->widget == widget)
	{
	  current_incrs = g_list_remove_link (current_incrs, tmp_list);
	  /* structure will be freed in timeout */
	  g_list_free (tmp_list);
	}
      tmp_list = next;
    }
523
  
Elliot Lee's avatar
Elliot Lee committed
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
  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 */
539
  
Elliot Lee's avatar
Elliot Lee committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
	  gdk_selection_owner_set (NULL, 
				   selection_info->selection,
				   GDK_CURRENT_TIME, FALSE);
	  current_selections = g_list_remove_link (current_selections, 
						   tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
      
      tmp_list = next;
    }
559 560 561

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
562 563 564 565 566 567 568 569
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
570
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
571
 *     selection:  Which selection to get
572 573 574
 *     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
575 576 577 578 579 580 581 582 583
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

gint
gtk_selection_convert (GtkWidget *widget, 
584 585 586
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
587 588 589 590
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
591
  
Elliot Lee's avatar
Elliot Lee committed
592
  g_return_val_if_fail (widget != NULL, FALSE);
593
  
Elliot Lee's avatar
Elliot Lee committed
594 595 596 597 598
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
599
  
Elliot Lee's avatar
Elliot Lee committed
600 601 602 603 604
  /* 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. */
605
  
Elliot Lee's avatar
Elliot Lee committed
606 607 608 609 610 611 612 613
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
614
  
Elliot Lee's avatar
Elliot Lee committed
615
  info = g_new (GtkRetrievalInfo, 1);
616
  
Elliot Lee's avatar
Elliot Lee committed
617 618 619 620 621
  info->widget = widget;
  info->selection = selection;
  info->target = target;
  info->buffer = NULL;
  info->offset = -1;
622
  
Elliot Lee's avatar
Elliot Lee committed
623 624
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
625
  
Elliot Lee's avatar
Elliot Lee committed
626 627 628 629 630 631
  owner_window = gdk_selection_owner_get (selection);
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
632
      
Elliot Lee's avatar
Elliot Lee committed
633 634 635 636
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
637
      
Elliot Lee's avatar
Elliot Lee committed
638
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
639
      
Elliot Lee's avatar
Elliot Lee committed
640 641
      if (owner_widget != NULL)
	{
642
	  gtk_selection_invoke_handler (owner_widget, 
643 644
					&selection_data,
					time);
645
	  
Elliot Lee's avatar
Elliot Lee committed
646 647 648 649
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
650 651
					  selection_data.length,
					  time);
652
	  
Elliot Lee's avatar
Elliot Lee committed
653 654 655 656 657 658 659 660
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
661
  
Elliot Lee's avatar
Elliot Lee committed
662 663 664
  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);
665
  
Elliot Lee's avatar
Elliot Lee committed
666 667 668 669 670 671 672 673 674 675
  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
676 677 678
 *     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
679 680 681 682 683
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
684 685 686 687
			GdkAtom		  type,
			gint		  format,
			guchar		 *data,
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
688 689 690
{
  if (selection_data->data)
    g_free (selection_data->data);
691
  
Elliot Lee's avatar
Elliot Lee committed
692 693
  selection_data->type = type;
  selection_data->format = format;
694
  
Elliot Lee's avatar
Elliot Lee committed
695 696 697 698 699 700 701
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
702 703 704 705 706 707 708 709
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
710
  
Elliot Lee's avatar
Elliot Lee committed
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
  selection_data->length = length;
}

/*************************************************************
 * 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);
}

/*************************************************************
 * gtk_selection_clear:
 *     Handler for "selection_clear_event"
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

gint
gtk_selection_clear (GtkWidget *widget,
		     GdkEventSelection *event)
{
  /* FIXME: there can be a problem if we change the selection
     via gtk_selection_owner_set after another client claims 
     the selection, but before we get the notification event.
     Tk filters based on serial #'s, which aren't retained by
     GTK. Filtering based on time's will be inherently 
     somewhat unreliable. */
750
  
Elliot Lee's avatar
Elliot Lee committed
751
  GList *tmp_list;
752
  GtkSelectionInfo *selection_info = NULL;
753
  
Elliot Lee's avatar
Elliot Lee committed
754 755 756 757 758 759 760 761 762 763 764
  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;
    }
765
  
766 767 768 769
  if (tmp_list)
    {
      if (selection_info->time > event->time)
	return FALSE;		/* return FALSE to indicate that
770 771
				 * the selection was out of date,
				 * and this clear should be ignored */
772 773 774 775 776 777 778 779
      else
	{
	  current_selections = g_list_remove_link (current_selections, tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
    }
  
Elliot Lee's avatar
Elliot Lee committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
  return TRUE;
}


/*************************************************************
 * gtk_selection_request:
 *     Handler for "selection_request_event" 
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

gint
gtk_selection_request (GtkWidget *widget,
		       GdkEventSelection *event)
{
  GtkIncrInfo *info;
  GList *tmp_list;
  guchar *mult_atoms;
  int i;
801
  
802 803 804
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
805
  /* Check if we own selection */
806
  
Elliot Lee's avatar
Elliot Lee committed
807 808 809 810
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
811
      
Elliot Lee's avatar
Elliot Lee committed
812 813 814
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
815
      
Elliot Lee's avatar
Elliot Lee committed
816 817
      tmp_list = tmp_list->next;
    }
818
  
Elliot Lee's avatar
Elliot Lee committed
819 820 821 822
  if (tmp_list == NULL)
    return FALSE;
  
  info = g_new(GtkIncrInfo, 1);
823
  
Elliot Lee's avatar
Elliot Lee committed
824 825 826
  info->widget = widget;
  info->selection = event->selection;
  info->num_incrs = 0;
827
  
Elliot Lee's avatar
Elliot Lee committed
828
  /* Create GdkWindow structure for the requestor */
829
  
Elliot Lee's avatar
Elliot Lee committed
830 831 832 833 834
  info->requestor = gdk_window_lookup (event->requestor);
  if (!info->requestor)
    info->requestor = gdk_window_foreign_new (event->requestor);
  
  /* Determine conversions we need to perform */
835
  
Elliot Lee's avatar
Elliot Lee committed
836 837 838 839 840
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
      gint     format;
      gint     length;
841
      
Elliot Lee's avatar
Elliot Lee committed
842
      mult_atoms = NULL;
843
      if (!gdk_property_get (info->requestor, event->property, 0, /* AnyPropertyType */
Elliot Lee's avatar
Elliot Lee committed
844
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
845
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
846 847 848 849 850 851 852
	{
	  gdk_selection_send_notify (event->requestor, event->selection,
				     event->target, GDK_NONE, event->time);
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
853
      
Elliot Lee's avatar
Elliot Lee committed
854 855
      info->num_conversions = length / (2*sizeof (GdkAtom));
      info->conversions = g_new (GtkIncrConversion, info->num_conversions);
856
      
Elliot Lee's avatar
Elliot Lee committed
857 858 859 860 861 862 863 864 865 866 867 868 869 870
      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;
    }
871
  
Elliot Lee's avatar
Elliot Lee committed
872 873 874 875 876 877
  /* 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;
      gint items;
878
      
Elliot Lee's avatar
Elliot Lee committed
879 880 881 882
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
883
      
Elliot Lee's avatar
Elliot Lee committed
884
#ifdef DEBUG_SELECTION
885 886 887 888
      g_message ("Selection %ld, target %ld (%s) requested by 0x%x (property = %ld)",
		 event->selection, info->conversions[i].target,
		 gdk_atom_name(info->conversions[i].target),
		 event->requestor, event->property);
Elliot Lee's avatar
Elliot Lee committed
889
#endif
890
      
891
      gtk_selection_invoke_handler (widget, &data, event->time);
892
      
Elliot Lee's avatar
Elliot Lee committed
893 894 895 896 897 898
      if (data.length < 0)
	{
	  ((GdkAtom *)mult_atoms)[2*i+1] = GDK_NONE;
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
899
      
Tim Janik's avatar
GLib:  
Tim Janik committed
900
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
901
      
Elliot Lee's avatar
Elliot Lee committed
902
      items = (data.length + data.format/8 - 1) / (data.format/8);
903
      
Elliot Lee's avatar
Elliot Lee committed
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
      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],
			       8*sizeof (GdkAtom),
			       GDK_PROP_MODE_REPLACE,
			       (guchar *)&items, 1);
	}
      else
	{
	  info->conversions[i].offset = -1;
922
	  
Elliot Lee's avatar
Elliot Lee committed
923 924 925 926 927 928
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
929
	  
Elliot Lee's avatar
Elliot Lee committed
930 931 932
	  g_free (data.data);
	}
    }
933
  
Elliot Lee's avatar
Elliot Lee committed
934 935
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
936
  
Elliot Lee's avatar
Elliot Lee committed
937 938 939 940
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
941
      
Elliot Lee's avatar
Elliot Lee committed
942
#ifdef DEBUG_SELECTION
943
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
944
#endif
945
      
Elliot Lee's avatar
Elliot Lee committed
946 947 948 949 950 951
      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);
    }
952
  
Elliot Lee's avatar
Elliot Lee committed
953 954 955 956 957 958 959
  /* 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,
			   GDK_SELECTION_TYPE_ATOM, 8*sizeof(GdkAtom), 
			   GDK_PROP_MODE_REPLACE,
960
			   mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
961 962
      g_free (mult_atoms);
    }
963
  
Elliot Lee's avatar
Elliot Lee committed
964 965
  gdk_selection_send_notify (event->requestor, event->selection, event->target,
			     event->property, event->time);
966
  
Elliot Lee's avatar
Elliot Lee committed
967 968 969 970 971
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
972
  
Elliot Lee's avatar
Elliot Lee committed
973 974 975 976 977 978 979 980 981 982 983 984
  return TRUE;
}

/*************************************************************
 * gtk_selection_incr_event:
 *     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:
985 986
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
987 988 989 990 991
 *
 *   results:
 *************************************************************/

gint
992
gtk_selection_incr_event (GdkWindow	   *window,
Elliot Lee's avatar
Elliot Lee committed
993 994 995
			  GdkEventProperty *event)
{
  GList *tmp_list;
996
  GtkIncrInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
997 998
  gint num_bytes;
  guchar *buffer;
999
  
Elliot Lee's avatar
Elliot Lee committed
1000 1001 1002 1003
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
1004
  
Elliot Lee's avatar
Elliot Lee committed
1005
#ifdef DEBUG_SELECTION
1006
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
1007
#endif
1008
  
Elliot Lee's avatar
Elliot Lee committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
  /* 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;
    }
1019
  
Elliot Lee's avatar
Elliot Lee committed
1020 1021
  if (tmp_list == NULL)
    return FALSE;
1022
  
Elliot Lee's avatar
Elliot Lee committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
  /* 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)
	{
	  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;
1043
	      
Elliot Lee's avatar
Elliot Lee committed
1044 1045 1046 1047 1048 1049 1050 1051 1052
	      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
1053 1054 1055
	  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
1056 1057 1058 1059 1060 1061 1062 1063
#endif
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
			       buffer, 
			       (num_bytes + info->conversions[i].data.format/8 - 1) / 
			       (info->conversions[i].data.format/8));
1064
	  
Elliot Lee's avatar
Elliot Lee committed
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	  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;
    }
1079
  
Elliot Lee's avatar
Elliot Lee committed
1080
  /* Check if we're finished with all the targets */
1081
  
Elliot Lee's avatar
Elliot Lee committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
  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:
1097
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
1098 1099 1100 1101 1102 1103 1104
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1105 1106
  gboolean retval;

1107
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1108 1109 1110
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1111
  
Elliot Lee's avatar
Elliot Lee committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
  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? */
1132
      
Elliot Lee's avatar
Elliot Lee committed
1133 1134
      g_free (info);
      
1135
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1136 1137 1138 1139 1140
    }
  else
    {
      info->idle_time++;
      
1141
      retval = TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1142
    }
1143
  
1144
  GDK_THREADS_LEAVE ();
1145 1146

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1147 1148 1149 1150 1151 1152 1153 1154
}

/*************************************************************
 * gtk_selection_notify:
 *     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:
1155 1156 1157
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1158 1159 1160 1161 1162
 *   results:
 *     was event handled?
 *************************************************************/

gint
1163
gtk_selection_notify (GtkWidget	       *widget,
Elliot Lee's avatar
Elliot Lee committed
1164 1165 1166
		      GdkEventSelection *event)
{
  GList *tmp_list;
1167
  GtkRetrievalInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1168 1169 1170
  guchar  *buffer;
  gint length;
  GdkAtom type;
1171
  gint	  format;
Elliot Lee's avatar
Elliot Lee committed
1172 1173
  
#ifdef DEBUG_SELECTION
1174 1175
  g_message ("Initial receipt of selection %ld, target %ld (property = %ld)",
	     event->selection, event->target, event->property);
Elliot Lee's avatar
Elliot Lee committed
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
#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;
    }
1186
  
Elliot Lee's avatar
Elliot Lee committed
1187 1188
  if (!tmp_list)		/* no retrieval in progress */
    return FALSE;
1189
  
Elliot Lee's avatar
Elliot Lee committed
1190 1191 1192 1193 1194 1195
  if (event->property == GDK_NONE)
    {
      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,
1196
				      GDK_NONE, 0, NULL, -1, event->time);
1197
      
Elliot Lee's avatar
Elliot Lee committed
1198 1199 1200 1201 1202
      return TRUE;
    }
  
  length = gdk_selection_property_get (widget->window, &buffer, 
				       &type, &format);
1203
  
Elliot Lee's avatar
Elliot Lee committed
1204 1205 1206 1207
  if (type == gtk_selection_atoms[INCR])
    {
      /* The remainder of the selection will come through PropertyNotify
	 events */
1208 1209

      info->notify_time = event->time;
Elliot Lee's avatar
Elliot Lee committed
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
      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);
1221
      
Elliot Lee's avatar
Elliot Lee committed
1222 1223 1224
      info->offset = length;
      gtk_selection_retrieval_report (info,
				      type, format, 
1225
				      buffer, length, event->time);
Elliot Lee's avatar
Elliot Lee committed
1226
    }
1227
  
Elliot Lee's avatar
Elliot Lee committed
1228
  gdk_property_delete (widget->window, event->property);
1229
  
Elliot Lee's avatar
Elliot Lee committed
1230
  g_free (buffer);
1231
  
Elliot Lee's avatar
Elliot Lee committed
1232 1233 1234 1235 1236 1237 1238 1239 1240
  return TRUE;
}

/*************************************************************
 * gtk_selection_property_notify:
 *     Handler for "property_notify_event" signals on windows
 *     where a retrieval is currently in process. The selection
 *     owner has added more data.
 *   arguments:
1241 1242 1243
 *     widget:		Widget getting signal
 *     event:		Property event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1244 1245 1246 1247 1248
 *   results:
 *     was event handled?
 *************************************************************/

gint
1249
gtk_selection_property_notify (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1250 1251 1252
			       GdkEventProperty *event)
{
  GList *tmp_list;
1253
  GtkRetrievalInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1254 1255 1256
  guchar *new_buffer;
  int length;
  GdkAtom type;
1257
  gint	  format;
1258
  
1259 1260 1261
  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

Elliot Lee's avatar
Elliot Lee committed
1262 1263 1264
  if ((event->state != GDK_PROPERTY_NEW_VALUE) ||  /* property was deleted */
      (event->atom != gdk_selection_property)) /* not the right property */
    return FALSE;
1265
  
Elliot Lee's avatar
Elliot Lee committed
1266
#ifdef DEBUG_SELECTION
1267 1268
  g_message ("PropertyNewValue, property %ld",
	     event->atom);
Elliot Lee's avatar
Elliot Lee committed
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	break;
      tmp_list = tmp_list->next;
    }
1279
  
Elliot Lee's avatar
Elliot Lee committed
1280 1281
  if (!tmp_list)		/* No retrieval in progress */
    return FALSE;
1282
  
Elliot Lee's avatar
Elliot Lee committed
1283 1284 1285
  if (info->offset < 0)		/* We haven't got the SelectionNotify
				   for this retrieval yet */
    return FALSE;
1286
  
Elliot Lee's avatar
Elliot Lee committed
1287 1288 1289 1290 1291
  info->idle_time = 0;
  
  length = gdk_selection_property_get (widget->window, &new_buffer, 
				       &type, &format);
  gdk_property_delete (widget->window, event->atom);
1292
  
Elliot Lee's avatar
Elliot Lee committed
1293 1294 1295 1296
  /* We could do a lot better efficiency-wise by paying attention to
     what length was sent in the initial INCR transaction, instead of
     doing memory allocation at every step. But its only guaranteed to
     be a _lower bound_ (pretty useless!) */
1297
  
Elliot Lee's avatar
Elliot Lee committed
1298 1299 1300 1301 1302 1303 1304 1305
  if (length == 0 || type == GDK_NONE)		/* final zero length portion */
    {
      /* Info structure will be freed in timeout */
      current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
      g_list_free (tmp_list);
      gtk_selection_retrieval_report (info,
				      type, format, 
				      (type == GDK_NONE) ?  NULL : info->buffer,
1306 1307
				      (type == GDK_NONE) ?  -1 : info->offset,
				      info->notify_time);
Elliot Lee's avatar
Elliot Lee committed
1308 1309 1310 1311 1312 1313
    }
  else				/* append on newly arrived data */
    {
      if (!info->buffer)
	{
#ifdef DEBUG_SELECTION
1314 1315
	  g_message ("Start - Adding %d bytes at offset 0",
		     length);
Elliot Lee's avatar
Elliot Lee committed
1316 1317 1318 1319 1320 1321
#endif
	  info->buffer = new_buffer;
	  info->offset = length;
	}
      else
	{
1322
	  
Elliot Lee's avatar
Elliot Lee committed
1323
#ifdef DEBUG_SELECTION
1324 1325
	  g_message ("Appending %d bytes at offset %d",
		     length,info->offset);
Elliot Lee's avatar
Elliot Lee committed
1326 1327 1328 1329 1330 1331 1332 1333
#endif
	  /* We copy length+1 bytes to preserve guaranteed null termination */
	  info->buffer = g_realloc (info->buffer, info->offset+length+1);
	  memcpy (info->buffer + info->offset, new_buffer, length+1);
	  info->offset += length;
	  g_free (new_buffer);
	}
    }
1334
  
Elliot Lee's avatar
Elliot Lee committed
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
  return TRUE;
}

/*************************************************************
 * gtk_selection_retrieval_timeout:
 *     Timeout callback while receiving a selection.
 *   arguments:
 *     info:	Information about this retrieval
 *   results:
 *************************************************************/

static gint
gtk_selection_retrieval_timeout (GtkRetrievalInfo *info)
{
  GList *tmp_list;
1350 1351
  gboolean retval;

1352
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1353 1354 1355
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1356
  
Elliot Lee's avatar
Elliot Lee committed
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      if (info == (GtkRetrievalInfo *)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_retrievals = g_list_remove_link (current_retrievals, tmp_list);
	  g_list_free (tmp_list);
1372
	  gtk_selection_retrieval_report (info, GDK_NONE, 0, NULL, -1, GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
1373 1374 1375 1376 1377
	}
      
      g_free (info->buffer);
      g_free (info);
      
1378
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1379 1380 1381 1382 1383
    }
  else
    {
      info->idle_time++;
      
1384
      retval =  TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1385
    }
1386

1387
  GDK_THREADS_LEAVE ();
1388 1389

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1390 1391 1392 1393 1394 1395
}

/*************************************************************
 * gtk_selection_retrieval_report:
 *     Emits a "selection_received" signal.
 *   arguments:
1396 1397
 *     info:	  information about the retrieval that completed
 *     buffer:	  buffer containing data (NULL => errror)
1398
 *     time:      timestamp for data in buffer
Elliot Lee's avatar
Elliot Lee committed
1399 1400 1401 1402 1403 1404
 *   results:
 *************************************************************/

static void
gtk_selection_retrieval_report (GtkRetrievalInfo *info,
				GdkAtom type, gint format, 
1405 1406
				guchar *buffer, gint length,
				guint32 time)
Elliot Lee's avatar
Elliot Lee committed
1407 1408
{
  GtkSelectionData data;
1409
  
Elliot Lee's avatar
Elliot Lee committed
1410 1411 1412 1413
  data.selection = info->selection;
  data.target = info->target;
  data.type = type;
  data.format = format;
1414
  
Elliot Lee's avatar
Elliot Lee committed
1415 1416
  data.length = length;
  data.data = buffer;
1417
  
Elliot Lee's avatar
Elliot Lee committed
1418
  gtk_signal_emit_by_name (GTK_OBJECT(info->widget),
1419 1420
			   "selection_received", 
			   &data, time);
Elliot Lee's avatar
Elliot Lee committed
1421 1422 1423
}

/*************************************************************
1424 1425 1426 1427 1428
 * gtk_selection_invoke_handler:
 *     Finds and invokes handler for specified
 *     widget/selection/target combination, calls 
 *     gtk_selection_default_handler if none exists.
 *
Elliot Lee's avatar
Elliot Lee committed
1429
 *   arguments:
1430 1431
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1432
 *     time:        time from requeset
1433
 *     
Elliot Lee's avatar
Elliot Lee committed
1434
 *   results:
1435
 *     Number of bytes written to buffer, -1 if error
Elliot Lee's avatar
Elliot Lee committed
1436 1437
 *************************************************************/

1438
static void
1439
gtk_selection_invoke_handler (GtkWidget	       *widget,
1440 1441
			      GtkSelectionData *data,
			      guint             time)
Elliot Lee's avatar
Elliot Lee committed
1442
{
1443 1444
  GtkTargetList *target_list;
  guint info;
1445
  
1446

1447
  g_return_if_fail (widget != NULL);
1448 1449 1450 1451

  target_list = gtk_selection_target_list_get (widget, data->selection);
  if (target_list && 
      gtk_target_list_find (target_list, data->target, &info))
Elliot Lee's avatar
Elliot Lee committed
1452
    {
1453 1454 1455 1456
      gtk_signal_emit_by_name (GTK_OBJECT (widget), 
			       "selection_get",
			       data,
			       info, time);
Elliot Lee's avatar
Elliot Lee committed
1457
    }
1458
  else
1459
    gtk_selection_default_handler (widget, data);
Elliot Lee's avatar
Elliot Lee committed
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
}

/*************************************************************
 * gtk_selection_default_handler:
 *     Handles some default targets that exist for any widget
 *     If it can't fit results into buffer, returns -1. This
 *     won't happen in any conceivable case, since it would
 *     require 1000 selection targets!
 *
 *   arguments:
1470 1471
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1472
 *
Elliot Lee's avatar
Elliot Lee committed
1473 1474 1475
 *************************************************************/

static void
1476
gtk_selection_default_handler (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
			       GtkSelectionData *data)
{
  if (data->target == gtk_selection_atoms[TIMESTAMP])
    {
      /* Time which was used to obtain selection */
      GList *tmp_list;
      GtkSelectionInfo *selection_info;
      
      tmp_list = current_selections;
      while (tmp_list)
	{
	  selection_info = (GtkSelectionInfo *)tmp_list->data;
	  if ((selection_info->widget == widget) &&
	      (selection_info->selection == data->selection))
	    {
	      gtk_selection_data_set (data,
				      GDK_SELECTION_TYPE_INTEGER,
				      sizeof (guint32)*8,
				      (guchar *)&selection_info->time,
				      sizeof (guint32));
	      return;
	    }
1499
	  
Elliot Lee's avatar
Elliot Lee committed
1500 1501
	  tmp_list = tmp_list->next;
	}
1502
      
Elliot Lee's avatar
Elliot Lee committed
1503 1504 1505 1506 1507 1508
      data->length = -1;
    }
  else if (data->target == gtk_selection_atoms[TARGETS])
    {
      /* List of all targets supported for this widget/selection pair */
      GdkAtom *p;
1509
      guint count;
Elliot Lee's avatar
Elliot Lee committed
1510
      GList *tmp_list;
1511 1512
      GtkTargetList *target_list;
      GtkTargetPair *pair;
1513
      
1514 1515
      target_list = gtk_selection_target_list_get (widget,
						   data->selection);
1516
      count = g_list_length (target_list->list) + 3;
1517
      
Elliot Lee's avatar
Elliot Lee committed
1518 1519
      data->type = GDK_SELECTION_TYPE_ATOM;
      data->format = 8*sizeof (GdkAtom);
1520
      data->length = count * sizeof (GdkAtom);
1521
      
Elliot Lee's avatar
Elliot Lee committed
1522 1523
      p = g_new (GdkAtom, count);
      data->data = (guchar *)p;
1524
      
Elliot Lee's avatar
Elliot Lee committed
1525 1526 1527
      *p++ = gtk_selection_atoms[TIMESTAMP];
      *p++ = gtk_selection_atoms[TARGETS];
      *p++ = gtk_selection_atoms[MULTIPLE];
1528
      
1529
      tmp_list = target_list->list;
Elliot Lee's avatar
Elliot Lee committed
1530 1531
      while (tmp_list)
	{
1532 1533
	  pair = (GtkTargetPair *)tmp_list->data;
	  *p++ = pair->target;
1534
	  
Elliot Lee's avatar
Elliot Lee committed
1535 1536 1537 1538 1539 1540 1541 1542
	  tmp_list = tmp_list->next;
	}
    }
  else
    {
      data->length = -1;
    }
}
1543 1544 1545 1546 1547 1548


GtkSelectioData*
gtk_selection_data_copy (GtkSelectionData *data)
{
  GtkSelectionData *new_data;
1549
  
1550
  g_return_val_if_fail (data != NULL, NULL);
1551
  
1552 1553
  new_data = g_new (GtkSelectionData, 1);
  *new_data = *data;
1554
  
1555 1556 1557 1558 1559 1560 1561
  return new_data;
}

void
gtk_selection_data_free (GtkSelectionData *data)
{
  g_return_if_fail (data != NULL);
1562
  
1563 1564
  g_free (data);
}