cell.c 34.6 KB
Newer Older
1
2
3
4
/*
 * cell.c: Cell management of the Gnumeric spreadsheet.
 *
 * Author:
5
 *    Miguel de Icaza 1998, 1999 (miguel@kernel.org)
6
 */
7
#include <config.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
8
#include <gnome.h>
Miguel de Icaza's avatar
Miguel de Icaza committed
9
#include <locale.h>
10
#include <ctype.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
11
#include "gnumeric.h"
12
#include "gnumeric-util.h"
13
#include "gnumeric-sheet.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
14
#include "eval.h"
15
#include "format.h"
16
#include "color.h"
17
#include "border.h"
18
#include "cursors.h"
19
#include "utils.h"
20
#include "gnumeric-util.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
21

22
23
static int         redraws_frozen           = 0;
static int         redraws_deep_frozen      = 0;
24
25
static GHashTable *cell_hash_queue;

26
static void
27
28
29
cell_formula_changed (Cell *cell)
{
	g_return_if_fail (cell != NULL);
30

31
	sheet_cell_formula_link (cell);
32

33
34
35
	cell_queue_recalc (cell);
}

36
37
38
static inline void
cell_modified (Cell *cell)
{
39
	Sheet *sheet = cell->sheet;
40
41
42
43

	/* Cells from the clipboard do not have a sheet attached */
	if (sheet)
		sheet->modified = TRUE;
44
45
}

Morten Welinder's avatar
Morten Welinder committed
46

47
/* Empty a cell's value, entered_text, and parsed_node.  */
Jody Goldberg's avatar
typo.    
Jody Goldberg committed
48
static void
49
50
51
cell_cleanout (Cell *cell)
{
	if (cell->parsed_node){
52
53
54
		/* Clipboard cells, e.g., are not attached to a sheet.  */
		if (cell->sheet)
			sheet_cell_formula_unlink (cell);
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
		expr_tree_unref (cell->parsed_node);
		cell->parsed_node = NULL;
	}

	if (cell->value) {
		value_release (cell->value);
		cell->value = NULL;
	}

	if (cell->entered_text) {
		string_unref (cell->entered_text);
		cell->entered_text = NULL;
	}
}


