clipboard.c 12 KB
Newer Older
Arturo Espinosa's avatar
Arturo Espinosa committed
1 2 3 4 5 6 7 8 9
/*
 * Clipboard.c: Implements the copy/paste operations
 *
 * Author:
 *  MIguel de Icaza (miguel@gnu.org)
 *
 */
#include <config.h>
#include <gnome.h>
10 11
#include <locale.h>
#include <string.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
12
#include "gnumeric.h"
13
#include "gnumeric-util.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
14
#include "clipboard.h"
15
#include "eval.h"
16 17
#include "render-ascii.h"

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

/*
 * Pastes a cell in the spreadsheet
 */
static int
paste_cell (Sheet *dest_sheet, Cell *new_cell, int target_col, int target_row, int paste_flags)
35
{
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
	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){
		if (paste_flags & PASTE_FORMULAS)
			cell_formula_relocate (new_cell, target_col, target_row);
		else 
			cell_make_value (new_cell);
	}
51

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
	cell_render_value (new_cell);
	
	if (!(paste_flags & PASTE_FORMULAS)){
		string_unref (new_cell->entered_text);
		new_cell->entered_text = string_ref (new_cell->text);
	}

	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;
		
		if (c_copy->type == CELL_COPY_TYPE_CELL){
			new_cell = cell_copy (c_copy->u.cell);
			
			return paste_cell (
				dest_sheet, new_cell,
				target_col, target_row, paste_flags);
		} else {
			new_cell = sheet_cell_new (dest_sheet,
						   target_col, target_row);
			cell_set_text (new_cell, c_copy->u.text);
		}
	}

	return 0;
}

/*
 * 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;
	int col, row;

	/* 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,
				    dest_row + paste_height - 1);

	/* If no operations are defined, we clear the area */
	if (!(paste_flags & PASTE_OP_MASK))
		sheet_redraw_cell_region (dest_sheet,
					  dest_col, dest_row,
					  dest_col + paste_width - 1,
					  dest_row + paste_height - 1);
	
	/* Paste each element */
	for (col = 0; col < paste_width; col += region->cols){
		for (row = 0; row < paste_height; row += region->rows){
			for (l = region->list; l; l = l->next){
				CellCopy *c_copy = l->data;
				Cell *new_cell;
				int target_col, target_row;
				
				target_col = col + dest_col + c_copy->col_offset;
				target_row = row + dest_row + c_copy->row_offset;

				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){
		cell_queue_recalc_list (deps);
		formulas = 1;
	}

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

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
static GList *
new_node (GList *list, char *data, char *p, int col, int row)
{
	CellCopy *c_copy;
	char *text;

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

191 192 193 194 195 196 197 198 199 200
/*
 * 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;
201
	int cols = 1, cur_col = 0;
202 203 204 205
	int rows = 0;
	GList *list = NULL;
	char *p = data;

206
	for (;len >= 0; len--, p++){
207
		if (*p == '\t' || *p == ';' || *p == ',' || *p == '\n'){
208 209
			if (p != data)
				list = new_node (list, data, p, cur_col, rows);
210
			
211
			if (*p == '\n'){
212
				rows++;
213 214
				cur_col = 0;
			} else {
215 216 217 218 219
				if (cur_col > cols)
					cols = cur_col;
				cur_col++;
			}

220
			data = p+1;
221 222 223
		}
	}

224 225 226 227
	/* Handle the remainings */
	if (p != data)
		list = new_node (list, data, p, cur_col, rows);

228 229 230
	/* Return the CellRegion */
	cr = g_new (CellRegion, 1);	
	cr->list = list;
231 232
	cr->cols = cols ? cols : 1;
	cr->rows = rows + 1;
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

	return cr;
}

/*
 * 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, gpointer data)
{
	SheetSelection *ss;
	Workbook       *wb = data;
	clipboard_paste_closure_t *pc = wb->clipboard_paste_callback_data;
	CellRegion *content;
	int        paste_height, paste_width;
	int        end_col, end_row;
252

253 254 255
	ss = pc->dest_sheet->selections->data;
	
	/* Did X provide any selection? */
256
	if (sel->length < 0){
257
		content = pc->region;
258 259 260
		if (!content)
			return;
	} else
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 289 290 291 292
		content = x_selection_to_cell_region (sel->data, sel->length);

	/* Compute the bigger bounding box (selection u clipboard-region) */
	if (ss->end_col - ss->start_col + 1 > content->cols)
		paste_width = ss->end_col - ss->start_col + 1;
	else
		paste_width = content->cols;

	if (ss->end_row - ss->start_row + 1 > content->rows)
		paste_height = ss->end_row - ss->start_row + 1;
	else
		paste_height = content->rows;

	end_col = pc->dest_col + paste_width - 1;
	end_row = pc->dest_row + paste_height - 1;

	/* Do the actual paste operation */
	do_clipboard_paste_cell_region (
		content,      pc->dest_sheet,
		pc->dest_col, pc->dest_row,
		paste_width,  paste_height,
		pc->paste_flags);
	
	sheet_cursor_set (pc->dest_sheet,
			  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);

	/* Release the resources we used */
293
	if (sel->length >= 0)
294 295 296 297 298
		clipboard_release (content);

	/* Remove our used resources */
	g_free (wb->clipboard_paste_callback_data);
	wb->clipboard_paste_callback_data = NULL;
299 300
}

301 302 303 304 305
/*
 * x_selection_handler:
 *
 * Callback invoked when another application requests we render the selection.
 */
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
static void
x_selection_handler (GtkWidget *widget, GtkSelectionData *selection_data, gpointer data)
{
	Workbook *wb = data;
	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));
}

