/
moveoperation.js
209 lines (184 loc) · 7.22 KB
/
moveoperation.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/**
* @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module engine/model/operation/moveoperation
*/
import Operation from './operation';
import Position from '../position';
import Range from '../range';
import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays';
import { _move } from './utils';
// @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;
/**
* Operation to move a range of {@link module:engine/model/item~Item model items}
* to given {@link module:engine/model/position~Position target position}.
*
* @extends module:engine/model/operation/operation~Operation
*/
export default class MoveOperation extends Operation {
/**
* Creates a move operation.
*
* @param {module:engine/model/position~Position} sourcePosition
* Position before the first {@link module:engine/model/item~Item model item} to move.
* @param {Number} howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
* `sourcePosition` with offset shifted by `howMany`.
* @param {module:engine/model/position~Position} targetPosition Position at which moved nodes will be inserted.
* @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
* can be applied or `null` if the operation operates on detached (non-document) tree.
*/
constructor( sourcePosition, howMany, targetPosition, baseVersion ) {
super( baseVersion );
/**
* Position before the first {@link module:engine/model/item~Item model item} to move.
*
* @member {module:engine/model/position~Position} module:engine/model/operation/moveoperation~MoveOperation#sourcePosition
*/
this.sourcePosition = sourcePosition.clone();
// `'toNext'` because `sourcePosition` is a bit like a start of the moved range.
this.sourcePosition.stickiness = 'toNext';
/**
* Offset size of moved range.
*
* @member {Number} module:engine/model/operation/moveoperation~MoveOperation#howMany
*/
this.howMany = howMany;
/**
* Position at which moved nodes will be inserted.
*
* @member {module:engine/model/position~Position} module:engine/model/operation/moveoperation~MoveOperation#targetPosition
*/
this.targetPosition = targetPosition.clone();
this.targetPosition.stickiness = 'toNone';
}
/**
* @inheritDoc
*/
get type() {
if ( this.targetPosition.root.rootName == '$graveyard' ) {
return 'remove';
} else if ( this.sourcePosition.root.rootName == '$graveyard' ) {
return 'reinsert';
}
return 'move';
}
/**
* Creates and returns an operation that has the same parameters as this operation.
*
* @returns {module:engine/model/operation/moveoperation~MoveOperation} Clone of this operation.
*/
clone() {
return new this.constructor( this.sourcePosition, this.howMany, this.targetPosition, this.baseVersion );
}
/**
* Returns the start position of the moved range after it got moved. This may be different than
* {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition} in some cases, i.e. when a range is moved
* inside the same parent but {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition targetPosition}
* is after {@link module:engine/model/operation/moveoperation~MoveOperation#sourcePosition sourcePosition}.
*
* vv vv
* abcdefg ===> adefbcg
* ^ ^
* targetPos movedRangeStart
* offset 6 offset 4
*
* @returns {module:engine/model/position~Position}
*/
getMovedRangeStart() {
return this.targetPosition._getTransformedByDeletion( this.sourcePosition, this.howMany );
}
/**
* See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
*
* @returns {module:engine/model/operation/moveoperation~MoveOperation}
*/
getReversed() {
const newTargetPosition = this.sourcePosition._getTransformedByInsertion( this.targetPosition, this.howMany );
return new this.constructor( this.getMovedRangeStart(), this.howMany, newTargetPosition, this.baseVersion + 1 );
}
/**
* @inheritDoc
*/
_validate() {
const sourceElement = this.sourcePosition.parent;
const targetElement = this.targetPosition.parent;
const sourceOffset = this.sourcePosition.offset;
const targetOffset = this.targetPosition.offset;
// Validate whether move operation has correct parameters.
// Validation is pretty complex but move operation is one of the core ways to manipulate the document state.
// We expect that many errors might be connected with one of scenarios described below.
if ( sourceOffset + this.howMany > sourceElement.maxOffset ) {
/**
* The nodes which should be moved do not exist.
*
* @error move-operation-nodes-do-not-exist
*/
throw new CKEditorError(
'move-operation-nodes-do-not-exist', this
);
} else if ( sourceElement === targetElement && sourceOffset < targetOffset && targetOffset < sourceOffset + this.howMany ) {
/**
* Trying to move a range of nodes into the middle of that range.
*
* @error move-operation-range-into-itself
*/
throw new CKEditorError(
'move-operation-range-into-itself', this
);
} else if ( this.sourcePosition.root == this.targetPosition.root ) {
if ( compareArrays( this.sourcePosition.getParentPath(), this.targetPosition.getParentPath() ) == 'prefix' ) {
const i = this.sourcePosition.path.length - 1;
if ( this.targetPosition.path[ i ] >= sourceOffset && this.targetPosition.path[ i ] < sourceOffset + this.howMany ) {
/**
* Trying to move a range of nodes into one of nodes from that range.
*
* @error move-operation-node-into-itself
*/
throw new CKEditorError(
'move-operation-node-into-itself', this
);
}
}
}
}
/**
* @inheritDoc
*/
_execute() {
_move( Range._createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition );
}
/**
* @inheritDoc
*/
toJSON() {
const json = super.toJSON();
json.sourcePosition = this.sourcePosition.toJSON();
json.targetPosition = this.targetPosition.toJSON();
return json;
}
/**
* @inheritDoc
*/
static get className() {
return 'MoveOperation';
}
/**
* Creates `MoveOperation` object from deserilized object, i.e. from parsed JSON string.
*
* @param {Object} json Deserialized JSON object.
* @param {module:engine/model/document~Document} document Document on which this operation will be applied.
* @returns {module:engine/model/operation/moveoperation~MoveOperation}
*/
static fromJSON( json, document ) {
const sourcePosition = Position.fromJSON( json.sourcePosition, document );
const targetPosition = Position.fromJSON( json.targetPosition, document );
return new this( sourcePosition, json.howMany, targetPosition, json.baseVersion );
}
// @if CK_DEBUG_ENGINE // toString() {
// @if CK_DEBUG_ENGINE // const range = ModelRange._createFromPositionAndShift( this.sourcePosition, this.howMany );
// @if CK_DEBUG_ENGINE // return `MoveOperation( ${ this.baseVersion } ): ${ range } -> ${ this.targetPosition }`;
// @if CK_DEBUG_ENGINE // }
}