##// END OF EJS Templates
added new use_shortcut method to shortcuts...
Paul Ivanov -
Show More
@@ -1,251 +1,257 b''
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 177 ShortcutManager.prototype.add_shortcut = function (shortcut, data) {
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 190 }
191 191
192 192 ShortcutManager.prototype.add_shortcuts = function (data) {
193 193 for (var shortcut in data) {
194 194 this.add_shortcut(shortcut, data[shortcut]);
195 195 }
196 196 }
197 197
198 198 ShortcutManager.prototype.remove_shortcut = function (shortcut) {
199 199 shortcut = normalize_shortcut(shortcut);
200 200 delete this._counts[shortcut];
201 201 delete this._shortcuts[shortcut];
202 202 }
203 203
204 204 ShortcutManager.prototype.count_handler = function (shortcut, event, data) {
205 205 var that = this;
206 206 var c = this._counts;
207 207 var t = this._timers;
208 208 var timer = null;
209 209 if (c[shortcut] === data.count-1) {
210 210 c[shortcut] = 0;
211 211 var timer = t[shortcut];
212 212 if (timer) {clearTimeout(timer); delete t[shortcut];}
213 213 return data.handler(event);
214 214 } else {
215 215 c[shortcut] = c[shortcut] + 1;
216 216 timer = setTimeout(function () {
217 217 c[shortcut] = 0;
218 218 }, that.delay);
219 219 t[shortcut] = timer;
220 220 }
221 221 return false;
222 222 }
223 223
224 224 ShortcutManager.prototype.call_handler = function (event) {
225 225 var shortcut = event_to_shortcut(event);
226 226 var data = this._shortcuts[shortcut];
227 227 if (data) {
228 228 var handler = data['handler'];
229 229 if (handler) {
230 230 if (data.count === 1) {
231 231 return handler(event);
232 232 } else if (data.count > 1) {
233 233 return this.count_handler(shortcut, event, data);
234 234 }
235 235 }
236 236 }
237 237 return true;
238 238 }
239 239
240 ShortcutManager.prototype.use_shortcut = function (event) {
241 var shortcut = event_to_shortcut(event);
242 var data = this._shortcuts[shortcut];
243 return !( data === undefined )
244 }
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));
@@ -1,596 +1,600 b''
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 // Cell
10 10 //============================================================================
11 11 /**
12 12 * An extendable module that provide base functionnality to create cell for notebook.
13 13 * @module IPython
14 14 * @namespace IPython
15 15 * @submodule Cell
16 16 */
17 17
18 18 var IPython = (function (IPython) {
19 19 "use strict";
20 20
21 21 var utils = IPython.utils;
22 22 var keycodes = IPython.keyboard.keycodes;
23 23
24 24 /**
25 25 * The Base `Cell` class from which to inherit
26 26 * @class Cell
27 27 **/
28 28
29 29 /*
30 30 * @constructor
31 31 *
32 32 * @param {object|undefined} [options]
33 33 * @param [options.cm_config] {object} config to pass to CodeMirror, will extend default parameters
34 34 */
35 35 var Cell = function (options) {
36 36
37 37 options = this.mergeopt(Cell, options);
38 38 // superclass default overwrite our default
39 39
40 40 this.placeholder = options.placeholder || '';
41 41 this.read_only = options.cm_config.readOnly;
42 42 this.selected = false;
43 43 this.rendered = false;
44 44 this.mode = 'command';
45 45 this.metadata = {};
46 46 // load this from metadata later ?
47 47 this.user_highlight = 'auto';
48 48 this.cm_config = options.cm_config;
49 49 this.cell_id = utils.uuid();
50 50 this._options = options;
51 51
52 52 // For JS VM engines optimization, attributes should be all set (even
53 53 // to null) in the constructor, and if possible, if different subclass
54 54 // have new attributes with same name, they should be created in the
55 55 // same order. Easiest is to create and set to null in parent class.
56 56
57 57 this.element = null;
58 58 this.cell_type = this.cell_type || null;
59 59 this.code_mirror = null;
60 60
61 61 this.create_element();
62 62 if (this.element !== null) {
63 63 this.element.data("cell", this);
64 64 this.bind_events();
65 65 this.init_classes();
66 66 }
67 67 };
68 68
69 69 Cell.options_default = {
70 70 cm_config : {
71 71 indentUnit : 4,
72 72 readOnly: false,
73 73 theme: "default"
74 74 }
75 75 };
76 76
77 77 // FIXME: Workaround CM Bug #332 (Safari segfault on drag)
78 78 // by disabling drag/drop altogether on Safari
79 79 // https://github.com/marijnh/CodeMirror/issues/332
80 80 if (utils.browser[0] == "Safari") {
81 81 Cell.options_default.cm_config.dragDrop = false;
82 82 }
83 83
84 84 Cell.prototype.mergeopt = function(_class, options, overwrite){
85 85 options = options || {};
86 86 overwrite = overwrite || {};
87 87 return $.extend(true, {}, _class.options_default, options, overwrite);
88 88 };
89 89
90 90 /**
91 91 * Empty. Subclasses must implement create_element.
92 92 * This should contain all the code to create the DOM element in notebook
93 93 * and will be called by Base Class constructor.
94 94 * @method create_element
95 95 */
96 96 Cell.prototype.create_element = function () {
97 97 };
98 98
99 99 Cell.prototype.init_classes = function () {
100 100 // Call after this.element exists to initialize the css classes
101 101 // related to selected, rendered and mode.
102 102 if (this.selected) {
103 103 this.element.addClass('selected');
104 104 } else {
105 105 this.element.addClass('unselected');
106 106 }
107 107 if (this.rendered) {
108 108 this.element.addClass('rendered');
109 109 } else {
110 110 this.element.addClass('unrendered');
111 111 }
112 112 if (this.mode === 'edit') {
113 113 this.element.addClass('edit_mode');
114 114 } else {
115 115 this.element.addClass('command_mode');
116 116 }
117 117 };
118 118
119 119 /**
120 120 * Subclasses can implement override bind_events.
121 121 * Be carefull to call the parent method when overwriting as it fires event.
122 122 * this will be triggerd after create_element in constructor.
123 123 * @method bind_events
124 124 */
125 125 Cell.prototype.bind_events = function () {
126 126 var that = this;
127 127 // We trigger events so that Cell doesn't have to depend on Notebook.
128 128 that.element.click(function (event) {
129 129 if (!that.selected) {
130 130 $([IPython.events]).trigger('select.Cell', {'cell':that});
131 131 }
132 132 });
133 133 that.element.focusin(function (event) {
134 134 if (!that.selected) {
135 135 $([IPython.events]).trigger('select.Cell', {'cell':that});
136 136 }
137 137 });
138 138 if (this.code_mirror) {
139 139 this.code_mirror.on("change", function(cm, change) {
140 140 $([IPython.events]).trigger("set_dirty.Notebook", {value: true});
141 141 });
142 142 }
143 143 if (this.code_mirror) {
144 144 this.code_mirror.on('focus', function(cm, change) {
145 145 $([IPython.events]).trigger('edit_mode.Cell', {cell: that});
146 146 });
147 147 }
148 148 if (this.code_mirror) {
149 149 this.code_mirror.on('blur', function(cm, change) {
150 150 // Check if this unfocus event is legit.
151 151 if (!that.should_cancel_blur()) {
152 152 $([IPython.events]).trigger('command_mode.Cell', {cell: that});
153 153 }
154 154 });
155 155 }
156 156 };
157 157
158 158 /**
159 159 * This method gets called in CodeMirror's onKeyDown/onKeyPress
160 160 * handlers and is used to provide custom key handling.
161 161 *
162 162 * To have custom handling, subclasses should override this method, but still call it
163 163 * in order to process the Edit mode keyboard shortcuts.
164 164 *
165 165 * @method handle_codemirror_keyevent
166 166 * @param {CodeMirror} editor - The codemirror instance bound to the cell
167 167 * @param {event} event -
168 168 * @return {Boolean} `true` if CodeMirror should ignore the event, `false` Otherwise
169 169 */
170 170 Cell.prototype.handle_codemirror_keyevent = function (editor, event) {
171 171 var that = this;
172 var shortcuts = IPython.keyboard_manager.edit_shortcuts;
172 173
174 // if this is an edit_shortcuts shortcut, we've already handled it.
175 if (shortcuts.use_shortcut(event)) { return true; }
176
173 177 if (event.keyCode === keycodes.enter && (event.shiftKey || event.ctrlKey || event.altKey)) {
174 178 // Always ignore shift-enter in CodeMirror as we handle it.
175 179 return true;
176 180 } else if (event.which === keycodes.up && event.type === 'keydown') {
177 181 // If we are not at the top, let CM handle the up arrow and
178 182 // prevent the global keydown handler from handling it.
179 183 if (!that.at_top()) {
180 184 event.stop();
181 185 return false;
182 186 } else {
183 187 return true;
184 188 };
185 189 } else if (event.which === keycodes.down && event.type === 'keydown') {
186 190 // If we are not at the bottom, let CM handle the down arrow and
187 191 // prevent the global keydown handler from handling it.
188 192 if (!that.at_bottom()) {
189 193 event.stop();
190 194 return false;
191 195 } else {
192 196 return true;
193 197 };
194 198 } else if (event.which === keycodes.esc && event.type === 'keydown') {
195 199 if (that.code_mirror.options.keyMap === "vim-insert") {
196 200 // vim keyMap is active and in insert mode. In this case we leave vim
197 201 // insert mode, but remain in notebook edit mode.
198 202 // Let' CM handle this event and prevent global handling.
199 203 event.stop();
200 204 return false;
201 205 } else {
202 206 // vim keyMap is not active. Leave notebook edit mode.
203 207 // Don't let CM handle the event, defer to global handling.
204 208 return true;
205 209 }
206 210 }
207 211 return false;
208 212 };
209 213
210 214
211 215 /**
212 216 * Triger typsetting of math by mathjax on current cell element
213 217 * @method typeset
214 218 */
215 219 Cell.prototype.typeset = function () {
216 220 if (window.MathJax) {
217 221 var cell_math = this.element.get(0);
218 222 MathJax.Hub.Queue(["Typeset", MathJax.Hub, cell_math]);
219 223 }
220 224 };
221 225
222 226 /**
223 227 * handle cell level logic when a cell is selected
224 228 * @method select
225 229 * @return is the action being taken
226 230 */
227 231 Cell.prototype.select = function () {
228 232 if (!this.selected) {
229 233 this.element.addClass('selected');
230 234 this.element.removeClass('unselected');
231 235 this.selected = true;
232 236 return true;
233 237 } else {
234 238 return false;
235 239 }
236 240 };
237 241
238 242 /**
239 243 * handle cell level logic when a cell is unselected
240 244 * @method unselect
241 245 * @return is the action being taken
242 246 */
243 247 Cell.prototype.unselect = function () {
244 248 if (this.selected) {
245 249 this.element.addClass('unselected');
246 250 this.element.removeClass('selected');
247 251 this.selected = false;
248 252 return true;
249 253 } else {
250 254 return false;
251 255 }
252 256 };
253 257
254 258 /**
255 259 * handle cell level logic when a cell is rendered
256 260 * @method render
257 261 * @return is the action being taken
258 262 */
259 263 Cell.prototype.render = function () {
260 264 if (!this.rendered) {
261 265 this.element.addClass('rendered');
262 266 this.element.removeClass('unrendered');
263 267 this.rendered = true;
264 268 return true;
265 269 } else {
266 270 return false;
267 271 }
268 272 };
269 273
270 274 /**
271 275 * handle cell level logic when a cell is unrendered
272 276 * @method unrender
273 277 * @return is the action being taken
274 278 */
275 279 Cell.prototype.unrender = function () {
276 280 if (this.rendered) {
277 281 this.element.addClass('unrendered');
278 282 this.element.removeClass('rendered');
279 283 this.rendered = false;
280 284 return true;
281 285 } else {
282 286 return false;
283 287 }
284 288 };
285 289
286 290 /**
287 291 * Either delegates keyboard shortcut handling to either IPython keyboard
288 292 * manager when in command mode, or CodeMirror when in edit mode
289 293 *
290 294 * @method handle_keyevent
291 295 * @param {CodeMirror} editor - The codemirror instance bound to the cell
292 296 * @param {event} event -
293 297 * @return {Boolean} `true` if CodeMirror should ignore the event, `false` Otherwise
294 298 */
295 299 Cell.prototype.handle_keyevent = function (editor, event) {
296 300
297 301 // console.log('CM', this.mode, event.which, event.type)
298 302
299 303 if (this.mode === 'command') {
300 304 return true;
301 305 } else if (this.mode === 'edit') {
302 306 return this.handle_codemirror_keyevent(editor, event);
303 307 }
304 308 };
305 309
306 310 /**
307 311 * @method at_top
308 312 * @return {Boolean}
309 313 */
310 314 Cell.prototype.at_top = function () {
311 315 var cm = this.code_mirror
312 316 var cursor = cm.getCursor();
313 317 if (cursor.line === 0 && cm.findPosV(cursor, -1, 'line').hitSide) {
314 318 return true;
315 319 } else {
316 320 return false;
317 321 }
318 322 };
319 323
320 324 /**
321 325 * @method at_bottom
322 326 * @return {Boolean}
323 327 * */
324 328 Cell.prototype.at_bottom = function () {
325 329 var cm = this.code_mirror
326 330 var cursor = cm.getCursor();
327 331 if (cursor.line === (cm.lineCount()-1) && cm.findPosV(cursor, 1, 'line').hitSide) {
328 332 return true;
329 333 } else {
330 334 return false;
331 335 }
332 336 };
333 337 /**
334 338 * enter the command mode for the cell
335 339 * @method command_mode
336 340 * @return is the action being taken
337 341 */
338 342 Cell.prototype.command_mode = function () {
339 343 if (this.mode !== 'command') {
340 344 this.element.addClass('command_mode');
341 345 this.element.removeClass('edit_mode');
342 346 this.mode = 'command';
343 347 return true;
344 348 } else {
345 349 return false;
346 350 }
347 351 };
348 352
349 353 /**
350 354 * enter the edit mode for the cell
351 355 * @method command_mode
352 356 * @return is the action being taken
353 357 */
354 358 Cell.prototype.edit_mode = function () {
355 359 if (this.mode !== 'edit') {
356 360 this.element.addClass('edit_mode');
357 361 this.element.removeClass('command_mode');
358 362 this.mode = 'edit';
359 363 return true;
360 364 } else {
361 365 return false;
362 366 }
363 367 };
364 368
365 369 /**
366 370 * Determine whether or not the unfocus event should be aknowledged.
367 371 *
368 372 * @method should_cancel_blur
369 373 *
370 374 * @return results {bool} Whether or not to ignore the cell's blur event.
371 375 **/
372 376 Cell.prototype.should_cancel_blur = function () {
373 377 return false;
374 378 };
375 379
376 380 /**
377 381 * Focus the cell in the DOM sense
378 382 * @method focus_cell
379 383 */
380 384 Cell.prototype.focus_cell = function () {
381 385 this.element.focus();
382 386 };
383 387
384 388 /**
385 389 * Focus the editor area so a user can type
386 390 *
387 391 * NOTE: If codemirror is focused via a mouse click event, you don't want to
388 392 * call this because it will cause a page jump.
389 393 * @method focus_editor
390 394 */
391 395 Cell.prototype.focus_editor = function () {
392 396 this.refresh();
393 397 this.code_mirror.focus();
394 398 };
395 399
396 400 /**
397 401 * Refresh codemirror instance
398 402 * @method refresh
399 403 */
400 404 Cell.prototype.refresh = function () {
401 405 this.code_mirror.refresh();
402 406 };
403 407
404 408 /**
405 409 * should be overritten by subclass
406 410 * @method get_text
407 411 */
408 412 Cell.prototype.get_text = function () {
409 413 };
410 414
411 415 /**
412 416 * should be overritten by subclass
413 417 * @method set_text
414 418 * @param {string} text
415 419 */
416 420 Cell.prototype.set_text = function (text) {
417 421 };
418 422
419 423 /**
420 424 * should be overritten by subclass
421 425 * serialise cell to json.
422 426 * @method toJSON
423 427 **/
424 428 Cell.prototype.toJSON = function () {
425 429 var data = {};
426 430 data.metadata = this.metadata;
427 431 data.cell_type = this.cell_type;
428 432 return data;
429 433 };
430 434
431 435
432 436 /**
433 437 * should be overritten by subclass
434 438 * @method fromJSON
435 439 **/
436 440 Cell.prototype.fromJSON = function (data) {
437 441 if (data.metadata !== undefined) {
438 442 this.metadata = data.metadata;
439 443 }
440 444 this.celltoolbar.rebuild();
441 445 };
442 446
443 447
444 448 /**
445 449 * can the cell be split into two cells
446 450 * @method is_splittable
447 451 **/
448 452 Cell.prototype.is_splittable = function () {
449 453 return true;
450 454 };
451 455
452 456
453 457 /**
454 458 * can the cell be merged with other cells
455 459 * @method is_mergeable
456 460 **/
457 461 Cell.prototype.is_mergeable = function () {
458 462 return true;
459 463 };
460 464
461 465
462 466 /**
463 467 * @return {String} - the text before the cursor
464 468 * @method get_pre_cursor
465 469 **/
466 470 Cell.prototype.get_pre_cursor = function () {
467 471 var cursor = this.code_mirror.getCursor();
468 472 var text = this.code_mirror.getRange({line:0, ch:0}, cursor);
469 473 text = text.replace(/^\n+/, '').replace(/\n+$/, '');
470 474 return text;
471 475 };
472 476
473 477
474 478 /**
475 479 * @return {String} - the text after the cursor
476 480 * @method get_post_cursor
477 481 **/
478 482 Cell.prototype.get_post_cursor = function () {
479 483 var cursor = this.code_mirror.getCursor();
480 484 var last_line_num = this.code_mirror.lineCount()-1;
481 485 var last_line_len = this.code_mirror.getLine(last_line_num).length;
482 486 var end = {line:last_line_num, ch:last_line_len};
483 487 var text = this.code_mirror.getRange(cursor, end);
484 488 text = text.replace(/^\n+/, '').replace(/\n+$/, '');
485 489 return text;
486 490 };
487 491
488 492 /**
489 493 * Show/Hide CodeMirror LineNumber
490 494 * @method show_line_numbers
491 495 *
492 496 * @param value {Bool} show (true), or hide (false) the line number in CodeMirror
493 497 **/
494 498 Cell.prototype.show_line_numbers = function (value) {
495 499 this.code_mirror.setOption('lineNumbers', value);
496 500 this.code_mirror.refresh();
497 501 };
498 502
499 503 /**
500 504 * Toggle CodeMirror LineNumber
501 505 * @method toggle_line_numbers
502 506 **/
503 507 Cell.prototype.toggle_line_numbers = function () {
504 508 var val = this.code_mirror.getOption('lineNumbers');
505 509 this.show_line_numbers(!val);
506 510 };
507 511
508 512 /**
509 513 * Force codemirror highlight mode
510 514 * @method force_highlight
511 515 * @param {object} - CodeMirror mode
512 516 **/
513 517 Cell.prototype.force_highlight = function(mode) {
514 518 this.user_highlight = mode;
515 519 this.auto_highlight();
516 520 };
517 521
518 522 /**
519 523 * Try to autodetect cell highlight mode, or use selected mode
520 524 * @methods _auto_highlight
521 525 * @private
522 526 * @param {String|object|undefined} - CodeMirror mode | 'auto'
523 527 **/
524 528 Cell.prototype._auto_highlight = function (modes) {
525 529 //Here we handle manually selected modes
526 530 var mode;
527 531 if( this.user_highlight !== undefined && this.user_highlight != 'auto' )
528 532 {
529 533 mode = this.user_highlight;
530 534 CodeMirror.autoLoadMode(this.code_mirror, mode);
531 535 this.code_mirror.setOption('mode', mode);
532 536 return;
533 537 }
534 538 var current_mode = this.code_mirror.getOption('mode', mode);
535 539 var first_line = this.code_mirror.getLine(0);
536 540 // loop on every pairs
537 541 for(mode in modes) {
538 542 var regs = modes[mode].reg;
539 543 // only one key every time but regexp can't be keys...
540 544 for(var i=0; i<regs.length; i++) {
541 545 // here we handle non magic_modes
542 546 if(first_line.match(regs[i]) !== null) {
543 547 if(current_mode == mode){
544 548 return;
545 549 }
546 550 if (mode.search('magic_') !== 0) {
547 551 this.code_mirror.setOption('mode', mode);
548 552 CodeMirror.autoLoadMode(this.code_mirror, mode);
549 553 return;
550 554 }
551 555 var open = modes[mode].open || "%%";
552 556 var close = modes[mode].close || "%%end";
553 557 var mmode = mode;
554 558 mode = mmode.substr(6);
555 559 if(current_mode == mode){
556 560 return;
557 561 }
558 562 CodeMirror.autoLoadMode(this.code_mirror, mode);
559 563 // create on the fly a mode that swhitch between
560 564 // plain/text and smth else otherwise `%%` is
561 565 // source of some highlight issues.
562 566 // we use patchedGetMode to circumvent a bug in CM
563 567 CodeMirror.defineMode(mmode , function(config) {
564 568 return CodeMirror.multiplexingMode(
565 569 CodeMirror.patchedGetMode(config, 'text/plain'),
566 570 // always set someting on close
567 571 {open: open, close: close,
568 572 mode: CodeMirror.patchedGetMode(config, mode),
569 573 delimStyle: "delimit"
570 574 }
571 575 );
572 576 });
573 577 this.code_mirror.setOption('mode', mmode);
574 578 return;
575 579 }
576 580 }
577 581 }
578 582 // fallback on default
579 583 var default_mode;
580 584 try {
581 585 default_mode = this._options.cm_config.mode;
582 586 } catch(e) {
583 587 default_mode = 'text/plain';
584 588 }
585 589 if( current_mode === default_mode){
586 590 return;
587 591 }
588 592 this.code_mirror.setOption('mode', default_mode);
589 593 };
590 594
591 595 IPython.Cell = Cell;
592 596
593 597 return IPython;
594 598
595 599 }(IPython));
596 600
General Comments 0
You need to be logged in to leave comments. Login now