clipboard.c 15.1 KB
Newer Older
Arturo Espinosa's avatar
Arturo Espinosa committed
1 2 3 4
/*
 * Clipboard.c: Implements the copy/paste operations
 *
 * Author:
5
 *  Miguel de Icaza (miguel@gnu.org)
Arturo Espinosa's avatar
Arturo Espinosa committed
6
 *
Miguel de Icaza's avatar
Miguel de Icaza committed
7
 * FIXME:
8 9
 *    I would like to have a global selection instead of the per-sheet/workbook
 *    clipboard, it would clean up a few code spots.
Arturo Espinosa's avatar
Arturo Espinosa committed
10 11 12
 */
#include <config.h>
#include <gnome.h>
13 14
#include <locale.h>
#include <string.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
15
#include "gnumeric.h"
16
#include "gnumeric-util.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
17
#include "clipboard.h"
18
#include "eval.h"
19
#include "selection.h"
20 21
#include "render-ascii.h"

22
/*
23
 * Callback information.
24
 *
25
 * Passed through the workbook structure.
26
 */
27 28 29 30 31 32 33
typedef struct {
	Sheet      *dest_sheet;
	CellRegion *region;
	int         dest_col, dest_row;
	int         paste_flags;
} clipboard_paste_closure_t;

34 35 36 37 38 39 40 41
/**
 * paste_cell:
 * @dest_sheet:  The sheet where the pasting will be done
 * @new_cell:    The cell to paste.
 * @target_col:  Column to put the cell into
 * @target_row:  Row to put the cell into.
 * @paste_flags: Bit mask that describes the paste options.
 *
42 43 44
 * Pastes a cell in the spreadsheet
 */
static int
45 46
paste_cell (Sheet *dest_sheet, Cell *new_cell,
	    int target_col, int target_row,
47
	    int paste_flags)
48
{
49 50 51
	g_return_val_if_fail (target_col < SHEET_MAX_COLS, 0);
	g_return_val_if_fail (target_row < SHEET_MAX_ROWS, 0);
	
52 53 54 55 56 57 58 59 60 61
	sheet_cell_add (dest_sheet, new_cell, target_col, target_row);
	
	if (!(paste_flags & PASTE_FORMULAS)){
		if (new_cell->parsed_node){
			expr_tree_unref (new_cell->parsed_node);
			new_cell->parsed_node = NULL;
		}
	}
	
	if (new_cell->parsed_node){
62
		if (paste_flags & PASTE_FORMULAS){
63
			cell_relocate (new_cell);
64 65
			cell_content_changed (new_cell);
		}
66 67 68
		else 
			cell_make_value (new_cell);
	}
69

70 71
	if (new_cell->value)
		cell_render_value (new_cell);
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
	
	sheet_redraw_cell_region (dest_sheet,
				  target_col, target_row,
				  target_col, target_row);

	return new_cell->parsed_node != 0;
}

static int
paste_cell_flags (Sheet *dest_sheet, int target_col, int target_row,
		  CellCopy *c_copy, int paste_flags)
{
	if (!(paste_flags & (PASTE_FORMULAS | PASTE_VALUES))){
		Cell *cell;
		
		cell = sheet_cell_get (dest_sheet,
				       target_col,
				       target_row);
		if (cell && c_copy->u.cell)
			cell_set_style (cell, c_copy->u.cell->style);
	} else {
		Cell *new_cell;
		
95
		if (c_copy->type != CELL_COPY_TYPE_TEXT){
96 97 98 99
			new_cell = cell_copy (c_copy->u.cell);
			
			return paste_cell (
				dest_sheet, new_cell,
100
				target_col, target_row, paste_flags);
101 102 103 104 105 106 107 108 109 110
		} else {
			new_cell = sheet_cell_new (dest_sheet,
						   target_col, target_row);
			cell_set_text (new_cell, c_copy->u.text);
		}
	}

	return 0;
}

111
/**
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
 * do_clipboard_paste_cell_region:
 *
 * region:       a Cell Region that contains information to be pasted
 * dest_col:     initial column where cell pasting takes place
 * dest_row:     initial row where cell pasting takes place
 * paste_width:  boundary for pasting (in columns)
 * paste_height: boundar for pasting (in rows)
 * paste_flags:  controls what gets pasted (see clipboard.h for details
 */
