mirror of
https://github.com/google/blockly.git
synced 2026-01-07 17:10:11 +01:00
bd77b4ad3d
* Add parameter for recording undo. This sets up the most common default behavior, but also makes it clear to people that it is happening, because it might not be expected. * Add grouping of events * Add text width caching * Add disabling workspace resizing * Add performance optimizations * Respect nulls from blocks.save * Cleanup from rebase * PR Comments * Cleanup from rebase
77 lines
2.1 KiB
JavaScript
77 lines
2.1 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Handles serializing variables to plain JavaScript objects, only
|
|
* containing state.
|
|
*/
|
|
'use strict';
|
|
|
|
goog.module('Blockly.serialization.variables');
|
|
goog.module.declareLegacyNamespace();
|
|
|
|
const Events = goog.require('Blockly.Events');
|
|
// eslint-disable-next-line no-unused-vars
|
|
const VariableModel = goog.requireType('Blockly.VariableModel');
|
|
// eslint-disable-next-line no-unused-vars
|
|
const Workspace = goog.requireType('Blockly.Workspace');
|
|
|
|
|
|
/**
|
|
* Represents the state of a given variable.
|
|
* @typedef {{
|
|
* name: string,
|
|
* id: string,
|
|
* type: (string|undefined),
|
|
* }}
|
|
*/
|
|
var State;
|
|
exports.State = State;
|
|
|
|
/**
|
|
* Returns the state of the variable as a plain JavaScript object.
|
|
* @param {!VariableModel} variableModel The variable to serialize.
|
|
* @return {!State} The serialized state of the variable.
|
|
*/
|
|
const save = function(variableModel) {
|
|
const state = {
|
|
'name': variableModel.name,
|
|
'id': variableModel.getId()
|
|
};
|
|
if (variableModel.type) {
|
|
state['type'] = variableModel.type;
|
|
}
|
|
return state;
|
|
};
|
|
/** @package */
|
|
exports.save = save;
|
|
|
|
/**
|
|
* Loads the variable represented by the given state into the given workspace.
|
|
* Do not call this directly, use workspace.createVariable instead.
|
|
* @param {!State} state The state of a variable to deserialize into the
|
|
* workspace.
|
|
* @param {!Workspace} workspace The workspace to add the variable to.
|
|
* @param {{recordUndo: (boolean|undefined)}=} param1
|
|
* recordUndo: If true, events triggered by this function will be undo-able
|
|
* by the user. False by default.
|
|
*/
|
|
const load = function(state, workspace, {recordUndo = false} = {}) {
|
|
const prevRecordUndo = Events.getRecordUndo();
|
|
Events.setRecordUndo(recordUndo);
|
|
const existingGroup = Events.getGroup();
|
|
if (!existingGroup) {
|
|
Events.setGroup(true);
|
|
}
|
|
|
|
workspace.createVariable(state['name'], state['type'], state['id']);
|
|
|
|
Events.setGroup(existingGroup);
|
|
Events.setRecordUndo(prevRecordUndo);
|
|
};
|
|
/** @package */
|
|
exports.load = load;
|