expr.c 38.9 KB
Newer Older
Miguel de Icaza's avatar
Miguel de Icaza committed
1
/*
Morten Welinder's avatar
Morten Welinder committed
2
 * expr.c: Expression evaluation in Gnumeric
Miguel de Icaza's avatar
Miguel de Icaza committed
3 4 5 6
 *
 * Author:
 *   Miguel de Icaza (miguel@gnu.org).
 */
7
#include <config.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
8
#include <gnome.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
9
#include <math.h>
10
#include <string.h>
11
#include <locale.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
12
#include "gnumeric.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
13
#include "expr.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
14
#include "eval.h"
Miguel de Icaza's avatar
Today:  
Miguel de Icaza committed
15
#include "format.h"
16
#include "func.h"
17
#include "utils.h"
18
#include "ranges.h"
19

20 21
static Value *eval_expr_real (FunctionEvalInfo *s, ExprTree const *tree);

22
EvalPosition *
23
eval_pos_init (EvalPosition *eval_pos, Sheet *sheet, int col, int row)
24
{
25 26 27 28 29 30 31
	g_return_val_if_fail (sheet != NULL, NULL);
	g_return_val_if_fail (eval_pos != NULL, NULL);
	g_return_val_if_fail (IS_SHEET (sheet), NULL);

	eval_pos->sheet = sheet;
	eval_pos->eval_col = col;
	eval_pos->eval_row = row;
32

33
	return eval_pos;
34
}
35

36 37 38 39 40 41 42 43 44 45 46 47 48
ParsePosition *
parse_pos_init (ParsePosition *pp, Workbook *wb, int col, int row)
{
	g_return_val_if_fail (wb != NULL, NULL);
	g_return_val_if_fail (pp != NULL, NULL);

	pp->wb  = wb;
	pp->col = col;
	pp->row = row;

	return pp;
}

49
EvalPosition *
50
eval_pos_cell (EvalPosition *eval_pos, Cell *cell)
51
{
52 53 54
	g_return_val_if_fail (eval_pos != NULL, NULL);
	g_return_val_if_fail (cell != NULL, NULL);
	g_return_val_if_fail (cell->sheet != NULL, NULL);
55 56
	g_return_val_if_fail (IS_SHEET (cell->sheet), NULL);

57 58 59 60 61
	return eval_pos_init (
		eval_pos,
		cell->sheet,
		cell->col->pos,
		cell->row->pos);
62
}
63

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
ParsePosition *
parse_pos_cell (ParsePosition *pp, Cell *cell)
{
	g_return_val_if_fail (pp != NULL, NULL);
	g_return_val_if_fail (cell != NULL, NULL);
	g_return_val_if_fail (cell->sheet != NULL, NULL);
	g_return_val_if_fail (IS_SHEET (cell->sheet), NULL);
	g_return_val_if_fail (cell->sheet->workbook != NULL, NULL);

	return parse_pos_init (
		pp,
		cell->sheet->workbook,
		cell->col->pos,
		cell->row->pos);
}

80
FunctionEvalInfo *
81
func_eval_info_init (FunctionEvalInfo *eval_info, Sheet *sheet, int col, int row)
82
{
83
	g_return_val_if_fail (eval_info != NULL, NULL);
84
       
85 86
	eval_pos_init (&eval_info->pos, sheet, col, row);
	eval_info->func_def = 0;
87

88
	return eval_info;
89 90
}

91
FunctionEvalInfo *
92
func_eval_info_cell (FunctionEvalInfo *eval_info, Cell *cell)
93
{
94 95
	g_return_val_if_fail (eval_info != NULL, NULL);
	g_return_val_if_fail (cell != NULL, NULL);
96

97 98 99
	return func_eval_info_init (
		eval_info, cell->sheet,
		cell->col->pos, cell->row->pos);
100 101
}

102 103
FunctionEvalInfo *
func_eval_info_pos (FunctionEvalInfo *eval_info, const EvalPosition *eval_pos)
104
{
105 106
	g_return_val_if_fail (eval_info != NULL, NULL);
	g_return_val_if_fail (eval_pos != NULL, NULL);
107

108 109 110 111 112
	return func_eval_info_init (
		eval_info,
		eval_pos->sheet,
		eval_pos->eval_col,
		eval_pos->eval_row);
113 114
}

115
ExprTree *
Morten Welinder's avatar
Morten Welinder committed
116
expr_tree_new_constant (Value *v)
117
{
118 119 120
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
121 122 123 124 125 126 127
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = OPER_CONSTANT;
	ans->u.constant = v;

Morten Welinder's avatar
Morten Welinder committed
128 129 130 131 132 133 134 135 136
	return ans;
}

ExprTree *
expr_tree_new_unary  (Operation op, ExprTree *e)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
137 138 139 140 141 142 143
	if (!ans)
		return NULL;

	ans->ref_count = 1;
	ans->oper = op;
	ans->u.value = e;

Morten Welinder's avatar
Morten Welinder committed
144 145 146 147 148 149 150 151 152 153
	return ans;
}


ExprTree *
expr_tree_new_binary (ExprTree *l, Operation op, ExprTree *r)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
154 155 156 157 158 159 160 161
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = op;
	ans->u.binary.value_a = l;
	ans->u.binary.value_b = r;

