gtkselection.c 38.7 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 83
#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;
typedef struct _GtkSelectionHandler GtkSelectionHandler;

struct _GtkSelectionInfo
{
  GdkAtom    selection;
  GtkWidget *widget;		/* widget that owns selection */
  guint32    time;		/* time used to acquire selection */
};

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

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

struct _GtkSelectionHandler
{
  GdkAtom selection;		/* selection thats handled */
  GdkAtom target;		/* target thats handled */
  GtkSelectionFunction function; /* callback function */
127
  GtkCallbackMarshal marshal;	 /* Marshalling function */
Elliot Lee's avatar
Elliot Lee committed
128
  gpointer data;		 /* callback data */
129
  GtkDestroyNotify destroy;	 /* called when callback is removed */
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 138
						  GdkAtom type, gint format, 
						  guchar *buffer, gint length);
139
static void gtk_selection_invoke_handler	 (GtkWidget	   *widget,
140
						  GtkSelectionData *data);
141
static void gtk_selection_default_handler	 (GtkWidget	  *widget,
Elliot Lee's avatar
Elliot Lee committed
142 143 144 145 146 147 148 149 150
						  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
151
static const char *gtk_selection_handler_key = "gtk-selection-handlers";
Elliot Lee's avatar
Elliot Lee committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172

/*************************************************************
 * 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;
173
  
Elliot Lee's avatar
Elliot Lee committed
174 175 176 177 178 179 180 181 182
  if (widget == NULL)
    window = NULL;
  else
    {
      if (!GTK_WIDGET_REALIZED (widget))
	gtk_widget_realize (widget);
      
      window = widget->window;
    }
183
  
Elliot Lee's avatar
Elliot Lee committed
184 185 186 187 188 189 190 191 192 193
  tmp_list = current_selections;
  while (tmp_list)
    {
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->selection == selection)
	break;
      
      tmp_list = tmp_list->next;
    }
194
  
Elliot Lee's avatar
Elliot Lee committed
195 196 197 198 199
  if (tmp_list == NULL)
    selection_info = NULL;
  else
    if (selection_info->widget == widget)
      return TRUE;
200
  
Elliot Lee's avatar
Elliot Lee committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 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
  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;
245
	  
246
	  gtk_widget_event (old_owner, (GdkEvent *) &event);
Elliot Lee's avatar
Elliot Lee committed
247 248 249 250 251 252 253 254
	}
      return TRUE;
    }
  else
    return FALSE;
}

/*************************************************************
255
 * gtk_selection_add_handler_full:
Elliot Lee's avatar
Elliot Lee committed
256 257 258
 *     Add a handler for a specified selection/target pair
 *
 *   arguments:
259
 *     widget:	   The widget the handler applies to
Elliot Lee's avatar
Elliot Lee committed
260 261
 *     selection:
 *     target:
262
 *     format:	   Format in which this handler will return data
Elliot Lee's avatar
Elliot Lee committed
263
 *     function:   Callback function (can be NULL)
264 265 266
 *     marshal:	   Callback marshal function
 *     data:	   User data for callback
 *     destroy:	   Called when handler removed
Elliot Lee's avatar
Elliot Lee committed
267 268 269 270 271
 *
 *   results:
 *************************************************************/

void
272 273 274
gtk_selection_add_handler (GtkWidget	       *widget, 
			   GdkAtom		selection,
			   GdkAtom		target,
Elliot Lee's avatar
Elliot Lee committed
275
			   GtkSelectionFunction function,
276
			   gpointer		data)
277 278 279 280 281 282
{
  gtk_selection_add_handler_full (widget, selection, target, function,
				  NULL, data, NULL);
}

void 
283 284 285
gtk_selection_add_handler_full (GtkWidget	    *widget, 
				GdkAtom		     selection,
				GdkAtom		     target,
286 287
				GtkSelectionFunction function,
				GtkCallbackMarshal   marshal,
288
				gpointer	     data,
289
				GtkDestroyNotify     destroy)
Elliot Lee's avatar
Elliot Lee committed
290 291 292 293
{
  GList *selection_handlers;
  GList *tmp_list;
  GtkSelectionHandler *handler;
294
  
Elliot Lee's avatar
Elliot Lee committed
295 296 297 298 299 300
  g_return_if_fail (widget != NULL);
  if (initialize)
    gtk_selection_init ();
  
  selection_handlers = gtk_object_get_data (GTK_OBJECT (widget),
					    gtk_selection_handler_key);
301
  
Elliot Lee's avatar
Elliot Lee committed
302 303 304 305 306 307 308
  /* Reuse old handler structure, if present */
  tmp_list = selection_handlers;
  while (tmp_list)
    {
      handler = (GtkSelectionHandler *)tmp_list->data;
      if ((handler->selection == selection) && (handler->target == target))
	{
309 310
	  if (handler->destroy)
	    (*handler->destroy)(handler->data);
Elliot Lee's avatar
Elliot Lee committed
311 312 313
	  if (function)
	    {
	      handler->function = function;
314
	      handler->marshal = marshal;
Elliot Lee's avatar
Elliot Lee committed
315
	      handler->data = data;
316
	      handler->destroy = destroy;
Elliot Lee's avatar
Elliot Lee committed
317 318 319 320 321 322 323 324 325 326 327 328
	    }
	  else
	    {
	      selection_handlers = g_list_remove_link (selection_handlers, 
						       tmp_list);
	      g_list_free (tmp_list);
	      g_free (handler);
	    }
	  return;
	}
      tmp_list = tmp_list->next;
    }
329
  
Elliot Lee's avatar
Elliot Lee committed
330 331 332 333 334 335
  if (tmp_list == NULL && function)
    {
      handler = g_new (GtkSelectionHandler, 1);
      handler->selection = selection;
      handler->target = target;
      handler->function = function;
336
      handler->marshal = marshal;
Elliot Lee's avatar
Elliot Lee committed
337
      handler->data = data;
338
      handler->destroy = destroy;
Elliot Lee's avatar
Elliot Lee committed
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
      selection_handlers = g_list_append (selection_handlers, handler);
    }
  
  gtk_object_set_data (GTK_OBJECT (widget), gtk_selection_handler_key,
		       selection_handlers);
}

/*************************************************************
 * 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;
  GList *selection_handlers;
  GtkSelectionHandler *handler;
365
  
Elliot Lee's avatar
Elliot Lee committed
366
  /* Remove pending requests/incrs for this widget */
367
  
Elliot Lee's avatar
Elliot Lee committed
368 369 370 371 372 373 374 375 376 377 378 379
  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;
    }
