expr.c 40.3 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"
14
#include "expr-name.h"
Arturo Espinosa's avatar
Arturo Espinosa committed
15
#include "eval.h"
Miguel de Icaza's avatar
Today:  
Miguel de Icaza committed
16
#include "format.h"
17
#include "func.h"
18
#include "parse-util.h"
19
#include "ranges.h"
20
#include "workbook.h"
21

22 23
inline EvalPosition *
eval_pos_init (EvalPosition *eval_pos, Sheet *sheet, CellPos const *pos)
24
{
25
	g_return_val_if_fail (eval_pos != NULL, NULL);
26
	g_return_val_if_fail (sheet != NULL, NULL);
27 28 29
	g_return_val_if_fail (IS_SHEET (sheet), NULL);

	eval_pos->sheet = sheet;
30
	eval_pos->eval  = *pos;
31

32
	return eval_pos;
33
}
34

35
EvalPosition *
Jody Goldberg's avatar
Jody Goldberg committed
36
eval_pos_cell (EvalPosition *eval_pos, Cell const *cell)
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
{
	CellPos pos;
	g_return_val_if_fail (cell != NULL, NULL);

	pos.col = cell->col_info->pos;
	pos.row = cell->row_info->pos;
	return eval_pos_init (eval_pos, cell->sheet, &pos);
}

EvalPosition *
eval_pos_cellref (EvalPosition *dest, EvalPosition const *src, 
		  CellRef const *ref)
{
	/* FIXME : This is a place to catch all of the strange
	 * usages.  Please figure out what they were trying to do.
	 */
	*dest = *src;
	return dest;
}

57 58 59 60
/*
 * Supply either a sheet (preferred) or a workbook.
 */

61
ParsePosition *
62
parse_pos_init (ParsePosition *pp, Workbook *wb, Sheet *sheet, int col, int row)
63
{
64
	g_return_val_if_fail (wb || sheet, NULL);
65 66
	g_return_val_if_fail (pp != NULL, NULL);

67 68
	pp->sheet = sheet;
	pp->wb = sheet ? sheet->workbook : wb;
69 70 71 72 73 74 75
	pp->col = col;
	pp->row = row;

	return pp;
}

ParsePosition *
Jody Goldberg's avatar
Jody Goldberg committed
76
parse_pos_cell (ParsePosition *pp, Cell const *cell)
77 78 79 80 81 82 83 84 85
{
	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,
86 87
		NULL,
		cell->sheet,
88 89
		cell->col_info->pos,
		cell->row_info->pos);
90 91
}

92 93 94 95 96 97 98 99 100 101 102
ParsePosition *
parse_pos_evalpos (ParsePosition *pp, EvalPosition const *ep)
{
	g_return_val_if_fail (pp != NULL, NULL);
	g_return_val_if_fail (ep != NULL, NULL);

	return parse_pos_init (pp, NULL, ep->sheet, ep->eval.col, ep->eval.row);
}

/***************************************************************************/

103
ExprTree *
Morten Welinder's avatar
Morten Welinder committed
104
expr_tree_new_constant (Value *v)
105
{
106 107 108
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
109 110 111 112
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
113
	*((Operation *)&(ans->oper)) = OPER_CONSTANT;
114 115
	ans->u.constant = v;

Morten Welinder's avatar
Morten Welinder committed
116 117 118 119 120 121 122 123 124
	return ans;
}

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

	ans = g_new (ExprTree, 1);
125 126 127 128
	if (!ans)
		return NULL;

	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
129
	*((Operation *)&(ans->oper)) = op;
130 131
	ans->u.value = e;

Morten Welinder's avatar
Morten Welinder committed
132 133 134 135 136 137 138 139 140 141
	return ans;
}


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

	ans = g_new (ExprTree, 1);
142 143 144 145
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
146
	*((Operation *)&(ans->oper)) = op;
147 148 149
	ans->u.binary.value_a = l;
	ans->u.binary.value_b = r;

Morten Welinder's avatar
Morten Welinder committed
150 151 152 153 154 155 156 157 158 159
	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);
160 161 162 163
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
164
	*((Operation *)&(ans->oper)) = OPER_FUNCALL;
165 166 167
	ans->u.function.symbol = sym;;
	ans->u.function.arg_list = args;

Morten Welinder's avatar
Morten Welinder committed
168 169
	return ans;
}
170
       
