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

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

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

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

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

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

Elliot Lee's avatar
Elliot Lee committed
58 59 60
#include "gtkmain.h"
#include "gtkselection.h"

61 62 63 64
#ifdef GDK_WINDOWING_X11
#include "x11/gdkx.h"
#endif

Elliot Lee's avatar
Elliot Lee committed
65 66 67 68
/* #define DEBUG_SELECTION */

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
69
#ifdef GDK_WINDOWING_WIN32
70 71 72
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE G_MAXINT
#else
Elliot Lee's avatar
Elliot Lee committed
73
#define GTK_SELECTION_MAX_SIZE 4000
74
#endif
Owen Taylor's avatar
Owen Taylor committed
75 76 77

#define IDLE_ABORT_TIME 300

Elliot Lee's avatar
Elliot Lee committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
enum {
  INCR,
  MULTIPLE,
  TARGETS,
  TIMESTAMP,
  LAST_ATOM
};

typedef struct _GtkSelectionInfo GtkSelectionInfo;
typedef struct _GtkIncrConversion GtkIncrConversion;
typedef struct _GtkIncrInfo GtkIncrInfo;
typedef struct _GtkRetrievalInfo GtkRetrievalInfo;

struct _GtkSelectionInfo
{
93 94 95 96
  GdkAtom	 selection;
  GtkWidget	*widget;	/* widget that owns selection */
  guint32	 time;		/* time used to acquire selection */
  GdkDisplay	*display;	/* needed in gtk_selection_remove_all */    
Elliot Lee's avatar
Elliot Lee committed
97 98 99 100
};

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

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

/* Local Functions */
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
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
155 156 157 158 159 160 161 162

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

165 166 167 168 169 170 171 172 173
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
174 175
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
176 177 178 179 180 181 182 183 184 185 186 187 188 189
{
  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)
{
190 191
  g_return_if_fail (list != NULL);

192 193 194 195 196 197
  list->ref_count++;
}

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

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

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

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               
237 238 239
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
{
  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);

271
	  list->list = g_list_remove_link (list->list, tmp_list);
272 273 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
	  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;
}

302 303 304 305 306
/**
 * gtk_selection_owner_set_for_display:
 * @display: the #Gdkdisplay where the selection is set 
 * @widget: new selection owner (a #GdkWidget), or %NULL.
 * @selection: an interned atom representing the selection to claim.
307
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
308
 *
309 310 311 312
 * Claim ownership of a given selection for a particular widget, or,
 * if @widget is %NULL, release ownership of the selection.
 *
 * Return value: TRUE if the operation succeeded 
Matthias Clasen's avatar
Matthias Clasen committed
313 314
 * 
 * Since: 2.2
315
 */
316
gboolean
317 318 319 320
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
321 322 323
{
  GList *tmp_list;
  GtkWidget *old_owner;
324
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
325
  GdkWindow *window;
326

327
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
328
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
329
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
330
  g_return_val_if_fail (widget == NULL || gtk_widget_get_display (widget) == display, FALSE);
331
  
Elliot Lee's avatar
Elliot Lee committed
332 333 334
  if (widget == NULL)
    window = NULL;
  else
335 336
    window = widget->window;

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

	  gdk_event_free (event);
Elliot Lee's avatar
Elliot Lee committed
398 399 400 401 402 403 404
	}
      return TRUE;
    }
  else
    return FALSE;
}

405 406 407 408
/**
 * gtk_selection_owner_set:
 * @widget:  a #GtkWidget, or %NULL.
 * @selection:  an interned atom representing the selection to claim
409
 * @time_: timestamp with which to claim the selection
410 411 412 413 414 415 416 417 418 419 420
 * 
 * Claims ownership of a given selection for a particular widget,
 * or, if @widget is %NULL, release ownership of the selection.
 * 
 * Return value: %TRUE if the operation succeeded
 **/
gboolean
gtk_selection_owner_set (GtkWidget *widget,
			 GdkAtom    selection,
			 guint32    time)
{
421 422
  GdkDisplay *display;
  
423
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
424
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
425 426 427 428 429 430 431 432

  if (widget)
    display = gtk_widget_get_display (widget);
  else
    {
      GTK_NOTE (MULTIHEAD,
		g_warning ("gtk_selection_owner_set (NULL,...) is not multihead safe"));
		 
Owen Taylor's avatar
Owen Taylor committed
433
      display = gdk_display_get_default ();
434
    }
435
  
436 437
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
438 439
}

