gtkselection.c 45.4 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18 19 20 21 22 23 24 25 26 27 28 29 30
 */

/* This file implements most of the work of the ICCM selection protocol.
 * The code was written after an intensive study of the equivalent part
 * of John Ousterhout's Tk toolkit, and does many things in much the 
 * same way.
 *
 * The one thing in the ICCM that isn't fully supported here (or in Tk)
 * is side effects targets. For these to be handled properly, MULTIPLE
 * targets need to be done in the order specified. This cannot be
 * guaranteed with the way we do things, since if we are doing INCR
 * transfers, the order will depend on the timing of the requestor.
 *
31
 * By Owen Taylor <owt1@cornell.edu>	      8/16/97
Elliot Lee's avatar
Elliot Lee committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
 */

/* Terminology note: when not otherwise specified, the term "incr" below
 * refers to the _sending_ part of the INCR protocol. The receiving
 * portion is referred to just as "retrieval". (Terminology borrowed
 * from Tk, because there is no good opposite to "retrieval" in English.
 * "send" can't be made into a noun gracefully and we're already using
 * "emission" for something else ....)
 */

/* The MOTIF entry widget seems to ask for the TARGETS target, then
   (regardless of the reply) ask for the TEXT target. It's slightly
   possible though that it somehow thinks we are responding negatively
   to the TARGETS request, though I don't really think so ... */

47
/*
48
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
49 50 51 52 53
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
54
#include <stdarg.h>
55
#include <string.h>
56 57 58 59 60 61
#include "gdk.h"

#if defined (GDK_WINDOWING_X11)
#include "x11/gdkx.h"		/* For gdk_window_lookup() */
#elif defined (GDK_WINDOWING_WIN32)
#include "win32/gdkwin32.h"	/* For gdk_window_lookup() */
62 63
#elif defined (GDK_WINDOWING_FB)
#include "linux-fb/gdkfb.h"	/* For gdk_window_lookup() */
64 65
#endif

Elliot Lee's avatar
Elliot Lee committed
66 67 68 69 70 71 72 73
#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 */
74
#ifdef GDK_WINDOWING_WIN32
75 76 77
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE G_MAXINT
#else
Elliot Lee's avatar
Elliot Lee committed
78
#define GTK_SELECTION_MAX_SIZE 4000
79
#endif
Elliot Lee's avatar
Elliot Lee committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
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 
{
102 103
  GdkAtom	    target;	/* Requested target */
  GdkAtom	    property;	/* Property to store in */
Elliot Lee's avatar
Elliot Lee committed
104
  GtkSelectionData  data;	/* The data being supplied */
105
  gint		    offset;	/* Current offset in sent selection.
Elliot Lee's avatar
Elliot Lee committed
106 107
				 *  -1 => All done
				 *  -2 => Only the final (empty) portion
108
				 *	  left to send */
Elliot Lee's avatar
Elliot Lee committed
109 110 111 112 113 114 115 116
};

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 */
117
  
Elliot Lee's avatar
Elliot Lee committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
  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 */
136
  gint	   offset;		/* Current offset in buffer, -1 indicates
Elliot Lee's avatar
Elliot Lee committed
137
				   not yet started */
138
  guint32 notify_time;		/* Timestamp from SelectionNotify */
Elliot Lee's avatar
Elliot Lee committed
139 140 141
};

/* Local Functions */
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
static void gtk_selection_init              (void);
static gint gtk_selection_incr_timeout      (GtkIncrInfo      *info);
static gint gtk_selection_retrieval_timeout (GtkRetrievalInfo *info);
static void gtk_selection_retrieval_report  (GtkRetrievalInfo *info,
					     GdkAtom           type,
					     gint              format,
					     guchar           *buffer,
					     gint              length,
					     guint32           time);
static void gtk_selection_invoke_handler    (GtkWidget        *widget,
					     GtkSelectionData *data,
					     guint             time);
static void gtk_selection_default_handler   (GtkWidget        *widget,
					     GtkSelectionData *data);