321
/*
322
 * x_selection_clear:
323
 *
324
 * Callback for the "we lost the X selection" signal
325
 */
326 327
static gint
x_selection_clear (GtkWidget *widget, GdkEventSelection *event, Workbook *wb)
328
{
329
	wb->have_x_selection = FALSE;
330

331
	return TRUE;
332 333 334 335 336 337 338
}

/*
 * x_clipboard_bind_workbook
 *
 * Binds the signals related to the X selection to the Workbook
 */
339 340 341 342 343 344 345 346 347 348 349 350 351
void
x_clipboard_bind_workbook (Workbook *wb)
{
	wb->have_x_selection = FALSE;
	
	gtk_signal_connect (
		GTK_OBJECT (wb->toplevel), "selection_clear_event",
		GTK_SIGNAL_FUNC(x_selection_clear), wb);

	gtk_selection_add_handler (
		wb->toplevel,
		GDK_SELECTION_PRIMARY, GDK_SELECTION_TYPE_STRING,
		x_selection_handler, wb);
352 353 354
	gtk_signal_connect (
		GTK_OBJECT (wb->toplevel), "selection_received",
		GTK_SIGNAL_FUNC(x_selection_received), wb);
355 356 357 358 359 360 361 362
}

/*
 * clipboard_export_cell_region:
 *
 * This routine exports a CellRegion to the X selection
 */
static void
363
clipboard_export_cell_region (Workbook *wb)
364 365 366 367 368 369
{
	wb->have_x_selection = gtk_selection_owner_set (
		current_workbook->toplevel,
		GDK_SELECTION_PRIMARY,
		GDK_CURRENT_TIME);
}
Arturo Espinosa's avatar
Arturo Espinosa committed
370 371 372 373 374 375

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

