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

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

/* 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
49
50
51
52
53
/*
 * Modified by the GTK+ Team and others 1997-1999.  See the AUTHORS
 * 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
#include "gdkx.h"
Elliot Lee's avatar
Elliot Lee committed
57
58
59
60
61
62
63
64
65
/* we need this for gdk_window_lookup() */
#include "gtkmain.h"
#include "gtkselection.h"
#include "gtksignal.h"

/* #define DEBUG_SELECTION */

/* Maximum size of a sent chunk, in bytes. Also the default size of
   our buffers */
66
#ifdef GDK_WINDOWING_WIN32
67
68
69
/* No chunks on Win32 */
#define GTK_SELECTION_MAX_SIZE G_MAXINT
#else
Elliot Lee's avatar
Elliot Lee committed
70
#define GTK_SELECTION_MAX_SIZE 4000
71
#endif
Elliot Lee's avatar
Elliot Lee committed
72
73
74
75
76
77
78
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
{
  GdkAtom    selection;
  GtkWidget *widget;		/* widget that owns selection */
  guint32    time;		/* time used to acquire selection */
};

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

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

/* Local Functions */
134
135
136
137
static void gtk_selection_init			 (void);
static gint gtk_selection_incr_timeout		 (GtkIncrInfo *info);
static gint gtk_selection_retrieval_timeout	 (GtkRetrievalInfo *info);
static void gtk_selection_retrieval_report	 (GtkRetrievalInfo *info,
Elliot Lee's avatar
Elliot Lee committed
138
						  GdkAtom type, gint format, 
139
140
						  guchar *buffer, gint length,
						  guint32 time);
141
static void gtk_selection_invoke_handler	 (GtkWidget	   *widget,
142
143
						  GtkSelectionData *data,
						  guint             time);
144
static void gtk_selection_default_handler	 (GtkWidget	  *widget,
Elliot Lee's avatar
Elliot Lee committed
145
146
147
148
149
150
151
152
153
						  GtkSelectionData *data);

/* Local Data */
static gint initialize = TRUE;
static GList *current_retrievals = NULL;
static GList *current_incrs = NULL;
static GList *current_selections = NULL;

static GdkAtom gtk_selection_atoms[LAST_ATOM];
Tim Janik's avatar
Tim Janik committed
154
static const char *gtk_selection_handler_key = "gtk-selection-handlers";
Elliot Lee's avatar
Elliot Lee committed
155

156
157
158
159
160
161
162
163
164
/****************
 * Target Lists *
 ****************/

/*
 * Target lists
 */