171 172 173 174 175 176 177 178 179 180 181
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;
}

182 183 184 185 186 187 188 189 190 191 192
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;
}

193
ExprTree *
194
expr_parse_string (const char *expr, const ParsePosition *pp,
Morten Welinder's avatar
Morten Welinder committed
195
		   char **desired_format, char **error_msg)
196 197 198 199
{
	ExprTree *tree;
	g_return_val_if_fail (expr != NULL, NULL);

200
	switch (gnumeric_expr_parser (expr, pp, TRUE, desired_format, &tree)) {
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
	case PARSE_OK:
		*error_msg = NULL;
		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
220 221 222 223 224 225 226 227 228 229
ExprTree *
expr_tree_new_name (const ExprName *name)
{
	ExprTree *ans;

	ans = g_new (ExprTree, 1);
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
230
	*((Operation *)&(ans->oper)) = OPER_NAME;
Michael Meeks's avatar
Michael Meeks committed
231 232 233 234
	ans->u.name = name;

	return ans;
}
235 236 237 238 239 240 241 242 243 244 245

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

	ans = g_new (ExprTree, 1);
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
246
	*((Operation *)&(ans->oper)) = OPER_CONSTANT;
247 248 249
	ans->u.constant = NULL;
	return ans;
}*/
Morten Welinder's avatar
Morten Welinder committed
250 251 252 253 254 255 256

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

	ans = g_new (ExprTree, 1);
257 258 259 260
	if (!ans)
		return NULL;
	
	ans->ref_count = 1;
Jody Goldberg's avatar
Jody Goldberg committed
261
	*((Operation *)&(ans->oper)) = OPER_VAR;
262 263
	ans->u.ref = *cr;

264 265 266
	return ans;
}

Morten Welinder's avatar
Morten Welinder committed
267 268 269 270
ExprTree *
expr_tree_new_error (const char *txt)
{
	Symbol *func;
Morten Welinder's avatar
Morten Welinder committed
271 272 273 274 275 276 277 278 279
	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
280 281

	symbol_ref (func);
Morten Welinder's avatar
Morten Welinder committed
282
	return expr_tree_new_funcall (func, args);
Morten Welinder's avatar
Morten Welinder committed
283 284
}

285 286 287 288 289 290 291 292 293 294
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;
Jody Goldberg's avatar
Jody Goldberg committed
295
	*((Operation *)&(ans->oper)) = OPER_ARRAY;
296 297 298 299 300 301 302 303 304 305 306 307
	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 *
308
expr_tree_array_formula_corner (ExprTree const *expr, EvalPosition const *pos)
309
{
310
	Cell * corner = expr->u.array.corner.cell;
311

312 313 314 315 316 317
	/* 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,
Jody Goldberg's avatar
Jody Goldberg committed
318 319
					 pos->eval.col - expr->u.array.x,
					 pos->eval.row - expr->u.array.y);
320 321 322 323
		((ExprTree *)expr)->u.array.corner.cell = corner;
	}

	g_return_val_if_fail (corner != NULL, NULL);
324
	g_return_val_if_fail (cell_has_expr (corner), NULL);
325 326

	/* Sanity check incase the corner gets removed for some reason */
327 328 329 330
	g_return_val_if_fail (corner->u.expression != (void *)0xdeadbeef, NULL);
	g_return_val_if_fail (corner->u.expression->oper == OPER_ARRAY, NULL);
	g_return_val_if_fail (corner->u.expression->u.array.x == 0, NULL);
	g_return_val_if_fail (corner->u.expression->u.array.y == 0, NULL);
331

332
	return corner->u.expression;
333 334
}

Arturo Espinosa's avatar
Arturo Espinosa committed
335 336 337 338
/*
 * expr_tree_ref:
 * Increments the ref_count for part of a tree
 */
339 340 341 342 343 344
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
345
	tree->ref_count++;
Arturo Espinosa's avatar
Arturo Espinosa committed
346 347 348 349 350
}

