codecell.js
526 lines
| 17.6 KiB
| application/javascript
|
JavascriptLexer
|
r17198 | // Copyright (c) IPython Development Team. | ||
// Distributed under the terms of the Modified BSD License. | ||||
define([ | ||||
'base/js/namespace', | ||||
|
r17200 | 'jquery', | ||
|
r17198 | 'base/js/utils', | ||
'base/js/keyboard', | ||||
'notebook/js/cell', | ||||
'notebook/js/outputarea', | ||||
'notebook/js/completer', | ||||
|
r17200 | 'notebook/js/celltoolbar', | ||
|
r17215 | ], function(IPython, $, utils, keyboard, cell, outputarea, completer, celltoolbar) { | ||
|
r7132 | "use strict"; | ||
|
r17203 | var Cell = cell.Cell; | ||
|
r7132 | |||
|
r17198 | /* local util for codemirror */ | ||
var posEq = function(a, b) {return a.line == b.line && a.ch == b.ch;}; | ||||
/** | ||||
* | ||||
* function to delete until previous non blanking space character | ||||
* or first multiple of 4 tabstop. | ||||
* @private | ||||
*/ | ||||
CodeMirror.commands.delSpaceToPrevTabStop = function(cm){ | ||||
var from = cm.getCursor(true), to = cm.getCursor(false), sel = !posEq(from, to); | ||||
if (!posEq(from, to)) { cm.replaceRange("", from, to); return; } | ||||
var cur = cm.getCursor(), line = cm.getLine(cur.line); | ||||
var tabsize = cm.getOption('tabSize'); | ||||
var chToPrevTabStop = cur.ch-(Math.ceil(cur.ch/tabsize)-1)*tabsize; | ||||
from = {ch:cur.ch-chToPrevTabStop,line:cur.line}; | ||||
var select = cm.getRange(from,cur); | ||||
if( select.match(/^\ +$/) !== null){ | ||||
cm.replaceRange("",from,cur); | ||||
} else { | ||||
cm.deleteH(-1,"char"); | ||||
} | ||||
}; | ||||
var keycodes = keyboard.keycodes; | ||||
|
r4352 | |||
|
r17210 | var CodeCell = function (kernel, options) { | ||
|
r17211 | // Constructor | ||
// | ||||
// A Cell conceived to write code. | ||||
// | ||||
// Parameters: | ||||
// kernel: Kernel instance | ||||
// The kernel doesn't have to be set at creation time, in that case | ||||
// it will be null and set_kernel has to be called later. | ||||
// options: dictionary | ||||
// Dictionary of keyword arguments. | ||||
// events: $(Events) instance | ||||
// config: dictionary | ||||
// keyboard_manager: KeyboardManager instance | ||||
// notebook: Notebook instance | ||||
|
r17215 | // tooltip: Tooltip instance | ||
|
r13133 | this.kernel = kernel || null; | ||
|
r17210 | this.notebook = options.notebook; | ||
|
r7524 | this.collapsed = false; | ||
|
r17210 | this.events = options.events; | ||
|
r17215 | this.tooltip = options.tooltip; | ||
|
r17210 | this.config = options.config; | ||
|
r9537 | |||
|
r13574 | // create all attributed in constructor function | ||
// even if null for V8 VM optimisation | ||||
this.input_prompt_number = null; | ||||
this.celltoolbar = null; | ||||
this.output_area = null; | ||||
this.last_msg_id = null; | ||||
this.completer = null; | ||||
|
r9537 | |||
var cm_overwrite_options = { | ||||
|
r14021 | onKeyEvent: $.proxy(this.handle_keyevent,this) | ||
|
r9537 | }; | ||
|
r17210 | var config = this.mergeopt(CodeCell, this.config, {cm_config: cm_overwrite_options}); | ||
Cell.apply(this,[{ | ||||
config: config, | ||||
keyboard_manager: options.keyboard_manager, | ||||
events: this.events}]); | ||||
|
r8202 | |||
|
r13661 | // Attributes we want to override in this subclass. | ||
this.cell_type = "code"; | ||||
|
r8202 | var that = this; | ||
this.element.focusout( | ||||
|
r8281 | function() { that.auto_highlight(); } | ||
); | ||||
|
r4352 | }; | ||
|
r10165 | CodeCell.options_default = { | ||
cm_config : { | ||||
|
r11488 | extraKeys: { | ||
"Tab" : "indentMore", | ||||
"Shift-Tab" : "indentLess", | ||||
"Backspace" : "delSpaceToPrevTabStop", | ||||
"Cmd-/" : "toggleComment", | ||||
"Ctrl-/" : "toggleComment" | ||||
}, | ||||
|
r10418 | mode: 'ipython', | ||
|
r9537 | theme: 'ipython', | ||
|
r14986 | matchBrackets: true, | ||
|
r15842 | // don't auto-close strings because of CodeMirror #2385 | ||
autoCloseBrackets: "()[]{}" | ||||
|
r10165 | } | ||
|
r9537 | }; | ||
|
r14604 | CodeCell.msg_cells = {}; | ||
|
r9537 | |||
|
r17203 | CodeCell.prototype = new Cell(); | ||
|
r4352 | |||
|
r8768 | /** | ||
* @method auto_highlight | ||||
*/ | ||||
|
r8202 | CodeCell.prototype.auto_highlight = function () { | ||
|
r17198 | this._auto_highlight(this.config.cell_magic_highlight); | ||
|
r8202 | }; | ||
|
r8768 | /** @method create_element */ | ||
|
r4352 | CodeCell.prototype.create_element = function () { | ||
|
r17203 | Cell.prototype.create_element.apply(this, arguments); | ||
|
r9055 | |||
|
r10217 | var cell = $('<div></div>').addClass('cell border-box-sizing code_cell'); | ||
|
r4629 | cell.attr('tabindex','2'); | ||
|
r9142 | |||
|
r10215 | var input = $('<div></div>').addClass('input'); | ||
|
r13776 | var prompt = $('<div/>').addClass('prompt input_prompt'); | ||
var inner_cell = $('<div/>').addClass('inner_cell'); | ||||
|
r17214 | this.celltoolbar = new celltoolbar.CellToolbar({ | ||
cell: this, | ||||
events: this.events, | ||||
notebook: this.notebook}); | ||||
|
r13776 | inner_cell.append(this.celltoolbar.element); | ||
|
r9422 | var input_area = $('<div/>').addClass('input_area'); | ||
|
r17217 | this.code_mirror = new CodeMirror(input_area.get(0), this.cm_config); | ||
|
r10065 | $(this.code_mirror.getInputField()).attr("spellcheck", "false"); | ||
|
r13776 | inner_cell.append(input_area); | ||
input.append(prompt).append(inner_cell); | ||||
|
r14219 | |||
|
r14234 | var widget_area = $('<div/>') | ||
|
r14293 | .addClass('widget-area') | ||
|
r14234 | .hide(); | ||
this.widget_area = widget_area; | ||||
var widget_prompt = $('<div/>') | ||||
.addClass('prompt') | ||||
.appendTo(widget_area); | ||||
var widget_subarea = $('<div/>') | ||||
|
r14293 | .addClass('widget-subarea') | ||
|
r14234 | .appendTo(widget_area); | ||
this.widget_subarea = widget_subarea; | ||||
var widget_clear_buton = $('<button />') | ||||
.addClass('close') | ||||
.html('×') | ||||
.click(function() { | ||||
widget_area.slideUp('', function(){ widget_subarea.html(''); }); | ||||
}) | ||||
.appendTo(widget_prompt); | ||||
|
r14219 | |||
|
r7177 | var output = $('<div></div>'); | ||
|
r14219 | cell.append(input).append(widget_area).append(output); | ||
|
r4352 | this.element = cell; | ||
|
r17214 | this.output_area = new outputarea.OutputArea({ | ||
selector: output, | ||||
prompt_area: true, | ||||
events: this.events, | ||||
keyboard_manager: this.keyboard_manager}); | ||||
|
r17202 | this.completer = new completer.Completer(this, this.events); | ||
|
r4352 | }; | ||
|
r14015 | /** @method bind_events */ | ||
CodeCell.prototype.bind_events = function () { | ||||
|
r17203 | Cell.prototype.bind_events.apply(this); | ||
|
r14015 | var that = this; | ||
this.element.focusout( | ||||
function() { that.auto_highlight(); } | ||||
); | ||||
}; | ||||
|
r14021 | |||
|
r8768 | /** | ||
* This method gets called in CodeMirror's onKeyDown/onKeyPress | ||||
* handlers and is used to provide custom key handling. Its return | ||||
* value is used to determine if CodeMirror should ignore the event: | ||||
* true = ignore, false = don't ignore. | ||||
* @method handle_codemirror_keyevent | ||||
*/ | ||||
|
r4378 | CodeCell.prototype.handle_codemirror_keyevent = function (editor, event) { | ||
|
r14021 | |||
|
r5398 | var that = this; | ||
|
r14021 | // whatever key is pressed, first, cancel the tooltip request before | ||
// they are sent, and remove tooltip if any, except for tab again | ||||
|
r14062 | var tooltip_closed = null; | ||
|
r15619 | if (event.type === 'keydown' && event.which != keycodes.tab ) { | ||
|
r17198 | tooltip_closed = this.tooltip.remove_and_cancel_tooltip(); | ||
|
r14021 | } | ||
|
r6059 | |||
|
r14021 | var cur = editor.getCursor(); | ||
|
r15619 | if (event.keyCode === keycodes.enter){ | ||
|
r14021 | this.auto_highlight(); | ||
} | ||||
|
r6059 | |||
|
r17198 | if (event.which === keycodes.down && event.type === 'keypress' && this.tooltip.time_before_tooltip >= 0) { | ||
|
r14021 | // triger on keypress (!) otherwise inconsistent event.which depending on plateform | ||
// browser and keyboard layout ! | ||||
// Pressing '(' , request tooltip, don't forget to reappend it | ||||
// The second argument says to hide the tooltip if the docstring | ||||
// is actually empty | ||||
|
r17198 | this.tooltip.pending(that, true); | ||
|
r15757 | } else if ( tooltip_closed && event.which === keycodes.esc && event.type === 'keydown') { | ||
|
r15820 | // If tooltip is active, cancel it. The call to | ||
// remove_and_cancel_tooltip above doesn't pass, force=true. | ||||
// Because of this it won't actually close the tooltip | ||||
|
r15757 | // if it is in sticky mode. Thus, we have to check again if it is open | ||
// and close it with force=true. | ||||
|
r17198 | if (!this.tooltip._hidden) { | ||
this.tooltip.remove_and_cancel_tooltip(true); | ||||
|
r14021 | } | ||
|
r15757 | // If we closed the tooltip, don't let CM or the global handlers | ||
// handle this event. | ||||
event.stop(); | ||||
return true; | ||||
|
r15619 | } else if (event.keyCode === keycodes.tab && event.type === 'keydown' && event.shiftKey) { | ||
|
r14021 | if (editor.somethingSelected()){ | ||
var anchor = editor.getCursor("anchor"); | ||||
var head = editor.getCursor("head"); | ||||
if( anchor.line != head.line){ | ||||
return false; | ||||
|
r8949 | } | ||
} | ||||
|
r17198 | this.tooltip.request(that); | ||
|
r8949 | event.stop(); | ||
return true; | ||||
|
r15619 | } else if (event.keyCode === keycodes.tab && event.type == 'keydown') { | ||
|
r4555 | // Tab completion. | ||
|
r17198 | this.tooltip.remove_and_cancel_tooltip(); | ||
|
r13572 | if (editor.somethingSelected()) { | ||
return false; | ||||
} | ||||
|
r5398 | var pre_cursor = editor.getRange({line:cur.line,ch:0},cur); | ||
if (pre_cursor.trim() === "") { | ||||
|
r5016 | // Don't autocomplete if the part of the line before the cursor | ||
// is empty. In this case, let CodeMirror handle indentation. | ||||
|
r4393 | return false; | ||
} else { | ||||
|
r14021 | event.stop(); | ||
this.completer.startCompletion(); | ||||
return true; | ||||
} | ||||
|
r15757 | } | ||
// keyboard event wasn't one of those unique to code cells, let's see | ||||
// if it's one of the generic ones (i.e. check edit mode shortcuts) | ||||
|
r17203 | return Cell.prototype.handle_codemirror_keyevent.apply(this, [editor, event]); | ||
|
r4378 | }; | ||
|
r7168 | // Kernel related calls. | ||
|
r13133 | CodeCell.prototype.set_kernel = function (kernel) { | ||
this.kernel = kernel; | ||||
|
r13210 | }; | ||
|
r7197 | |||
|
r8768 | /** | ||
* Execute current code cell to the kernel | ||||
* @method execute | ||||
*/ | ||||
|
r7168 | CodeCell.prototype.execute = function () { | ||
|
r13102 | this.output_area.clear_output(); | ||
|
r14248 | |||
// Clear widget area | ||||
|
r14235 | this.widget_subarea.html(''); | ||
this.widget_subarea.height(''); | ||||
this.widget_area.height(''); | ||||
|
r14248 | this.widget_area.hide(); | ||
|
r7168 | this.set_input_prompt('*'); | ||
this.element.addClass("running"); | ||||
|
r13225 | if (this.last_msg_id) { | ||
this.kernel.clear_callbacks_for_msg(this.last_msg_id); | ||||
} | ||||
var callbacks = this.get_callbacks(); | ||||
|
r14604 | var old_msg_id = this.last_msg_id; | ||
|
r13225 | this.last_msg_id = this.kernel.execute(this.get_text(), callbacks, {silent: false, store_history: true}); | ||
|
r14604 | if (old_msg_id) { | ||
delete CodeCell.msg_cells[old_msg_id]; | ||||
} | ||||
CodeCell.msg_cells[this.last_msg_id] = this; | ||||
|
r13225 | }; | ||
/** | ||||
* Construct the default callbacks for | ||||
* @method get_callbacks | ||||
*/ | ||||
CodeCell.prototype.get_callbacks = function () { | ||||
return { | ||||
|
r13207 | shell : { | ||
reply : $.proxy(this._handle_execute_reply, this), | ||||
payload : { | ||||
set_next_input : $.proxy(this._handle_set_next_input, this), | ||||
|
r13225 | page : $.proxy(this._open_with_pager, this) | ||
|
r13207 | } | ||
}, | ||||
iopub : { | ||||
output : $.proxy(this.output_area.handle_output, this.output_area), | ||||
clear_output : $.proxy(this.output_area.handle_clear_output, this.output_area), | ||||
}, | ||||
input : $.proxy(this._handle_input_request, this) | ||||
|
r13210 | }; | ||
|
r13225 | }; | ||
CodeCell.prototype._open_with_pager = function (payload) { | ||||
|
r17198 | this.events.trigger('open_with_text.Pager', payload); | ||
|
r7168 | }; | ||
|
r8768 | /** | ||
* @method _handle_execute_reply | ||||
* @private | ||||
*/ | ||||
|
r13207 | CodeCell.prototype._handle_execute_reply = function (msg) { | ||
this.set_input_prompt(msg.content.execution_count); | ||||
|
r7168 | this.element.removeClass("running"); | ||
|
r17198 | this.events.trigger('set_dirty.Notebook', {value: true}); | ||
|
r13210 | }; | ||
|
r4389 | |||
|
r10368 | /** | ||
* @method _handle_set_next_input | ||||
* @private | ||||
*/ | ||||
|
r13207 | CodeCell.prototype._handle_set_next_input = function (payload) { | ||
|
r13210 | var data = {'cell': this, 'text': payload.text}; | ||
|
r17198 | this.events.trigger('set_next_input.Notebook', data); | ||
|
r13210 | }; | ||
|
r12458 | |||
|
r10368 | /** | ||
* @method _handle_input_request | ||||
* @private | ||||
*/ | ||||
|
r13207 | CodeCell.prototype._handle_input_request = function (msg) { | ||
this.output_area.append_raw_input(msg); | ||||
|
r13210 | }; | ||
|
r10368 | |||
|
r7223 | |||
|
r7168 | // Basic cell manipulation. | ||
|
r4352 | CodeCell.prototype.select = function () { | ||
|
r17203 | var cont = Cell.prototype.select.apply(this); | ||
|
r14015 | if (cont) { | ||
|
r14014 | this.code_mirror.refresh(); | ||
this.auto_highlight(); | ||||
|
r14092 | } | ||
|
r14015 | return cont; | ||
|
r4352 | }; | ||
|
r14014 | CodeCell.prototype.render = function () { | ||
|
r17203 | var cont = Cell.prototype.render.apply(this); | ||
|
r14015 | // Always execute, even if we are already in the rendered state | ||
return cont; | ||||
|
r14013 | }; | ||
|
r14015 | |||
|
r14014 | CodeCell.prototype.unrender = function () { | ||
|
r14015 | // CodeCell is always rendered | ||
return false; | ||||
|
r14013 | }; | ||
|
r4352 | |||
|
r4675 | CodeCell.prototype.select_all = function () { | ||
var start = {line: 0, ch: 0}; | ||||
var nlines = this.code_mirror.lineCount(); | ||||
var last_line = this.code_mirror.getLine(nlines-1); | ||||
var end = {line: nlines-1, ch: last_line.length}; | ||||
this.code_mirror.setSelection(start, end); | ||||
}; | ||||
|
r14867 | CodeCell.prototype.collapse_output = function () { | ||
|
r7524 | this.collapsed = true; | ||
this.output_area.collapse(); | ||||
|
r7168 | }; | ||
|
r14867 | CodeCell.prototype.expand_output = function () { | ||
|
r7524 | this.collapsed = false; | ||
this.output_area.expand(); | ||||
|
r14867 | this.output_area.unscroll_area(); | ||
|
r7168 | }; | ||
|
r14867 | CodeCell.prototype.scroll_output = function () { | ||
this.output_area.expand(); | ||||
this.output_area.scroll_if_long(); | ||||
}; | ||||
|
r7168 | |||
CodeCell.prototype.toggle_output = function () { | ||||
|
r7524 | this.collapsed = Boolean(1 - this.collapsed); | ||
this.output_area.toggle_output(); | ||||
|
r7168 | }; | ||
|
r7429 | CodeCell.prototype.toggle_output_scroll = function () { | ||
|
r14867 | this.output_area.toggle_scroll(); | ||
|
r7429 | }; | ||
|
r8467 | CodeCell.input_prompt_classical = function (prompt_value, lines_number) { | ||
|
r14714 | var ns; | ||
|
r15820 | if (prompt_value === undefined) { | ||
|
r14714 | ns = " "; | ||
} else { | ||||
ns = encodeURIComponent(prompt_value); | ||||
} | ||||
|
r13210 | return 'In [' + ns + ']:'; | ||
|
r8467 | }; | ||
|
r8768 | |||
|
r8467 | CodeCell.input_prompt_continuation = function (prompt_value, lines_number) { | ||
var html = [CodeCell.input_prompt_classical(prompt_value, lines_number)]; | ||||
|
r13210 | for(var i=1; i < lines_number; i++) { | ||
html.push(['...:']); | ||||
} | ||||
return html.join('<br/>'); | ||||
|
r8467 | }; | ||
|
r8768 | |||
|
r8467 | CodeCell.input_prompt_function = CodeCell.input_prompt_classical; | ||
|
r7168 | CodeCell.prototype.set_input_prompt = function (number) { | ||
|
r13210 | var nline = 1; | ||
if (this.code_mirror !== undefined) { | ||||
|
r8467 | nline = this.code_mirror.lineCount(); | ||
} | ||||
|
r8603 | this.input_prompt_number = number; | ||
|
r8467 | var prompt_html = CodeCell.input_prompt_function(this.input_prompt_number, nline); | ||
|
r15376 | // This HTML call is okay because the user contents are escaped. | ||
|
r8467 | this.element.find('div.input_prompt').html(prompt_html); | ||
|
r7168 | }; | ||
CodeCell.prototype.clear_input = function () { | ||||
this.code_mirror.setValue(''); | ||||
}; | ||||
CodeCell.prototype.get_text = function () { | ||||
return this.code_mirror.getValue(); | ||||
}; | ||||
CodeCell.prototype.set_text = function (code) { | ||||
return this.code_mirror.setValue(code); | ||||
}; | ||||
|
r13102 | CodeCell.prototype.clear_output = function (wait) { | ||
this.output_area.clear_output(wait); | ||||
|
r14867 | this.set_input_prompt(); | ||
|
r6423 | }; | ||
|
r7168 | |||
// JSON serialization | ||||
|
r4349 | |||
|
r4352 | CodeCell.prototype.fromJSON = function (data) { | ||
|
r17203 | Cell.prototype.fromJSON.apply(this, arguments); | ||
|
r4352 | if (data.cell_type === 'code') { | ||
|
r4484 | if (data.input !== undefined) { | ||
|
r5943 | this.set_text(data.input); | ||
|
r7587 | // make this value the starting point, so that we can only undo | ||
// to this state, instead of a blank cell | ||||
this.code_mirror.clearHistory(); | ||||
|
r8202 | this.auto_highlight(); | ||
|
r4484 | } | ||
if (data.prompt_number !== undefined) { | ||||
this.set_input_prompt(data.prompt_number); | ||||
} else { | ||||
this.set_input_prompt(); | ||||
|
r13210 | } | ||
|
r14856 | this.output_area.trusted = data.trusted || false; | ||
|
r7177 | this.output_area.fromJSON(data.outputs); | ||
|
r4533 | if (data.collapsed !== undefined) { | ||
if (data.collapsed) { | ||||
|
r14867 | this.collapse_output(); | ||
|
r6032 | } else { | ||
|
r14867 | this.expand_output(); | ||
|
r13210 | } | ||
} | ||||
} | ||||
|
r4352 | }; | ||
CodeCell.prototype.toJSON = function () { | ||||
|
r17203 | var data = Cell.prototype.toJSON.apply(this); | ||
|
r5943 | data.input = this.get_text(); | ||
|
r13572 | // is finite protect against undefined and '*' value | ||
if (isFinite(this.input_prompt_number)) { | ||||
|
r5479 | data.prompt_number = this.input_prompt_number; | ||
|
r13210 | } | ||
|
r7177 | var outputs = this.output_area.toJSON(); | ||
|
r4497 | data.outputs = outputs; | ||
|
r4484 | data.language = 'python'; | ||
|
r14856 | data.trusted = this.output_area.trusted; | ||
|
r4533 | data.collapsed = this.collapsed; | ||
|
r4484 | return data; | ||
|
r4352 | }; | ||
|
r15793 | /** | ||
* handle cell level logic when a cell is unselected | ||||
* @method unselect | ||||
* @return is the action being taken | ||||
*/ | ||||
CodeCell.prototype.unselect = function () { | ||||
|
r17203 | var cont = Cell.prototype.unselect.apply(this); | ||
|
r15793 | if (cont) { | ||
|
r15818 | // When a code cell is usnelected, make sure that the corresponding | ||
|
r15952 | // tooltip and completer to that cell is closed. | ||
|
r17198 | this.tooltip.remove_and_cancel_tooltip(true); | ||
|
r15952 | if (this.completer !== null) { | ||
this.completer.close(); | ||||
} | ||||
|
r15793 | } | ||
return cont; | ||||
}; | ||||
|
r4497 | |||
|
r17198 | // Backwards compatability. | ||
|
r4352 | IPython.CodeCell = CodeCell; | ||
|
r17201 | return {'CodeCell': CodeCell}; | ||
|
r17198 | }); | ||