refactor(generators): Introduce PythonGenerator class, Order enum (#7163)

* refactor(generators): Introduce PhpGenerator class, Order enum

* refactor(generators): Use Order.* instead of .ORDER_*

* refactor(generators): Don't rename pythonGenerator
This commit is contained in:
Christopher Allen
2023-06-14 16:51:15 +01:00
committed by GitHub
parent 26901654ea
commit 2f89c0dd09
10 changed files with 725 additions and 671 deletions

View File

@@ -13,10 +13,10 @@ goog.declareModuleId('Blockly.Python.loops');
import * as stringUtils from '../../core/utils/string.js';
import {NameType} from '../../core/names.js';
import {pythonGenerator as Python} from '../python.js';
import {pythonGenerator, Order} from '../python.js';
Python.forBlock['controls_repeat_ext'] = function(block) {
pythonGenerator.forBlock['controls_repeat_ext'] = function(block) {
// Repeat n times.
let repeats;
if (block.getField('TIMES')) {
@@ -24,68 +24,71 @@ Python.forBlock['controls_repeat_ext'] = function(block) {
repeats = String(parseInt(block.getFieldValue('TIMES'), 10));
} else {
// External number.
repeats = Python.valueToCode(block, 'TIMES', Python.ORDER_NONE) || '0';
repeats = pythonGenerator.valueToCode(block, 'TIMES', Order.NONE) || '0';
}
if (stringUtils.isNumber(repeats)) {
repeats = parseInt(repeats, 10);
} else {
repeats = 'int(' + repeats + ')';
}
let branch = Python.statementToCode(block, 'DO');
branch = Python.addLoopTrap(branch, block) || Python.PASS;
const loopVar = Python.nameDB_.getDistinctName('count', NameType.VARIABLE);
let branch = pythonGenerator.statementToCode(block, 'DO');
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
const loopVar =
pythonGenerator.nameDB_.getDistinctName('count', NameType.VARIABLE);
const code = 'for ' + loopVar + ' in range(' + repeats + '):\n' + branch;
return code;
};
Python.forBlock['controls_repeat'] = Python.forBlock['controls_repeat_ext'];
pythonGenerator.forBlock['controls_repeat'] =
pythonGenerator.forBlock['controls_repeat_ext'];
Python.forBlock['controls_whileUntil'] = function(block) {
pythonGenerator.forBlock['controls_whileUntil'] = function(block) {
// Do while/until loop.
const until = block.getFieldValue('MODE') === 'UNTIL';
let argument0 = Python.valueToCode(
let argument0 = pythonGenerator.valueToCode(
block, 'BOOL',
until ? Python.ORDER_LOGICAL_NOT : Python.ORDER_NONE) ||
until ? Order.LOGICAL_NOT : Order.NONE) ||
'False';
let branch = Python.statementToCode(block, 'DO');
branch = Python.addLoopTrap(branch, block) || Python.PASS;
let branch = pythonGenerator.statementToCode(block, 'DO');
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
if (until) {
argument0 = 'not ' + argument0;
}
return 'while ' + argument0 + ':\n' + branch;
};
Python.forBlock['controls_for'] = function(block) {
pythonGenerator.forBlock['controls_for'] = function(block) {
// For loop.
const variable0 =
Python.nameDB_.getName(block.getFieldValue('VAR'), NameType.VARIABLE);
let argument0 = Python.valueToCode(block, 'FROM', Python.ORDER_NONE) || '0';
let argument1 = Python.valueToCode(block, 'TO', Python.ORDER_NONE) || '0';
let increment = Python.valueToCode(block, 'BY', Python.ORDER_NONE) || '1';
let branch = Python.statementToCode(block, 'DO');
branch = Python.addLoopTrap(branch, block) || Python.PASS;
pythonGenerator.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 code = '';
let range;
// Helper functions.
const defineUpRange = function() {
return Python.provideFunction_('upRange', `
def ${Python.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
return pythonGenerator.provideFunction_('upRange', `
def ${pythonGenerator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
while start <= stop:
yield start
start += abs(step)
`);
};
const defineDownRange = function() {
return Python.provideFunction_('downRange', `
def ${Python.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
return pythonGenerator.provideFunction_('downRange', `
def ${pythonGenerator.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
while start >= stop:
yield start
start -= abs(step)
`);
};
// Arguments are legal Python code (numbers or strings returned by scrub()).
// Arguments are legal pythonGenerator code (numbers or strings returned by scrub()).
const generateUpDownRange = function(start, end, inc) {
return '(' + start + ' <= ' + end + ') and ' + defineUpRange() + '(' +
start + ', ' + end + ', ' + inc + ') or ' + defineDownRange() + '(' +
@@ -136,7 +139,7 @@ def ${Python.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
arg = Number(arg);
} else if (!arg.match(/^\w+$/)) {
// Not a variable, it's complicated.
const varName = Python.nameDB_.getDistinctName(
const varName = pythonGenerator.nameDB_.getDistinctName(
variable0 + suffix, NameType.VARIABLE);
code += varName + ' = ' + arg + '\n';
arg = varName;
@@ -163,37 +166,38 @@ def ${Python.FUNCTION_NAME_PLACEHOLDER_}(start, stop, step):
return code;
};
Python.forBlock['controls_forEach'] = function(block) {
pythonGenerator.forBlock['controls_forEach'] = function(block) {
// For each loop.
const variable0 =
Python.nameDB_.getName(block.getFieldValue('VAR'), NameType.VARIABLE);
pythonGenerator.nameDB_.getName(
block.getFieldValue('VAR'), NameType.VARIABLE);
const argument0 =
Python.valueToCode(block, 'LIST', Python.ORDER_RELATIONAL) || '[]';
let branch = Python.statementToCode(block, 'DO');
branch = Python.addLoopTrap(branch, block) || Python.PASS;
pythonGenerator.valueToCode(block, 'LIST', Order.RELATIONAL) || '[]';
let branch = pythonGenerator.statementToCode(block, 'DO');
branch = pythonGenerator.addLoopTrap(branch, block) || pythonGenerator.PASS;
const code = 'for ' + variable0 + ' in ' + argument0 + ':\n' + branch;
return code;
};
Python.forBlock['controls_flow_statements'] = function(block) {
pythonGenerator.forBlock['controls_flow_statements'] = function(block) {
// Flow statements: continue, break.
let xfix = '';
if (Python.STATEMENT_PREFIX) {
if (pythonGenerator.STATEMENT_PREFIX) {
// Automatic prefix insertion is switched off for this block. Add manually.
xfix += Python.injectId(Python.STATEMENT_PREFIX, block);
xfix += pythonGenerator.injectId(pythonGenerator.STATEMENT_PREFIX, block);
}
if (Python.STATEMENT_SUFFIX) {
if (pythonGenerator.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 += Python.injectId(Python.STATEMENT_SUFFIX, block);
xfix += pythonGenerator.injectId(pythonGenerator.STATEMENT_SUFFIX, block);
}
if (Python.STATEMENT_PREFIX) {
if (pythonGenerator.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 += Python.injectId(Python.STATEMENT_PREFIX, loop);
xfix += pythonGenerator.injectId(pythonGenerator.STATEMENT_PREFIX, loop);
}
}
switch (block.getFieldValue('FLOW')) {