static void
do_expr_tree_unref (ExprTree *tree)
{
Morten Welinder's avatar
Morten Welinder committed
351 352 353
	if (--tree->ref_count > 0)
		return;

Arturo Espinosa's avatar
Arturo Espinosa committed
354
	switch (tree->oper){
355
	case OPER_VAR:
Arturo Espinosa's avatar
Arturo Espinosa committed
356
		break;
357

358
	case OPER_CONSTANT:
Morten Welinder's avatar
Morten Welinder committed
359
		value_release (tree->u.constant);
Arturo Espinosa's avatar
Arturo Espinosa committed
360
		break;
361

Morten Welinder's avatar
Morten Welinder committed
362 363 364 365 366 367 368
	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
369
		break;
Morten Welinder's avatar
Morten Welinder committed
370
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
371

Michael Meeks's avatar
Michael Meeks committed
372 373 374
	case OPER_NAME:
		break;

375
	case OPER_ANY_BINARY:
Arturo Espinosa's avatar
Arturo Espinosa committed
376 377 378 379
		do_expr_tree_unref (tree->u.binary.value_a);
		do_expr_tree_unref (tree->u.binary.value_b);
		break;

380
	case OPER_ANY_UNARY:
Arturo Espinosa's avatar
Arturo Espinosa committed
381 382
		do_expr_tree_unref (tree->u.value);
		break;
383
	case OPER_ARRAY:
384 385 386
		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);
387
			do_expr_tree_unref (tree->u.array.corner.func.expr);
388
		}
389
		break;
390 391 392
	default:
		g_warning ("do_expr_tree_unref error\n");
		break;
Arturo Espinosa's avatar
Arturo Espinosa committed
393
	}
394

Morten Welinder's avatar
Morten Welinder committed
395
	g_free (tree);
396 397
}

Morten Welinder's avatar
Morten Welinder committed
398 399 400 401 402 403
/*
 * 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.)
 */
404 405 406 407 408 409
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
410
	do_expr_tree_unref (tree);
411 412
}

413
static Value *
414
eval_funcall (EvalPosition const * const pos, ExprTree const *tree)
Arturo Espinosa's avatar
Arturo Espinosa committed
415
{
416
	FunctionEvalInfo ei;
417
	const Symbol *sym;
Arturo Espinosa's avatar
Arturo Espinosa committed
418
	FunctionDefinition *fd;
Michael Meeks's avatar
Michael Meeks committed
419
	GList *args;
420

421
	g_return_val_if_fail (pos != NULL, NULL);
Michael Meeks's avatar
Michael Meeks committed
422
	g_return_val_if_fail (tree != NULL, NULL);
423

424
	sym = tree->u.function.symbol;
425 426

	if (sym->type != SYMBOL_FUNCTION)
427
		return value_new_error (pos, _("Internal error"));
428

429
	fd = (FunctionDefinition *)sym->data;
430 431
	ei.func_def = fd;
	ei.pos = pos;
Michael Meeks's avatar
Michael Meeks committed
432
	args = tree->u.function.arg_list;
433

434
	return function_call_with_list (&ei, args);
Arturo Espinosa's avatar
Arturo Espinosa committed
435 436
}

Jody Goldberg's avatar
Jody Goldberg committed
437 438 439 440 441 442 443 444 445 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 477 478 479 480 481 482 483 484 485
/**
 * expr_implicit_intersection :
 * @ei: EvalInfo containing valid fd!
 * @v: a VALUE_CELLRANGE
 * 
 * Attempt to find the intersection between the calling cell and
 * some element of the 1 one unit wide or tall range.
 *
 * Always release the value passed in.
 *
 * Return value: 
 *     If the intersection succeeded return a duplicate of the value
 *     at the intersection point.  This value needs to be freed.
 **/
Value *
expr_implicit_intersection (EvalPosition const * const pos,
			    Value * const v)
{
	/*
	 * Handle the implicit union of a single row or
	 * column with the eval position.
	 * NOTE : We do not need to know if this is expression is
	 * being evaluated as an array or not because we can differentiate
	 * based on the required type for the argument.
	 */
	Value *res = NULL;
	CellRef const * const a = & v->v.cell_range.cell_a;
	CellRef const * const b = & v->v.cell_range.cell_b;

	if (a->sheet == b->sheet) {
		int a_col, a_row, b_col, b_row;
		cell_get_abs_col_row (a, &pos->eval, &a_col, &a_row);
		cell_get_abs_col_row (b, &pos->eval, &b_col, &b_row);
		if (a_row == b_row) {
			int const c = pos->eval.col;
			if (a_col <= c && c <= b_col)
				res = value_duplicate (value_area_get_x_y (pos, v, c - a_col, 0));
		}

		if (a_col == b_col) {
			int const r = pos->eval.row;
			if (a_row <= r && r <= b_row)
				res = value_duplicate (value_area_get_x_y (pos, v, 0, r - a_row));
		}
	}
	value_release (v);
	return res;
}

