Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 1 | /* |
Simon Hunt | 8ead3a2 | 2015-01-06 11:00:15 -0800 | [diff] [blame] | 2 | * Copyright 2014,2015 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 |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 24 | var $log, fs, ts; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 25 | |
| 26 | // internal state |
| 27 | var keyHandler = { |
| 28 | globalKeys: {}, |
| 29 | maskedKeys: {}, |
| 30 | viewKeys: {}, |
| 31 | viewFn: null, |
| 32 | viewGestures: [] |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 33 | }; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 34 | |
| 35 | // TODO: we need to have the concept of view token here.. |
| 36 | function getViewToken() { |
| 37 | return 'NotYetAViewToken'; |
| 38 | } |
| 39 | |
| 40 | function whatKey(code) { |
| 41 | switch (code) { |
| 42 | case 13: return 'enter'; |
| 43 | case 16: return 'shift'; |
| 44 | case 17: return 'ctrl'; |
| 45 | case 18: return 'alt'; |
| 46 | case 27: return 'esc'; |
| 47 | case 32: return 'space'; |
| 48 | case 37: return 'leftArrow'; |
| 49 | case 38: return 'upArrow'; |
| 50 | case 39: return 'rightArrow'; |
| 51 | case 40: return 'downArrow'; |
| 52 | case 91: return 'cmdLeft'; |
| 53 | case 93: return 'cmdRight'; |
| 54 | case 187: return 'equals'; |
| 55 | case 189: return 'dash'; |
| 56 | case 191: return 'slash'; |
| 57 | case 192: return 'backQuote'; |
| 58 | case 220: return 'backSlash'; |
| 59 | default: |
| 60 | if ((code >= 48 && code <= 57) || |
| 61 | (code >= 65 && code <= 90)) { |
| 62 | return String.fromCharCode(code); |
| 63 | } else if (code >= 112 && code <= 123) { |
| 64 | return 'F' + (code - 111); |
| 65 | } |
| 66 | return '.'; |
| 67 | } |
| 68 | } |
| 69 | |
| 70 | function keyIn() { |
| 71 | var event = d3.event, |
| 72 | keyCode = event.keyCode, |
| 73 | key = whatKey(keyCode), |
| 74 | kh = keyHandler, |
| 75 | gk = kh.globalKeys[key], |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 76 | gcb = fs.isF(gk) || (fs.isA(gk) && fs.isF(gk[0])), |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 77 | vk = kh.viewKeys[key], |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 78 | vcb = fs.isF(vk) || (fs.isA(vk) && fs.isF(vk[0])) || fs.isF(kh.viewFn), |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 79 | token = getViewToken(); |
| 80 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 81 | d3.event.stopPropagation(); |
| 82 | |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 83 | // global callback? |
| 84 | if (gcb && gcb(token, key, keyCode, event)) { |
| 85 | // if the event was 'handled', we are done |
| 86 | return; |
| 87 | } |
| 88 | // otherwise, let the view callback have a shot |
| 89 | if (vcb) { |
| 90 | vcb(token, key, keyCode, event); |
| 91 | } |
| 92 | } |
| 93 | |
| 94 | function setupGlobalKeys() { |
Simon Hunt | 404f6b2 | 2015-01-21 14:00:56 -0800 | [diff] [blame^] | 95 | angular.extend(keyHandler, { |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 96 | globalKeys: { |
| 97 | backSlash: [quickHelp, 'Show / hide Quick Help'], |
| 98 | slash: [quickHelp, 'Show / hide Quick Help'], |
| 99 | esc: [escapeKey, 'Dismiss dialog or cancel selections'], |
| 100 | T: [toggleTheme, "Toggle theme"] |
| 101 | }, |
| 102 | globalFormat: ['backSlash', 'slash', 'esc', 'T'], |
| 103 | |
| 104 | // Masked keys are global key handlers that always return true. |
| 105 | // That is, the view will never see the event for that key. |
| 106 | maskedKeys: { |
| 107 | slash: true, |
| 108 | backSlash: true, |
| 109 | T: true |
| 110 | } |
| 111 | }); |
| 112 | } |
| 113 | |
| 114 | function quickHelp(view, key, code, ev) { |
| 115 | // TODO: show quick help |
Simon Hunt | 7256d08 | 2014-12-18 21:43:28 -0800 | [diff] [blame] | 116 | // delegate to QuickHelp service. |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 117 | //libApi.quickHelp.show(keyHandler); |
| 118 | console.log('QUICK-HELP'); |
| 119 | return true; |
| 120 | } |
| 121 | |
| 122 | function escapeKey(view, key, code, ev) { |
| 123 | // TODO: plumb in handling of alerts and quick help dismissal |
Simon Hunt | 7256d08 | 2014-12-18 21:43:28 -0800 | [diff] [blame] | 124 | // We will delegate to the Alert / QuickHelp Services as appropriate. |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 125 | /* |
| 126 | if (alerts.open) { |
| 127 | closeAlerts(); |
| 128 | return true; |
| 129 | } |
| 130 | if (libApi.quickHelp.hide()) { |
| 131 | return true; |
| 132 | } |
| 133 | */ |
| 134 | console.log('ESCAPE'); |
| 135 | return false; |
| 136 | } |
| 137 | |
| 138 | function toggleTheme(view, key, code, ev) { |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 139 | ts.toggleTheme(); |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 140 | return true; |
| 141 | } |
| 142 | |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 143 | function setKeyBindings(keyArg) { |
| 144 | var viewKeys, |
| 145 | masked = []; |
| 146 | |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 147 | if (fs.isF(keyArg)) { |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 148 | // set general key handler callback |
| 149 | keyHandler.viewFn = keyArg; |
| 150 | } else { |
| 151 | // set specific key filter map |
| 152 | viewKeys = d3.map(keyArg).keys(); |
| 153 | viewKeys.forEach(function (key) { |
| 154 | if (keyHandler.maskedKeys[key]) { |
Simon Hunt | af32207 | 2014-12-18 13:23:40 -0800 | [diff] [blame] | 155 | masked.push('setKeyBindings(): Key "' + key + '" is reserved'); |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 156 | } |
| 157 | }); |
| 158 | |
| 159 | if (masked.length) { |
Simon Hunt | af32207 | 2014-12-18 13:23:40 -0800 | [diff] [blame] | 160 | $log.warn(masked.join('\n')); |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 161 | } |
| 162 | keyHandler.viewKeys = keyArg; |
| 163 | } |
| 164 | } |
| 165 | |
| 166 | function getKeyBindings() { |
| 167 | var gkeys = d3.map(keyHandler.globalKeys).keys(), |
| 168 | masked = d3.map(keyHandler.maskedKeys).keys(), |
| 169 | vkeys = d3.map(keyHandler.viewKeys).keys(), |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 170 | vfn = !!fs.isF(keyHandler.viewFn); |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 171 | |
| 172 | return { |
| 173 | globalKeys: gkeys, |
| 174 | maskedKeys: masked, |
| 175 | viewKeys: vkeys, |
| 176 | viewFunction: vfn |
| 177 | }; |
| 178 | } |
| 179 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 180 | angular.module('onosUtil') |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 181 | .factory('KeyService', ['$log', 'FnService', 'ThemeService', |
| 182 | function (_$log_, _fs_, _ts_) { |
| 183 | $log = _$log_; |
| 184 | fs = _fs_; |
| 185 | ts = _ts_; |
| 186 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 187 | return { |
| 188 | installOn: function (elem) { |
| 189 | elem.on('keydown', keyIn); |
| 190 | setupGlobalKeys(); |
| 191 | }, |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 192 | keyBindings: function (x) { |
| 193 | if (x === undefined) { |
| 194 | return getKeyBindings(); |
| 195 | } else { |
| 196 | setKeyBindings(x); |
| 197 | } |
| 198 | }, |
| 199 | gestureNotes: function (g) { |
| 200 | if (g === undefined) { |
| 201 | return keyHandler.viewGestures; |
| 202 | } else { |
Yuta HIGUCHI | 4f39bcd | 2014-12-18 20:46:14 -0800 | [diff] [blame] | 203 | keyHandler.viewGestures = fs.isA(g) || []; |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 204 | } |
Simon Hunt | 59df0b2 | 2014-12-17 10:32:25 -0800 | [diff] [blame] | 205 | } |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 206 | }; |
Simon Hunt | 1eecfa2 | 2014-12-16 14:46:29 -0800 | [diff] [blame] | 207 | }]); |
| 208 | |
Simon Hunt | dc6362a | 2014-12-18 19:55:23 -0800 | [diff] [blame] | 209 | }()); |