All files / repl/lib parse_key.js

90.03% Statements 235/261
80% Branches 4/5
50% Functions 1/2
90.03% Lines 235/261

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 26211x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x                                 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 4959x 4959x 4959x 4959x 4959x 4959x 4252x 4252x 707x 707x 707x 707x 707x 707x 707x 707x 707x 707x 707x 707x 707x                     4959x 11x 11x 11x 11x 11x  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var pick = require( '@stdlib/utils/pick' );
var containsFactory = require( '@stdlib/array/base/assert/contains' ).factory;
var isUndefined = require( '@stdlib/assert/is-undefined' );
 
 
// VARIABLES //
 
// Control sequence prefix in ALT combinations:
var ALT_CSI = '\u001B';
 
// Properties in parsed keybinding:
var KEYBINDING_PROPS = [ 'name', 'ctrl', 'shift', 'meta' ];
 
/**
* Asserts if a sequence is an unrecognized symbol.
*
* ## Notes
*
* -   `SHIFT+<symbol>` will result in a keybinding with the name of the resulting symbol and not the original symbol with shift enabled.
*
* @private
* @name isUnrecognizedSymbol
* @type {Function}
*/
var isUnrecognizedSymbol = containsFactory([
	'`',
	'~',
	'!',
	'@',
	'#',
	'$',
	'%',
	'^',
	'&',
	'*',
	'(',
	')',
	'-',
	'_',
	'=',
	'+',
	'{',
	'}',
	'[',
	']',
	'|',
	'\\',
	':',
	';',
	'"',
	'\'',
	'<',
	',',
	'>',
	'.',
	'?',
	'/'
]);
 
/**
* Table mapping unrecognized control sequences to their possible key objects.
*
* ## Notes
*
* -   The following map is recorded as observed in gnome.
*
* @private
* @name CTRL_SEQUENCES_KEYMAP
* @type {Object}
*/
var CTRL_SEQUENCES_KEYMAP = {
	'\u001F': [
		{
			'name': '/',
			'ctrl': true,
			'shift': false,
			'meta': false
		},
		{
			'name': '-',
			'ctrl': true,
			'shift': false,
			'meta': true
		},
		{
			'name': '7',
			'ctrl': true,
			'shift': false,
			'meta': true
		}
	],
	'\u001C': [
		{
			'name': '\\',
			'ctrl': true,
			'shift': false,
			'meta': false
		},
		{
			'name': '\\',
			'ctrl': true,
			'shift': true,
			'meta': false
		},
		{
			'name': '|',
			'ctrl': true,
			'shift': false,
			'meta': false
		},
		{
			'name': '4',
			'ctrl': true,
			'shift': false,
			'meta': false
		}
	],
	'\u001D': [
		{
			'name': ']',
			'ctrl': true,
			'shift': false,
			'meta': false
		},
		{
			'name': ']',
			'ctrl': true,
			'shift': true,
			'meta': false
		},
		{
			'name': '}',
			'ctrl': true,
			'shift': false,
			'meta': false
		},
		{
			'name': '5',
			'ctrl': true,
			'shift': false,
			'meta': false
		}
	],
	'\u001E': [
		{
			'name': '6',
			'ctrl': true,
			'shift': false,
			'meta': false
		},
		{
			'name': '6',
			'ctrl': true,
			'shift': true,
			'meta': false
		},
		{
			'name': '^',
			'ctrl': true,
			'shift': false,
			'meta': false
		}
	]
};
 
 
// FUNCTIONS //
 
/**
* Parses unrecognized control sequences emitted by `ALT+<symbol>` combinations.
*
* @private
* @param {string} seq - control sequence
* @returns {(Object|null)} parsed key object or null if not a meta symbol sequence
*/
function parseMetaSymbolSequence( seq ) {
	if (
		!seq ||
		seq.length !== 2 ||
		seq[ 0 ] !== ALT_CSI ||
		isUnrecognizedSymbol( seq[ 1 ] )
	) {
		return null;
	}
	return {
		'name': seq[ 1 ],
		'ctrl': false,
		'shift': false,
		'meta': true
	};
}
 
 
// MAIN //
 
/**
* Parses a readline keypress object.
*
* @param {Object} key - readline keypress object
* @returns {Array<Object>} list of possible key objects
*/
function parseKey( key ) {
	var out;
	var seq;
 
	// If key is already defined, no need to parse it...
	if ( !isUndefined( key.name ) ) {
		return [ pick( key, KEYBINDING_PROPS ) ];
	}
	seq = key.sequence;
 
	// Check if it's an unrecognized symbol:
	if ( isUnrecognizedSymbol( seq ) ) {
		return [
			{
				'name': seq,
				'ctrl': false,
				'shift': false,
				'meta': false
			}
		];
	}
	// Check if it's a `CTRL+<symbol>` combination:
	if ( hasOwnProp( CTRL_SEQUENCES_KEYMAP, seq ) ) {
		return CTRL_SEQUENCES_KEYMAP[ seq ];
	}
	// Check if it's a `META+<symbol>` combination:
	out = parseMetaSymbolSequence( seq );
	if ( out ) {
		return [ out ];
	}
	return [ pick( key, KEYBINDING_PROPS ) ]; // couldn't parse, return original key
}
 
 
// EXPORTS //
 
module.exports = parseKey;