380
  
Elliot Lee's avatar
Elliot Lee committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  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 */
396
  
Elliot Lee's avatar
Elliot Lee committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  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;
    }
416
  
Elliot Lee's avatar
Elliot Lee committed
417
  /* Now remove all handlers */
418
  
Elliot Lee's avatar
Elliot Lee committed
419 420
  selection_handlers = gtk_object_get_data (GTK_OBJECT (widget),
					    gtk_selection_handler_key);
421
  gtk_object_remove_data (GTK_OBJECT (widget), gtk_selection_handler_key);
422
  
Elliot Lee's avatar
Elliot Lee committed
423 424 425 426 427
  tmp_list = selection_handlers;
  while (tmp_list)
    {
      next = tmp_list->next;
      handler = (GtkSelectionHandler *)tmp_list->data;
428
      
429 430
      if (handler->destroy)
	(*handler->destroy)(handler->data);
431
      
Elliot Lee's avatar
Elliot Lee committed
432
      g_free (handler);
433
      
Elliot Lee's avatar
Elliot Lee committed
434 435
      tmp_list = next;
    }
436
  
Elliot Lee's avatar
Elliot Lee committed
437 438 439 440 441 442 443 444 445
  g_list_free (selection_handlers);
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
446
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
447
 *     selection:  Which selection to get
448 449 450
 *     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
451 452 453 454 455 456 457 458 459
 *
 *   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, 
460 461 462
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
463 464 465 466
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
467
  
Elliot Lee's avatar
Elliot Lee committed
468
  g_return_val_if_fail (widget != NULL, FALSE);
469
  
Elliot Lee's avatar
Elliot Lee committed
470 471 472 473 474
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
475
  
Elliot Lee's avatar
Elliot Lee committed
476 477 478 479 480
  /* 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. */
481
  
