gtkselection.c 40.2 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 47
 */

/* 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 ... */

#include <stdarg.h>
48
#include <string.h>
Elliot Lee's avatar
Elliot Lee committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
#include <gdk/gdkx.h>
/* we need this for gdk_window_lookup() */
#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 */
#define GTK_SELECTION_MAX_SIZE 4000

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 
{
83 84
  GdkAtom	    target;	/* Requested target */
  GdkAtom	    property;	/* Property to store in */
Elliot Lee's avatar
Elliot Lee committed
85
  GtkSelectionData  data;	/* The data being supplied */
86
  gint		    offset;	/* Current offset in sent selection.
Elliot Lee's avatar
Elliot Lee committed
87 88
				 *  -1 => All done
				 *  -2 => Only the final (empty) portion
89
				 *	  left to send */
Elliot Lee's avatar
Elliot Lee committed
90 91 92 93 94 95 96 97
};

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 */
98
  
Elliot Lee's avatar
Elliot Lee committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
  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 */
117
  gint	   offset;		/* Current offset in buffer, -1 indicates
Elliot Lee's avatar
Elliot Lee committed
118
				   not yet started */
119
  guint32 notify_time;		/* Timestamp from SelectionNotify */
Elliot Lee's avatar
Elliot Lee committed
120 121 122
};

/* Local Functions */
123 124 125 126
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
127
						  GdkAtom type, gint format, 
128 129
						  guchar *buffer, gint length,
						  guint32 time);
130
static void gtk_selection_invoke_handler	 (GtkWidget	   *widget,
131 132
						  GtkSelectionData *data,
						  guint             time);
133
static void gtk_selection_default_handler	 (GtkWidget	  *widget,
Elliot Lee's avatar
Elliot Lee committed
134 135 136 137 138 139 140 141 142
						  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
143
static const char *gtk_selection_handler_key = "gtk-selection-handlers";
Elliot Lee's avatar
Elliot Lee committed
144

145 146 147 148 149 150 151 152 153
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
154 155
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
{
  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
182 183
	  GtkTargetPair *pair = tmp_list->data;
	  g_free (pair);
184 185 186

	  tmp_list = tmp_list->next;
	}
Owen Taylor's avatar
Owen Taylor committed
187 188
      
      g_list_free (list->list);
189
      g_free (list);
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
    }
}

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               
212 213 214
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
215 216 217 218 219 220 221 222 223 224 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
{
  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
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
/*************************************************************
 * 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;
  GtkSelectionInfo *selection_info;
  GdkWindow *window;
298
  
Elliot Lee's avatar
Elliot Lee committed
299 300 301 302 303 304 305 306 307
  if (widget == NULL)
    window = NULL;
  else
    {
      if (!GTK_WIDGET_REALIZED (widget))
	gtk_widget_realize (widget);
      
      window = widget->window;
    }
308
  
Elliot Lee's avatar
Elliot Lee committed
309 310 311 312 313 314 315 316 317 318
  tmp_list = current_selections;
  while (tmp_list)
    {
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->selection == selection)
	break;
      
      tmp_list = tmp_list->next;
    }
319
  
Elliot Lee's avatar
Elliot Lee committed
320 321 322 323 324
  if (tmp_list == NULL)
    selection_info = NULL;
  else
    if (selection_info->widget == widget)
      return TRUE;
325
  
Elliot Lee's avatar
Elliot Lee committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
  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;
370
	  
371
	  gtk_widget_event (old_owner, (GdkEvent *) &event);
Elliot Lee's avatar
Elliot Lee committed
372 373 374 375 376 377 378 379
	}
      return TRUE;
    }
  else
    return FALSE;
}

/*************************************************************
380 381
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
382 383
 *
 *   arguments:
384
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
385 386
 *     selection:
 *     target:
387
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
388 389 390 391
 *
 *   results:
 *************************************************************/

392
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
393

394 395 396 397 398 399 400 401
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
402
{
403
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
404
  GList *tmp_list;
405 406 407
  GList *lists;

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
408
  
409
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
410 411
  while (tmp_list)
    {
412 413 414
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
415 416
      tmp_list = tmp_list->next;
    }
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435

  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);
436
  
437 438
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
439
    {
440 441 442 443 444 445
      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
446
    }
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466

  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 
467 468 469 470
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
471 472 473 474 475
{
  GtkTargetList *list;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
476
  
477 478
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
}

/*************************************************************
 * 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;
498
  
Elliot Lee's avatar
Elliot Lee committed
499
  /* Remove pending requests/incrs for this widget */
500
  
Elliot Lee's avatar
Elliot Lee committed
501 502 503 504 505 506 507 508 509 510 511 512
  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;
    }
