diff --git a/ctools.api.php b/ctools.api.php
index 8bf4697..19dc37b 100644
--- a/ctools.api.php
+++ b/ctools.api.php
@@ -152,15 +152,40 @@ function hook_ctools_api_hook_alter(&$list) {
/**
* Alter the available functions to be used in ctools math expression api.
*
- * One usecase would be to create your own function in your module and
+ * One use case would be to create your own function in your module and
* allow to use it in the math expression api.
*
* @param $functions
* An array which has the functions as value.
+ * @param $context
+ * An array containing an item 'final' whose value is a reference to the
+ * definitions for multiple-arg functions. Use this to add in functions that
+ * require more than one arg.
*/
-function hook_ctools_math_expression_functions_alter(&$functions) {
- // Allow to convert from degrees to radiant.
+function hook_ctools_math_expression_functions_alter(&$functions, $context) {
+ // Allow to convert from degrees to radians.
$functions[] = 'deg2rad';
+
+ $multiarg = $context['final'];
+ $multiarg['pow'] = array(
+ 'function' => 'pow',
+ 'arguments' => 2,
+ );
+}
+
+/**
+ * Alter the available functions to be used in ctools math expression api.
+ *
+ * One usecase would be to create your own function in your module and
+ * allow to use it in the math expression api.
+ *
+ * @param array $constants
+ * An array of name:value pairs, one for each named constant. Values added
+ * to this array become read-only variables with the value assigned here.
+ */
+function hook_ctools_math_expression_constants_alter(&$constants) {
+ // Add the speed of light as constant 'c':
+ $constants['c'] = 299792458;
}
/**
diff --git a/includes/math-expr.inc b/includes/math-expr.inc
index 3105ec5..acbdfe9 100644
--- a/includes/math-expr.inc
+++ b/includes/math-expr.inc
@@ -1,391 +1,955 @@
-
-================================================================================
-
-NAME
- ctools_math_expr - safely evaluate math expressions
-
-SYNOPSIS
- include('ctools_math_expr.class.php');
- $m = new ctools_math_expr;
- // basic evaluation:
- $result = $m->evaluate('2+2');
- // supports: order of operation; parentheses; negation; built-in functions
- $result = $m->evaluate('-8(5/2)^2*(1-sqrt(4))-8');
- // create your own variables
- $m->evaluate('a = e^(ln(pi))');
- // or functions
- $m->evaluate('f(x,y) = x^2 + y^2 - 2x*y + 1');
- // and then use them
- $result = $m->evaluate('3*f(42,a)');
-
-DESCRIPTION
- Use the ctools_math_expr class when you want to evaluate mathematical expressions
- from untrusted sources. You can define your own variables and functions,
- which are stored in the object. Try it, it's fun!
-
-METHODS
- $m->evalute($expr)
- Evaluates the expression and returns the result. If an error occurs,
- prints a warning and returns false. If $expr is a function assignment,
- returns true on success.
-
- $m->e($expr)
- A synonym for $m->evaluate().
-
- $m->vars()
- Returns an associative array of all user-defined variables and values.
-
- $m->funcs()
- Returns an array of all user-defined functions.
-
-PARAMETERS
- $m->suppress_errors
- Set to true to turn off warnings when evaluating expressions
-
- $m->last_error
- If the last evaluation failed, contains a string describing the error.
- (Useful when suppress_errors is on).
-
-AUTHOR INFORMATION
- Copyright 2005, Miles Kaufmann.
-
-LICENSE
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are
- met:
-
- 1 Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
- 3. The name of the author may not be used to endorse or promote
- products derived from this software without specific prior written
- permission.
-
- THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
- IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
- INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- POSSIBILITY OF SUCH DAMAGE.
-
-*/
-
+/**
+ * @file
+ * =============================================================================.
+ *
+ * ctools_math_expr - PHP Class to safely evaluate math expressions
+ * Copyright (C) 2005 Miles Kaufmann
+ *
+ * =============================================================================
+ *
+ * NAME
+ * ctools_math_expr - safely evaluate math expressions
+ *
+ * SYNOPSIS
+ * $m = new ctools_math_expr();
+ * // basic evaluation:
+ * $result = $m->evaluate('2+2');
+ * // supports: order of operation; parentheses; negation; built-in
+ * // functions.
+ * $result = $m->evaluate('-8(5/2)^2*(1-sqrt(4))-8');
+ * // create your own variables
+ * $m->evaluate('a = e^(ln(pi))');
+ * // or functions
+ * $m->evaluate('f(x,y) = x^2 + y^2 - 2x*y + 1');
+ * // and then use them
+ * $result = $m->evaluate('3*f(42,a)');
+ *
+ * DESCRIPTION
+ * Use the ctools_math_expr class when you want to evaluate mathematical
+ * expressions from untrusted sources. You can define your own variables
+ * and functions, which are stored in the object. Try it, it's fun!
+ *
+ * METHODS
+ * $m->evalute($expr)
+ * Evaluates the expression and returns the result. If an error occurs,
+ * prints a warning and returns false. If $expr is a function
+ * assignment, returns true on success.
+ *
+ * $m->e($expr)
+ * A synonym for $m->evaluate().
+ *
+ * $m->vars()
+ * Returns an associative array of all user-defined variables and
+ * values.
+ *
+ * $m->funcs()
+ * Returns an array of all user-defined functions.
+ *
+ * PARAMETERS
+ * $m->suppress_errors
+ * Set to true to turn off warnings when evaluating expressions
+ *
+ * $m->last_error
+ * If the last evaluation failed, contains a string describing the
+ * error.
+ * (Useful when suppress_errors is on).
+ *
+ * AUTHOR INFORMATION
+ * Copyright 2005, Miles Kaufmann.
+ *
+ * LICENSE
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1 Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * ctools_math_expr Class.
+ */
class ctools_math_expr {
- var $suppress_errors = false;
- var $last_error = null;
-
- var $v = array('e'=>2.71,'pi'=>3.14); // variables (and constants)
- var $f = array(); // user-defined functions
- var $vb = array('e', 'pi'); // constants
- var $fb = array( // built-in functions
- 'sin','sinh','arcsin','asin','arcsinh','asinh',
- 'cos','cosh','arccos','acos','arccosh','acosh',
- 'tan','tanh','arctan','atan','arctanh','atanh',
- 'pow', 'exp',
- 'sqrt','abs','ln','log',
- 'time', 'ceil', 'floor', 'min', 'max', 'round');
-
- /**
- * ctools_math_expr constructor.
- */
- function __construct() {
- // make the variables a little more accurate
- $this->v['pi'] = pi();
- $this->v['e'] = exp(1);
- drupal_alter('ctools_math_expression_functions', $this->fb);
+
+ /**
+ * If TRUE do not call trigger_error on error other wise do.
+ *
+ * @var bool
+ */
+ public $suppress_errors = FALSE;
+
+ /**
+ * The last error message reported.
+ *
+ * @var string
+ */
+ public $last_error = NULL;
+
+ /**
+ * List of all errors reported.
+ *
+ * @var array
+ */
+ public $errors = array();
+
+ /**
+ * Variable and constant values.
+ *
+ * @var array
+ */
+ protected $vars;
+
+ /**
+ * User defined functions.
+ *
+ * @var array
+ */
+ protected $userfuncs;
+
+ /**
+ * The names of constants, used to make constants read-only.
+ *
+ * @var array
+ */
+ protected $constvars;
+
+ /**
+ * Built in simple (one arg) functions.
+ * Merged into $this->funcs in constructor.
+ *
+ * @var array
+ */
+ protected $simplefuncs;
+
+ /**
+ * Definitions of all built-in functions.
+ *
+ * @var array
+ */
+ protected $funcs;
+
+ /**
+ * Operators and their precedence.
+ *
+ * @var array
+ */
+ protected $ops;
+
+ /**
+ * The set of operators using two arguments.
+ *
+ * @var array
+ */
+ protected $binaryops;
+
+ /**
+ * Public constructor.
+ */
+ public function __construct() {
+ $this->userfuncs = array();
+ $this->simplefuncs = array(
+ 'sin',
+ 'sinh',
+ 'asin',
+ 'asinh',
+ 'cos',
+ 'cosh',
+ 'acos',
+ 'acosh',
+ 'tan',
+ 'tanh',
+ 'atan',
+ 'atanh',
+ 'exp',
+ 'sqrt',
+ 'abs',
+ 'log',
+ 'time',
+ 'ceil',
+ 'floor',
+ 'round',
+ );
+
+ $this->ops = array(
+ '+' => array('precedence' => 0),
+ '-' => array('precedence' => 0),
+ '*' => array('precedence' => 1),
+ '/' => array('precedence' => 1),
+ '^' => array('precedence' => 2, 'right' => TRUE),
+ '_' => array('precedence' => 1),
+ '==' => array('precedence' => -1),
+ '!=' => array('precedence' => -1),
+ '>=' => array('precedence' => -1),
+ '<=' => array('precedence' => -1),
+ '>' => array('precedence' => -1),
+ '<' => array('precedence' => -1),
+ );
+
+ $this->binaryops = array(
+ '+', '-', '*', '/', '^', '==', '!=', '<', '<=', '>=', '>',
+ );
+
+ $this->funcs = array(
+ 'ln' => array(
+ 'function' => 'log',
+ 'arguments' => 1,
+ ),
+ 'arcsin' => array(
+ 'function' => 'asin',
+ 'arguments' => 1,
+ ),
+ 'arcsinh' => array(
+ 'function' => 'asinh',
+ 'arguments' => 1,
+ ),
+ 'arccos' => array(
+ 'function' => 'acos',
+ 'arguments' => 1,
+ ),
+ 'arccosh' => array(
+ 'function' => 'acosh',
+ 'arguments' => 1,
+ ),
+ 'arctan' => array(
+ 'function' => 'atan',
+ 'arguments' => 1,
+ ),
+ 'arctanh' => array(
+ 'function' => 'atanh',
+ 'arguments' => 1,
+ ),
+ 'min' => array(
+ 'function' => 'min',
+ 'arguments' => 2,
+ 'max arguments' => 99,
+ ),
+ 'max' => array(
+ 'function' => 'max',
+ 'arguments' => 2,
+ 'max arguments' => 99,
+ ),
+ 'pow' => array(
+ 'function' => 'pow',
+ 'arguments' => 2,
+ ),
+ 'if' => array(
+ 'function' => 'ctools_math_expr_if',
+ 'arguments' => 2,
+ 'max arguments' => 3,
+ ),
+ 'number' => array(
+ 'function' => 'ctools_math_expr_number',
+ 'arguments' => 1,
+ ),
+ );
+
+ // Allow modules to add custom functions.
+ $context = array('final' => &$this->funcs);
+ drupal_alter('ctools_math_expression_functions', $this->simplefuncs, $context);
+
+ // Set up the initial constants and mark them read-only.
+ $this->vars = array('e' => exp(1), 'pi' => pi());
+ drupal_alter('ctools_math_expression_constants', $this->vars);
+ $this->constvars = array_keys($this->vars);
+
+ // Translate the older, simpler style into the newer, richer style.
+ foreach ($this->simplefuncs as $function) {
+ $this->funcs[$function] = array(
+ 'function' => $function,
+ 'arguments' => 1,
+ );
}
+ }
+
+ /**
+ * Change the suppress errors flag.
+ *
+ * When errors are not suppressed, trigger_error is used to cause a PHP error
+ * when an evaluation error occurs, as a result of calling trigger(). With
+ * errors suppressed this doesn't happen.
+ *
+ * @param bool $enable
+ * If FALSE, enable triggering of php errors when expression errors occurs.
+ * otherwise, suppress triggering the errors.
+ *
+ * @return bool
+ * The new (current) state of the flag.
+ *
+ * @see ctools_math_expr::trigger()
+ */
+ public function set_suppress_errors($enable) {
+ return $this->suppress_errors = (bool) $enable;
+ }
+
+ /**
+ * Backwards compatible wrapper for evaluate().
+ *
+ * @see ctools_math_expr::evaluate()
+ */
+ public function e($expr) {
+ return $this->evaluate($expr);
+ }
+
+ /**
+ * Evaluate the expression.
+ *
+ * @param string $expr
+ * The expression to evaluate.
+ *
+ * @return string|bool
+ * The result of the expression, or FALSE if an error occurred, or TRUE if
+ * an user-defined function was created.
+ */
+ public function evaluate($expr) {
+ $this->last_error = NULL;
+ $expr = trim($expr);
+
+ // Strip possible semicolons at the end.
+ if (substr($expr, -1, 1) == ';') {
+ $expr = substr($expr, 0, -1);
+ }
+
+ // Is it a variable assignment?
+ if (preg_match('/^\s*([a-z]\w*)\s*=\s*(.+)$/', $expr, $matches)) {
+
+ // Make sure we're not assigning to a constant.
+ if (in_array($matches[1], $this->constvars)) {
+ return $this->trigger("cannot assign to constant '$matches[1]'");
+ }
+
+ // Get the result and make sure it's good:
+ if (($tmp = $this->pfx($this->nfx($matches[2]))) === FALSE) {
+ return FALSE;
+ }
+ // If so, stick it in the variable array...
+ $this->vars[$matches[1]] = $tmp;
+ // ...and return the resulting value:
+ return $this->vars[$matches[1]];
- function e($expr) {
- return $this->evaluate($expr);
}
+ // Is it a function assignment?
+ elseif (preg_match('/^\s*([a-z]\w*)\s*\(\s*([a-z]\w*(?:\s*,\s*[a-z]\w*)*)\s*\)\s*=\s*(.+)$/', $expr, $matches)) {
+ // Get the function name.
+ $fnn = $matches[1];
+ // Make sure it isn't built in:
+ if (isset($this->funcs[$matches[1]])) {
+ return $this->trigger("cannot redefine built-in function '$matches[1]()'");
+ }
+
+ // Get the arguments.
+ $args = explode(",", preg_replace("/\s+/", "", $matches[2]));
+ // See if it can be converted to postfix.
+ $stack = $this->nfx($matches[3]);
+ if ($stack === FALSE) {
+ return FALSE;
+ }
+
+ // Freeze the state of the non-argument variables.
+ for ($i = 0; $i < count($stack); $i++) {
+ $token = $stack[$i];
+ if (preg_match('/^[a-z]\w*$/', $token) and !in_array($token, $args)) {
+ if (array_key_exists($token, $this->vars)) {
+ $stack[$i] = $this->vars[$token];
+ }
+ else {
+ return $this->trigger("undefined variable '$token' in function definition");
+ }
+ }
+ }
+ $this->userfuncs[$fnn] = array('args' => $args, 'func' => $stack);
- function evaluate($expr) {
- $this->last_error = null;
- $expr = trim($expr);
- if (substr($expr, -1, 1) == ';') $expr = substr($expr, 0, strlen($expr)-1); // strip semicolons at the end
- //===============
- // is it a variable assignment?
- if (preg_match('/^\s*([a-z]\w*)\s*=\s*(.+)$/', $expr, $matches)) {
- if (in_array($matches[1], $this->vb)) { // make sure we're not assigning to a constant
- return $this->trigger("cannot assign to constant '$matches[1]'");
- }
- if (($tmp = $this->pfx($this->nfx($matches[2]))) === false) return false; // get the result and make sure it's good
- $this->v[$matches[1]] = $tmp; // if so, stick it in the variable array
- return $this->v[$matches[1]]; // and return the resulting value
- //===============
- // is it a function assignment?
- } elseif (preg_match('/^\s*([a-z]\w*)\s*\(\s*([a-z]\w*(?:\s*,\s*[a-z]\w*)*)\s*\)\s*=\s*(.+)$/', $expr, $matches)) {
- $fnn = $matches[1]; // get the function name
- if (in_array($matches[1], $this->fb)) { // make sure it isn't built in
- return $this->trigger("cannot redefine built-in function '$matches[1]()'");
+ return TRUE;
+ }
+ else {
+ // Straight up evaluation.
+ return trim($this->pfx($this->nfx($expr)), '"');
+ }
+ }
+
+ /**
+ * Fetch an array of variables used in the expression.
+ *
+ * @return array
+ * Array of name : value pairs, one for each variable defined.
+ */
+ public function vars() {
+ $output = $this->vars;
+
+ // TODO: Is this supposed to remove all constants? we should remove all
+ // those in $this->constvars!
+ unset($output['pi']);
+ unset($output['e']);
+
+ return $output;
+ }
+
+ /**
+ * Fetch all user defined functions in the expression.
+ *
+ * @return array
+ * Array of name : string pairs, one for each function defined. The string
+ * will be of the form fname(arg1,arg2). The function body is not returned.
+ */
+ public function funcs() {
+ $output = array();
+ foreach ($this->userfuncs as $fnn => $dat) {
+ $output[] = $fnn . '(' . implode(',', $dat['args']) . ')';
+ }
+
+ return $output;
+ }
+
+ /**
+ * Convert infix to postfix notation.
+ *
+ * @param string $expr
+ * The expression to convert.
+ *
+ * @return array|bool
+ * The expression as an ordered list of postfix action tokens.
+ */
+ private function nfx($expr) {
+
+ $index = 0;
+ $stack = new ctools_math_expr_stack();
+ // Postfix form of expression, to be passed to pfx().
+ $output = array();
+
+ // TODO: Because the expr can contain string operands, using strtolower here is a bug.
+ $expr = trim(strtolower($expr));
+
+ // We use this in syntax-checking the expression and determining when
+ // '-' is a negation.
+ $expecting_op = FALSE;
+
+ while (TRUE) {
+ $op = substr($expr, $index, 1);
+ // Get the first character at the current index, and if the second
+ // character is an =, add it to our op as well (accounts for <=).
+ if (substr($expr, $index + 1, 1) === '=') {
+ $op = substr($expr, $index, 2);
+ $index++;
+ }
+
+ // Find out if we're currently at the beginning of a number/variable/
+ // function/parenthesis/operand.
+ $ex = preg_match('/^([a-z]\w*\(?|\d+(?:\.\d*)?|\.\d+|\()/', substr($expr, $index), $match);
+
+ // Is it a negation instead of a minus?
+ if ($op === '-' and !$expecting_op) {
+ // Put a negation on the stack.
+ $stack->push('_');
+ $index++;
+ }
+ // We have to explicitly deny this, because it's legal on the stack but
+ // not in the input expression.
+ elseif ($op == '_') {
+ return $this->trigger("illegal character '_'");
+
+ }
+ // Are we putting an operator on the stack?
+ elseif ((isset($this->ops[$op]) || $ex) && $expecting_op) {
+ // Are we expecting an operator but have a num, var, func, or
+ // open-paren?
+ if ($ex) {
+ $op = '*';
+ // It's an implicit multiplication.
+ $index--;
+ }
+ // Heart of the algorithm:
+ while ($stack->count() > 0 &&
+ ($o2 = $stack->last()) &&
+ isset($this->ops[$o2]) &&
+ (!empty($this->ops[$op]['right']) ?
+ $this->ops[$op]['precedence'] < $this->ops[$o2]['precedence'] :
+ $this->ops[$op]['precedence'] <= $this->ops[$o2]['precedence'])) {
+
+ // Pop stuff off the stack into the output.
+ $output[] = $stack->pop();
+ }
+ // Many thanks: http://en.wikipedia.org/wiki/Reverse_Polish_notation#The_algorithm_in_detail
+ // finally put OUR operator onto the stack.
+ $stack->push($op);
+ $index++;
+ $expecting_op = FALSE;
+
+ }
+ // Ready to close a parenthesis?
+ elseif ($op === ')' and $expecting_op) {
+
+ // Pop off the stack back to the last '('.
+ while (($o2 = $stack->pop()) !== '(') {
+ if (is_null($o2)) {
+ return $this->trigger("unexpected ')'");
+ }
+ else {
+ $output[] = $o2;
+ }
+ }
+
+ // Did we just close a function?
+ if (preg_match("/^([a-z]\w*)\($/", $stack->last(2), $matches)) {
+
+ // Get the function name.
+ $fnn = $matches[1];
+ // See how many arguments there were (cleverly stored on the stack,
+ // thank you).
+ $arg_count = $stack->pop();
+ // Pop the function and push onto the output.
+ $output[] = $stack->pop();
+
+ // Check the argument count:
+ if (isset($this->funcs[$fnn])) {
+ $fdef = $this->funcs[$fnn];
+ $max_arguments = isset($fdef['max arguments']) ? $fdef['max arguments'] : $fdef['arguments'];
+ if ($arg_count > $max_arguments) {
+ return $this->trigger("too many arguments ($arg_count given, $max_arguments expected)");
}
- $args = explode(",", preg_replace("/\s+/", "", $matches[2])); // get the arguments
- if (($stack = $this->nfx($matches[3])) === false) return false; // see if it can be converted to postfix
- for ($i = 0; $iv)) {
- $stack[$i] = $this->v[$token];
- } else {
- return $this->trigger("undefined variable '$token' in function definition");
- }
- }
+ }
+ elseif (array_key_exists($fnn, $this->userfuncs)) {
+ $fdef = $this->userfuncs[$fnn];
+ if ($arg_count !== count($fdef['args'])) {
+ return $this->trigger("wrong number of arguments ($arg_count given, " . count($fdef['args']) . ' expected)');
}
- $this->f[$fnn] = array('args'=>$args, 'func'=>$stack);
- return true;
- //===============
- } else {
- return $this->pfx($this->nfx($expr)); // straight up evaluation, woo
+ }
+ else {
+ // Did we somehow push a non-function on the stack? this should
+ // never happen.
+ return $this->trigger('internal error');
+ }
+ }
+ $index++;
+
+ }
+ // Did we just finish a function argument?
+ elseif ($op === ',' && $expecting_op) {
+
+ // Pop the argument expression stuff and push onto the output:
+ while (($o2 = $stack->pop()) !== '(') {
+ // Oops, never had a '('.
+ if (is_null($o2)) {
+ return $this->trigger("unexpected ',' in $expr $o2");
+ }
+ else {
+ $output[] = $o2;
+ }
+ }
+
+ // Make sure there was a function.
+ if (!preg_match("/^([a-z]\w*)\($/", $stack->last(2), $matches)) {
+ return $this->trigger("unexpected ','");
+ }
+
+ // Increment the argument count.
+ $stack->push($stack->pop() + 1);
+ // Put the ( back on, we'll need to pop back to it again.
+ $stack->push('(');
+ $index++;
+ $expecting_op = FALSE;
+
+ }
+ elseif ($op === '(' && !$expecting_op) {
+ $stack->push('(');
+ $index++;
+
+ }
+ elseif ($ex && !$expecting_op) {
+ // Do we now have a function/variable/number?
+ $expecting_op = TRUE;
+ $val = $match[1];
+ if (preg_match("/^([a-z]\w*)\($/", $val, $matches)) {
+ // May be func, or variable w/ implicit multiplication against
+ // parentheses...
+ if (isset($this->funcs[$matches[1]]) or array_key_exists($matches[1], $this->userfuncs)) {
+ $stack->push($val);
+ $stack->push(1);
+ $stack->push('(');
+ $expecting_op = FALSE;
+ }
+ // it's a var w/ implicit multiplication.
+ else {
+ $val = $matches[1];
+ $output[] = $val;
+ }
+ }
+ // it's a plain old var or num.
+ else {
+ $output[] = $val;
+ }
+ $index += strlen($val);
+
+ }
+ elseif ($op === ')') {
+ // Miscellaneous error checking.
+ return $this->trigger("unexpected ')'");
+ }
+ elseif (isset($this->ops[$op]) and !$expecting_op) {
+ return $this->trigger("unexpected operator '$op'");
+ }
+ elseif ($op === '"') {
+ // Fetch a quoted string.
+ $string = substr($expr, $index);
+ if (preg_match('/"[^"\\\\]*(?:\\\\.[^"\\\\]*)*"/s', $string, $matches)) {
+ $string = $matches[0];
+ // Trim the quotes off:
+ $output[] = $string;
+ $index += strlen($string);
+ $expecting_op = TRUE;
+ }
+ else {
+ return $this->trigger('open quote without close quote.');
+ }
+ }
+ else {
+ // I don't even want to know what you did to get here.
+ return $this->trigger("an unexpected error occurred at $op");
+ }
+ if ($index === strlen($expr)) {
+ if (isset($this->ops[$op])) {
+ // Did we end with an operator? bad.
+ return $this->trigger("operator '$op' lacks operand");
+ }
+ else {
+ break;
}
+ }
+
+ // Step the index past whitespace (pretty much turns whitespace into
+ // implicit multiplication if no operator is there).
+ while (substr($expr, $index, 1) === ' ') {
+ $index++;
+ }
}
- function vars() {
- $output = $this->v;
- unset($output['pi']);
- unset($output['e']);
- return $output;
+ // Pop everything off the stack and push onto output:
+ while (!is_null($op = $stack->pop())) {
+
+ // If there are (s on the stack, ()s were unbalanced.
+ if ($op === '(') {
+ return $this->trigger("expecting ')'");
+ }
+ $output[] = $op;
}
- function funcs() {
- $output = array();
- foreach ($this->f as $fnn=>$dat)
- $output[] = $fnn . '(' . implode(',', $dat['args']) . ')';
- return $output;
+ return $output;
+ }
+
+ /**
+ * Evaluate a prefix-operator stack expression.
+ *
+ * @param array $tokens
+ * The array of token values to evaluate. A token is a string value
+ * representing either an operation to perform, a variable, or a value.
+ * Literal values are checked using is_numeric(), or a value that starts
+ * with a double-quote; functions and variables by existence in the
+ * appropriate tables.
+ * If FALSE is passed in the function terminates immediately, returning
+ * FALSE.
+ * @param array $vars
+ * Additional variable values to use when evaluating the expression. These
+ * variables do not override internal variables with the same name.
+ *
+ * @return bool|mixed
+ * The expression's value, otherwise FALSE is returned if there is an error
+ * detected unless php error handling intervenes: see suppress_error.
+ */
+ public function pfx(array $tokens, array $vars = array()) {
+
+ if ($tokens == FALSE) {
+ return FALSE;
}
- //===================== HERE BE INTERNAL METHODS ====================\\
+ $stack = new ctools_math_expr_stack();
- // Convert infix to postfix notation
- function nfx($expr) {
+ foreach ($tokens as $token) {
+ // If the token is a binary operator, pop two values off the stack, do
+ // the operation, and push the result back on again.
+ if (in_array($token, $this->binaryops)) {
+ if (is_null($op2 = $stack->pop())) {
+ return $this->trigger('internal error');
+ }
+ if (is_null($op1 = $stack->pop())) {
+ return $this->trigger('internal error');
+ }
+ switch ($token) {
+ case '+':
+ $stack->push($op1 + $op2);
+ break;
+
+ case '-':
+ $stack->push($op1 - $op2);
+ break;
+
+ case '*':
+ $stack->push($op1 * $op2);
+ break;
+
+ case '/':
+ if ($op2 == 0) {
+ return $this->trigger('division by zero');
+ }
+ $stack->push($op1 / $op2);
+ break;
- $index = 0;
- $stack = new ctools_math_expr_stack;
- $output = array(); // postfix form of expression, to be passed to pfx()
- $expr = trim(strtolower($expr));
+ case '^':
+ $stack->push(pow($op1, $op2));
+ break;
- $ops = array('+', '-', '*', '/', '^', '_');
- $ops_r = array('+'=>0,'-'=>0,'*'=>0,'/'=>0,'^'=>1); // right-associative operator?
- $ops_p = array('+'=>0,'-'=>0,'*'=>1,'/'=>1,'_'=>1,'^'=>2); // operator precedence
+ case '==':
+ $stack->push((int) ($op1 == $op2));
+ break;
- $expecting_op = false; // we use this in syntax-checking the expression
- // and determining when a - is a negation
+ case '!=':
+ $stack->push((int) ($op1 != $op2));
+ break;
- if (preg_match("/[^\w\s+*^\/()\.,-]/", $expr, $matches)) { // make sure the characters are all good
- return $this->trigger("illegal character '{$matches[0]}'");
- }
+ case '<=':
+ $stack->push((int) ($op1 <= $op2));
+ break;
- while(1) { // 1 Infinite Loop ;)
- $op = substr($expr, $index, 1); // get the first character at the current index
- // find out if we're currently at the beginning of a number/variable/function/parenthesis/operand
- $ex = preg_match('/^([a-z]\w*\(?|\d+(?:\.\d*)?|\.\d+|\()/', substr($expr, $index), $match);
- //===============
- if ($op == '-' and !$expecting_op) { // is it a negation instead of a minus?
- $stack->push('_'); // put a negation on the stack
- $index++;
- } elseif ($op == '_') { // we have to explicitly deny this, because it's legal on the stack
- return $this->trigger("illegal character '_'"); // but not in the input expression
- //===============
- } elseif ((in_array($op, $ops) or $ex) and $expecting_op) { // are we putting an operator on the stack?
- if ($ex) { // are we expecting an operator but have a number/variable/function/opening parethesis?
- $op = '*'; $index--; // it's an implicit multiplication
- }
- // heart of the algorithm:
- while($stack->count > 0 and ($o2 = $stack->last()) and in_array($o2, $ops) and ($ops_r[$op] ? $ops_p[$op] < $ops_p[$o2] : $ops_p[$op] <= $ops_p[$o2])) {
- $output[] = $stack->pop(); // pop stuff off the stack into the output
- }
- // many thanks: http://en.wikipedia.org/wiki/Reverse_Polish_notation#The_algorithm_in_detail
- $stack->push($op); // finally put OUR operator onto the stack
- $index++;
- $expecting_op = false;
- //===============
- } elseif ($op == ')' and $expecting_op) { // ready to close a parenthesis?
- while (($o2 = $stack->pop()) != '(') { // pop off the stack back to the last (
- if (is_null($o2)) return $this->trigger("unexpected ')'");
- else $output[] = $o2;
- }
- if (preg_match("/^([a-z]\w*)\($/", $stack->last(2), $matches)) { // did we just close a function?
- $fnn = $matches[1]; // get the function name
- $arg_count = $stack->pop(); // see how many arguments there were (cleverly stored on the stack, thank you)
- $output[] = $stack->pop(); // pop the function and push onto the output
- if (in_array($fnn, $this->fb)) { // check the argument count
- if($arg_count > 1)
- return $this->trigger("too many arguments ($arg_count given, 1 expected)");
- } elseif (array_key_exists($fnn, $this->f)) {
- if ($arg_count != count($this->f[$fnn]['args']))
- return $this->trigger("wrong number of arguments ($arg_count given, " . count($this->f[$fnn]['args']) . " expected)");
- } else { // did we somehow push a non-function on the stack? this should never happen
- return $this->trigger("internal error");
- }
- }
- $index++;
- //===============
- } elseif ($op == ',' and $expecting_op) { // did we just finish a function argument?
- while (($o2 = $stack->pop()) != '(') {
- if (is_null($o2)) return $this->trigger("unexpected ','"); // oops, never had a (
- else $output[] = $o2; // pop the argument expression stuff and push onto the output
- }
- // make sure there was a function
- if (!preg_match("/^([a-z]\w*)\($/", $stack->last(2), $matches))
- return $this->trigger("unexpected ','");
- $stack->push($stack->pop()+1); // increment the argument count
- $stack->push('('); // put the ( back on, we'll need to pop back to it again
- $index++;
- $expecting_op = false;
- //===============
- } elseif ($op == '(' and !$expecting_op) {
- $stack->push('('); // that was easy
- $index++;
- $allow_neg = true;
- //===============
- } elseif ($ex and !$expecting_op) { // do we now have a function/variable/number?
- $expecting_op = true;
- $val = $match[1];
- if (preg_match("/^([a-z]\w*)\($/", $val, $matches)) { // may be func, or variable w/ implicit multiplication against parentheses...
- if (in_array($matches[1], $this->fb) or array_key_exists($matches[1], $this->f)) { // it's a func
- $stack->push($val);
- $stack->push(1);
- $stack->push('(');
- $expecting_op = false;
- } else { // it's a var w/ implicit multiplication
- $val = $matches[1];
- $output[] = $val;
- }
- } else { // it's a plain old var or num
- $output[] = $val;
- }
- $index += strlen($val);
- //===============
- } elseif ($op == ')') { // miscellaneous error checking
- return $this->trigger("unexpected ')'");
- } elseif (in_array($op, $ops) and !$expecting_op) {
- return $this->trigger("unexpected operator '$op'");
- } else { // I don't even want to know what you did to get here
- return $this->trigger("an unexpected error occurred");
- }
- if ($index == strlen($expr)) {
- if (in_array($op, $ops)) { // did we end with an operator? bad.
- return $this->trigger("operator '$op' lacks operand");
- } else {
- break;
- }
- }
- while (substr($expr, $index, 1) == ' ') { // step the index past whitespace (pretty much turns whitespace
- $index++; // into implicit multiplication if no operator is there)
- }
+ case '<':
+ $stack->push((int) ($op1 < $op2));
+ break;
+
+ case '>=':
+ $stack->push((int) ($op1 >= $op2));
+ break;
+ case '>':
+ $stack->push((int) ($op1 > $op2));
+ break;
}
- while (!is_null($op = $stack->pop())) { // pop everything off the stack and push onto output
- if ($op == '(') return $this->trigger("expecting ')'"); // if there are (s on the stack, ()s were unbalanced
- $output[] = $op;
+ }
+ // If the token is a unary operator, pop one value off the stack, do the
+ // operation, and push it back on again.
+ elseif ($token === "_") {
+ $stack->push(-1 * $stack->pop());
+ }
+ // If the token is a function, pop arguments off the stack, hand them to
+ // the function, and push the result back on again.
+ elseif (preg_match("/^([a-z]\w*)\($/", $token, $matches)) {
+ $fnn = $matches[1];
+
+ // Check for a built-in function.
+ if (isset($this->funcs[$fnn])) {
+ $args = array();
+ // Collect all required args from the stack.
+ for ($i = 0; $i < $this->funcs[$fnn]['arguments']; $i++) {
+ if (is_null($op1 = $stack->pop())) {
+ return $this->trigger("function $fnn missing argument $i");
+ }
+ $args[] = $op1;
+ }
+ // If func allows additional args, collect them too, stopping on a
+ // NULL arg.
+ if (!empty($this->funcs[$fnn]['max arguments'])) {
+ for (; $i < $this->funcs[$fnn]['max arguments']; $i++) {
+ $arg = $stack->pop();
+ if (!isset($arg)) {
+ break;
+ }
+ $args[] = $arg;
+ }
+ }
+ $stack->push(
+ call_user_func_array($this->funcs[$fnn]['function'], array_reverse($args))
+ );
}
- return $output;
- }
- // evaluate postfix notation
- function pfx($tokens, $vars = array()) {
-
- if ($tokens == false) return false;
-
- $stack = new ctools_math_expr_stack;
-
- foreach ($tokens as $token) { // nice and easy
- // if the token is a binary operator, pop two values off the stack, do the operation, and push the result back on
- if (in_array($token, array('+', '-', '*', '/', '^'))) {
- if (is_null($op2 = $stack->pop())) return $this->trigger("internal error");
- if (is_null($op1 = $stack->pop())) return $this->trigger("internal error");
- switch ($token) {
- case '+':
- $stack->push($op1+$op2); break;
- case '-':
- $stack->push($op1-$op2); break;
- case '*':
- $stack->push($op1*$op2); break;
- case '/':
- if ($op2 == 0) return $this->trigger("division by zero");
- $stack->push($op1/$op2); break;
- case '^':
- $stack->push(pow($op1, $op2)); break;
- }
- // if the token is a unary operator, pop one value off the stack, do the operation, and push it back on
- } elseif ($token == "_") {
- $stack->push(-1*$stack->pop());
- // if the token is a function, pop arguments off the stack, hand them to the function, and push the result back on
- } elseif (preg_match("/^([a-z]\w*)\($/", $token, $matches)) { // it's a function!
- $fnn = $matches[1];
- if (in_array($fnn, $this->fb)) { // built-in function:
- if (is_null($op1 = $stack->pop())) return $this->trigger("internal error");
- $fnn = preg_replace("/^arc/", "a", $fnn); // for the 'arc' trig synonyms
- if ($fnn == 'ln') $fnn = 'log';
- eval('$stack->push(' . $fnn . '($op1));'); // perfectly safe eval()
- } elseif (array_key_exists($fnn, $this->f)) { // user function
- // get args
- $args = array();
- for ($i = count($this->f[$fnn]['args'])-1; $i >= 0; $i--) {
- if (is_null($args[$this->f[$fnn]['args'][$i]] = $stack->pop())) return $this->trigger("internal error");
- }
- $stack->push($this->pfx($this->f[$fnn]['func'], $args)); // yay... recursion!!!!
- }
- // if the token is a number or variable, push it on the stack
- } else {
- if (is_numeric($token)) {
- $stack->push($token);
- } elseif (array_key_exists($token, $this->v)) {
- $stack->push($this->v[$token]);
- } elseif (array_key_exists($token, $vars)) {
- $stack->push($vars[$token]);
- } else {
- return $this->trigger("undefined variable '$token'");
- }
+ // Check for a user function.
+ elseif (isset($fnn, $this->userfuncs)) {
+ $args = array();
+ for ($i = count($this->userfuncs[$fnn]['args']) - 1; $i >= 0; $i--) {
+ $value = $stack->pop();
+ $args[$this->userfuncs[$fnn]['args'][$i]] = $value;
+ if (is_null($value)) {
+ return $this->trigger('internal error');
}
+ }
+ // yay... recursion!!!!
+ $stack->push($this->pfx($this->userfuncs[$fnn]['func'], $args));
}
- // when we're out of tokens, the stack should have a single element, the final result
- if ($stack->count != 1) return $this->trigger("internal error");
- return $stack->pop();
+ }
+ // If the token is a number or variable, push it on the stack.
+ else {
+ if (is_numeric($token) || $token[0] == '"') {
+ $stack->push($token);
+ }
+ elseif (array_key_exists($token, $this->vars)) {
+ $stack->push($this->vars[$token]);
+ }
+ elseif (array_key_exists($token, $vars)) {
+ $stack->push($vars[$token]);
+ }
+ else {
+ return $this->trigger("undefined variable '$token'");
+ }
+ }
+ }
+ // When we're out of tokens, the stack should have a single element, the
+ // final result:
+ if ($stack->count() !== 1) {
+ return $this->trigger('internal error');
}
- // trigger an error, but nicely, if need be
- function trigger($msg) {
- $this->last_error = $msg;
- if (!$this->suppress_errors) trigger_error($msg, E_USER_WARNING);
- return false;
+ return $stack->pop();
+ }
+
+ /**
+ * Trigger an error, but nicely, if need be.
+ *
+ * @param string $msg
+ * Message to add to trigger error.
+ *
+ * @return bool
+ * Can trigger error, then returns FALSE.
+ */
+ protected function trigger($msg) {
+ $this->errors[] = $msg;
+ $this->last_error = $msg;
+ if (!$this->suppress_errors) {
+ trigger_error($msg, E_USER_WARNING);
}
+
+ return FALSE;
+ }
+
}
-// for internal use
+/**
+ * Class implementing a simple stack structure, used by ctools_math_expr.
+ */
class ctools_math_expr_stack {
- var $stack = array();
- var $count = 0;
-
- function push($val) {
- $this->stack[$this->count] = $val;
- $this->count++;
+ /**
+ * The stack.
+ * @var array
+ */
+ private $stack;
+ /**
+ * The stack pointer, points at the first empty space.
+ * @var int
+ */
+ private $count;
+
+ /**
+ * Ctools_math_expr_stack constructor.
+ */
+ public function __construct() {
+ $this->stack = array();
+ $this->count = 0;
+ }
+
+ /**
+ * Push the value onto the stack.
+ *
+ * @param mixed $val
+ */
+ public function push($val) {
+ $this->stack[$this->count] = $val;
+ $this->count++;
+ }
+
+ /**
+ * Remove the most recently pushed value and return it.
+ *
+ * @return mixed|null
+ * The most recently pushed value, or NULL if the stack was empty.
+ */
+ public function pop() {
+ if ($this->count > 0) {
+ $this->count--;
+
+ return $this->stack[$this->count];
}
+ return NULL;
+ }
+
+ /**
+ * "Peek" the stack, or Return a value from the stack without removing it.
+ *
+ * @param int $n
+ * Integer indicating which value to return. 1 is the topmost (i.e. the
+ * value that pop() would return), 2 indicates the next, 3 the third, etc.
+ *
+ * @return mixed|null
+ * A value pushed onto the stack at the nth position, or NULL if the stack
+ * was empty.
+ */
+ public function last($n = 1) {
+ return !empty($this->stack[$this->count - $n]) ? $this->stack[$this->count - $n] : NULL;
+ }
+
+ /**
+ * Return the number of items on the stack.
+ *
+ * @return int
+ * The number of items.
+ */
+ public function count() {
+ return $this->count;
+ }
- function pop() {
- if ($this->count > 0) {
- $this->count--;
- return $this->stack[$this->count];
- }
- return null;
- }
+}
- function last($n=1) {
- return !empty($this->stack[$this->count-$n]) ? $this->stack[$this->count-$n] : NULL;
- }
+/**
+ * Helper function for evaluating 'if' condition.
+ *
+ * @param int $expr
+ * The expression to test: if <> 0 then the $if expression is returned.
+ * @param mixed $if
+ * The expression returned if the condition is true.
+ * @param mixed $else
+ * Optional. The expression returned if the expression is false.
+ *
+ * @return mixed|null
+ * The result. NULL is returned when an If condition is False and no Else
+ * expression is provided.
+ */
+function ctools_math_expr_if($expr, $if, $else = NULL) {
+ return $expr ? $if : $else;
}
+/**
+ * Remove any non-digits so that numbers like $4,511.23 still work.
+ *
+ * It might be good for those using the 12,345.67 format, but is awful for
+ * those using other conventions.
+ * Use of the php 'intl' module might work here, if the correct locale can be
+ * derived, but that seems unlikely to be true in all cases.
+ *
+ * @todo: locale could break this since in some locales that's $4.512,33 so
+ * there needs to be a way to detect that and make it work properly.
+ *
+ * @param mixed $arg
+ * A number string with possible leading chars.
+ *
+ * @return mixed
+ * Returns a number string.
+ */
+function ctools_math_expr_number($arg) {
+ // TODO: A really bad idea: It might be good for those using the 12,345.67
+ // format, but is awful for those using other conventions.
+ // $arg = preg_replace("/[^0-9\.]/", '', $arg);.
+ return $arg;
+}
diff --git a/tests/math_expression.test b/tests/math_expression.test
index f89d395..0190afe 100644
--- a/tests/math_expression.test
+++ b/tests/math_expression.test
@@ -27,121 +27,295 @@ class CtoolsMathExpressionTestCase extends DrupalWebTestCase {
}
/**
- * Returns a random double between 0 and 1.
+ * Return the sign of the numeric arg $n as an integer -1, 0, 1.
+ *
+ * Note: Not defined when $n is Infinity or NaN (or NULL or ...)!
+ *
+ * @param int|float $n
+ * The number to test.
+ * @return integer
+ * -1 if the $n is negative, 0 if $n is zero or 1 if $n is positive.
+ *
+ * @see gmp_sign()
+ */
+ protected static function sign($n) {
+ return ($n > 0) - ($n < 0);
+ }
+
+ /**
+ * Returns a random number between 0 and 1.
+ *
+ * @return float
+ * A random number between 0 and 1 inclusive.
*/
protected function rand01() {
- return rand(0, PHP_INT_MAX) / PHP_INT_MAX;
+ return mt_rand(0, PHP_INT_MAX) / PHP_INT_MAX;
}
/**
* A custom assertion with checks the values in a certain range.
+ *
+ * @param float $first
+ * A value to check for equality.
+ * @param float $second
+ * A value to check for equality.
+ * @param string $message
+ * The message describing the correct behaviour, eg. "2/4 equals 1/2". The
+ * default message is used if this value is empty.
+ * @param float $delta
+ * The precision with which values must match. This accounts for rounding
+ * errors and imprecise representation errors in the floating point format.
+ * The value passed in should ideally be proportional to the values being
+ * compared.
+ * @param string $group
+ * Which group this assert belongs to.
+ *
+ * @return bool
+ * TRUE if the assertion was correct (that is, $first == $second within the
+ * given limits), FALSE otherwise.
*/
- protected function assertFloat($first, $second, $delta = 0.0000001, $message = '', $group = 'Other') {
- return $this->assert(abs($first - $second) <= $delta, $message ? $message : t('Value @first is equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
+ protected function assertFloat($first, $second, $message = '', $delta = 0.00000001, $group = 'Other') {
+ // Check for NaN and Inf because the abs() and sign() code won't like those.
+ $equal = FALSE
+ // Equal if both an infinity.
+ || (is_infinite($first) && is_infinite($second))
+
+ // Equal if both NaN.
+ || (is_nan($first) && is_nan($second))
+
+ // Equal if same absolute value (within limits) and same sign.
+ || ((abs($first - $second) <= $delta) && (self::sign($first) === self::sign($second)));
+
+ if (empty($message)) {
+ $default = t('Value !first is equal to value !second.',
+ array(
+ '!first' => var_export($first, TRUE),
+ '!second' => var_export($second, TRUE)
+ ));
+ $message = $default;
+ }
+
+ return $this->assert($equal, $message, $group);
}
/**
* Test some arithmetic handling.
*/
public function testArithmetic() {
- $math_expression = new ctools_math_expr();
-
- // Test constant expressions.
- $this->assertEqual($math_expression->e('2'), 2);
- $random_number = rand(0, 10);
- $this->assertEqual($random_number, $math_expression->e((string) $random_number));
-
- // Test simple arithmetic.
- $random_number_a = rand(5, 10);
- $random_number_b = rand(5, 10);
- $this->assertEqual($random_number_a + $random_number_b, $math_expression->e("$random_number_a + $random_number_b"));
- $this->assertEqual($random_number_a - $random_number_b, $math_expression->e("$random_number_a - $random_number_b"));
- $this->assertEqual($random_number_a * $random_number_b, $math_expression->e("$random_number_a * $random_number_b"));
- $this->assertEqual($random_number_a / $random_number_b, $math_expression->e("$random_number_a / $random_number_b"));
-
- // Test Associative property.
- $random_number_c = rand(5, 10);
- $this->assertEqual($math_expression->e("$random_number_a + ($random_number_b + $random_number_c)"), $math_expression->e("($random_number_a + $random_number_b) + $random_number_c"));
- $this->assertEqual($math_expression->e("$random_number_a * ($random_number_b * $random_number_c)"), $math_expression->e("($random_number_a * $random_number_b) * $random_number_c"));
-
- // Test Commutative property.
- $this->assertEqual($math_expression->e("$random_number_a + $random_number_b"), $math_expression->e("$random_number_b + $random_number_a"));
- $this->assertEqual($math_expression->e("$random_number_a * $random_number_b"), $math_expression->e("$random_number_b * $random_number_a"));
-
- // Test Distributive property.
- $this->assertEqual($math_expression->e("($random_number_a + $random_number_b) * $random_number_c"), $math_expression->e("($random_number_a * $random_number_c + $random_number_b * $random_number_c)"));
-
- $this->assertEqual(pow($random_number_a, $random_number_b), $math_expression->e("$random_number_a ^ $random_number_b"));
+ $math_expr = new ctools_math_expr();
+
+ $this->assertEqual($math_expr->evaluate('2'), 2, 'Check Literal 2');
+
+ $this->assertEqual($math_expr->e('2+1'), $math_expr->evaluate('2+1'), 'Check that e() and evaluate() are equivalent.');
+
+ foreach (range(1, 4) as $n) {
+ // Test constant expressions.
+ $random_number = mt_rand(0, 20);
+ $this->assertEqual($random_number, $math_expr->evaluate((string) $random_number), "Literal $random_number");
+
+ // Test simple arithmetic.
+ $number_a = mt_rand(-55, 777);
+ $number_b = mt_rand(-555, 77);
+ $this->assertEqual(
+ $number_a + $number_b,
+ $math_expr->evaluate("$number_a + $number_b"),
+ "Addition: $number_a + $number_b");
+ $this->assertEqual(
+ $number_a - $number_b,
+ $math_expr->evaluate("$number_a - $number_b"),
+ "Subtraction: $number_a + $number_b");
+ $this->assertFloat(
+ ($number_a * $number_b),
+ $math_expr->evaluate("$number_a * $number_b"),
+ "Multiplication: $number_a * $number_b = " . ($number_a * $number_b));
+ $this->assertFloat(
+ ($number_a / $number_b),
+ $math_expr->evaluate("$number_a / $number_b"),
+ "Division: $number_a / $number_b = " . ($number_a / $number_b));
+
+ // Test Associative property.
+ $number_c = mt_rand(-99, 77);
+ $this->assertEqual(
+ $math_expr->evaluate("$number_a + ($number_b + $number_c)"),
+ $math_expr->evaluate("($number_a + $number_b) + $number_c"),
+ "Associative: $number_a + ($number_b + $number_c)");
+ $this->assertEqual(
+ $math_expr->evaluate("$number_a * ($number_b * $number_c)"),
+ $math_expr->evaluate("($number_a * $number_b) * $number_c"),
+ "Associative: $number_a * ($number_b * $number_c)");
+
+ // Test Commutative property.
+ $this->assertEqual(
+ $math_expr->evaluate("$number_a + $number_b"),
+ $math_expr->evaluate("$number_b + $number_a"),
+ "Commutative: $number_a + $number_b");
+ $this->assertEqual(
+ $math_expr->evaluate("$number_a * $number_b"),
+ $math_expr->evaluate("$number_b * $number_a"),
+ "Commutative: $number_a * $number_b");
+
+ // Test Distributive property.
+ $this->assertEqual(
+ $math_expr->evaluate("($number_a + $number_b) * $number_c"),
+ $math_expr->evaluate("($number_a * $number_c + $number_b * $number_c)"),
+ "Distributive: ($number_a + $number_b) * $number_c");
+
+ $random_number = mt_rand(0, 15);
+ $random_power = mt_rand(-15, 15);
+
+ $this->assertFloat(
+ pow($random_number, $random_power),
+ $math_expr->evaluate("$random_number ^ $random_power"),
+ "$random_number ^ $random_power");
+
+ $this->assertFloat(
+ pow($random_number, $random_power),
+ $math_expr->evaluate("pow($random_number, $random_power)"),
+ "pow($random_number, $random_power)");
+ }
}
/**
- * Test the basic built-in functions in the math expression library.
+ * Test various built-in transcendental and extended functions.
*/
public function testBuildInFunctions() {
- $math_expression = new ctools_math_expr();
-
- // @todo Maybe run this code multiple times to test different values.
- $random_double = $this->rand01();
- $random_int = rand(5, 10);
- $this->assertFloat(sin($random_double), $math_expression->e("sin($random_double)"));
- $this->assertFloat(cos($random_double), $math_expression->e("cos($random_double)"));
- $this->assertFloat(tan($random_double), $math_expression->e("tan($random_double)"));
- $this->assertFloat(exp($random_double), $math_expression->e("exp($random_double)"));
- $this->assertFloat(sqrt($random_double), $math_expression->e("sqrt($random_double)"));
- $this->assertFloat(log($random_double), $math_expression->e("ln($random_double)"));
- $this->assertFloat(round($random_double), $math_expression->e("round($random_double)"));
- $this->assertFloat(abs($random_double + $random_int), $math_expression->e('abs(' . ($random_double + $random_int) . ')'));
- $this->assertEqual(round($random_double + $random_int), $math_expression->e('round(' . ($random_double + $random_int) . ')'));
- $this->assertEqual(ceil($random_double + $random_int), $math_expression->e('ceil(' . ($random_double + $random_int) . ')'));
- $this->assertEqual(floor($random_double + $random_int), $math_expression->e('floor(' . ($random_double + $random_int) . ')'));
-
- // @fixme: you can't run time without an argument.
- $this->assertFloat(time(), $math_expression->e('time(1)'));
+ $math_expr = new ctools_math_expr();
+
+ foreach (range(1, 4) as $n) {
+ $random_double = $this->rand01();
+ $random_int = mt_rand(-65535, 65535);
+ $this->assertFloat(sin($random_double), $math_expr->evaluate("sin($random_double)"), "sin($random_double)");
+ $this->assertFloat(cos($random_double), $math_expr->evaluate("cos($random_double)"), "cos($random_double)");
+ $this->assertFloat(tan($random_double), $math_expr->evaluate("tan($random_double)"), "tan($random_double)");
+ $this->assertFloat(exp($random_double), $math_expr->evaluate("exp($random_double)"), "exp($random_double)");
+ $this->assertFloat(sqrt($random_double), $math_expr->evaluate("sqrt($random_double)"), "sqrt($random_double)");
+ $this->assertFloat(log($random_double), $math_expr->evaluate("ln($random_double)"), "ln($random_double)");
+ $this->assertFloat(round($random_double), $math_expr->evaluate("round($random_double)"), "round($random_double)");
+
+ $random_real = $random_double + $random_int;
+ $this->assertFloat(abs($random_real), $math_expr->evaluate('abs(' . $random_real . ')'), "abs($random_real)");
+ $this->assertEqual(round($random_real), $math_expr->evaluate('round(' . $random_real . ')'), "round($random_real)");
+ $this->assertEqual(ceil($random_real), $math_expr->evaluate('ceil(' . $random_real . ')'), "ceil($random_real)");
+ $this->assertEqual(floor($random_real), $math_expr->evaluate('floor(' . $random_real . ')'), "floor($random_real)");
+ }
+
+ $this->assertFloat(time(), $math_expr->evaluate('time(1)'), "time(1)");
$random_double_a = $this->rand01();
$random_double_b = $this->rand01();
- // @fixme: max/min don't work at the moment.
-// $this->assertFloat(max($random_double_a, $random_double_b), $math_expression->e("max($random_double_a, $random_double_b)"));
-// $this->assertFloat(min($random_double_a, $random_double_b), $math_expression->e("min($random_double_a, $random_double_b)"));
+ $this->assertFloat(
+ max($random_double_a, $random_double_b),
+ $math_expr->evaluate("max($random_double_a, $random_double_b)"),
+ "max($random_double_a, $random_double_b)");
+ $this->assertFloat(
+ min($random_double_a, $random_double_b),
+ $math_expr->evaluate("min($random_double_a, $random_double_b)"),
+ "min($random_double_a, $random_double_b)");
}
/**
* Test variable handling.
*/
public function testVariables() {
- $math_expression = new ctools_math_expr();
+ $math_expr = new ctools_math_expr();
+
+ // We should have a definition of pi:
+ $this->assertFloat(pi(), $math_expr->evaluate('pi'));
+
+ // and a definition of e:
+ $this->assertFloat(exp(1), $math_expr->evaluate('e'));
+
+ $number_a = 5;
+ $number_b = 10;
- $random_number_a = rand(5, 10);
- $random_number_b = rand(5, 10);
+ // Store the first number and use it on a calculation.
+ $math_expr->evaluate("var = $number_a");
+ $this->assertEqual($number_a + $number_b, $math_expr->evaluate("var + $number_b"));
- // Store the first random number and use it on calculations.
- $math_expression->e("var = $random_number_a");
- $this->assertEqual($random_number_a + $random_number_b, $math_expression->e("var + $random_number_b"));
- $this->assertEqual($random_number_a * $random_number_b, $math_expression->e("var * $random_number_b"));
- $this->assertEqual($random_number_a - $random_number_b, $math_expression->e("var - $random_number_b"));
- $this->assertEqual($random_number_a / $random_number_b, $math_expression->e("var / $random_number_b"));
+ // Change the value and check the new value is used.
+ $math_expr->evaluate("var = $number_b");
+ $this->assertEqual(
+ $number_b + $number_b,
+ $math_expr->evaluate("var + $number_b"),
+ "var + $number_b");
+
+ // Store another number and use it on a calculation.
+ $math_expr->evaluate("var = $number_a");
+ $math_expr->evaluate("newvar = $number_a");
+
+ $this->assertEqual(
+ $number_a + $number_a,
+ $math_expr->evaluate('var + newvar'),
+ 'var + newvar');
+
+ $this->assertFloat(
+ $number_a / $number_b,
+ $math_expr->evaluate("var / $number_b"),
+ "var / $number_b");
}
/**
* Test custom function handling.
*/
public function testCustomFunctions() {
- $math_expression = new ctools_math_expr();
+ $math_expr = new ctools_math_expr();
- $random_number_a = rand(5, 10);
- $random_number_b = rand(5, 10);
+ $number_a = mt_rand(5, 10);
+ $number_b = mt_rand(5, 10);
// Create a one-argument function.
- $math_expression->e("f(x) = 2 * x");
- $this->assertEqual($random_number_a * 2, $math_expression->e("f($random_number_a)"));
- $this->assertEqual($random_number_b * 2, $math_expression->e("f($random_number_b)"));
+ $math_expr->evaluate("f(x) = 2 * x");
+ $this->assertEqual($number_a * 2, $math_expr->evaluate("f($number_a)"));
+ $this->assertEqual($number_b * 2, $math_expr->evaluate("f($number_b)"));
// Create a two-argument function.
- $math_expression->e("g(x, y) = 2 * x + y");
- $this->assertEqual($random_number_a * 2 + $random_number_b, $math_expression->e("g($random_number_a, $random_number_b)"));
+ $math_expr->evaluate("g(x, y) = 2 * x + y");
+ $this->assertEqual(
+ $number_a * 2 + $number_b,
+ $math_expr->evaluate("g($number_a, $number_b)"),
+ "g($number_a, $number_b)");
// Use a custom function in another function.
- $this->assertEqual(($random_number_a * 2 + $random_number_b) * 2, $math_expression->e("f(g($random_number_a, $random_number_b))"));
+ $this->assertEqual(
+ ($number_a * 2 + $number_b) * 2,
+ $math_expr->evaluate("f(g($number_a, $number_b))"),
+ "f(g($number_a, $number_b))");
+ }
+
+ /**
+ * Test conditional handling.
+ */
+ public function testIf() {
+ $math_expr = new ctools_math_expr();
+
+ $number_a = mt_rand(-5, 5);
+ $number_b = mt_rand(10, 20);
+
+ $this->assertEqual(
+ $number_a,
+ $math_expr->evaluate("if(1, $number_a, $number_b)"),
+ "if(1, $number_a, $number_b)");
+
+ $this->assertEqual(
+ $number_a,
+ $math_expr->evaluate("if(1, $number_a)",
+ "if(1, $number_a)"));
+
+ $this->assertEqual(
+ $number_b,
+ $math_expr->evaluate("if(0, $number_a, $number_b)"),
+ "if(0, $number_a, $number_b)");
+
+ // Also add an expression so ensure it's evaluated.
+ $this->assertEqual(
+ $number_b,
+ $math_expr->evaluate("if($number_a > $number_b, $number_a, $number_b)"),
+ "if($number_a > $number_b, $number_a, $number_b)");
+
+ $this->assertEqual(
+ $number_b,
+ $math_expr->evaluate("if($number_a < $number_b, $number_b, $number_a)"),
+ "if($number_a < $number_b, $number_b, $number_a)");
}
}