Elliot Lee's avatar
Elliot Lee committed
482 483 484 485 486 487 488 489
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
490
  
Elliot Lee's avatar
Elliot Lee committed
491
  info = g_new (GtkRetrievalInfo, 1);
492
  
Elliot Lee's avatar
Elliot Lee committed
493 494 495 496 497
  info->widget = widget;
  info->selection = selection;
  info->target = target;
  info->buffer = NULL;
  info->offset = -1;
498
  
Elliot Lee's avatar
Elliot Lee committed
499 500
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
501
  
Elliot Lee's avatar
Elliot Lee committed
502 503 504 505 506 507
  owner_window = gdk_selection_owner_get (selection);
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
508
      
Elliot Lee's avatar
Elliot Lee committed
509 510 511 512
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
513
      
Elliot Lee's avatar
Elliot Lee committed
514
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
515
      
Elliot Lee's avatar
Elliot Lee committed
516 517
      if (owner_widget != NULL)
	{
518 519
	  gtk_selection_invoke_handler (owner_widget, 
					&selection_data);
520
	  
Elliot Lee's avatar
Elliot Lee committed
521 522 523 524 525
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
					  selection_data.length);
526
	  
Elliot Lee's avatar
Elliot Lee committed
527 528 529 530 531 532 533 534
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
535
  
Elliot Lee's avatar
Elliot Lee committed
536 537 538
  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);
539
  
Elliot Lee's avatar
Elliot Lee committed
540 541 542 543 544 545 546 547 548 549
  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
550 551 552
 *     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
553 554 555 556 557
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
558 559 560 561
			GdkAtom		  type,
			gint		  format,
			guchar		 *data,
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
562 563 564
{
  if (selection_data->data)
    g_free (selection_data->data);
565
  
Elliot Lee's avatar
Elliot Lee committed
566 567
  selection_data->type = type;
  selection_data->format = format;
568
  
Elliot Lee's avatar
Elliot Lee committed
569 570 571 572 573 574 575 576
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
    selection_data->data = NULL;
577
  
Elliot Lee's avatar
Elliot Lee committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
  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. */
617
  
Elliot Lee's avatar
Elliot Lee committed
618 619
  GList *tmp_list;
  GtkSelectionInfo *selection_info;
620
  
Elliot Lee's avatar
Elliot Lee committed
621 622 623 624 625 626 627 628 629 630 631
  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;
    }
632
  
633 634 635 636
  if (tmp_list)
    {
      if (selection_info->time > event->time)
	return FALSE;		/* return FALSE to indicate that
637 638
				 * the selection was out of date,
				 * and this clear should be ignored */
639 640 641 642 643 644 645 646
      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
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
  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;
668
  
Elliot Lee's avatar
Elliot Lee committed
669
  /* Check if we own selection */
670
  
Elliot Lee's avatar
Elliot Lee committed
671 672 673 674
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
675
      
Elliot Lee's avatar
Elliot Lee committed
676 677 678
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
679
      
Elliot Lee's avatar
Elliot Lee committed
680 681
      tmp_list = tmp_list->next;
    }
682
  
Elliot Lee's avatar
Elliot Lee committed
683 684 685 686
  if (tmp_list == NULL)
    return FALSE;
  
  info = g_new(GtkIncrInfo, 1);
687
  
Elliot Lee's avatar
Elliot Lee committed
688 689 690
  info->widget = widget;
  info->selection = event->selection;
  info->num_incrs = 0;
691
  
Elliot Lee's avatar
Elliot Lee committed
692
  /* Create GdkWindow structure for the requestor */
693
  
Elliot Lee's avatar
Elliot Lee committed
694 695 696 697 698
  info->requestor = gdk_window_lookup (event->requestor);
  if (!info->requestor)
    info->requestor = gdk_window_foreign_new (event->requestor);
  
  /* Determine conversions we need to perform */
699
  
Elliot Lee's avatar
Elliot Lee committed
700 701 702 703 704
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
      gint     format;
      gint     length;
705
      
Elliot Lee's avatar
Elliot Lee committed
706 707 708 709
      mult_atoms = NULL;
      if (!gdk_property_get (info->requestor, event->property, GDK_SELECTION_TYPE_ATOM,
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
			     &type, &format, &length, &mult_atoms) ||
710
	  type != GDK_SELECTION_TYPE_ATOM || format != 8*sizeof(GdkAtom))
