-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
outdentcodeblockcommand.js
187 lines (163 loc) · 5.52 KB
/
outdentcodeblockcommand.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
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module code-block/outdentcodeblockcommand
*/
import Command from '@ckeditor/ckeditor5-core/src/command';
import {
getLeadingWhiteSpaces,
getIndentOutdentPositions,
isModelSelectionInCodeBlock
} from './utils';
/**
* The code block indentation decrease command plugin.
*
* @extends module:core/command~Command
*/
export default class OutdentCodeBlockCommand extends Command {
constructor( editor ) {
super( editor );
/**
* A sequence of characters removed from the line when the command is executed.
*
* @readonly
* @private
* @member {String}
*/
this._indentSequence = editor.config.get( 'codeBlock.indentSequence' );
}
/**
* @inheritDoc
*/
refresh() {
this.isEnabled = this._checkEnabled();
}
/**
* Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
* code lines in the selection will be decreased.
*
* @fires execute
*/
execute() {
const editor = this.editor;
const model = editor.model;
model.change( writer => {
const positions = getIndentOutdentPositions( model );
// Outdent all positions, for instance assuming the indent sequence is 4x space (" "):
//
// <codeBlock>^foo</codeBlock> -> <codeBlock>foo</codeBlock>
//
// <codeBlock> ^bar</codeBlock> -> <codeBlock>bar</codeBlock>
//
// Also, when there is more than one position:
//
// <codeBlock>
// ^foobar
// <softBreak></softBreak>
// ^bazqux
// </codeBlock>
//
// ->
//
// <codeBlock>
// foobar
// <softBreak></softBreak>
// bazqux
// </codeBlock>
for ( const position of positions ) {
const range = getLastOutdentableSequenceRange( this.editor.model, position, this._indentSequence );
if ( range ) {
writer.remove( range );
}
}
} );
}
/**
* Checks whether the command can be enabled in the current context.
*
* @private
* @returns {Boolean} Whether the command should be enabled.
*/
_checkEnabled() {
if ( !this._indentSequence ) {
return false;
}
const model = this.editor.model;
if ( !isModelSelectionInCodeBlock( model.document.selection ) ) {
return false;
}
// Outdent command can execute only when there is an indent character sequence
// in some of the lines.
return getIndentOutdentPositions( model ).some( position => {
return getLastOutdentableSequenceRange( model, position, this._indentSequence );
} );
}
}
// For a position coming from `getIndentOutdentPositions()`, it returns the range representing
// the last occurrence of the indent sequence among the leading whitespaces of the code line the
// position represents.
//
// For instance, assuming the indent sequence is 4x space (" "):
//
// <codeBlock>foo^</codeBlock> -> null
// <codeBlock>foo^<softBreak></softBreak>bar</codeBlock> -> null
// <codeBlock> ^foo</codeBlock> -> null
// <codeBlock> ^foo</codeBlock> -> <codeBlock> [ ]foo</codeBlock>
// <codeBlock> ^foo bar</codeBlock> -> <codeBlock>[ ]foo bar</codeBlock>
//
// @param {<module:engine/model/model~Model>} model
// @param {<module:engine/model/position~Position>} position
// @param {String} sequence
// @returns {<module:engine/model/range~Range>|null}
function getLastOutdentableSequenceRange( model, position, sequence ) {
// Positions start before each text node (code line). Get the node corresponding to the position.
const nodeAtPosition = getCodeLineTextNodeAtPosition( position );
if ( !nodeAtPosition ) {
return null;
}
const leadingWhiteSpaces = getLeadingWhiteSpaces( nodeAtPosition );
const lastIndexOfSequence = leadingWhiteSpaces.lastIndexOf( sequence );
// For instance, assuming the indent sequence is 4x space (" "):
//
// <codeBlock> ^foo</codeBlock> -> null
//
if ( lastIndexOfSequence + sequence.length !== leadingWhiteSpaces.length ) {
return null;
}
// For instance, assuming the indent sequence is 4x space (" "):
//
// <codeBlock> ^foo</codeBlock> -> null
//
if ( lastIndexOfSequence === -1 ) {
return null;
}
const { parent, startOffset } = nodeAtPosition;
// Create a range that contains the **last** indent sequence among the leading whitespaces
// of the line.
//
// For instance, assuming the indent sequence is 4x space (" "):
//
// <codeBlock> ^foo</codeBlock> -> <codeBlock> [ ]foo</codeBlock>
//
return model.createRange(
model.createPositionAt( parent, startOffset + lastIndexOfSequence ),
model.createPositionAt( parent, startOffset + lastIndexOfSequence + sequence.length )
);
}
function getCodeLineTextNodeAtPosition( position ) {
// Positions start before each text node (code line). Get the node corresponding to the position.
let nodeAtPosition = position.parent.getChild( position.index );
// <codeBlock>foo^</codeBlock>
// <codeBlock>foo^<softBreak></softBreak>bar</codeBlock>
if ( !nodeAtPosition || nodeAtPosition.is( 'element', 'softBreak' ) ) {
nodeAtPosition = position.nodeBefore;
}
// <codeBlock>^</codeBlock>
// <codeBlock>foo^<softBreak></softBreak>bar</codeBlock>
if ( !nodeAtPosition || nodeAtPosition.is( 'element', 'softBreak' ) ) {
return null;
}
return nodeAtPosition;
}