refactor(generators): Introduce JavascriptGenerator class, Order enum (#7153)

* refactor(generators): Introduce class JavascriptGenerator

  Also fix an import ordering error.

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

* refactor(generators): Don't rename javascriptGenerator
This commit is contained in:
Christopher Allen
2023-06-13 21:30:37 +01:00
committed by GitHub
parent 3e9d892934
commit 306eb80216
10 changed files with 770 additions and 713 deletions

View File

@@ -12,98 +12,112 @@ import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.JavaScript.procedures');
import {NameType} from '../../core/names.js';
import {javascriptGenerator as JavaScript} from '../javascript.js';
import {Order, javascriptGenerator} from '../javascript.js';
JavaScript.forBlock['procedures_defreturn'] = function(block) {
javascriptGenerator.forBlock['procedures_defreturn'] = function(block) {
// Define a procedure with a return value.
const funcName = JavaScript.nameDB_.getName(
const funcName = javascriptGenerator.nameDB_.getName(
block.getFieldValue('NAME'), NameType.PROCEDURE);
let xfix1 = '';
if (JavaScript.STATEMENT_PREFIX) {
xfix1 += JavaScript.injectId(JavaScript.STATEMENT_PREFIX, block);
if (javascriptGenerator.STATEMENT_PREFIX) {
xfix1 += javascriptGenerator.injectId(
javascriptGenerator.STATEMENT_PREFIX, block);
}
if (JavaScript.STATEMENT_SUFFIX) {
xfix1 += JavaScript.injectId(JavaScript.STATEMENT_SUFFIX, block);
if (javascriptGenerator.STATEMENT_SUFFIX) {
xfix1 += javascriptGenerator.injectId(
javascriptGenerator.STATEMENT_SUFFIX, block);
}
if (xfix1) {
xfix1 = JavaScript.prefixLines(xfix1, JavaScript.INDENT);
xfix1 = javascriptGenerator.prefixLines(xfix1, javascriptGenerator.INDENT);
}
let loopTrap = '';
if (JavaScript.INFINITE_LOOP_TRAP) {
loopTrap = JavaScript.prefixLines(
JavaScript.injectId(JavaScript.INFINITE_LOOP_TRAP, block),
JavaScript.INDENT);
if (javascriptGenerator.INFINITE_LOOP_TRAP) {
loopTrap = javascriptGenerator.prefixLines(
javascriptGenerator.injectId(
javascriptGenerator.INFINITE_LOOP_TRAP, block),
javascriptGenerator.INDENT);
}
const branch = JavaScript.statementToCode(block, 'STACK');
const branch = javascriptGenerator.statementToCode(block, 'STACK');
let returnValue =
JavaScript.valueToCode(block, 'RETURN', JavaScript.ORDER_NONE) || '';
javascriptGenerator.valueToCode(block, 'RETURN', Order.NONE) || '';
let xfix2 = '';
if (branch && returnValue) {
// After executing the function body, revisit this block for the return.
xfix2 = xfix1;
}
if (returnValue) {
returnValue = JavaScript.INDENT + 'return ' + returnValue + ';\n';
returnValue = javascriptGenerator.INDENT + 'return ' + returnValue + ';\n';
}
const args = [];
const variables = block.getVars();
for (let i = 0; i < variables.length; i++) {
args[i] = JavaScript.nameDB_.getName(variables[i], NameType.VARIABLE);
args[i] =
javascriptGenerator.nameDB_.getName(variables[i], NameType.VARIABLE);
}
let code = 'function ' + funcName + '(' + args.join(', ') + ') {\n' + xfix1 +
loopTrap + branch + xfix2 + returnValue + '}';
code = JavaScript.scrub_(block, code);
code = javascriptGenerator.scrub_(block, code);
// Add % so as not to collide with helper functions in definitions list.
JavaScript.definitions_['%' + funcName] = code;
javascriptGenerator.definitions_['%' + funcName] = code;
return null;
};
// Defining a procedure without a return value uses the same generator as
// a procedure with a return value.
JavaScript.forBlock['procedures_defnoreturn'] = JavaScript.forBlock['procedures_defreturn'];
javascriptGenerator.forBlock['procedures_defnoreturn'] =
javascriptGenerator.forBlock['procedures_defreturn'];
JavaScript.forBlock['procedures_callreturn'] = function(block) {
javascriptGenerator.forBlock['procedures_callreturn'] = function(block) {
// Call a procedure with a return value.
const funcName = JavaScript.nameDB_.getName(
const funcName = javascriptGenerator.nameDB_.getName(
block.getFieldValue('NAME'), NameType.PROCEDURE);
const args = [];
const variables = block.getVars();
for (let i = 0; i < variables.length; i++) {
args[i] = JavaScript.valueToCode(block, 'ARG' + i, JavaScript.ORDER_NONE) ||
args[i] = javascriptGenerator.valueToCode(block, 'ARG' + i, Order.NONE) ||
'null';
}
const code = funcName + '(' + args.join(', ') + ')';
return [code, JavaScript.ORDER_FUNCTION_CALL];
return [code, Order.FUNCTION_CALL];
};
JavaScript.forBlock['procedures_callnoreturn'] = function(block) {
javascriptGenerator.forBlock['procedures_callnoreturn'] = function(block) {
// Call a procedure with no return value.
// Generated code is for a function call as a statement is the same as a
// function call as a value, with the addition of line ending.
const tuple = JavaScript.forBlock['procedures_callreturn'](block);
const tuple = javascriptGenerator.forBlock['procedures_callreturn'](block);
return tuple[0] + ';\n';
};
JavaScript.forBlock['procedures_ifreturn'] = function(block) {
javascriptGenerator.forBlock['procedures_callnoreturn'] = function(block) {
// Call a procedure with no return value.
// Generated code is for a function call as a statement is the same as a
// function call as a value, with the addition of line ending.
const tuple = javascriptGenerator.forBlock['procedures_callreturn'](block);
return tuple[0] + ';\n';
};
javascriptGenerator.forBlock['procedures_ifreturn'] = function(block) {
// Conditionally return value from a procedure.
const condition =
JavaScript.valueToCode(block, 'CONDITION', JavaScript.ORDER_NONE) ||
javascriptGenerator.valueToCode(block, 'CONDITION', Order.NONE) ||
'false';
let code = 'if (' + condition + ') {\n';
if (JavaScript.STATEMENT_SUFFIX) {
if (javascriptGenerator.STATEMENT_SUFFIX) {
// Inject any statement suffix here since the regular one at the end
// will not get executed if the return is triggered.
code += JavaScript.prefixLines(
JavaScript.injectId(JavaScript.STATEMENT_SUFFIX, block),
JavaScript.INDENT);
code += javascriptGenerator.prefixLines(
javascriptGenerator.injectId(
javascriptGenerator.STATEMENT_SUFFIX, block),
javascriptGenerator.INDENT);
}
if (block.hasReturnValue_) {
const value =
JavaScript.valueToCode(block, 'VALUE', JavaScript.ORDER_NONE) || 'null';
code += JavaScript.INDENT + 'return ' + value + ';\n';
javascriptGenerator.valueToCode(block, 'VALUE', Order.NONE) || 'null';
code += javascriptGenerator.INDENT + 'return ' + value + ';\n';
} else {
code += JavaScript.INDENT + 'return;\n';
code += javascriptGenerator.INDENT + 'return;\n';
}
code += '}\n';
return code;