513
  
Elliot Lee's avatar
Elliot Lee committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
  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 */
529
  
Elliot Lee's avatar
Elliot Lee committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
  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;
    }
549 550 551

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
552 553 554 555 556 557 558 559
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
560
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
561
 *     selection:  Which selection to get
562 563 564
 *     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
565 566 567 568 569 570 571 572 573
 *
 *   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, 
574 575 576
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
577 578 579 580
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
581
  
Elliot Lee's avatar
Elliot Lee committed
582
  g_return_val_if_fail (widget != NULL, FALSE);
583
  
Elliot Lee's avatar
Elliot Lee committed
584 585 586 587 588
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
589
  
Elliot Lee's avatar
Elliot Lee committed
590 591 592 593 594
  /* 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. */
595
  
Elliot Lee's avatar
Elliot Lee committed
596 597 598 599 600 601 602 603
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
604
  
Elliot Lee's avatar
Elliot Lee committed
605
  info = g_new (GtkRetrievalInfo, 1);
606
  
Elliot Lee's avatar
Elliot Lee committed
607 608 609 610 611
  info->widget = widget;
  info->selection = selection;
  info->target = target;
  info->buffer = NULL;
  info->offset = -1;
612
  
Elliot Lee's avatar
Elliot Lee committed
613 614
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
615
  
Elliot Lee's avatar
Elliot Lee committed
616 617 618 619 620 621
  owner_window = gdk_selection_owner_get (selection);
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
622
      
Elliot Lee's avatar
Elliot Lee committed
623 624 625 626
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
627
      
Elliot Lee's avatar
Elliot Lee committed
628
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
629
      
Elliot Lee's avatar
Elliot Lee committed
630 631
      if (owner_widget != NULL)
	{
632
	  gtk_selection_invoke_handler (owner_widget, 
633 634
					&selection_data,
					time);
635
	  
Elliot Lee's avatar
Elliot Lee committed
636 637 638 639
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
640 641
					  selection_data.length,
					  time);
642
	  
Elliot Lee's avatar
Elliot Lee committed
643 644 645 646 647 648 649 650
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
651
  
Elliot Lee's avatar
Elliot Lee committed
652 653 654
  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);
655
  
Elliot Lee's avatar
Elliot Lee committed
656 657 658 659 660 661 662 663 664 665
  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
666 667 668
 *     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
669 670 671 672 673
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
674 675 676 677
			GdkAtom		  type,
			gint		  format,
			guchar		 *data,
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
678 679 680
{
  if (selection_data->data)
    g_free (selection_data->data);
681
  
Elliot Lee's avatar
Elliot Lee committed
682 683
  selection_data->type = type;
  selection_data->format = format;
684
  
Elliot Lee's avatar
Elliot Lee committed
685 686 687 688 689 690 691
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
692 693 694 695 696 697 698 699
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
700
  
Elliot Lee's avatar
Elliot Lee committed
701 702 703 704 705 706 707 708 709 710 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
  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. */
740
  
Elliot Lee's avatar
Elliot Lee committed
741 742
  GList *tmp_list;
  GtkSelectionInfo *selection_info;
743
  
Elliot Lee's avatar
Elliot Lee committed
744 745 746 747 748 749 750 751 752 753 754
  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;
    }
755
  
756 757 758 759
  if (tmp_list)
    {
      if (selection_info->time > event->time)
	return FALSE;		/* return FALSE to indicate that
760 761
				 * the selection was out of date,
				 * and this clear should be ignored */
762 763 764 765 766 767 768 769
      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
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
  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;
791
  
792 793 794
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
795
  /* Check if we own selection */
796
  
Elliot Lee's avatar
Elliot Lee committed
797 798 799 800
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
801
      
Elliot Lee's avatar
Elliot Lee committed
802 803 804
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
805
      
Elliot Lee's avatar
Elliot Lee committed
806 807
      tmp_list = tmp_list->next;
    }
808
  
Elliot Lee's avatar
Elliot Lee committed
809 810 811 812
  if (tmp_list == NULL)
    return FALSE;
  
  info = g_new(GtkIncrInfo, 1);
813
  
Elliot Lee's avatar
Elliot Lee committed
814 815 816
  info->widget = widget;
  info->selection = event->selection;
  info->num_incrs = 0;
817
  
Elliot Lee's avatar
Elliot Lee committed
818
  /* Create GdkWindow structure for the requestor */
819
  