static void
do_clipboard_paste_cell_region (CellRegion *region, Sheet *dest_sheet,
				int dest_col,       int dest_row,
				int paste_width,    int paste_height,
				int paste_flags)
{
	CellCopyList *l;
	GList *deps;
	int formulas = 0;
130
	int col, row, col_inc, row_inc;
131 132 133 134 135 136

	/* clear the region where we will paste */
	if (paste_flags & (PASTE_VALUES | PASTE_FORMULAS))
		sheet_clear_region (dest_sheet,
				    dest_col, dest_row,
				    dest_col + paste_width - 1,
137 138
				    dest_row + paste_height - 1,
				    NULL);
139 140

	/* If no operations are defined, we clear the area */
141
	if (!(paste_flags & PASTE_OPER_MASK))
142 143 144 145 146 147
		sheet_redraw_cell_region (dest_sheet,
					  dest_col, dest_row,
					  dest_col + paste_width - 1,
					  dest_row + paste_height - 1);
	
	/* Paste each element */
148 149 150 151 152 153 154 155 156 157
	if (paste_flags & PASTE_TRANSPOSE){
		col_inc = region->rows;
		row_inc = region->cols;
	} else {
		col_inc = region->cols;
		row_inc = region->rows;
	}

	for (col = 0; col < paste_width; col += col_inc){
		for (row = 0; row < paste_height; row += row_inc){
158 159 160 161
			for (l = region->list; l; l = l->next){
				CellCopy *c_copy = l->data;
				int target_col, target_row;

162 163 164 165 166 167 168 169
				if (paste_flags & PASTE_TRANSPOSE){
					target_col = col + dest_col + c_copy->row_offset;
					target_row = row + dest_row + c_copy->col_offset;
				} else {
					target_col = col + dest_col + c_copy->col_offset;
					target_row = row + dest_row + c_copy->row_offset;
				}
				
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
				if (target_col > dest_col + paste_width - 1)
					continue;

				if (target_row > dest_row + paste_height - 1)
					continue;

				formulas |= paste_cell_flags (
					dest_sheet, target_col, target_row,
					c_copy, paste_flags);
			}
		}
	}
	
	deps = region_get_dependencies (
		dest_sheet,
		dest_col, dest_row,
		dest_col + paste_width - 1,
		dest_row + paste_height -1);

	if (deps){
Morten Welinder's avatar
Morten Welinder committed
190
		cell_queue_recalc_list (deps, TRUE);
191 192 193 194 195 196 197 198
		formulas = 1;
	}

	/* Trigger a recompute if required */
	if (formulas)
		workbook_recalc (dest_sheet->workbook);
}

199 200 201 202 203 204
static GList *
new_node (GList *list, char *data, char *p, int col, int row)
{
	CellCopy *c_copy;
	char *text;

Miguel de Icaza's avatar
Miguel de Icaza committed
205 206 207 208
	/* Eliminate spaces */
	while (*data == ' ' && *data)
		data++;
	
209 210 211 212 213 214 215 216 217 218 219 220 221
	text = g_malloc (p-data+1);
	text = strncpy (text, data, p-data);
	text [p-data] = 0;
	
	c_copy = g_new (CellCopy, 1);
	c_copy->type = CELL_COPY_TYPE_TEXT;
	c_copy->col_offset = col;
	c_copy->row_offset = row;
	c_copy->u.text = text;
	
	return g_list_prepend (list, c_copy);
}

222 223 224 225 226
/**
 * x_selection_to_cell_region:
 * @data: points to an array of chars are received.
 * @len:  The lenght of the @data buffer as received. 
 *
227 228 229 230 231 232 233 234 235
 * Creates a CellRegion based on the X selection
 *
 * We use \t, ; and "," as cell separators
 * \n is a line separator
 */
static CellRegion *
x_selection_to_cell_region (char *data, int len)
{
	CellRegion *cr;
236
	int cols = 1, cur_col = 0;
237 238 239 240
	int rows = 0;
	GList *list = NULL;
	char *p = data;

241
	for (;len >= 0; len--, p++){
242
		if (*p == '\t' || *p == ';' || *p == ',' || *p == '\n'){
243 244
			if (p != data)
				list = new_node (list, data, p, cur_col, rows);
245
			
246
			if (*p == '\n'){
247
				rows++;
248 249
				cur_col = 0;
			} else {
250
				cur_col++;
251 252 253 254
				if (cur_col > cols)
					cols = cur_col;
			}

255
			data = p+1;
256 257 258
		}
	}

259
	/* Handle the remainings */
260
	if (p != data){
261
		list = new_node (list, data, p, cur_col, rows);
262 263 264 265 266
		cur_col++;
		if (cur_col > cols)
			cols = cur_col;
	}
	
267 268 269
	/* Return the CellRegion */
	cr = g_new (CellRegion, 1);	
	cr->list = list;
270 271
	cr->cols = cols ? cols : 1;
	cr->rows = rows + 1;
272 273 274 275

	return cr;
}

