mirror of
https://github.com/google/blockly.git
synced 2026-01-27 02:30:08 +01:00
d6230b2a44
* feat: add serialization to procedure base event * feat: add serialization to procedure change return event * feat: add serialization to procedure create event * feat: add serialization of the procedure delete event * feat: add serialization of procedure enable events * feat: add serialization of procedure parameter create events * feat: add serialization of the parameter delete event * feat: add serialization of procedure parameter rename events * feat: add serialization for procedure rename events
102 lines
3.3 KiB
TypeScript
102 lines
3.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2022 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import type {IParameterModel} from '../interfaces/i_parameter_model.js';
|
|
import type {IProcedureModel} from '../interfaces/i_procedure_model.js';
|
|
import {ObservableParameterModel} from '../procedures/observable_parameter_model.js';
|
|
import * as registry from '../registry.js';
|
|
import {loadParameter, ParameterState, saveParameter} from '../serialization/procedures.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
|
|
import {ProcedureParameterBase, ProcedureParameterBaseJson} from './events_procedure_parameter_base.js';
|
|
import * as eventUtils from './utils.js';
|
|
|
|
|
|
/**
|
|
* Represents a parameter being added to a procedure.
|
|
*/
|
|
export class ProcedureParameterCreate extends ProcedureParameterBase {
|
|
/** A string used to check the type of the event. */
|
|
type = eventUtils.PROCEDURE_PARAMETER_CREATE;
|
|
|
|
/**
|
|
* @param parameter The parameter model that was just added to the procedure.
|
|
* @param index The index the parameter was inserted at.
|
|
*/
|
|
constructor(
|
|
workspace: Workspace, procedure: IProcedureModel,
|
|
parameter: IParameterModel, public readonly index: number) {
|
|
super(workspace, procedure, parameter);
|
|
}
|
|
|
|
run(forward: boolean) {
|
|
const workspace = this.getEventWorkspace_();
|
|
const procedureMap = workspace.getProcedureMap();
|
|
const procedureModel = procedureMap.get(this.model.getId());
|
|
if (!procedureModel) {
|
|
throw new Error(
|
|
'Cannot add a parameter to a procedure that does not exist ' +
|
|
'in the procedure map');
|
|
}
|
|
const parameterModel = procedureModel.getParameter(this.index);
|
|
if (forward) {
|
|
if (this.parameterMatches(parameterModel)) return;
|
|
// TODO: This should just add the parameter instead of creating a dupe.
|
|
procedureModel.insertParameter(
|
|
new ObservableParameterModel(
|
|
workspace, this.parameter.getName(), this.parameter.getId()),
|
|
this.index);
|
|
} else {
|
|
if (!this.parameterMatches(parameterModel)) return;
|
|
procedureModel.deleteParameter(this.index);
|
|
}
|
|
}
|
|
|
|
parameterMatches(param: IParameterModel) {
|
|
return param && param.getId() === this.parameter.getId();
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
toJson(): ProcedureParameterCreateJson {
|
|
const json = super.toJson() as ProcedureParameterCreateJson;
|
|
json['parameter'] = saveParameter(this.parameter);
|
|
json['index'] = this.index;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @internal
|
|
*/
|
|
static fromJson(json: ProcedureParameterCreateJson, workspace: Workspace):
|
|
ProcedureParameterCreate {
|
|
const procedure = workspace.getProcedureMap().get(json['procedureId']);
|
|
if (!procedure) {
|
|
throw new Error(
|
|
'Cannot deserialize parameter create event because the ' +
|
|
'target procedure does not exist');
|
|
}
|
|
return new ProcedureParameterCreate(
|
|
workspace, procedure,
|
|
loadParameter(ObservableParameterModel, json['parameter'], workspace),
|
|
json['index']);
|
|
}
|
|
}
|
|
|
|
export interface ProcedureParameterCreateJson extends
|
|
ProcedureParameterBaseJson {
|
|
parameter: ParameterState, index: number,
|
|
}
|
|
|
|
registry.register(
|
|
registry.Type.EVENT, eventUtils.PROCEDURE_PARAMETER_CREATE,
|
|
ProcedureParameterCreate);
|