Elliot Lee's avatar
Elliot Lee committed
711 712 713 714 715 716 717
	{
	  gdk_selection_send_notify (event->requestor, event->selection,
				     event->target, GDK_NONE, event->time);
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
718
      
Elliot Lee's avatar
Elliot Lee committed
719 720
      info->num_conversions = length / (2*sizeof (GdkAtom));
      info->conversions = g_new (GtkIncrConversion, info->num_conversions);
721
      
Elliot Lee's avatar
Elliot Lee committed
722 723 724 725 726 727 728 729 730 731 732 733 734 735
      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;
    }
736
  
Elliot Lee's avatar
Elliot Lee committed
737 738 739 740 741 742
  /* 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;
743
      
Elliot Lee's avatar
Elliot Lee committed
744 745 746 747
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
748
      
Elliot Lee's avatar
Elliot Lee committed
749
#ifdef DEBUG_SELECTION
750 751 752 753
      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
754
#endif
755
      
756
      gtk_selection_invoke_handler (widget, &data);
757
      
Elliot Lee's avatar
Elliot Lee committed
758 759 760 761 762 763
      if (data.length < 0)
	{
	  ((GdkAtom *)mult_atoms)[2*i+1] = GDK_NONE;
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
764
      
Tim Janik's avatar
GLib:  
Tim Janik committed
765
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
766
      
Elliot Lee's avatar
Elliot Lee committed
767
      items = (data.length + data.format/8 - 1) / (data.format/8);
768
      
Elliot Lee's avatar
Elliot Lee committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
      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;
787
	  
Elliot Lee's avatar
Elliot Lee committed
788 789 790 791 792 793
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
794
	  
Elliot Lee's avatar
Elliot Lee committed
795 796 797
	  g_free (data.data);
	}
    }
798
  
Elliot Lee's avatar
Elliot Lee committed
799 800
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
801
  
Elliot Lee's avatar
Elliot Lee committed
802 803 804 805
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
806
      
Elliot Lee's avatar
Elliot Lee committed
807
#ifdef DEBUG_SELECTION
808
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
809
#endif
810
      
Elliot Lee's avatar
Elliot Lee committed
811 812 813 814 815 816
      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);
    }
817
  
Elliot Lee's avatar
Elliot Lee committed
818 819 820 821 822 823 824 825 826 827
  /* 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,
			   mult_atoms, info->num_conversions);
      g_free (mult_atoms);
    }
828
  
Elliot Lee's avatar
Elliot Lee committed
829 830
  gdk_selection_send_notify (event->requestor, event->selection, event->target,
			     event->property, event->time);
831
  
Elliot Lee's avatar
Elliot Lee committed
832 833 834 835 836
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
837
  
Elliot Lee's avatar
Elliot Lee committed
838 839 840 841 842 843 844 845 846 847 848 849
  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:
850 851
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
852 853 854 855 856
 *
 *   results:
 *************************************************************/

gint
857
gtk_selection_incr_event (GdkWindow	   *window,
Elliot Lee's avatar
Elliot Lee committed
858 859 860 861 862 863
			  GdkEventProperty *event)
{
  GList *tmp_list;
  GtkIncrInfo *info;
  gint num_bytes;
  guchar *buffer;
864
  
Elliot Lee's avatar
Elliot Lee committed
865 866 867 868
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
869
  
Elliot Lee's avatar
Elliot Lee committed
870
#ifdef DEBUG_SELECTION
871
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
872
#endif
873
  
Elliot Lee's avatar
Elliot Lee committed
874 875 876 877 878 879 880 881 882 883
  /* 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;
    }
884
  
Elliot Lee's avatar
Elliot Lee committed
885 886
  if (tmp_list == NULL)
    return FALSE;
887
  
Elliot Lee's avatar
Elliot Lee committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
  /* 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;
908
	      
Elliot Lee's avatar
Elliot Lee committed
909 910 911 912 913 914 915 916 917
	      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
918 919 920
	  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
921 922 923 924 925 926 927 928
#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));
929
	  
Elliot Lee's avatar
Elliot Lee committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943
	  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;
    }
944
  
Elliot Lee's avatar
Elliot Lee committed
945
  /* Check if we're finished with all the targets */
946
  
Elliot Lee's avatar
Elliot Lee committed
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
  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:
962
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
963 964 965 966 967 968 969 970 971 972
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
973
  
Elliot Lee's avatar
Elliot Lee committed
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
  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? */
994
      
Elliot Lee's avatar
Elliot Lee committed
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
      g_free (info);
      
      return FALSE;		/* remove timeout */
    }
  else
    {
      info->idle_time++;
      
      return TRUE;		/* timeout will happen again */
    }
}