static int  gtk_selection_bytes_per_item    (gint              format);
Elliot Lee's avatar
Elliot Lee committed
157 158 159 160 161 162 163 164

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

167 168 169 170 171 172 173 174 175
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
176 177
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
178 179 180 181 182 183 184 185 186 187 188 189 190 191
{
  GtkTargetList *result = g_new (GtkTargetList, 1);
  result->list = NULL;
  result->ref_count = 1;

  if (targets)
    gtk_target_list_add_table (result, targets, ntargets);
  
  return result;
}

void               
gtk_target_list_ref (GtkTargetList *list)
{
192 193
  g_return_if_fail (list != NULL);

194 195 196 197 198 199
  list->ref_count++;
}

void               
gtk_target_list_unref (GtkTargetList *list)
{
200 201 202
  g_return_if_fail (list != NULL);
  g_return_if_fail (list->ref_count > 0);

203 204 205 206 207 208
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
Owen Taylor's avatar
Owen Taylor committed
209 210
	  GtkTargetPair *pair = tmp_list->data;
	  g_free (pair);
211 212 213

	  tmp_list = tmp_list->next;
	}
Owen Taylor's avatar
Owen Taylor committed
214 215
      
      g_list_free (list->list);
216
      g_free (list);
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    }
}

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               
239 240 241
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
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
{
  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);

273
	  list->list = g_list_remove_link (list->list, tmp_list);
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	  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
305 306 307 308 309 310 311 312 313 314 315
/*************************************************************
 * 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:
 *************************************************************/

316
gboolean
Elliot Lee's avatar
Elliot Lee committed
317 318 319 320 321 322
gtk_selection_owner_set (GtkWidget *widget,
			 GdkAtom    selection,
			 guint32    time)
{
  GList *tmp_list;
  GtkWidget *old_owner;
323
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
324
  GdkWindow *window;
325 326

  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
327
  
Elliot Lee's avatar
Elliot Lee committed
328 329 330
  if (widget == NULL)
    window = NULL;
  else
331 332
    window = widget->window;

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

/*************************************************************
399 400
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
401 402
 *
 *   arguments:
403
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
404 405
 *     selection:
 *     target:
406
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
407 408 409 410
 *
 *   results:
 *************************************************************/

411
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
412

413 414 415 416 417 418 419 420
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
421
{
422
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
423
  GList *tmp_list;
424 425 426
  GList *lists;

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
427
  
428
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
429 430
  while (tmp_list)
    {
431 432 433
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
434 435
      tmp_list = tmp_list->next;
    }
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454

  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);
455
  
456 457
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
458
    {
459 460 461 462 463 464
      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
465
    }
466 467 468 469 470

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

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/**
 * gtk_selection_clear_targets:
 * @widget:    a #GtkWidget
 * @selection: an atom representing a selection
 *
 * Remove all targets registered for the given selection for the
 * widget.
 **/
void 
gtk_selection_clear_targets (GtkWidget *widget,
			     GdkAtom    selection)
{
  GtkSelectionTargetList *sellist;
  GList *tmp_list;
  GList *lists;

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
  
  tmp_list = lists;
  while (tmp_list)
    {
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	{
	  lists = g_list_delete_link (lists, tmp_list);
	  gtk_target_list_unref (sellist->list);
	  g_free (sellist);

	  break;
	}
      
      tmp_list = tmp_list->next;
    }
  
  gtk_object_set_data (GTK_OBJECT (widget), gtk_selection_handler_key, lists);
}

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
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 
523 524 525 526
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
527 528 529 530 531
{
  GtkTargetList *list;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
532
  
533 534
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
535 536
}

537

Elliot Lee's avatar
Elliot Lee committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
/*************************************************************
 * 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;
555
  
Elliot Lee's avatar
Elliot Lee committed
556
  /* Remove pending requests/incrs for this widget */
557
  
Elliot Lee's avatar
Elliot Lee committed
558 559 560 561 562 563 564 565 566 567 568 569
  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;
    }