Elliot Lee's avatar
Elliot Lee committed
820 821 822 823 824
  info->requestor = gdk_window_lookup (event->requestor);
  if (!info->requestor)
    info->requestor = gdk_window_foreign_new (event->requestor);
  
  /* Determine conversions we need to perform */
825
  
Elliot Lee's avatar
Elliot Lee committed
826 827 828 829 830
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
      gint     format;
      gint     length;
831
      
Elliot Lee's avatar
Elliot Lee committed
832
      mult_atoms = NULL;
833
      if (!gdk_property_get (info->requestor, event->property, 0, /* AnyPropertyType */
Elliot Lee's avatar
Elliot Lee committed
834
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
835
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
836 837 838 839 840 841 842
	{
	  gdk_selection_send_notify (event->requestor, event->selection,
				     event->target, GDK_NONE, event->time);
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
843
      
Elliot Lee's avatar
Elliot Lee committed
844 845
      info->num_conversions = length / (2*sizeof (GdkAtom));
      info->conversions = g_new (GtkIncrConversion, info->num_conversions);
846
      
Elliot Lee's avatar
Elliot Lee committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860
      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;
    }
861
  
Elliot Lee's avatar
Elliot Lee committed
862 863 864 865 866 867
  /* 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;
868
      
Elliot Lee's avatar
Elliot Lee committed
869 870 871 872
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
873
      
Elliot Lee's avatar
Elliot Lee committed
874
#ifdef DEBUG_SELECTION
875 876 877 878
      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
879
#endif
880
      
881
      gtk_selection_invoke_handler (widget, &data, event->time);
882
      
Elliot Lee's avatar
Elliot Lee committed
883 884 885 886 887 888
      if (data.length < 0)
	{
	  ((GdkAtom *)mult_atoms)[2*i+1] = GDK_NONE;
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
889
      
Tim Janik's avatar
GLib:  
Tim Janik committed
890
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
891
      
Elliot Lee's avatar
Elliot Lee committed
892
      items = (data.length + data.format/8 - 1) / (data.format/8);
893
      
Elliot Lee's avatar
Elliot Lee committed
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
      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;
912
	  
Elliot Lee's avatar
Elliot Lee committed
913 914 915 916 917 918
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
919
	  
Elliot Lee's avatar
Elliot Lee committed
920 921 922
	  g_free (data.data);
	}
    }
923
  
Elliot Lee's avatar
Elliot Lee committed
924 925
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
926
  
Elliot Lee's avatar
Elliot Lee committed
927 928 929 930
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
931
      
Elliot Lee's avatar
Elliot Lee committed
932
#ifdef DEBUG_SELECTION
933
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
934
#endif
935
      
Elliot Lee's avatar
Elliot Lee committed
936 937 938 939 940 941
      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);
    }
942
  
Elliot Lee's avatar
Elliot Lee committed
943 944 945 946 947 948 949
  /* 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,
950
			   mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
951 952
      g_free (mult_atoms);
    }
953
  
Elliot Lee's avatar
Elliot Lee committed
954 955
  gdk_selection_send_notify (event->requestor, event->selection, event->target,
			     event->property, event->time);
956
  
Elliot Lee's avatar
Elliot Lee committed
957 958 959 960 961
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
962
  
Elliot Lee's avatar
Elliot Lee committed
963 964 965 966 967 968 969 970 971 972 973 974
  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:
975 976
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
977 978 979 980 981
 *
 *   results:
 *************************************************************/

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

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1095 1096
  gboolean retval;

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

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1137 1138 1139 1140 1141 1142 1143 1144
}

/*************************************************************
 * 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:
1145 1146 1147
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1148 1149 1150 1151 1152
 *   results:
 *     was event handled?
 *************************************************************/

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

      info->notify_time = event->time;
Elliot Lee's avatar
Elliot Lee committed
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
      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);
1211
      
Elliot Lee's avatar
Elliot Lee committed
1212 1213 1214
      info->offset = length;
      gtk_selection_retrieval_report (info,
				      type, format, 
1215
				      buffer, length, event->time);
Elliot Lee's avatar
Elliot Lee committed
1216
    }
1217
  
Elliot Lee's avatar
Elliot Lee committed
1218
  gdk_property_delete (widget->window, event->property);
1219
  
Elliot Lee's avatar
Elliot Lee committed
1220
  g_free (buffer);
1221
  
Elliot Lee's avatar
Elliot Lee committed
1222 1223 1224 1225 1226 1227 1228 1229 1230
  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:
1231 1232 1233
 *     widget:		Widget getting signal
 *     event:		Property event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1234 1235 1236 1237 1238
 *   results:
 *     was event handled?
 *************************************************************/

