2016-05-02 02:58:41 +00:00
|
|
|
/**
|
|
|
|
* Package: svgedit.history
|
|
|
|
*
|
|
|
|
* Licensed under the MIT License
|
|
|
|
*
|
|
|
|
* Copyright(c) 2016 Flint O'Brien
|
|
|
|
*/
|
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
import {
|
|
|
|
BatchCommand, MoveElementCommand, InsertElementCommand, RemoveElementCommand,
|
|
|
|
ChangeElementCommand
|
|
|
|
} from './history.js';
|
2016-05-02 02:58:41 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* History recording service.
|
|
|
|
*
|
2016-05-02 16:27:53 +00:00
|
|
|
* A self-contained service interface for recording history. Once injected, no other dependencies
|
|
|
|
* or globals are required (example: UndoManager, command types, etc.). Easy to mock for unit tests.
|
|
|
|
* Built on top of history classes in history.js.
|
|
|
|
*
|
|
|
|
* There is a simple start/end interface for batch commands.
|
2016-05-02 02:58:41 +00:00
|
|
|
*
|
|
|
|
* HistoryRecordingService.NO_HISTORY is a singleton that can be passed in to functions
|
|
|
|
* that record history. This helps when the caller requires that no history be recorded.
|
|
|
|
*
|
|
|
|
* Usage:
|
|
|
|
* The following will record history: insert, batch, insert.
|
|
|
|
* ```
|
|
|
|
* hrService = new svgedit.history.HistoryRecordingService(this.undoMgr);
|
|
|
|
* hrService.insertElement(elem, text); // add simple command to history.
|
|
|
|
* hrService.startBatchCommand('create two elements');
|
|
|
|
* hrService.changeElement(elem, attrs, text); // add to batchCommand
|
|
|
|
* hrService.changeElement(elem, attrs2, text); // add to batchCommand
|
|
|
|
* hrService.endBatchCommand(); // add batch command with two change commands to history.
|
|
|
|
* hrService.insertElement(elem, text); // add simple command to history.
|
|
|
|
* ```
|
|
|
|
*
|
|
|
|
* Note that all functions return this, so commands can be chained, like so:
|
|
|
|
*
|
|
|
|
* ```
|
|
|
|
* hrService
|
|
|
|
* .startBatchCommand('create two elements')
|
|
|
|
* .insertElement(elem, text)
|
|
|
|
* .changeElement(elem, attrs, text)
|
|
|
|
* .endBatchCommand();
|
|
|
|
* ```
|
|
|
|
*
|
|
|
|
* @param {svgedit.history.UndoManager} undoManager - The undo manager.
|
2018-05-18 06:41:43 +00:00
|
|
|
* A value of null is valid for cases where no history recording is required.
|
|
|
|
* See singleton: HistoryRecordingService.NO_HISTORY
|
2016-05-02 02:58:41 +00:00
|
|
|
*/
|
2018-05-29 16:43:02 +00:00
|
|
|
class HistoryRecordingService {
|
2018-05-18 03:25:45 +00:00
|
|
|
constructor (undoManager) {
|
|
|
|
this.undoManager_ = undoManager;
|
|
|
|
this.currentBatchCommand_ = null;
|
|
|
|
this.batchCommandStack_ = [];
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* Start a batch command so multiple commands can recorded as a single history command.
|
|
|
|
* Requires a corresponding call to endBatchCommand. Start and end commands can be nested.
|
|
|
|
*
|
|
|
|
* @param {string} text - Optional string describing the batch command.
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
*/
|
|
|
|
startBatchCommand (text) {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
this.currentBatchCommand_ = new BatchCommand(text);
|
|
|
|
this.batchCommandStack_.push(this.currentBatchCommand_);
|
|
|
|
return this;
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* End a batch command and add it to the history or a parent batch command.
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
*/
|
|
|
|
endBatchCommand () {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
if (this.currentBatchCommand_) {
|
|
|
|
const batchCommand = this.currentBatchCommand_;
|
|
|
|
this.batchCommandStack_.pop();
|
|
|
|
const {length} = this.batchCommandStack_;
|
|
|
|
this.currentBatchCommand_ = length ? this.batchCommandStack_[length - 1] : null;
|
|
|
|
this.addCommand_(batchCommand);
|
|
|
|
}
|
|
|
|
return this;
|
2018-05-18 04:02:30 +00:00
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* Add a MoveElementCommand to the history or current batch command
|
|
|
|
* @param {Element} elem - The DOM element that was moved
|
|
|
|
* @param {Element} oldNextSibling - The element's next sibling before it was moved
|
|
|
|
* @param {Element} oldParent - The element's parent before it was moved
|
|
|
|
* @param {string} [text] - An optional string visible to user related to this change
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
*/
|
|
|
|
moveElement (elem, oldNextSibling, oldParent, text) {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
this.addCommand_(new MoveElementCommand(elem, oldNextSibling, oldParent, text));
|
|
|
|
return this;
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* Add an InsertElementCommand to the history or current batch command
|
|
|
|
* @param {Element} elem - The DOM element that was added
|
|
|
|
* @param {string} [text] - An optional string visible to user related to this change
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
*/
|
|
|
|
insertElement (elem, text) {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
this.addCommand_(new InsertElementCommand(elem, text));
|
|
|
|
return this;
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* Add a RemoveElementCommand to the history or current batch command
|
|
|
|
* @param {Element} elem - The DOM element that was removed
|
|
|
|
* @param {Element} oldNextSibling - The element's next sibling before it was removed
|
|
|
|
* @param {Element} oldParent - The element's parent before it was removed
|
|
|
|
* @param {string} [text] - An optional string visible to user related to this change
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
*/
|
|
|
|
removeElement (elem, oldNextSibling, oldParent, text) {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
this.addCommand_(new RemoveElementCommand(elem, oldNextSibling, oldParent, text));
|
|
|
|
return this;
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* Add a ChangeElementCommand to the history or current batch command
|
|
|
|
* @param {Element} elem - The DOM element that was changed
|
|
|
|
* @param {Object} attrs - An object with the attributes to be changed and the values they had *before* the change
|
|
|
|
* @param {string} [text] - An optional string visible to user related to this change
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
*/
|
|
|
|
changeElement (elem, attrs, text) {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
this.addCommand_(new ChangeElementCommand(elem, attrs, text));
|
|
|
|
return this;
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
|
2018-05-18 03:25:45 +00:00
|
|
|
/**
|
|
|
|
* Private function to add a command to the history or current batch command.
|
|
|
|
* @param cmd
|
|
|
|
* @returns {svgedit.history.HistoryRecordingService}
|
|
|
|
* @private
|
|
|
|
*/
|
|
|
|
addCommand_ (cmd) {
|
|
|
|
if (!this.undoManager_) { return this; }
|
|
|
|
if (this.currentBatchCommand_) {
|
|
|
|
this.currentBatchCommand_.addSubCommand(cmd);
|
|
|
|
} else {
|
|
|
|
this.undoManager_.addCommandToHistory(cmd);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2016-05-02 02:58:41 +00:00
|
|
|
/**
|
2018-05-29 08:39:29 +00:00
|
|
|
* @property {HistoryRecordingService} NO_HISTORY - Singleton that can be passed to functions that record history, but the caller requires that no history be recorded.
|
2016-05-02 02:58:41 +00:00
|
|
|
*/
|
2018-05-18 03:25:45 +00:00
|
|
|
HistoryRecordingService.NO_HISTORY = new HistoryRecordingService();
|
2018-05-29 16:43:02 +00:00
|
|
|
export default HistoryRecordingService;
|