570
  
Elliot Lee's avatar
Elliot Lee committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
  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 */
586
  
Elliot Lee's avatar
Elliot Lee committed
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
  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;
    }
606 607 608

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
609 610 611 612 613 614 615 616
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
617
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
618
 *     selection:  Which selection to get
619 620 621
 *     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
622 623 624 625 626 627 628
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

629
gboolean
Elliot Lee's avatar
Elliot Lee committed
630
gtk_selection_convert (GtkWidget *widget, 
631 632 633
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
634 635 636 637
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
638
  
Elliot Lee's avatar
Elliot Lee committed
639
  g_return_val_if_fail (widget != NULL, FALSE);
640
  
Elliot Lee's avatar
Elliot Lee committed
641 642 643 644 645
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
646
  
Elliot Lee's avatar
Elliot Lee committed
647 648 649 650 651
  /* 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. */
652
  
Elliot Lee's avatar
Elliot Lee committed
653 654 655 656 657 658 659 660
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
661
  
Elliot Lee's avatar
Elliot Lee committed
662
  info = g_new (GtkRetrievalInfo, 1);
663
  
Elliot Lee's avatar
Elliot Lee committed
664 665 666 667 668
  info->widget = widget;
  info->selection = selection;
  info->target = target;
  info->buffer = NULL;
  info->offset = -1;
669
  
Elliot Lee's avatar
Elliot Lee committed
670 671
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
672
  
Elliot Lee's avatar
Elliot Lee committed
673 674 675 676 677 678
  owner_window = gdk_selection_owner_get (selection);
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
679
      
Elliot Lee's avatar
Elliot Lee committed
680 681 682 683
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
684
      
Elliot Lee's avatar
Elliot Lee committed
685
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
686
      
Elliot Lee's avatar
Elliot Lee committed
687 688
      if (owner_widget != NULL)
	{
689
	  gtk_selection_invoke_handler (owner_widget, 
690 691
					&selection_data,
					time);
692
	  
Elliot Lee's avatar
Elliot Lee committed
693 694 695 696
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
697 698
					  selection_data.length,
					  time);
699
	  
Elliot Lee's avatar
Elliot Lee committed
700 701 702 703 704 705 706 707
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
708
  
Elliot Lee's avatar
Elliot Lee committed
709 710 711
  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);
712
  
Elliot Lee's avatar
Elliot Lee committed
713 714 715 716 717 718 719 720 721 722
  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
723 724 725
 *     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
726 727 728 729 730
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
731 732
			GdkAtom		  type,
			gint		  format,
733
			const guchar	 *data,
734
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
735 736 737
{
  if (selection_data->data)
    g_free (selection_data->data);
738
  
Elliot Lee's avatar
Elliot Lee committed
739 740
  selection_data->type = type;
  selection_data->format = format;
741
  
Elliot Lee's avatar
Elliot Lee committed
742 743 744 745 746 747 748
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
749 750 751 752 753 754 755 756
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
757
  
Elliot Lee's avatar
Elliot Lee committed
758 759 760
  selection_data->length = length;
}

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
static GdkAtom utf8_atom;
static GdkAtom text_atom;
static GdkAtom ctext_atom;

static void 
init_atoms (void)
{
  if (!utf8_atom)
    {
      utf8_atom = gdk_atom_intern ("UTF8_STRING", FALSE);
      text_atom = gdk_atom_intern ("TEXT", FALSE);
      ctext_atom = gdk_atom_intern ("COMPOUND_TEXT", FALSE);
    }
}