486
typedef enum {
Arturo Espinosa's avatar
Arturo Espinosa committed
487 488
	IS_EQUAL,
	IS_LESS,
489
	IS_GREATER,
490
	TYPE_MISMATCH
491 492 493
} compare_t;

static compare_t
494
compare_bool_bool (Value const * const va, Value const * const vb)
495
{
496 497 498 499 500 501 502 503 504 505 506 507 508
	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);
509 510 511 512 513 514 515 516 517
	if (a == b)
		return IS_EQUAL;
	else if (a < b)
		return IS_LESS;
	else
		return IS_GREATER;
}

static compare_t
518
compare_float_float (Value const * const va, Value const * const vb)
519
{
520 521
	float_t const a = value_get_as_float (va);
	float_t const b = value_get_as_float (vb);
522 523 524 525 526 527 528
	if (a == b)
		return IS_EQUAL;
	else if (a < b)
		return IS_LESS;
	else
		return IS_GREATER;
}
Arturo Espinosa's avatar
Arturo Espinosa committed
529

530 531
/*
 * Compares two (Value *) and returns one of compare_t
Jody Goldberg's avatar
Jody Goldberg committed
532 533 534
 *
 * if pos is non null it will perform implict intersection for
 * cellranges.
535 536
 */
static compare_t
Jody Goldberg's avatar
Jody Goldberg committed
537
compare (Value const * const a, Value const * const b)
Arturo Espinosa's avatar
Arturo Espinosa committed
538
{
539 540
	ValueType ta, tb;

541 542 543 544
	/* Handle trivial and double NULL case */
	if (a == b)
		return IS_EQUAL;

545 546
	ta = value_is_empty_cell (a) ? VALUE_EMPTY : a->type;
	tb = value_is_empty_cell (b) ? VALUE_EMPTY : b->type;
547

548 549 550 551 552 553
	/* 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;
554

555 556 557
		/* Strings are < FALSE ?? */
		case VALUE_BOOLEAN :
			return IS_LESS;
558

559 560 561 562 563 564 565 566 567 568 569 570
		/* 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 :
571
			return TYPE_MISMATCH;
572
		}
573 574 575 576 577
	} else if (tb == VALUE_STRING) {
		switch (ta) {
		/* (empty, or number) < String */
		case VALUE_EMPTY : case VALUE_INTEGER : case VALUE_FLOAT :
			return IS_LESS;
578

579 580 581
		/* Strings are < FALSE ?? */
		case VALUE_BOOLEAN :
			return IS_GREATER;
582

583
		default :
584
			return TYPE_MISMATCH;
585 586 587
		}
	}

588 589 590 591 592 593
	/* 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;

594 595 596
	switch ((ta > tb) ? ta : tb) {
	case VALUE_EMPTY:	/* Empty Empty compare */
		return IS_EQUAL;
597

598 599
	case VALUE_BOOLEAN:
		return compare_bool_bool (a, b);
600

601 602 603 604 605 606 607 608
	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
609 610
}

611 612 613 614 615
/*
 * Utility routine to ensure that all elements of a range are recalced as
 * necessary.
 */
static void
616
eval_range (EvalPosition const * const pos, Value *v)
617 618 619 620
{
	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;
621
	Sheet * sheet = a->sheet ? a->sheet : pos->sheet;
622 623
	Cell * cell;
	int r, c;
624
	int const gen = pos->sheet->workbook->generation;
625

626 627
	cell_get_abs_col_row (a, &pos->eval, &start_col, &start_row);
	cell_get_abs_col_row (b, &pos->eval, &end_col, &end_row);
628

Michael Meeks's avatar
Michael Meeks committed
629
	if (b->sheet && a->sheet != b->sheet) {
630 631 632 633 634 635 636 637 638
		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;
639 640
			if (cell->generation != gen)
				cell_eval (cell);
641 642 643
		}
}

644
static Value *
645
eval_expr_real (EvalPosition const * const pos, ExprTree const * const tree,
646
		ExprEvalFlags const flags)
