test('snippets, nested sessions', function () {
model.setValue('');
editor.setSelection(new Selection(1, 1, 1, 1));
const first = new SnippetSession(editor, 'foo${2:bar}foo$0');
first.insert();
assert.equal(model.getValue(), 'foobarfoo');
assertSelections(editor, new Selection(1, 4, 1, 7));
const second = new SnippetSession(editor, 'ba${1:zzzz}$0');
second.insert();
assert.equal(model.getValue(), 'foobazzzzfoo');
assertSelections(editor, new Selection(1, 6, 1, 10));
second.next();
assert.equal(second.isAtLastPlaceholder, true);
assertSelections(editor, new Selection(1, 10, 1, 10));
first.next();
assert.equal(first.isAtLastPlaceholder, true);
assertSelections(editor, new Selection(1, 13, 1, 13));
});
public run(accessor: ServicesAccessor, editor: ICodeEditor): void {
if (!editor.hasModel()) {
return;
}
let model = editor.getModel();
let commands: ICommand[] = [];
let selections = editor.getSelections();
let opts = model.getOptions();
for (const selection of selections) {
commands.push(new LineCommentCommand(selection, opts.tabSize, this._type));
}
editor.pushUndoStop();
editor.executeCommands(this.id, commands);
editor.pushUndoStop();
}
public runEditorCommand(accessor: ServicesAccessor, editor: ICodeEditor, args: any): void {
if (!editor.hasModel()) {
return;
}
const config = editor.getConfiguration();
const wordSeparators = getMapForWordSeparators(config.wordSeparators);
const model = editor.getModel();
const selections = editor.getSelections();
const result = selections.map((sel) => {
const inPosition = new Position(sel.positionLineNumber, sel.positionColumn);
const outPosition = this._move(wordSeparators, model, inPosition, this._wordNavigationType);
return this._moveTo(sel, outPosition, this._inSelectionMode);
});
editor._getCursors().setStates('moveWordCommand', CursorChangeReason.NotSet, result.map(r => CursorState.fromModelSelection(r)));
if (result.length === 1) {
const pos = new Position(result[0].positionLineNumber, result[0].positionColumn);
editor.revealPosition(pos, ScrollType.Smooth);
}
}
public setCodeEditor(codeEditor: ICodeEditor): void {
if (this.hasCodeEditor(codeEditor)) {
// Nothing to do...
return;
}
this._codeEditorListeners = dispose(this._codeEditorListeners);
this._codeEditor = codeEditor;
if (this._codeEditor) {
// Catch early the case that this code editor gets a different model set and disassociate from this model
this._codeEditorListeners.push(this._codeEditor.onDidChangeModel(() => {
this.setCodeEditor(null);
}));
let forwardSelection = (event?: ICursorSelectionChangedEvent) => {
this._lastSelection = this._codeEditor.getSelections();
this._onSelectionChanged.fire({
selections: this._lastSelection,
source: event && event.source
});
};
this._codeEditorListeners.push(this._codeEditor.onDidChangeCursorSelection(forwardSelection));
if (!Selection.selectionsArrEqual(this._lastSelection, this._codeEditor.getSelections())) {
forwardSelection();
}
this._codeEditorListeners.push(this._codeEditor.onDidFocusEditor(() => {
this._focusTracker.onGainedFocus();
}));
this._codeEditorListeners.push(this._codeEditor.onDidBlurEditor(() => {
this._focusTracker.onLostFocus();
}));
this._codeEditorListeners.push(this._codeEditor.onDidChangeConfiguration(() => {
this._setConfiguration(this._readConfiguration(this._model, this._codeEditor));
}));
this._setConfiguration(this._readConfiguration(this._model, this._codeEditor));
}
}
public isFocused(): boolean {
if (this._codeEditor) {
return this._codeEditor.hasTextFocus();
}
return false;
}
public runEditorCommand(accessor: ServicesAccessor, editor: ICodeEditor, args: any): void {
return editor.getContribution<IDebugEditorContribution>(EDITOR_CONTRIBUTION_ID).closeBreakpointWidget();
}
public setDecorations(key: string, ranges: editorCommon.IDecorationOptions[]): void {
if (!this._codeEditor) {
return;
}
this._codeEditor.setDecorations(key, ranges);
}
teardown(() => {
reg.dispose();
editor.dispose();
model.dispose();
markerService.dispose();
});
this.triggerAutoSuggestPromise.then(() => {
this.triggerAutoSuggestPromise = null;
if (marker === this.lastMarker) {
this.triggerDialog(true, this.editor.getPosition());
}
});
suite('SnippetController2', function () {
function assertSelections(editor: ICodeEditor, ...s: Selection[]) {
for (const selection of editor.getSelections()!) {
const actual = s.shift()!;
assert.ok(selection.equalsSelection(actual), `actual=${selection.toString()} <> expected=${actual.toString()}`);
}
assert.equal(s.length, 0);
}
function assertContextKeys(service: MockContextKeyService, inSnippet: boolean, hasPrev: boolean, hasNext: boolean): void {
assert.equal(SnippetController2.InSnippetMode.getValue(service), inSnippet, `inSnippetMode`);
assert.equal(SnippetController2.HasPrevTabstop.getValue(service), hasPrev, `HasPrevTabstop`);
assert.equal(SnippetController2.HasNextTabstop.getValue(service), hasNext, `HasNextTabstop`);
}
let editor: ICodeEditor;
let model: TextModel;
let contextKeys: MockContextKeyService;
let logService = new NullLogService();
setup(function () {
contextKeys = new MockContextKeyService();
model = TextModel.createFromString('if\n $state\nfi');
editor = createTestCodeEditor({ model: model });
editor.setSelections([new Selection(1, 1, 1, 1), new Selection(2, 5, 2, 5)]);
assert.equal(model.getEOL(), '\n');
});
teardown(function () {
model.dispose();
});
test('creation', () => {
const ctrl = new SnippetController2(editor, logService, contextKeys);
assertContextKeys(contextKeys, false, false, false);
ctrl.dispose();
});
test('insert, insert -> abort', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('foo${1:bar}foo$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 4, 1, 7), new Selection(2, 8, 2, 11));
ctrl.cancel();
assertContextKeys(contextKeys, false, false, false);
assertSelections(editor, new Selection(1, 4, 1, 7), new Selection(2, 8, 2, 11));
});
test('insert, insert -> tab, tab, done', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('${1:one}${2:two}$0');
assertContextKeys(contextKeys, true, false, true);
ctrl.next();
assertContextKeys(contextKeys, true, true, true);
ctrl.next();
assertContextKeys(contextKeys, false, false, false);
editor.trigger('test', 'type', { text: '\t' });
assert.equal(SnippetController2.InSnippetMode.getValue(contextKeys), false);
assert.equal(SnippetController2.HasNextTabstop.getValue(contextKeys), false);
assert.equal(SnippetController2.HasPrevTabstop.getValue(contextKeys), false);
});
test('insert, insert -> cursor moves out (left/right)', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('foo${1:bar}foo$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 4, 1, 7), new Selection(2, 8, 2, 11));
// bad selection change
editor.setSelections([new Selection(1, 12, 1, 12), new Selection(2, 16, 2, 16)]);
assertContextKeys(contextKeys, false, false, false);
});
test('insert, insert -> cursor moves out (up/down)', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('foo${1:bar}foo$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 4, 1, 7), new Selection(2, 8, 2, 11));
// bad selection change
editor.setSelections([new Selection(2, 4, 2, 7), new Selection(3, 8, 3, 11)]);
assertContextKeys(contextKeys, false, false, false);
});
test('insert, insert -> cursors collapse', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('foo${1:bar}foo$0');
assert.equal(SnippetController2.InSnippetMode.getValue(contextKeys), true);
assertSelections(editor, new Selection(1, 4, 1, 7), new Selection(2, 8, 2, 11));
// bad selection change
editor.setSelections([new Selection(1, 4, 1, 7)]);
assertContextKeys(contextKeys, false, false, false);
});
test('insert, insert plain text -> no snippet mode', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('foobar');
assertContextKeys(contextKeys, false, false, false);
assertSelections(editor, new Selection(1, 7, 1, 7), new Selection(2, 11, 2, 11));
});
test('insert, delete snippet text', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('${1:foobar}$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 1, 1, 7), new Selection(2, 5, 2, 11));
editor.trigger('test', 'cut', {});
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 1, 1, 1), new Selection(2, 5, 2, 5));
editor.trigger('test', 'type', { text: 'abc' });
assertContextKeys(contextKeys, true, false, true);
ctrl.next();
assertContextKeys(contextKeys, false, false, false);
editor.trigger('test', 'tab', {});
assertContextKeys(contextKeys, false, false, false);
// editor.trigger('test', 'type', { text: 'abc' });
// assertContextKeys(contextKeys, false, false, false);
});
test('insert, nested snippet', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('${1:foobar}$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 1, 1, 7), new Selection(2, 5, 2, 11));
ctrl.insert('far$1boo$0');
assertSelections(editor, new Selection(1, 4, 1, 4), new Selection(2, 8, 2, 8));
assertContextKeys(contextKeys, true, false, true);
ctrl.next();
assertSelections(editor, new Selection(1, 7, 1, 7), new Selection(2, 11, 2, 11));
assertContextKeys(contextKeys, true, true, true);
ctrl.next();
assertSelections(editor, new Selection(1, 7, 1, 7), new Selection(2, 11, 2, 11));
assertContextKeys(contextKeys, false, false, false);
});
test('insert, nested plain text', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('${1:foobar}$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 1, 1, 7), new Selection(2, 5, 2, 11));
ctrl.insert('farboo');
assertSelections(editor, new Selection(1, 7, 1, 7), new Selection(2, 11, 2, 11));
assertContextKeys(contextKeys, true, false, true);
ctrl.next();
assertSelections(editor, new Selection(1, 7, 1, 7), new Selection(2, 11, 2, 11));
assertContextKeys(contextKeys, false, false, false);
});
test('Nested snippets without final placeholder jumps to next outer placeholder, #27898', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('for(const ${1:element} of ${2:array}) {$0}');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 11, 1, 18), new Selection(2, 15, 2, 22));
ctrl.next();
assertContextKeys(contextKeys, true, true, true);
assertSelections(editor, new Selection(1, 22, 1, 27), new Selection(2, 26, 2, 31));
ctrl.insert('document');
assertContextKeys(contextKeys, true, true, true);
assertSelections(editor, new Selection(1, 30, 1, 30), new Selection(2, 34, 2, 34));
ctrl.next();
assertContextKeys(contextKeys, false, false, false);
});
test('Inconsistent tab stop behaviour with recursive snippets and tab / shift tab, #27543', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
ctrl.insert('1_calize(${1:nl}, \'${2:value}\')$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 10, 1, 12), new Selection(2, 14, 2, 16));
ctrl.insert('2_calize(${1:nl}, \'${2:value}\')$0');
assertSelections(editor, new Selection(1, 19, 1, 21), new Selection(2, 23, 2, 25));
ctrl.next(); // inner `value`
assertSelections(editor, new Selection(1, 24, 1, 29), new Selection(2, 28, 2, 33));
ctrl.next(); // inner `$0`
assertSelections(editor, new Selection(1, 31, 1, 31), new Selection(2, 35, 2, 35));
ctrl.next(); // outer `value`
assertSelections(editor, new Selection(1, 34, 1, 39), new Selection(2, 38, 2, 43));
ctrl.prev(); // inner `$0`
assertSelections(editor, new Selection(1, 31, 1, 31), new Selection(2, 35, 2, 35));
});
test('Snippet tabstop selecting content of previously entered variable only works when separated by space, #23728', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('');
editor.setSelection(new Selection(1, 1, 1, 1));
ctrl.insert('import ${2:${1:module}} from \'${1:module}\'$0');
assertContextKeys(contextKeys, true, false, true);
assertSelections(editor, new Selection(1, 8, 1, 14), new Selection(1, 21, 1, 27));
ctrl.insert('foo');
assertSelections(editor, new Selection(1, 11, 1, 11), new Selection(1, 21, 1, 21));
ctrl.next(); // ${2:...}
assertSelections(editor, new Selection(1, 8, 1, 11));
});
test('HTML Snippets Combine, #32211', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('');
model.updateOptions({ insertSpaces: false, tabSize: 4, trimAutoWhitespace: false });
editor.setSelection(new Selection(1, 1, 1, 1));
ctrl.insert(`
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=\${2:device-width}, initial-scale=\${3:1.0}">
<meta http-equiv="X-UA-Compatible" content="\${5:ie=edge}">
<title>\${7:Document}</title>
</head>
<body>
\${8}
</body>
</html>
`);
ctrl.next();
ctrl.next();
ctrl.next();
ctrl.next();
assertSelections(editor, new Selection(11, 5, 11, 5));
ctrl.insert('<input type="${2:text}">');
assertSelections(editor, new Selection(11, 18, 11, 22));
});
test('Problems with nested snippet insertion #39594', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('');
editor.setSelection(new Selection(1, 1, 1, 1));
ctrl.insert('$1 = ConvertTo-Json $1');
assertSelections(editor, new Selection(1, 1, 1, 1), new Selection(1, 19, 1, 19));
editor.setSelection(new Selection(1, 19, 1, 19));
// snippet mode should stop because $1 has two occurrences
// and we only have one selection left
assertContextKeys(contextKeys, false, false, false);
});
test('Problems with nested snippet insertion #39594', function () {
// ensure selection-change-to-cancel logic isn't too aggressive
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('a-\naaa-');
editor.setSelections([new Selection(2, 5, 2, 5), new Selection(1, 3, 1, 3)]);
ctrl.insert('log($1);$0');
assertSelections(editor, new Selection(2, 9, 2, 9), new Selection(1, 7, 1, 7));
assertContextKeys(contextKeys, true, false, true);
});
test('“Nested” snippets terminating abruptly in VSCode 1.19.2. #42012', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('');
editor.setSelection(new Selection(1, 1, 1, 1));
ctrl.insert('var ${2:${1:name}} = ${1:name} + 1;${0}');
assertSelections(editor, new Selection(1, 5, 1, 9), new Selection(1, 12, 1, 16));
assertContextKeys(contextKeys, true, false, true);
ctrl.next();
assertContextKeys(contextKeys, true, true, true);
});
test('Placeholders order #58267', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('');
editor.setSelection(new Selection(1, 1, 1, 1));
ctrl.insert('\\pth{$1}$0');
assertSelections(editor, new Selection(1, 6, 1, 6));
assertContextKeys(contextKeys, true, false, true);
ctrl.insert('\\itv{${1:left}}{${2:right}}{${3:left_value}}{${4:right_value}}$0');
assertSelections(editor, new Selection(1, 11, 1, 15));
ctrl.next();
assertSelections(editor, new Selection(1, 17, 1, 22));
ctrl.next();
assertSelections(editor, new Selection(1, 24, 1, 34));
ctrl.next();
assertSelections(editor, new Selection(1, 36, 1, 47));
ctrl.next();
assertSelections(editor, new Selection(1, 48, 1, 48));
ctrl.next();
assertSelections(editor, new Selection(1, 49, 1, 49));
assertContextKeys(contextKeys, false, false, false);
});
test('Must tab through deleted tab stops in snippets #31619', function () {
const ctrl = new SnippetController2(editor, logService, contextKeys);
model.setValue('');
editor.setSelection(new Selection(1, 1, 1, 1));
ctrl.insert('foo${1:a${2:bar}baz}end$0');
assertSelections(editor, new Selection(1, 4, 1, 11));
editor.trigger('test', Handler.Cut, null);
assertSelections(editor, new Selection(1, 4, 1, 4));
ctrl.next();
assertSelections(editor, new Selection(1, 7, 1, 7));
assertContextKeys(contextKeys, false, false, false);
});
});