376
static int
Arturo Espinosa's avatar
Arturo Espinosa committed
377 378 379 380 381 382 383
clipboard_append_cell (Sheet *sheet, int col, int row, Cell *cell, void *user_data)
{
	append_cell_closure_t *c = user_data;
	CellCopy *copy;

	copy = g_new (CellCopy, 1);

384 385
	copy->type = CELL_COPY_TYPE_CELL;
	copy->u.cell = cell_copy (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
386
	copy->col_offset  = col - c->base_col;
387
	copy->row_offset  = row - c->base_row;
Arturo Espinosa's avatar
Arturo Espinosa committed
388 389
	
	/* Now clear the traces and dependencies on the copied Cell */
390 391 392
	copy->u.cell->col   = NULL;
	copy->u.cell->row   = NULL;
	copy->u.cell->sheet = NULL;
Arturo Espinosa's avatar
Arturo Espinosa committed
393 394 395 396 397 398
	
	c->r->list = g_list_prepend (c->r->list, copy);

	return TRUE;
}

399 400 401 402 403
/*
 * clipboard_copy_cell_range:
 *
 * Entry point to the clipboard copy code
 */
Arturo Espinosa's avatar
Arturo Espinosa committed
404 405 406 407
CellRegion *
clipboard_copy_cell_range (Sheet *sheet, int start_col, int start_row, int end_col, int end_row)
{
	append_cell_closure_t c;
408
	
409 410 411 412
	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);
413

414
	c.r = g_new0 (CellRegion, 1);
Arturo Espinosa's avatar
Arturo Espinosa committed
415 416 417

	c.base_col = start_col;
	c.base_row = start_row;
418 419
	c.r->cols = end_col - start_col + 1;
	c.r->rows = end_row - start_row + 1;
Arturo Espinosa's avatar
Arturo Espinosa committed
420 421 422
	
	sheet_cell_foreach_range (
		sheet, 1, start_col, start_row, end_col, end_row,
423 424
		clipboard_append_cell, &c);

425
	clipboard_export_cell_region (sheet->workbook);
426
	
427
	return c.r;
Arturo Espinosa's avatar
Arturo Espinosa committed
428 429
}

430 431 432
/*
 * Main entry point for the paste code
 */
Arturo Espinosa's avatar
Arturo Espinosa committed
433
void
Arturo Espinosa's avatar
Arturo Espinosa committed
434
clipboard_paste_region (CellRegion *region, Sheet *dest_sheet,
435 436
			int dest_col,       int dest_row,
			int paste_flags,    guint32 time)
Arturo Espinosa's avatar
Arturo Espinosa committed
437
{
438
	clipboard_paste_closure_t *data;
439
	
440 441 442
	g_return_if_fail (dest_sheet != NULL);
	g_return_if_fail (IS_SHEET (dest_sheet));

443 444 445
	if (dest_sheet->workbook->clipboard_paste_callback_data){
		g_free (dest_sheet->workbook->clipboard_paste_callback_data);	
		dest_sheet->workbook->clipboard_paste_callback_data = NULL;
Arturo Espinosa's avatar
Arturo Espinosa committed
446 447
	}

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
	/*
	 * 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
	 */
	if (dest_sheet->workbook->have_x_selection){
		GtkSelectionData sel;

		sel.length = -1;
		x_selection_received (dest_sheet->workbook->toplevel, &sel,
				      dest_sheet->workbook);
477
		return;
478
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
479

480 481 482
	/* Now, trigger a grab of the X selection */
	gtk_selection_convert (
		dest_sheet->workbook->toplevel, GDK_SELECTION_PRIMARY,
483
		GDK_TARGET_STRING, time);
484 485
}

486 487 488
/*
 * Destroys the contents of a CellRegion
 */
489 490 491 492 493 494 495
void
clipboard_release (CellRegion *region)
{
	CellCopyList *l;

	g_return_if_fail (region != NULL);
	
496
	for (l = region->list; l; l = l->next){
497
		CellCopy *this_cell = l->data;
498 499 500 501 502
		
		if (this_cell->type == CELL_COPY_TYPE_CELL)
			cell_destroy (this_cell->u.cell);
		else
			g_free (this_cell->u.text);
503 504
		g_free (this_cell);
	}
505

506 507
	g_list_free (region->list);
	g_free (region);
Arturo Espinosa's avatar
Arturo Espinosa committed
508
}
509

510