GtkTargetList *
165
166
gtk_target_list_new (const GtkTargetEntry *targets,
		     guint                 ntargets)
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
{
  GtkTargetList *result = g_new (GtkTargetList, 1);
  result->list = NULL;
  result->ref_count = 1;

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

void               
gtk_target_list_ref (GtkTargetList *list)
{
  list->ref_count++;
}

void               
gtk_target_list_unref (GtkTargetList *list)
{
  list->ref_count--;
  if (list->ref_count == 0)
    {
      GList *tmp_list = list->list;
      while (tmp_list)
	{
Owen Taylor's avatar
Owen Taylor committed
193
194
	  GtkTargetPair *pair = tmp_list->data;
	  g_free (pair);
195
196
197

	  tmp_list = tmp_list->next;
	}
Owen Taylor's avatar
Owen Taylor committed
198
199
      
      g_list_free (list->list);
200
      g_free (list);
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
    }
}

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               
223
224
225
gtk_target_list_add_table (GtkTargetList        *list,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
{
  gint i;

  for (i=ntargets-1; i >= 0; i--)
    {
      GtkTargetPair *pair = g_new (GtkTargetPair, 1);
      pair->target = gdk_atom_intern (targets[i].target, FALSE);
      pair->flags = targets[i].flags;
      pair->info = targets[i].info;
      
      list->list = g_list_prepend (list->list, pair);
    }
}

void 
gtk_target_list_remove (GtkTargetList *list,
			GdkAtom            target)
{
  GList *tmp_list;

  g_return_if_fail (list != NULL);

  tmp_list = list->list;
  while (tmp_list)
    {
      GtkTargetPair *pair = tmp_list->data;
      
      if (pair->target == target)
	{
	  g_free (pair);

	  list->list = g_list_remove (list->list, tmp_list);
	  g_list_free_1 (tmp_list);

	  return;
	}
      
      tmp_list = tmp_list->next;
    }
}

gboolean
gtk_target_list_find (GtkTargetList *list,
		      GdkAtom        target,
		      guint         *info)
{
  GList *tmp_list = list->list;
  while (tmp_list)
    {
      GtkTargetPair *pair = tmp_list->data;

      if (pair->target == target)
	{
	  *info = pair->info;
	  return TRUE;
	}
      tmp_list = tmp_list->next;
    }

  return FALSE;
}


Elliot Lee's avatar
Elliot Lee committed
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/*************************************************************
 * gtk_selection_owner_set:
 *     Claim ownership of a selection.
 *   arguments:
 *     widget:		new selection owner
 *     selection:	which selection
 *     time:		time (use GDK_CURRENT_TIME only if necessary)
 *
 *   results:
 *************************************************************/

gint
gtk_selection_owner_set (GtkWidget *widget,
			 GdkAtom    selection,
			 guint32    time)
{
  GList *tmp_list;
  GtkWidget *old_owner;
307
  GtkSelectionInfo *selection_info = NULL;
Elliot Lee's avatar
Elliot Lee committed
308
  GdkWindow *window;
309
  
Elliot Lee's avatar
Elliot Lee committed
310
311
312
313
314
315
316
317
318
  if (widget == NULL)
    window = NULL;
  else
    {
      if (!GTK_WIDGET_REALIZED (widget))
	gtk_widget_realize (widget);
      
      window = widget->window;
    }
319
  
Elliot Lee's avatar
Elliot Lee committed
320
321
322
323
324
325
326
327
328
329
  tmp_list = current_selections;
  while (tmp_list)
    {
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->selection == selection)
	break;
      
      tmp_list = tmp_list->next;
    }
330
  
Elliot Lee's avatar
Elliot Lee committed
331
332
333
334
335
  if (tmp_list == NULL)
    selection_info = NULL;
  else
    if (selection_info->widget == widget)
      return TRUE;
336
  
Elliot Lee's avatar
Elliot Lee committed
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
  if (gdk_selection_owner_set (window, selection, time, TRUE))
    {
      old_owner = NULL;
      
      if (widget == NULL)
	{
	  if (selection_info)
	    {
	      old_owner = selection_info->widget;
	      current_selections = g_list_remove_link (current_selections,
						       tmp_list);
	      g_list_free (tmp_list);
	      g_free (selection_info);
	    }
	}
      else
	{
	  if (selection_info == NULL)
	    {
	      selection_info = g_new (GtkSelectionInfo, 1);
	      selection_info->selection = selection;
	      selection_info->widget = widget;
	      selection_info->time = time;
	      current_selections = g_list_append (current_selections, 
						  selection_info);
	    }
	  else
	    {
	      old_owner = selection_info->widget;
	      selection_info->widget = widget;
	      selection_info->time = time;
	    }
	}
      /* If another widget in the application lost the selection,
       *  send it a GDK_SELECTION_CLEAR event, unless we're setting
       *  the owner to None, in which case an event will be sent */
      if (old_owner && (widget != NULL))
	{
	  GdkEventSelection event;
	  
	  event.type = GDK_SELECTION_CLEAR;
	  event.window = old_owner->window;
	  event.selection = selection;
	  event.time = time;
381
	  
382
	  gtk_widget_event (old_owner, (GdkEvent *) &event);
Elliot Lee's avatar
Elliot Lee committed
383
384
385
386
387
388
389
390
	}
      return TRUE;
    }
  else
    return FALSE;
}

/*************************************************************
391
392
 * gtk_selection_add_target
 *     Add specified target to list of supported targets
Elliot Lee's avatar
Elliot Lee committed
393
394
 *
 *   arguments:
395
 *     widget:	   The widget for which this target applies
Elliot Lee's avatar
Elliot Lee committed
396
397
 *     selection:
 *     target:
398
 *     info:       guint to pass to to the selection_get signal 
Elliot Lee's avatar
Elliot Lee committed
399
400
401
402
 *
 *   results:
 *************************************************************/

403
typedef struct _GtkSelectionTargetList GtkSelectionTargetList;
404

405
406
407
408
409
410
411
412
struct _GtkSelectionTargetList {
  GdkAtom selection;
  GtkTargetList *list;
};

static GtkTargetList *
gtk_selection_target_list_get (GtkWidget    *widget,
			       GdkAtom       selection)
Elliot Lee's avatar
Elliot Lee committed
413
{
414
  GtkSelectionTargetList *sellist;
Elliot Lee's avatar
Elliot Lee committed
415
  GList *tmp_list;
416
417
418
  GList *lists;

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
419
  
420
  tmp_list = lists;
Elliot Lee's avatar
Elliot Lee committed
421
422
  while (tmp_list)
    {
423
424
425
      sellist = tmp_list->data;
      if (sellist->selection == selection)
	return sellist->list;
Elliot Lee's avatar
Elliot Lee committed
426
427
      tmp_list = tmp_list->next;
    }
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446

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

  lists = g_list_prepend (lists, sellist);
  gtk_object_set_data (GTK_OBJECT (widget), gtk_selection_handler_key, lists);

  return sellist->list;
}

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

  lists = gtk_object_get_data (GTK_OBJECT (widget), gtk_selection_handler_key);
447
  
448
449
  tmp_list = lists;
  while (tmp_list)
Elliot Lee's avatar
Elliot Lee committed
450
    {
451
452
453
454
455
456
      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
457
    }
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477

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

void 
gtk_selection_add_target (GtkWidget	    *widget, 
			  GdkAtom	     selection,
			  GdkAtom	     target,
			  guint              info)
{
  GtkTargetList *list;

  g_return_if_fail (widget != NULL);

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

void 
478
479
480
481
gtk_selection_add_targets (GtkWidget            *widget, 
			   GdkAtom               selection,
			   const GtkTargetEntry *targets,
			   guint                 ntargets)
482
483
484
485
486
{
  GtkTargetList *list;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (targets != NULL);
Elliot Lee's avatar
Elliot Lee committed
487
  
488
489
  list = gtk_selection_target_list_get (widget, selection);
  gtk_target_list_add_table (list, targets, ntargets);
Elliot Lee's avatar
Elliot Lee committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
}

/*************************************************************
 * 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;
509
  
Elliot Lee's avatar
Elliot Lee committed
510
  /* Remove pending requests/incrs for this widget */
511
  
Elliot Lee's avatar
Elliot Lee committed
512
513
514
515
516
517
518
519
520
521
522
523
  tmp_list = current_incrs;
  while (tmp_list)
    {
      next = tmp_list->next;
      if (((GtkIncrInfo *)tmp_list->data)->widget == widget)
	{
	  current_incrs = g_list_remove_link (current_incrs, tmp_list);
	  /* structure will be freed in timeout */
	  g_list_free (tmp_list);
	}
      tmp_list = next;
    }
524
  
Elliot Lee's avatar
Elliot Lee committed
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
  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 */
540
  
Elliot Lee's avatar
Elliot Lee committed
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
  tmp_list = current_selections;
  while (tmp_list)
    {
      next = tmp_list->next;
      selection_info = (GtkSelectionInfo *)tmp_list->data;
      
      if (selection_info->widget == widget)
	{	
	  gdk_selection_owner_set (NULL, 
				   selection_info->selection,
				   GDK_CURRENT_TIME, FALSE);
	  current_selections = g_list_remove_link (current_selections, 
						   tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
      
      tmp_list = next;
    }
560
561
562

  /* Remove all selection lists */
  gtk_selection_target_list_remove (widget);
Elliot Lee's avatar
Elliot Lee committed
563
564
565
566
567
568
569
570
}

/*************************************************************
 * gtk_selection_convert:
 *     Request the contents of a selection. When received, 
 *     a "selection_received" signal will be generated.
 *
 *   arguments:
571
 *     widget:	   The widget which acts as requestor
Elliot Lee's avatar
Elliot Lee committed
572
 *     selection:  Which selection to get
573
574
575
 *     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
576
577
578
579
580
581
582
583
584
 *
 *   results:
 *     TRUE if requested succeeded. FALSE if we could not process
 *     request. (e.g., there was already a request in process for
 *     this widget). 
 *************************************************************/

gint
gtk_selection_convert (GtkWidget *widget, 
585
586
587
		       GdkAtom	  selection, 
		       GdkAtom	  target,
		       guint32	  time)
Elliot Lee's avatar
Elliot Lee committed
588
589
590
591
{
  GtkRetrievalInfo *info;
  GList *tmp_list;
  GdkWindow *owner_window;
592
  
Elliot Lee's avatar
Elliot Lee committed
593
  g_return_val_if_fail (widget != NULL, FALSE);
594
  
Elliot Lee's avatar
Elliot Lee committed
595
596
597
598
599
  if (initialize)
    gtk_selection_init ();
  
  if (!GTK_WIDGET_REALIZED (widget))
    gtk_widget_realize (widget);
600
  
Elliot Lee's avatar
Elliot Lee committed
601
602
603
604
605
  /* 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. */
606
  
Elliot Lee's avatar
Elliot Lee committed
607
608
609
610
611
612
613
614
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	return FALSE;
      tmp_list = tmp_list->next;
    }
615
  
Elliot Lee's avatar
Elliot Lee committed
616
  info = g_new (GtkRetrievalInfo, 1);
617
  
Elliot Lee's avatar
Elliot Lee committed
618
619
620
621
622
  info->widget = widget;
  info->selection = selection;
  info->target = target;
  info->buffer = NULL;
  info->offset = -1;
623
  
Elliot Lee's avatar
Elliot Lee committed
624
625
  /* Check if this process has current owner. If so, call handler
     procedure directly to avoid deadlocks with INCR. */
626
  
Elliot Lee's avatar
Elliot Lee committed
627
628
629
630
631
632
  owner_window = gdk_selection_owner_get (selection);
  
  if (owner_window != NULL)
    {
      GtkWidget *owner_widget;
      GtkSelectionData selection_data;
633
      
Elliot Lee's avatar
Elliot Lee committed
634
635
636
637
      selection_data.selection = selection;
      selection_data.target = target;
      selection_data.data = NULL;
      selection_data.length = -1;
638
      
Elliot Lee's avatar
Elliot Lee committed
639
      gdk_window_get_user_data (owner_window, (gpointer *)&owner_widget);
640
      
Elliot Lee's avatar
Elliot Lee committed
641
642
      if (owner_widget != NULL)
	{
643
	  gtk_selection_invoke_handler (owner_widget, 
644
645
					&selection_data,
					time);
646
	  
Elliot Lee's avatar
Elliot Lee committed
647
648
649
650
	  gtk_selection_retrieval_report (info,
					  selection_data.type, 
					  selection_data.format,
					  selection_data.data,
651
652
					  selection_data.length,
					  time);
653
	  
Elliot Lee's avatar
Elliot Lee committed
654
655
656
657
658
659
660
661
	  g_free (selection_data.data);
	  
	  g_free (info);
	  return TRUE;
	}
    }
  
  /* Otherwise, we need to go through X */
662
  
Elliot Lee's avatar
Elliot Lee committed
663
664
665
  current_retrievals = g_list_append (current_retrievals, info);
  gdk_selection_convert (widget->window, selection, target, time);
  gtk_timeout_add (1000, (GtkFunction) gtk_selection_retrieval_timeout, info);
666
  
Elliot Lee's avatar
Elliot Lee committed
667
668
669
670
671
672
673
674
675
676
  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
677
678
679
 *     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
680
681
682
683
684
 *   results:
 *************************************************************/

void 
gtk_selection_data_set (GtkSelectionData *selection_data,
685
686
687
688
			GdkAtom		  type,
			gint		  format,
			guchar		 *data,
			gint		  length)
Elliot Lee's avatar
Elliot Lee committed
689
690
691
{
  if (selection_data->data)
    g_free (selection_data->data);
692
  
Elliot Lee's avatar
Elliot Lee committed
693
694
  selection_data->type = type;
  selection_data->format = format;
695
  
Elliot Lee's avatar
Elliot Lee committed
696
697
698
699
700
701
702
  if (data)
    {
      selection_data->data = g_new (guchar, length+1);
      memcpy (selection_data->data, data, length);
      selection_data->data[length] = 0;
    }
  else
703
704
705
706
707
708
709
710
    {
      g_return_if_fail (length <= 0);
      
      if (length < 0)
	selection_data->data = NULL;
      else
	selection_data->data = g_strdup("");
    }
711
  
Elliot Lee's avatar
Elliot Lee committed
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
  selection_data->length = length;
}

/*************************************************************
 * gtk_selection_init:
 *     Initialize local variables
 *   arguments:
 *     
 *   results:
 *************************************************************/

static void
gtk_selection_init (void)
{
  gtk_selection_atoms[INCR] = gdk_atom_intern ("INCR", FALSE);
  gtk_selection_atoms[MULTIPLE] = gdk_atom_intern ("MULTIPLE", FALSE);
  gtk_selection_atoms[TIMESTAMP] = gdk_atom_intern ("TIMESTAMP", FALSE);
  gtk_selection_atoms[TARGETS] = gdk_atom_intern ("TARGETS", FALSE);
}

/*************************************************************
 * gtk_selection_clear:
 *     Handler for "selection_clear_event"
 *   arguments:
 *     widget:
 *     event:
 *   results:
 *************************************************************/

gint
gtk_selection_clear (GtkWidget *widget,
		     GdkEventSelection *event)
{
  /* FIXME: there can be a problem if we change the selection
     via gtk_selection_owner_set after another client claims 
     the selection, but before we get the notification event.
     Tk filters based on serial #'s, which aren't retained by
     GTK. Filtering based on time's will be inherently 
     somewhat unreliable. */
751
  
Elliot Lee's avatar
Elliot Lee committed
752
  GList *tmp_list;
753
  GtkSelectionInfo *selection_info = NULL;
754
  
Elliot Lee's avatar
Elliot Lee committed
755
756
757
758
759
760
761
762
763
764
765
  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;
    }
766
  
767
768
769
770
  if (tmp_list)
    {
      if (selection_info->time > event->time)
	return FALSE;		/* return FALSE to indicate that
771
772
				 * the selection was out of date,
				 * and this clear should be ignored */
773
774
775
776
777
778
779
780
      else
	{
	  current_selections = g_list_remove_link (current_selections, tmp_list);
	  g_list_free (tmp_list);
	  g_free (selection_info);
	}
    }
  
Elliot Lee's avatar
Elliot Lee committed
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
  return TRUE;
}


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

gint
gtk_selection_request (GtkWidget *widget,
		       GdkEventSelection *event)
{
  GtkIncrInfo *info;
  GList *tmp_list;
  guchar *mult_atoms;
  int i;
802
  
803
804
805
  if (initialize)
    gtk_selection_init ();
  
Elliot Lee's avatar
Elliot Lee committed
806
  /* Check if we own selection */
807
  
Elliot Lee's avatar
Elliot Lee committed
808
809
810
811
  tmp_list = current_selections;
  while (tmp_list)
    {
      GtkSelectionInfo *selection_info = (GtkSelectionInfo *)tmp_list->data;
812
      
Elliot Lee's avatar
Elliot Lee committed
813
814
815
      if ((selection_info->selection == event->selection) &&
	  (selection_info->widget == widget))
	break;
816
      
Elliot Lee's avatar
Elliot Lee committed
817
818
      tmp_list = tmp_list->next;
    }
819
  
Elliot Lee's avatar
Elliot Lee committed
820
821
822
823
  if (tmp_list == NULL)
    return FALSE;
  
  info = g_new(GtkIncrInfo, 1);
824
  
Elliot Lee's avatar
Elliot Lee committed
825
826
827
  info->widget = widget;
  info->selection = event->selection;
  info->num_incrs = 0;
828
  
Elliot Lee's avatar
Elliot Lee committed
829
  /* Create GdkWindow structure for the requestor */
830
  
Elliot Lee's avatar
Elliot Lee committed
831
832
833
834
835
  info->requestor = gdk_window_lookup (event->requestor);
  if (!info->requestor)
    info->requestor = gdk_window_foreign_new (event->requestor);
  
  /* Determine conversions we need to perform */
836
  
Elliot Lee's avatar
Elliot Lee committed
837
838
839
840
841
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      GdkAtom  type;
      gint     format;
      gint     length;
842
      
Elliot Lee's avatar
Elliot Lee committed
843
      mult_atoms = NULL;
844
      if (!gdk_property_get (info->requestor, event->property, 0, /* AnyPropertyType */
Elliot Lee's avatar
Elliot Lee committed
845
			     0, GTK_SELECTION_MAX_SIZE, FALSE,
846
			     &type, &format, &length, &mult_atoms))
Elliot Lee's avatar
Elliot Lee committed
847
848
849
850
851
852
853
	{
	  gdk_selection_send_notify (event->requestor, event->selection,
				     event->target, GDK_NONE, event->time);
	  g_free (mult_atoms);
	  g_free (info);
	  return TRUE;
	}
854
      
Elliot Lee's avatar
Elliot Lee committed
855
856
      info->num_conversions = length / (2*sizeof (GdkAtom));
      info->conversions = g_new (GtkIncrConversion, info->num_conversions);
857
      
Elliot Lee's avatar
Elliot Lee committed
858
859
860
861
862
863
864
865
866
867
868
869
870
871
      for (i=0; i<info->num_conversions; i++)
	{
	  info->conversions[i].target = ((GdkAtom *)mult_atoms)[2*i];
	  info->conversions[i].property = ((GdkAtom *)mult_atoms)[2*i+1];
	}
    }
  else				/* only a single conversion */
    {
      info->conversions = g_new (GtkIncrConversion, 1);
      info->num_conversions = 1;
      info->conversions[0].target = event->target;
      info->conversions[0].property = event->property;
      mult_atoms = (guchar *)info->conversions;
    }
872
  
Elliot Lee's avatar
Elliot Lee committed
873
874
875
876
877
878
  /* Loop through conversions and determine which of these are big
     enough to require doing them via INCR */
  for (i=0; i<info->num_conversions; i++)
    {
      GtkSelectionData data;
      gint items;
879
      
Elliot Lee's avatar
Elliot Lee committed
880
881
882
883
      data.selection = event->selection;
      data.target = info->conversions[i].target;
      data.data = NULL;
      data.length = -1;
884
      
Elliot Lee's avatar
Elliot Lee committed
885
#ifdef DEBUG_SELECTION
886
887
888
889
      g_message ("Selection %ld, target %ld (%s) requested by 0x%x (property = %ld)",
		 event->selection, info->conversions[i].target,
		 gdk_atom_name(info->conversions[i].target),
		 event->requestor, event->property);
Elliot Lee's avatar
Elliot Lee committed
890
#endif
891
      
892
      gtk_selection_invoke_handler (widget, &data, event->time);
893
      
Elliot Lee's avatar
Elliot Lee committed
894
895
896
897
898
899
      if (data.length < 0)
	{
	  ((GdkAtom *)mult_atoms)[2*i+1] = GDK_NONE;
	  info->conversions[i].property = GDK_NONE;
	  continue;
	}
900
      
Tim Janik's avatar
GLib:    
Tim Janik committed
901
      g_return_val_if_fail ((data.format >= 8) && (data.format % 8 == 0), FALSE);
902
      
Elliot Lee's avatar
Elliot Lee committed
903
      items = (data.length + data.format/8 - 1) / (data.format/8);
904
      
Elliot Lee's avatar
Elliot Lee committed
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
      if (data.length > GTK_SELECTION_MAX_SIZE)
	{
	  /* Sending via INCR */
	  
	  info->conversions[i].offset = 0;
	  info->conversions[i].data = data;
	  info->num_incrs++;
	  
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       gtk_selection_atoms[INCR],
			       8*sizeof (GdkAtom),
			       GDK_PROP_MODE_REPLACE,
			       (guchar *)&items, 1);
	}
      else
	{
	  info->conversions[i].offset = -1;
923
	  
Elliot Lee's avatar
Elliot Lee committed
924
925
926
927
928
929
	  gdk_property_change (info->requestor, 
			       info->conversions[i].property,
			       data.type,
			       data.format,
			       GDK_PROP_MODE_REPLACE,
			       data.data, items);
930
	  
Elliot Lee's avatar
Elliot Lee committed
931
932
933
	  g_free (data.data);
	}
    }
934
  
Elliot Lee's avatar
Elliot Lee committed
935
936
  /* If we have some INCR's, we need to send the rest of the data in
     a callback */
937
  
Elliot Lee's avatar
Elliot Lee committed
938
939
940
941
  if (info->num_incrs > 0)
    {
      /* FIXME: this could be dangerous if window doesn't still
	 exist */
942
      
Elliot Lee's avatar
Elliot Lee committed
943
#ifdef DEBUG_SELECTION
944
      g_message ("Starting INCR...");
Elliot Lee's avatar
Elliot Lee committed
945
#endif
946
      
Elliot Lee's avatar
Elliot Lee committed
947
948
949
950
951
952
      gdk_window_set_events (info->requestor,
			     gdk_window_get_events (info->requestor) |
			     GDK_PROPERTY_CHANGE_MASK);
      current_incrs = g_list_append (current_incrs, info);
      gtk_timeout_add (1000, (GtkFunction)gtk_selection_incr_timeout, info);
    }
953
  
Elliot Lee's avatar
Elliot Lee committed
954
955
956
957
958
959
960
  /* If it was a MULTIPLE request, set the property to indicate which
     conversions succeeded */
  if (event->target == gtk_selection_atoms[MULTIPLE])
    {
      gdk_property_change (info->requestor, event->property,
			   GDK_SELECTION_TYPE_ATOM, 8*sizeof(GdkAtom), 
			   GDK_PROP_MODE_REPLACE,
961
			   mult_atoms, 2*info->num_conversions);
Elliot Lee's avatar
Elliot Lee committed
962
963
      g_free (mult_atoms);
    }
964
  
Elliot Lee's avatar
Elliot Lee committed
965
966
  gdk_selection_send_notify (event->requestor, event->selection, event->target,
			     event->property, event->time);
967
  
Elliot Lee's avatar
Elliot Lee committed
968
969
970
971
972
  if (info->num_incrs == 0)
    {
      g_free (info->conversions);
      g_free (info);
    }
973
  
Elliot Lee's avatar
Elliot Lee committed
974
975
976
977
978
979
980
981
982
983
984
985
  return TRUE;
}

