mirror of
https://github.com/google/blockly.git
synced 2026-01-10 02:17:09 +01:00
Create separate file for VariableMap and its functions.
This commit is contained in:
marisaleung
214
core/variable_map.js
Normal file
214
core/variable_map.js
Normal file
@@ -0,0 +1,214 @@
|
||||
/**
|
||||
* @license
|
||||
* Visual Blocks Editor
|
||||
*
|
||||
* Copyright 2017 Google Inc.
|
||||
* https://developers.google.com/blockly/
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @fileoverview Object representing a map of variables and their types.
|
||||
* @author marisaleung@google.com (Marisa Leung)
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
goog.provide('Blockly.VariableMap');
|
||||
|
||||
/**
|
||||
* Class for a variable map. This contains a dictionary data structure with
|
||||
* variable types as keys and lists of variables as values. The list of
|
||||
* variables are the type indicated by the key.
|
||||
* @constructor
|
||||
*/
|
||||
Blockly.VariableMap = function() {
|
||||
/**
|
||||
* @type {!Object<string, !Array.<Blockly.VariableModel>>}
|
||||
* A map from variable type to list of variable names. The lists contain all
|
||||
* of the named variables in the workspace, including variables
|
||||
* that are not currently in use.
|
||||
* @private
|
||||
*/
|
||||
this.variableMap_ = {};
|
||||
};
|
||||
|
||||
/**
|
||||
* Clear the variable map.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.clear = function() {
|
||||
this.variableMap_ = {};
|
||||
};
|
||||
|
||||
/**
|
||||
* Rename a variable by updating its name in the variable map. Identify the
|
||||
* variable to rename with the given variable.
|
||||
* TODO: #468
|
||||
* @param {?Blockly.VariableModel} variable Variable to rename.
|
||||
* @param {string} newName New variable name.
|
||||
* @param {?string} oldCase The oldCase to replace with newName.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.renameVariable = function(variable, newName, oldCase) {
|
||||
var newVariable = this.getVariable(newName);
|
||||
var variableIndex = -1;
|
||||
var newVariableIndex = -1;
|
||||
var type = (variable || newVariable || '').type;
|
||||
var variableList = this.getVariablesOfType(type);
|
||||
if (variable) {
|
||||
variableIndex = variableList.indexOf(variable);
|
||||
}
|
||||
if (newVariable){ // see if I can get rid of newVariable dependency
|
||||
newVariableIndex = variableList.indexOf(newVariable);
|
||||
}
|
||||
|
||||
if (variableIndex == -1 && newVariableIndex == -1) {
|
||||
this.createVariable(newName, '');
|
||||
console.log('Tried to rename an non-existent variable.');
|
||||
}
|
||||
else if (variableIndex == newVariableIndex ||
|
||||
variableIndex != -1 && newVariableIndex == -1) {
|
||||
// Only changing case, or renaming to a completely novel name.
|
||||
if (oldCase) {
|
||||
this.variableMap_[type][newVariableIndex].name = newName;
|
||||
}
|
||||
else {
|
||||
this.variableMap_[type][variableIndex].name = newName;
|
||||
}
|
||||
} else if (variableIndex != -1 && newVariableIndex != -1) {
|
||||
// Renaming one existing variable to another existing variable.
|
||||
// The case might have changed, so we update the destination ID.
|
||||
this.variableMap_[type][newVariableIndex].name = newName;
|
||||
this.variableMap_[type].splice(variableIndex, 1);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Create a variable with a given name, optional type, and optional id.
|
||||
* @param {!string} name The name of the variable. This must be unique across
|
||||
* variables and procedures.
|
||||
* @param {?string} opt_type The type of the variable like 'int' or 'string'.
|
||||
* Does not need to be unique. Field_variable can filter variables based on
|
||||
* their type. This will default to '' which is a specific type.
|
||||
* @param {?string} opt_id The unique id of the variable. This will default to
|
||||
* a UUID.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.createVariable = function(name, opt_type, opt_id) {
|
||||
if (this.getVariable(name)) {
|
||||
return;
|
||||
}
|
||||
if (opt_id && this.getVariableById(opt_id)) {
|
||||
throw Error('Variable id, "' + opt_id + '", is already in use.');
|
||||
}
|
||||
opt_id = opt_id || Blockly.utils.genUid();
|
||||
opt_type = opt_type || '';
|
||||
|
||||
var variable = new Blockly.VariableModel(name, opt_type, opt_id);
|
||||
// If opt_type is not a key, create a new list.
|
||||
if (!this.variableMap_[opt_type]) {
|
||||
this.variableMap_[opt_type] = [variable];
|
||||
}
|
||||
// Else append the variable to the preexisting list.
|
||||
else {
|
||||
this.variableMap_[opt_type].push(variable);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Delete a variable.
|
||||
* @param {Blockly.VariableModel} variable Variable to delete.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.deleteVariable = function(variable) {
|
||||
var type = variable.type;
|
||||
for (var i = 0, tempVar; tempVar = this.variableMap_[type][i]; i++) {
|
||||
if (Blockly.Names.equals(tempVar.name, variable.name)) {
|
||||
delete this.variableMap_[type][i];
|
||||
this.variableMap_[type].splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Find the variable by the given name and return it. Return null if it is not
|
||||
* found.
|
||||
* @param {!string} name The name to check for.
|
||||
* @return {?Blockly.VariableModel} the variable with the given name.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.getVariable = function(name) {
|
||||
var keys = Object.keys(this.variableMap_);
|
||||
for (var i = 0; i < keys.length; i++ ) {
|
||||
var key = keys[i];
|
||||
for (var j = 0, variable; variable = this.variableMap_[key][j]; j++) {
|
||||
if (Blockly.Names.equals(variable.name, name)) {
|
||||
return variable;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
/**
|
||||
* Find the variable by the given id and return it. Return null if it is not
|
||||
* found.
|
||||
* @param {!string} id The id to check for.
|
||||
* @return {?Blockly.VariableModel} The variable with the given id.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.getVariableById = function(id) {
|
||||
var keys = Object.keys(this.variableMap_);
|
||||
for (var i = 0; i < keys.length; i++ ) {
|
||||
var key = keys[i];
|
||||
for (var j = 0, variable; variable = this.variableMap_[key][j]; j++) {
|
||||
if (variable.getId() == id) {
|
||||
return variable;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
/**
|
||||
* Find the variable with the specified type. If type is null, return list of
|
||||
* variables with empty string type.
|
||||
* @param {?string} type Type of the variables to find.
|
||||
* @return {Array.<Blockly.VariableModel>} The sought after variables of the
|
||||
* passed in type. An empty array if none are found.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.getVariablesOfType = function(type) {
|
||||
type = type || '';
|
||||
var variable_list = this.variableMap_[type];
|
||||
if (variable_list) {
|
||||
return variable_list;
|
||||
}
|
||||
return [];
|
||||
};
|
||||
|
||||
/**
|
||||
* Return all variable types.
|
||||
* @return {!Array.<string>} List of variable types.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.getVariableTypes = function() {
|
||||
return Object.keys(this.variableMap_);
|
||||
};
|
||||
|
||||
/**
|
||||
* Return all variables of all types.
|
||||
* @return {!Array.<Blockly.VariableModel>} List of variable models.
|
||||
*/
|
||||
Blockly.VariableMap.prototype.getAllVariables = function() {
|
||||
var all_variables = [];
|
||||
var keys = Object.keys(this.variableMap_);
|
||||
for (var i = 0; i < keys.length; i++ ) {
|
||||
all_variables = all_variables.concat(this.variableMap_[keys[i]]);
|
||||
}
|
||||
return all_variables;
|
||||
};
|
||||
@@ -76,13 +76,13 @@ Blockly.Workspace = function(opt_options) {
|
||||
this.blockDB_ = Object.create(null);
|
||||
|
||||
/**
|
||||
* @type {!Object<string, !Array.<Blockly.VariableModel>>}
|
||||
* @type {!Blockly.VariableMap}
|
||||
* A map from variable type to list of variable names. The lists contain all
|
||||
* of the named variables in the workspace, including variables
|
||||
* that are not currently in use.
|
||||
* @private
|
||||
*/
|
||||
this.variableMap_ = {};
|
||||
this.variableMap_ = new Blockly.VariableMap();
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -195,7 +195,7 @@ Blockly.Workspace.prototype.clear = function() {
|
||||
if (!existingGroup) {
|
||||
Blockly.Events.setGroup(false);
|
||||
}
|
||||
this.variableMap_ = {};
|
||||
this.variableMap_.clear();
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -225,7 +225,7 @@ Blockly.Workspace.prototype.updateVariableStore = function(clear) {
|
||||
}
|
||||
}
|
||||
if (clear) {
|
||||
this.variableMap_ = {};
|
||||
this.variableMap_.clear();
|
||||
}
|
||||
for (var i = 0, varDict; varDict = varList[i]; i++) {
|
||||
if (!this.getVariable(varDict.name)) {
|
||||
@@ -244,8 +244,6 @@ Blockly.Workspace.prototype.updateVariableStore = function(clear) {
|
||||
Blockly.Workspace.prototype.renameVariableInternal_ = function(variable, newName) {
|
||||
var newVariable = this.getVariable(newName);
|
||||
var oldCase;
|
||||
var variableIndex = -1;
|
||||
var newVariableIndex = -1;
|
||||
|
||||
// If they are different types, throw an error.
|
||||
if (variable && newVariable && variable.type != newVariable.type) {
|
||||
@@ -253,17 +251,9 @@ Blockly.Workspace.prototype.renameVariableInternal_ = function(variable, newName
|
||||
'" and variable "' + newName + '" is type "' + newVariable.type +
|
||||
'". Both must be the same type.');
|
||||
}
|
||||
var type = (variable || newVariable || '').type;
|
||||
var variableList = this.getVariablesOfType(type);
|
||||
if (variable) {
|
||||
variableIndex = variableList.indexOf(variable);
|
||||
}
|
||||
if (newVariable){
|
||||
newVariableIndex = variableList.indexOf(newVariable);
|
||||
}
|
||||
|
||||
// Find if newVariable case is different.
|
||||
if (newVariableIndex != -1 && newVariable.name != newName) {
|
||||
if (newVariable && newVariable.name != newName) {
|
||||
oldCase = newVariable.name;
|
||||
}
|
||||
|
||||
@@ -278,25 +268,7 @@ Blockly.Workspace.prototype.renameVariableInternal_ = function(variable, newName
|
||||
}
|
||||
Blockly.Events.setGroup(false);
|
||||
|
||||
if (variableIndex == -1 && newVariableIndex == -1) {
|
||||
this.createVariable(newName, '');
|
||||
console.log('Tried to rename an non-existent variable.');
|
||||
}
|
||||
else if (variableIndex == newVariableIndex ||
|
||||
variableIndex != -1 && newVariableIndex == -1) {
|
||||
// Only changing case, or renaming to a completely novel name.
|
||||
if (oldCase) {
|
||||
this.variableMap_[type][newVariableIndex].name = newName;
|
||||
}
|
||||
else {
|
||||
this.variableMap_[type][variableIndex].name = newName;
|
||||
}
|
||||
} else if (variableIndex != -1 && newVariableIndex != -1) {
|
||||
// Renaming one existing variable to another existing variable.
|
||||
// The case might have changed, so we update the destination ID.
|
||||
this.variableMap_[type][newVariableIndex].name = newName;
|
||||
this.variableMap_[type].splice(variableIndex, 1);
|
||||
}
|
||||
this.variableMap_.renameVariable(variable, newName, oldCase);
|
||||
};
|
||||
|
||||
|
||||
@@ -335,24 +307,7 @@ Blockly.Workspace.prototype.renameVariableById = function(id, newName) {
|
||||
* a UUID.
|
||||
*/
|
||||
Blockly.Workspace.prototype.createVariable = function(name, opt_type, opt_id) {
|
||||
if (this.getVariable(name)) {
|
||||
return;
|
||||
}
|
||||
if (opt_id && this.getVariableById(opt_id)) {
|
||||
throw Error('Variable id, "' + opt_id + '", is already in use.');
|
||||
}
|
||||
opt_id = opt_id || Blockly.utils.genUid();
|
||||
opt_type = opt_type || '';
|
||||
|
||||
var variable = new Blockly.VariableModel(name, opt_type, opt_id);
|
||||
// If opt_type is not a key, create a new list.
|
||||
if (!this.variableMap_[opt_type]) {
|
||||
this.variableMap_[opt_type] = [variable];
|
||||
}
|
||||
// Else append the variable to the preexisting list.
|
||||
else {
|
||||
this.variableMap_[opt_type].push(variable);
|
||||
}
|
||||
this.variableMap_.createVariable(name, opt_type, opt_id);
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -443,14 +398,7 @@ Blockly.Workspace.prototype.deleteVariableInternal_ = function(variable) {
|
||||
}
|
||||
Blockly.Events.setGroup(false);
|
||||
|
||||
var type = variable.type;
|
||||
for (var i = 0, tempVar; tempVar = this.variableMap_[type][i]; i++) {
|
||||
if (Blockly.Names.equals(tempVar.name, variable.name)) {
|
||||
delete this.variableMap_[type][i];
|
||||
this.variableMap_[type].splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
this.variableMap_.deleteVariable(variable);
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -474,16 +422,7 @@ Blockly.Workspace.prototype.variableIndexOf = function(name) {
|
||||
* @return {?Blockly.VariableModel} the variable with the given name.
|
||||
*/
|
||||
Blockly.Workspace.prototype.getVariable = function(name) {
|
||||
var keys = Object.keys(this.variableMap_);
|
||||
for (var i = 0; i < keys.length; i++ ) {
|
||||
var key = keys[i];
|
||||
for (var j = 0, variable; variable = this.variableMap_[key][j]; j++) {
|
||||
if (Blockly.Names.equals(variable.name, name)) {
|
||||
return variable;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
return this.variableMap_.getVariable(name);
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -493,14 +432,7 @@ Blockly.Workspace.prototype.getVariable = function(name) {
|
||||
* @return {?Blockly.VariableModel} The variable with the given id.
|
||||
*/
|
||||
Blockly.Workspace.prototype.getVariableById = function(id) {
|
||||
for (var key of Object.keys(this.variableMap_)) {
|
||||
for (var variable of this.variableMap_[key]) {
|
||||
if (variable.getId() == id) {
|
||||
return variable;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
return this.variableMap_.getVariableById(id);
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -646,12 +578,7 @@ Blockly.Workspace.prototype.allInputsFilled = function(opt_shadowBlocksAreFilled
|
||||
* passed in type. An empty array if none are found.
|
||||
*/
|
||||
Blockly.Workspace.prototype.getVariablesOfType = function(type) {
|
||||
type = type || '';
|
||||
var variable_list = this.variableMap_[type];
|
||||
if (variable_list) {
|
||||
return variable_list;
|
||||
}
|
||||
return [];
|
||||
return this.variableMap_.getVariablesOfType(type);
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -659,7 +586,7 @@ Blockly.Workspace.prototype.getVariablesOfType = function(type) {
|
||||
* @return {!Array.<string>} List of variable types.
|
||||
*/
|
||||
Blockly.Workspace.prototype.getVariableTypes = function() {
|
||||
return Object.keys(this.variableMap_);
|
||||
return this.variableMap_.getVariableTypes();
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -667,12 +594,7 @@ Blockly.Workspace.prototype.getVariableTypes = function() {
|
||||
* @return {!Array.<Blockly.VariableModel>} List of variable models.
|
||||
*/
|
||||
Blockly.Workspace.prototype.getAllVariables = function() {
|
||||
var all_variables = [];
|
||||
var keys = Object.keys(this.variableMap_);
|
||||
for (var i = 0; i < keys.length; i++ ) {
|
||||
all_variables = all_variables.concat(this.variableMap_[keys[i]]);
|
||||
}
|
||||
return all_variables;
|
||||
return this.variableMap_.getAllVariables();
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -286,17 +286,8 @@ function test_createVariable_AlreadyExists() {
|
||||
// Expect that when the variable already exists, the variableMap_ is unchanged.
|
||||
workspaceTest_setUp();
|
||||
var var_1 = this.createAndGetVariable('name1', 'type1', 'id1');
|
||||
// Assert there is only one variable in the workspace.
|
||||
var keys = Object.keys(workspace.variableMap_);
|
||||
assertEquals(1, keys.length);
|
||||
assertEquals(1, workspace.variableMap_[keys[0]].length);
|
||||
|
||||
workspace.createVariable('name1');
|
||||
checkVariableValues('name1', 'type1', 'id1');
|
||||
// Check that the size of the variableMap_ did not change.
|
||||
assertEquals(1, keys.length);
|
||||
var varMapLength = workspace.variableMap_[keys[0]].length;
|
||||
assertEquals(1, varMapLength);
|
||||
workspaceTest_tearDown();
|
||||
}
|
||||
|
||||
@@ -478,7 +469,7 @@ function test_clear_Trivial() {
|
||||
workspace.clear();
|
||||
mockControl_.$verifyAll();
|
||||
var topBlocks_length = workspace.topBlocks_.length;
|
||||
var varMapLength = Object.keys(workspace.variableMap_).length;
|
||||
var varMapLength = Object.keys(workspace.variableMap_.variableMap_).length;
|
||||
assertEquals(0, topBlocks_length);
|
||||
assertEquals(0, varMapLength);
|
||||
}
|
||||
@@ -498,7 +489,7 @@ function test_clear_NoVariables() {
|
||||
workspace.clear();
|
||||
mockSetGroup.$verify();
|
||||
var topBlocks_length = workspace.topBlocks_.length;
|
||||
var varMapLength = Object.keys(workspace.variableMap_).length;
|
||||
var varMapLength = Object.keys(workspace.variableMap_.variableMap_).length;
|
||||
assertEquals(0, topBlocks_length);
|
||||
assertEquals(0, varMapLength);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user