Arturo Espinosa's avatar
Arturo Espinosa committed
647
{
648
	Value *res = NULL, *a = NULL, *b = NULL;
649
	
Arturo Espinosa's avatar
Arturo Espinosa committed
650
	g_return_val_if_fail (tree != NULL, NULL);
651
	g_return_val_if_fail (pos != NULL, NULL);
652

653
	switch (tree->oper){
654 655 656 657 658 659
	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
660
		int comp;
661

662
		a = eval_expr_real (pos, tree->u.binary.value_a, flags);
Jody Goldberg's avatar
Jody Goldberg committed
663 664
		if (a != NULL) {
			if (a->type == VALUE_CELLRANGE) {
665
				a = expr_implicit_intersection (pos, a);
Jody Goldberg's avatar
Jody Goldberg committed
666
				if (a == NULL)
667
					return value_new_error (pos, gnumeric_err_VALUE);
Jody Goldberg's avatar
Jody Goldberg committed
668 669 670
			} else if (a->type == VALUE_ERROR)
				return a;
		}
Morten Welinder's avatar
Morten Welinder committed
671

672
		b = eval_expr_real (pos, tree->u.binary.value_b, flags);
Jody Goldberg's avatar
Jody Goldberg committed
673 674 675
		if (b != NULL) {
			Value *res = NULL;
			if (b->type == VALUE_CELLRANGE) {
676
				b = expr_implicit_intersection (pos, b);
Jody Goldberg's avatar
Jody Goldberg committed
677
				if (b == NULL)
678
					res = value_new_error (pos, gnumeric_err_VALUE);
Jody Goldberg's avatar
Jody Goldberg committed
679 680 681 682 683 684 685 686
			} else if (b->type == VALUE_ERROR)
				res = b;

			if (res != NULL) {
				if (a != NULL)
					value_release (a);
				return res;
			}
Morten Welinder's avatar
Morten Welinder committed
687
		}
688

Arturo Espinosa's avatar
Arturo Espinosa committed
689 690
		comp = compare (a, b);

691 692 693 694
		if (a != NULL)
			value_release (a);
		if (b != NULL)
			value_release (b);
695

Michael Meeks's avatar
Michael Meeks committed
696
		if (comp == TYPE_MISMATCH) {
697 698 699 700 701 702 703 704 705
			/* 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);

706
			return value_new_error (pos, gnumeric_err_VALUE);
707
		}
708

Michael Meeks's avatar
Michael Meeks committed
709
		switch (tree->oper) {
710
		case OPER_EQUAL:
711
			res = value_new_bool (comp == IS_EQUAL);
Arturo Espinosa's avatar
Arturo Espinosa committed
712 713
			break;

714
		case OPER_GT:
715
			res = value_new_bool (comp == IS_GREATER);
Arturo Espinosa's avatar
Arturo Espinosa committed
716 717
			break;

718
		case OPER_LT:
719
			res = value_new_bool (comp == IS_LESS);
Arturo Espinosa's avatar
Arturo Espinosa committed
720 721
			break;

722 723
		case OPER_NOT_EQUAL:
			res = value_new_bool (comp != IS_EQUAL);
Arturo Espinosa's avatar
Arturo Espinosa committed
724 725
			break;

726 727
		case OPER_LTE:
			res = value_new_bool (comp != IS_GREATER);
Arturo Espinosa's avatar
Arturo Espinosa committed
728 729
			break;

730 731
		case OPER_GTE:
			res = value_new_bool (comp != IS_LESS);
Arturo Espinosa's avatar
Arturo Espinosa committed
732
			break;
733

Arturo Espinosa's avatar
Arturo Espinosa committed
734
		default:
735
			g_assert_not_reached ();
736
			res = value_new_error (pos,
737
						_("Internal type error"));
Arturo Espinosa's avatar
Arturo Espinosa committed
738
		}
Morten Welinder's avatar
Morten Welinder committed
739
		return res;
Arturo Espinosa's avatar
Arturo Espinosa committed
740
	}
741

742 743 744 745 746
	case OPER_ADD:
	case OPER_SUB:
	case OPER_MULT:
	case OPER_DIV:
	case OPER_EXP:
747 748 749 750 751 752 753 754 755
		/*
		 * 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
		 */

756 757 758
	        /* Ensure a != NULL */
		a = eval_expr (pos, tree->u.binary.value_a,
			       flags & (~EVAL_PERMIT_EMPTY));
Jody Goldberg's avatar
Jody Goldberg committed
759 760 761

		/* Handle implicit intersection */
		if (a->type == VALUE_CELLRANGE) {
762
			a = expr_implicit_intersection (pos, a);
Jody Goldberg's avatar
Jody Goldberg committed
763
			if (a == NULL)
764
				return value_new_error (pos, gnumeric_err_VALUE);
Jody Goldberg's avatar
Jody Goldberg committed
765 766
		}

767 768
		/* 1) Error from A */
		if (a->type == VALUE_ERROR)
769
			return a;
770

771 772 773
		/* 2) #!VALUE error if A is not a number */
		if (!VALUE_IS_NUMBER (a)) {
			value_release (a);
774
			return value_new_error (pos, gnumeric_err_VALUE);
775 776 777
		}

	        /* Garantees that b != NULL */
778 779
		b = eval_expr (pos, tree->u.binary.value_b,
			       flags & (~EVAL_PERMIT_EMPTY));
Arturo Espinosa's avatar
Arturo Espinosa committed
780

Jody Goldberg's avatar
Jody Goldberg committed
781 782
		/* Handle implicit intersection */
		if (b->type == VALUE_CELLRANGE) {
783
			b = expr_implicit_intersection (pos, a);
Jody Goldberg's avatar
Jody Goldberg committed
784
			if (b == NULL)
785
				return value_new_error (pos, gnumeric_err_VALUE);
Jody Goldberg's avatar
Jody Goldberg committed
786 787
		}

788 789
		/* 3) Error from B */
		if (b->type == VALUE_ERROR) {
790
			value_release (a);
791
			return b;
Arturo Espinosa's avatar
Arturo Espinosa committed
792
		}
793

794 795
		/* 4) #!VALUE error if B is not a number */
		if (!VALUE_IS_NUMBER (b)) {
796 797
			value_release (a);
			value_release (b);
798
			return value_new_error (pos, gnumeric_err_VALUE);
Arturo Espinosa's avatar
Arturo Espinosa committed
799
		}
800

801
		if (a->type != VALUE_FLOAT && b->type != VALUE_FLOAT){
Morten Welinder's avatar
Morten Welinder committed
802
			int ia = value_get_as_int (a);
803
			int ib = value_get_as_int (b);
804 805 806
			double dres;
			int ires;

Morten Welinder's avatar
Morten Welinder committed
807 808
			value_release (a);
			value_release (b);
809

810 811
			/* FIXME: we could use simple (cheap) heuristics to
			   catch most cases where overflow will not happen.  */
812
			switch (tree->oper){
813 814 815 816 817 818 819 820
			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);

821
			case OPER_SUB:
822 823 824 825 826 827
				dres = (double)ia - (double)ib;
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);
828

829
			case OPER_MULT:
830 831 832 833 834 835
				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
836

837
			case OPER_DIV:
838
				if (ib == 0)
839
					return value_new_error (pos, gnumeric_err_DIV0);
840 841 842 843 844 845
				dres = (double)ia / (double)ib;
				ires = (int)dres;
				if (dres == ires)
					return value_new_int (ires);
				else
					return value_new_float ((float_t) dres);
846 847

			case OPER_EXP:
848
				if (ia == 0 && ib <= 0)
849
					return value_new_error (pos, gnumeric_err_NUM);
850 851 852 853 854 855 856
				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
857
			default:
858
				abort ();
Arturo Espinosa's avatar
Arturo Espinosa committed
859 860
			}
		} else {
Arturo Espinosa's avatar
Arturo Espinosa committed
861 862
			float_t const va = value_get_as_float (a);
			float_t const vb = value_get_as_float (b);
863 864
			value_release (a);
			value_release (b);
865

866
			switch (tree->oper){
867
			case OPER_ADD:
Arturo Espinosa's avatar
Arturo Espinosa committed
868
				return value_new_float (va + vb);
869

870
			case OPER_SUB:
Arturo Espinosa's avatar
Arturo Espinosa committed
871
				return value_new_float (va - vb);
872

873
			case OPER_MULT:
Arturo Espinosa's avatar
Arturo Espinosa committed
874
				return value_new_float (va * vb);
875

876
			case OPER_DIV:
877
				return (vb == 0.0)
878
				    ? value_new_error (pos,
879
						       gnumeric_err_DIV0)
Arturo Espinosa's avatar
Arturo Espinosa committed
880
				    : value_new_float (va / vb);
881

882
			case OPER_EXP:
883 884
				if ((va == 0 && vb <= 0) ||
				    (va < 0 && vb != (int)vb))
885
					return value_new_error (pos, gnumeric_err_NUM);
Arturo Espinosa's avatar
Arturo Espinosa committed
886
				return value_new_float (pow (va, vb));
887

Arturo Espinosa's avatar
Arturo Espinosa committed
888
			default:
889
				break;
Arturo Espinosa's avatar
Arturo Espinosa committed
890 891
			}
		}
892
		return value_new_error (pos, _("Unknown operator"));
893

Jody Goldberg's avatar
Jody Goldberg committed
894
	case OPER_PERCENT:
Jody Goldberg's avatar
Jody Goldberg committed
895 896
	case OPER_UNARY_NEG:
	case OPER_UNARY_PLUS:
897
	        /* Garantees that a != NULL */
898
		a = eval_expr (pos, tree->u.value, flags & (~EVAL_PERMIT_EMPTY));
Jody Goldberg's avatar
Jody Goldberg committed
899 900 901

		/* Handle implicit intersection */
		if (a->type == VALUE_CELLRANGE) {
902
			a = expr_implicit_intersection (pos, a);
Jody Goldberg's avatar
Jody Goldberg committed
903
			if (a == NULL)
904
				return value_new_error (pos, gnumeric_err_VALUE);
Jody Goldberg's avatar
Jody Goldberg committed
905 906
		}

907 908
		if (a->type == VALUE_ERROR)
			return a;
Jody Goldberg's avatar
Jody Goldberg committed
909

Jody Goldberg's avatar
Jody Goldberg committed
910 911 912
		if (tree->oper == OPER_UNARY_PLUS)
			return a;

913 914
		if (!VALUE_IS_NUMBER (a)){
			value_release (a);
915
			return value_new_error (pos, gnumeric_err_VALUE);
916
		}
Jody Goldberg's avatar
Jody Goldberg committed
917
		if (tree->oper == OPER_UNARY_NEG) {
Jody Goldberg's avatar
Jody Goldberg committed
918 919 920 921 922 923 924 925
			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);
926
		value_release (a);
Morten Welinder's avatar
Morten Welinder committed
927
		return res;
928

929
	case OPER_CONCAT: {
930 931
		char *sa, *sb, *tmp;

932
		a = eval_expr_real (pos, tree->u.binary.value_a, flags);
933
		if (a != NULL && a->type == VALUE_ERROR)
934
			return a;
935
		b = eval_expr_real (pos, tree->u.binary.value_b, flags);
936 937 938
		if (b != NULL && b->type == VALUE_ERROR) {
			if (a != NULL)
				value_release (a);
939
			return b;
940 941
		}

Michael Meeks's avatar
Michael Meeks committed
942 943
		sa = value_get_as_string (a);
		sb = value_get_as_string (b);
Jeff Garzik's avatar
Jeff Garzik committed
944
		tmp = g_strconcat (sa, sb, NULL);
Morten Welinder's avatar
Morten Welinder committed
945 946
		res = value_new_string (tmp);

947 948 949 950
		g_free (sa);
		g_free (sb);
		g_free (tmp);

951
		if (a != NULL)
952
		value_release (a);
953
		if (b != NULL)
954
		value_release (b);
Morten Welinder's avatar
Morten Welinder committed
955
		return res;
956
	}
Arturo Espinosa's avatar
Arturo Espinosa committed
957

958
	case OPER_FUNCALL:
959
		return eval_funcall (pos, tree);
Arturo Espinosa's avatar
Arturo Espinosa committed
960

Michael Meeks's avatar
Michael Meeks committed
961
	case OPER_NAME:
962
		return eval_expr_name (pos, tree->u.name, flags);
Michael Meeks's avatar
Michael Meeks committed
963

964
	case OPER_VAR: {
965
		Sheet *cell_sheet;
966
		CellRef const *ref;
Arturo Espinosa's avatar
Arturo Espinosa committed
967 968
		Cell *cell;
		int col, row;
969

970
		if (pos->sheet == NULL) {
Arturo Espinosa's avatar
Arturo Espinosa committed
971
			/* Only the test program requests this */
Morten Welinder's avatar
Morten Welinder committed
972
			return value_new_float (3.14);
Arturo Espinosa's avatar
Arturo Espinosa committed
973 974
		}

975
		ref = &tree->u.ref;
976
		cell_get_abs_col_row (ref, &pos->eval, &col, &row);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
977

978
		cell_sheet = eval_sheet (ref->sheet, pos->sheet);
979
		cell = sheet_cell_get (cell_sheet, col, row);
980 981
		if (cell == NULL)
			return NULL;
982

983
		if (cell->generation != pos->sheet->workbook->generation)
984
			cell_eval (cell);
985

986
		return value_duplicate (cell->value);
Arturo Espinosa's avatar
Arturo Espinosa committed
987
	}
988

989
	case OPER_CONSTANT:
990
		res = tree->u.constant;
991 992
		if (res->type != VALUE_CELLRANGE)
			return value_duplicate (res);
993
		if (flags & EVAL_PERMIT_NON_SCALAR) {
994
			eval_range (pos, res);
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
			return value_duplicate (res);
		} else {
			/*
			 * Handle the implicit union of a single row or
			 * column with the eval position.
			 * NOTE : We do not need to know if this is expression is
			 * being evaluated as an array or not because we can differentiate
			 * based on the required type for the argument.
			 */
			CellRef const * const a = & res->v.cell_range.cell_a;
			CellRef const * const b = & res->v.cell_range.cell_b;
			gboolean found = FALSE;

			if (a->sheet == b->sheet) {
				int a_col, a_row, b_col, b_row;
				int c = pos->eval.col;
				int r = pos->eval.row;

				cell_get_abs_col_row (a, &pos->eval, &a_col, &a_row);
				cell_get_abs_col_row (b, &pos->eval, &b_col, &b_row);
				if (a_row == b_row) {
					if (a_col <= c && c <= b_col) {
						r = a_row;
						found = TRUE;
					}
				} else if (a_col == b_col) {
					if (a_row <= r && r <= b_row) {
						c = a_col;
						found = TRUE;
					}
				}
				if (found) {
					Cell * cell = sheet_cell_get (pos->sheet, c, r);
					if (cell == NULL)
						return NULL;

					if (cell->generation != pos->sheet->workbook->generation)
						cell_eval (cell);

					return value_duplicate (cell->value);
				}
			}
			return value_new_error (pos, gnumeric_err_VALUE);
		}
1039

1040 1041 1042
	case OPER_ARRAY:
	{
		/* The upper left corner manages the recalc of the expr */
1043 1044
		int x = tree->u.array.x;
		int y = tree->u.array.y;
1045
		if (x == 0 && y == 0){
1046 1047 1048 1049 1050 1051
			/* Release old value if necessary */
			a = tree->u.array.corner.func.value;
			if (a != NULL)
				value_release (a);

			/* Store real result (cast away const)*/
Jody Goldberg's avatar
Jody Goldberg committed
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
			/* FIXME : Call a wrapper routine that will iterate over the
			 * the array and evaluate the expression for all elements
			 *
			 * Figure out when to iterate and when to do array operations.
			 * ie
			 * A1:A3 = '=B1:B3^2'  Will iterate over all the elements and
			 *     re-evaluate.
			 * whereas
			 * A1:A3 = '=bob(B1:B3)'  Will call bob once if it returns an
			 *     array.
			 *
			 * This may be as simple as evaluating the corner.  If that is
			 * is an array return the result, else build an array and
			 * iterate over the elements, but that theory needs validation.
			 */
Jody Goldberg's avatar
Jody Goldberg committed
1067 1068
			a = eval_expr_real (pos, tree->u.array.corner.func.expr,
					    EVAL_PERMIT_NON_SCALAR);
1069
			*((Value **)&(tree->u.array.corner.func.value)) = a;
1070
		} else {
1071
			ExprTree const * const array =
1072
			    expr_tree_array_formula_corner (tree, pos);
1073 1074 1075 1076
			if (array)
				a = array->u.array.corner.func.value;
			else
				a = NULL;
1077
		}
1078

1079 1080
		if (a != NULL &&
		    (a->type == VALUE_CELLRANGE || a->type == VALUE_ARRAY)) {
1081 1082
			int const num_x = value_area_get_width (pos, a);
			int const num_y = value_area_get_height (pos, a);
1083

1084
			/* Evaluate relative to the upper left corner */