/*************************************************************
 * gtk_selection_incr_event:
 *     Called whenever an PropertyNotify event occurs for an 
 *     GdkWindow with user_data == NULL. These will be notifications
 *     that a window we are sending the selection to via the
 *     INCR protocol has deleted a property and is ready for
 *     more data.
 *
 *   arguments:
986
987
 *     window:	the requestor window
 *     event:	the property event structure
Elliot Lee's avatar
Elliot Lee committed
988
989
990
991
992
 *
 *   results:
 *************************************************************/

gint
993
gtk_selection_incr_event (GdkWindow	   *window,
Elliot Lee's avatar
Elliot Lee committed
994
995
996
			  GdkEventProperty *event)
{
  GList *tmp_list;
997
  GtkIncrInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
998
999
  gint num_bytes;
  guchar *buffer;
1000
  
Elliot Lee's avatar
Elliot Lee committed
1001
1002
1003
1004
  int i;
  
  if (event->state != GDK_PROPERTY_DELETE)
    return FALSE;
1005
  
Elliot Lee's avatar
Elliot Lee committed
1006
#ifdef DEBUG_SELECTION
1007
  g_message ("PropertyDelete, property %ld", event->atom);
Elliot Lee's avatar
Elliot Lee committed
1008
#endif
1009
  
Elliot Lee's avatar
Elliot Lee committed
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
  /* 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;
    }
1020
  
Elliot Lee's avatar
Elliot Lee committed
1021
1022
  if (tmp_list == NULL)
    return FALSE;
1023
  
Elliot Lee's avatar
Elliot Lee committed
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
  /* Find out which target this is for */
  for (i=0; i<info->num_conversions; i++)
    {
      if (info->conversions[i].property == event->atom &&
	  info->conversions[i].offset != -1)
	{
	  info->idle_time = 0;
	  
	  if (info->conversions[i].offset == -2) /* only the last 0-length
						    piece*/
	    {
	      num_bytes = 0;
	      buffer = NULL;
	    }
	  else
	    {
	      num_bytes = info->conversions[i].data.length -
		info->conversions[i].offset;
	      buffer = info->conversions[i].data.data + 
		info->conversions[i].offset;
1044
	      
Elliot Lee's avatar
Elliot Lee committed
1045
1046
1047
1048
1049
1050
1051
1052
1053
	      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
1054
1055
1056
	  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
1057
1058
1059
1060
1061
1062
1063
1064
#endif
	  gdk_property_change (info->requestor, event->atom,
			       info->conversions[i].data.type,
			       info->conversions[i].data.format,
			       GDK_PROP_MODE_REPLACE,
			       buffer, 
			       (num_bytes + info->conversions[i].data.format/8 - 1) / 
			       (info->conversions[i].data.format/8));
1065
	  
Elliot Lee's avatar
Elliot Lee committed
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
	  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;
    }
1080
  
Elliot Lee's avatar
Elliot Lee committed
1081
  /* Check if we're finished with all the targets */
1082
  
Elliot Lee's avatar
Elliot Lee committed
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
  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:
1098
 *     info:	Information about this incr
Elliot Lee's avatar
Elliot Lee committed
1099
1100
1101
1102
1103
1104
1105
 *   results:
 *************************************************************/

static gint
gtk_selection_incr_timeout (GtkIncrInfo *info)
{
  GList *tmp_list;
1106
1107
  gboolean retval;

1108
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1109
1110
1111
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1112
  
Elliot Lee's avatar
Elliot Lee committed
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
  tmp_list = current_incrs;
  while (tmp_list)
    {
      if (info == (GtkIncrInfo *)tmp_list->data)
	break;
      tmp_list = tmp_list->next;
    }
  
  /* If retrieval is finished */
  if (!tmp_list || info->idle_time >= 5)
    {
      if (tmp_list && info->idle_time >= 5)
	{
	  current_incrs = g_list_remove_link (current_incrs, tmp_list);
	  g_list_free (tmp_list);
	}
      
      g_free (info->conversions);
      /* FIXME: we should check if requestor window is still in use,
	 and if not, remove it? */
1133
      
Elliot Lee's avatar
Elliot Lee committed
1134
1135
      g_free (info);
      
1136
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1137
1138
1139
1140
1141
    }
  else
    {
      info->idle_time++;
      
1142
      retval = TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1143
    }
1144
  
1145
  GDK_THREADS_LEAVE ();
1146
1147

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1148
1149
1150
1151
1152
1153
1154
1155
}

/*************************************************************
 * gtk_selection_notify:
 *     Handler for "selection_notify_event" signals on windows
 *     where a retrieval is currently in process. The selection
 *     owner has responded to our conversion request.
 *   arguments:
1156
1157
1158
 *     widget:		Widget getting signal
 *     event:		Selection event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1159
1160
1161
1162
1163
 *   results:
 *     was event handled?
 *************************************************************/

gint
1164
gtk_selection_notify (GtkWidget	       *widget,
Elliot Lee's avatar
Elliot Lee committed
1165
1166
1167
		      GdkEventSelection *event)
{
  GList *tmp_list;
1168
  GtkRetrievalInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1169
1170
1171
  guchar  *buffer;
  gint length;
  GdkAtom type;
1172
  gint	  format;
Elliot Lee's avatar
Elliot Lee committed
1173
1174
  
#ifdef DEBUG_SELECTION
1175
1176
  g_message ("Initial receipt of selection %ld, target %ld (property = %ld)",
	     event->selection, event->target, event->property);
Elliot Lee's avatar
Elliot Lee committed
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget && info->selection == event->selection)
	break;
      tmp_list = tmp_list->next;
    }
1187
  
Elliot Lee's avatar
Elliot Lee committed
1188
1189
  if (!tmp_list)		/* no retrieval in progress */
    return FALSE;
1190
  
Elliot Lee's avatar
Elliot Lee committed
1191
1192
1193
1194
1195
1196
  if (event->property == GDK_NONE)
    {
      current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
      g_list_free (tmp_list);
      /* structure will be freed in timeout */
      gtk_selection_retrieval_report (info,
1197
				      GDK_NONE, 0, NULL, -1, event->time);
1198
      
Elliot Lee's avatar
Elliot Lee committed
1199
1200
1201
1202
1203
      return TRUE;
    }
  
  length = gdk_selection_property_get (widget->window, &buffer, 
				       &type, &format);
1204
  
Elliot Lee's avatar
Elliot Lee committed
1205
1206
1207
1208
  if (type == gtk_selection_atoms[INCR])
    {
      /* The remainder of the selection will come through PropertyNotify
	 events */
1209
1210

      info->notify_time = event->time;
Elliot Lee's avatar
Elliot Lee committed
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
      info->idle_time = 0;
      info->offset = 0;		/* Mark as OK to proceed */
      gdk_window_set_events (widget->window,
			     gdk_window_get_events (widget->window)
			     | GDK_PROPERTY_CHANGE_MASK);
    }
  else
    {
      /* We don't delete the info structure - that will happen in timeout */
      current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
      g_list_free (tmp_list);
1222
      
Elliot Lee's avatar
Elliot Lee committed
1223
1224
1225
      info->offset = length;
      gtk_selection_retrieval_report (info,
				      type, format, 
1226
				      buffer, length, event->time);
Elliot Lee's avatar
Elliot Lee committed
1227
    }
1228
  
Elliot Lee's avatar
Elliot Lee committed
1229
  gdk_property_delete (widget->window, event->property);
1230
  
Elliot Lee's avatar
Elliot Lee committed
1231
  g_free (buffer);
1232
  
Elliot Lee's avatar
Elliot Lee committed
1233
1234
1235
1236
1237
1238
1239
1240
1241
  return TRUE;
}

/*************************************************************
 * gtk_selection_property_notify:
 *     Handler for "property_notify_event" signals on windows
 *     where a retrieval is currently in process. The selection
 *     owner has added more data.
 *   arguments:
1242
1243
1244
 *     widget:		Widget getting signal
 *     event:		Property event structure
 *     info:		Information about this retrieval
Elliot Lee's avatar
Elliot Lee committed
1245
1246
1247
1248
1249
 *   results:
 *     was event handled?
 *************************************************************/

gint
1250
gtk_selection_property_notify (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1251
1252
1253
			       GdkEventProperty *event)
{
  GList *tmp_list;
1254
  GtkRetrievalInfo *info = NULL;
Elliot Lee's avatar
Elliot Lee committed
1255
1256
1257
  guchar *new_buffer;
  int length;
  GdkAtom type;
1258
  gint	  format;
1259
  
1260
1261
1262
  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

Elliot Lee's avatar
Elliot Lee committed
1263
1264
1265
  if ((event->state != GDK_PROPERTY_NEW_VALUE) ||  /* property was deleted */
      (event->atom != gdk_selection_property)) /* not the right property */
    return FALSE;
1266
  
Elliot Lee's avatar
Elliot Lee committed
1267
#ifdef DEBUG_SELECTION
1268
1269
  g_message ("PropertyNewValue, property %ld",
	     event->atom);
Elliot Lee's avatar
Elliot Lee committed
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
#endif
  
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      info = (GtkRetrievalInfo *)tmp_list->data;
      if (info->widget == widget)
	break;
      tmp_list = tmp_list->next;
    }
1280
  
Elliot Lee's avatar
Elliot Lee committed
1281
1282
  if (!tmp_list)		/* No retrieval in progress */
    return FALSE;
1283
  
Elliot Lee's avatar
Elliot Lee committed
1284
1285
1286
  if (info->offset < 0)		/* We haven't got the SelectionNotify
				   for this retrieval yet */
    return FALSE;
1287
  
Elliot Lee's avatar
Elliot Lee committed
1288
1289
1290
1291
1292
  info->idle_time = 0;
  
  length = gdk_selection_property_get (widget->window, &new_buffer, 
				       &type, &format);
  gdk_property_delete (widget->window, event->atom);
1293
  
Elliot Lee's avatar
Elliot Lee committed
1294
1295
1296
1297
  /* We could do a lot better efficiency-wise by paying attention to
     what length was sent in the initial INCR transaction, instead of
     doing memory allocation at every step. But its only guaranteed to
     be a _lower bound_ (pretty useless!) */
1298
  
Elliot Lee's avatar
Elliot Lee committed
1299
1300
1301
1302
1303
1304
1305
1306
  if (length == 0 || type == GDK_NONE)		/* final zero length portion */
    {
      /* Info structure will be freed in timeout */
      current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
      g_list_free (tmp_list);
      gtk_selection_retrieval_report (info,
				      type, format, 
				      (type == GDK_NONE) ?  NULL : info->buffer,
1307
1308
				      (type == GDK_NONE) ?  -1 : info->offset,
				      info->notify_time);
Elliot Lee's avatar
Elliot Lee committed
1309
1310
1311
1312
1313
1314
    }
  else				/* append on newly arrived data */
    {
      if (!info->buffer)
	{
#ifdef DEBUG_SELECTION
1315
1316
	  g_message ("Start - Adding %d bytes at offset 0",
		     length);
Elliot Lee's avatar
Elliot Lee committed
1317
1318
1319
1320
1321
1322
#endif
	  info->buffer = new_buffer;
	  info->offset = length;
	}
      else
	{
1323
	  
Elliot Lee's avatar
Elliot Lee committed
1324
#ifdef DEBUG_SELECTION
1325
1326
	  g_message ("Appending %d bytes at offset %d",
		     length,info->offset);
Elliot Lee's avatar
Elliot Lee committed
1327
1328
1329
1330
1331
1332
1333
1334
#endif
	  /* We copy length+1 bytes to preserve guaranteed null termination */
	  info->buffer = g_realloc (info->buffer, info->offset+length+1);
	  memcpy (info->buffer + info->offset, new_buffer, length+1);
	  info->offset += length;
	  g_free (new_buffer);
	}
    }
1335
  
Elliot Lee's avatar
Elliot Lee committed
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
  return TRUE;
}

