refactor(generators)!: Pass this CodeGenerator to individual generator functions (#7168)

* feat(generators): Pass this CodeGenerator to generator functions

  This implements option 1A of proposal 1 of #7086.

  This commit is not by itself a breaking change, except in the unlikely event that
  developers' custom generator functions take an (optional) second argument of a
  dfferent type.

* feat(generators): Accept generator argument in block functions

  Accept a CodeGenerator instance as parameter two of every
  per-block-type generator function.

* fix(generators): Pass generator when calling other generator functions

  Make sure to pass generator to any other block functions that are
  called recursively.

* refactor(generators)!: Use generator argument in generator functions

  Refactor per-block-type generator functions to use the provided
  generator argument to make recursive calls, rather than depending
  on the closed-over <lang>Generator instance.

  This allows generator functions to be moved between CodeGenerator
  instances (of the same language, at least).

  This commit was created by search-and-replace and addresses most
  but not all recursive references; remaining uses will require
  manual attention and will be dealt with in a following commit.

  BREAKING CHANGE: This commit makes the generator functions we provide
  dependent on the new generator parameter.  Although
  CodeGenerator.prototype.blockToCode has been modified to supply this,
  so this change will not affect most developers, this change will be a
  breaking change where developers make direct calls to these generator
  functions without supplying the generator parameter.  See previous
  commit for an example of the update required.

* refactor(generators): Manual fix for remaining uses of langGenerator

  Manually replace remaining uses of <lang>Generator in block
  generator functions.

* fix(generators): Delete duplicate procedures_callnoreturn generator

  For some reason the generator function for procedures_callnoreturn
  appears twice in generators/javascript/procedures.js.  Delete the
  first copy (since the second one overwrote it anyway).

* chore(generators): Format
This commit is contained in:
Christopher Allen
2023-06-14 23:25:36 +01:00
committed by GitHub
parent 12b91ae49c
commit a3458871db
44 changed files with 1474 additions and 1477 deletions

View File

@@ -16,7 +16,7 @@ import {NameType} from '../../core/names.js';
import {Order, javascriptGenerator} from '../javascript.js';
javascriptGenerator.forBlock['math_number'] = function(block) {
javascriptGenerator.forBlock['math_number'] = function(block, generator) {
// Numeric value.
const code = Number(block.getFieldValue('NUM'));
const order = code >= 0 ? Order.ATOMIC :
@@ -24,7 +24,7 @@ javascriptGenerator.forBlock['math_number'] = function(block) {
return [code, order];
};
javascriptGenerator.forBlock['math_arithmetic'] = function(block) {
javascriptGenerator.forBlock['math_arithmetic'] = function(block, generator) {
// Basic arithmetic operators, and power.
const OPERATORS = {
'ADD': [' + ', Order.ADDITION],
@@ -36,8 +36,8 @@ javascriptGenerator.forBlock['math_arithmetic'] = function(block) {
const tuple = OPERATORS[block.getFieldValue('OP')];
const operator = tuple[0];
const order = tuple[1];
const argument0 = javascriptGenerator.valueToCode(block, 'A', order) || '0';
const argument1 = javascriptGenerator.valueToCode(block, 'B', order) || '0';
const argument0 = generator.valueToCode(block, 'A', order) || '0';
const argument1 = generator.valueToCode(block, 'B', order) || '0';
let code;
// Power in JavaScript requires a special case since it has no operator.
if (!operator) {
@@ -48,14 +48,14 @@ javascriptGenerator.forBlock['math_arithmetic'] = function(block) {
return [code, order];
};
javascriptGenerator.forBlock['math_single'] = function(block) {
javascriptGenerator.forBlock['math_single'] = function(block, generator) {
// 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 = javascriptGenerator.valueToCode(block, 'NUM',
arg = generator.valueToCode(block, 'NUM',
Order.UNARY_NEGATION) || '0';
if (arg[0] === '-') {
// --3 is not legal in JS.
@@ -65,10 +65,10 @@ javascriptGenerator.forBlock['math_single'] = function(block) {
return [code, Order.UNARY_NEGATION];
}
if (operator === 'SIN' || operator === 'COS' || operator === 'TAN') {
arg = javascriptGenerator.valueToCode(block, 'NUM',
arg = generator.valueToCode(block, 'NUM',
Order.DIVISION) || '0';
} else {
arg = javascriptGenerator.valueToCode(block, 'NUM',
arg = generator.valueToCode(block, 'NUM',
Order.NONE) || '0';
}
// First, handle cases which generate values that don't need parentheses
@@ -132,7 +132,7 @@ javascriptGenerator.forBlock['math_single'] = function(block) {
return [code, Order.DIVISION];
};
javascriptGenerator.forBlock['math_constant'] = function(block) {
javascriptGenerator.forBlock['math_constant'] = function(block, generator) {
// Constants: PI, E, the Golden Ratio, sqrt(2), 1/sqrt(2), INFINITY.
const CONSTANTS = {
'PI': ['Math.PI', Order.MEMBER],
@@ -145,7 +145,7 @@ javascriptGenerator.forBlock['math_constant'] = function(block) {
return CONSTANTS[block.getFieldValue('CONSTANT')];
};
javascriptGenerator.forBlock['math_number_property'] = function(block) {
javascriptGenerator.forBlock['math_number_property'] = function(block, generator) {
// 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 = {
@@ -163,13 +163,13 @@ javascriptGenerator.forBlock['math_number_property'] = function(block) {
const dropdownProperty = block.getFieldValue('PROPERTY');
const [suffix, inputOrder, outputOrder] = PROPERTIES[dropdownProperty];
const numberToCheck =
javascriptGenerator.valueToCode(block, 'NUMBER_TO_CHECK', inputOrder) ||
generator.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 = javascriptGenerator.provideFunction_('mathIsPrime', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(n) {
const functionName = generator.provideFunction_('mathIsPrime', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(n) {
// https://en.wikipedia.org/wiki/Primality_test#Naive_methods
if (n == 2 || n == 3) {
return true;
@@ -190,7 +190,7 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(n) {
`);
code = functionName + '(' + numberToCheck + ')';
} else if (dropdownProperty === 'DIVISIBLE_BY') {
const divisor = javascriptGenerator.valueToCode(block, 'DIVISOR',
const divisor = generator.valueToCode(block, 'DIVISOR',
Order.MODULUS) || '0';
code = numberToCheck + ' % ' + divisor + ' === 0';
} else {
@@ -199,11 +199,11 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(n) {
return [code, outputOrder];
};
javascriptGenerator.forBlock['math_change'] = function(block) {
javascriptGenerator.forBlock['math_change'] = function(block, generator) {
// Add to a variable in place.
const argument0 = javascriptGenerator.valueToCode(block, 'DELTA',
const argument0 = generator.valueToCode(block, 'DELTA',
Order.ADDITION) || '0';
const varName = javascriptGenerator.nameDB_.getName(
const varName = generator.nameDB_.getName(
block.getFieldValue('VAR'), NameType.VARIABLE);
return varName + ' = (typeof ' + varName + ' === \'number\' ? ' + varName +
' : 0) + ' + argument0 + ';\n';
@@ -216,43 +216,43 @@ javascriptGenerator.forBlock['math_round'] =
javascriptGenerator.forBlock['math_trig'] =
javascriptGenerator.forBlock['math_single'];
javascriptGenerator.forBlock['math_on_list'] = function(block) {
javascriptGenerator.forBlock['math_on_list'] = function(block, generator) {
// Math functions for lists.
const func = block.getFieldValue('OP');
let list;
let code;
switch (func) {
case 'SUM':
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.MEMBER) || '[]';
code = list + '.reduce(function(x, y) {return x + y;}, 0)';
break;
case 'MIN':
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = 'Math.min.apply(null, ' + list + ')';
break;
case 'MAX':
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = 'Math.max.apply(null, ' + list + ')';
break;
case 'AVERAGE': {
// mathMean([null,null,1,3]) === 2.0.
const functionName = javascriptGenerator.provideFunction_('mathMean', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(myList) {
const functionName = generator.provideFunction_('mathMean', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(myList) {
return myList.reduce(function(x, y) {return x + y;}, 0) / myList.length;
}
`);
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = functionName + '(' + list + ')';
break;
}
case 'MEDIAN': {
// mathMedian([null,null,1,3]) === 2.0.
const functionName = javascriptGenerator.provideFunction_('mathMedian', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(myList) {
const functionName = generator.provideFunction_('mathMedian', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(myList) {
var localList = myList.filter(function (x) {return typeof x === 'number';});
if (!localList.length) return null;
localList.sort(function(a, b) {return b - a;});
@@ -263,7 +263,7 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(myList) {
}
}
`);
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = functionName + '(' + list + ')';
break;
@@ -272,8 +272,8 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(myList) {
// 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 = javascriptGenerator.provideFunction_('mathModes', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(values) {
const functionName = generator.provideFunction_('mathModes', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(values) {
var modes = [];
var counts = [];
var maxCount = 0;
@@ -302,15 +302,15 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(values) {
return modes;
}
`);
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = functionName + '(' + list + ')';
break;
}
case 'STD_DEV': {
const functionName =
javascriptGenerator.provideFunction_('mathStandardDeviation', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(numbers) {
generator.provideFunction_('mathStandardDeviation', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(numbers) {
var n = numbers.length;
if (!n) return null;
var mean = numbers.reduce(function(x, y) {return x + y;}) / n;
@@ -322,20 +322,20 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(numbers) {
return Math.sqrt(variance);
}
`);
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = functionName + '(' + list + ')';
break;
}
case 'RANDOM': {
const functionName =
javascriptGenerator.provideFunction_('mathRandomList', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(list) {
generator.provideFunction_('mathRandomList', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(list) {
var x = Math.floor(Math.random() * list.length);
return list[x];
}
`);
list = javascriptGenerator.valueToCode(block, 'LIST',
list = generator.valueToCode(block, 'LIST',
Order.NONE) || '[]';
code = functionName + '(' + list + ')';
break;
@@ -346,37 +346,37 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(list) {
return [code, Order.FUNCTION_CALL];
};
javascriptGenerator.forBlock['math_modulo'] = function(block) {
javascriptGenerator.forBlock['math_modulo'] = function(block, generator) {
// Remainder computation.
const argument0 = javascriptGenerator.valueToCode(block, 'DIVIDEND',
const argument0 = generator.valueToCode(block, 'DIVIDEND',
Order.MODULUS) || '0';
const argument1 = javascriptGenerator.valueToCode(block, 'DIVISOR',
const argument1 = generator.valueToCode(block, 'DIVISOR',
Order.MODULUS) || '0';
const code = argument0 + ' % ' + argument1;
return [code, Order.MODULUS];
};
javascriptGenerator.forBlock['math_constrain'] = function(block) {
javascriptGenerator.forBlock['math_constrain'] = function(block, generator) {
// Constrain a number between two limits.
const argument0 = javascriptGenerator.valueToCode(block, 'VALUE',
const argument0 = generator.valueToCode(block, 'VALUE',
Order.NONE) || '0';
const argument1 = javascriptGenerator.valueToCode(block, 'LOW',
const argument1 = generator.valueToCode(block, 'LOW',
Order.NONE) || '0';
const argument2 = javascriptGenerator.valueToCode(block, 'HIGH',
const argument2 = generator.valueToCode(block, 'HIGH',
Order.NONE) || 'Infinity';
const code = 'Math.min(Math.max(' + argument0 + ', ' + argument1 + '), ' +
argument2 + ')';
return [code, Order.FUNCTION_CALL];
};
javascriptGenerator.forBlock['math_random_int'] = function(block) {
javascriptGenerator.forBlock['math_random_int'] = function(block, generator) {
// Random integer between [X] and [Y].
const argument0 = javascriptGenerator.valueToCode(block, 'FROM',
const argument0 = generator.valueToCode(block, 'FROM',
Order.NONE) || '0';
const argument1 = javascriptGenerator.valueToCode(block, 'TO',
const argument1 = generator.valueToCode(block, 'TO',
Order.NONE) || '0';
const functionName = javascriptGenerator.provideFunction_('mathRandomInt', `
function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(a, b) {
const functionName = generator.provideFunction_('mathRandomInt', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}(a, b) {
if (a > b) {
// Swap a and b to ensure a is smaller.
var c = a;
@@ -390,16 +390,16 @@ function ${javascriptGenerator.FUNCTION_NAME_PLACEHOLDER_}(a, b) {
return [code, Order.FUNCTION_CALL];
};
javascriptGenerator.forBlock['math_random_float'] = function(block) {
javascriptGenerator.forBlock['math_random_float'] = function(block, generator) {
// Random fraction between 0 and 1.
return ['Math.random()', Order.FUNCTION_CALL];
};
javascriptGenerator.forBlock['math_atan2'] = function(block) {
javascriptGenerator.forBlock['math_atan2'] = function(block, generator) {
// Arctangent of point (X, Y) in degrees from -180 to 180.
const argument0 = javascriptGenerator.valueToCode(block, 'X',
const argument0 = generator.valueToCode(block, 'X',
Order.NONE) || '0';
const argument1 = javascriptGenerator.valueToCode(block, 'Y',
const argument1 = generator.valueToCode(block, 'Y',
Order.NONE) || '0';
return ['Math.atan2(' + argument1 + ', ' + argument0 + ') / Math.PI * 180',
Order.DIVISION];