Morten Welinder's avatar
Morten Welinder committed
162 163 164 165 166 167 168 169 170 171
	return ans;
}

ExprTree *
expr_tree_new_funcall (Symbol *sym, GList *args)
{
	ExprTree *ans;
	g_return_val_if_fail (sym, NULL);

	ans = g_new (ExprTree, 1);
172 173 174 175 176 177 178 179
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = OPER_FUNCALL;
	ans->u.function.symbol = sym;;
	ans->u.function.arg_list = args;

Morten Welinder's avatar
Morten Welinder committed
180 181
	return ans;
}
182
       
183 184 185 186 187 188 189 190 191 192 193
int
expr_tree_get_const_int (ExprTree const * const expr)
{
	g_return_val_if_fail (expr != NULL, 0);
	g_return_val_if_fail (expr->oper == OPER_CONSTANT, 0);
	g_return_val_if_fail (expr->u.constant, 0);
	g_return_val_if_fail (expr->u.constant->type == VALUE_INTEGER, 0);

	return expr->u.constant->v.v_int;
}

194 195 196 197 198 199 200 201 202 203 204
char const *
expr_tree_get_const_str (ExprTree const *const expr)
{
	g_return_val_if_fail (expr != NULL, NULL);
	g_return_val_if_fail (expr->oper == OPER_CONSTANT, NULL);
	g_return_val_if_fail (expr->u.constant, NULL);
	g_return_val_if_fail (expr->u.constant->type == VALUE_STRING, NULL);

	return expr->u.constant->v.str->str;
}

205
ExprTree *
206
expr_parse_string (const char *expr, const ParsePosition *pp,
207 208 209 210 211
		   const char **desired_format, char **error_msg)
{
	ExprTree *tree;
	g_return_val_if_fail (expr != NULL, NULL);

212
	switch (gnumeric_expr_parser (expr, pp, desired_format, &tree)) {
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
	case PARSE_OK:
		*error_msg = NULL;
		tree->ref_count = 1;
		return tree;

	case PARSE_ERR_SYNTAX:
		*error_msg = _("Syntax error");
		break;

	case PARSE_ERR_NO_QUOTE:
		*error_msg = _("Missing quote");
		break;
	default:
		g_assert_not_reached ();
		*error_msg = _("Impossible!");
		break;
	}
	return NULL;
}

Michael Meeks's avatar
Michael Meeks committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
ExprTree *
expr_tree_new_name (const ExprName *name)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = OPER_NAME;
	ans->u.name = name;

	return ans;
}
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262

/*ExprTree *
expr_tree_new (void)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = OPER_CONSTANT;
	ans->u.constant = NULL;
	return ans;
}*/
Morten Welinder's avatar
Morten Welinder committed
263 264 265 266 267 268 269

ExprTree *
expr_tree_new_var (const CellRef *cr)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
270 271 272 273 274 275 276
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = OPER_VAR;
	ans->u.ref = *cr;

277 278 279
	return ans;
}

Morten Welinder's avatar
Morten Welinder committed
280 281 282 283
ExprTree *
expr_tree_new_error (const char *txt)
{
	Symbol *func;
Morten Welinder's avatar
Morten Welinder committed
284 285 286 287 288 289 290 291 292
	GList *args = NULL;

	if (strcmp (txt, gnumeric_err_NA) == 0) {
		func = symbol_lookup (global_symbol_table, "NA");
	} else {
		func = symbol_lookup (global_symbol_table, "ERROR");
		args = g_list_prepend (NULL,
				       expr_tree_new_constant (value_new_string (txt)));
	}
Morten Welinder's avatar
Morten Welinder committed
293 294

	symbol_ref (func);
Morten Welinder's avatar
Morten Welinder committed
295
	return expr_tree_new_funcall (func, args);
Morten Welinder's avatar
Morten Welinder committed
296 297
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
ExprTree *
expr_tree_array_formula (int const x, int const y, int const rows, int const cols)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
	if (ans == NULL)
		return NULL;
	
	ans->ref_count = 1;
	ans->oper = OPER_ARRAY;
	ans->u.array.x = x;
	ans->u.array.y = y;
	ans->u.array.rows = rows;
	ans->u.array.cols = cols;
	ans->u.array.corner.func.value = NULL;
	ans->u.array.corner.func.expr = NULL;
	ans->u.array.corner.cell = NULL;
	return ans;
}


static ExprTree *
321
expr_tree_array_formula_corner (ExprTree const *expr, EvalPosition const *pos)
322
{
323
	Cell * corner = expr->u.array.corner.cell;
324

325 326 327 328 329 330 331 332 333 334 335 336
	/* Attempt to set the corner if it is not already set */
	if (corner == NULL) {
		g_return_val_if_fail (pos != NULL, NULL);
		g_return_val_if_fail (pos->sheet != NULL, NULL);

		corner = sheet_cell_get (pos->sheet,
					 pos->eval_col - expr->u.array.x,
					 pos->eval_row - expr->u.array.y);
		((ExprTree *)expr)->u.array.corner.cell = corner;
	}

	g_return_val_if_fail (corner != NULL, NULL);
337 338 339 340 341
	g_return_val_if_fail (corner->parsed_node != NULL, NULL);

	/* Sanity check incase the corner gets removed for some reason */
	g_return_val_if_fail (corner->parsed_node != (void *)0xdeadbeef, NULL);
	g_return_val_if_fail (corner->parsed_node->oper == OPER_ARRAY, NULL);
342 343
	g_return_val_if_fail (corner->parsed_node->u.array.x == 0, NULL);
	g_return_val_if_fail (corner->parsed_node->u.array.y == 0, NULL);
344 345 346 347

	return corner->parsed_node;
}