Miguel de Icaza's avatar
Miguel de Icaza committed
276
/**
277
 * sheet_paste_selection:
278 279 280
 *
 */
static void
281
sheet_paste_selection (Sheet *sheet, CellRegion *content, SheetSelection *ss, clipboard_paste_closure_t *pc)
282 283 284
{
	int        paste_height, paste_width;
	int        end_col, end_row;
285

286
	/* Compute the bigger bounding box (selection u clipboard-region) */
287 288
	if (ss->user.end.col - ss->user.start.col + 1 > content->cols)
		paste_width = ss->user.end.col - ss->user.start.col + 1;
289 290 291
	else
		paste_width = content->cols;

292 293
	if (ss->user.end.row - ss->user.start.row + 1 > content->rows)
		paste_height = ss->user.end.row - ss->user.start.row + 1;
294 295 296
	else
		paste_height = content->rows;

297 298 299 300 301
	if (pc->dest_col + paste_width > SHEET_MAX_COLS)
		paste_width = SHEET_MAX_COLS - pc->dest_col;
	if (pc->dest_row + paste_height > SHEET_MAX_ROWS)
		paste_height = SHEET_MAX_ROWS - pc->dest_row;
	
302 303 304 305 306
	if (pc->paste_flags & PASTE_TRANSPOSE){
		int t;
		
		end_col = pc->dest_col + paste_height - 1;
		end_row = pc->dest_row + paste_width - 1;
307

308 309 310 311 312 313 314 315
		/* Swap the paste dimensions for transposing */
		t = paste_height;
		paste_height = paste_width;
		paste_width = t;
	} else {
		end_col = pc->dest_col + paste_width - 1;
		end_row = pc->dest_row + paste_height - 1;
	}
316

317 318
	/* Do the actual paste operation */
	do_clipboard_paste_cell_region (
319
		content,      sheet,
320 321 322
		pc->dest_col, pc->dest_row,
		paste_width,  paste_height,
		pc->paste_flags);
323

324
	sheet_cursor_set (pc->dest_sheet,
325
			  pc->dest_col, pc->dest_row,
326 327 328 329 330 331 332
			  pc->dest_col, pc->dest_row,
			  end_col,      end_row);

	sheet_selection_reset_only (pc->dest_sheet);
	sheet_selection_append (pc->dest_sheet, pc->dest_col, pc->dest_row);
	sheet_selection_extend_to (pc->dest_sheet, end_col, end_row);

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
}

/**
 * x_selection_received:
 *
 * Invoked when the selection has been received by our application.
 * This is triggered by a call we do to gtk_selection_convert.
 */
static void
x_selection_received (GtkWidget *widget, GtkSelectionData *sel, guint time, gpointer data)
{
	SheetSelection *ss;
	Workbook       *wb = data;
	clipboard_paste_closure_t *pc = wb->clipboard_paste_callback_data;
	CellRegion *content;

	ss = pc->dest_sheet->selections->data;
	
	/* Did X provide any selection? */
	if (sel->length < 0){
		content = pc->region;
		if (!content)
			return;
	} else
		content = x_selection_to_cell_region (sel->data, sel->length);

	sheet_paste_selection (pc->dest_sheet, content, ss, pc);
			    
361
	/* Release the resources we used */
362
	if (sel->length >= 0)
363 364 365
		clipboard_release (content);

	/* Remove our used resources */
366 367 368 369
	if (wb->clipboard_paste_callback_data != NULL) {
		g_free (wb->clipboard_paste_callback_data);
		wb->clipboard_paste_callback_data = NULL;
	}
370 371
}

Miguel de Icaza's avatar
Miguel de Icaza committed
372
/**
373 374 375 376
 * x_selection_handler:
 *
 * Callback invoked when another application requests we render the selection.
 */
377
static void
Tom Dyas's avatar
Tom Dyas committed
378
x_selection_handler (GtkWidget *widget, GtkSelectionData *selection_data, guint info, guint time, gpointer data)
379
{
380
	Workbook *wb = (Workbook *) data;
381 382 383 384 385 386 387 388 389 390 391
	char *rendered_selection;
	
	g_assert (wb->clipboard_contents);

	rendered_selection = cell_region_render_ascii (wb->clipboard_contents);
	
	gtk_selection_data_set (
		selection_data, GDK_SELECTION_TYPE_STRING, 8,
		rendered_selection, strlen (rendered_selection));
}

