blockly 7.20211209.2 → 8.0.0

package/core/names.js

@@ -27,23 +27,235 @@ goog.requireType('Blockly.Procedures');
 
 /**
  * Class for a database of entity names (variables, procedures, etc).
- * @param {string} reservedWords A comma-separated string of words that are
- *     illegal for use as names in a language (e.g. 'new,if,this,...').
- * @param {string=} opt_variablePrefix Some languages need a '$' or a namespace
- *     before all variable names (but not procedure names).
- * @constructor
  * @alias Blockly.Names
  */
-const Names = function(reservedWords, opt_variablePrefix) {
-  this.variablePrefix_ = opt_variablePrefix || '';
-  this.reservedDict_ = Object.create(null);
-  if (reservedWords) {
-    const splitWords = reservedWords.split(',');
-    for (let i = 0; i < splitWords.length; i++) {
-      this.reservedDict_[splitWords[i]] = true;
+const Names = class {
+  /**
+   * @param {string} reservedWords A comma-separated string of words that are
+   *     illegal for use as names in a language (e.g. 'new,if,this,...').
+   * @param {string=} opt_variablePrefix Some languages need a '$' or a
+   *     namespace before all variable names (but not procedure names).
+   */
+  constructor(reservedWords, opt_variablePrefix) {
+    /**
+     * The prefix to attach to variable names in generated code.
+     * @type {string}
+     * @private
+     */
+    this.variablePrefix_ = opt_variablePrefix || '';
+
+    /**
+     * A dictionary of reserved words.
+     * @type {Object}
+     * @private
+     */
+    this.reservedDict_ = Object.create(null);
+
+    /**
+     * A map from type (e.g. name, procedure) to maps from names to generated
+     * names.
+     * @type {Object<string, Object<string, string>>}
+     * @private
+     */
+    this.db_ = Object.create(null);
+
+    /**
+     * A map from used names to booleans to avoid collisions.
+     * @type {Object<string, boolean>}
+     * @private
+     */
+    this.dbReverse_ = Object.create(null);
+
+    /**
+     * The variable map from the workspace, containing Blockly variable models.
+     * @type {?VariableMap}
+     * @private
+     */
+    this.variableMap_ = null;
+
+    if (reservedWords) {
+      const splitWords = reservedWords.split(',');
+      for (let i = 0; i < splitWords.length; i++) {
+        this.reservedDict_[splitWords[i]] = true;
+      }
+    }
+    this.reset();
+  }
+
+  /**
+   * Empty the database and start from scratch.  The reserved words are kept.
+   */
+  reset() {
+    this.db_ = Object.create(null);
+    this.dbReverse_ = Object.create(null);
+    this.variableMap_ = null;
+  }
+
+  /**
+   * Set the variable map that maps from variable name to variable object.
+   * @param {!VariableMap} map The map to track.
+   */
+  setVariableMap(map) {
+    this.variableMap_ = map;
+  }
+
+  /**
+   * Get the name for a user-defined variable, based on its ID.
+   * This should only be used for variables of NameType VARIABLE.
+   * @param {string} id The ID to look up in the variable map.
+   * @return {?string} The name of the referenced variable, or null if there was
+   *     no variable map or the variable was not found in the map.
+   * @private
+   */
+  getNameForUserVariable_(id) {
+    if (!this.variableMap_) {
+      console.warn(
+          'Deprecated call to Names.prototype.getName without ' +
+          'defining a variable map. To fix, add the following code in your ' +
+          'generator\'s init() function:\n' +
+          'Blockly.YourGeneratorName.nameDB_.setVariableMap(' +
+          'workspace.getVariableMap());');
+      return null;
+    }
+    const variable = this.variableMap_.getVariableById(id);
+    if (variable) {
+      return variable.name;
+    }
+    return null;
+  }
+
+  /**
+   * Generate names for user variables, but only ones that are being used.
+   * @param {!Workspace} workspace Workspace to generate variables from.
+   */
+  populateVariables(workspace) {
+    const variables = Variables.allUsedVarModels(workspace);
+    for (let i = 0; i < variables.length; i++) {
+      this.getName(variables[i].getId(), NameType.VARIABLE);
+    }
+  }
+
+  /**
+   * Generate names for procedures.
+   * @param {!Workspace} workspace Workspace to generate procedures from.
+   */
+  populateProcedures(workspace) {
+    let procedures =
+        goog.module.get('Blockly.Procedures').allProcedures(workspace);
+    // Flatten the return vs no-return procedure lists.
+    procedures = procedures[0].concat(procedures[1]);
+    for (let i = 0; i < procedures.length; i++) {
+      this.getName(procedures[i][0], NameType.PROCEDURE);
+    }
+  }
+
+  /**
+   * Convert a Blockly entity name to a legal exportable entity name.
+   * @param {string} nameOrId The Blockly entity name (no constraints) or
+   *     variable ID.
+   * @param {NameType|string} type The type of the name in Blockly
+   *     ('VARIABLE', 'PROCEDURE', 'DEVELOPER_VARIABLE', etc...).
+   * @return {string} An entity name that is legal in the exported language.
+   */
+  getName(nameOrId, type) {
+    let name = nameOrId;
+    if (type === NameType.VARIABLE) {
+      const varName = this.getNameForUserVariable_(nameOrId);
+      if (varName) {
+        // Successful ID lookup.
+        name = varName;
+      }
     }
+    const normalizedName = name.toLowerCase();
+
+    const isVar =
+        type === NameType.VARIABLE || type === NameType.DEVELOPER_VARIABLE;
+
+    const prefix = isVar ? this.variablePrefix_ : '';
+    if (!(type in this.db_)) {
+      this.db_[type] = Object.create(null);
+    }
+    const typeDb = this.db_[type];
+    if (normalizedName in typeDb) {
+      return prefix + typeDb[normalizedName];
+    }
+    const safeName = this.getDistinctName(name, type);
+    typeDb[normalizedName] = safeName.substr(prefix.length);
+    return safeName;
+  }
+
+  /**
+   * Return a list of all known user-created names of a specified name type.
+   * @param {NameType|string} type The type of entity in Blockly
+   *     ('VARIABLE', 'PROCEDURE', 'DEVELOPER_VARIABLE', etc...).
+   * @return {!Array<string>} A list of Blockly entity names (no constraints).
+   */
+  getUserNames(type) {
+    const typeDb = this.db_[type] || {};
+    return Object.keys(typeDb);
+  }
+
+  /**
+   * Convert a Blockly entity name to a legal exportable entity name.
+   * Ensure that this is a new name not overlapping any previously defined name.
+   * Also check against list of reserved words for the current language and
+   * ensure name doesn't collide.
+   * @param {string} name The Blockly entity name (no constraints).
+   * @param {NameType|string} type The type of entity in Blockly
+   *     ('VARIABLE', 'PROCEDURE', 'DEVELOPER_VARIABLE', etc...).
+   * @return {string} An entity name that is legal in the exported language.
+   */
+  getDistinctName(name, type) {
+    let safeName = this.safeName_(name);
+    let i = '';
+    while (this.dbReverse_[safeName + i] ||
+           (safeName + i) in this.reservedDict_) {
+      // Collision with existing name.  Create a unique name.
+      i = i ? i + 1 : 2;
+    }
+    safeName += i;
+    this.dbReverse_[safeName] = true;
+    const isVar =
+        type === NameType.VARIABLE || type === NameType.DEVELOPER_VARIABLE;
+    const prefix = isVar ? this.variablePrefix_ : '';
+    return prefix + safeName;
+  }
+
+  /**
+   * Given a proposed entity name, generate a name that conforms to the
+   * [_A-Za-z][_A-Za-z0-9]* format that most languages consider legal for
+   * variable and function names.
+   * @param {string} name Potentially illegal entity name.
+   * @return {string} Safe entity name.
+   * @private
+   */
+  safeName_(name) {
+    if (!name) {
+      name = Msg['UNNAMED_KEY'] || 'unnamed';
+    } else {
+      // Unfortunately names in non-latin characters will look like
+      // _E9_9F_B3_E4_B9_90 which is pretty meaningless.
+      // https://github.com/google/blockly/issues/1654
+      name = encodeURI(name.replace(/ /g, '_')).replace(/[^\w]/g, '_');
+      // Most languages don't allow names with leading numbers.
+      if ('0123456789'.indexOf(name[0]) !== -1) {
+        name = 'my_' + name;
+      }
+    }
+    return name;
+  }
+
+  /**
+   * Do the given two entity names refer to the same entity?
+   * Blockly names are case-insensitive.
+   * @param {string} name1 First name.
+   * @param {string} name2 Second name.
+   * @return {boolean} True if names are the same.
+   */
+  static equals(name1, name2) {
+    // name1.localeCompare(name2) is slower.
+    return name1.toLowerCase() === name2.toLowerCase();
   }
-  this.reset();
 };
 
 /**
@@ -65,6 +277,10 @@ const NameType = {
 };
 exports.NameType = NameType;
 
+// We have to export NameType here so that it is accessible under the old name
+// `Blockly.Names.NameType`
+Names.NameType = NameType;
+
 /**
  * Constant to separate developer variable names from user-defined variable
  * names when running generators.
@@ -74,179 +290,4 @@ exports.NameType = NameType;
  */
 Names.DEVELOPER_VARIABLE_TYPE = NameType.DEVELOPER_VARIABLE;
 
-/**
- * Empty the database and start from scratch.  The reserved words are kept.
- */
-Names.prototype.reset = function() {
-  this.db_ = Object.create(null);
-  this.dbReverse_ = Object.create(null);
-  this.variableMap_ = null;
-};
-
-/**
- * Set the variable map that maps from variable name to variable object.
- * @param {!VariableMap} map The map to track.
- */
-Names.prototype.setVariableMap = function(map) {
-  this.variableMap_ = map;
-};
-
-/**
- * Get the name for a user-defined variable, based on its ID.
- * This should only be used for variables of NameType VARIABLE.
- * @param {string} id The ID to look up in the variable map.
- * @return {?string} The name of the referenced variable, or null if there was
- *     no variable map or the variable was not found in the map.
- * @private
- */
-Names.prototype.getNameForUserVariable_ = function(id) {
-  if (!this.variableMap_) {
-    console.warn(
-        'Deprecated call to Names.prototype.getName without ' +
-        'defining a variable map. To fix, add the following code in your ' +
-        'generator\'s init() function:\n' +
-        'Blockly.YourGeneratorName.nameDB_.setVariableMap(' +
-        'workspace.getVariableMap());');
-    return null;
-  }
-  const variable = this.variableMap_.getVariableById(id);
-  if (variable) {
-    return variable.name;
-  }
-  return null;
-};
-
-/**
- * Generate names for user variables, but only ones that are being used.
- * @param {!Workspace} workspace Workspace to generate variables from.
- */
-Names.prototype.populateVariables = function(workspace) {
-  const variables = Variables.allUsedVarModels(workspace);
-  for (let i = 0; i < variables.length; i++) {
-    this.getName(variables[i].getId(), NameType.VARIABLE);
-  }
-};
-
-/**
- * Generate names for procedures.
- * @param {!Workspace} workspace Workspace to generate procedures from.
- */
-Names.prototype.populateProcedures = function(workspace) {
-  let procedures =
-      goog.module.get('Blockly.Procedures').allProcedures(workspace);
-  // Flatten the return vs no-return procedure lists.
-  procedures = procedures[0].concat(procedures[1]);
-  for (let i = 0; i < procedures.length; i++) {
-    this.getName(procedures[i][0], NameType.PROCEDURE);
-  }
-};
-
-/**
- * Convert a Blockly entity name to a legal exportable entity name.
- * @param {string} nameOrId The Blockly entity name (no constraints) or
- *     variable ID.
- * @param {NameType|string} type The type of the name in Blockly
- *     ('VARIABLE', 'PROCEDURE', 'DEVELOPER_VARIABLE', etc...).
- * @return {string} An entity name that is legal in the exported language.
- */
-Names.prototype.getName = function(nameOrId, type) {
-  let name = nameOrId;
-  if (type === NameType.VARIABLE) {
-    const varName = this.getNameForUserVariable_(nameOrId);
-    if (varName) {
-      // Successful ID lookup.
-      name = varName;
-    }
-  }
-  const normalizedName = name.toLowerCase();
-
-  const isVar =
-      type === NameType.VARIABLE || type === NameType.DEVELOPER_VARIABLE;
-
-  const prefix = isVar ? this.variablePrefix_ : '';
-  if (!(type in this.db_)) {
-    this.db_[type] = Object.create(null);
-  }
-  const typeDb = this.db_[type];
-  if (normalizedName in typeDb) {
-    return prefix + typeDb[normalizedName];
-  }
-  const safeName = this.getDistinctName(name, type);
-  typeDb[normalizedName] = safeName.substr(prefix.length);
-  return safeName;
-};
-
-/**
- * Return a list of all known user-created names of a specified name type.
- * @param {NameType|string} type The type of entity in Blockly
- *     ('VARIABLE', 'PROCEDURE', 'DEVELOPER_VARIABLE', etc...).
- * @return {!Array<string>} A list of Blockly entity names (no constraints).
- */
-Names.prototype.getUserNames = function(type) {
-  const typeDb = this.db_[type] || {};
-  return Object.keys(typeDb);
-};
-
-/**
- * Convert a Blockly entity name to a legal exportable entity name.
- * Ensure that this is a new name not overlapping any previously defined name.
- * Also check against list of reserved words for the current language and
- * ensure name doesn't collide.
- * @param {string} name The Blockly entity name (no constraints).
- * @param {NameType|string} type The type of entity in Blockly
- *     ('VARIABLE', 'PROCEDURE', 'DEVELOPER_VARIABLE', etc...).
- * @return {string} An entity name that is legal in the exported language.
- */
-Names.prototype.getDistinctName = function(name, type) {
-  let safeName = this.safeName_(name);
-  let i = '';
-  while (this.dbReverse_[safeName + i] ||
-         (safeName + i) in this.reservedDict_) {
-    // Collision with existing name.  Create a unique name.
-    i = i ? i + 1 : 2;
-  }
-  safeName += i;
-  this.dbReverse_[safeName] = true;
-  const isVar =
-      type === NameType.VARIABLE || type === NameType.DEVELOPER_VARIABLE;
-  const prefix = isVar ? this.variablePrefix_ : '';
-  return prefix + safeName;
-};
-
-/**
- * Given a proposed entity name, generate a name that conforms to the
- * [_A-Za-z][_A-Za-z0-9]* format that most languages consider legal for
- * variable and function names.
- * @param {string} name Potentially illegal entity name.
- * @return {string} Safe entity name.
- * @private
- */
-Names.prototype.safeName_ = function(name) {
-  if (!name) {
-    name = Msg['UNNAMED_KEY'] || 'unnamed';
-  } else {
-    // Unfortunately names in non-latin characters will look like
-    // _E9_9F_B3_E4_B9_90 which is pretty meaningless.
-    // https://github.com/google/blockly/issues/1654
-    name = encodeURI(name.replace(/ /g, '_')).replace(/[^\w]/g, '_');
-    // Most languages don't allow names with leading numbers.
-    if ('0123456789'.indexOf(name[0]) !== -1) {
-      name = 'my_' + name;
-    }
-  }
-  return name;
-};
-
-/**
- * Do the given two entity names refer to the same entity?
- * Blockly names are case-insensitive.
- * @param {string} name1 First name.
- * @param {string} name2 Second name.
- * @return {boolean} True if names are the same.
- */
-Names.equals = function(name1, name2) {
-  // name1.localeCompare(name2) is slower.
-  return name1.toLowerCase() === name2.toLowerCase();
-};
-
 exports.Names = Names;