Arturo Espinosa's avatar
Arturo Espinosa committed
348 349 350 351
/*
 * expr_tree_ref:
 * Increments the ref_count for part of a tree
 */
352 353 354 355 356 357
void
expr_tree_ref (ExprTree *tree)
{
	g_return_if_fail (tree != NULL);
	g_return_if_fail (tree->ref_count > 0);

Morten Welinder's avatar
Morten Welinder committed
358
	tree->ref_count++;
Arturo Espinosa's avatar
Arturo Espinosa committed
359 360 361 362 363
}

static void
do_expr_tree_unref (ExprTree *tree)
{
Morten Welinder's avatar
Morten Welinder committed
364 365 366
	if (--tree->ref_count > 0)
		return;

Arturo Espinosa's avatar
Arturo Espinosa committed
367
	switch (tree->oper){
368
	case OPER_VAR:
Arturo Espinosa's avatar
Arturo Espinosa committed
369
		break;
370

371
	case OPER_CONSTANT:
Morten Welinder's avatar
Morten Welinder committed
372
		value_release (tree->u.constant);
Arturo Espinosa's avatar
Arturo Espinosa committed
373
		break;
374

Morten Welinder's avatar
Morten Welinder committed
375 376 377 378 379 380 381
	case OPER_FUNCALL: {
		GList *l;

		for (l = tree->u.function.arg_list; l; l = l->next)
			do_expr_tree_unref (l->data);
		g_list_free (tree->u.function.arg_list);
		symbol_unref (tree->u.function.symbol);
Arturo Espinosa's avatar
Arturo Espinosa committed
382
		break;
Morten Welinder's avatar
Morten Welinder committed
383
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
384

Michael Meeks's avatar
Michael Meeks committed
385 386 387
	case OPER_NAME:
		break;

388
	case OPER_ANY_BINARY:
Arturo Espinosa's avatar
Arturo Espinosa committed
389 390 391 392
		do_expr_tree_unref (tree->u.binary.value_a);
		do_expr_tree_unref (tree->u.binary.value_b);
		break;

393
	case OPER_ANY_UNARY:
Arturo Espinosa's avatar
Arturo Espinosa committed
394 395
		do_expr_tree_unref (tree->u.value);
		break;
396
	case OPER_ARRAY:
397 398 399
		if (tree->u.array.x == 0 && tree->u.array.y == 0) {
			if (tree->u.array.corner.func.value)
				value_release (tree->u.array.corner.func.value);
400
			do_expr_tree_unref (tree->u.array.corner.func.expr);
401
		}
402
		break;
403 404 405
	default:
		g_warning ("do_expr_tree_unref error\n");
		break;
Arturo Espinosa's avatar
Arturo Espinosa committed
406
	}
407

Morten Welinder's avatar
Morten Welinder committed
408
	g_free (tree);
409 410
}

Morten Welinder's avatar
Morten Welinder committed
411 412 413 414 415 416
/*
 * expr_tree_unref:
 * Decrements the ref_count for part of a tree.  (All trees are expected
 * to have been created with a ref-count of one, so when we hit zero, we
 * go down over the tree and unref the tree and its leaves stuff.)
 */
417 418 419 420 421 422
void
expr_tree_unref (ExprTree *tree)
{
	g_return_if_fail (tree != NULL);
	g_return_if_fail (tree->ref_count > 0);

Arturo Espinosa's avatar
Arturo Espinosa committed
423
	do_expr_tree_unref (tree);
424 425
}

426 427 428 429 430 431
static void
cell_ref_make_absolute (CellRef *cell_ref, int eval_col, int eval_row)
{
	g_return_if_fail (cell_ref != NULL);

	if (cell_ref->col_relative)
432
		cell_ref->col = eval_col + cell_ref->col;
433 434 435

	if (cell_ref->row_relative)
		cell_ref->row = eval_row + cell_ref->row;
436

Arturo Espinosa's avatar
Arturo Espinosa committed
437 438
	cell_ref->row_relative = 0;
	cell_ref->col_relative = 0;
439 440
}

441 442 443 444
static void
free_values (Value **values, int top)
{
	int i;
445

446
	for (i = 0; i < top; i++)
447 448
		if (values[i])
			value_release (values [i]);
449 450 451
	g_free (values);
}

452
static Value *
453
eval_funcall (FunctionEvalInfo *s, ExprTree const *tree)
Arturo Espinosa's avatar
Arturo Espinosa committed
454
{
455
	const Symbol *sym;
Arturo Espinosa's avatar
Arturo Espinosa committed
456 457
	FunctionDefinition *fd;
	GList *l;
458
	int argc, arg;
459
	Value *v = NULL;
460 461 462 463 464 465
	Sheet *sheet;
	int eval_col;
	int eval_row;

	g_return_val_if_fail (s, NULL);
	g_return_val_if_fail (tree, NULL);
466

467
	sym = tree->u.function.symbol;
468 469 470 471 472

	sheet    = s->pos.sheet;
	eval_col = s->pos.eval_col;
	eval_row = s->pos.eval_row;

Arturo Espinosa's avatar
Arturo Espinosa committed
473 474 475
	l = tree->u.function.arg_list;
	argc = g_list_length (l);

476
	if (sym->type != SYMBOL_FUNCTION)
477
		return value_new_error (&s->pos, _("Internal error"));
478

479
	fd = (FunctionDefinition *)sym->data;
Morten Welinder's avatar
Morten Welinder committed
480
	s->func_def = fd;
481

482 483
	if (fd->fn_type == FUNCTION_NODES) {
		/* Functions that deal with ExprNodes */		
484
		v = fd->fn.fn_nodes (s, l);
485
	} else {
Arturo Espinosa's avatar
Arturo Espinosa committed
486 487
		/* Functions that take pre-computed Values */
		Value **values;
Arturo Espinosa's avatar
Arturo Espinosa committed
488
		int fn_argc_min = 0, fn_argc_max = 0, var_len = 0;
489 490
		const char *arg_type = fd->args;
		const char *argptr = fd->args;
491

492
		/* Get variable limits */
Arturo Espinosa's avatar
Arturo Espinosa committed
493 494 495 496
		while (*argptr){
			if (*argptr++ == '|'){
				var_len = 1;
				continue;
497 498
			}
			if (!var_len)
Arturo Espinosa's avatar
Arturo Espinosa committed
499 500
				fn_argc_min++;
			fn_argc_max++;
501
		}
502

503 504
		if (argc > fn_argc_max || argc < fn_argc_min)
			return value_new_error (&s->pos, _("Invalid number of arguments"));
Arturo Espinosa's avatar
Arturo Espinosa committed
505

506
		values = g_new (Value *, fn_argc_max);
507

508
		for (arg = 0; l; l = l->next, arg++, arg_type++){
Arturo Espinosa's avatar
Arturo Espinosa committed
509
			ExprTree *t = (ExprTree *) l->data;
510
			gboolean type_mismatch = FALSE;
511
			Value *v;
512

Arturo Espinosa's avatar
Arturo Espinosa committed
513 514
			if (*arg_type=='|')
				arg_type++;
515 516 517 518

			if ((*arg_type != 'A' &&          /* This is so a cell reference */
			     *arg_type != 'r') ||         /* can be converted to a cell range */
			    !t || (t->oper != OPER_VAR)) { /* without being evaluated */
519
				if ((v = eval_expr_real (s, t)) == NULL)
520 521 522
					goto free_list;
			} else {
				g_assert (t->oper == OPER_VAR);
523
				v = value_new_cellrange (&t->u.ref,
Michael Meeks's avatar
Michael Meeks committed
524
							 &t->u.ref);
525
			}
526

Arturo Espinosa's avatar
Arturo Espinosa committed
527
			switch (*arg_type){
528
			case 'f':
Morten Welinder's avatar
Morten Welinder committed
529
			case 'b':
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
				/*
				 * Handle the implicit union of a single row or
				 * column with the eval position
				 */
				if (v->type == VALUE_CELLRANGE) {
					CellRef a = v->v.cell_range.cell_a;
					CellRef b = v->v.cell_range.cell_b;
					cell_ref_make_absolute (&a, eval_col,
								eval_row);
					cell_ref_make_absolute (&b, eval_col,
								eval_row);

					if (a.sheet !=  b.sheet)
						type_mismatch = TRUE;
					else if (a.row == b.row) {
						int const c = s->pos.eval_col;
						if (a.col <= c && c <= b.col)
							v = value_duplicate(value_area_get_x_y (&s->pos, v, c - a.col, 0));
						else
							type_mismatch = TRUE;
					} else if (a.col == b.col) {
						int const r = s->pos.eval_row;
						if (a.row <= r && r <= b.row)
							v = value_duplicate(value_area_get_x_y (&s->pos, v, 0, r - a.row));
						else
							type_mismatch = TRUE;
					} else
						type_mismatch = TRUE;
				} else if (v->type != VALUE_INTEGER &&
					 v->type != VALUE_FLOAT &&
					 v->type != VALUE_BOOLEAN)
					type_mismatch = TRUE;
562
				break;
563
			case 's':
564
				if (v->type != VALUE_STRING)
565
					type_mismatch = TRUE;
Arturo Espinosa's avatar
Arturo Espinosa committed
566
				break;
567
			case 'r':
568
				if (v->type != VALUE_CELLRANGE)
569
					type_mismatch = TRUE;
570 571 572
				else {
					cell_ref_make_absolute (&v->v.cell_range.cell_a, eval_col, eval_row);
					cell_ref_make_absolute (&v->v.cell_range.cell_b, eval_col, eval_row);
573
				}
Arturo Espinosa's avatar
Arturo Espinosa committed
574
				break;
575 576
			case 'a':
				if (v->type != VALUE_ARRAY)
577
					type_mismatch = TRUE;
578 579 580 581
				break;
			case 'A':
				if (v->type != VALUE_ARRAY &&
				    v->type != VALUE_CELLRANGE)
582
					type_mismatch = TRUE;
Michael Meeks's avatar
Michael Meeks committed
583 584 585 586 587

				if (v->type == VALUE_CELLRANGE) {
					cell_ref_make_absolute (&v->v.cell_range.cell_a, eval_col, eval_row);
					cell_ref_make_absolute (&v->v.cell_range.cell_b, eval_col, eval_row);
				}
588 589
				break;
			}
590
			values [arg] = v;
591
			if (type_mismatch){
592
				free_values (values, arg + 1);
593 594
				return value_new_error (&s->pos,
							gnumeric_err_VALUE);
595
			}
Arturo Espinosa's avatar
Arturo Espinosa committed
596
		}
Arturo Espinosa's avatar
Arturo Espinosa committed
597 598
		while (arg < fn_argc_max)
			values [arg++] = NULL;
599
		v = fd->fn.fn_args (s, values);
Arturo Espinosa's avatar
Arturo Espinosa committed
600 601

	free_list:
602
		free_values (values, arg);
Arturo Espinosa's avatar
Arturo Espinosa committed
603 604 605 606
	}
	return v;
}

607
typedef enum {
Arturo Espinosa's avatar
Arturo Espinosa committed
608 609
	IS_EQUAL,
	IS_LESS,
610
	IS_GREATER,
611
	TYPE_MISMATCH
612 613 614
} compare_t;

static compare_t
615
compare_bool_bool (Value const * const va, Value const * const vb)
616
{
617 618 619 620 621 622 623 624 625 626 627 628 629
	gboolean err; /* Ignored */
	gboolean const a = value_get_as_bool (va, &err);
	gboolean const b = value_get_as_bool (vb, &err);
	if (a)
		return b ? IS_EQUAL : IS_GREATER;
	return b ? IS_LESS : IS_EQUAL;
}

static compare_t
compare_int_int (Value const * const va, Value const * const vb)
{
	int const a = value_get_as_int (va);
	int const b = value_get_as_int (vb);
630 631 632 633 634 635 636 637 638
	if (a == b)
		return IS_EQUAL;
	else if (a < b)
		return IS_LESS;
	else
		return IS_GREATER;
}

static compare_t
639
compare_float_float (Value const * const va, Value const * const vb)
640
{
641 642
	float_t const a = value_get_as_float (va);
	float_t const b = value_get_as_float (vb);
643 644 645 646 647 648 649
	if (a == b)
		return IS_EQUAL;
	else if (a < b)
		return IS_LESS;
	else
		return IS_GREATER;
}
Arturo Espinosa's avatar
Arturo Espinosa committed
650

651 652 653 654
/*
 * Compares two (Value *) and returns one of compare_t
 */
static compare_t
655
compare (const Value *a, const Value *b)
Arturo Espinosa's avatar
Arturo Espinosa committed
656
{
657 658
	ValueType ta, tb;

659 660 661 662
	/* Handle trivial and double NULL case */
	if (a == b)
		return IS_EQUAL;

663 664
	ta = value_is_empty_cell (a) ? VALUE_EMPTY : a->type;
	tb = value_is_empty_cell (b) ? VALUE_EMPTY : b->type;
665

666 667 668 669 670 671
	/* string > empty */
	if (ta == VALUE_STRING) {
		switch (tb) {
		/* Strings are > (empty, or number) */
		case VALUE_EMPTY : case VALUE_INTEGER : case VALUE_FLOAT :
			return IS_GREATER;
672

673 674 675
		/* Strings are < FALSE ?? */
		case VALUE_BOOLEAN :
			return IS_LESS;
676

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
		/* If both are strings compare as string */
		case VALUE_STRING :
		{
			int const t = strcasecmp (a->v.str->str, b->v.str->str);
			if (t == 0)
				return IS_EQUAL;
			else if (t > 0)
				return IS_GREATER;
			else
				return IS_LESS;
		}
		default :
			/*
			 * TODO : Add implicit intersection here if not in
			 * array mode
			 * */
693
			return TYPE_MISMATCH;
694
		}
695 696 697 698 699
	} else if (tb == VALUE_STRING) {
		switch (ta) {
		/* (empty, or number) < String */
		case VALUE_EMPTY : case VALUE_INTEGER : case VALUE_FLOAT :
			return IS_LESS;
700

701 702 703
		/* Strings are < FALSE ?? */
		case VALUE_BOOLEAN :
			return IS_GREATER;
704

705 706 707 708 709
		default :
			/*
			 * TODO : Add implicit intersection here if not in
			 * array mode
			 * */
710
			return TYPE_MISMATCH;
711 712 713
		}
	}

714 715 716 717 718 719
	/* Booleans > all numbers (Why did excel do this ??) */
	if (ta == VALUE_BOOLEAN && (tb == VALUE_INTEGER || tb == VALUE_FLOAT))
		return IS_GREATER;
	if (tb == VALUE_BOOLEAN && (ta == VALUE_INTEGER || ta == VALUE_FLOAT))
		return IS_LESS;

720 721 722
	switch ((ta > tb) ? ta : tb) {
	case VALUE_EMPTY:	/* Empty Empty compare */
		return IS_EQUAL;
723

724 725
	case VALUE_BOOLEAN:
		return compare_bool_bool (a, b);
726

727 728 729 730 731 732 733 734
	case VALUE_INTEGER:
		return compare_int_int (a, b);

	case VALUE_FLOAT:
		return compare_float_float (a, b);
	default:
		return TYPE_MISMATCH;
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
735 736
}

737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
/*
 * Utility routine to ensure that all elements of a range are recalced as
 * necessary.
 */
static void
eval_range (FunctionEvalInfo *s, Value *v)
{
	int start_col, start_row, end_col, end_row;
	CellRef * a = &v->v.cell_range.cell_a;
	CellRef * b = &v->v.cell_range.cell_b;
	Sheet * sheet = a->sheet ? a->sheet : s->pos.sheet;
	Cell * cell;
	int r, c;
	int const gen = s->pos.sheet->workbook->generation;

	cell_get_abs_col_row (a,
			      s->pos.eval_col, s->pos.eval_row,
			      &start_col, &start_row);
	cell_get_abs_col_row (b,
			      s->pos.eval_col, s->pos.eval_row,
			      &end_col, &end_row);

	if (a->sheet != b->sheet) {
		g_warning ("3D references not-fully supported.\n"
			   "Recalc may be incorrect");
		return;
	}

	for (r = start_row; r <= end_row; ++r)
		for (c = start_col; c <= end_col; ++c) {
			if ((cell = sheet_cell_get (sheet, c, r)) == NULL)
				continue;
769 770
			if (cell->generation != gen)
				cell_eval (cell);
771 772 773
		}
}

774
static Value *
775
eval_expr_real (FunctionEvalInfo *s, ExprTree const *tree)
Arturo Espinosa's avatar
Arturo Espinosa committed
776
{
777
	Value *res = NULL, *a = NULL, *b = NULL;
778
	
Arturo Espinosa's avatar
Arturo Espinosa committed
779
	g_return_val_if_fail (tree != NULL, NULL);
780
	g_return_val_if_fail (s != NULL, NULL);
781

782 783 784 785 786
	/* FIXME FIXME : We need to rework support for
	 * ranges and builtin operators to support the
	 * implicit intersection rule AND figure out
	 * how to turn it off when evaluating as an array
	 */
787
	switch (tree->oper){
788 789 790 791 792 793
	case OPER_EQUAL:
	case OPER_NOT_EQUAL:
	case OPER_GT:
	case OPER_GTE:
	case OPER_LT:
	case OPER_LTE: {
Arturo Espinosa's avatar
Arturo Espinosa committed
794
		int comp;
795

796
		a = eval_expr_real (s, tree->u.binary.value_a);
797
		if (a != NULL && a->type == VALUE_ERROR)
Morten Welinder's avatar
Morten Welinder committed
798 799
			return a;

800
		b = eval_expr_real (s, tree->u.binary.value_b);
801 802 803
		if (b != NULL && b->type == VALUE_ERROR) {
			if (a != NULL)
				value_release (a);
Morten Welinder's avatar
Morten Welinder committed
804 805
			return b;
		}
806

Arturo Espinosa's avatar
Arturo Espinosa committed
807 808
		comp = compare (a, b);

809 810 811 812
		if (a != NULL)
			value_release (a);
		if (b != NULL)
			value_release (b);
813 814 815 816 817 818 819 820 821 822 823

		if (comp == TYPE_MISMATCH){
			/* TODO TODO TODO : Make error more informative
			 *    regarding what is comparing to what
			 */
			/* For equality comparisons even errors are ok */
			if (tree->oper == OPER_EQUAL)
				return value_new_bool (FALSE);
			if (tree->oper == OPER_NOT_EQUAL)
				return value_new_bool (TRUE);

824
			return value_new_error (&s->pos, gnumeric_err_VALUE);
825
		}
826

Arturo Espinosa's avatar
Arturo Espinosa committed
827
		switch (tree->oper){
828
		case OPER_EQUAL:
829
			res = value_new_bool (comp == IS_EQUAL);
Arturo Espinosa's avatar
Arturo Espinosa committed
830 831
			break;

832
		case OPER_GT:
833
			res = value_new_bool (comp == IS_GREATER);
Arturo Espinosa's avatar
Arturo Espinosa committed
834 835
			break;

836
		case OPER_LT:
837
			res = value_new_bool (comp == IS_LESS);
Arturo Espinosa's avatar
Arturo Espinosa committed
838 839
			break;

840 841
		case OPER_NOT_EQUAL:
			res = value_new_bool (comp != IS_EQUAL);
Arturo Espinosa's avatar
Arturo Espinosa committed
842 843
			break;

844 845
		case OPER_LTE:
			res = value_new_bool (comp != IS_GREATER);
Arturo Espinosa's avatar
Arturo Espinosa committed
846 847
			break;

848 849
		case OPER_GTE:
			res = value_new_bool (comp != IS_LESS);
Arturo Espinosa's avatar
Arturo Espinosa committed
850
			break;
851

Arturo Espinosa's avatar
Arturo Espinosa committed
852
		default:
853
			g_assert_not_reached ();
854 855
			res = value_new_error (&s->pos,
						_("Internal type error"));
Arturo Espinosa's avatar
Arturo Espinosa committed
856
		}
Morten Welinder's avatar
Morten Welinder committed
857
		return res;
Arturo Espinosa's avatar
Arturo Espinosa committed
858
	}
859

860 861 862 863 864
	case OPER_ADD:
	case OPER_SUB:
	case OPER_MULT:
	case OPER_DIV:
	case OPER_EXP:
865 866 867 868 869 870 871 872 873 874 875 876 877 878
	        /* Garantees that a != NULL */
		a = eval_expr (s, tree->u.binary.value_a);

		/*
		 * Priority
		 * 1) Error from A
		 * 2) #!VALUE error if A is not a number
		 * 3) Error from B
		 * 4) #!VALUE error if B is not a number
		 * 5) result of operation, or error specific to the operation
		 */

		/* 1) Error from A */
		if (a->type == VALUE_ERROR)
879
			return a;
880

881 882 883 884 885 886 887 888
		/* 2) #!VALUE error if A is not a number */
		if (!VALUE_IS_NUMBER (a)) {
			value_release (a);
			return value_new_error (&s->pos, gnumeric_err_VALUE);
		}

	        /* Garantees that b != NULL */
		b = eval_expr (s, tree->u.binary.value_b);
Arturo Espinosa's avatar
Arturo Espinosa committed
889

890 891
		/* 3) Error from B */
		if (b->type == VALUE_ERROR) {
892
			value_release (a);
893
			return b;
Arturo Espinosa's avatar
Arturo Espinosa committed
894
		}
895

896 897
		/* 4) #!VALUE error if B is not a number */
		if (!VALUE_IS_NUMBER (b)) {
898 899
			value_release (a);
			value_release (b);
900
			return value_new_error (&s->pos, gnumeric_err_VALUE);
Arturo Espinosa's avatar
Arturo Espinosa committed
901
		}
902

903
		if (a->type != VALUE_FLOAT && b->type != VALUE_FLOAT){
Morten Welinder's avatar
Morten Welinder committed
904
			int ia = value_get_as_int (a);
905
			int ib = value_get_as_int (b);
906 907 908
			double dres;
			int ires;

Morten Welinder's avatar
Morten Welinder committed
909 910
			value_release (a);
			value_release (b);
911

912 913
			/* FIXME: we could use simple (cheap) heuristics to
			   catch most cases where overflow will not happen.  */
914
			switch (tree->oper){
915 916 917 918 919 920 921 922
			case OPER_ADD:
				dres = (double)ia + (double)ib;
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);

923
			case OPER_SUB:
924 925 926 927 928 929
				dres = (double)ia - (double)ib;
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);
930

931
			case OPER_MULT:
932 933 934 935 936 937
				dres = (double)ia * (double)ib;
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);
Arturo Espinosa's avatar
Arturo Espinosa committed
938

939
			case OPER_DIV:
940 941 942 943 944 945 946 947
				if (ib == 0)
					return value_new_error (&s->pos, gnumeric_err_DIV0);
				dres = (double)ia / (double)ib;
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);
948 949

			case OPER_EXP:
950
				if (ia == 0 && ib <= 0)
951 952 953 954 955 956 957 958
					return value_new_error (&s->pos, gnumeric_err_NUM);
				dres = pow ((double)ia, (double)ib);
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);

Arturo Espinosa's avatar
Arturo Espinosa committed
959
			default:
960
				abort ();
Arturo Espinosa's avatar
Arturo Espinosa committed
961 962
			}
		} else {
963 964 965 966
			float_t const va = value_get_as_float(a);
			float_t const vb = value_get_as_float(b);
			value_release (a);
			value_release (b);
967

968
			switch (tree->oper){
969
			case OPER_ADD:
970
				return value_new_float(va + vb);
971

972
			case OPER_SUB:
973
				return value_new_float(va - vb);
974

975
			case OPER_MULT:
976
				return value_new_float(va * vb);
977

978
			case OPER_DIV:
979 980 981 982
				return (vb == 0.0)
				    ? value_new_error (&s->pos,
						       gnumeric_err_DIV0)
				    : value_new_float(va / vb);
983

984
			case OPER_EXP:
985 986
				if (va == 0 && vb <= 0)
					return value_new_error (&s->pos, gnumeric_err_NUM);
987 988
				return value_new_float(pow(va, vb));

Arturo Espinosa's avatar
Arturo Espinosa committed
989
			default:
990
				break;
Arturo Espinosa's avatar
Arturo Espinosa committed
991 992
			}
		}
