/** * @license * Copyright 2015 Google LLC * SPDX-License-Identifier: Apache-2.0 */ /** * @fileoverview Generating PHP for math blocks. */ import * as goog from '../../closure/goog/goog.js'; goog.declareModuleId('Blockly.PHP.math'); import {NameType} from '../../core/names.js'; import {phpGenerator, Order} from '../php.js'; phpGenerator.forBlock['math_number'] = function(block) { // Numeric value. let code = Number(block.getFieldValue('NUM')); const order = code >= 0 ? Order.ATOMIC : Order.UNARY_NEGATION; if (code === Infinity) { code = 'INF'; } else if (code === -Infinity) { code = '-INF'; } return [code, order]; }; phpGenerator.forBlock['math_arithmetic'] = function(block) { // Basic arithmetic operators, and power. const OPERATORS = { 'ADD': [' + ', Order.ADDITION], 'MINUS': [' - ', Order.SUBTRACTION], 'MULTIPLY': [' * ', Order.MULTIPLICATION], 'DIVIDE': [' / ', Order.DIVISION], 'POWER': [' ** ', Order.POWER], }; const tuple = OPERATORS[block.getFieldValue('OP')]; const operator = tuple[0]; const order = tuple[1]; const argument0 = phpGenerator.valueToCode(block, 'A', order) || '0'; const argument1 = phpGenerator.valueToCode(block, 'B', order) || '0'; const code = argument0 + operator + argument1; return [code, order]; }; phpGenerator.forBlock['math_single'] = function(block) { // Math operators with single operand. const operator = block.getFieldValue('OP'); let code; let arg; if (operator === 'NEG') { // Negation is a special case given its different operator precedence. arg = phpGenerator.valueToCode(block, 'NUM', Order.UNARY_NEGATION) || '0'; if (arg[0] === '-') { // --3 is not legal in JS. arg = ' ' + arg; } code = '-' + arg; return [code, Order.UNARY_NEGATION]; } if (operator === 'SIN' || operator === 'COS' || operator === 'TAN') { arg = phpGenerator.valueToCode(block, 'NUM', Order.DIVISION) || '0'; } else { arg = phpGenerator.valueToCode(block, 'NUM', Order.NONE) || '0'; } // First, handle cases which generate values that don't need parentheses // wrapping the code. switch (operator) { case 'ABS': code = 'abs(' + arg + ')'; break; case 'ROOT': code = 'sqrt(' + arg + ')'; break; case 'LN': code = 'log(' + arg + ')'; break; case 'EXP': code = 'exp(' + arg + ')'; break; case 'POW10': code = 'pow(10,' + arg + ')'; break; case 'ROUND': code = 'round(' + arg + ')'; break; case 'ROUNDUP': code = 'ceil(' + arg + ')'; break; case 'ROUNDDOWN': code = 'floor(' + arg + ')'; break; case 'SIN': code = 'sin(' + arg + ' / 180 * pi())'; break; case 'COS': code = 'cos(' + arg + ' / 180 * pi())'; break; case 'TAN': code = 'tan(' + arg + ' / 180 * pi())'; break; } if (code) { return [code, Order.FUNCTION_CALL]; } // Second, handle cases which generate values that may need parentheses // wrapping the code. switch (operator) { case 'LOG10': code = 'log(' + arg + ') / log(10)'; break; case 'ASIN': code = 'asin(' + arg + ') / pi() * 180'; break; case 'ACOS': code = 'acos(' + arg + ') / pi() * 180'; break; case 'ATAN': code = 'atan(' + arg + ') / pi() * 180'; break; default: throw Error('Unknown math operator: ' + operator); } return [code, Order.DIVISION]; }; phpGenerator.forBlock['math_constant'] = function(block) { // Constants: PI, E, the Golden Ratio, sqrt(2), 1/sqrt(2), INFINITY. const CONSTANTS = { 'PI': ['M_PI', Order.ATOMIC], 'E': ['M_E', Order.ATOMIC], 'GOLDEN_RATIO': ['(1 + sqrt(5)) / 2', Order.DIVISION], 'SQRT2': ['M_SQRT2', Order.ATOMIC], 'SQRT1_2': ['M_SQRT1_2', Order.ATOMIC], 'INFINITY': ['INF', Order.ATOMIC], }; return CONSTANTS[block.getFieldValue('CONSTANT')]; }; phpGenerator.forBlock['math_number_property'] = function(block) { // Check if a number is even, odd, prime, whole, positive, or negative // or if it is divisible by certain number. Returns true or false. const PROPERTIES = { 'EVEN': ['', ' % 2 == 0', Order.MODULUS, Order.EQUALITY], 'ODD': ['', ' % 2 == 1', Order.MODULUS, Order.EQUALITY], 'WHOLE': ['is_int(', ')', Order.NONE, Order.FUNCTION_CALL], 'POSITIVE': ['', ' > 0', Order.RELATIONAL, Order.RELATIONAL], 'NEGATIVE': ['', ' < 0', Order.RELATIONAL, Order.RELATIONAL], 'DIVISIBLE_BY': [null, null, Order.MODULUS, Order.EQUALITY], 'PRIME': [null, null, Order.NONE, Order.FUNCTION_CALL], }; const dropdownProperty = block.getFieldValue('PROPERTY'); const [prefix, suffix, inputOrder, outputOrder] = PROPERTIES[dropdownProperty]; const numberToCheck = phpGenerator.valueToCode(block, 'NUMBER_TO_CHECK', inputOrder) || '0'; let code; if (dropdownProperty === 'PRIME') { // Prime is a special case as it is not a one-liner test. const functionName = phpGenerator.provideFunction_('math_isPrime', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($n) { // https://en.wikipedia.org/wiki/Primality_test#Naive_methods if ($n == 2 || $n == 3) { return true; } // False if n is NaN, negative, is 1, or not whole. // And false if n is divisible by 2 or 3. if (!is_numeric($n) || $n <= 1 || $n % 1 != 0 || $n % 2 == 0 || $n % 3 == 0) { return false; } // Check all the numbers of form 6k +/- 1, up to sqrt(n). for ($x = 6; $x <= sqrt($n) + 1; $x += 6) { if ($n % ($x - 1) == 0 || $n % ($x + 1) == 0) { return false; } } return true; } `); code = functionName + '(' + numberToCheck + ')'; } else if (dropdownProperty === 'DIVISIBLE_BY') { const divisor = phpGenerator.valueToCode(block, 'DIVISOR', Order.MODULUS) || '0'; if (divisor === '0') { return ['false', Order.ATOMIC]; } code = numberToCheck + ' % ' + divisor + ' == 0'; } else { code = prefix + numberToCheck + suffix; } return [code, outputOrder]; }; phpGenerator.forBlock['math_change'] = function(block) { // Add to a variable in place. const argument0 = phpGenerator.valueToCode(block, 'DELTA', Order.ADDITION) || '0'; const varName = phpGenerator.nameDB_.getName( block.getFieldValue('VAR'), NameType.VARIABLE); return varName + ' += ' + argument0 + ';\n'; }; // Rounding functions have a single operand. phpGenerator.forBlock['math_round'] = phpGenerator.forBlock['math_single']; // Trigonometry functions have a single operand. phpGenerator.forBlock['math_trig'] = phpGenerator.forBlock['math_single']; phpGenerator.forBlock['math_on_list'] = function(block) { // Math functions for lists. const func = block.getFieldValue('OP'); let list; let code; switch (func) { case 'SUM': list = phpGenerator.valueToCode(block, 'LIST', Order.FUNCTION_CALL) || 'array()'; code = 'array_sum(' + list + ')'; break; case 'MIN': list = phpGenerator.valueToCode(block, 'LIST', Order.FUNCTION_CALL) || 'array()'; code = 'min(' + list + ')'; break; case 'MAX': list = phpGenerator.valueToCode(block, 'LIST', Order.FUNCTION_CALL) || 'array()'; code = 'max(' + list + ')'; break; case 'AVERAGE': { const functionName = phpGenerator.provideFunction_('math_mean', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($myList) { return array_sum($myList) / count($myList); } `); list = phpGenerator.valueToCode(block, 'LIST', Order.NONE) || 'array()'; code = functionName + '(' + list + ')'; break; } case 'MEDIAN': { const functionName = phpGenerator.provideFunction_('math_median', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($arr) { sort($arr,SORT_NUMERIC); return (count($arr) % 2) ? $arr[floor(count($arr) / 2)] : ($arr[floor(count($arr) / 2)] + $arr[floor(count($arr) / 2) - 1]) / 2; } `); list = phpGenerator.valueToCode(block, 'LIST', Order.NONE) || '[]'; code = functionName + '(' + list + ')'; break; } case 'MODE': { // As a list of numbers can contain more than one mode, // the returned result is provided as an array. // Mode of [3, 'x', 'x', 1, 1, 2, '3'] -> ['x', 1]. const functionName = phpGenerator.provideFunction_('math_modes', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($values) { if (empty($values)) return array(); $counts = array_count_values($values); arsort($counts); // Sort counts in descending order $modes = array_keys($counts, current($counts), true); return $modes; } `); list = phpGenerator.valueToCode(block, 'LIST', Order.NONE) || '[]'; code = functionName + '(' + list + ')'; break; } case 'STD_DEV': { const functionName = phpGenerator.provideFunction_('math_standard_deviation', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($numbers) { $n = count($numbers); if (!$n) return null; $mean = array_sum($numbers) / count($numbers); foreach($numbers as $key => $num) $devs[$key] = pow($num - $mean, 2); return sqrt(array_sum($devs) / (count($devs) - 1)); } `); list = phpGenerator.valueToCode(block, 'LIST', Order.NONE) || '[]'; code = functionName + '(' + list + ')'; break; } case 'RANDOM': { const functionName = phpGenerator.provideFunction_('math_random_list', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($list) { $x = rand(0, count($list)-1); return $list[$x]; } `); list = phpGenerator.valueToCode(block, 'LIST', Order.NONE) || '[]'; code = functionName + '(' + list + ')'; break; } default: throw Error('Unknown operator: ' + func); } return [code, Order.FUNCTION_CALL]; }; phpGenerator.forBlock['math_modulo'] = function(block) { // Remainder computation. const argument0 = phpGenerator.valueToCode(block, 'DIVIDEND', Order.MODULUS) || '0'; const argument1 = phpGenerator.valueToCode(block, 'DIVISOR', Order.MODULUS) || '0'; const code = argument0 + ' % ' + argument1; return [code, Order.MODULUS]; }; phpGenerator.forBlock['math_constrain'] = function(block) { // Constrain a number between two limits. const argument0 = phpGenerator.valueToCode(block, 'VALUE', Order.NONE) || '0'; const argument1 = phpGenerator.valueToCode(block, 'LOW', Order.NONE) || '0'; const argument2 = phpGenerator.valueToCode(block, 'HIGH', Order.NONE) || 'Infinity'; const code = 'min(max(' + argument0 + ', ' + argument1 + '), ' + argument2 + ')'; return [code, Order.FUNCTION_CALL]; }; phpGenerator.forBlock['math_random_int'] = function(block) { // Random integer between [X] and [Y]. const argument0 = phpGenerator.valueToCode(block, 'FROM', Order.NONE) || '0'; const argument1 = phpGenerator.valueToCode(block, 'TO', Order.NONE) || '0'; const functionName = phpGenerator.provideFunction_('math_random_int', ` function ${phpGenerator.FUNCTION_NAME_PLACEHOLDER_}($a, $b) { if ($a > $b) { return rand($b, $a); } return rand($a, $b); } `); const code = functionName + '(' + argument0 + ', ' + argument1 + ')'; return [code, Order.FUNCTION_CALL]; }; phpGenerator.forBlock['math_random_float'] = function(block) { // Random fraction between 0 and 1. return ['(float)rand()/(float)getrandmax()', Order.FUNCTION_CALL]; }; phpGenerator.forBlock['math_atan2'] = function(block) { // Arctangent of point (X, Y) in degrees from -180 to 180. const argument0 = phpGenerator.valueToCode(block, 'X', Order.NONE) || '0'; const argument1 = phpGenerator.valueToCode(block, 'Y', Order.NONE) || '0'; return [ 'atan2(' + argument1 + ', ' + argument0 + ') / pi() * 180', Order.DIVISION ]; };