##// END OF EJS Templates
update notebook quickhelp on new shortcuts
Paul Ivanov -
Show More
@@ -1,251 +1,257
1 1 //----------------------------------------------------------------------------
2 2 // Copyright (C) 2011 The IPython Development Team
3 3 //
4 4 // Distributed under the terms of the BSD License. The full license is in
5 5 // the file COPYING, distributed as part of this software.
6 6 //----------------------------------------------------------------------------
7 7
8 8 //============================================================================
9 9 // Keyboard management
10 10 //============================================================================
11 11
12 12 IPython.namespace('IPython.keyboard');
13 13
14 14 IPython.keyboard = (function (IPython) {
15 15 "use strict";
16 16
17 17 // Setup global keycodes and inverse keycodes.
18 18
19 19 // See http://unixpapa.com/js/key.html for a complete description. The short of
20 20 // it is that there are different keycode sets. Firefox uses the "Mozilla keycodes"
21 21 // and Webkit/IE use the "IE keycodes". These keycode sets are mostly the same
22 22 // but have minor differences.
23 23
24 24 // These apply to Firefox, (Webkit and IE)
25 25 var _keycodes = {
26 26 'a': 65, 'b': 66, 'c': 67, 'd': 68, 'e': 69, 'f': 70, 'g': 71, 'h': 72, 'i': 73,
27 27 'j': 74, 'k': 75, 'l': 76, 'm': 77, 'n': 78, 'o': 79, 'p': 80, 'q': 81, 'r': 82,
28 28 's': 83, 't': 84, 'u': 85, 'v': 86, 'w': 87, 'x': 88, 'y': 89, 'z': 90,
29 29 '1 !': 49, '2 @': 50, '3 #': 51, '4 $': 52, '5 %': 53, '6 ^': 54,
30 30 '7 &': 55, '8 *': 56, '9 (': 57, '0 )': 48,
31 31 '[ {': 219, '] }': 221, '` ~': 192, ', <': 188, '. >': 190, '/ ?': 191,
32 32 '\\ |': 220, '\' "': 222,
33 33 'numpad0': 96, 'numpad1': 97, 'numpad2': 98, 'numpad3': 99, 'numpad4': 100,
34 34 'numpad5': 101, 'numpad6': 102, 'numpad7': 103, 'numpad8': 104, 'numpad9': 105,
35 35 'multiply': 106, 'add': 107, 'subtract': 109, 'decimal': 110, 'divide': 111,
36 36 'f1': 112, 'f2': 113, 'f3': 114, 'f4': 115, 'f5': 116, 'f6': 117, 'f7': 118,
37 37 'f8': 119, 'f9': 120, 'f11': 122, 'f12': 123, 'f13': 124, 'f14': 125, 'f15': 126,
38 38 'backspace': 8, 'tab': 9, 'enter': 13, 'shift': 16, 'ctrl': 17, 'alt': 18,
39 39 'meta': 91, 'capslock': 20, 'esc': 27, 'space': 32, 'pageup': 33, 'pagedown': 34,
40 40 'end': 35, 'home': 36, 'left': 37, 'up': 38, 'right': 39, 'down': 40,
41 41 'insert': 45, 'delete': 46, 'numlock': 144,
42 42 };
43 43
44 44 // These apply to Firefox and Opera
45 45 var _mozilla_keycodes = {
46 46 '; :': 59, '= +': 61, '- _': 173, 'meta': 224
47 47 }
48 48
49 49 // This apply to Webkit and IE
50 50 var _ie_keycodes = {
51 51 '; :': 186, '= +': 187, '- _': 189,
52 52 }
53 53
54 54 var browser = IPython.utils.browser[0];
55 55 var platform = IPython.utils.platform;
56 56
57 57 if (browser === 'Firefox' || browser === 'Opera') {
58 58 $.extend(_keycodes, _mozilla_keycodes);
59 59 } else if (browser === 'Safari' || browser === 'Chrome' || browser === 'MSIE') {
60 60 $.extend(_keycodes, _ie_keycodes);
61 61 }
62 62
63 63 var keycodes = {};
64 64 var inv_keycodes = {};
65 65 for (var name in _keycodes) {
66 66 var names = name.split(' ');
67 67 if (names.length === 1) {
68 68 var n = names[0]
69 69 keycodes[n] = _keycodes[n]
70 70 inv_keycodes[_keycodes[n]] = n
71 71 } else {
72 72 var primary = names[0];
73 73 var secondary = names[1];
74 74 keycodes[primary] = _keycodes[name]
75 75 keycodes[secondary] = _keycodes[name]
76 76 inv_keycodes[_keycodes[name]] = primary
77 77 }
78 78 }
79 79
80 80 var normalize_key = function (key) {
81 81 return inv_keycodes[keycodes[key]];
82 82 }
83 83
84 84 var normalize_shortcut = function (shortcut) {
85 85 // Put a shortcut into normalized form:
86 86 // 1. Make lowercase
87 87 // 2. Replace cmd by meta
88 88 // 3. Sort '+' separated modifiers into the order alt+ctrl+meta+shift
89 89 // 4. Normalize keys
90 90 shortcut = shortcut.toLowerCase().replace('cmd', 'meta');
91 91 var values = shortcut.split("+");
92 92 if (values.length === 1) {
93 93 return normalize_key(values[0])
94 94 } else {
95 95 var modifiers = values.slice(0,-1);
96 96 var key = normalize_key(values[values.length-1]);
97 97 modifiers.sort();
98 98 return modifiers.join('+') + '+' + key;
99 99 }
100 100 }
101 101
102 102 var shortcut_to_event = function (shortcut, type) {
103 103 // Convert a shortcut (shift+r) to a jQuery Event object
104 104 type = type || 'keydown';
105 105 shortcut = normalize_shortcut(shortcut);
106 106 var values = shortcut.split("+");
107 107 var modifiers = values.slice(0,-1);
108 108 var key = values[values.length-1];
109 109 var opts = {which: keycodes[key]};
110 110 if (modifiers.indexOf('alt') !== -1) {opts.altKey = true;}
111 111 if (modifiers.indexOf('ctrl') !== -1) {opts.ctrlKey = true;}
112 112 if (modifiers.indexOf('meta') !== -1) {opts.metaKey = true;}
113 113 if (modifiers.indexOf('shift') !== -1) {opts.shiftKey = true;}
114 114 return $.Event(type, opts);
115 115 }
116 116
117 117 var event_to_shortcut = function (event) {
118 118 // Convert a jQuery Event object to a shortcut (shift+r)
119 119 var shortcut = '';
120 120 var key = inv_keycodes[event.which]
121 121 if (event.altKey && key !== 'alt') {shortcut += 'alt+';}
122 122 if (event.ctrlKey && key !== 'ctrl') {shortcut += 'ctrl+';}
123 123 if (event.metaKey && key !== 'meta') {shortcut += 'meta+';}
124 124 if (event.shiftKey && key !== 'shift') {shortcut += 'shift+';}
125 125 shortcut += key;
126 126 return shortcut
127 127 }
128 128
129 129 var trigger_keydown = function (shortcut, element) {
130 130 // Trigger shortcut keydown on an element
131 131 element = element || document;
132 132 element = $(element);
133 133 var event = shortcut_to_event(shortcut, 'keydown');
134 134 element.trigger(event);
135 135 }
136 136
137 137
138 138 // Shortcut manager class
139 139
140 140 var ShortcutManager = function (delay) {
141 141 this._shortcuts = {}
142 142 this._counts = {}
143 143 this._timers = {}
144 144 this.delay = delay || 800; // delay in milliseconds
145 145 }
146 146
147 147 ShortcutManager.prototype.help = function () {
148 148 var help = [];
149 149 for (var shortcut in this._shortcuts) {
150 150 var help_string = this._shortcuts[shortcut]['help'];
151 151 var help_index = this._shortcuts[shortcut]['help_index'];
152 152 if (help_string) {
153 153 if (platform === 'MacOS') {
154 154 shortcut = shortcut.replace('meta', 'cmd');
155 155 }
156 156 help.push({
157 157 shortcut: shortcut,
158 158 help: help_string,
159 159 help_index: help_index}
160 160 );
161 161 }
162 162 }
163 163 help.sort(function (a, b) {
164 164 if (a.help_index > b.help_index)
165 165 return 1;
166 166 if (a.help_index < b.help_index)
167 167 return -1;
168 168 return 0;
169 169 });
170 170 return help;
171 171 }
172 172
173 173 ShortcutManager.prototype.clear_shortcuts = function () {
174 174 this._shortcuts = {};
175 175 }
176 176
177 ShortcutManager.prototype.add_shortcut = function (shortcut, data) {
177 ShortcutManager.prototype.add_shortcut = function (shortcut, data, suppress_help_update) {
178 178 if (typeof(data) === 'function') {
179 179 data = {help: '', help_index: '', handler: data}
180 180 }
181 181 data.help_index = data.help_index || '';
182 182 data.help = data.help || '';
183 183 data.count = data.count || 1;
184 184 if (data.help_index === '') {
185 185 data.help_index = 'zz';
186 186 }
187 187 shortcut = normalize_shortcut(shortcut);
188 188 this._counts[shortcut] = 0;
189 189 this._shortcuts[shortcut] = data;
190 if (!suppress_help_update) {
191 // update the keyboard shortcuts notebook help
192 IPython.quick_help = new IPython.QuickHelp();
193 }
190 194 }
191 195
192 196 ShortcutManager.prototype.add_shortcuts = function (data) {
193 197 for (var shortcut in data) {
194 this.add_shortcut(shortcut, data[shortcut]);
198 this.add_shortcut(shortcut, data[shortcut], True);
195 199 }
200 // update the keyboard shortcuts notebook help
201 IPython.quick_help = new IPython.QuickHelp();
196 202 }
197 203
198 204 ShortcutManager.prototype.remove_shortcut = function (shortcut) {
199 205 shortcut = normalize_shortcut(shortcut);
200 206 delete this._counts[shortcut];
201 207 delete this._shortcuts[shortcut];
202 208 }
203 209
204 210 ShortcutManager.prototype.count_handler = function (shortcut, event, data) {
205 211 var that = this;
206 212 var c = this._counts;
207 213 var t = this._timers;
208 214 var timer = null;
209 215 if (c[shortcut] === data.count-1) {
210 216 c[shortcut] = 0;
211 217 var timer = t[shortcut];
212 218 if (timer) {clearTimeout(timer); delete t[shortcut];}
213 219 return data.handler(event);
214 220 } else {
215 221 c[shortcut] = c[shortcut] + 1;
216 222 timer = setTimeout(function () {
217 223 c[shortcut] = 0;
218 224 }, that.delay);
219 225 t[shortcut] = timer;
220 226 }
221 227 return false;
222 228 }
223 229
224 230 ShortcutManager.prototype.call_handler = function (event) {
225 231 var shortcut = event_to_shortcut(event);
226 232 var data = this._shortcuts[shortcut];
227 233 if (data) {
228 234 var handler = data['handler'];
229 235 if (handler) {
230 236 if (data.count === 1) {
231 237 return handler(event);
232 238 } else if (data.count > 1) {
233 239 return this.count_handler(shortcut, event, data);
234 240 }
235 241 }
236 242 }
237 243 return true;
238 244 }
239 245
240 246 return {
241 247 keycodes : keycodes,
242 248 inv_keycodes : inv_keycodes,
243 249 ShortcutManager : ShortcutManager,
244 250 normalize_key : normalize_key,
245 251 normalize_shortcut : normalize_shortcut,
246 252 shortcut_to_event : shortcut_to_event,
247 253 event_to_shortcut : event_to_shortcut,
248 254 trigger_keydown : trigger_keydown
249 255 }
250 256
251 257 }(IPython));
General Comments 0
You need to be logged in to leave comments. Login now