gint
1239
gtk_selection_property_notify (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1240 1241 1242 1243 1244 1245 1246
			       GdkEventProperty *event)
{
  GList *tmp_list;
  GtkRetrievalInfo *info;
  guchar *new_buffer;
  int length;
  GdkAtom type;
1247
  gint	  format;
1248
  
Elliot Lee's avatar
Elliot Lee committed
1249 1250 1251
  if ((event->state != GDK_PROPERTY_NEW_VALUE) ||  /* property was deleted */
      (event->atom != gdk_selection_property)) /* not the right property */
    return FALSE;
1252
  
Elliot Lee's avatar
Elliot Lee committed
1253
#ifdef DEBUG_SELECTION
1254 1255
  g_message ("PropertyNewValue, property %ld",
	     event->atom);
Elliot Lee's avatar
Elliot Lee committed
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	break;
      tmp_list = tmp_list->next;
    }
1266
  
Elliot Lee's avatar
Elliot Lee committed
1267 1268
  if (!tmp_list)		/* No retrieval in progress */
    return FALSE;
1269
  
Elliot Lee's avatar
Elliot Lee committed
1270 1271 1272
  if (info->offset < 0)		/* We haven't got the SelectionNotify
				   for this retrieval yet */
    return FALSE;
1273
  
Elliot Lee's avatar
Elliot Lee committed
1274 1275 1276 1277 1278
  info->idle_time = 0;
  
  length = gdk_selection_property_get (widget->window, &new_buffer, 
				       &type, &format);
  gdk_property_delete (widget->window, event->atom);
1279
  
Elliot Lee's avatar
Elliot Lee committed
1280 1281 1282 1283
  /* 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!) */
1284
  
Elliot Lee's avatar
Elliot Lee committed
1285 1286 1287 1288 1289 1290 1291 1292
  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,
1293 1294
				      (type == GDK_NONE) ?  -1 : info->offset,
				      info->notify_time);
Elliot Lee's avatar
Elliot Lee committed
1295 1296 1297 1298 1299 1300
    }
  else				/* append on newly arrived data */
    {
      if (!info->buffer)
	{
#ifdef DEBUG_SELECTION
1301 1302
	  g_message ("Start - Adding %d bytes at offset 0",
		     length);
Elliot Lee's avatar
Elliot Lee committed
1303 1304 1305 1306 1307 1308
#endif
	  info->buffer = new_buffer;
	  info->offset = length;
	}
      else
	{
1309
	  
Elliot Lee's avatar
Elliot Lee committed
1310
#ifdef DEBUG_SELECTION
1311 1312
	  g_message ("Appending %d bytes at offset %d",
		     length,info->offset);
Elliot Lee's avatar
Elliot Lee committed
1313 1314 1315 1316 1317 1318 1319 1320
#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);
	}
    }
1321
  
Elliot Lee's avatar
Elliot Lee committed
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
  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;
1337 1338
  gboolean retval;

1339
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1340 1341 1342
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1343
  
Elliot Lee's avatar
Elliot Lee committed
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
  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);
1359
	  gtk_selection_retrieval_report (info, GDK_NONE, 0, NULL, -1, GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
1360 1361 1362 1363 1364
	}
      
      g_free (info->buffer);
      g_free (info);
      
1365
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1366 1367 1368 1369 1370
    }
  else
    {
      info->idle_time++;
      
1371
      retval =  TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1372
    }
1373

1374
  GDK_THREADS_LEAVE ();
1375 1376

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1377 1378 1379 1380 1381 1382
}

/*************************************************************
 * gtk_selection_retrieval_report:
 *     Emits a "selection_received" signal.
 *   arguments:
1383 1384
 *     info:	  information about the retrieval that completed
 *     buffer:	  buffer containing data (NULL => errror)
1385
 *     time:      timestamp for data in buffer
Elliot Lee's avatar
Elliot Lee committed
1386 1387 1388 1389 1390 1391
 *   results:
 *************************************************************/

static void
gtk_selection_retrieval_report (GtkRetrievalInfo *info,
				GdkAtom type, gint format, 
1392 1393
				guchar *buffer, gint length,
				guint32 time)
Elliot Lee's avatar
Elliot Lee committed
1394 1395
{
  GtkSelectionData data;
1396
  
Elliot Lee's avatar
Elliot Lee committed
1397 1398 1399 1400
  data.selection = info->selection;
  data.target = info->target;
  data.type = type;
  data.format = format;
1401
  
Elliot Lee's avatar
Elliot Lee committed
1402 1403
  data.length = length;
  data.data = buffer;
1404
  
Elliot Lee's avatar
Elliot Lee committed
1405
  gtk_signal_emit_by_name (GTK_OBJECT(info->widget),
1406 1407
			   "selection_received", 
			   &data, time);
Elliot Lee's avatar
Elliot Lee committed
1408 1409 1410
}