/*************************************************************
 * gtk_selection_retrieval_timeout:
 *     Timeout callback while receiving a selection.
 *   arguments:
 *     info:	Information about this retrieval
 *   results:
 *************************************************************/

static gint
gtk_selection_retrieval_timeout (GtkRetrievalInfo *info)
{
  GList *tmp_list;
1351
1352
  gboolean retval;

1353
  GDK_THREADS_ENTER ();
Elliot Lee's avatar
Elliot Lee committed
1354
1355
1356
  
  /* Determine if retrieval has finished by checking if it still in
     list of pending retrievals */
1357
  
Elliot Lee's avatar
Elliot Lee committed
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
  tmp_list = current_retrievals;
  while (tmp_list)
    {
      if (info == (GtkRetrievalInfo *)tmp_list->data)
	break;
      tmp_list = tmp_list->next;
    }
  
  /* If retrieval is finished */
  if (!tmp_list || info->idle_time >= 5)
    {
      if (tmp_list && info->idle_time >= 5)
	{
	  current_retrievals = g_list_remove_link (current_retrievals, tmp_list);
	  g_list_free (tmp_list);
1373
	  gtk_selection_retrieval_report (info, GDK_NONE, 0, NULL, -1, GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
1374
1375
1376
1377
1378
	}
      
      g_free (info->buffer);
      g_free (info);
      
1379
      retval =  FALSE;		/* remove timeout */
Elliot Lee's avatar
Elliot Lee committed
1380
1381
1382
1383
1384
    }
  else
    {
      info->idle_time++;
      
1385
      retval =  TRUE;		/* timeout will happen again */
Elliot Lee's avatar
Elliot Lee committed
1386
    }
1387

1388
  GDK_THREADS_LEAVE ();
1389
1390

  return retval;
Elliot Lee's avatar
Elliot Lee committed
1391
1392
1393
1394
1395
1396
}

/*************************************************************
 * gtk_selection_retrieval_report:
 *     Emits a "selection_received" signal.
 *   arguments:
1397
1398
 *     info:	  information about the retrieval that completed
 *     buffer:	  buffer containing data (NULL => errror)
1399
 *     time:      timestamp for data in buffer
Elliot Lee's avatar
Elliot Lee committed
1400
1401
1402
1403
1404
1405
 *   results:
 *************************************************************/

static void
gtk_selection_retrieval_report (GtkRetrievalInfo *info,
				GdkAtom type, gint format, 
1406
1407
				guchar *buffer, gint length,
				guint32 time)
Elliot Lee's avatar
Elliot Lee committed
1408
1409
{
  GtkSelectionData data;
1410
  
Elliot Lee's avatar
Elliot Lee committed
1411
1412
1413
1414
  data.selection = info->selection;
  data.target = info->target;
  data.type = type;
  data.format = format;
1415
  
Elliot Lee's avatar
Elliot Lee committed
1416
1417
  data.length = length;
  data.data = buffer;
1418
  
Elliot Lee's avatar
Elliot Lee committed
1419
  gtk_signal_emit_by_name (GTK_OBJECT(info->widget),
1420
1421
			   "selection_received", 
			   &data, time);
Elliot Lee's avatar
Elliot Lee committed
1422
1423
1424
}

/*************************************************************
1425
1426
1427
1428
1429
 * gtk_selection_invoke_handler:
 *     Finds and invokes handler for specified
 *     widget/selection/target combination, calls 
 *     gtk_selection_default_handler if none exists.
 *
Elliot Lee's avatar
Elliot Lee committed
1430
 *   arguments:
1431
1432
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1433
 *     time:        time from requeset
1434
 *     
Elliot Lee's avatar
Elliot Lee committed
1435
 *   results:
1436
 *     Number of bytes written to buffer, -1 if error
Elliot Lee's avatar
Elliot Lee committed
1437
1438
 *************************************************************/

1439
static void
1440
gtk_selection_invoke_handler (GtkWidget	       *widget,
1441
1442
			      GtkSelectionData *data,
			      guint             time)
Elliot Lee's avatar
Elliot Lee committed
1443
{
1444
1445
  GtkTargetList *target_list;
  guint info;
1446
  
1447

1448
  g_return_if_fail (widget != NULL);
1449
1450
1451
1452

  target_list = gtk_selection_target_list_get (widget, data->selection);
  if (target_list && 
      gtk_target_list_find (target_list, data->target, &info))
Elliot Lee's avatar
Elliot Lee committed
1453
    {
1454
1455
1456
1457
      gtk_signal_emit_by_name (GTK_OBJECT (widget), 
			       "selection_get",
			       data,
			       info, time);
Elliot Lee's avatar
Elliot Lee committed
1458
    }
1459
  else
1460
    gtk_selection_default_handler (widget, data);
Elliot Lee's avatar
Elliot Lee committed
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
}

/*************************************************************
 * gtk_selection_default_handler:
 *     Handles some default targets that exist for any widget
 *     If it can't fit results into buffer, returns -1. This
 *     won't happen in any conceivable case, since it would
 *     require 1000 selection targets!
 *
 *   arguments:
1471
1472
 *     widget:	    selection owner
 *     data:	    selection data [INOUT]
1473
 *
Elliot Lee's avatar
Elliot Lee committed
1474
1475
1476
 *************************************************************/

static void
1477
gtk_selection_default_handler (GtkWidget	*widget,
Elliot Lee's avatar
Elliot Lee committed
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
			       GtkSelectionData *data)
{
  if (data->target == gtk_selection_atoms[TIMESTAMP])
    {
      /* Time which was used to obtain selection */
      GList *tmp_list;
      GtkSelectionInfo *selection_info;
      
      tmp_list = current_selections;
      while (tmp_list)
	{
	  selection_info = (GtkSelectionInfo *)tmp_list->data;
	  if ((selection_info->widget == widget) &&
	      (selection_info->selection == data->selection))
	    {
	      gtk_selection_data_set (data,
				      GDK_SELECTION_TYPE_INTEGER,
				      sizeof (guint32)*8,
				      (guchar *)&selection_info->time,
				      sizeof (guint32));
	      return;
	    }
1500
	  
Elliot Lee's avatar
Elliot Lee committed
1501
1502
	  tmp_list = tmp_list->next;
	}
1503
      
Elliot Lee's avatar
Elliot Lee committed
1504
1505
1506
1507
1508
1509
      data->length = -1;
    }
  else if (data->target == gtk_selection_atoms[TARGETS])
    {
      /* List of all targets supported for this widget/selection pair */
      GdkAtom *p;
Jeff Garzik's avatar