/*************************************************************
 * 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:
1013 1014 1015
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1016 1017 1018 1019 1020
 *   results:
 *     was event handled?
 *************************************************************/

gint
1021
gtk_selection_notify (GtkWidget	       *widget,
Elliot Lee's avatar
Elliot Lee committed
1022 1023 1024 1025 1026 1027 1028
		      GdkEventSelection *event)
{
  GList *tmp_list;
  GtkRetrievalInfo *info;
  guchar  *buffer;
  gint length;
  GdkAtom type;
1029
  gint	  format;
Elliot Lee's avatar
Elliot Lee committed
1030 1031
  
#ifdef DEBUG_SELECTION
1032 1033
  g_message ("Initial receipt of selection %ld, target %ld (property = %ld)",
	     event->selection, event->target, event->property);
Elliot Lee's avatar
Elliot Lee committed
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
#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;
    }
1044
  
Elliot Lee's avatar
Elliot Lee committed
1045 1046
  if (!tmp_list)		/* no retrieval in progress */
    return FALSE;
1047
  
Elliot Lee's avatar
Elliot Lee committed
1048 1049 1050 1051 1052 1053 1054
  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,
				      GDK_NONE, 0, NULL, -1);
1055
      
Elliot Lee's avatar
Elliot Lee committed
1056 1057 1058 1059 1060
      return TRUE;
    }
  
  length = gdk_selection_property_get (widget->window, &buffer, 
				       &type, &format);
1061
  
Elliot Lee's avatar
Elliot Lee committed
1062 1063 1064 1065
  if (type == gtk_selection_atoms[INCR])
    {
      /* The remainder of the selection will come through PropertyNotify
	 events */
1066
      
Elliot Lee's avatar
Elliot Lee committed
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
      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);
1078
      
Elliot Lee's avatar
Elliot Lee committed
1079 1080 1081 1082 1083
      info->offset = length;
      gtk_selection_retrieval_report (info,
				      type, format, 
				      buffer, length);
    }
1084
  
Elliot Lee's avatar
Elliot Lee committed
1085
  gdk_property_delete (widget->window, event->property);
1086
  
Elliot Lee's avatar
Elliot Lee committed
1087
  g_free (buffer);
1088
  
Elliot Lee's avatar
Elliot Lee committed
1089 1090 1091 1092 1093 1094 1095 1096 1097
  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:
1098 1099 1100
 *     widget:		Widget getting signal
 *     event:		Property event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1101 1102 1103 1104 1105
 *   results:
 *     was event handled?
 *************************************************************/

gint
1106
gtk_selection_property_notify (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1107 1108 1109 1110 1111 1112 1113
			       GdkEventProperty *event)
{
  GList *tmp_list;
  GtkRetrievalInfo *info;
  guchar *new_buffer;
  int length;
  GdkAtom type;
1114
  gint	  format;
1115
  
Elliot Lee's avatar
Elliot Lee committed
1116 1117 1118
  if ((event->state != GDK_PROPERTY_NEW_VALUE) ||  /* property was deleted */
      (event->atom != gdk_selection_property)) /* not the right property */
    return FALSE;
1119
  
Elliot Lee's avatar
Elliot Lee committed
1120
#ifdef DEBUG_SELECTION
1121 1122
  g_message ("PropertyNewValue, property %ld",
	     event->atom);
Elliot Lee's avatar
Elliot Lee committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	break;
      tmp_list = tmp_list->next;
    }
1133
  
Elliot Lee's avatar
Elliot Lee committed
1134 1135
  if (!tmp_list)		/* No retrieval in progress */
    return FALSE;
1136
  