993 994
		return value_new_error (&s->pos, _("Unknown operator"));

Jody Goldberg's avatar
Jody Goldberg committed
995
	case OPER_PERCENT:
996 997 998 999 1000 1001 1002 1003 1004
	case OPER_NEG:
	        /* Garantees that a != NULL */
		a = eval_expr (s, tree->u.value);
		if (a->type == VALUE_ERROR)
			return a;
		if (!VALUE_IS_NUMBER (a)){
			value_release (a);
			return value_new_error (&s->pos, gnumeric_err_VALUE);
		}
Jody Goldberg's avatar
Jody Goldberg committed
1005 1006 1007 1008 1009 1010 1011 1012 1013
		if (tree->oper == OPER_NEG) {
			if (a->type == VALUE_INTEGER)
				res = value_new_int (-a->v.v_int);
			else if (a->type == VALUE_FLOAT)
				res = value_new_float (-a->v.v_float);
			else
				res = value_new_bool (!a->v.v_float);
		} else
			res = value_new_float (value_get_as_float (a) * .01);
1014
		value_release (a);
Morten Welinder's avatar
Morten Welinder committed
1015
		return res;
1016

1017
	case OPER_CONCAT: {
1018 1019
		char *sa, *sb, *tmp;

1020
		a = eval_expr_real (s, tree->u.binary.value_a);
1021
		if (a != NULL && a->type == VALUE_ERROR)
1022
			return a;
1023
		b = eval_expr_real (s, tree->u.binary.value_b);
1024 1025 1026
		if (b != NULL && b->type == VALUE_ERROR) {
			if (a != NULL)
				value_release (a);
1027
			return b;
1028 1029
		}

Michael Meeks's avatar
Michael Meeks committed
1030 1031
		sa = value_get_as_string (a);
		sb = value_get_as_string (b);
Jeff Garzik's avatar
Jeff Garzik committed
1032
		tmp = g_strconcat (sa, sb, NULL);
Morten Welinder's avatar
Morten Welinder committed
1033 1034
		res = value_new_string (tmp);

1035 1036 1037 1038
		g_free (sa);
		g_free (sb);
		g_free (tmp);

1039
		if (a != NULL)
1040
		value_release (a);
1041
		if (b != NULL)
1042
		value_release (b);
Morten Welinder's avatar
Morten Welinder committed
1043
		return res;
1044
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
1045

1046
	case OPER_FUNCALL:
1047
		return eval_funcall (s, tree);
Arturo Espinosa's avatar
Arturo Espinosa committed
1048

Michael Meeks's avatar
Michael Meeks committed
1049 1050 1051
	case OPER_NAME:
		return eval_expr_name (s, tree->u.name);

1052
	case OPER_VAR: {
1053
		Sheet *cell_sheet;
1054
		CellRef const *ref;
Arturo Espinosa's avatar
Arturo Espinosa committed
1055 1056
		Cell *cell;
		int col, row;
1057

1058
		if (s->pos.sheet == NULL) {
Arturo Espinosa's avatar
Arturo Espinosa committed
1059
			/* Only the test program requests this */
Morten Welinder's avatar
Morten Welinder committed
1060
			return value_new_float (3.14);
Arturo Espinosa's avatar
Arturo Espinosa committed
1061 1062
		}

1063
		ref = &tree->u.ref;
1064
		cell_get_abs_col_row (ref, s->pos.eval_col, s->pos.eval_row, &col, &row);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
1065

1066
		cell_sheet = eval_sheet (ref->sheet, s->pos.sheet);
1067
		cell = sheet_cell_get (cell_sheet, col, row);
1068 1069
		if (cell == NULL)
			return NULL;
1070

1071 1072
		if (cell->generation != s->pos.sheet->workbook->generation)
			cell_eval (cell);
1073

1074
		return value_duplicate (cell->value);
Arturo Espinosa's avatar
Arturo Espinosa committed
1075
	}
1076

1077
	case OPER_CONSTANT:
1078 1079 1080 1081
		res = tree->u.constant;
		if (res->type == VALUE_CELLRANGE)
			eval_range (s, res);
		return value_duplicate (res);
1082

1083 1084 1085 1086 1087 1088
	case OPER_ARRAY:
	{
		/* The upper left corner manages the recalc of the expr */
		int const x = tree->u.array.x;
		int const y = tree->u.array.y;
		if (x == 0 && y == 0){
1089 1090 1091 1092 1093 1094
			/* Release old value if necessary */
			a = tree->u.array.corner.func.value;
			if (a != NULL)
				value_release (a);

			/* Store real result (cast away const)*/
1095
			a = eval_expr_real (s, tree->u.array.corner.func.expr);
1096
			*((Value **)&(tree->u.array.corner.func.value)) = a;
1097
		} else {
1098
			ExprTree const * const array =
1099
			    expr_tree_array_formula_corner (tree, &s->pos);
1100 1101 1102 1103
			if (array)
				a = array->u.array.corner.func.value;
			else
				a = NULL;
1104
		}
1105

1106 1107
		if (a != NULL &&
		    (a->type == VALUE_CELLRANGE || a->type == VALUE_ARRAY)) {
1108 1109
			int const num_x = value_area_get_width (&s->pos, a);
			int const num_y = value_area_get_height (&s->pos, a);
1110

1111 1112
			if (x < num_x && y < num_y){
				/* Evaluate relative to the upper left corner */
1113
				EvalPosition tmp_ep = s->pos;
1114 1115
				tmp_ep.eval_col -= x;
				tmp_ep.eval_row -= y;
1116 1117
				a = (Value *)value_area_get_x_y (
					&tmp_ep, a, x, y);
1118
			} else