mirror of
https://github.com/google/blockly.git
synced 2026-01-04 23:50:12 +01:00
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:
committed by
GitHub
parent
12b91ae49c
commit
a3458871db
@@ -16,7 +16,7 @@ import {NameType} from '../../core/names.js';
|
||||
import {pythonGenerator, Order} from '../python.js';
|
||||
|
||||
|
||||
pythonGenerator.forBlock['controls_repeat_ext'] = function(block) {
|
||||
pythonGenerator.forBlock['controls_repeat_ext'] = function(block, generator) {
|
||||
// Repeat n times.
|
||||
let repeats;
|
||||
if (block.getField('TIMES')) {
|
||||
@@ -24,17 +24,17 @@ pythonGenerator.forBlock['controls_repeat_ext'] = function(block) {
|
||||
repeats = String(parseInt(block.getFieldValue('TIMES'), 10));
|
||||
} else {
|
||||
// External number.
|
||||
repeats = pythonGenerator.valueToCode(block, 'TIMES', Order.NONE) || '0';
|
||||
repeats = generator.valueToCode(block, 'TIMES', Order.NONE) || '0';
|
||||
}
|
||||
if (stringUtils.isNumber(repeats)) {
|
||||
repeats = parseInt(repeats, 10);
|
||||
} else {
|
||||
repeats = 'int(' + repeats + ')';
|
||||
}
|
||||
let branch = pythonGenerator.statementToCode(block, 'DO');
|
||||
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
const loopVar =
|
||||
pythonGenerator.nameDB_.getDistinctName('count', NameType.VARIABLE);
|
||||
generator.nameDB_.getDistinctName('count', NameType.VARIABLE);
|
||||
const code = 'for ' + loopVar + ' in range(' + repeats + '):\n' + branch;
|
||||
return code;
|
||||
};
|
||||
@@ -42,53 +42,53 @@ pythonGenerator.forBlock['controls_repeat_ext'] = function(block) {
|
||||
pythonGenerator.forBlock['controls_repeat'] =
|
||||
pythonGenerator.forBlock['controls_repeat_ext'];
|
||||
|
||||
pythonGenerator.forBlock['controls_whileUntil'] = function(block) {
|
||||
pythonGenerator.forBlock['controls_whileUntil'] = function(block, generator) {
|
||||
// Do while/until loop.
|
||||
const until = block.getFieldValue('MODE') === 'UNTIL';
|
||||
let argument0 = pythonGenerator.valueToCode(
|
||||
let argument0 = generator.valueToCode(
|
||||
block, 'BOOL',
|
||||
until ? Order.LOGICAL_NOT : Order.NONE) ||
|
||||
'False';
|
||||
let branch = pythonGenerator.statementToCode(block, 'DO');
|
||||
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
if (until) {
|
||||
argument0 = 'not ' + argument0;
|
||||
}
|
||||
return 'while ' + argument0 + ':\n' + branch;
|
||||
};
|
||||
|
||||
pythonGenerator.forBlock['controls_for'] = function(block) {
|
||||
pythonGenerator.forBlock['controls_for'] = function(block, generator) {
|
||||
// For loop.
|
||||
const variable0 =
|
||||
pythonGenerator.nameDB_.getName(
|
||||
generator.nameDB_.getName(
|
||||
block.getFieldValue('VAR'), NameType.VARIABLE);
|
||||
let argument0 = pythonGenerator.valueToCode(block, 'FROM', Order.NONE) || '0';
|
||||
let argument1 = pythonGenerator.valueToCode(block, 'TO', Order.NONE) || '0';
|
||||
let increment = pythonGenerator.valueToCode(block, 'BY', Order.NONE) || '1';
|
||||
let branch = pythonGenerator.statementToCode(block, 'DO');
|
||||
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
|
||||
let argument0 = generator.valueToCode(block, 'FROM', Order.NONE) || '0';
|
||||
let argument1 = generator.valueToCode(block, 'TO', Order.NONE) || '0';
|
||||
let increment = generator.valueToCode(block, 'BY', Order.NONE) || '1';
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
|
||||
let code = '';
|
||||
let range;
|
||||
|
||||
// Helper functions.
|
||||
const defineUpRange = function() {
|
||||
return pythonGenerator.provideFunction_('upRange', `
|
||||
def ${pythonGenerator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
return generator.provideFunction_('upRange', `
|
||||
def ${generator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
while start <= stop:
|
||||
yield start
|
||||
start += abs(step)
|
||||
`);
|
||||
};
|
||||
const defineDownRange = function() {
|
||||
return pythonGenerator.provideFunction_('downRange', `
|
||||
def ${pythonGenerator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
return generator.provideFunction_('downRange', `
|
||||
def ${generator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
while start >= stop:
|
||||
yield start
|
||||
start -= abs(step)
|
||||
`);
|
||||
};
|
||||
// Arguments are legal pythonGenerator code (numbers or strings returned by scrub()).
|
||||
// Arguments are legal generator code (numbers or strings returned by scrub()).
|
||||
const generateUpDownRange = function(start, end, inc) {
|
||||
return '(' + start + ' <= ' + end + ') and ' + defineUpRange() + '(' +
|
||||
start + ', ' + end + ', ' + inc + ') or ' + defineDownRange() + '(' +
|
||||
@@ -139,7 +139,7 @@ def ${pythonGenerator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
arg = Number(arg);
|
||||
} else if (!arg.match(/^\w+$/)) {
|
||||
// Not a variable, it's complicated.
|
||||
const varName = pythonGenerator.nameDB_.getDistinctName(
|
||||
const varName = generator.nameDB_.getDistinctName(
|
||||
variable0 + suffix, NameType.VARIABLE);
|
||||
code += varName + ' = ' + arg + '\n';
|
||||
arg = varName;
|
||||
@@ -166,38 +166,38 @@ def ${pythonGenerator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
|
||||
return code;
|
||||
};
|
||||
|
||||
pythonGenerator.forBlock['controls_forEach'] = function(block) {
|
||||
pythonGenerator.forBlock['controls_forEach'] = function(block, generator) {
|
||||
// For each loop.
|
||||
const variable0 =
|
||||
pythonGenerator.nameDB_.getName(
|
||||
generator.nameDB_.getName(
|
||||
block.getFieldValue('VAR'), NameType.VARIABLE);
|
||||
const argument0 =
|
||||
pythonGenerator.valueToCode(block, 'LIST', Order.RELATIONAL) || '[]';
|
||||
let branch = pythonGenerator.statementToCode(block, 'DO');
|
||||
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
|
||||
generator.valueToCode(block, 'LIST', Order.RELATIONAL) || '[]';
|
||||
let branch = generator.statementToCode(block, 'DO');
|
||||
branch = generator.addLoopTrap(branch, block) || generator.PASS;
|
||||
const code = 'for ' + variable0 + ' in ' + argument0 + ':\n' + branch;
|
||||
return code;
|
||||
};
|
||||
|
||||
pythonGenerator.forBlock['controls_flow_statements'] = function(block) {
|
||||
pythonGenerator.forBlock['controls_flow_statements'] = function(block, generator) {
|
||||
// Flow statements: continue, break.
|
||||
let xfix = '';
|
||||
if (pythonGenerator.STATEMENT_PREFIX) {
|
||||
if (generator.STATEMENT_PREFIX) {
|
||||
// Automatic prefix insertion is switched off for this block. Add manually.
|
||||
xfix += pythonGenerator.injectId(pythonGenerator.STATEMENT_PREFIX, block);
|
||||
xfix += generator.injectId(generator.STATEMENT_PREFIX, block);
|
||||
}
|
||||
if (pythonGenerator.STATEMENT_SUFFIX) {
|
||||
if (generator.STATEMENT_SUFFIX) {
|
||||
// Inject any statement suffix here since the regular one at the end
|
||||
// will not get executed if the break/continue is triggered.
|
||||
xfix += pythonGenerator.injectId(pythonGenerator.STATEMENT_SUFFIX, block);
|
||||
xfix += generator.injectId(generator.STATEMENT_SUFFIX, block);
|
||||
}
|
||||
if (pythonGenerator.STATEMENT_PREFIX) {
|
||||
if (generator.STATEMENT_PREFIX) {
|
||||
const loop = block.getSurroundLoop();
|
||||
if (loop && !loop.suppressPrefixSuffix) {
|
||||
// Inject loop's statement prefix here since the regular one at the end
|
||||
// of the loop will not get executed if 'continue' is triggered.
|
||||
// In the case of 'break', a prefix is needed due to the loop's suffix.
|
||||
xfix += pythonGenerator.injectId(pythonGenerator.STATEMENT_PREFIX, loop);
|
||||
xfix += generator.injectId(generator.STATEMENT_PREFIX, loop);
|
||||
}
|
||||
}
|
||||
switch (block.getFieldValue('FLOW')) {
|
||||
|
||||
Reference in New Issue
Block a user