Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Laboratory |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /* |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 18 | ONOS GUI -- Util -- Key Handler Service |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 19 | */ |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 20 | (function () { |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 21 | 'use strict'; |
| 22 | |
| 23 | // references to injected services |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 24 | var $log, $timeout, fs, ts, ns, ee, qhs; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 25 | |
| 26 | // internal state |
Simon Hunt | 36fc15c | 2015-02-12 17:02:58 -0800 | [diff] [blame] | 27 | var enabled = true, |
Simon Hunt | d557925 | 2015-10-06 15:09:14 -0700 | [diff] [blame] | 28 | globalEnabled = true, |
Simon Hunt | 36fc15c | 2015-02-12 17:02:58 -0800 | [diff] [blame] | 29 | keyHandler = { |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 30 | globalKeys: {}, |
| 31 | maskedKeys: {}, |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 32 | dialogKeys: {}, |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 33 | viewKeys: {}, |
| 34 | viewFn: null, |
| 35 | viewGestures: [] |
Simon Hunt | 9f5e97d | 2015-12-11 10:32:09 -0800 | [diff] [blame] | 36 | }, |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 37 | seq = {}, |
| 38 | matching = false, |
| 39 | matched = '', |
| 40 | lookup; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 41 | |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 42 | function matchSeq(key) { |
| 43 | if (!matching && key === 'shift') { |
| 44 | matching = true; |
Thomas Vachuska | fe1f01a | 2015-12-10 23:56:02 -0800 | [diff] [blame] | 45 | return true; |
Simon Hunt | 9f5e97d | 2015-12-11 10:32:09 -0800 | [diff] [blame] | 46 | } |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 47 | if (matching) { |
| 48 | matched += key; |
| 49 | lookup = fs.trieLookup(seq, matched); |
| 50 | if (lookup === -1) { |
| 51 | return true; |
| 52 | } |
| 53 | matching = false; |
| 54 | matched = ''; |
| 55 | if (!lookup) { |
| 56 | return; |
| 57 | } |
| 58 | ee.cluck(lookup); |
| 59 | return true; |
Thomas Vachuska | fe1f01a | 2015-12-10 23:56:02 -0800 | [diff] [blame] | 60 | } |
Thomas Vachuska | fe1f01a | 2015-12-10 23:56:02 -0800 | [diff] [blame] | 61 | } |
| 62 | |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 63 | function whatKey(code) { |
| 64 | switch (code) { |
Simon Hunt | 18d4bc8 | 2016-01-08 14:09:35 -0800 | [diff] [blame] | 65 | case 8: return 'delete'; |
| 66 | case 9: return 'tab'; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 67 | case 13: return 'enter'; |
| 68 | case 16: return 'shift'; |
| 69 | case 17: return 'ctrl'; |
| 70 | case 18: return 'alt'; |
| 71 | case 27: return 'esc'; |
| 72 | case 32: return 'space'; |
| 73 | case 37: return 'leftArrow'; |
| 74 | case 38: return 'upArrow'; |
| 75 | case 39: return 'rightArrow'; |
| 76 | case 40: return 'downArrow'; |
| 77 | case 91: return 'cmdLeft'; |
| 78 | case 93: return 'cmdRight'; |
Simon Hunt | 18d4bc8 | 2016-01-08 14:09:35 -0800 | [diff] [blame] | 79 | case 186: return 'semicolon'; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 80 | case 187: return 'equals'; |
Simon Hunt | 90dcc3e | 2015-03-25 15:01:27 -0700 | [diff] [blame] | 81 | case 188: return 'comma'; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 82 | case 189: return 'dash'; |
Simon Hunt | 90dcc3e | 2015-03-25 15:01:27 -0700 | [diff] [blame] | 83 | case 190: return 'dot'; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 84 | case 191: return 'slash'; |
| 85 | case 192: return 'backQuote'; |
Simon Hunt | 18d4bc8 | 2016-01-08 14:09:35 -0800 | [diff] [blame] | 86 | case 219: return 'openBracket'; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 87 | case 220: return 'backSlash'; |
Simon Hunt | 18d4bc8 | 2016-01-08 14:09:35 -0800 | [diff] [blame] | 88 | case 221: return 'closeBracket'; |
| 89 | case 222: return 'quote'; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 90 | default: |
| 91 | if ((code >= 48 && code <= 57) || |
| 92 | (code >= 65 && code <= 90)) { |
| 93 | return String.fromCharCode(code); |
| 94 | } else if (code >= 112 && code <= 123) { |
| 95 | return 'F' + (code - 111); |
| 96 | } |
| 97 | return '.'; |
| 98 | } |
| 99 | } |
| 100 | |
Fan Cheng | 12ed9af | 2016-06-17 15:04:27 +0800 | [diff] [blame] | 101 | function textFieldInput() { |
| 102 | var t = d3.event.target.tagName.toLowerCase(); |
| 103 | return t === 'input' || t === 'textarea'; |
| 104 | } |
| 105 | |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 106 | function keyIn() { |
Fan Cheng | 12ed9af | 2016-06-17 15:04:27 +0800 | [diff] [blame] | 107 | if (textFieldInput()) { |
| 108 | return; |
| 109 | } |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 110 | var event = d3.event, |
| 111 | keyCode = event.keyCode, |
| 112 | key = whatKey(keyCode), |
| 113 | kh = keyHandler, |
| 114 | gk = kh.globalKeys[key], |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 115 | gcb = fs.isF(gk) || (fs.isA(gk) && fs.isF(gk[0])), |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 116 | dk = kh.dialogKeys[key], |
| 117 | dcb = fs.isF(dk), |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 118 | vk = kh.viewKeys[key], |
Simon Hunt | 0906014 | 2015-03-18 20:23:32 -0700 | [diff] [blame] | 119 | kl = fs.isF(kh.viewKeys._keyListener), |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 120 | vcb = fs.isF(vk) || (fs.isA(vk) && fs.isF(vk[0])) || fs.isF(kh.viewFn), |
Simon Hunt | 1bf1e8c | 2015-04-08 10:12:43 -0700 | [diff] [blame] | 121 | token = 'keyev'; // indicate this was a key-pressed event |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 122 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 123 | d3.event.stopPropagation(); |
| 124 | |
Simon Hunt | 36fc15c | 2015-02-12 17:02:58 -0800 | [diff] [blame] | 125 | if (enabled) { |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 126 | if (matchSeq(key)) return; |
Thomas Vachuska | fe1f01a | 2015-12-10 23:56:02 -0800 | [diff] [blame] | 127 | |
Simon Hunt | 36fc15c | 2015-02-12 17:02:58 -0800 | [diff] [blame] | 128 | // global callback? |
| 129 | if (gcb && gcb(token, key, keyCode, event)) { |
| 130 | // if the event was 'handled', we are done |
| 131 | return; |
| 132 | } |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 133 | // dialog callback? |
| 134 | if (dcb) { |
| 135 | dcb(token, key, keyCode, event); |
| 136 | // assume dialog handled the event |
| 137 | return; |
| 138 | } |
Simon Hunt | 36fc15c | 2015-02-12 17:02:58 -0800 | [diff] [blame] | 139 | // otherwise, let the view callback have a shot |
| 140 | if (vcb) { |
| 141 | vcb(token, key, keyCode, event); |
| 142 | } |
Simon Hunt | 0906014 | 2015-03-18 20:23:32 -0700 | [diff] [blame] | 143 | if (kl) { |
| 144 | kl(key); |
| 145 | } |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 146 | } |
| 147 | } |
| 148 | |
| 149 | function setupGlobalKeys() { |
Simon Hunt | 404f6b2 | 2015-01-21 14:00:56 -0800 | [diff] [blame] | 150 | angular.extend(keyHandler, { |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 151 | globalKeys: { |
| 152 | backSlash: [quickHelp, 'Show / hide Quick Help'], |
| 153 | slash: [quickHelp, 'Show / hide Quick Help'], |
| 154 | esc: [escapeKey, 'Dismiss dialog or cancel selections'], |
| 155 | T: [toggleTheme, "Toggle theme"] |
| 156 | }, |
| 157 | globalFormat: ['backSlash', 'slash', 'esc', 'T'], |
| 158 | |
| 159 | // Masked keys are global key handlers that always return true. |
| 160 | // That is, the view will never see the event for that key. |
| 161 | maskedKeys: { |
| 162 | slash: true, |
| 163 | backSlash: true, |
| 164 | T: true |
| 165 | } |
| 166 | }); |
| 167 | } |
| 168 | |
| 169 | function quickHelp(view, key, code, ev) { |
Simon Hunt | d557925 | 2015-10-06 15:09:14 -0700 | [diff] [blame] | 170 | if (!globalEnabled) { |
| 171 | return false; |
| 172 | } |
Simon Hunt | 639dc66 | 2015-02-18 14:19:20 -0800 | [diff] [blame] | 173 | qhs.showQuickHelp(keyHandler); |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 174 | return true; |
| 175 | } |
| 176 | |
Simon Hunt | a0eb0a8 | 2015-02-11 12:30:06 -0800 | [diff] [blame] | 177 | // returns true if we 'consumed' the ESC keypress, false otherwise |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 178 | function escapeKey(view, key, code, ev) { |
Simon Hunt | 9d28656 | 2015-03-09 13:53:50 -0700 | [diff] [blame] | 179 | return ns.hideIfShown() || qhs.hideQuickHelp(); |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | function toggleTheme(view, key, code, ev) { |
Simon Hunt | d557925 | 2015-10-06 15:09:14 -0700 | [diff] [blame] | 183 | if (!globalEnabled) { |
| 184 | return false; |
| 185 | } |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 186 | ts.toggleTheme(); |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 187 | return true; |
| 188 | } |
| 189 | |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 190 | function filterMaskedKeys(map, caller, remove) { |
| 191 | var masked = [], |
| 192 | msgs = []; |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 193 | |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 194 | d3.map(map).keys().forEach(function (key) { |
| 195 | if (keyHandler.maskedKeys[key]) { |
| 196 | masked.push(key); |
| 197 | msgs.push(caller, ': Key "' + key + '" is reserved'); |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 198 | } |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 199 | }); |
| 200 | |
| 201 | if (msgs.length) { |
| 202 | $log.warn(msgs.join('\n')); |
| 203 | } |
| 204 | |
| 205 | if (remove) { |
| 206 | masked.forEach(function (k) { |
| 207 | delete map[k]; |
| 208 | }); |
| 209 | } |
| 210 | return masked; |
| 211 | } |
| 212 | |
| 213 | function unexParam(fname, x) { |
| 214 | $log.warn(fname, ": unexpected parameter-- ", x); |
| 215 | } |
| 216 | |
| 217 | function setKeyBindings(keyArg) { |
| 218 | var fname = 'setKeyBindings()', |
| 219 | kFunc = fs.isF(keyArg), |
| 220 | kMap = fs.isO(keyArg); |
| 221 | |
| 222 | if (kFunc) { |
| 223 | // set general key handler callback |
| 224 | keyHandler.viewFn = kFunc; |
| 225 | } else if (kMap) { |
| 226 | filterMaskedKeys(kMap, fname, true); |
| 227 | keyHandler.viewKeys = kMap; |
| 228 | } else { |
| 229 | unexParam(fname, keyArg); |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 230 | } |
| 231 | } |
| 232 | |
| 233 | function getKeyBindings() { |
| 234 | var gkeys = d3.map(keyHandler.globalKeys).keys(), |
| 235 | masked = d3.map(keyHandler.maskedKeys).keys(), |
| 236 | vkeys = d3.map(keyHandler.viewKeys).keys(), |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 237 | vfn = !!fs.isF(keyHandler.viewFn); |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 238 | |
| 239 | return { |
| 240 | globalKeys: gkeys, |
| 241 | maskedKeys: masked, |
| 242 | viewKeys: vkeys, |
| 243 | viewFunction: vfn |
| 244 | }; |
| 245 | } |
| 246 | |
Bri Prebilic Cole | 9dcaea5 | 2015-07-21 14:39:48 -0700 | [diff] [blame] | 247 | function unbindKeys() { |
| 248 | keyHandler.viewKeys = {}; |
| 249 | keyHandler.viewFn = null; |
| 250 | keyHandler.viewGestures = []; |
| 251 | } |
| 252 | |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 253 | function bindDialogKeys(map) { |
| 254 | var fname = 'bindDialogKeys()', |
| 255 | kMap = fs.isO(map); |
| 256 | |
| 257 | if (kMap) { |
| 258 | filterMaskedKeys(map, fname, true); |
| 259 | keyHandler.dialogKeys = kMap; |
| 260 | } else { |
| 261 | unexParam(fname, map); |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | function unbindDialogKeys() { |
| 266 | keyHandler.dialogKeys = {}; |
| 267 | } |
| 268 | |
Simon Hunt | 7189222 | 2015-09-29 13:39:40 -0700 | [diff] [blame] | 269 | function checkNotGlobal(o) { |
| 270 | var oops = []; |
| 271 | if (fs.isO(o)) { |
| 272 | angular.forEach(o, function (val, key) { |
| 273 | if (keyHandler.globalKeys[key]) { |
| 274 | oops.push(key); |
| 275 | } |
| 276 | }); |
| 277 | if (oops.length) { |
| 278 | $log.warn('Ignoring reserved global key(s):', oops.join(',')); |
| 279 | oops.forEach(function (key) { |
| 280 | delete o[key]; |
| 281 | }); |
| 282 | } |
| 283 | } |
| 284 | } |
| 285 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 286 | angular.module('onosUtil') |
Simon Hunt | 639dc66 | 2015-02-18 14:19:20 -0800 | [diff] [blame] | 287 | .factory('KeyService', |
Simon Hunt | 9f5e97d | 2015-12-11 10:32:09 -0800 | [diff] [blame] | 288 | ['$log', '$timeout', 'FnService', 'ThemeService', 'NavService', |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 289 | 'EeService', |
Simon Hunt | 639dc66 | 2015-02-18 14:19:20 -0800 | [diff] [blame] | 290 | |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 291 | function (_$log_, _$timeout_, _fs_, _ts_, _ns_, _ee_) { |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 292 | $log = _$log_; |
Simon Hunt | 9f5e97d | 2015-12-11 10:32:09 -0800 | [diff] [blame] | 293 | $timeout = _$timeout_; |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 294 | fs = _fs_; |
| 295 | ts = _ts_; |
Simon Hunt | 9d28656 | 2015-03-09 13:53:50 -0700 | [diff] [blame] | 296 | ns = _ns_; |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 297 | ee = _ee_; |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 298 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 299 | return { |
Simon Hunt | 639dc66 | 2015-02-18 14:19:20 -0800 | [diff] [blame] | 300 | bindQhs: function (_qhs_) { |
| 301 | qhs = _qhs_; |
| 302 | }, |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 303 | installOn: function (elem) { |
| 304 | elem.on('keydown', keyIn); |
| 305 | setupGlobalKeys(); |
| 306 | }, |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 307 | keyBindings: function (x) { |
| 308 | if (x === undefined) { |
| 309 | return getKeyBindings(); |
| 310 | } else { |
| 311 | setKeyBindings(x); |
| 312 | } |
| 313 | }, |
Bri Prebilic Cole | 9dcaea5 | 2015-07-21 14:39:48 -0700 | [diff] [blame] | 314 | unbindKeys: unbindKeys, |
Simon Hunt | 5198f08 | 2016-02-04 13:41:17 -0800 | [diff] [blame] | 315 | dialogKeys: function (x) { |
| 316 | if (x === undefined) { |
| 317 | unbindDialogKeys(); |
| 318 | } else { |
| 319 | bindDialogKeys(x); |
| 320 | } |
| 321 | }, |
Simon Hunt | f4ef6dd | 2016-02-03 17:05:14 -0800 | [diff] [blame] | 322 | addSeq: function (word, data) { |
| 323 | fs.addToTrie(seq, word, data); |
| 324 | }, |
| 325 | remSeq: function (word) { |
| 326 | fs.removeFromTrie(seq, word); |
| 327 | }, |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 328 | gestureNotes: function (g) { |
| 329 | if (g === undefined) { |
| 330 | return keyHandler.viewGestures; |
| 331 | } else { |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 332 | keyHandler.viewGestures = fs.isA(g) || []; |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 333 | } |
Simon Hunt | 36fc15c | 2015-02-12 17:02:58 -0800 | [diff] [blame] | 334 | }, |
| 335 | enableKeys: function (b) { |
| 336 | enabled = b; |
Simon Hunt | 7189222 | 2015-09-29 13:39:40 -0700 | [diff] [blame] | 337 | }, |
Simon Hunt | d557925 | 2015-10-06 15:09:14 -0700 | [diff] [blame] | 338 | enableGlobalKeys: function (b) { |
| 339 | globalEnabled = b; |
| 340 | }, |
Simon Hunt | 7189222 | 2015-09-29 13:39:40 -0700 | [diff] [blame] | 341 | checkNotGlobal: checkNotGlobal |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 342 | }; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 343 | }]); |
| 344 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 345 | }()); |