/**
 * gtk_selection_data_set_text:
 * @selection_data: a #GtkSelectionData
 * @str: a UTF-8 string
 * 
 * Sets the contents of the selection from a UTF-8 encoded string.
 * The string is converted to the form determined by
 * @selection_data->target.
 * 
 * Return value: %TRUE if the selection was succesfully set,
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
			     const guchar         *str)
{
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
			      8, (guchar *)str, strlen (str));
      return TRUE;
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
      gchar *latin1 = gdk_utf8_to_string_target (str);

      if (latin1)
	{
	  gtk_selection_data_set (selection_data,
				  GDK_SELECTION_TYPE_STRING,
				  8, latin1, strlen (latin1));
	  g_free(latin1);
	  
	  return TRUE;
	}

    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
      guchar *text;
      GdkAtom encoding;
      gint format;
      gint new_length;
      
      if (gdk_utf8_to_compound_text (str, &encoding, &format, &text, &new_length))
	{
	  gtk_selection_data_set (selection_data, encoding, format, text, new_length);
	  gdk_free_compound_text (text);
      
	  return TRUE;
	}
    }
  
  return FALSE;
}

/**
 * gtk_selection_data_get_text:
 * @selection_data: a #GtkSelectionData
 * 
 * Gets the contents of the selection data as a UTF-8 string.
 * 
 * Return value: if the selection data contained a recognized
 *   text type and it could be converted to UTF-8, a newly allocated
 *   string containing the converted text, otherwise %NULL.
 *   If the result is non-%NULL it must be freed with g_free().
 **/
guchar *
gtk_selection_data_get_text (GtkSelectionData *selection_data)
{
  guchar *result = NULL;

  init_atoms ();
  
  if (selection_data->length >= 0 &&
      (selection_data->type == GDK_TARGET_STRING ||
       selection_data->type == ctext_atom ||
       selection_data->type == utf8_atom))
    {
      gchar **list;
      gint i;
      gint count = gdk_text_property_to_utf8_list (selection_data->type,
						   selection_data->format, 
						   selection_data->data,
						   selection_data->length,
						   &list);
      if (count > 0)
	result = list[0];

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

  return result;
}

Elliot Lee's avatar
Elliot Lee committed
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
/*************************************************************
 * 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:
 *************************************************************/

903
gboolean
904
gtk_selection_clear (GtkWidget         *widget,
Elliot Lee's avatar
Elliot Lee committed
905 906
		     GdkEventSelection *event)
{
907 908 909 910
  /* Note that we filter clear events in gdkselection-x11.c, so
   * that we only will get here if the clear event actually
   * represents a change that we didn't do ourself.
   */
Elliot Lee's avatar
Elliot Lee committed
911
  GList *tmp_list;
912
  GtkSelectionInfo *selection_info = NULL;
913
  
Elliot Lee's avatar
Elliot Lee committed
914 915 916 917 918 919 920 921 922 923 924
  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;
    }
925
  
926 927
  if (tmp_list)
    {
928 929 930
      current_selections = g_list_remove_link (current_selections, tmp_list);
      g_list_free (tmp_list);
      g_free (selection_info);
931 932
    }
  
Elliot Lee's avatar
Elliot Lee committed
933 934 935 936 937 938 939 940 941 942 943 944 945
  return TRUE;
}


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

946
gboolean
Elliot Lee's avatar
Elliot Lee committed
947 948 949 950 951 952 953
gtk_selection_request (GtkWidget *widget,
		       GdkEventSelection *event)
{
  GtkIncrInfo *info;
  GList *tmp_list;
  guchar *mult_atoms;
  int i;
954
  
955 956 957
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
958
  /* Check if we own selection */
959
  
Elliot Lee's avatar
Elliot Lee committed
960 961 962 963
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
964
      
Elliot Lee's avatar
Elliot Lee committed
965 966 967
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
968
      
Elliot Lee's avatar
Elliot Lee committed
969 970
      tmp_list = tmp_list->next;
    }
971
  
Elliot Lee's avatar
Elliot Lee committed
972 973 974
  if (tmp_list == NULL)
    return FALSE;
  
975
  info = g_new (GtkIncrInfo, 1);
976
  
Elliot Lee's avatar
Elliot Lee committed
977 978 979
  info->widget = widget;
  info->selection = event->selection;
  info->num_incrs = 0;
