mirror of
https://github.com/google/blockly.git
synced 2026-01-11 10:57:07 +01:00
aecfe34c38
* feat: add the IVariableMap and IVariableModel interfaces. * chore: add license headers.
73 lines
2.1 KiB
TypeScript
73 lines
2.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2024 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import {IVariableModel} from './i_variable_model.js';
|
|
import {State} from '../serialization/variables.js';
|
|
|
|
/**
|
|
* Variable maps are container objects responsible for storing and managing the
|
|
* set of variables referenced on a workspace.
|
|
*
|
|
* Any of these methods may define invariants about which names and types are
|
|
* legal, and throw if they are not met.
|
|
*/
|
|
export interface IVariableMap<T extends IVariableModel, U extends State> {
|
|
/* Returns the variable corresponding to the given ID, or null if none. */
|
|
getVariableById(id: string): T | null;
|
|
|
|
/**
|
|
* Returns the variable with the given name, or null if not found. If `type`
|
|
* is provided, the variable's type must also match, or null should be
|
|
* returned.
|
|
*/
|
|
getVariable(name: string, type?: string): T | null;
|
|
|
|
/* Returns a list of all variables managed by this variable map. */
|
|
getAllVariables(): T[];
|
|
|
|
/**
|
|
* Returns a list of all of the variables of the given type managed by this
|
|
* variable map.
|
|
*/
|
|
getVariablesOfType(type: string): T[];
|
|
|
|
/**
|
|
* Returns a list of the set of types of the variables managed by this
|
|
* variable map.
|
|
*/
|
|
getTypes(): string[];
|
|
|
|
/**
|
|
* Creates a new variable with the given name. If ID is not specified, the
|
|
* variable map should create one. Returns the new variable.
|
|
*/
|
|
createVariable(name: string, id?: string, type?: string | null): T;
|
|
|
|
/**
|
|
* Changes the name of the given variable to the name provided and returns the
|
|
* renamed variable.
|
|
*/
|
|
renameVariable(variable: T, newName: string): T;
|
|
|
|
/* Changes the type of the given variable and returns it. */
|
|
changeVariableType(variable: T, newType: string): T;
|
|
|
|
/* Deletes the given variable. */
|
|
deleteVariable(variable: T): void;
|
|
|
|
/* Removes all variables from this variable map. */
|
|
clear(): void;
|
|
|
|
/* Returns an object representing the serialized state of the variable. */
|
|
saveVariable(variable: T): U;
|
|
|
|
/**
|
|
* Creates a variable in this variable map corresponding to the given state
|
|
* (produced by a call to `saveVariable`).
|
|
*/
|
|
loadVariable(state: U): T;
|
|
}
|