Elliot Lee's avatar
Elliot Lee committed
440
/*************************************************************
441 442
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
443 444
 *
 *   arguments:
445
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
446 447
 *     selection:
 *     target:
448
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
449 450 451 452
 *
 *   results:
 *************************************************************/

453
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
454

455 456 457 458 459 460 461 462
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
463
{
464
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
465
  GList *tmp_list;
466 467
  GList *lists;

Manish Singh's avatar
Manish Singh committed
468
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
469
  
470
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
471 472
  while (tmp_list)
    {
473 474 475
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
476 477
      tmp_list = tmp_list->next;
    }
478 479 480 481 482 483

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

  lists = g_list_prepend (lists, sellist);
Manish Singh's avatar
Manish Singh committed
484
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
485 486 487 488 489 490 491 492 493 494 495

  return sellist->list;
}

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

Manish Singh's avatar
Manish Singh committed
496
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
497
  
498 499
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
500
    {
501 502 503 504 505 506
      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
507
    }
508 509

  g_list_free (lists);
Manish Singh's avatar
Manish Singh committed
510
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, NULL);
511 512
}

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
/**
 * 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;

529 530 531
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);

Manish Singh's avatar
Manish Singh committed
532
  lists = g_object_get_data (G_OBJECT (widget), gtk_selection_handler_key);
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  
  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;
    }
  
Manish Singh's avatar
Manish Singh committed
550
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
551 552
}

553 554 555 556 557 558 559 560
void 
gtk_selection_add_target (GtkWidget	    *widget, 
			  GdkAtom	     selection,
			  GdkAtom	     target,
			  guint              info)
{
  GtkTargetList *list;

561 562
  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
563 564 565 566 567 568

  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add (list, target, 0, info);
}

void 
569 570 571 572
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
573 574
{
  GtkTargetList *list;
575 576 577

  g_return_if_fail (GTK_IS_WIDGET (widget));
  g_return_if_fail (selection != GDK_NONE);
578
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
579
  
580 581
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
582 583
}

584

Elliot Lee's avatar
Elliot Lee committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
/*************************************************************
 * 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;
602
  
Elliot Lee's avatar
Elliot Lee committed
603
  /* Remove pending requests/incrs for this widget */
604
  
Elliot Lee's avatar
Elliot Lee committed
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
  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 */
620
  
Elliot Lee's avatar
Elliot Lee committed
621 622 623 624 625 626 627 628
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
629 630 631 632 633
	  gdk_selection_owner_set_for_display (selection_info->display,
					       NULL, 
					       selection_info->selection,
				               GDK_CURRENT_TIME, FALSE);
	  current_selections = g_list_remove_link (current_selections,
Elliot Lee's avatar
Elliot Lee committed
634 635 636 637 638 639 640
						   tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
      
      tmp_list = next;
    }
641 642 643

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
644 645 646 647 648 649 650 651
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
652
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
653
 *     selection:  Which selection to get
654 655 656
 *     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
657 658 659 660 661 662 663
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

