CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-07 00:50:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor: clean up VariableModel. (#8416)

Browse Source
This commit is contained in:
Aaron Dodson
2024-07-22 10:51:56 -07:00
committed by GitHub
parent 21c0a7d999
commit 26e6d80e15
2 changed files with 43 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
core/variable_model.ts
View File

@@ -15,6 +15,7 @@
import './events/events_var_create.js';
import * as idGenerator from './utils/idgenerator.js';
import * as eventUtils from './events/utils.js';
import * as registry from './registry.js';
import type {Workspace} from './workspace.js';
import {IVariableModel, IVariableState} from './interfaces/i_variable_model.js';
@@ -27,7 +28,7 @@ import {IVariableModel, IVariableState} from './interfaces/i_variable_model.js';
*/
export class VariableModel implements IVariableModel<IVariableState> {
private type: string;
private readonly id_: string;
private readonly id: string;
/**
* @param workspace The variable's workspace.
@@ -39,7 +40,7 @@ export class VariableModel implements IVariableModel<IVariableState> {
* @param opt_id The unique ID of the variable. This will default to a UUID.
*/
constructor(
private workspace: Workspace,
private readonly workspace: Workspace,
private name: string,
opt_type?: string,
opt_id?: string,
@@ -58,12 +59,12 @@ export class VariableModel implements IVariableModel<IVariableState> {
* not change, even if the name changes. In most cases this should be a
* UUID.
*/
this.id_ = opt_id || idGenerator.genUid();
this.id = opt_id || idGenerator.genUid();
}
/** @returns The ID for the variable. */
getId(): string {
return this.id_;
return this.id;
}
/** @returns The name of this variable. */
@@ -96,10 +97,20 @@ export class VariableModel implements IVariableModel<IVariableState> {
return this;
}
/**
* Returns the workspace this VariableModel belongs to.
*
* @returns The workspace this VariableModel belongs to.
*/
getWorkspace(): Workspace {
return this.workspace;
}
/**
* Serializes this VariableModel.
*
* @returns a JSON representation of this VariableModel.
*/
save(): IVariableState {
const state: IVariableState = {
'name': this.getName(),
@@ -113,11 +124,21 @@ export class VariableModel implements IVariableModel<IVariableState> {
return state;
}
/**
* Loads the persisted state into a new variable in the given workspace.
*
* @param state The serialized state of a variable model from save().
* @param workspace The workspace to create the new variable in.
*/
static load(state: IVariableState, workspace: Workspace) {
// TODO(adodson): Once VariableMap implements IVariableMap, directly
// construct a variable, retrieve the variable map from the workspace,
// add the variable to that variable map, and fire a VAR_CREATE event.
workspace.createVariable(state['name'], state['type'], state['id']);
const variable = new this(
workspace,
state['name'],
state['type'],
state['id'],
);
workspace.getVariableMap().addVariable(variable);
eventUtils.fire(new (eventUtils.get(eventUtils.VAR_CREATE))(variable));
}
/**