980
  
Elliot Lee's avatar
Elliot Lee committed
981
  /* Create GdkWindow structure for the requestor */
982
  
983
#if defined(GDK_WINDOWING_WIN32) || defined(GDK_WINDOWING_X11) || defined(GDK_WINDOWING_FB) 
Elliot Lee's avatar
Elliot Lee committed
984 985 986
  info->requestor = gdk_window_lookup (event->requestor);
  if (!info->requestor)
    info->requestor = gdk_window_foreign_new (event->requestor);
Elliot Lee's avatar
Elliot Lee committed
987 988 989
#else
  info->requestor = NULL;
#endif
Elliot Lee's avatar
Elliot Lee committed
990 991
  
  /* Determine conversions we need to perform */
992
  
Elliot Lee's avatar
Elliot Lee committed
993 994 995 996 997
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
      gint     format;
      gint     length;
998
      
Elliot Lee's avatar
Elliot Lee committed
999
      mult_atoms = NULL;
1000
      
1001
      gdk_error_trap_push ();
1002
      if (!gdk_property_get (info->requestor, event->property, 0, /* AnyPropertyType */
Elliot Lee's avatar
Elliot Lee committed
1003
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
1004
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
1005 1006 1007 1008 1009 1010 1011
	{
	  gdk_selection_send_notify (event->requestor, event->selection,
				     event->target, GDK_NONE, event->time);
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
1012
      gdk_error_trap_pop ();
1013
      
Elliot Lee's avatar
Elliot Lee committed
1014 1015
      info->num_conversions = length / (2*sizeof (GdkAtom));
      info->conversions = g_new (GtkIncrConversion, info->num_conversions);
1016
      
Elliot Lee's avatar
Elliot Lee committed
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
      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;
    }
1031
  
Elliot Lee's avatar
Elliot Lee committed
1032 1033 1034 1035 1036
  /* 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;
1037
      glong items;
1038
      
Elliot Lee's avatar
Elliot Lee committed
1039 1040 1041 1042
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
1043
      
Elliot Lee's avatar
Elliot Lee committed
1044
#ifdef DEBUG_SELECTION
1045 1046
      g_message ("Selection %ld, target %ld (%s) requested by 0x%x (property = %ld)",
		 event->selection, info->conversions[i].target,
1047
		 gdk_atom_name (info->conversions[i].target),
1048
		 event->requestor, event->property);
Elliot Lee's avatar
Elliot Lee committed
1049
#endif
1050
      
1051
      gtk_selection_invoke_handler (widget, &data, event->time);
1052
      
Elliot Lee's avatar
Elliot Lee committed
1053 1054 1055 1056 1057 1058
      if (data.length < 0)
	{
	  ((GdkAtom *)mult_atoms)[2*i+1] = GDK_NONE;
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
1059
      
Tim Janik's avatar
GLib:  
Tim Janik committed
1060
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
1061
      
1062
      items = data.length / gtk_selection_bytes_per_item (data.format);
1063
      
Elliot Lee's avatar
Elliot Lee committed
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
      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],
1075
			       32,
Elliot Lee's avatar
Elliot Lee committed
1076 1077 1078 1079 1080 1081
			       GDK_PROP_MODE_REPLACE,
			       (guchar *)&items, 1);
	}
      else
	{
	  info->conversions[i].offset = -1;
1082
	  
Elliot Lee's avatar
Elliot Lee committed
1083 1084 1085 1086 1087 1088
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
1089
	  
Elliot Lee's avatar
Elliot Lee committed
1090 1091 1092
	  g_free (data.data);
	}
    }
1093
  
Elliot Lee's avatar
Elliot Lee committed
1094 1095
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
1096
  
Elliot Lee's avatar
Elliot Lee committed
1097 1098 1099 1100
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
1101
      
Elliot Lee's avatar
Elliot Lee committed
1102
#ifdef DEBUG_SELECTION
1103
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
1104
#endif
1105
      
Elliot Lee's avatar
Elliot Lee committed
1106 1107 1108 1109 1110 1111
      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);
    }
1112
  
Elliot Lee's avatar
Elliot Lee committed
1113 1114 1115 1116 1117
  /* 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,
1118
			   GDK_SELECTION_TYPE_ATOM, 32, 
Elliot Lee's avatar
Elliot Lee committed
1119
			   GDK_PROP_MODE_REPLACE,
1120
			   mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
1121 1122
      g_free (mult_atoms);
    }
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135

  if (info->num_conversions == 1 &&
      info->conversions[0].property == GDK_NONE)
    {
      /* Reject the entire conversion */
      gdk_selection_send_notify (event->requestor, event->selection, 
				 event->target, GDK_NONE, event->time);
    }
  else
    {
      gdk_selection_send_notify (event->requestor, event->selection, 
				 event->target, event->property, event->time);
    }
1136
  
Elliot Lee's avatar
Elliot Lee committed
1137 1138 1139 1140 1141
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
1142
  
Elliot Lee's avatar
Elliot Lee committed
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
  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:
1155 1156
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
1157 1158 1159 1160
 *
 *   results:
 *************************************************************/

1161
gboolean
1162
gtk_selection_incr_event (GdkWindow	   *window,
Elliot Lee's avatar
Elliot Lee committed
1163 1164 1165
			  GdkEventProperty *event)
{
  GList *tmp_list;
1166
  GtkIncrInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1167 1168
  gint num_bytes;
  guchar *buffer;
1169
  
Elliot Lee's avatar
Elliot Lee committed
1170 1171 1172 1173
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
1174
  
Elliot Lee's avatar
Elliot Lee committed
1175
#ifdef DEBUG_SELECTION
1176
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
1177
#endif
1178
  
Elliot Lee's avatar
Elliot Lee committed
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
  /* 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;
    }
1189
  
Elliot Lee's avatar
Elliot Lee committed
1190 1191
  if (tmp_list == NULL)
    return FALSE;
1192
  
Elliot Lee's avatar
Elliot Lee committed
1193 1194 1195 1196 1197 1198
  /* 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)
	{
1199 1200
	  int bytes_per_item;
	  
Elliot Lee's avatar
Elliot Lee committed
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
	  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;
1215
	      
Elliot Lee's avatar
Elliot Lee committed
1216 1217 1218 1219 1220 1221 1222 1223 1224
	      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
1225 1226 1227
	  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
1228
#endif
1229 1230

	  bytes_per_item = gtk_selection_bytes_per_item (info->conversions[i].data.format);
Elliot Lee's avatar
Elliot Lee committed
1231 1232 1233 1234
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
1235 1236
			       buffer,
			       num_bytes / bytes_per_item);
1237
	  
Elliot Lee's avatar
Elliot Lee committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
	  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;
    }
1252
  
Elliot Lee's avatar
Elliot Lee committed
1253
  /* Check if we're finished with all the targets */
1254
  
Elliot Lee's avatar
Elliot Lee committed
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
  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:
1270
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
1271 1272 1273 1274 1275 1276 1277
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1278 1279
  gboolean retval;

1280
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1281 1282 1283
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1284
  
Elliot Lee's avatar
Elliot Lee committed
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
  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? */
1305
      
Elliot Lee's avatar
Elliot Lee committed
1306 1307
      g_free (info);
      
1308
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1309 1310 1311 1312 1313
    }
  else
    {
      info->idle_time++;
      
1314
      retval = TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1315
    }
1316
  
1317
  GDK_THREADS_LEAVE ();
1318 1319

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1320 1321 1322 1323 1324 1325 1326 1327
}