664
gboolean
Elliot Lee's avatar
Elliot Lee committed
665
gtk_selection_convert (GtkWidget *widget, 
666 667 668
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
669 670 671 672
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
673
  GdkDisplay *display;
674
  
675 676
  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
677
  
Elliot Lee's avatar
Elliot Lee committed
678 679 680 681 682
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
683
  
Elliot Lee's avatar
Elliot Lee committed
684 685 686 687 688
  /* 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. */
689
  
Elliot Lee's avatar
Elliot Lee committed
690 691 692 693 694 695 696 697
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
698
  
Elliot Lee's avatar
Elliot Lee committed
699
  info = g_new (GtkRetrievalInfo, 1);
700
  
Elliot Lee's avatar
Elliot Lee committed
701 702 703
  info->widget = widget;
  info->selection = selection;
  info->target = target;
Owen Taylor's avatar
Owen Taylor committed
704
  info->idle_time = 0;
Elliot Lee's avatar
Elliot Lee committed
705 706
  info->buffer = NULL;
  info->offset = -1;
707
  
Elliot Lee's avatar
Elliot Lee committed
708 709
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
710 711 712

  display = gtk_widget_get_display (widget);
  owner_window = gdk_selection_owner_get_for_display (display, selection);
Elliot Lee's avatar
Elliot Lee committed
713 714 715 716 717
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
718
      
Elliot Lee's avatar
Elliot Lee committed
719 720 721 722
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
723
      selection_data.display = display;
724
      
Elliot Lee's avatar
Elliot Lee committed
725
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
726
      
Elliot Lee's avatar
Elliot Lee committed
727 728
      if (owner_widget != NULL)
	{
729
	  gtk_selection_invoke_handler (owner_widget, 
730 731
					&selection_data,
					time);
732
	  
Elliot Lee's avatar
Elliot Lee committed
733 734 735 736
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
737 738
					  selection_data.length,
					  time);
739
	  
Elliot Lee's avatar
Elliot Lee committed
740 741 742 743 744 745 746 747
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
748
  
Elliot Lee's avatar
Elliot Lee committed
749 750
  current_retrievals = g_list_append (current_retrievals, info);
  gdk_selection_convert (widget->window, selection, target, time);
751
  g_timeout_add (1000, (GSourceFunc) gtk_selection_retrieval_timeout, info);
752
  
Elliot Lee's avatar
Elliot Lee committed
753 754 755 756 757 758 759 760 761 762
  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
763 764 765
 *     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
766 767 768 769 770
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
771 772
			GdkAtom		  type,
			gint		  format,
773
			const guchar	 *data,
774
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
775 776 777
{
  if (selection_data->data)
    g_free (selection_data->data);
778
  
Elliot Lee's avatar
Elliot Lee committed
779 780
  selection_data->type = type;
  selection_data->format = format;
781
  
Elliot Lee's avatar
Elliot Lee committed
782 783 784 785 786 787 788
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
789 790 791 792 793 794 795 796
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
797
  
Elliot Lee's avatar
Elliot Lee committed
798 799 800
  selection_data->length = length;
}

801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
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);
    }
}

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
static gboolean
selection_set_string (GtkSelectionData *selection_data,
		      const gchar      *str,
		      gint              len)
{
  gchar *tmp = g_strndup (str, len);
  gchar *latin1 = gdk_utf8_to_string_target (tmp);
  g_free (tmp);
  
  if (latin1)
    {
      gtk_selection_data_set (selection_data,
			      GDK_SELECTION_TYPE_STRING,
			      8, latin1, strlen (latin1));
      g_free (latin1);
      
      return TRUE;
    }
  else
    return FALSE;
}

static gboolean
selection_set_compound_text (GtkSelectionData *selection_data,
			     const gchar      *str,
			     gint              len)
{
  gchar *tmp;
  guchar *text;
  GdkAtom encoding;
  gint format;
  gint new_length;
  gboolean result = FALSE;
  
  tmp = g_strndup (str, len);
  if (gdk_utf8_to_compound_text_for_display (selection_data->display, tmp,
					     &encoding, &format, &text, &new_length))
    {
      gtk_selection_data_set (selection_data, encoding, format, text, new_length);
      gdk_free_compound_text (text);
      
      result = TRUE;
    }

  g_free (tmp);

  return result;
}

