Skip to content

Group MODE field changes with disconnect events into single undo entry #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tracygardner wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −0
Open

Group MODE field changes with disconnect events into single undo entry #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions blocks/control.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,10 @@ export function defineControlBlocks() {
// True while Blockly is constructing/rehydrating the block graph.
this._isRestoring = true;

// Tracks a group we opened in the MODE validator so we can close it
// once Blockly fires the corresponding BLOCK_CHANGE event.
this._modeChangeGroupId = null;

this.appendDummyInput("HEAD").appendField(
new Blockly.FieldDropdown(
[
Expand All @@ -469,6 +473,14 @@ export function defineControlBlocks() {
["%{BKY_CONTROLS_IF_MSG_ELSE}", MODE.ELSE],
],
(newValue) => {
// If there's no active event group, open one so that any
// BLOCK_MOVE events fired by validateAndDisconnectInvalidChain_
// land in the same undo entry as the BLOCK_CHANGE that Blockly
// fires for this field after the validator returns.
if (!Blockly.Events.getGroup() && !this._modeChangeGroupId) {
Blockly.Events.setGroup(true);
this._modeChangeGroupId = Blockly.Events.getGroup();
}
this.updateShape_(newValue);
return newValue;
},
Expand Down Expand Up @@ -585,6 +597,22 @@ export function defineControlBlocks() {
return;
}

// Close the event group we opened in the MODE validator once Blockly
// has fired the corresponding BLOCK_CHANGE, so that the field change
// and any prior disconnect events are a single undo entry.
if (
this._modeChangeGroupId &&
event.type === Blockly.Events.BLOCK_CHANGE &&
event.element === "field" &&
event.name === "MODE" &&
event.blockId === this.id
) {
if (Blockly.Events.getGroup() === this._modeChangeGroupId) {
Blockly.Events.setGroup(false);
}
this._modeChangeGroupId = null;
}

const isRelevantEvent =
event.type === Blockly.Events.BLOCK_MOVE ||
event.type === Blockly.Events.BLOCK_CHANGE ||
Expand Down
Loading