onEnter.test.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
'use strict';

import * as assert from 'assert';
import {IndentAction, CharacterPair} from 'vs/editor/common/modes';
import {OnEnterSupport} from 'vs/editor/common/modes/supports/onEnter';

suite('OnEnter', () => {

	test('uses indentationRules', () => {
		var support = new OnEnterSupport(null, {
			indentationRules: {
				decreaseIndentPattern: /^\s*((?!\S.*\/[*]).*[*]\/\s*)?[})\]]|^\s*(case\b.*|default):\s*(\/\/.*|\/[*].*[*]\/\s*)?$/,
				increaseIndentPattern: /(\{[^}"']*|\([^)"']*|\[[^\]"']*|^\s*(\{\}|\(\)|\[\]|(case\b.*|default):))\s*(\/\/.*|\/[*].*[*]\/\s*)?$/,
				indentNextLinePattern: /^\s*(for|while|if|else)\b(?!.*[;{}]\s*(\/\/.*|\/[*].*[*]\/\s*)?$)/,
				unIndentedLinePattern: /^(?!.*([;{}]|\S:)\s*(\/\/.*|\/[*].*[*]\/\s*)?$)(?!.*(\{[^}"']*|\([^)"']*|\[[^\]"']*|^\s*(\{\}|\(\)|\[\]|(case\b.*|default):))\s*(\/\/.*|\/[*].*[*]\/\s*)?$)(?!^\s*((?!\S.*\/[*]).*[*]\/\s*)?[})\]]|^\s*(case\b.*|default):\s*(\/\/.*|\/[*].*[*]\/\s*)?$)(?!^\s*(for|while|if|else)\b(?!.*[;{}]\s*(\/\/.*|\/[*].*[*]\/\s*)?$))/
			}
		});

		var testIndentAction = (oneLineAboveText:string, beforeText:string, afterText:string, expected:IndentAction) => {
			var actual = support._actualOnEnter(oneLineAboveText, beforeText, afterText);
			if (expected === IndentAction.None) {
				assert.equal(actual, null);
			} else {
				assert.equal(actual.indentAction, expected);
			}
		};

		testIndentAction('', 'case', '', IndentAction.None);
		testIndentAction('', 'case:', '', IndentAction.Indent);
		testIndentAction('', 'if (true) {', '', IndentAction.Indent);
		testIndentAction('', 'if (true)', '', IndentAction.Indent);
		testIndentAction('', ' ', '}', IndentAction.Outdent);
		testIndentAction('if(true)', '\treturn false', '', IndentAction.Outdent);
	});

	test('uses brackets', () => {
		var brackets: CharacterPair[] = [
			['(', ')'],
			['begin', 'end']
		];
		var support = new OnEnterSupport(null, {
			brackets: brackets
		});
		var testIndentAction = (beforeText:string, afterText:string, expected:IndentAction) => {
			var actual = support._actualOnEnter('', beforeText, afterText);
			if (expected === IndentAction.None) {
				assert.equal(actual, null);
			} else {
				assert.equal(actual.indentAction, expected);
			}
		};

		testIndentAction('a', '', IndentAction.None);
		testIndentAction('', 'b', IndentAction.None);
		testIndentAction('(', 'b', IndentAction.Indent);
		testIndentAction('a', ')', IndentAction.None);
		testIndentAction('begin', 'ending', IndentAction.Indent);
		testIndentAction('abegin', 'end', IndentAction.None);
		testIndentAction('begin', ')', IndentAction.Indent);
		testIndentAction('begin', 'end', IndentAction.IndentOutdent);
		testIndentAction('begin ', ' end', IndentAction.IndentOutdent);
		testIndentAction(' begin', 'end//as', IndentAction.IndentOutdent);
		testIndentAction('(', ')', IndentAction.IndentOutdent);
		testIndentAction('( ', ')', IndentAction.IndentOutdent);
		testIndentAction('a(', ')b', IndentAction.IndentOutdent);

		testIndentAction('(', '', IndentAction.Indent);
		testIndentAction('(', 'foo', IndentAction.Indent);
		testIndentAction('begin', 'foo', IndentAction.Indent);
		testIndentAction('begin', '', IndentAction.Indent);
	});

	test('uses regExpRules', () => {
		var support = new OnEnterSupport(null, {
			regExpRules: [
				{
					beforeText: /^\s*\/\*\*(?!\/)([^\*]|\*(?!\/))*$/,
					afterText: /^\s*\*\/$/,
					action: { indentAction: IndentAction.IndentOutdent, appendText: ' * ' }
				},
				{
					beforeText: /^\s*\/\*\*(?!\/)([^\*]|\*(?!\/))*$/,
					action: { indentAction: IndentAction.None, appendText: ' * ' }
				},
				{
					beforeText: /^(\t|(\ \ ))*\ \*(\ ([^\*]|\*(?!\/))*)?$/,
					action: { indentAction: IndentAction.None, appendText: '* ' }
				},
				{
					beforeText: /^(\t|(\ \ ))*\ \*\/\s*$/,
					action: { indentAction: IndentAction.None, removeText: 1 }
				},
				{
					beforeText: /^(\t|(\ \ ))*\ \*[^/]*\*\/\s*$/,
					action: { indentAction: IndentAction.None, removeText: 1 }
				}
			]
		});
		var testIndentAction = (beforeText:string, afterText:string, expectedIndentAction:IndentAction, expectedAppendText:string, removeText:number = 0) => {
			var actual = support._actualOnEnter('', beforeText, afterText);
			if (expectedIndentAction === null) {
				assert.equal(actual, null, 'isNull:' + beforeText);
			} else {
				assert.equal(actual !== null, true, 'isNotNull:' + beforeText);
				assert.equal(actual.indentAction, expectedIndentAction, 'indentAction:' + beforeText);
				if (expectedAppendText !== null) {
					assert.equal(actual.appendText, expectedAppendText, 'appendText:' + beforeText);
				}
				if (removeText !== 0) {
					assert.equal(actual.removeText, removeText, 'removeText:' + beforeText);
				}
			}
		};

		testIndentAction('\t/**', ' */', IndentAction.IndentOutdent, ' * ');
		testIndentAction('\t/**', '', IndentAction.None, ' * ');
		testIndentAction('\t/** * / * / * /', '', IndentAction.None, ' * ');
		testIndentAction('\t/** /*', '', IndentAction.None, ' * ');
		testIndentAction('/**', '', IndentAction.None, ' * ');
		testIndentAction('\t/**/', '', null, null);
		testIndentAction('\t/***/', '', null, null);
		testIndentAction('\t/*******/', '', null, null);
		testIndentAction('\t/** * * * * */', '', null, null);
		testIndentAction('\t/** */', '', null, null);
		testIndentAction('\t/** asdfg */', '', null, null);
		testIndentAction('\t/* asdfg */', '', null, null);
		testIndentAction('\t/* asdfg */', '', null, null);
		testIndentAction('\t/** asdfg */', '', null, null);
		testIndentAction('*/', '', null, null);
		testIndentAction('\t/*', '', null, null);
		testIndentAction('\t*', '', null, null);
		testIndentAction('\t *', '', IndentAction.None, '* ');
		testIndentAction('\t */', '', IndentAction.None, null, 1);
		testIndentAction('\t * */', '', IndentAction.None, null, 1);
		testIndentAction('\t * * / * / * / */', '', null, null);
		testIndentAction('\t * ', '', IndentAction.None, '* ');
		testIndentAction(' * ', '', IndentAction.None, '* ');
		testIndentAction(' * asdfsfagadfg', '', IndentAction.None, '* ');
		testIndentAction(' * asdfsfagadfg * * * ', '', IndentAction.None, '* ');
		testIndentAction(' * /*', '', IndentAction.None, '* ');
		testIndentAction(' * asdfsfagadfg * / * / * /', '', IndentAction.None, '* ');
		testIndentAction(' * asdfsfagadfg * / * / * /*', '', IndentAction.None, '* ');
		testIndentAction(' */', '', IndentAction.None, null, 1);
		testIndentAction('\t */', '', IndentAction.None, null, 1);
		testIndentAction('\t\t */', '', IndentAction.None, null, 1);
		testIndentAction('   */', '', IndentAction.None, null, 1);
		testIndentAction('     */', '', IndentAction.None, null, 1);
		testIndentAction('\t     */', '', IndentAction.None, null, 1);
		testIndentAction(' *--------------------------------------------------------------------------------------------*/', '', IndentAction.None, null, 1);
	});
});