/*************************************************************
1411 1412 1413 1414 1415
 * 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
1416
 *   arguments:
1417 1418
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1419
 *     time:        time from requeset
1420
 *     
Elliot Lee's avatar
Elliot Lee committed
1421
 *   results:
1422
 *     Number of bytes written to buffer, -1 if error
Elliot Lee's avatar
Elliot Lee committed
1423 1424
 *************************************************************/

1425
static void
1426
gtk_selection_invoke_handler (GtkWidget	       *widget,
1427 1428
			      GtkSelectionData *data,
			      guint             time)
Elliot Lee's avatar
Elliot Lee committed
1429
{
1430 1431
  GtkTargetList *target_list;
  guint info;
1432
  
1433

1434
  g_return_if_fail (widget != NULL);
1435 1436 1437 1438

  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
1439
    {
1440 1441 1442 1443
      gtk_signal_emit_by_name (GTK_OBJECT (widget), 
			       "selection_get",
			       data,
			       info, time);
Elliot Lee's avatar
Elliot Lee committed
1444
    }
1445
  else
1446
    gtk_selection_default_handler (widget, data);
Elliot Lee's avatar
Elliot Lee committed
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
}

/*************************************************************
 * 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:
1457 1458
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1459
 *
Elliot Lee's avatar
Elliot Lee committed
1460 1461 1462
 *************************************************************/

static void
1463
gtk_selection_default_handler (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
			       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;
	    }
1486
	  
Elliot Lee's avatar
Elliot Lee committed
1487 1488
	  tmp_list = tmp_list->next;
	}
1489
      
Elliot Lee's avatar
Elliot Lee committed
1490 1491 1492 1493 1494 1495 1496 1497
      data->length = -1;
    }
  else if (data->target == gtk_selection_atoms[TARGETS])
    {
      /* List of all targets supported for this widget/selection pair */
      GdkAtom *p;
      gint count;
      GList *tmp_list;
1498 1499
      GtkTargetList *target_list;
      GtkTargetPair *pair;
1500
      
Elliot Lee's avatar
Elliot Lee committed
1501
      count = 3;
1502 1503 1504
      target_list = gtk_selection_target_list_get (widget,
						   data->selection);
      tmp_list = target_list->list;
Elliot Lee's avatar
Elliot Lee committed
1505 1506
      while (tmp_list)
	{
1507
	  count++;
Elliot Lee's avatar
Elliot Lee committed
1508 1509
	  tmp_list = tmp_list->next;
	}
1510
      
Elliot Lee's avatar
Elliot Lee committed
1511 1512 1513
      data->type = GDK_SELECTION_TYPE_ATOM;
      data->format = 8*sizeof (GdkAtom);
      data->length = count*sizeof (GdkAtom);
1514
      
Elliot Lee's avatar
Elliot Lee committed
1515 1516
      p = g_new (GdkAtom, count);
      data->data = (guchar *)p;
1517
      
Elliot Lee's avatar
Elliot Lee committed
1518 1519 1520
      *p++ = gtk_selection_atoms[TIMESTAMP];
      *p++ = gtk_selection_atoms[TARGETS];
      *p++ = gtk_selection_atoms[MULTIPLE];
1521
      
1522
      tmp_list = target_list->list;
Elliot Lee's avatar
Elliot Lee committed
1523 1524
      while (tmp_list)
	{
1525 1526
	  pair = (GtkTargetPair *)tmp_list->data;
	  *p++ = pair->target;
1527
	  
Elliot Lee's avatar
Elliot Lee committed
1528 1529 1530 1531 1532 1533 1534 1535
	  tmp_list = tmp_list->next;
	}
    }
  else
    {
      data->length = -1;
    }
}
1536 1537 1538 1539 1540 1541


GtkSelectioData*
gtk_selection_data_copy (GtkSelectionData *data)
{
  GtkSelectionData *new_data;
1542
  
1543
  g_return_val_if_fail (data != NULL, NULL);
1544
  
1545 1546
  new_data = g_new (GtkSelectionData, 1);
  *new_data = *data;
1547
  
1548 1549 1550 1551 1552 1553 1554
  return new_data;
}

void
gtk_selection_data_free (GtkSelectionData *data)
{
  g_return_if_fail (data != NULL);
1555
  
1556 1557
  g_free (data);
}