Jody Goldberg's avatar
typo.    
Jody Goldberg committed
71
void
72
cell_set_formula (Cell *cell, const char *text)
Arturo Espinosa's avatar
Arturo Espinosa committed
73
{
74
	ExprTree *new_expr;
75
	char *error_msg = _("ERROR");
Morten Welinder's avatar
Morten Welinder committed
76
	char *desired_format = NULL;
77
	ParsePosition pp;
Morten Welinder's avatar
Morten Welinder committed
78
	gboolean may_set_format;
79

Arturo Espinosa's avatar
Arturo Espinosa committed
80
81
	g_return_if_fail (cell != NULL);
	g_return_if_fail (text != NULL);
82
	g_return_if_fail (gnumeric_char_start_expr_p (*text));
83

Morten Welinder's avatar
Morten Welinder committed
84
85
	may_set_format = !cell_has_assigned_format (cell);

86
	cell_modified (cell);
87
	new_expr = expr_parse_string (text+1, /* Ignore leading char (=,@,+) */
88
				      parse_pos_cell (&pp, cell),
Morten Welinder's avatar
Morten Welinder committed
89
				      may_set_format ? &desired_format : NULL,
90
				      &error_msg);
91
92
	cell_cleanout (cell);

93
	if (new_expr == NULL) {
94
		cell_set_rendered_text (cell, error_msg);
95
96
97
		cell->entered_text = string_get (text);
		/* FIXME: Supply a proper position?  */
		cell->value = value_new_error (NULL, error_msg);
Arturo Espinosa's avatar
Arturo Espinosa committed
98
		return;
99
100
	}

Morten Welinder's avatar
Morten Welinder committed
101
102
103
	/* Until the value is recomputed, we put in this value.  */
	cell->value = value_new_error (NULL, _("Pending recomputation"));

Morten Welinder's avatar
Morten Welinder committed
104
	if (desired_format) {
105
		cell_set_format (cell, desired_format);
Morten Welinder's avatar
Morten Welinder committed
106
107
		g_free (desired_format);
	}
Miguel de Icaza's avatar
New:    
Miguel de Icaza committed
108

109
	if (new_expr->oper == OPER_ARRAY) {
110
		/* The corner sets up the entire array block */
111
		if (new_expr->u.array.x != 0 || new_expr->u.array.y != 0) {
112
113
114
			/* Throw away the expression, including the inner
			   one.  */
			expr_tree_unref (new_expr->u.array.corner.func.expr);
115
116
117
118
			expr_tree_unref (new_expr);
			return;
		}

119
		/*
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
		 * NOTE : The wrapper supplied by the parser will be released
		 *        and recreated.  new_expr will NOT be valid on exit
		 *        from cell_set_array_formula.
		 */
		cell->parsed_node = new_expr;
		cell_set_array_formula (cell->sheet,
					cell->row->pos, cell->col->pos,
					cell->row->pos +
					    new_expr->u.array.rows -1,
					cell->col->pos +
					    new_expr->u.array.cols -1,
					new_expr->u.array.corner.func.expr);
	} else {
		cell->parsed_node = new_expr;
		cell_formula_changed (cell);
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
136
}
Arturo Espinosa's avatar
Arturo Espinosa committed
137

138
139
140
141
142
void
cell_comment_destroy (Cell *cell)
{
	CellComment *comment;
	GList *l;
143

144
145
146
147
148
149
150
151
152
	g_return_if_fail (cell != NULL);

	comment = cell->comment;
	if (!comment)
		return;
	cell->comment = NULL;

	/* Free resources */
	string_unref (comment->comment);
153
154
155
156
157

	if (comment->timer_tag != -1)
		gtk_timeout_remove (comment->timer_tag);

	if (comment->window)
158
		gtk_object_destroy (GTK_OBJECT (comment->window));
159

160
	for (l = comment->realized_list; l; l = l->next)
161
		gtk_object_destroy (l->data);
Morten Welinder's avatar
Morten Welinder committed
162
	g_list_free (comment->realized_list);
163

164
165
166
	g_free (comment);
}

167
168
169
170
171
172
173
static void
cell_comment_cancel_timer (Cell *cell)
{
	if (cell->comment->timer_tag != -1){
		gtk_timeout_remove (cell->comment->timer_tag);
		cell->comment->timer_tag = -1;
	}
174

175
}
176

177
178
179
180
181
static void
cell_display_comment (Cell *cell)
{
	GtkWidget *window, *label;
	int x, y;
182

183
184
	g_return_if_fail (cell != NULL);

185
	cell_comment_cancel_timer (cell);
186

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
	window = gtk_window_new (GTK_WINDOW_POPUP);
	label = gtk_label_new (cell->comment->comment->str);
	gtk_container_add (GTK_CONTAINER (window), label);

	gdk_window_get_pointer (NULL, &x, &y, NULL);
	gtk_widget_set_uposition (window, x+10, y+10);

	gtk_widget_show_all (window);

	cell->comment->window = window;
}

static gint
cell_popup_comment (gpointer data)
{
	Cell *cell = data;
203

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
	cell->comment->timer_tag = -1;

	cell_display_comment (cell);
	return FALSE;
}

static int
cell_comment_clicked (GnomeCanvasItem *item, GdkEvent *event, Cell *cell)
{
	GnomeCanvas *canvas = item->canvas;

	switch (event->type){
	case GDK_BUTTON_RELEASE:
		if (event->button.button != 1)
			return FALSE;
		if (cell->comment->window)
			return FALSE;
		cell_display_comment (cell);
		break;

	case GDK_BUTTON_PRESS:
		if (event->button.button != 1)
			return FALSE;
		break;
228

229
230
231
232
233
234
	case GDK_ENTER_NOTIFY:
		cell->comment->timer_tag = gtk_timeout_add (1000, cell_popup_comment, cell);
		cursor_set_widget (canvas, GNUMERIC_CURSOR_ARROW);
		break;

	case GDK_LEAVE_NOTIFY:
235
		cell_comment_cancel_timer (cell);
236
		if (cell->comment->window){
237
			gtk_object_destroy (GTK_OBJECT (cell->comment->window));
238
239
240
			cell->comment->window = NULL;
		}
		break;
241

242
243
244
245
246
247
	default:
		return FALSE;
	}
	return TRUE;
}

248
249
250
251
252
253
254
255
static void
cell_comment_realize (Cell *cell)
{
	GList *l;

	g_return_if_fail (cell->comment != NULL);

	sheet_cell_comment_link (cell);
Morten Welinder's avatar
Morten Welinder committed
256
	for (l = cell->sheet->sheet_views; l; l = l->next){
257
258
		SheetView *sheet_view = SHEET_VIEW (l->data);
		GnomeCanvasItem *o;
259

260
		o = sheet_view_comment_create_marker (
261
			sheet_view,
262
			cell->col->pos, cell->row->pos);
263
		gtk_object_ref (GTK_OBJECT (o));
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

		cell->comment->realized_list = g_list_prepend (
			cell->comment->realized_list, o);

		gtk_signal_connect (GTK_OBJECT (o), "event",
				    GTK_SIGNAL_FUNC (cell_comment_clicked), cell);
	}
}

static void
cell_comment_unrealize (Cell *cell)
{
	GList *l;

	g_return_if_fail (cell->comment != NULL);

	sheet_cell_comment_unlink (cell);
	for (l = cell->comment->realized_list; l; l = l->next){
		GnomeCanvasItem *o = l->data;

284
		gtk_object_unref (GTK_OBJECT (o));
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
	}
	g_list_free (cell->comment->realized_list);
	cell->comment->realized_list = NULL;
}

void
cell_realize (Cell *cell)
{
	g_return_if_fail (cell != NULL);

	if (cell->comment)
		cell_comment_realize (cell);
}

void
cell_unrealize (Cell *cell)
{
	g_return_if_fail (cell != NULL);

	if (cell->comment)
		cell_comment_unrealize (cell);
}

308
void
309
cell_set_comment (Cell *cell, const char *str)
310
311
{
	int had_comments = FALSE;
312

313
314
315
316
317
318
319
320
321
322
323
	g_return_if_fail (cell != NULL);
	g_return_if_fail (str != NULL);

	cell_modified (cell);

	cell_comment_destroy (cell);

	cell->comment = g_new (CellComment, 1);
	cell->comment->realized_list = NULL;
	cell->comment->timer_tag = -1;
	cell->comment->window = NULL;
324

325
326
327
328
329
	cell->comment->comment = string_get (str);

	if (had_comments)
		cell_queue_redraw (cell);

330
331
	if (cell->sheet)
		cell_comment_realize (cell);
332
333
}

Miguel de Icaza's avatar
Miguel de Icaza committed
334
335
336
337
338
339
340
341
/*
 * cell_set_rendered_text
 * @cell:          the cell we will modify
 * @rendered_text: the text we will display
 *
 * This routine sets the rendered text field of the cell
 * it recomputes the bounding box for the cell as well
 */
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
342
void
343
cell_set_rendered_text (Cell *cell, const char *rendered_text)
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
344
{
345
	String *oldtext;
346

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
347
348
	g_return_if_fail (cell != NULL);
	g_return_if_fail (rendered_text != NULL);
349

350
	cell_modified (cell);
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
351

352
	oldtext = cell->text;
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
353
	cell->text = string_get (rendered_text);
354
355
	if (oldtext)
		string_unref (oldtext);
356

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
357
358
359
	cell_calc_dimensions (cell);
}

360
char *
361
362
363
364
cell_get_formatted_val (Cell *cell, StyleColor **col)
{
	MStyle *mstyle;
	char *txt;
365

366
367
368
369
370
371
372
373
374
375
376
377
378
	mstyle = sheet_style_compute (cell->sheet, cell->col->pos,
				      cell->row->pos);
	if (mstyle_is_element_set (mstyle, MSTYLE_FORMAT))
		txt = format_value (mstyle_get_format (mstyle),
				    cell->value, col);
	else {
		g_warning ("No format: serious error");
		txt = g_strdup ("Error");
	}
	mstyle_unref (mstyle);
	return txt;
}

Miguel de Icaza's avatar
Miguel de Icaza committed
379
380
381
382
/*
 * cell_render_value
 * @cell: The cell whose value needs to be rendered
 *
383
384
385
 * The value of the cell is formated according to the format style, but if
 * formulas are being displayed then use the text of the formula instead of 
 * its value.
Miguel de Icaza's avatar
Miguel de Icaza committed
386
 */
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
387
388
389
void
cell_render_value (Cell *cell)
{
390
	StyleColor *color;
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
391
	char *str;
392

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
393
394
395
	g_return_if_fail (cell != NULL);
	g_return_if_fail (cell->value != NULL);

Jody Goldberg's avatar
Jody Goldberg committed
396
	if (cell->render_color == (void *)0xdeadbeef) {
Miguel de Icaza's avatar
Miguel de Icaza committed
397
398
		g_error ("This cell is dead!");
	}
399
	if (cell->render_color) {
400
401
402
		style_color_unref (cell->render_color);
		cell->render_color = NULL;
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
403

404
	if (cell->sheet->display_formulas && cell->parsed_node){
405
406
407
408
409
410
411
412
413
		ParsePosition pp;
		char *tmpstr = expr_decode_tree (cell->parsed_node,
						 parse_pos_cell (&pp, cell));
		str = g_strconcat ("=", tmpstr, NULL);
		g_free (tmpstr);
	} else {
		str = cell_get_formatted_val (cell, &color);		
		cell->render_color = color;
	}
414

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
415
416
417
418
	cell_set_rendered_text (cell, str);
	g_free (str);
}

Michael Meeks's avatar
Michael Meeks committed
419
420
421
422
423
424
425
426
427
428
429
430
431
432
/*
 * Sets the value for a cell:
 *
 * This is kind of an internal function and should be only called by
 * routines that know what they are doing.  These are the important
 * differences from cell_set_value:
 *
 *    - It does not queue redraws (so you have to queue the redraw yourself
 *      or queue a full redraw).
 *
 *    - It does not queue any recomputations.  You have to queue the recompute
 *      yourself.
 */
void
Morten Welinder's avatar
Morten Welinder committed
433
cell_set_value_simple (Cell *cell, Value *v)
Michael Meeks's avatar
Michael Meeks committed
434
435
436
437
438
{
	g_return_if_fail (cell);
	g_return_if_fail (v);

	cell_modified (cell);
439
	cell_cleanout (cell);
Michael Meeks's avatar
Michael Meeks committed
440
441
442
443
444
445
446
447
448
449
450

	cell->value = v;
	cell_render_value (cell);
}

/*
 * cell_set_value
 *
 * Changes the value of a cell
 */
void
Morten Welinder's avatar
Morten Welinder committed
451
cell_set_value (Cell *cell, Value *v)
Michael Meeks's avatar
Michael Meeks committed
452
453
454
{
	g_return_if_fail (cell);
	g_return_if_fail (v);
455

Michael Meeks's avatar
Michael Meeks committed
456
457
458
459
460
461
462
463
	cell_queue_redraw (cell);

	cell_set_value_simple (cell, v);
	cell_content_changed (cell);

	cell_queue_redraw (cell);
}

464
465
466
467
468
469
470
471
472
473
474
475
/*
 * Sets the text for a cell:
 *
 * This is kind of an internal function and should be only called by
 * routines that know what they are doing.  These are the important
 * differences from cell_set_text:
 *
 *    - It does not queue redraws (so you have to queue the redraw yourself
 *      or queue a full redraw).
 *
 *    - It does not queue any recomputations.  You have to queue the recompute
 *      yourself.
Jody Goldberg's avatar
Jody Goldberg committed
476
477
 *
 *    - It stores the rendered value of the text as if that is what was entered.
478
 */
479
void
480
cell_set_text_simple (Cell *cell, const char *text)
481
{
Arturo Espinosa's avatar
Arturo Espinosa committed
482
483
	g_return_if_fail (cell != NULL);
	g_return_if_fail (text != NULL);
Arturo Espinosa's avatar
Arturo Espinosa committed
484

485
	cell_modified (cell);
486
	cell_cleanout (cell);
487

488
	if (gnumeric_char_start_expr_p (*text) && text[1] != '\0')
489
		cell_set_formula (cell, text);
490
	else {
491
492
		char *end;
		long l;
493
		int  set=0;
494

Morten Welinder's avatar
Morten Welinder committed
495
		l = strtol (text, &end, 10);
496
497
		if (l != LONG_MAX && l != LONG_MIN &&
		    text != end && (l == (int)l)) {
498
499
500
			/* Allow and ignore spaces at the end of integers.  */
			while (*end == ' ')
				end++;
501
502
503
504
505
			if (*end == 0) {
				cell->value = value_new_int (l);
				set = 1;
			}
		}
506

507
		if (!set) {
508
			double d;
Morten Welinder's avatar
Morten Welinder committed
509
			d = strtod (text, &end);
510
			if (text != end && *end == 0) {
511
512
				/* It is a floating point number.  */
				cell->value = value_new_float ((float_t)d);
Arturo Espinosa's avatar
Arturo Espinosa committed
513
			} else {
514
515
				/* It is text.  */
				cell->value = value_new_string (text);
Arturo Espinosa's avatar
Arturo Espinosa committed
516
517
			}
		}
518

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
519
		cell_render_value (cell);
Jody Goldberg's avatar
Jody Goldberg committed
520
521
522
		cell->entered_text = (cell->text != NULL)
		    ? string_ref (cell->text)
		    : string_get (text);
523
	}
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
}

/*
 * cell_content_changed:
 *
 * Call this routine if you modify the contents of a cell
 * to trigger a recompute on any dependencies
 */
void
cell_content_changed (Cell *cell)
{
	GList   *deps;

	g_return_if_fail (cell != NULL);

Arturo Espinosa's avatar
Arturo Espinosa committed
539
	/* Queue all of the dependencies for this cell */
540
	deps = cell_get_dependencies (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
541
	if (deps)
Morten Welinder's avatar
Morten Welinder committed
542
		cell_queue_recalc_list (deps, TRUE);
543
544
}

545

546
547
548
/*
 * cell_set_text
 *
Jody Goldberg's avatar
Jody Goldberg committed
549
550
 * Changes the content of a cell and stores
 * the actual entered text.
551
552
 */
void
553
cell_set_text (Cell *cell, const char *text)
554
555
556
{
	g_return_if_fail (cell != NULL);
	g_return_if_fail (text != NULL);
557

558
	if (cell->parsed_node != NULL && cell->parsed_node->oper == OPER_ARRAY) {
559
560
561
562
		gnumeric_no_modify_array_notice (cell->sheet->workbook);
		return;
	}

563
564
565
566
567
568
569
570
571
572
	if (*text == 0){
		static int warn_shown;

		if (!warn_shown){
			g_warning (
				"Cell value being set to empty string");
			warn_shown = 1;
		}
	}
	
573
574
575
	cell_queue_redraw (cell);

	cell_set_text_simple (cell, text);
Jody Goldberg's avatar
Jody Goldberg committed
576
577
578
579
580
581

	/* Store the real entered text */
	if (cell->text != NULL) {
		string_unref (cell->text);
		cell->entered_text = string_get (text);
	}
582
	cell_content_changed (cell);
583

584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
	cell_queue_redraw (cell);
}

/**
 * cell_set_formula_tree_simple:
 * @cell:    the cell to set the formula to
 * @formula: an expression tree with the formula
 *
 * This is an internal function.  It should be only called by routines that
 * know what they are doing.  These are the important differences from
 * cell_set_formula:
 *
 *   - It does not queue redraws (so you have to queue the redraw yourself
 *     or queue a full redraw).
 */
void
cell_set_formula_tree_simple (Cell *cell, ExprTree *formula)
{
	g_return_if_fail (cell != NULL);
	g_return_if_fail (formula != NULL);

605
	/* Ref before unref.  Repeat after me.  */
Morten Welinder's avatar
Morten Welinder committed
606
607
	expr_tree_ref (formula);

608
609
	cell_modified (cell);
	cell_cleanout (cell);
610
611

	cell->parsed_node = formula;
612
613
	/* Until the value is recomputed, we put in this value.  */
	cell->value = value_new_error (NULL, _("Circular reference"));
614
615
616
	cell_formula_changed (cell);
}

617
618
619
620
621
622
623
624
625
/**
 * cell_set_array_formula:
 * @sheet:   The sheet to set the formula to.
 * @row_a:   The top row in the destination region.
 * @col_a:   The left column in the destination region.
 * @row_b:   The bottom row in the destination region.
 * @col_b:   The right column in the destination region.
 * @formula: an expression tree with the formula
 *
626
 * Uses cell_set_formula_tree_simple to store the formula as an
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 * 'array-formula'.  The supplied expression is wrapped in an array
 * operator for each cell in the range and scheduled for recalc.  The
 * upper left corner is handled as a special case and care is taken to
 * out it at the head of the recalc queue.
 */
void
cell_set_array_formula (Sheet *sheet,
			int row_a, int col_a, int row_b, int col_b,
			ExprTree *formula)
{
	int const num_rows = 1 + row_b - row_a;
	int const num_cols = 1 + col_b - col_a;
	int x, y;
	Cell * const corner = sheet_cell_fetch (sheet, col_a, row_a);
	Cell * cell = NULL;
642
	ExprTree *wrapper;
643
644
645
646
647
648
649
650
651
652
653

	g_return_if_fail (num_cols > 0);
	g_return_if_fail (num_rows > 0);
	g_return_if_fail (formula != NULL);
	g_return_if_fail (corner != NULL);

	wrapper = expr_tree_array_formula (0, 0, num_rows, num_cols);
	wrapper->u.array.corner.func.value = NULL;
	wrapper->u.array.corner.func.expr = formula;
	expr_tree_ref (formula);
	cell_set_formula_tree_simple (corner, wrapper);
654
	expr_tree_unref (wrapper);
655
656
657
658
659

	/* The corner must be 1st on the recalc list, queue it later */
	cell_unqueue_from_recalc (corner);

	for (x = 0; x < num_cols; ++x)
660
		for (y = 0; y < num_rows; ++y) {
661
662
			if (x == 0 && y == 0)
				continue;
Michael Meeks's avatar
Michael Meeks committed
663
			cell = sheet_cell_fetch (sheet, col_a + x, row_a + y);
664
665
666
667
			wrapper = expr_tree_array_formula (x, y,
							   num_rows, num_cols);
			wrapper->u.array.corner.cell = corner;
			cell_set_formula_tree_simple (cell, wrapper);
668
			expr_tree_unref (wrapper);
669
670
671
672
673
674
		}

	/* Put the corner at the head of the recalc list */
	cell_queue_recalc (corner);
}

675
676
677
678
679
680
681
682
void
cell_set_formula_tree (Cell *cell, ExprTree *formula)
{
	g_return_if_fail (cell != NULL);

	cell_queue_redraw (cell);

	cell_set_formula_tree_simple (cell, formula);
683
	cell_content_changed (cell);
Arturo Espinosa's avatar
Today:    
Arturo Espinosa committed
684
685

	cell_queue_redraw (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
686
}
Arturo Espinosa's avatar
Arturo Espinosa committed
687

688
689
690
691
/**
 * cell_copy:
 * @cell: existing cell to duplicate
 *
692
 * Makes a copy of a Cell.
693
 *
694
 * Returns a copy of the cell.
Arturo Espinosa's avatar
Arturo Espinosa committed
695
696
 */
Cell *
697
cell_copy (const Cell *cell)
Arturo Espinosa's avatar
Arturo Espinosa committed
698
699
700
701
702
703
704
705
706
707
{
	Cell *new_cell;

	g_return_val_if_fail (cell != NULL, NULL);

	new_cell = g_new (Cell, 1);

	/* bitmap copy first */
	*new_cell = *cell;

Morten Welinder's avatar
Morten Welinder committed
708
	new_cell->flags &= ~CELL_QUEUED_FOR_RECALC;
709

Morten Welinder's avatar
Morten Welinder committed
710
	/* now copy properly the rest */
711
	if (new_cell->parsed_node)
Morten Welinder's avatar
Morten Welinder committed
712
713
714
715
		expr_tree_ref (new_cell->parsed_node);

	if (new_cell->text)
		string_ref (new_cell->text);
716
717
718
719

	if (new_cell->entered_text)
		string_ref (new_cell->entered_text);

720
721
/*	if (new_cell->style)
	new_cell->style = style_duplicate (new_cell->style);*/
Morten Welinder's avatar
Morten Welinder committed
722
723
724

	if (new_cell->render_color)
		style_color_ref (new_cell->render_color);
725
726
727

	if (new_cell->value)
		new_cell->value = value_duplicate (new_cell->value);
Arturo Espinosa's avatar
Arturo Espinosa committed
728

Morten Welinder's avatar
Morten Welinder committed
729
730
	if (cell->comment) {
		new_cell->comment = NULL;
731
		cell_set_comment (new_cell, cell->comment->comment->str);
Morten Welinder's avatar
Morten Welinder committed
732
	}
733

Arturo Espinosa's avatar
Arturo Espinosa committed
734
735
736
737
738
739
740
741
	return new_cell;
}

void
cell_destroy (Cell *cell)
{
	g_return_if_fail (cell != NULL);

Morten Welinder's avatar
Morten Welinder committed
742
743
744
745
746
747
	if (cell_hash_queue && g_hash_table_lookup (cell_hash_queue, cell)) {
		g_warning ("FIXME: Deleting cell %s which was queued for redraw",
			   cell_name (cell->col->pos, cell->row->pos));
		g_hash_table_remove (cell_hash_queue, cell);
	}

748
	cell_modified (cell);
749
	cell_cleanout (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
750

751
752
	if (cell->render_color)
		style_color_unref (cell->render_color);
Morten Welinder's avatar
Morten Welinder committed
753
	cell->render_color = (void *)0xdeadbeef;
754

755
	cell_comment_destroy (cell);
756
757

	if (cell->text)
758
		string_unref (cell->text);
Morten Welinder's avatar
Morten Welinder committed
759
760
	cell->text = (void *)0xdeadbeef;

761
/*	cell->style = (void *)0xdeadbeef;*/
762

763
	g_free (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
764
}
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
765

766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
void
cell_freeze_redraws (void)
{
	redraws_frozen++;
	if (redraws_frozen == 1)
		cell_hash_queue = g_hash_table_new (g_direct_hash, g_direct_equal);
}

static void
call_cell_queue_redraw (gpointer key, gpointer value, gpointer user_data)
{
	cell_queue_redraw (value);
}

void
cell_thaw_redraws (void)
{
	redraws_frozen--;
784
	if (redraws_frozen < 0) {
785
786
787
		g_warning ("unbalanced freeze/thaw\n");
		return;
	}
788
	if (redraws_frozen == 0) {
789
790
791
792
793
		g_hash_table_foreach (cell_hash_queue, call_cell_queue_redraw, NULL);
		g_hash_table_destroy (cell_hash_queue);
		cell_hash_queue = NULL;
	}
}
Michael Meeks's avatar
Michael Meeks committed
794
795
796
797
798
799
800
801
802
803
804
805
806
void
cell_deep_freeze_redraws (void)
{
	redraws_deep_frozen++;
}

void
cell_deep_thaw_redraws (void)
{
	redraws_deep_frozen--;
	if (redraws_frozen < 0)
		g_warning ("unbalanced deep freeze/thaw\n");
}
807
808
809
810
811
812
813
814
815

static void
queue_cell (Cell *cell)
{
	if (g_hash_table_lookup (cell_hash_queue, cell))
		return;
	g_hash_table_insert (cell_hash_queue, cell, cell);
}

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
816
817
818
void
cell_queue_redraw (Cell *cell)
{
Michael Meeks's avatar
Michael Meeks committed
819
	/* You wake up dead after a deep freeze */
820
	if (redraws_deep_frozen > 0)
Michael Meeks's avatar
Michael Meeks committed
821
822
		return;

823
	g_return_if_fail (cell != NULL);
824

825
	if (redraws_frozen) {
826
827
828
		queue_cell (cell);
		return;
	}
Morten Welinder's avatar
Morten Welinder committed
829

Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
830
831
832
833
834
	sheet_redraw_cell_region (cell->sheet,
				  cell->col->pos, cell->row->pos,
				  cell->col->pos, cell->row->pos);
}

835
836
837
838
839
840
841
842
843
/*
 * cell_set_format_simple:
 *
 * This routine is similar to cell_set_format, but it does not queue
 * any redraws, nor expects the cell to have a value.
 *
 * Make sure you queue a draw in the future for this cell.
 */
void
844
cell_set_format_simple (Cell *cell, const char *format)
845
{
846
	MStyle *mstyle = mstyle_new ();
847

848
	mstyle_set_format (mstyle, format);
849

850
	cell_set_mstyle (cell, mstyle);
851
852
}

853
854
855
856
857
858
/*
 * cell_set_format:
 *
 * Changes the format for CELL to be FORMAT.  FORMAT should be
 * a number display format as specified on the manual
 */
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
859
void
860
cell_set_format (Cell *cell, const char *format)
Miguel de Icaza's avatar
Today:    
Miguel de Icaza committed
861
{
862
	g_return_if_fail (cell != NULL);
863

864
	cell_set_format_simple (cell, format);
865

866
867
868
	/* re-render the cell text */
	cell_render_value (cell);
	cell_queue_redraw (cell);
869
870
}

871
872
873
874
void
cell_comment_reposition (Cell *cell)
{
	GList *l;
875

876
877
	g_return_if_fail (cell != NULL);
	g_return_if_fail (cell->comment != NULL);
878

879
	/* FIXME : This should use the sheet_view list */
880
881
882
883
884
885
886
887
	for (l = cell->comment->realized_list; l; l = l->next){
		GnomeCanvasItem *o = l->data;
		SheetView *sheet_view = GNUMERIC_SHEET (o->canvas)->sheet_view;

		sheet_view_comment_relocate (sheet_view, cell->col->pos, cell->row->pos, o);
	}
}

888
/*
889
 * cell_relocate:
890
891
 * @cell:           The cell that is changing position
 * @check_bonunds : Should expressions be bounds checked.
892
893
 *
 * This routine is used to move a cell to a different location:
894
895
 *
 * Auxiliary items canvas items attached to the cell are moved.
896
 */
Arturo Espinosa's avatar
Arturo Espinosa committed
897
void
898
cell_relocate (Cell *cell, gboolean const check_bounds)
Arturo Espinosa's avatar
Arturo Espinosa committed
899
900
{
	g_return_if_fail (cell != NULL);
901
902

	/* 1. Tag the cell as modified */
903
904
	cell_modified (cell);

905
	/* 2. If the cell contains a formula, relocate the formula */
Michael Meeks's avatar
Michael Meeks committed
906
	if (cell->parsed_node) {
907
		sheet_cell_formula_unlink (cell);
908
909
910
911

		/*
		 * WARNING WARNING WARNING
		 *
912
		 * This will only work if the new array cell has already
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
		 * been inserted.
		 *
		 * WARNING WARNING WARNING
		 */
		/* If cell was part of an array, reset the corner pointer */
		if (cell->parsed_node->oper == OPER_ARRAY) {
			int const x = cell->parsed_node->u.array.x;
			int const y = cell->parsed_node->u.array.y;
			if (x != 0 || y != 0)
				cell->parsed_node->u.array.corner.cell =
					sheet_cell_get (cell->sheet,
							cell->col->pos - x,
							cell->row->pos - y);
		}

928
929
930
931
932
		/* We do not actually need to change any references
		 * the move is from its current location to its current
		 * location.  All the move is doing is a bounds check.
		 */
		if (check_bounds) {
933
934
			ExprRelocateInfo	rinfo;
			EvalPosition 		pos;
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
			ExprTree    	*expr = cell->parsed_node;

			rinfo.origin.start.col =
				rinfo.origin.end.col = cell->col->pos;
			rinfo.origin.start.row =
				rinfo.origin.end.row = cell->row->pos;
			rinfo.origin_sheet = rinfo.target_sheet = cell->sheet;
			rinfo.col_offset = 0;
			rinfo.row_offset = 0;
			expr = expr_relocate (expr, eval_pos_cell (&pos, cell), &rinfo);

			if (expr != NULL) {
				expr_tree_unref (cell->parsed_node);
				cell->parsed_node = expr;
			}
		}

952
		/* The following call also relinks the cell.  */
953
		cell_formula_changed (cell);
954
	}
955

956
	/* 3. Move any auxiliary canvas items */
Miguel de Icaza's avatar
Miguel de Icaza committed
957
958
	if (cell->comment)
		cell_comment_reposition (cell);
Michael Meeks's avatar
Michael Meeks committed
959
960
961

	/* 4. Tag the contents as having changed */
	cell_content_changed (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
962
963
964
965
966
967
968
969
970
971
972
}

/*
 * This routine drops the formula and just keeps the value
 */
void
cell_make_value (Cell *cell)
{
	g_return_if_fail (cell != NULL);
	g_return_if_fail (cell->parsed_node != NULL);

973
	/* FIXME: does this work at all?  -- MW */
974
	cell_modified (cell);
Arturo Espinosa's avatar
Arturo Espinosa committed
975
}
976
977

int
978
cell_get_horizontal_align (const Cell *cell, int align)
979
{
980
	g_return_val_if_fail (cell != NULL, HALIGN_RIGHT);
981

982
983
984
	if (align == HALIGN_GENERAL) {
		if (cell->value) {
			if (cell->value->type == VALUE_FLOAT ||
985
			    cell->value->type == VALUE_INTEGER)
986
				align = HALIGN_RIGHT;
987
			else
988
				align = HALIGN_LEFT;
989
		} else
990
991
992
993
			align = HALIGN_RIGHT;
	}

	return align;
994
995
}

996
gboolean inline
997
cell_is_number (const Cell *cell)
998
{
999
	return cell->value && VALUE_IS_NUMBER (cell->value);
1000
}
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
gboolean
cell_is_zero (const Cell *cell)
{
	Value const * const v = cell->value;
	if (v == NULL)
		return FALSE;
	switch (v->type) {
	case VALUE_BOOLEAN : return !v->v.v_bool;
	case VALUE_INTEGER : return v->v.v_int == 0;
	case VALUE_FLOAT :
	{
		double const res = v->v.v_float;
		return (-1e-10 < res && res < 1e-10);
	}

	default :
		return FALSE;
	}
}
1020
1021

static inline int
1022
cell_contents_fit_inside_column (const Cell *cell)
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
{
	if (cell->width < COL_INTERNAL_WIDTH (cell->col))
		return TRUE;
	else
		return FALSE;
}

/*
 * cell_get_span:
 * @cell:   The cell we will examine
 * @col1:   return value: the first column used by this cell
 * @col2:   return value: the last column used by this cell
 *
 * This routine returns the column interval used by a Cell.
 */
void
cell_get_span (Cell *cell, int *col1, int *col2)
{
	Sheet *sheet;
	int align, left;
	int row, pos, margin;
1044
	MStyle *mstyle;
1045

1046
1047
	g_return_if_fail (cell != NULL);

1048
1049
1050
1051
        /*
	 * If the cell is a number, or the text fits inside the column, or the
	 * alignment modes are set to "justify", then we report only one
	 * column is used.
1052
	 */
1053

1054
	if (cell_is_number (cell) ||
1055
	    cell_contents_fit_inside_column (cell)) {
1056
1057
1058
1059
1060
		*col1 = *col2 = cell->col->pos;
		return;
	}

	sheet = cell->sheet;
1061
1062
1063
1064
	mstyle = sheet_style_compute (cell->sheet, cell->col->pos,
				      cell->row->pos);
	align = cell_get_horizontal_align (cell,
					   mstyle_get_align_h (mstyle));
1065
1066
	row   = cell->row->pos;

1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
	if (align == HALIGN_JUSTIFY ||
	    align == HALIGN_FILL ||
	    mstyle_get_fit_in_cell (mstyle) ||
	    mstyle_get_align_v (mstyle) == VALIGN_JUSTIFY) {
		*col1 = *col2 = cell->col->pos;
		mstyle_unref (mstyle);
		return;
	}
	mstyle_unref (mstyle);

	switch (align) {
1078
1079
1080
1081
1082
	case HALIGN_LEFT:
		*col1 = *col2 = cell->col->pos;
		pos = cell->col->pos + 1;
		left = cell->width - COL_INTERNAL_WIDTH (cell->col);
		margin = cell->col->margin_b;
1083

1084
1085
1086
1087
1088
1089
		for (; left > 0 && pos < SHEET_MAX_COLS-1; pos++){
			ColRowInfo *ci;
			Cell *sibling;

			sibling = sheet_cell_get (sheet, pos, row);

Arturo Espinosa's avatar
Arturo Espinosa committed
1090
			if (!cell_is_blank (sibling))
1091
1092
1093
				return;

			ci = sheet_col_get_info (sheet, pos);
1094

1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
			/* The space consumed is:
			 *    - The margin_b from the last column
			 *    - The width of the cell
			 */
			left -= COL_INTERNAL_WIDTH (ci) +
				margin + ci->margin_a;
			margin = ci->margin_b;
			(*col2)++;
		}
		return;
1105

1106
1107
1108
1109
1110
	case HALIGN_RIGHT:
		*col1 = *col2 = cell->col->pos;
		pos = cell->col->pos - 1;
		left = cell->width - COL_INTERNAL_WIDTH (cell->col);
		margin = cell->col->margin_a;
1111

1112
1113
1114
1115
1116
1117
		for (; left > 0 && pos >= 0; pos--){
			ColRowInfo *ci;
			Cell *sibling;

			sibling = sheet_cell_get (sheet, pos, row);

Arturo Espinosa's avatar
Arturo Espinosa committed
1118
			if (!cell_is_blank (sibling))
1119
1120
1121
1122
1123
1124
				return;

			ci = sheet_col_get_info (sheet, pos);

			/* The space consumed is:
			 *   - The margin_a from the last column
Jody Goldberg's avatar
Jody Goldberg committed
1125
			 *   - The width of this cell
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
			 */
			left -= COL_INTERNAL_WIDTH (ci) +
				margin + ci->margin_b;
			margin = ci->margin_a;
			(*col1)--;
		}
		return;

	case HALIGN_CENTER: {
		int left_left, left_right;
		int margin_a, margin_b;
1137

1138
1139
		*col1 = *col2 = cell->col->pos;
		left = cell->width -  COL_INTERNAL_WIDTH (cell->col);
1140

1141
1142
1143
1144
		left_left  = left / 2 + (left % 2);
		left_right = left / 2;
		margin_a = cell->col->margin_a;
		margin_b = cell->col->margin_b;
1145

1146
1147
1148
1149
		for (; left_left > 0 || left_right > 0;){
			ColRowInfo *ci;
			Cell *left_sibling, *right_sibling;

Arturo Espinosa's avatar
Arturo Espinosa committed
1150
			if (*col1 - 1 >= 0){
1151
1152
				left_sibling = sheet_cell_get (sheet, *col1 - 1