Show More
@@ -1,262 +1,263 | |||
|
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 |
'; :': 59, '= +': 61, '- _': 173, |
|
|
46 | '; :': 59, '= +': 61, '- _': 173, 'meta': 224 | |
|
47 | 47 | }; |
|
48 | 48 | |
|
49 | 49 | // This apply to Webkit and IE |
|
50 | 50 | var _ie_keycodes = { |
|
51 |
'; :': 186, '= +': 187, '- _': 189 |
|
|
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 |
shortcut = shortcut.replace(/-$/, ' |
|
|
91 | shortcut = shortcut.replace(/-$/, '_'); // catch shortcuts using '-' key | |
|
92 | 92 | var values = shortcut.split("-"); |
|
93 | 93 | if (values.length === 1) { |
|
94 | 94 | return normalize_key(values[0]); |
|
95 | 95 | } else { |
|
96 | 96 | var modifiers = values.slice(0,-1); |
|
97 | 97 | var key = normalize_key(values[values.length-1]); |
|
98 | 98 | modifiers.sort(); |
|
99 | 99 | return modifiers.join('-') + '-' + key; |
|
100 | 100 | } |
|
101 | 101 | }; |
|
102 | 102 | |
|
103 | 103 | var shortcut_to_event = function (shortcut, type) { |
|
104 | 104 | // Convert a shortcut (shift-r) to a jQuery Event object |
|
105 | 105 | type = type || 'keydown'; |
|
106 | 106 | shortcut = normalize_shortcut(shortcut); |
|
107 | shortcut = shortcut.replace(/-$/, '_'); // catch shortcuts using '-' key | |
|
107 | 108 | var values = shortcut.split("-"); |
|
108 | 109 | var modifiers = values.slice(0,-1); |
|
109 | 110 | var key = values[values.length-1]; |
|
110 | 111 | var opts = {which: keycodes[key]}; |
|
111 | 112 | if (modifiers.indexOf('alt') !== -1) {opts.altKey = true;} |
|
112 | 113 | if (modifiers.indexOf('ctrl') !== -1) {opts.ctrlKey = true;} |
|
113 | 114 | if (modifiers.indexOf('meta') !== -1) {opts.metaKey = true;} |
|
114 | 115 | if (modifiers.indexOf('shift') !== -1) {opts.shiftKey = true;} |
|
115 | 116 | return $.Event(type, opts); |
|
116 | 117 | }; |
|
117 | 118 | |
|
118 | 119 | var event_to_shortcut = function (event) { |
|
119 | 120 | // Convert a jQuery Event object to a shortcut (shift-r) |
|
120 | 121 | var shortcut = ''; |
|
121 | 122 | var key = inv_keycodes[event.which]; |
|
122 | 123 | if (event.altKey && key !== 'alt') {shortcut += 'alt-';} |
|
123 | 124 | if (event.ctrlKey && key !== 'ctrl') {shortcut += 'ctrl-';} |
|
124 | 125 | if (event.metaKey && key !== 'meta') {shortcut += 'meta-';} |
|
125 | 126 | if (event.shiftKey && key !== 'shift') {shortcut += 'shift-';} |
|
126 | 127 | shortcut += key; |
|
127 | 128 | return shortcut; |
|
128 | 129 | }; |
|
129 | 130 | |
|
130 | 131 | var trigger_keydown = function (shortcut, element) { |
|
131 | 132 | // Trigger shortcut keydown on an element |
|
132 | 133 | element = element || document; |
|
133 | 134 | element = $(element); |
|
134 | 135 | var event = shortcut_to_event(shortcut, 'keydown'); |
|
135 | 136 | element.trigger(event); |
|
136 | 137 | }; |
|
137 | 138 | |
|
138 | 139 | |
|
139 | 140 | // Shortcut manager class |
|
140 | 141 | |
|
141 | 142 | var ShortcutManager = function (delay) { |
|
142 | 143 | this._shortcuts = {}; |
|
143 | 144 | this._counts = {}; |
|
144 | 145 | this._timers = {}; |
|
145 | 146 | this.delay = delay || 800; // delay in milliseconds |
|
146 | 147 | }; |
|
147 | 148 | |
|
148 | 149 | ShortcutManager.prototype.help = function () { |
|
149 | 150 | var help = []; |
|
150 | 151 | for (var shortcut in this._shortcuts) { |
|
151 | 152 | var help_string = this._shortcuts[shortcut]['help']; |
|
152 | 153 | var help_index = this._shortcuts[shortcut]['help_index']; |
|
153 | 154 | if (help_string) { |
|
154 | 155 | if (platform === 'MacOS') { |
|
155 | 156 | shortcut = shortcut.replace('meta', 'cmd'); |
|
156 | 157 | } |
|
157 | 158 | help.push({ |
|
158 | 159 | shortcut: shortcut, |
|
159 | 160 | help: help_string, |
|
160 | 161 | help_index: help_index} |
|
161 | 162 | ); |
|
162 | 163 | } |
|
163 | 164 | } |
|
164 | 165 | help.sort(function (a, b) { |
|
165 | 166 | if (a.help_index > b.help_index) |
|
166 | 167 | return 1; |
|
167 | 168 | if (a.help_index < b.help_index) |
|
168 | 169 | return -1; |
|
169 | 170 | return 0; |
|
170 | 171 | }); |
|
171 | 172 | return help; |
|
172 | 173 | }; |
|
173 | 174 | |
|
174 | 175 | ShortcutManager.prototype.clear_shortcuts = function () { |
|
175 | 176 | this._shortcuts = {}; |
|
176 | 177 | }; |
|
177 | 178 | |
|
178 | 179 | ShortcutManager.prototype.add_shortcut = function (shortcut, data, suppress_help_update) { |
|
179 | 180 | if (typeof(data) === 'function') { |
|
180 | 181 | data = {help: '', help_index: '', handler: data}; |
|
181 | 182 | } |
|
182 | 183 | data.help_index = data.help_index || ''; |
|
183 | 184 | data.help = data.help || ''; |
|
184 | 185 | data.count = data.count || 1; |
|
185 | 186 | if (data.help_index === '') { |
|
186 | 187 | data.help_index = 'zz'; |
|
187 | 188 | } |
|
188 | 189 | shortcut = normalize_shortcut(shortcut); |
|
189 | 190 | this._counts[shortcut] = 0; |
|
190 | 191 | this._shortcuts[shortcut] = data; |
|
191 | 192 | if (!suppress_help_update) { |
|
192 | 193 | // update the keyboard shortcuts notebook help |
|
193 | 194 | $([IPython.events]).trigger('rebuild.QuickHelp'); |
|
194 | 195 | } |
|
195 | 196 | }; |
|
196 | 197 | |
|
197 | 198 | ShortcutManager.prototype.add_shortcuts = function (data) { |
|
198 | 199 | for (var shortcut in data) { |
|
199 | 200 | this.add_shortcut(shortcut, data[shortcut], true); |
|
200 | 201 | } |
|
201 | 202 | // update the keyboard shortcuts notebook help |
|
202 | 203 | $([IPython.events]).trigger('rebuild.QuickHelp'); |
|
203 | 204 | }; |
|
204 | 205 | |
|
205 | 206 | ShortcutManager.prototype.remove_shortcut = function (shortcut, suppress_help_update) { |
|
206 | 207 | shortcut = normalize_shortcut(shortcut); |
|
207 | 208 | delete this._counts[shortcut]; |
|
208 | 209 | delete this._shortcuts[shortcut]; |
|
209 | 210 | if (!suppress_help_update) { |
|
210 | 211 | // update the keyboard shortcuts notebook help |
|
211 | 212 | $([IPython.events]).trigger('rebuild.QuickHelp'); |
|
212 | 213 | } |
|
213 | 214 | }; |
|
214 | 215 | |
|
215 | 216 | ShortcutManager.prototype.count_handler = function (shortcut, event, data) { |
|
216 | 217 | var that = this; |
|
217 | 218 | var c = this._counts; |
|
218 | 219 | var t = this._timers; |
|
219 | 220 | var timer = null; |
|
220 | 221 | if (c[shortcut] === data.count-1) { |
|
221 | 222 | c[shortcut] = 0; |
|
222 | 223 | var timer = t[shortcut]; |
|
223 | 224 | if (timer) {clearTimeout(timer); delete t[shortcut];} |
|
224 | 225 | return data.handler(event); |
|
225 | 226 | } else { |
|
226 | 227 | c[shortcut] = c[shortcut] + 1; |
|
227 | 228 | timer = setTimeout(function () { |
|
228 | 229 | c[shortcut] = 0; |
|
229 | 230 | }, that.delay); |
|
230 | 231 | t[shortcut] = timer; |
|
231 | 232 | } |
|
232 | 233 | return false; |
|
233 | 234 | }; |
|
234 | 235 | |
|
235 | 236 | ShortcutManager.prototype.call_handler = function (event) { |
|
236 | 237 | var shortcut = event_to_shortcut(event); |
|
237 | 238 | var data = this._shortcuts[shortcut]; |
|
238 | 239 | if (data) { |
|
239 | 240 | var handler = data['handler']; |
|
240 | 241 | if (handler) { |
|
241 | 242 | if (data.count === 1) { |
|
242 | 243 | return handler(event); |
|
243 | 244 | } else if (data.count > 1) { |
|
244 | 245 | return this.count_handler(shortcut, event, data); |
|
245 | 246 | } |
|
246 | 247 | } |
|
247 | 248 | } |
|
248 | 249 | return true; |
|
249 | 250 | }; |
|
250 | 251 | |
|
251 | 252 | return { |
|
252 | 253 | keycodes : keycodes, |
|
253 | 254 | inv_keycodes : inv_keycodes, |
|
254 | 255 | ShortcutManager : ShortcutManager, |
|
255 | 256 | normalize_key : normalize_key, |
|
256 | 257 | normalize_shortcut : normalize_shortcut, |
|
257 | 258 | shortcut_to_event : shortcut_to_event, |
|
258 | 259 | event_to_shortcut : event_to_shortcut, |
|
259 | 260 | trigger_keydown : trigger_keydown |
|
260 | 261 | }; |
|
261 | 262 | |
|
262 | 263 | }(IPython)); |
@@ -1,128 +1,128 | |||
|
1 | 1 | //---------------------------------------------------------------------------- |
|
2 | 2 | // Copyright (C) 2008-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 | // QuickHelp button |
|
10 | 10 | //============================================================================ |
|
11 | 11 | |
|
12 | 12 | var IPython = (function (IPython) { |
|
13 | 13 | "use strict"; |
|
14 | 14 | |
|
15 | 15 | var QuickHelp = function (selector) { |
|
16 | 16 | }; |
|
17 | 17 | |
|
18 | 18 | QuickHelp.prototype.show_keyboard_shortcuts = function () { |
|
19 | 19 | // toggles display of keyboard shortcut dialog |
|
20 | 20 | var that = this; |
|
21 | 21 | if ( this.force_rebuild ) { |
|
22 | 22 | this.shortcut_dialog.remove(); |
|
23 | 23 | delete(this.shortcut_dialog); |
|
24 | 24 | this.force_rebuild = false; |
|
25 | 25 | } |
|
26 | 26 | if ( this.shortcut_dialog ){ |
|
27 | 27 | // if dialog is already shown, close it |
|
28 | 28 | $(this.shortcut_dialog).modal("toggle"); |
|
29 | 29 | return; |
|
30 | 30 | } |
|
31 | 31 | var command_shortcuts = IPython.keyboard_manager.command_shortcuts.help(); |
|
32 | 32 | var edit_shortcuts = IPython.keyboard_manager.edit_shortcuts.help(); |
|
33 | 33 | var help, shortcut; |
|
34 | 34 | var i, half, n; |
|
35 | 35 | var element = $('<div/>'); |
|
36 | 36 | |
|
37 | 37 | // The documentation |
|
38 | 38 | var doc = $('<div/>').addClass('alert'); |
|
39 | 39 | doc.append( |
|
40 | 40 | $('<button/>').addClass('close').attr('data-dismiss','alert').html('×') |
|
41 | 41 | ).append( |
|
42 | 42 | 'The IPython Notebook has two different keyboard input modes. <b>Edit mode</b> '+ |
|
43 | 43 | 'allows you to type code/text into a cell and is indicated by a green cell '+ |
|
44 | 44 | 'border. <b>Command mode</b> binds the keyboard to notebook level actions '+ |
|
45 | 45 | 'and is indicated by a grey cell border.' |
|
46 | 46 | ); |
|
47 | 47 | element.append(doc); |
|
48 | 48 | |
|
49 | 49 | // Command mode |
|
50 | 50 | var cmd_div = this.build_command_help(); |
|
51 | 51 | element.append(cmd_div); |
|
52 | 52 | |
|
53 | 53 | // Edit mode |
|
54 | 54 | var edit_div = this.build_edit_help(); |
|
55 | 55 | element.append(edit_div); |
|
56 | 56 | |
|
57 | 57 | this.shortcut_dialog = IPython.dialog.modal({ |
|
58 | 58 | title : "Keyboard shortcuts", |
|
59 | 59 | body : element, |
|
60 | 60 | destroy : false, |
|
61 | 61 | buttons : { |
|
62 | 62 | Close : {} |
|
63 | 63 | } |
|
64 | 64 | }); |
|
65 | 65 | |
|
66 | 66 | $([IPython.events]).on('rebuild.QuickHelp', function() { that.force_rebuild = true;}); |
|
67 | 67 | }; |
|
68 | 68 | |
|
69 | 69 | QuickHelp.prototype.build_command_help = function () { |
|
70 | 70 | var command_shortcuts = IPython.keyboard_manager.command_shortcuts.help(); |
|
71 | 71 | return build_div('<h4>Command Mode (press <code>Esc</code> to enable)</h4>', command_shortcuts); |
|
72 | 72 | }; |
|
73 | 73 | |
|
74 | 74 | var special_case = { pageup: "PageUp", pagedown: "Page Down", 'minus': '-' }; |
|
75 | 75 | var prettify = function (s) { |
|
76 |
s = s.replace( |
|
|
76 | s = s.replace(/-$/, 'minus'); // catch shortcuts using '-' key | |
|
77 | 77 | var keys = s.split('-'); |
|
78 | 78 | var k, i; |
|
79 | 79 | for (i in keys) { |
|
80 | 80 | k = keys[i]; |
|
81 | 81 | if ( k.length == 1 ) { |
|
82 | 82 | keys[i] = "<code><strong>" + k + "</strong></code>"; |
|
83 | 83 | continue; // leave individual keys lower-cased |
|
84 | 84 | } |
|
85 | 85 | keys[i] = ( special_case[k] ? special_case[k] : k.charAt(0).toUpperCase() + k.slice(1) ); |
|
86 | 86 | keys[i] = "<code><strong>" + keys[i] + "</strong></code>"; |
|
87 | 87 | } |
|
88 | 88 | return keys.join('-'); |
|
89 | 89 | |
|
90 | 90 | |
|
91 | 91 | }; |
|
92 | 92 | |
|
93 | 93 | QuickHelp.prototype.build_edit_help = function () { |
|
94 | 94 | var edit_shortcuts = IPython.keyboard_manager.edit_shortcuts.help(); |
|
95 | 95 | // Edit mode |
|
96 | 96 | return build_div('<h4>Edit Mode (press <code>Enter</code> to enable)</h4>', edit_shortcuts); |
|
97 | 97 | }; |
|
98 | 98 | |
|
99 | 99 | var build_one = function (s) { |
|
100 | 100 | var help = s.help; |
|
101 | 101 | var shortcut = prettify(s.shortcut); |
|
102 | 102 | return $('<div>').addClass('quickhelp'). |
|
103 | 103 | append($('<span/>').addClass('shortcut_key').append($(shortcut))). |
|
104 | 104 | append($('<span/>').addClass('shortcut_descr').text(' : ' + help)); |
|
105 | 105 | |
|
106 | 106 | }; |
|
107 | 107 | |
|
108 | 108 | var build_div = function (title, shortcuts) { |
|
109 | 109 | var i, half, n; |
|
110 | 110 | var div = $('<div/>').append($(title)); |
|
111 | 111 | var sub_div = $('<div/>').addClass('hbox'); |
|
112 | 112 | var col1 = $('<div/>').addClass('box-flex0'); |
|
113 | 113 | var col2 = $('<div/>').addClass('box-flex0'); |
|
114 | 114 | n = shortcuts.length; |
|
115 | 115 | half = ~~(n/2); // Truncate :) |
|
116 | 116 | for (i=0; i<half; i++) { col1.append( build_one(shortcuts[i]) ); } |
|
117 | 117 | for (i=half; i<n; i++) { col2.append( build_one(shortcuts[i]) ); } |
|
118 | 118 | sub_div.append(col1).append(col2); |
|
119 | 119 | div.append(sub_div); |
|
120 | 120 | return div; |
|
121 | 121 | }; |
|
122 | 122 | |
|
123 | 123 | // Set module variables |
|
124 | 124 | IPython.QuickHelp = QuickHelp; |
|
125 | 125 | |
|
126 | 126 | return IPython; |
|
127 | 127 | |
|
128 | 128 | }(IPython)); |
General Comments 0
You need to be logged in to leave comments.
Login now