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

@@ -14,25 +14,25 @@ goog.declareModuleId('Blockly.JavaScript.logic');
import {Order, javascriptGenerator} from '../javascript.js';
javascriptGenerator.forBlock['controls_if'] = function(block) {
javascriptGenerator.forBlock['controls_if'] = function(block, generator) {
// If/elseif/else condition.
let n = 0;
let code = '';
if (javascriptGenerator.STATEMENT_PREFIX) {
if (generator.STATEMENT_PREFIX) {
// Automatic prefix insertion is switched off for this block. Add manually.
code += javascriptGenerator.injectId(
javascriptGenerator.STATEMENT_PREFIX, block);
code += generator.injectId(
generator.STATEMENT_PREFIX, block);
}
do {
const conditionCode =
javascriptGenerator.valueToCode(block, 'IF' + n, Order.NONE) ||
generator.valueToCode(block, 'IF' + n, Order.NONE) ||
'false';
let branchCode = javascriptGenerator.statementToCode(block, 'DO' + n);
if (javascriptGenerator.STATEMENT_SUFFIX) {
branchCode = javascriptGenerator.prefixLines(
javascriptGenerator.injectId(
javascriptGenerator.STATEMENT_SUFFIX, block),
javascriptGenerator.INDENT) +
let branchCode = generator.statementToCode(block, 'DO' + n);
if (generator.STATEMENT_SUFFIX) {
branchCode = generator.prefixLines(
generator.injectId(
generator.STATEMENT_SUFFIX, block),
generator.INDENT) +
branchCode;
}
code += (n > 0 ? ' else ' : '') + 'if (' + conditionCode + ') {\n' +
@@ -40,13 +40,13 @@ javascriptGenerator.forBlock['controls_if'] = function(block) {
n++;
} while (block.getInput('IF' + n));
if (block.getInput('ELSE') || javascriptGenerator.STATEMENT_SUFFIX) {
let branchCode = javascriptGenerator.statementToCode(block, 'ELSE');
if (javascriptGenerator.STATEMENT_SUFFIX) {
branchCode = javascriptGenerator.prefixLines(
javascriptGenerator.injectId(
javascriptGenerator.STATEMENT_SUFFIX, block),
javascriptGenerator.INDENT) +
if (block.getInput('ELSE') || generator.STATEMENT_SUFFIX) {
let branchCode = generator.statementToCode(block, 'ELSE');
if (generator.STATEMENT_SUFFIX) {
branchCode = generator.prefixLines(
generator.injectId(
generator.STATEMENT_SUFFIX, block),
generator.INDENT) +
branchCode;
}
code += ' else {\n' + branchCode + '}';
@@ -57,7 +57,7 @@ javascriptGenerator.forBlock['controls_if'] = function(block) {
javascriptGenerator.forBlock['controls_ifelse'] =
javascriptGenerator.forBlock['controls_if'];
javascriptGenerator.forBlock['logic_compare'] = function(block) {
javascriptGenerator.forBlock['logic_compare'] = function(block, generator) {
// Comparison operator.
const OPERATORS =
{'EQ': '==', 'NEQ': '!=', 'LT': '<', 'LTE': '<=', 'GT': '>', 'GTE': '>='};
@@ -65,19 +65,19 @@ javascriptGenerator.forBlock['logic_compare'] = function(block) {
const order = (operator === '==' || operator === '!=') ?
Order.EQUALITY :
Order.RELATIONAL;
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';
const code = argument0 + ' ' + operator + ' ' + argument1;
return [code, order];
};
javascriptGenerator.forBlock['logic_operation'] = function(block) {
javascriptGenerator.forBlock['logic_operation'] = function(block, generator) {
// Operations 'and', 'or'.
const operator = (block.getFieldValue('OP') === 'AND') ? '&&' : '||';
const order = (operator === '&&') ? Order.LOGICAL_AND :
Order.LOGICAL_OR;
let argument0 = javascriptGenerator.valueToCode(block, 'A', order);
let argument1 = javascriptGenerator.valueToCode(block, 'B', order);
let argument0 = generator.valueToCode(block, 'A', order);
let argument1 = generator.valueToCode(block, 'B', order);
if (!argument0 && !argument1) {
// If there are no arguments, then the return value is false.
argument0 = 'false';
@@ -96,36 +96,36 @@ javascriptGenerator.forBlock['logic_operation'] = function(block) {
return [code, order];
};
javascriptGenerator.forBlock['logic_negate'] = function(block) {
javascriptGenerator.forBlock['logic_negate'] = function(block, generator) {
// Negation.
const order = Order.LOGICAL_NOT;
const argument0 =
javascriptGenerator.valueToCode(block, 'BOOL', order) || 'true';
generator.valueToCode(block, 'BOOL', order) || 'true';
const code = '!' + argument0;
return [code, order];
};
javascriptGenerator.forBlock['logic_boolean'] = function(block) {
javascriptGenerator.forBlock['logic_boolean'] = function(block, generator) {
// Boolean values true and false.
const code = (block.getFieldValue('BOOL') === 'TRUE') ? 'true' : 'false';
return [code, Order.ATOMIC];
};
javascriptGenerator.forBlock['logic_null'] = function(block) {
javascriptGenerator.forBlock['logic_null'] = function(block, generator) {
// Null data type.
return ['null', Order.ATOMIC];
};
javascriptGenerator.forBlock['logic_ternary'] = function(block) {
javascriptGenerator.forBlock['logic_ternary'] = function(block, generator) {
// Ternary operator.
const value_if =
javascriptGenerator.valueToCode(block, 'IF', Order.CONDITIONAL) ||
generator.valueToCode(block, 'IF', Order.CONDITIONAL) ||
'false';
const value_then =
javascriptGenerator.valueToCode(block, 'THEN', Order.CONDITIONAL) ||
generator.valueToCode(block, 'THEN', Order.CONDITIONAL) ||
'null';
const value_else =
javascriptGenerator.valueToCode(block, 'ELSE', Order.CONDITIONAL) ||
generator.valueToCode(block, 'ELSE', Order.CONDITIONAL) ||
'null';
const code = value_if + ' ? ' + value_then + ' : ' + value_else;
return [code, Order.CONDITIONAL];