/*************************************************************
 * 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:
1328 1329 1330
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1331 1332 1333 1334
 *   results:
 *     was event handled?
 *************************************************************/

1335
gboolean
1336
gtk_selection_notify (GtkWidget	       *widget,
Elliot Lee's avatar
Elliot Lee committed
1337 1338 1339
		      GdkEventSelection *event)
{
  GList *tmp_list;
1340
  GtkRetrievalInfo *info = NULL;
1341
  guchar  *buffer = NULL;
Elliot Lee's avatar
Elliot Lee committed
1342 1343
  gint length;
  GdkAtom type;
1344
  gint	  format;
Elliot Lee's avatar
Elliot Lee committed
1345 1346
  
#ifdef DEBUG_SELECTION
1347 1348
  g_message ("Initial receipt of selection %ld, target %ld (property = %ld)",
	     event->selection, event->target, event->property);
Elliot Lee's avatar
Elliot Lee committed
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
#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;
    }
1359
  
Elliot Lee's avatar
Elliot Lee committed
1360 1361
  if (!tmp_list)		/* no retrieval in progress */
    return FALSE;
1362 1363 1364 1365

  if (event->property != GDK_NONE)
    length = gdk_selection_property_get (widget->window, &buffer, 
					 &type, &format);
Havoc Pennington's avatar
Havoc Pennington committed
1366 1367 1368
  else
    length = 0; /* silence gcc */
  
