mirror of
https://github.com/google/blockly.git
synced 2026-01-24 17:20:11 +01:00
ce22f42868
* chore(deps): Add pretter-plugin-organize-imports * chore: Remove insignificant blank lines in import sections Since prettier-plugin-organize-imports sorts imports within sections separated by blank lines, but preserves the section divisions, remove any blank lines that are not dividing imports into meaningful sections. Do not remove blank lines separating side-effect-only imports from main imports. * chore: Remove unneded eslint-disable directives * chore: Organise imports
94 lines
2.8 KiB
TypeScript
94 lines
2.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
// Former goog.module ID: Blockly.serialization.workspaces
|
|
|
|
import * as eventUtils from '../events/utils.js';
|
|
import type {ISerializer} from '../interfaces/i_serializer.js';
|
|
import * as registry from '../registry.js';
|
|
import * as dom from '../utils/dom.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
import {WorkspaceSvg} from '../workspace_svg.js';
|
|
|
|
/**
|
|
* Returns the state of the workspace as a plain JavaScript object.
|
|
*
|
|
* @param workspace The workspace to serialize.
|
|
* @returns The serialized state of the workspace.
|
|
*/
|
|
export function save(workspace: Workspace): {
|
|
[key: string]: AnyDuringMigration;
|
|
} {
|
|
const state = Object.create(null);
|
|
const serializerMap = registry.getAllItems(registry.Type.SERIALIZER, true);
|
|
for (const key in serializerMap) {
|
|
const save = (serializerMap[key] as ISerializer)?.save(workspace);
|
|
if (save) {
|
|
state[key] = save;
|
|
}
|
|
}
|
|
return state;
|
|
}
|
|
|
|
/**
|
|
* Loads the variable represented by the given state into the given workspace.
|
|
*
|
|
* @param state The state of the workspace to deserialize into the workspace.
|
|
* @param workspace The workspace to add the new state to.
|
|
* @param param1 recordUndo: If true, events triggered by this function will be
|
|
* undo-able by the user. False by default.
|
|
*/
|
|
export function load(
|
|
state: {[key: string]: AnyDuringMigration},
|
|
workspace: Workspace,
|
|
{recordUndo = false}: {recordUndo?: boolean} = {},
|
|
) {
|
|
const serializerMap = registry.getAllItems(registry.Type.SERIALIZER, true);
|
|
if (!serializerMap) {
|
|
return;
|
|
}
|
|
|
|
const deserializers = Object.entries(serializerMap).sort(
|
|
(a, b) => (b[1] as ISerializer)!.priority - (a[1] as ISerializer)!.priority,
|
|
);
|
|
|
|
const prevRecordUndo = eventUtils.getRecordUndo();
|
|
eventUtils.setRecordUndo(recordUndo);
|
|
const existingGroup = eventUtils.getGroup();
|
|
if (!existingGroup) {
|
|
eventUtils.setGroup(true);
|
|
}
|
|
|
|
dom.startTextWidthCache();
|
|
if (workspace instanceof WorkspaceSvg) {
|
|
workspace.setResizesEnabled(false);
|
|
}
|
|
|
|
// We want to trigger clearing in reverse priority order so plugins don't end
|
|
// up missing dependencies.
|
|
for (const [, deserializer] of deserializers.reverse()) {
|
|
(deserializer as ISerializer)?.clear(workspace);
|
|
}
|
|
|
|
// reverse() is destructive, so we have to re-reverse to correct the order.
|
|
for (const [name, deserializer] of deserializers.reverse()) {
|
|
const pluginState = state[name];
|
|
if (pluginState) {
|
|
(deserializer as ISerializer)?.load(state[name], workspace);
|
|
}
|
|
}
|
|
|
|
if (workspace instanceof WorkspaceSvg) {
|
|
workspace.setResizesEnabled(true);
|
|
}
|
|
dom.stopTextWidthCache();
|
|
|
|
eventUtils.fire(new (eventUtils.get(eventUtils.FINISHED_LOADING))(workspace));
|
|
|
|
eventUtils.setGroup(existingGroup);
|
|
eventUtils.setRecordUndo(prevRecordUndo);
|
|
}
|