Files
blockly/generators/dart/lists.js
Christopher Allen 4d2201a427 chore(generators): Migrate generators to ES Modules (#7103)
* feat(j2ts): Add support for migrating renaming imports

  Convert
      const {foo: bar} = require(/*...*/);
  into
      import {foo as bar} from /*...*/;
              ^^^^^^^^^^

  Also fix a bug that caused relative paths to ESM in the same
  directory to be missing a leading "./".

* fix(build): Fix trivial error exports for generators

  The UMD wrapper was inadvertently exporting the contents of (e.g.)
  the Blockly.JavaScript closure module rather than the intended
  export of Blockly.JavaScript.all module - which went unnoticed
  because the latter just reexported the former - but we are
  about to convert the former to ESM.

* chore(generators): Migrate language generators to ESM

  Migrate the main language generators in generators/*.js to ESM.

  This was done by running js2ts on the files, renaming them back
  to .js, and commenting out "import type" statements, which are
  legal TS but not needed in JS (at least if you are not actually
  letting Closure Compiler do type checking, which we are not.)

* chore(generators): Migrate block generators to ESM

  Migrate generators/*/*.js (except all.js) to ESM.

  This was done by running js2ts on the files, renaming them back
  to .js, and removing now-spurious @suppress {extraRequire}
  directives.

* chores(generators): Migrate generator chunk entrypoints to ESM

  This was done by running js2ts on the files, renaming them back
  to .js, and manually fixing the export statements.

  An additional change to the chunk exports configuration in
  build_tasks.js was necessary in order for the UMD wrapper to
  find the new module object, which is given a different name
  than the old exports object.
2023-05-19 23:09:37 +01:00

432 lines
15 KiB
JavaScript

/**
* @license
* Copyright 2014 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Generating Dart for list blocks.
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.Dart.lists');
import {NameType} from '../../core/names.js';
import {dartGenerator as Dart} from '../dart.js';
Dart.addReservedWords('Math');
Dart['lists_create_empty'] = function(block) {
// Create an empty list.
return ['[]', Dart.ORDER_ATOMIC];
};
Dart['lists_create_with'] = function(block) {
// Create a list with any number of elements of any type.
const elements = new Array(block.itemCount_);
for (let i = 0; i < block.itemCount_; i++) {
elements[i] = Dart.valueToCode(block, 'ADD' + i, Dart.ORDER_NONE) || 'null';
}
const code = '[' + elements.join(', ') + ']';
return [code, Dart.ORDER_ATOMIC];
};
Dart['lists_repeat'] = function(block) {
// Create a list with one element repeated.
const element = Dart.valueToCode(block, 'ITEM', Dart.ORDER_NONE) || 'null';
const repeatCount = Dart.valueToCode(block, 'NUM', Dart.ORDER_NONE) || '0';
const code = 'new List.filled(' + repeatCount + ', ' + element + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
};
Dart['lists_length'] = function(block) {
// String or array length.
const list =
Dart.valueToCode(block, 'VALUE', Dart.ORDER_UNARY_POSTFIX) || '[]';
return [list + '.length', Dart.ORDER_UNARY_POSTFIX];
};
Dart['lists_isEmpty'] = function(block) {
// Is the string null or array empty?
const list =
Dart.valueToCode(block, 'VALUE', Dart.ORDER_UNARY_POSTFIX) || '[]';
return [list + '.isEmpty', Dart.ORDER_UNARY_POSTFIX];
};
Dart['lists_indexOf'] = function(block) {
// Find an item in the list.
const operator =
block.getFieldValue('END') === 'FIRST' ? 'indexOf' : 'lastIndexOf';
const item = Dart.valueToCode(block, 'FIND', Dart.ORDER_NONE) || "''";
const list =
Dart.valueToCode(block, 'VALUE', Dart.ORDER_UNARY_POSTFIX) || '[]';
const code = list + '.' + operator + '(' + item + ')';
if (block.workspace.options.oneBasedIndex) {
return [code + ' + 1', Dart.ORDER_ADDITIVE];
}
return [code, Dart.ORDER_UNARY_POSTFIX];
};
Dart['lists_getIndex'] = function(block) {
// Get element at index.
// Note: Until January 2013 this block did not have MODE or WHERE inputs.
const mode = block.getFieldValue('MODE') || 'GET';
const where = block.getFieldValue('WHERE') || 'FROM_START';
const listOrder = (where === 'RANDOM' || where === 'FROM_END') ?
Dart.ORDER_NONE :
Dart.ORDER_UNARY_POSTFIX;
let list = Dart.valueToCode(block, 'VALUE', listOrder) || '[]';
// Cache non-trivial values to variables to prevent repeated look-ups.
// Closure, which accesses and modifies 'list'.
function cacheList() {
const listVar = Dart.nameDB_.getDistinctName('tmp_list', NameType.VARIABLE);
const code = 'List ' + listVar + ' = ' + list + ';\n';
list = listVar;
return code;
}
// If `list` would be evaluated more than once (which is the case for
// RANDOM REMOVE and FROM_END) and is non-trivial, make sure to access it
// only once.
if (((where === 'RANDOM' && mode === 'REMOVE') || where === 'FROM_END') &&
!list.match(/^\w+$/)) {
// `list` is an expression, so we may not evaluate it more than once.
if (where === 'RANDOM') {
Dart.definitions_['import_dart_math'] = 'import \'dart:math\' as Math;';
// We can use multiple statements.
let code = cacheList();
const xVar = Dart.nameDB_.getDistinctName('tmp_x', NameType.VARIABLE);
code += 'int ' + xVar + ' = new Math.Random().nextInt(' + list +
'.length);\n';
code += list + '.removeAt(' + xVar + ');\n';
return code;
} else { // where === 'FROM_END'
if (mode === 'REMOVE') {
// We can use multiple statements.
const at = Dart.getAdjusted(block, 'AT', 1, false, Dart.ORDER_ADDITIVE);
let code = cacheList();
code += list + '.removeAt(' + list + '.length' +
' - ' + at + ');\n';
return code;
} else if (mode === 'GET') {
const at = Dart.getAdjusted(block, 'AT', 1);
// We need to create a procedure to avoid reevaluating values.
const functionName = Dart.provideFunction_('lists_get_from_end', `
dynamic ${Dart.FUNCTION_NAME_PLACEHOLDER_}(List my_list, num x) {
x = my_list.length - x;
return my_list[x];
}
`);
const code = functionName + '(' + list + ', ' + at + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'GET_REMOVE') {
const at = Dart.getAdjusted(block, 'AT', 1);
// We need to create a procedure to avoid reevaluating values.
const functionName = Dart.provideFunction_('lists_remove_from_end', `
dynamic ${Dart.FUNCTION_NAME_PLACEHOLDER_}(List my_list, num x) {
x = my_list.length - x;
return my_list.removeAt(x);
}
`);
const code = functionName + '(' + list + ', ' + at + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
}
}
} else {
// Either `list` is a simple variable, or we only need to refer to `list`
// once.
switch (where) {
case 'FIRST':
if (mode === 'GET') {
const code = list + '.first';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'GET_REMOVE') {
const code = list + '.removeAt(0)';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'REMOVE') {
return list + '.removeAt(0);\n';
}
break;
case 'LAST':
if (mode === 'GET') {
const code = list + '.last';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'GET_REMOVE') {
const code = list + '.removeLast()';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'REMOVE') {
return list + '.removeLast();\n';
}
break;
case 'FROM_START': {
const at = Dart.getAdjusted(block, 'AT');
if (mode === 'GET') {
const code = list + '[' + at + ']';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'GET_REMOVE') {
const code = list + '.removeAt(' + at + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'REMOVE') {
return list + '.removeAt(' + at + ');\n';
}
break;
}
case 'FROM_END': {
const at = Dart.getAdjusted(block, 'AT', 1, false, Dart.ORDER_ADDITIVE);
if (mode === 'GET') {
const code = list + '[' + list + '.length - ' + at + ']';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'GET_REMOVE' || mode === 'REMOVE') {
const code = list + '.removeAt(' + list + '.length - ' + at + ')';
if (mode === 'GET_REMOVE') {
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'REMOVE') {
return code + ';\n';
}
}
break;
}
case 'RANDOM':
Dart.definitions_['import_dart_math'] = 'import \'dart:math\' as Math;';
if (mode === 'REMOVE') {
// We can use multiple statements.
const xVar = Dart.nameDB_.getDistinctName('tmp_x', NameType.VARIABLE);
let code = 'int ' + xVar + ' = new Math.Random().nextInt(' + list +
'.length);\n';
code += list + '.removeAt(' + xVar + ');\n';
return code;
} else if (mode === 'GET') {
const functionName = Dart.provideFunction_('lists_get_random_item', `
dynamic ${Dart.FUNCTION_NAME_PLACEHOLDER_}(List my_list) {
int x = new Math.Random().nextInt(my_list.length);
return my_list[x];
}
`);
const code = functionName + '(' + list + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
} else if (mode === 'GET_REMOVE') {
const functionName =
Dart.provideFunction_('lists_remove_random_item', `
dynamic ${Dart.FUNCTION_NAME_PLACEHOLDER_}(List my_list) {
int x = new Math.Random().nextInt(my_list.length);
return my_list.removeAt(x);
}
`);
const code = functionName + '(' + list + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
}
break;
}
}
throw Error('Unhandled combination (lists_getIndex).');
};
Dart['lists_setIndex'] = function(block) {
// Set element at index.
// Note: Until February 2013 this block did not have MODE or WHERE inputs.
const mode = block.getFieldValue('MODE') || 'GET';
const where = block.getFieldValue('WHERE') || 'FROM_START';
let list = Dart.valueToCode(block, 'LIST', Dart.ORDER_UNARY_POSTFIX) || '[]';
const value = Dart.valueToCode(block, 'TO', Dart.ORDER_ASSIGNMENT) || 'null';
// Cache non-trivial values to variables to prevent repeated look-ups.
// Closure, which accesses and modifies 'list'.
function cacheList() {
if (list.match(/^\w+$/)) {
return '';
}
const listVar = Dart.nameDB_.getDistinctName('tmp_list', NameType.VARIABLE);
const code = 'List ' + listVar + ' = ' + list + ';\n';
list = listVar;
return code;
}
switch (where) {
case 'FIRST':
if (mode === 'SET') {
return list + '[0] = ' + value + ';\n';
} else if (mode === 'INSERT') {
return list + '.insert(0, ' + value + ');\n';
}
break;
case 'LAST':
if (mode === 'SET') {
let code = cacheList();
code += list + '[' + list + '.length - 1] = ' + value + ';\n';
return code;
} else if (mode === 'INSERT') {
return list + '.add(' + value + ');\n';
}
break;
case 'FROM_START': {
const at = Dart.getAdjusted(block, 'AT');
if (mode === 'SET') {
return list + '[' + at + '] = ' + value + ';\n';
} else if (mode === 'INSERT') {
return list + '.insert(' + at + ', ' + value + ');\n';
}
break;
}
case 'FROM_END': {
const at = Dart.getAdjusted(block, 'AT', 1, false, Dart.ORDER_ADDITIVE);
let code = cacheList();
if (mode === 'SET') {
code += list + '[' + list + '.length - ' + at + '] = ' + value + ';\n';
return code;
} else if (mode === 'INSERT') {
code += list + '.insert(' + list + '.length - ' + at + ', ' + value +
');\n';
return code;
}
break;
}
case 'RANDOM': {
Dart.definitions_['import_dart_math'] = 'import \'dart:math\' as Math;';
let code = cacheList();
const xVar = Dart.nameDB_.getDistinctName('tmp_x', NameType.VARIABLE);
code += 'int ' + xVar + ' = new Math.Random().nextInt(' + list +
'.length);\n';
if (mode === 'SET') {
code += list + '[' + xVar + '] = ' + value + ';\n';
return code;
} else if (mode === 'INSERT') {
code += list + '.insert(' + xVar + ', ' + value + ');\n';
return code;
}
break;
}
}
throw Error('Unhandled combination (lists_setIndex).');
};
Dart['lists_getSublist'] = function(block) {
// Get sublist.
const list =
Dart.valueToCode(block, 'LIST', Dart.ORDER_UNARY_POSTFIX) || '[]';
const where1 = block.getFieldValue('WHERE1');
const where2 = block.getFieldValue('WHERE2');
let code;
if (list.match(/^\w+$/) ||
(where1 !== 'FROM_END' && where2 === 'FROM_START')) {
// If the list is a is a variable or doesn't require a call for length,
// don't generate a helper function.
let at1;
switch (where1) {
case 'FROM_START':
at1 = Dart.getAdjusted(block, 'AT1');
break;
case 'FROM_END':
at1 = Dart.getAdjusted(block, 'AT1', 1, false, Dart.ORDER_ADDITIVE);
at1 = list + '.length - ' + at1;
break;
case 'FIRST':
at1 = '0';
break;
default:
throw Error('Unhandled option (lists_getSublist).');
}
let at2;
switch (where2) {
case 'FROM_START':
at2 = Dart.getAdjusted(block, 'AT2', 1);
break;
case 'FROM_END':
at2 = Dart.getAdjusted(block, 'AT2', 0, false, Dart.ORDER_ADDITIVE);
at2 = list + '.length - ' + at2;
break;
case 'LAST':
// There is no second index if LAST option is chosen.
break;
default:
throw Error('Unhandled option (lists_getSublist).');
}
if (where2 === 'LAST') {
code = list + '.sublist(' + at1 + ')';
} else {
code = list + '.sublist(' + at1 + ', ' + at2 + ')';
}
} else {
const at1 = Dart.getAdjusted(block, 'AT1');
const at2 = Dart.getAdjusted(block, 'AT2');
const functionName = Dart.provideFunction_('lists_get_sublist', `
List ${Dart.FUNCTION_NAME_PLACEHOLDER_}(List list, String where1, num at1, String where2, num at2) {
int getAt(String where, num at) {
if (where == 'FROM_END') {
at = list.length - 1 - at;
} else if (where == 'FIRST') {
at = 0;
} else if (where == 'LAST') {
at = list.length - 1;
} else if (where != 'FROM_START') {
throw 'Unhandled option (lists_getSublist).';
}
return at;
}
at1 = getAt(where1, at1);
at2 = getAt(where2, at2) + 1;
return list.sublist(at1, at2);
}
`);
code = functionName + '(' + list + ', \'' + where1 + '\', ' + at1 + ', \'' +
where2 + '\', ' + at2 + ')';
}
return [code, Dart.ORDER_UNARY_POSTFIX];
};
Dart['lists_sort'] = function(block) {
// Block for sorting a list.
const list = Dart.valueToCode(block, 'LIST', Dart.ORDER_NONE) || '[]';
const direction = block.getFieldValue('DIRECTION') === '1' ? 1 : -1;
const type = block.getFieldValue('TYPE');
const sortFunctionName = Dart.provideFunction_('lists_sort', `
List ${Dart.FUNCTION_NAME_PLACEHOLDER_}(List list, String type, int direction) {
var compareFuncs = {
'NUMERIC': (a, b) => (direction * a.compareTo(b)).toInt(),
'TEXT': (a, b) => direction * a.toString().compareTo(b.toString()),
'IGNORE_CASE':
(a, b) => direction *
a.toString().toLowerCase().compareTo(b.toString().toLowerCase())
};
list = new List.from(list);
var compare = compareFuncs[type];
list.sort(compare);
return list;
}
`);
return [
sortFunctionName + '(' + list + ', ' +
'"' + type + '", ' + direction + ')',
Dart.ORDER_UNARY_POSTFIX
];
};
Dart['lists_split'] = function(block) {
// Block for splitting text into a list, or joining a list into text.
let input = Dart.valueToCode(block, 'INPUT', Dart.ORDER_UNARY_POSTFIX);
const delimiter = Dart.valueToCode(block, 'DELIM', Dart.ORDER_NONE) || "''";
const mode = block.getFieldValue('MODE');
let functionName;
if (mode === 'SPLIT') {
if (!input) {
input = "''";
}
functionName = 'split';
} else if (mode === 'JOIN') {
if (!input) {
input = '[]';
}
functionName = 'join';
} else {
throw Error('Unknown mode: ' + mode);
}
const code = input + '.' + functionName + '(' + delimiter + ')';
return [code, Dart.ORDER_UNARY_POSTFIX];
};
Dart['lists_reverse'] = function(block) {
// Block for reversing a list.
const list = Dart.valueToCode(block, 'LIST', Dart.ORDER_NONE) || '[]';
// XXX What should the operator precedence be for a `new`?
const code = 'new List.from(' + list + '.reversed)';
return [code, Dart.ORDER_UNARY_POSTFIX];
};