1369
  if (event->property == GDK_NONE || buffer == NULL)
Elliot Lee's avatar
Elliot Lee committed
1370 1371 1372 1373 1374
    {
      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,
1375
				      GDK_NONE, 0, NULL, -1, event->time);
1376
      
Elliot Lee's avatar
Elliot Lee committed
1377 1378 1379 1380 1381 1382 1383
      return TRUE;
    }
  
  if (type == gtk_selection_atoms[INCR])
    {
      /* The remainder of the selection will come through PropertyNotify
	 events */
1384 1385

      info->notify_time = event->time;
Elliot Lee's avatar
Elliot Lee committed
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
      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);
1397
      
Elliot Lee's avatar
Elliot Lee committed
1398 1399 1400
      info->offset = length;
      gtk_selection_retrieval_report (info,
				      type, format, 
1401
				      buffer, length, event->time);
Elliot Lee's avatar
Elliot Lee committed
1402
    }
1403
  
Elliot Lee's avatar
Elliot Lee committed
1404
  gdk_property_delete (widget->window, event->property);
1405
  
Elliot Lee's avatar
Elliot Lee committed
1406
  g_free (buffer);
1407
  
Elliot Lee's avatar
Elliot Lee committed
1408 1409 1410 1411 1412 1413 1414 1415 1416
  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:
1417 1418 1419
 *     widget:		Widget getting signal
 *     event:		Property event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1420 1421 1422 1423
 *   results:
 *     was event handled?
 *************************************************************/

1424
gboolean
1425
gtk_selection_property_notify (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1426 1427 1428
			       GdkEventProperty *event)
{
  GList *tmp_list;
1429
  GtkRetrievalInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1430 1431 1432
  guchar *new_buffer;
  int length;
  GdkAtom type;
1433
  gint	  format;
1434
  
1435 1436 1437
  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

Elliot Lee's avatar
Elliot Lee committed
1438
#if defined(GDK_WINDOWING_WIN32) || defined(GDK_WINDOWING_X11)
Elliot Lee's avatar
Elliot Lee committed
1439
  if ((event->state != GDK_PROPERTY_NEW_VALUE) ||  /* property was deleted */
1440
      (event->atom != gdk_atom_intern ("GDK_SELECTION", FALSE))) /* not the right property */
Elliot Lee's avatar
Elliot Lee committed
1441
#endif
Elliot Lee's avatar
Elliot Lee committed
1442
    return FALSE;
1443
  
Elliot Lee's avatar
Elliot Lee committed
1444
#ifdef DEBUG_SELECTION
1445 1446
  g_message ("PropertyNewValue, property %ld",
	     event->atom);
Elliot Lee's avatar
Elliot Lee committed
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	break;
      tmp_list = tmp_list->next;
    }
1457
  
Elliot Lee's avatar
Elliot Lee committed
1458 1459
  if (!tmp_list)		/* No retrieval in progress */
    return FALSE;