392
/**
393
 * x_selection_clear:
394
 *
395
 * Callback for the "we lost the X selection" signal
396
 */
397 398
static gint
x_selection_clear (GtkWidget *widget, GdkEventSelection *event, Workbook *wb)
399
{
400
	wb->have_x_selection = FALSE;
401

402
	return TRUE;
403 404
}

405 406
/**
 * x_clipboard_bind_workbook:
407 408
 *
 * Binds the signals related to the X selection to the Workbook
409
 * and initialized the clipboard data structures for the Workbook.
410
 */
411 412 413 414
void
x_clipboard_bind_workbook (Workbook *wb)
{
	wb->have_x_selection = FALSE;
415
	wb->clipboard_paste_callback_data = NULL;
416 417 418 419 420
	
	gtk_signal_connect (
		GTK_OBJECT (wb->toplevel), "selection_clear_event",
		GTK_SIGNAL_FUNC(x_selection_clear), wb);

421 422 423
	gtk_signal_connect (
		GTK_OBJECT (wb->toplevel), "selection_received",
		GTK_SIGNAL_FUNC(x_selection_received), wb);
Tom Dyas's avatar
Tom Dyas committed
424 425 426 427 428 429

	gtk_signal_connect (
		GTK_OBJECT (wb->toplevel), "selection_get",
		GTK_SIGNAL_FUNC(x_selection_handler), wb);

	gtk_selection_add_target (
430
		wb->toplevel,
Tom Dyas's avatar
Tom Dyas committed
431
		GDK_SELECTION_PRIMARY, GDK_SELECTION_TYPE_STRING, 0);
432 433
}

434
/**
435 436 437 438 439
 * clipboard_export_cell_region:
 *
 * This routine exports a CellRegion to the X selection
 */
static void
440
clipboard_export_cell_region (Workbook *wb)
441 442
{
	wb->have_x_selection = gtk_selection_owner_set (
443
		wb->toplevel,
444 445
		GDK_SELECTION_PRIMARY,
		GDK_CURRENT_TIME);
446

447
}
Arturo Espinosa's avatar
Arturo Espinosa committed
448 449 450 451 452 453

typedef struct {
	int        base_col, base_row;
	CellRegion *r;
} append_cell_closure_t;