865 866 867 868
/**
 * gtk_selection_data_set_text:
 * @selection_data: a #GtkSelectionData
 * @str: a UTF-8 string
869
 * @len: the length of @str, or -1 if @str is nul-terminated.
870 871 872 873 874
 * 
 * Sets the contents of the selection from a UTF-8 encoded string.
 * The string is converted to the form determined by
 * @selection_data->target.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
875
 * Return value: %TRUE if the selection was successfully set,
876 877 878 879
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
880 881
			     const gchar          *str,
			     gint                  len)
882
{
883 884 885
  if (len < 0)
    len = strlen (str);
  
886 887 888 889 890 891
  init_atoms ();

  if (selection_data->target == utf8_atom)
    {
      gtk_selection_data_set (selection_data,
			      utf8_atom,
892
			      8, (guchar *)str, len);
893
      return TRUE;
894 895 896
    }
  else if (selection_data->target == GDK_TARGET_STRING)
    {
897
      return selection_set_string (selection_data, str, len);
898 899 900 901
    }
  else if (selection_data->target == ctext_atom ||
	   selection_data->target == text_atom)
    {
902 903 904 905
      if (selection_set_compound_text (selection_data, str, len))
	return TRUE;
      else if (selection_data->target == text_atom)
	return selection_set_string (selection_data, str, len);
906
    }
907 908

  return FALSE;
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
}

/**
 * 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;
936 937 938 939 940 941
      gint count = gdk_text_property_to_utf8_list_for_display (selection_data->display,
      							       selection_data->type,
						   	       selection_data->format, 
						               selection_data->data,
						               selection_data->length,
						               &list);
942 943 944 945 946 947 948 949 950 951 952
      if (count > 0)
	result = list[0];

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

  return result;
}

953 954 955 956 957 958 959
/**
 * gtk_selection_data_get_targets:
 * @selection_data: a #GtkSelectionData object
 * @targets: location to store an array of targets. The result
 *           stored here must be freed with g_free().
 * @n_atoms: location to store number of items in @targets.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
960
 * Gets the contents of @selection_data as an array of targets.
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
 * This can be used to interpret the results of getting
 * the standard TARGETS target that is always supplied for
 * any selection.
 * 
 * Return value: %TRUE if @selection_data contains a valid
 *    array of targets, otherwise %FALSE.
 **/
gboolean
gtk_selection_data_get_targets (GtkSelectionData  *selection_data,
				GdkAtom          **targets,
				gint              *n_atoms)
{
  if (selection_data->length >= 0 &&
      selection_data->format == 32 &&
      selection_data->type == GDK_SELECTION_TYPE_ATOM)
    {
      if (targets)
	*targets = g_memdup (selection_data->data, selection_data->length);
      if (n_atoms)
	*n_atoms = selection_data->length / sizeof (GdkAtom);

      return TRUE;
    }
  else
    {
      if (targets)
	*targets = NULL;
      if (n_atoms)
	*n_atoms = -1;

      return FALSE;
    }
}

/**
 * gtk_selection_data_targets_include_text:
 * @selection_data: a #GtkSelectionData object
 * 
 * Given a #GtkSelectionData object holding a list of targets,
Matthias Clasen's avatar
Matthias Clasen committed
1000
 * determines if any of the targets in @targets can be used to
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
 * provide text.
 * 
 * Return value: %TRUE if @selection_data holds a list of targets,
 *   and a suitable target for text is included, otherwise %FALSE.
 **/
gboolean
gtk_selection_data_targets_include_text (GtkSelectionData *selection_data)
{
  GdkAtom *targets;
  gint n_targets;
  gint i;
  gboolean result = FALSE;

  if (gtk_selection_data_get_targets (selection_data, &targets, &n_targets))
    {
      for (i=0; i < n_targets; i++)
	{
	  if (targets[i] == gdk_atom_intern ("STRING", FALSE) ||
	      targets[i] == gdk_atom_intern ("TEXT", FALSE) ||
	      targets[i] == gdk_atom_intern ("COMPOUND_TEXT", FALSE) ||
	      targets[i] == gdk_atom_intern ("UTF8_STRING", FALSE))
	    result = TRUE;
	}

      g_free (targets);
    }

  return result;
}
	  
Elliot Lee's avatar
Elliot Lee committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
/*************************************************************
 * 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);
1046 1047

  initialize = FALSE;
Elliot Lee's avatar
Elliot Lee committed
1048 1049
}

1050
/**
Elliot Lee's avatar
Elliot Lee committed
1051
 * gtk_selection_clear:
1052 1053 1054 1055
 * @widget: a #GtkWidget
 * @event: the event
 * 
 * The default handler for the GtkWidget::selection_clear_event
Matthias Clasen's avatar
Matthias Clasen committed
1056
 * signal. 
1057 1058
 * 
 * Return value: %TRUE if the event was handled, otherwise false
Matthias Clasen's avatar
Matthias Clasen committed
1059 1060
 * 
 * Since: 2.2
Matthias Clasen's avatar
Matthias Clasen committed
1061 1062 1063 1064
 *
 * Deprecated: Instead of calling this function, chain up from
 * your selection_clear_event handler. Calling this function
 * from any other context is illegal. 
1065
 **/
1066
gboolean
1067
gtk_selection_clear (GtkWidget         *widget,
Elliot Lee's avatar
Elliot Lee committed
1068 1069
		     GdkEventSelection *event)
{
1070 1071 1072 1073
  /* 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
1074
  GList *tmp_list;
1075
  GtkSelectionInfo *selection_info = NULL;
1076
  
Elliot Lee's avatar
Elliot Lee committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
  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;
    }
1088
  
1089 1090
  if (tmp_list)
    {
1091 1092 1093
      current_selections = g_list_remove_link (current_selections, tmp_list);
      g_list_free (tmp_list);
      g_free (selection_info);
1094 1095
    }
  
Elliot Lee's avatar
Elliot Lee committed
1096 1097 1098 1099 1100
  return TRUE;
}


/*************************************************************
1101
 * _gtk_selection_request:
Elliot Lee's avatar
Elliot Lee committed
1102 1103 1104 1105 1106 1107 1108
 *     Handler for "selection_request_event" 
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

1109
gboolean
1110 1111
_gtk_selection_request (GtkWidget *widget,
			GdkEventSelection *event)
Elliot Lee's avatar
Elliot Lee committed
1112
{
1113
  GdkDisplay *display = gtk_widget_get_display (widget);
Elliot Lee's avatar
Elliot Lee committed
1114 1115 1116
  GtkIncrInfo *info;
  GList *tmp_list;
  int i;
1117
  
1118 1119 1120
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
1121
  /* Check if we own selection */
1122
  
Elliot Lee's avatar
Elliot Lee committed
1123 1124 1125 1126
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
1127
      
Elliot Lee's avatar
Elliot Lee committed
1128 1129 1130
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
1131
      
Elliot Lee's avatar
Elliot Lee committed
1132 1133
      tmp_list = tmp_list->next;
    }
1134
  
Elliot Lee's avatar
Elliot Lee committed
1135 1136 1137
  if (tmp_list == NULL)
    return FALSE;
  
1138
  info = g_new (GtkIncrInfo, 1);
1139 1140

  g_object_ref (widget);
1141
  
Elliot Lee's avatar
Elliot Lee committed
1142 1143
  info->selection = event->selection;
  info->num_incrs = 0;
1144
  
Elliot Lee's avatar
Elliot Lee committed
1145
  /* Create GdkWindow structure for the requestor */
1146
  
1147
  info->requestor = gdk_window_lookup_for_display (display,
1148
						   event->requestor);
Elliot Lee's avatar
Elliot Lee committed
1149
  if (!info->requestor)
1150
    info->requestor = gdk_window_foreign_new_for_display (display,
1151
							  event->requestor);
Elliot Lee's avatar
Elliot Lee committed
1152 1153
  
  /* Determine conversions we need to perform */
1154
  
Elliot Lee's avatar
Elliot Lee committed
1155 1156 1157
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
1158
      guchar  *mult_atoms;
Elliot Lee's avatar
Elliot Lee committed
1159 1160
      gint     format;
      gint     length;
1161
      
Elliot Lee's avatar
Elliot Lee committed
1162
      mult_atoms = NULL;
1163
      
1164
      gdk_error_trap_push ();
1165
      if (!gdk_property_get (info->requestor, event->property, GDK_NONE, /* AnyPropertyType */
Elliot Lee's avatar
Elliot Lee committed
1166
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
1167
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
1168
	{
1169
	  gdk_selection_send_notify_for_display (display,
1170 1171 1172 1173 1174
						 event->requestor, 
						 event->selection,
						 event->target, 
						 GDK_NONE, 
						 event->time);
Elliot Lee's avatar
Elliot Lee committed
1175 1176 1177 1178
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
1179
      gdk_error_trap_pop ();
1180 1181 1182 1183 1184 1185 1186 1187

      /* This is annoying; the ICCCM doesn't specify the property type
       * used for the property contents, so the autoconversion for
       * ATOM / ATOM_PAIR in GDK doesn't work properly.
       */
#ifdef GDK_WINDOWING_X11
      if (type != GDK_SELECTION_TYPE_ATOM &&
	  type != gdk_atom_intern ("ATOM_PAIR", FALSE))
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 1206 1207 1208 1209 1210
	  info->num_conversions = length / (2*sizeof (glong));
	  info->conversions = g_new (GtkIncrConversion, info->num_conversions);
	  
	  for (i=0; i<info->num_conversions; i++)
	    {
	      info->conversions[i].target = gdk_x11_xatom_to_atom_for_display (display,
									       ((glong *)mult_atoms)[2*i]);
	      info->conversions[i].property = gdk_x11_xatom_to_atom_for_display (display,
										 ((glong *)mult_atoms)[2*i + 1]);
	    }
	}
      else
#endif
	{
	  info->num_conversions = length / (2*sizeof (GdkAtom));
	  info->conversions = g_new (GtkIncrConversion, info->num_conversions);
	  
	  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];
	    }
Elliot Lee's avatar
Elliot Lee committed
1211 1212 1213 1214 1215 1216 1217 1218 1219
	}
    }
  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;
    }
1220
  
Elliot Lee's avatar
Elliot Lee committed
1221 1222 1223 1224 1225
  /* 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;
1226
      glong items;
1227
      
Elliot Lee's avatar
Elliot Lee committed
1228 1229 1230 1231
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
1232
      data.display = gtk_widget_get_display (widget);
1233
      
Elliot Lee's avatar
Elliot Lee committed
1234
#ifdef DEBUG_SELECTION
1235 1236
      g_message ("Selection %ld, target %ld (%s) requested by 0x%x (property = %ld)",
		 event->selection, info->conversions[i].target,
1237
		 gdk_atom_name (info->conversions[i].target),
1238
		 event->requestor, event->property);
Elliot Lee's avatar
Elliot Lee committed
1239
#endif
1240
      
1241
      gtk_selection_invoke_handler (widget, &data, event->time);
1242
      
Elliot Lee's avatar
Elliot Lee committed
1243 1244 1245 1246 1247
      if (data.length < 0)
	{
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
1248
      
Tim Janik's avatar
GLib:  
Tim Janik committed
1249
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
1250
      
1251
      items = data.length / gtk_selection_bytes_per_item (data.format);
1252
      
Elliot Lee's avatar
Elliot Lee committed
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
      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],
1264
			       32,
Elliot Lee's avatar
Elliot Lee committed
1265 1266 1267 1268 1269 1270
			       GDK_PROP_MODE_REPLACE,
			       (guchar *)&items, 1);
	}
      else
	{
	  info->conversions[i].offset = -1;
1271
	  
Elliot Lee's avatar
Elliot Lee committed
1272 1273 1274 1275 1276 1277
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
1278
	  
Elliot Lee's avatar
Elliot Lee committed
1279 1280 1281
	  g_free (data.data);
	}
    }
1282
  
Elliot Lee's avatar
Elliot Lee committed
1283 1284
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
1285
  
Elliot Lee's avatar
Elliot Lee committed
1286 1287 1288 1289
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
1290
      
Elliot Lee's avatar
Elliot Lee committed
1291
#ifdef DEBUG_SELECTION
1292
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
1293
#endif
1294
      
Elliot Lee's avatar
Elliot Lee committed
1295 1296 1297 1298
      gdk_window_set_events (info->requestor,
			     gdk_window_get_events (info->requestor) |
			     GDK_PROPERTY_CHANGE_MASK);
      current_incrs = g_list_append (current_incrs, info);
1299
      g_timeout_add (1000, (GSourceFunc) gtk_selection_incr_timeout, info);
Elliot Lee's avatar
Elliot Lee committed
1300
    }
1301
  
Elliot Lee's avatar
Elliot Lee committed
1302 1303 1304 1305
  /* If it was a MULTIPLE request, set the property to indicate which
     conversions succeeded */
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
1306 1307 1308 1309 1310 1311 1312
      GdkAtom *mult_atoms = g_new (GdkAtom, 2 * info->num_conversions);
      for (i = 0; i < info->num_conversions; i++)
	{
	  mult_atoms[2*i] = info->conversions[i].target;
	  mult_atoms[2*i+1] = info->conversions[i].property;
	}
      
Elliot Lee's avatar
Elliot Lee committed
1313
      gdk_property_change (info->requestor, event->property,
1314
			   gdk_atom_intern ("ATOM_PAIR", FALSE), 32, 
Elliot Lee's avatar
Elliot Lee committed
1315
			   GDK_PROP_MODE_REPLACE,
1316
			   (guchar *)mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
1317 1318
      g_free (mult_atoms);
    }
1319 1320 1321 1322 1323

  if (info->num_conversions == 1 &&
      info->conversions[0].property == GDK_NONE)
    {
      /* Reject the entire conversion */
1324 1325 1326 1327 1328 1329
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection, 
					     event->target, 
					     GDK_NONE, 
					     event->time);
1330 1331 1332
    }
  else
    {
1333 1334 1335 1336 1337 1338
      gdk_selection_send_notify_for_display (gtk_widget_get_display (widget),
					     event->requestor, 
					     event->selection,
					     event->target,
					     event->property, 
					     event->time);
1339
    }
1340

Elliot Lee's avatar
Elliot Lee committed
1341 1342 1343 1344 1345
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
1346 1347

  g_object_unref (widget);
1348
  
Elliot Lee's avatar
Elliot Lee committed
1349 1350 1351 1352
  return TRUE;
}

/*************************************************************
1353
 * _gtk_selection_incr_event:
Elliot Lee's avatar
Elliot Lee committed
1354 1355 1356 1357 1358 1359 1360
 *     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:
1361 1362
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
1363 1364 1365 1366
 *
 *   results:
 *************************************************************/

1367
gboolean
1368 1369
_gtk_selection_incr_event (GdkWindow	   *window,
			   GdkEventProperty *event)
Elliot Lee's avatar
Elliot Lee committed
1370 1371
{
  GList *tmp_list;
1372
  GtkIncrInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1373 1374
  gint num_bytes;
  guchar *buffer;
1375
  
Elliot Lee's avatar
Elliot Lee committed
1376 1377 1378 1379
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
1380
  
Elliot Lee's avatar
Elliot Lee committed
1381
#ifdef DEBUG_SELECTION
1382
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
1383
#endif
1384
  
Elliot Lee's avatar
Elliot Lee committed
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
  /* 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;
    }
1395
  
Elliot Lee's avatar
Elliot Lee committed
1396 1397
  if (tmp_list == NULL)
    return FALSE;
1398
  
Elliot Lee's avatar
Elliot Lee committed
1399 1400 1401 1402 1403 1404
  /* 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)
	{
1405 1406
	  int bytes_per_item;
	  
Elliot Lee's avatar
Elliot Lee committed
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
	  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;
1421
	      
Elliot Lee's avatar
Elliot Lee committed
1422 1423 1424 1425 1426 1427 1428 1429 1430
	      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
1431 1432 1433
	  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
1434
#endif
1435 1436

	  bytes_per_item = gtk_selection_bytes_per_item (info->conversions[i].data.format);
Elliot Lee's avatar
Elliot Lee committed
1437 1438 1439 1440
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
1441 1442
			       buffer,
			       num_bytes / bytes_per_item);
1443
	  
Elliot Lee's avatar
Elliot Lee committed
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
	  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;
    }
1458
  
Elliot Lee's avatar
Elliot Lee committed
1459
  /* Check if we're finished with all the targets */
1460
  
Elliot Lee's avatar
Elliot Lee committed
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
  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:
1476
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
1477 1478 1479 1480 1481 1482 1483
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1484 1485
  gboolean retval;

1486
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1487 1488 1489
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1490
  
Elliot Lee's avatar
Elliot Lee committed
1491 1492 1493 1494 1495 1496 1497 1498 1499
  tmp_list = current_incrs;
  while (tmp_list)
    {
      if (info == (GtkIncrInfo *)tmp_list->data)
	break;
      tmp_list = tmp_list->next;
    }
  
  /* If retrieval is finished */
Owen Taylor's avatar
Owen Taylor committed
1500
  if (!tmp_list || info->idle_time >= IDLE_ABORT_TIME)
Elliot Lee's avatar
Elliot Lee committed
1501
    {
Owen Taylor's avatar
Owen Taylor committed
1502
      if (tmp_list && info->idle_time >= IDLE_ABORT_TIME)
Elliot Lee's avatar
Elliot Lee committed
1503 1504 1505 1506 1507 1508 1509 1510
	{
	  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? */
1511
      
Elliot Lee's avatar
Elliot Lee committed