Elliot Lee's avatar
Elliot Lee committed
1137 1138 1139
  if (info->offset < 0)		/* We haven't got the SelectionNotify
				   for this retrieval yet */
    return FALSE;
1140
  
Elliot Lee's avatar
Elliot Lee committed
1141 1142 1143 1144 1145
  info->idle_time = 0;
  
  length = gdk_selection_property_get (widget->window, &new_buffer, 
				       &type, &format);
  gdk_property_delete (widget->window, event->atom);
1146
  
Elliot Lee's avatar
Elliot Lee committed
1147 1148 1149 1150
  /* 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!) */
1151
  
Elliot Lee's avatar
Elliot Lee committed
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
  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,
				      (type == GDK_NONE) ?  -1 : info->offset);
    }
  else				/* append on newly arrived data */
    {
      if (!info->buffer)
	{
#ifdef DEBUG_SELECTION
1167 1168
	  g_message ("Start - Adding %d bytes at offset 0",
		     length);
Elliot Lee's avatar
Elliot Lee committed
1169 1170 1171 1172 1173 1174
#endif
	  info->buffer = new_buffer;
	  info->offset = length;
	}
      else
	{
1175
	  
Elliot Lee's avatar
Elliot Lee committed
1176
#ifdef DEBUG_SELECTION
1177 1178
	  g_message ("Appending %d bytes at offset %d",
		     length,info->offset);
Elliot Lee's avatar
Elliot Lee committed
1179 1180 1181 1182 1183 1184 1185 1186
#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);
	}
    }
1187
  
Elliot Lee's avatar
Elliot Lee committed
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
  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;
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1206
  
Elliot Lee's avatar
Elliot Lee committed
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
  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);
	  gtk_selection_retrieval_report (info, GDK_NONE, 0, NULL, -1);
	}
      
      g_free (info->buffer);
      g_free (info);
      
      return FALSE;		/* remove timeout */
    }
  else
    {
      info->idle_time++;
      
      return TRUE;		/* timeout will happen again */
    }
1236
  
Elliot Lee's avatar
Elliot Lee committed
1237 1238 1239 1240 1241 1242
}

/*************************************************************
 * gtk_selection_retrieval_report:
 *     Emits a "selection_received" signal.
 *   arguments:
1243 1244
 *     info:	  information about the retrieval that completed
 *     buffer:	  buffer containing data (NULL => errror)
Elliot Lee's avatar
Elliot Lee committed
1245 1246 1247 1248 1249 1250 1251 1252 1253
 *   results:
 *************************************************************/

static void
gtk_selection_retrieval_report (GtkRetrievalInfo *info,
				GdkAtom type, gint format, 
				guchar *buffer, gint length)
{
  GtkSelectionData data;
1254
  
Elliot Lee's avatar
Elliot Lee committed
1255 1256 1257 1258
  data.selection = info->selection;
  data.target = info->target;
  data.type = type;
  data.format = format;
1259
  
Elliot Lee's avatar
Elliot Lee committed
1260 1261
  data.length = length;
  data.data = buffer;
1262
  
Elliot Lee's avatar
Elliot Lee committed
1263 1264 1265 1266 1267
  gtk_signal_emit_by_name (GTK_OBJECT(info->widget),
			   "selection_received", &data);
}

/*************************************************************
1268 1269 1270 1271 1272
 * 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
1273
 *   arguments:
1274 1275
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1276
 *     
Elliot Lee's avatar
Elliot Lee committed
1277
 *   results:
1278
 *     Number of bytes written to buffer, -1 if error
Elliot Lee's avatar
Elliot Lee committed
1279 1280
 *************************************************************/

1281
static void
1282
gtk_selection_invoke_handler (GtkWidget	       *widget,
1283
			      GtkSelectionData *data)