1460
  
Elliot Lee's avatar
Elliot Lee committed
1461 1462 1463
  if (info->offset < 0)		/* We haven't got the SelectionNotify
				   for this retrieval yet */
    return FALSE;
1464
  
Elliot Lee's avatar
Elliot Lee committed
1465 1466 1467 1468 1469
  info->idle_time = 0;
  
  length = gdk_selection_property_get (widget->window, &new_buffer, 
				       &type, &format);
  gdk_property_delete (widget->window, event->atom);
1470
  
Elliot Lee's avatar
Elliot Lee committed
1471 1472 1473 1474
  /* 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!) */
1475
  
Elliot Lee's avatar
Elliot Lee committed
1476 1477 1478 1479 1480 1481 1482 1483
  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,
1484 1485
				      (type == GDK_NONE) ?  -1 : info->offset,
				      info->notify_time);
Elliot Lee's avatar
Elliot Lee committed
1486 1487 1488 1489 1490 1491
    }
  else				/* append on newly arrived data */
    {
      if (!info->buffer)
	{
#ifdef DEBUG_SELECTION
1492 1493
	  g_message ("Start - Adding %d bytes at offset 0",
		     length);
Elliot Lee's avatar
Elliot Lee committed
1494 1495 1496 1497 1498 1499
#endif
	  info->buffer = new_buffer;
	  info->offset = length;
	}
      else
	{
1500
	  
Elliot Lee's avatar
Elliot Lee committed
1501
#ifdef DEBUG_SELECTION
1502 1503
	  g_message ("Appending %d bytes at offset %d",
		     length,info->offset);
Elliot Lee's avatar
Elliot Lee committed
1504 1505 1506 1507 1508 1509 1510 1511
#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);
	}
    }
1512
  
Elliot Lee's avatar
Elliot Lee committed
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
  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;
1528 1529
  gboolean retval;

1530
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1531 1532 1533
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1534
  
Elliot Lee's avatar
Elliot Lee committed
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
  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);
1550
	  gtk_selection_retrieval_report (info, GDK_NONE, 0, NULL, -1, GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
1551 1552 1553 1554 1555
	}
      
      g_free (info->buffer);
      g_free (info);
      
1556
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1557 1558 1559 1560 1561
    }
  else
    {
      info->idle_time++;
      
1562
      retval =  TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1563
    }
1564

1565
  GDK_THREADS_LEAVE ();
1566 1567

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1568 1569 1570 1571 1572 1573
}

/*************************************************************
 * gtk_selection_retrieval_report:
 *     Emits a "selection_received" signal.
 *   arguments:
1574 1575
 *     info:	  information about the retrieval that completed
 *     buffer:	  buffer containing data (NULL => errror)
1576
 *     time:      timestamp for data in buffer
Elliot Lee's avatar
Elliot Lee committed
1577 1578 1579 1580 1581 1582
 *   results:
 *************************************************************/

static void
gtk_selection_retrieval_report (GtkRetrievalInfo *info,
				GdkAtom type, gint format, 
1583 1584
				guchar *buffer, gint length,
				guint32 time)
Elliot Lee's avatar
Elliot Lee committed
1585 1586
{
  GtkSelectionData data;
1587
  
Elliot Lee's avatar
Elliot Lee committed
1588 1589 1590 1591
  data.selection = info->selection;
  data.target = info->target;
  data.type = type;
  data.format = format;
1592
  
Elliot Lee's avatar
Elliot Lee committed
1593 1594
  data.length = length;
  data.data = buffer;
1595
  
Elliot Lee's avatar
Elliot Lee committed
1596
  gtk_signal_emit_by_name (GTK_OBJECT(info->widget),
1597 1598
			   "selection_received", 
			   &data, time);
Elliot Lee's avatar
Elliot Lee committed
1599 1600 1601
}

/*************************************************************
1602 1603 1604 1605 1606
 * 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
1607
 *   arguments: