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
/* This file implements most of the work of the ICCCM selection protocol.
Elliot Lee's avatar
Elliot Lee committed
21 22 23 24
 * 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.
 *
25
 * The one thing in the ICCCM that isn't fully supported here (or in Tk)
Elliot Lee's avatar
Elliot Lee committed
26 27 28 29 30
 * 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/. 
 */

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

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

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

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

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

#define IDLE_ABORT_TIME 300

Elliot Lee's avatar
Elliot Lee committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
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
{
94 95 96 97
  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
98 99 100 101
};

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
};

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

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

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

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

/*
 * Target lists
 */

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

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

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

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

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

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

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

303 304 305 306 307
/**
 * 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.
308
 * @time_: timestamp with which to claim the selection
Elliot Lee's avatar
Elliot Lee committed
309
 *
310 311 312 313
 * 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
314 315
 * 
 * Since: 2.2
316
 */
317
gboolean
318 319 320 321
gtk_selection_owner_set_for_display (GdkDisplay   *display,
				     GtkWidget    *widget,
				     GdkAtom       selection,
				     guint32       time)
Elliot Lee's avatar
Elliot Lee committed
322 323 324
{
  GList *tmp_list;
  GtkWidget *old_owner;
325
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
326
  GdkWindow *window;
327

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

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

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

406 407 408 409
/**
 * gtk_selection_owner_set:
 * @widget:  a #GtkWidget, or %NULL.
 * @selection:  an interned atom representing the selection to claim
410
 * @time_: timestamp with which to claim the selection
411 412 413 414 415 416 417 418 419 420 421
 * 
 * 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)
{
422 423
  GdkDisplay *display;
  
424
  g_return_val_if_fail (widget == NULL || GTK_WIDGET_REALIZED (widget), FALSE);
425
  g_return_val_if_fail (selection != GDK_NONE, FALSE);
426 427 428 429 430 431 432 433

  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
434
      display = gdk_display_get_default ();
435
    }
436
  
437 438
  return gtk_selection_owner_set_for_display (display, widget,
					      selection, time);
439 440
}

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

454
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
455

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

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

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

  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
485
  g_object_set_data (G_OBJECT (widget), gtk_selection_handler_key, lists);
486 487 488 489 490 491 492 493 494 495 496

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

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

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

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

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

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

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

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

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

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

585

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

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

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

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

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

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

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

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
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;
}

866 867 868 869
/**
 * gtk_selection_data_set_text:
 * @selection_data: a #GtkSelectionData
 * @str: a UTF-8 string
870
 * @len: the length of @str, or -1 if @str is nul-terminated.
871 872 873 874 875
 * 
 * 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
876
 * Return value: %TRUE if the selection was successfully set,
877 878 879 880
 *   otherwise %FALSE.
 **/
gboolean
gtk_selection_data_set_text (GtkSelectionData     *selection_data,
881 882
			     const gchar          *str,
			     gint                  len)
883
{
884 885 886
  if (len < 0)
    len = strlen (str);
  
887 888 889 890 891 892
  init_atoms ();

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

  return FALSE;
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 936
}

/**
 * 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;
937 938 939 940 941 942
      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);
943 944 945 946 947 948 949 950 951 952 953
      if (count > 0)
	result = list[0];

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

  return result;
}

954 955 956 957 958 959 960
/**
 * 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
961
 * Gets the contents of @selection_data as an array of targets.
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 1000
 * 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
1001
 * determines if any of the targets in @targets can be used to
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 1031
 * 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
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
/*************************************************************
 * 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);
1047 1048

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

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


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

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

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

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

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

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

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

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

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

	  bytes_per_item = gtk_selection_bytes_per_item (info->conversions[i].data.format);
Elliot Lee's avatar
Elliot Lee committed
1438 1439 1440 1441
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
1442 1443
			       buffer,
			       num_bytes / bytes_per_item);
1444
	  
Elliot Lee's avatar
Elliot Lee committed
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;
	    }
	}
    }
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
    {