mirror of
https://github.com/google/blockly.git
synced 2025-12-16 14:20:10 +01:00
12b91ae49c
Addresses various nits that escaped previous PRs: * Add TSDoc for `BlockGenerator` in `core/generator.ts` for PR #7150. * Fix bad formating in `generators/javascript.js` from PR #7153. * Add missing `@enum` tag that should have been included in PR #7160. * Delete obsolete comment from `generators/python.js` for PR #7163.
342 lines
11 KiB
JavaScript
342 lines
11 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2012 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Helper functions for generating JavaScript for blocks.
|
|
* @suppress {checkTypes|globalThis}
|
|
*/
|
|
|
|
import * as goog from '../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.JavaScript');
|
|
|
|
import * as Variables from '../core/variables.js';
|
|
import * as stringUtils from '../core/utils/string.js';
|
|
// import type {Block} from '../core/block.js';
|
|
import {CodeGenerator} from '../core/generator.js';
|
|
import {Names, NameType} from '../core/names.js';
|
|
// import type {Workspace} from '../core/workspace.js';
|
|
import {inputTypes} from '../core/inputs/input_types.js';
|
|
|
|
|
|
/**
|
|
* Order of operation ENUMs.
|
|
* https://developer.mozilla.org/en/JavaScript/Reference/Operators/Operator_Precedence
|
|
* @enum {number}
|
|
*/
|
|
export const Order = {
|
|
ATOMIC: 0, // 0 "" ...
|
|
NEW: 1.1, // new
|
|
MEMBER: 1.2, // . []
|
|
FUNCTION_CALL: 2, // ()
|
|
INCREMENT: 3, // ++
|
|
DECREMENT: 3, // --
|
|
BITWISE_NOT: 4.1, // ~
|
|
UNARY_PLUS: 4.2, // +
|
|
UNARY_NEGATION: 4.3, // -
|
|
LOGICAL_NOT: 4.4, // !
|
|
TYPEOF: 4.5, // typeof
|
|
VOID: 4.6, // void
|
|
DELETE: 4.7, // delete
|
|
AWAIT: 4.8, // await
|
|
EXPONENTIATION: 5.0, // **
|
|
MULTIPLICATION: 5.1, // *
|
|
DIVISION: 5.2, // /
|
|
MODULUS: 5.3, // %
|
|
SUBTRACTION: 6.1, // -
|
|
ADDITION: 6.2, // +
|
|
BITWISE_SHIFT: 7, // << >> >>>
|
|
RELATIONAL: 8, // < <= > >=
|
|
IN: 8, // in
|
|
INSTANCEOF: 8, // instanceof
|
|
EQUALITY: 9, // == != === !==
|
|
BITWISE_AND: 10, // &
|
|
BITWISE_XOR: 11, // ^
|
|
BITWISE_OR: 12, // |
|
|
LOGICAL_AND: 13, // &&
|
|
LOGICAL_OR: 14, // ||
|
|
CONDITIONAL: 15, // ?:
|
|
ASSIGNMENT: 16, //: += -= **= *= /= %= <<= >>= ...
|
|
YIELD: 17, // yield
|
|
COMMA: 18, // ,
|
|
NONE: 99, // (...)
|
|
};
|
|
|
|
/**
|
|
* JavaScript code generator class.
|
|
*/
|
|
export class JavascriptGenerator extends CodeGenerator {
|
|
/**
|
|
* List of outer-inner pairings that do NOT require parentheses.
|
|
* @type {!Array<!Array<number>>}
|
|
*/
|
|
ORDER_OVERRIDES = [
|
|
// (foo()).bar -> foo().bar
|
|
// (foo())[0] -> foo()[0]
|
|
[Order.FUNCTION_CALL, Order.MEMBER],
|
|
// (foo())() -> foo()()
|
|
[Order.FUNCTION_CALL, Order.FUNCTION_CALL],
|
|
// (foo.bar).baz -> foo.bar.baz
|
|
// (foo.bar)[0] -> foo.bar[0]
|
|
// (foo[0]).bar -> foo[0].bar
|
|
// (foo[0])[1] -> foo[0][1]
|
|
[Order.MEMBER, Order.MEMBER],
|
|
// (foo.bar)() -> foo.bar()
|
|
// (foo[0])() -> foo[0]()
|
|
[Order.MEMBER, Order.FUNCTION_CALL],
|
|
|
|
// !(!foo) -> !!foo
|
|
[Order.LOGICAL_NOT, Order.LOGICAL_NOT],
|
|
// a * (b * c) -> a * b * c
|
|
[Order.MULTIPLICATION, Order.MULTIPLICATION],
|
|
// a + (b + c) -> a + b + c
|
|
[Order.ADDITION, Order.ADDITION],
|
|
// a && (b && c) -> a && b && c
|
|
[Order.LOGICAL_AND, Order.LOGICAL_AND],
|
|
// a || (b || c) -> a || b || c
|
|
[Order.LOGICAL_OR, Order.LOGICAL_OR]
|
|
];
|
|
|
|
constructor(name) {
|
|
super(name ?? 'JavaScript');
|
|
this.isInitialized = false;
|
|
|
|
// Copy Order values onto instance for backwards compatibility
|
|
// while ensuring they are not part of the publically-advertised
|
|
// API.
|
|
//
|
|
// TODO(#7085): deprecate these in due course. (Could initially
|
|
// replace data properties with get accessors that call
|
|
// deprecate.warn().)
|
|
for (const key in Order) {
|
|
this['ORDER_' + key] = Order[key];
|
|
}
|
|
|
|
// List of illegal variable names. This is not intended to be a
|
|
// security feature. Blockly is 100% client-side, so bypassing
|
|
// this list is trivial. This is intended to prevent users from
|
|
// accidentally clobbering a built-in object or function.
|
|
this.addReservedWords(
|
|
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#Keywords
|
|
'break,case,catch,class,const,continue,debugger,default,delete,do,' +
|
|
'else,export,extends,finally,for,function,if,import,in,instanceof,' +
|
|
'new,return,super,switch,this,throw,try,typeof,var,void,' +
|
|
'while,with,yield,' +
|
|
'enum,' +
|
|
'implements,interface,let,package,private,protected,public,static,' +
|
|
'await,' +
|
|
'null,true,false,' +
|
|
// Magic variable.
|
|
'arguments,' +
|
|
// Everything in the current environment (835 items in Chrome,
|
|
// 104 in Node).
|
|
Object.getOwnPropertyNames(globalThis).join(',')
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Initialise the database of variable names.
|
|
* @param {!Workspace} workspace Workspace to generate code from.
|
|
*/
|
|
init(workspace) {
|
|
super.init(workspace);
|
|
|
|
if (!this.nameDB_) {
|
|
this.nameDB_ = new Names(this.RESERVED_WORDS_);
|
|
} else {
|
|
this.nameDB_.reset();
|
|
}
|
|
|
|
this.nameDB_.setVariableMap(workspace.getVariableMap());
|
|
this.nameDB_.populateVariables(workspace);
|
|
this.nameDB_.populateProcedures(workspace);
|
|
|
|
const defvars = [];
|
|
// Add developer variables (not created or named by the user).
|
|
const devVarList = Variables.allDeveloperVariables(workspace);
|
|
for (let i = 0; i < devVarList.length; i++) {
|
|
defvars.push(
|
|
this.nameDB_.getName(devVarList[i], NameType.DEVELOPER_VARIABLE));
|
|
}
|
|
|
|
// Add user variables, but only ones that are being used.
|
|
const variables = Variables.allUsedVarModels(workspace);
|
|
for (let i = 0; i < variables.length; i++) {
|
|
defvars.push(
|
|
this.nameDB_.getName(variables[i].getId(), NameType.VARIABLE));
|
|
}
|
|
|
|
// Declare all of the variables.
|
|
if (defvars.length) {
|
|
this.definitions_['variables'] = 'var ' + defvars.join(', ') + ';';
|
|
}
|
|
this.isInitialized = true;
|
|
}
|
|
|
|
/**
|
|
* Prepend the generated code with the variable definitions.
|
|
* @param {string} code Generated code.
|
|
* @return {string} Completed code.
|
|
*/
|
|
finish(code) {
|
|
// Convert the definitions dictionary into a list.
|
|
const definitions = Object.values(this.definitions_);
|
|
// Call Blockly.CodeGenerator's finish.
|
|
super.finish(code);
|
|
this.isInitialized = false;
|
|
|
|
this.nameDB_.reset();
|
|
return definitions.join('\n\n') + '\n\n\n' + code;
|
|
}
|
|
|
|
/**
|
|
* Naked values are top-level blocks with outputs that aren't plugged into
|
|
* anything. A trailing semicolon is needed to make this legal.
|
|
* @param {string} line Line of generated code.
|
|
* @return {string} Legal line of code.
|
|
*/
|
|
scrubNakedValue(line) {
|
|
return line + ';\n';
|
|
}
|
|
|
|
/**
|
|
* Encode a string as a properly escaped JavaScript string, complete with
|
|
* quotes.
|
|
* @param {string} string Text to encode.
|
|
* @return {string} JavaScript string.
|
|
* @protected
|
|
*/
|
|
quote_(string) {
|
|
// Can't use goog.string.quote since Google's style guide recommends
|
|
// JS string literals use single quotes.
|
|
string = string.replace(/\\/g, '\\\\')
|
|
.replace(/\n/g, '\\\n')
|
|
.replace(/'/g, '\\\'');
|
|
return '\'' + string + '\'';
|
|
}
|
|
|
|
/**
|
|
* Encode a string as a properly escaped multiline JavaScript string, complete
|
|
* with quotes.
|
|
* @param {string} string Text to encode.
|
|
* @return {string} JavaScript string.
|
|
* @protected
|
|
*/
|
|
multiline_quote_(string) {
|
|
// Can't use goog.string.quote since Google's style guide recommends
|
|
// JS string literals use single quotes.
|
|
const lines = string.split(/\n/g).map(this.quote_);
|
|
return lines.join(' + \'\\n\' +\n');
|
|
}
|
|
|
|
/**
|
|
* Common tasks for generating JavaScript from blocks.
|
|
* Handles comments for the specified block and any connected value blocks.
|
|
* Calls any statements following this block.
|
|
* @param {!Block} block The current block.
|
|
* @param {string} code The JavaScript code created for this block.
|
|
* @param {boolean=} opt_thisOnly True to generate code for only this
|
|
* statement.
|
|
* @return {string} JavaScript code with comments and subsequent blocks added.
|
|
* @protected
|
|
*/
|
|
scrub_(block, code, opt_thisOnly) {
|
|
let commentCode = '';
|
|
// Only collect comments for blocks that aren't inline.
|
|
if (!block.outputConnection || !block.outputConnection.targetConnection) {
|
|
// Collect comment for this block.
|
|
let comment = block.getCommentText();
|
|
if (comment) {
|
|
comment = stringUtils.wrap(comment, this.COMMENT_WRAP - 3);
|
|
commentCode += this.prefixLines(comment + '\n', '// ');
|
|
}
|
|
// Collect comments for all value arguments.
|
|
// Don't collect comments for nested statements.
|
|
for (let i = 0; i < block.inputList.length; i++) {
|
|
if (block.inputList[i].type === inputTypes.VALUE) {
|
|
const childBlock = block.inputList[i].connection.targetBlock();
|
|
if (childBlock) {
|
|
comment = this.allNestedComments(childBlock);
|
|
if (comment) {
|
|
commentCode += this.prefixLines(comment, '// ');
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
const nextBlock =
|
|
block.nextConnection && block.nextConnection.targetBlock();
|
|
const nextCode = opt_thisOnly ? '' : this.blockToCode(nextBlock);
|
|
return commentCode + code + nextCode;
|
|
}
|
|
|
|
/**
|
|
* Gets a property and adjusts the value while taking into account indexing.
|
|
* @param {!Block} block The block.
|
|
* @param {string} atId The property ID of the element to get.
|
|
* @param {number=} opt_delta Value to add.
|
|
* @param {boolean=} opt_negate Whether to negate the value.
|
|
* @param {number=} opt_order The highest order acting on this value.
|
|
* @return {string|number}
|
|
*/
|
|
getAdjusted(block, atId, opt_delta, opt_negate, opt_order) {
|
|
let delta = opt_delta || 0;
|
|
let order = opt_order || this.ORDER_NONE;
|
|
if (block.workspace.options.oneBasedIndex) {
|
|
delta--;
|
|
}
|
|
const defaultAtIndex = block.workspace.options.oneBasedIndex ? '1' : '0';
|
|
|
|
let innerOrder;
|
|
let outerOrder = order;
|
|
if (delta > 0) {
|
|
outerOrder = this.ORDER_ADDITION;
|
|
innerOrder = this.ORDER_ADDITION;
|
|
} else if (delta < 0) {
|
|
outerOrder = this.ORDER_SUBTRACTION;
|
|
innerOrder = this.ORDER_SUBTRACTION;
|
|
} else if (opt_negate) {
|
|
outerOrder = this.ORDER_UNARY_NEGATION;
|
|
innerOrder = this.ORDER_UNARY_NEGATION;
|
|
}
|
|
|
|
let at = this.valueToCode(block, atId, outerOrder) || defaultAtIndex;
|
|
|
|
if (stringUtils.isNumber(at)) {
|
|
// If the index is a naked number, adjust it right now.
|
|
at = Number(at) + delta;
|
|
if (opt_negate) {
|
|
at = -at;
|
|
}
|
|
} else {
|
|
// If the index is dynamic, adjust it in code.
|
|
if (delta > 0) {
|
|
at = at + ' + ' + delta;
|
|
} else if (delta < 0) {
|
|
at = at + ' - ' + -delta;
|
|
}
|
|
if (opt_negate) {
|
|
if (delta) {
|
|
at = '-(' + at + ')';
|
|
} else {
|
|
at = '-' + at;
|
|
}
|
|
}
|
|
innerOrder = Math.floor(innerOrder);
|
|
order = Math.floor(order);
|
|
if (innerOrder && order >= innerOrder) {
|
|
at = '(' + at + ')';
|
|
}
|
|
}
|
|
return at;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* JavaScript code generator instance.
|
|
* @type {!JavascriptGenerator}
|
|
*/
|
|
export const javascriptGenerator = new JavascriptGenerator();
|