Elliot Lee's avatar
Elliot Lee committed
1284 1285 1286
{
  GList *tmp_list;
  GtkSelectionHandler *handler;
1287
  
1288
  g_return_if_fail (widget != NULL);
Elliot Lee's avatar
Elliot Lee committed
1289 1290 1291
  
  tmp_list = gtk_object_get_data (GTK_OBJECT (widget),
				  gtk_selection_handler_key);
1292
  
Elliot Lee's avatar
Elliot Lee committed
1293 1294 1295
  while (tmp_list)
    {
      handler = (GtkSelectionHandler *)tmp_list->data;
1296 1297 1298
      if ((handler->selection == data->selection) && 
	  (handler->target == data->target))
	break;
Elliot Lee's avatar
Elliot Lee committed
1299 1300
      tmp_list = tmp_list->next;
    }
1301
  
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
  if (tmp_list == NULL)
    gtk_selection_default_handler (widget, data);
  else
    {
      if (handler->marshal)
	{
	  GtkArg args[2];
	  args[0].type = GTK_TYPE_BOXED;
	  args[0].name = NULL;
	  GTK_VALUE_BOXED(args[0]) = data;
	  args[1].type = GTK_TYPE_NONE;
	  args[1].name = NULL;
1314
	  
1315 1316 1317 1318 1319 1320
	  handler->marshal (GTK_OBJECT(widget), handler->data, 1, args);
	}
      else
	if (handler->function)
	  handler->function (widget, data, handler->data);
    }
Elliot Lee's avatar
Elliot Lee committed
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
}

/*************************************************************
 * 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:
1331 1332
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1333
 *
Elliot Lee's avatar
Elliot Lee committed
1334 1335 1336
 *************************************************************/

static void
1337
gtk_selection_default_handler (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
			       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;
	    }
1360
	  
Elliot Lee's avatar
Elliot Lee committed
1361 1362
	  tmp_list = tmp_list->next;
	}
1363
      
Elliot Lee's avatar
Elliot Lee committed
1364 1365 1366 1367 1368 1369 1370 1371 1372
      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;
      GtkSelectionHandler *handler;
1373
      
Elliot Lee's avatar
Elliot Lee committed
1374 1375 1376 1377 1378 1379
      count = 3;
      tmp_list = gtk_object_get_data (GTK_OBJECT(widget),
				      gtk_selection_handler_key);
      while (tmp_list)
	{
	  handler = (GtkSelectionHandler *)tmp_list->data;
1380
	  
Elliot Lee's avatar
Elliot Lee committed
1381 1382 1383 1384 1385
	  if (handler->selection == data->selection)
	    count++;
	  
	  tmp_list = tmp_list->next;
	}
1386
      
Elliot Lee's avatar
Elliot Lee committed
1387 1388 1389
      data->type = GDK_SELECTION_TYPE_ATOM;
      data->format = 8*sizeof (GdkAtom);
      data->length = count*sizeof (GdkAtom);
1390
      
Elliot Lee's avatar
Elliot Lee committed
1391 1392
      p = g_new (GdkAtom, count);
      data->data = (guchar *)p;
1393
      
Elliot Lee's avatar
Elliot Lee committed
1394 1395 1396
      *p++ = gtk_selection_atoms[TIMESTAMP];
      *p++ = gtk_selection_atoms[TARGETS];
      *p++ = gtk_selection_atoms[MULTIPLE];
1397
      
Elliot Lee's avatar
Elliot Lee committed
1398 1399 1400 1401 1402
      tmp_list = gtk_object_get_data (GTK_OBJECT(widget),
				      gtk_selection_handler_key);
      while (tmp_list)
	{
	  handler = (GtkSelectionHandler *)tmp_list->data;
1403
	  
Elliot Lee's avatar
Elliot Lee committed
1404 1405
	  if (handler->selection == data->selection)
	    *p++ = handler->target;
1406
	  
Elliot Lee's avatar
Elliot Lee committed
1407 1408 1409 1410 1411 1412 1413 1414
	  tmp_list = tmp_list->next;
	}
    }
  else
    {
      data->length = -1;
    }
}
1415 1416 1417 1418 1419 1420


GtkSelectioData*
gtk_selection_data_copy (GtkSelectionData *data)
{
  GtkSelectionData *new_data;
1421
  
1422
  g_return_val_if_fail (data != NULL, NULL);
1423
  
1424 1425
  new_data = g_new (GtkSelectionData, 1);
  *new_data = *data;
1426
  
1427 1428 1429 1430 1431 1432 1433
  return new_data;
}

void
gtk_selection_data_free (GtkSelectionData *data)
{
  g_return_if_fail (data != NULL);
1434
  
1435 1436
  g_free (data);
}