mirror of
https://github.com/google/blockly.git
synced 2026-01-07 00:50:27 +01:00
2f2252f588
There is significant confusion in names and comments with regards to variables and procedures. `Blockly.Generator.prototype.variableDB_` is a Blockly.Names database, not a variable map. This rename introduces a getter and setter so deprecated references still work. This commit also fixes some comments which are either outright wrong or misleading regarding variable and procedure names.
91 lines
2.6 KiB
JavaScript
91 lines
2.6 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2017 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Components for the variable model.
|
|
* @author marisaleung@google.com (Marisa Leung)
|
|
*/
|
|
'use strict';
|
|
|
|
goog.provide('Blockly.VariableModel');
|
|
|
|
goog.require('Blockly.Events');
|
|
/** @suppress {extraRequire} */
|
|
goog.require('Blockly.Events.VarCreate');
|
|
goog.require('Blockly.utils');
|
|
|
|
goog.requireType('Blockly.Workspace');
|
|
|
|
|
|
/**
|
|
* Class for a variable model.
|
|
* Holds information for the variable including name, ID, and type.
|
|
* @param {!Blockly.Workspace} workspace The variable's workspace.
|
|
* @param {string} name The name of the variable. This is the user-visible name
|
|
* (e.g. 'my var' or '私の変数'), not the generated name.
|
|
* @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.
|
|
* @see {Blockly.FieldVariable}
|
|
* @constructor
|
|
*/
|
|
Blockly.VariableModel = function(workspace, name, opt_type, opt_id) {
|
|
/**
|
|
* The workspace the variable is in.
|
|
* @type {!Blockly.Workspace}
|
|
*/
|
|
this.workspace = workspace;
|
|
|
|
/**
|
|
* The name of the variable, typically defined by the user. It may be
|
|
* changed by the user.
|
|
* @type {string}
|
|
*/
|
|
this.name = name;
|
|
|
|
/**
|
|
* The type of the variable, such as 'int' or 'sound_effect'. This may be
|
|
* used to build a list of variables of a specific type. By default this is
|
|
* the empty string '', which is a specific type.
|
|
* @see {Blockly.FieldVariable}
|
|
* @type {string}
|
|
*/
|
|
this.type = opt_type || '';
|
|
|
|
/**
|
|
* A unique ID for the variable. This should be defined at creation and
|
|
* not change, even if the name changes. In most cases this should be a
|
|
* UUID.
|
|
* @type {string}
|
|
* @private
|
|
*/
|
|
this.id_ = opt_id || Blockly.utils.genUid();
|
|
|
|
Blockly.Events.fire(new (Blockly.Events.get(Blockly.Events.VAR_CREATE))(
|
|
this));
|
|
};
|
|
|
|
/**
|
|
* @return {string} The ID for the variable.
|
|
*/
|
|
Blockly.VariableModel.prototype.getId = function() {
|
|
return this.id_;
|
|
};
|
|
|
|
/**
|
|
* A custom compare function for the VariableModel objects.
|
|
* @param {Blockly.VariableModel} var1 First variable to compare.
|
|
* @param {Blockly.VariableModel} var2 Second variable to compare.
|
|
* @return {number} -1 if name of var1 is less than name of var2, 0 if equal,
|
|
* and 1 if greater.
|
|
* @package
|
|
*/
|
|
Blockly.VariableModel.compareByName = function(var1, var2) {
|
|
return var1.name.localeCompare(var2.name, undefined, {sensitivity: 'base'});
|
|
};
|