454
static Value *
455
clipboard_prepend_cell (Sheet *sheet, int col, int row, Cell *cell, void *user_data)
Arturo Espinosa's avatar
Arturo Espinosa committed
456 457 458 459 460 461
{
	append_cell_closure_t *c = user_data;
	CellCopy *copy;

	copy = g_new (CellCopy, 1);

462
	copy->type = CELL_COPY_TYPE_CELL;
463
	copy->u.cell = cell_copy (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
464
	copy->col_offset  = col - c->base_col;
465
	copy->row_offset  = row - c->base_row;
Arturo Espinosa's avatar
Arturo Espinosa committed
466 467 468
	
	c->r->list = g_list_prepend (c->r->list, copy);

469
	return NULL;
Arturo Espinosa's avatar
Arturo Espinosa committed
470 471
}

472
/**
473 474 475 476
 * clipboard_copy_cell_range:
 *
 * Entry point to the clipboard copy code
 */
Arturo Espinosa's avatar
Arturo Espinosa committed
477
CellRegion *
478 479
clipboard_copy_cell_range (Sheet *sheet,
			   int start_col, int start_row,
480
			   int end_col, int end_row)
Arturo Espinosa's avatar
Arturo Espinosa committed
481 482
{
	append_cell_closure_t c;
483
	
484 485 486 487
	g_return_val_if_fail (sheet != NULL, NULL);
	g_return_val_if_fail (IS_SHEET (sheet), NULL);
	g_return_val_if_fail (start_col <= end_col, NULL);
	g_return_val_if_fail (start_row <= end_row, NULL);
488

489
	c.r = g_new0 (CellRegion, 1);
Arturo Espinosa's avatar
Arturo Espinosa committed
490 491 492

	c.base_col = start_col;
	c.base_row = start_row;
493 494
	c.r->cols = end_col - start_col + 1;
	c.r->rows = end_row - start_row + 1;
Arturo Espinosa's avatar
Arturo Espinosa committed
495 496
	
	sheet_cell_foreach_range (
497
		sheet, TRUE, start_col, start_row, end_col, end_row,
498 499 500 501
		clipboard_prepend_cell, &c);

	/* reverse the list so that upper left corner is first */
	c.r->list = g_list_reverse (c.r->list);
502

503
	clipboard_export_cell_region (sheet->workbook);
504
	
505
	return c.r;
Arturo Espinosa's avatar
Arturo Espinosa committed
506 507
}

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
static gboolean
workbook_selection_locator (Workbook *wb, gpointer data)
{
	Workbook **target = data;
	
	if (wb->have_x_selection)
		*target = wb;

	return TRUE;
}

static Workbook *
find_local_workbook_with_selection (void)
{
	Workbook *result = NULL;
	
	workbook_foreach (workbook_selection_locator, &result);

	return result;
}

529 530 531 532 533 534 535 536 537
/**
 * clipboard_paste_region:
 * @region:      A cell region
 * @dest_sheet:  Destination sheet
 * @dest_col:    Column where we should paste the region in dest_sheet
 * @dest_row:    Row where we should paste the region in dest_sheet
 * @paste_flags: Paste flags
 * @time:        Time at which the event happened.
 *
538 539
 * Main entry point for the paste code
 */
Arturo Espinosa's avatar
Arturo Espinosa committed
540
void
Arturo Espinosa's avatar
Arturo Espinosa committed
541
clipboard_paste_region (CellRegion *region, Sheet *dest_sheet,
542 543
			int dest_col,       int dest_row,
			int paste_flags,    guint32 time)
Arturo Espinosa's avatar
Arturo Espinosa committed
544
{
545
	clipboard_paste_closure_t *data;
546
	Workbook *workbook_holding_selection;
547
	
548 549 550
	g_return_if_fail (dest_sheet != NULL);
	g_return_if_fail (IS_SHEET (dest_sheet));

551
	if (dest_sheet->workbook->clipboard_paste_callback_data != NULL) {
552 553
		g_free (dest_sheet->workbook->clipboard_paste_callback_data);	
		dest_sheet->workbook->clipboard_paste_callback_data = NULL;
Arturo Espinosa's avatar
Arturo Espinosa committed
554 555
	}

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
	/*
	 * OK, we dont have the X selection, so we try to get it:
	 * we setup all of the parameters for the callback in
	 * case the X selection fails and we have to fallback to
	 * using our internal selection
	 */
	data = g_new (clipboard_paste_closure_t, 1);
	dest_sheet->workbook->clipboard_paste_callback_data = data;

	data->region       = region;
	data->dest_sheet   = dest_sheet;
	data->dest_col     = dest_col;
	data->dest_row     = dest_row;
	data->paste_flags  = paste_flags;

	/*
	 * If we own the selection, there is no need to ask X for
	 * the selection: we do the paste from our internal buffer.
	 *
	 * This is better as we have all sorts of useful information
	 * to paste from in this case (instead of the simplistic text
	 * we get from X
	 */

580 581 582 583 584 585 586 587
	workbook_holding_selection = find_local_workbook_with_selection ();
	if (workbook_holding_selection && region){
		CellRegion *content;
		
		content = region;

		sheet_paste_selection (dest_sheet, content, dest_sheet->selections->data, data);
		
588 589 590 591 592
		/* Check that this has not already been freed */
		if (workbook_holding_selection->clipboard_paste_callback_data != NULL) {
			workbook_holding_selection->clipboard_paste_callback_data = NULL;
			g_free (data);
		}
593
		return;
594
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
595

596 597 598
	/* Now, trigger a grab of the X selection */
	gtk_selection_convert (
		dest_sheet->workbook->toplevel, GDK_SELECTION_PRIMARY,
599
		GDK_TARGET_STRING, time);
600 601
}

602 603 604
/*
 * Destroys the contents of a CellRegion
 */
605 606 607 608 609 610 611
void
clipboard_release (CellRegion *region)
{
	CellCopyList *l;

	g_return_if_fail (region != NULL);
	
612
	for (l = region->list; l; l = l->next){
613
		CellCopy *this_cell = l->data;
614
		
615 616 617 618 619
		if (this_cell->type != CELL_COPY_TYPE_TEXT) {
			/* The cell is not really in the rows or columns */
			this_cell->u.cell->sheet = NULL;
			this_cell->u.cell->row = NULL;
			this_cell->u.cell->col = NULL;
620
			cell_destroy (this_cell->u.cell);
621
		} else
622
			g_free (this_cell->u.text);
623 624
		g_free (this_cell);
	}
625

626 627
	g_list_free (region->list);
	g_free (region);
Arturo Espinosa's avatar
Arturo Espinosa committed
628
}
629

630