codecell.js
518 lines
| 17.6 KiB
| application/javascript
|
JavascriptLexer
|
r4609 | //---------------------------------------------------------------------------- | ||
// Copyright (C) 2008-2011 The IPython Development Team | ||||
// | ||||
// Distributed under the terms of the BSD License. The full license is in | ||||
// the file COPYING, distributed as part of this software. | ||||
//---------------------------------------------------------------------------- | ||||
|
r4349 | |||
//============================================================================ | ||||
// CodeCell | ||||
//============================================================================ | ||||
|
r4352 | var IPython = (function (IPython) { | ||
|
r4349 | |||
|
r4352 | var utils = IPython.utils; | ||
var CodeCell = function (notebook) { | ||||
this.code_mirror = null; | ||||
this.input_prompt_number = ' '; | ||||
|
r4389 | this.is_completing = false; | ||
this.completion_cursor = null; | ||||
|
r4497 | this.outputs = []; | ||
|
r4533 | this.collapsed = false; | ||
|
r4352 | IPython.Cell.apply(this, arguments); | ||
}; | ||||
CodeCell.prototype = new IPython.Cell(); | ||||
CodeCell.prototype.create_element = function () { | ||||
|
r4361 | var cell = $('<div></div>').addClass('cell border-box-sizing code_cell vbox'); | ||
|
r4629 | cell.attr('tabindex','2'); | ||
|
r4360 | var input = $('<div></div>').addClass('input hbox'); | ||
|
r4379 | input.append($('<div/>').addClass('prompt input_prompt')); | ||
|
r4360 | var input_area = $('<div/>').addClass('input_area box-flex1'); | ||
|
r4352 | this.code_mirror = CodeMirror(input_area.get(0), { | ||
indentUnit : 4, | ||||
|
r4504 | mode: 'python', | ||
theme: 'ipython', | ||||
|
r4378 | onKeyEvent: $.proxy(this.handle_codemirror_keyevent,this) | ||
|
r4352 | }); | ||
input.append(input_area); | ||||
|
r4360 | var output = $('<div></div>').addClass('output vbox'); | ||
|
r4352 | cell.append(input).append(output); | ||
this.element = cell; | ||||
this.collapse() | ||||
}; | ||||
|
r4378 | CodeCell.prototype.handle_codemirror_keyevent = function (editor, event) { | ||
|
r5016 | // 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. | ||||
|
r4704 | if (event.keyCode === 13 && (event.shiftKey || event.ctrlKey)) { | ||
|
r4378 | // Always ignore shift-enter in CodeMirror as we handle it. | ||
return true; | ||||
|
r4555 | } else if (event.keyCode === 9 && event.type == 'keydown') { | ||
// Tab completion. | ||||
|
r4389 | var cur = editor.getCursor(); | ||
|
r4393 | var pre_cursor = editor.getRange({line:cur.line,ch:0},cur).trim(); | ||
if (pre_cursor === "") { | ||||
|
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 { | ||||
// Autocomplete the current line. | ||||
event.stop(); | ||||
var line = editor.getLine(cur.line); | ||||
this.is_completing = true; | ||||
this.completion_cursor = cur; | ||||
IPython.notebook.complete_cell(this, line, cur.ch); | ||||
return true; | ||||
} | ||||
|
r4529 | } else if (event.keyCode === 8 && event.type == 'keydown') { | ||
|
r4512 | // If backspace and the line ends with 4 spaces, remove them. | ||
var cur = editor.getCursor(); | ||||
var line = editor.getLine(cur.line); | ||||
var ending = line.slice(-4); | ||||
if (ending === ' ') { | ||||
editor.replaceRange('', | ||||
{line: cur.line, ch: cur.ch-4}, | ||||
{line: cur.line, ch: cur.ch} | ||||
); | ||||
event.stop(); | ||||
return true; | ||||
} else { | ||||
return false; | ||||
}; | ||||
|
r5016 | } else if (event.keyCode === 76 && event.ctrlKey && event.shiftKey | ||
|
r5025 | && event.type == 'keydown') { | ||
|
r5016 | // toggle line numbers with Ctrl-Shift-L | ||
|
r5025 | this.toggle_line_numbers(); | ||
|
r5016 | } | ||
|
r5025 | else { | ||
|
r5016 | // keypress/keyup also trigger on TAB press, and we don't want to | ||
// use those to disable tab completion. | ||||
|
r4555 | if (this.is_completing && event.keyCode !== 9) { | ||
var ed_cur = editor.getCursor(); | ||||
var cc_cur = this.completion_cursor; | ||||
if (ed_cur.line !== cc_cur.line || ed_cur.ch !== cc_cur.ch) { | ||||
this.is_completing = false; | ||||
this.completion_cursor = null; | ||||
}; | ||||
}; | ||||
|
r4378 | return false; | ||
}; | ||||
}; | ||||
|
r4389 | |||
CodeCell.prototype.finish_completing = function (matched_text, matches) { | ||||
// console.log("Got matches", matched_text, matches); | ||||
|
r4555 | if (!this.is_completing || matches.length === 0) {return;} | ||
|
r4389 | |||
var that = this; | ||||
var cur = this.completion_cursor; | ||||
|
r4554 | |||
var insert = function (selected_text) { | ||||
that.code_mirror.replaceRange( | ||||
selected_text, | ||||
{line: cur.line, ch: (cur.ch-matched_text.length)}, | ||||
{line: cur.line, ch: cur.ch} | ||||
); | ||||
}; | ||||
if (matches.length === 1) { | ||||
insert(matches[0]); | ||||
setTimeout(function(){that.code_mirror.focus();}, 50); | ||||
return; | ||||
}; | ||||
|
r4389 | var complete = $('<div/>').addClass('completions'); | ||
var select = $('<select/>').attr('multiple','true'); | ||||
for (var i=0; i<matches.length; ++i) { | ||||
select.append($('<option/>').text(matches[i])); | ||||
} | ||||
select.children().first().attr('selected','true'); | ||||
select.attr('size',Math.min(10,matches.length)); | ||||
var pos = this.code_mirror.cursorCoords(); | ||||
complete.css('left',pos.x+'px'); | ||||
complete.css('top',pos.yBot+'px'); | ||||
complete.append(select); | ||||
$('body').append(complete); | ||||
var done = false; | ||||
var close = function () { | ||||
if (done) return; | ||||
done = true; | ||||
complete.remove(); | ||||
that.is_completing = false; | ||||
that.completion_cursor = null; | ||||
}; | ||||
var pick = function () { | ||||
insert(select.val()[0]); | ||||
close(); | ||||
setTimeout(function(){that.code_mirror.focus();}, 50); | ||||
}; | ||||
select.blur(close); | ||||
select.keydown(function (event) { | ||||
var code = event.which; | ||||
if (code === 13 || code === 32) { | ||||
// Pressing SPACE or ENTER will cause a pick | ||||
event.stopPropagation(); | ||||
event.preventDefault(); | ||||
pick(); | ||||
} else if (code === 38 || code === 40) { | ||||
// We don't want the document keydown handler to handle UP/DOWN, | ||||
// but we want the default action. | ||||
event.stopPropagation(); | ||||
} else { | ||||
|
r4555 | // All other key presses exit completion. | ||
|
r4389 | event.stopPropagation(); | ||
event.preventDefault(); | ||||
close(); | ||||
that.code_mirror.focus(); | ||||
} | ||||
}); | ||||
// Double click also causes a pick. | ||||
select.dblclick(pick); | ||||
select.focus(); | ||||
}; | ||||
|
r5020 | CodeCell.prototype.toggle_line_numbers = function () { | ||
|
r5025 | if (this.code_mirror.getOption('lineNumbers') == false) { | ||
this.code_mirror.setOption('lineNumbers', true); | ||||
} else { | ||||
this.code_mirror.setOption('lineNumbers', false); | ||||
} | ||||
this.code_mirror.refresh() | ||||
|
r5020 | }; | ||
|
r4389 | |||
|
r4352 | CodeCell.prototype.select = function () { | ||
IPython.Cell.prototype.select.apply(this); | ||||
|
r4504 | // Todo: this dance is needed because as of CodeMirror 2.12, focus is | ||
// not causing the cursor to blink if the editor is empty initially. | ||||
// While this seems to fix the issue, this should be fixed | ||||
// in CodeMirror proper. | ||||
var s = this.code_mirror.getValue(); | ||||
|
r4352 | this.code_mirror.focus(); | ||
|
r4504 | if (s === '') this.code_mirror.setValue(''); | ||
|
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); | ||||
}; | ||||
|
r4497 | CodeCell.prototype.append_output = function (json) { | ||
this.expand(); | ||||
if (json.output_type === 'pyout') { | ||||
this.append_pyout(json); | ||||
} else if (json.output_type === 'pyerr') { | ||||
this.append_pyerr(json); | ||||
} else if (json.output_type === 'display_data') { | ||||
this.append_display_data(json); | ||||
} else if (json.output_type === 'stream') { | ||||
this.append_stream(json); | ||||
}; | ||||
this.outputs.push(json); | ||||
}; | ||||
|
r4642 | CodeCell.prototype.create_output_area = function () { | ||
var oa = $("<div/>").addClass("hbox output_area"); | ||||
oa.append($('<div/>').addClass('prompt')); | ||||
return oa; | ||||
}; | ||||
|
r4497 | CodeCell.prototype.append_pyout = function (json) { | ||
n = json.prompt_number || ' '; | ||||
|
r4642 | var toinsert = this.create_output_area(); | ||
toinsert.find('div.prompt').addClass('output_prompt').html('Out[' + n + ']:'); | ||||
|
r4625 | this.append_mime_type(json, toinsert); | ||
|
r4642 | this.element.find('div.output').append(toinsert); | ||
|
r4352 | // If we just output latex, typeset it. | ||
|
r4497 | if (json.latex !== undefined) { | ||
|
r4349 | MathJax.Hub.Queue(["Typeset",MathJax.Hub]); | ||
}; | ||||
}; | ||||
|
r4497 | CodeCell.prototype.append_pyerr = function (json) { | ||
var tb = json.traceback; | ||||
|
r4540 | if (tb !== undefined && tb.length > 0) { | ||
|
r4528 | var s = ''; | ||
var len = tb.length; | ||||
for (var i=0; i<len; i++) { | ||||
s = s + tb[i] + '\n'; | ||||
} | ||||
s = s + '\n'; | ||||
|
r4642 | var toinsert = this.create_output_area(); | ||
this.append_text(s, toinsert); | ||||
this.element.find('div.output').append(toinsert); | ||||
|
r4528 | }; | ||
|
r4497 | }; | ||
CodeCell.prototype.append_stream = function (json) { | ||||
|
r4864 | // temporary fix: if stream undefined (json file written prior to this patch), | ||
// default to most likely stdout: | ||||
if (json.stream == undefined){ | ||||
json.stream = 'stdout'; | ||||
} | ||||
|
r4865 | var subclass = "output_"+json.stream; | ||
|
r4864 | if (this.outputs.length > 0){ | ||
// have at least one output to consider | ||||
var last = this.outputs[this.outputs.length-1]; | ||||
if (last.output_type == 'stream' && json.stream == last.stream){ | ||||
// latest output was in the same stream, | ||||
// so append directly into its pre tag | ||||
|
r4865 | this.element.find('div.'+subclass).last().find('pre').append(json.text); | ||
|
r4864 | return; | ||
} | ||||
} | ||||
// If we got here, attach a new div | ||||
|
r4642 | var toinsert = this.create_output_area(); | ||
|
r4883 | this.append_text(json.text, toinsert, "output_stream "+subclass); | ||
|
r4642 | this.element.find('div.output').append(toinsert); | ||
|
r4352 | }; | ||
|
r4349 | |||
|
r4497 | CodeCell.prototype.append_display_data = function (json) { | ||
|
r4642 | var toinsert = this.create_output_area(); | ||
this.append_mime_type(json, toinsert) | ||||
this.element.find('div.output').append(toinsert); | ||||
|
r4553 | // If we just output latex, typeset it. | ||
if (json.latex !== undefined) { | ||||
MathJax.Hub.Queue(["Typeset",MathJax.Hub]); | ||||
}; | ||||
|
r4497 | }; | ||
CodeCell.prototype.append_mime_type = function (json, element) { | ||||
if (json.html !== undefined) { | ||||
|
r4642 | this.append_html(json.html, element); | ||
|
r4497 | } else if (json.latex !== undefined) { | ||
|
r4642 | this.append_latex(json.latex, element); | ||
|
r4497 | } else if (json.svg !== undefined) { | ||
|
r4642 | this.append_svg(json.svg, element); | ||
|
r4497 | } else if (json.png !== undefined) { | ||
|
r4642 | this.append_png(json.png, element); | ||
|
r4528 | } else if (json.jpeg !== undefined) { | ||
|
r4642 | this.append_jpeg(json.jpeg, element); | ||
|
r4497 | } else if (json.text !== undefined) { | ||
|
r4642 | this.append_text(json.text, element); | ||
|
r4352 | }; | ||
}; | ||||
|
r4349 | |||
|
r4403 | CodeCell.prototype.append_html = function (html, element) { | ||
|
r4642 | var toinsert = $("<div/>").addClass("box_flex1 output_subarea output_html rendered_html"); | ||
|
r4403 | toinsert.append(html); | ||
element.append(toinsert); | ||||
} | ||||
|
r4865 | CodeCell.prototype.append_text = function (data, element, extra_class) { | ||
|
r4883 | var toinsert = $("<div/>").addClass("box_flex1 output_subarea output_text"); | ||
|
r4865 | if (extra_class){ | ||
toinsert.addClass(extra_class); | ||||
} | ||||
|
r4540 | toinsert.append($("<pre/>").html(data)); | ||
|
r4352 | element.append(toinsert); | ||
}; | ||||
|
r4349 | |||
|
r4352 | CodeCell.prototype.append_svg = function (svg, element) { | ||
|
r4642 | var toinsert = $("<div/>").addClass("box_flex1 output_subarea output_svg"); | ||
|
r4352 | toinsert.append(svg); | ||
element.append(toinsert); | ||||
}; | ||||
|
r4349 | |||
|
r4352 | CodeCell.prototype.append_png = function (png, element) { | ||
|
r4642 | var toinsert = $("<div/>").addClass("box_flex1 output_subarea output_png"); | ||
|
r4352 | toinsert.append($("<img/>").attr('src','data:image/png;base64,'+png)); | ||
element.append(toinsert); | ||||
}; | ||||
|
r4349 | |||
|
r4528 | CodeCell.prototype.append_jpeg = function (jpeg, element) { | ||
|
r4642 | var toinsert = $("<div/>").addClass("box_flex1 output_subarea output_jpeg"); | ||
|
r4528 | toinsert.append($("<img/>").attr('src','data:image/jpeg;base64,'+jpeg)); | ||
element.append(toinsert); | ||||
}; | ||||
|
r4352 | CodeCell.prototype.append_latex = function (latex, element) { | ||
// This method cannot do the typesetting because the latex first has to | ||||
// be on the page. | ||||
|
r4642 | var toinsert = $("<div/>").addClass("box_flex1 output_subarea output_latex"); | ||
|
r4352 | toinsert.append(latex); | ||
element.append(toinsert); | ||||
} | ||||
|
r4349 | |||
|
r5085 | CodeCell.prototype.clear_output = function (stdout, stderr, other) { | ||
var output_div = this.element.find("div.output"); | ||||
if (stdout && stderr && other){ | ||||
// clear all, no need for logic | ||||
output_div.html(""); | ||||
this.outputs = []; | ||||
return; | ||||
} | ||||
// remove html output | ||||
// each output_subarea that has an identifying class is in an output_area | ||||
// which is the element to be removed. | ||||
if (stdout){ | ||||
output_div.find("div.output_stdout").parent().remove(); | ||||
} | ||||
if (stderr){ | ||||
output_div.find("div.output_stderr").parent().remove(); | ||||
} | ||||
if (other){ | ||||
output_div.find("div.output_subarea").not("div.output_stderr").not("div.output_stdout").parent().remove(); | ||||
} | ||||
// remove cleared outputs from JSON list: | ||||
for (var i = this.outputs.length - 1; i >= 0; i--){ | ||||
var out = this.outputs[i]; | ||||
var output_type = out.output_type; | ||||
if (output_type == "display_data" && other){ | ||||
this.outputs.splice(i,1); | ||||
}else if (output_type == "stream"){ | ||||
if (stdout && out.stream == "stdout"){ | ||||
this.outputs.splice(i,1); | ||||
}else if (stderr && out.stream == "stderr"){ | ||||
this.outputs.splice(i,1); | ||||
} | ||||
} | ||||
} | ||||
|
r4352 | }; | ||
|
r4349 | |||
|
r4390 | CodeCell.prototype.clear_input = function () { | ||
this.code_mirror.setValue(''); | ||||
}; | ||||
|
r4352 | CodeCell.prototype.collapse = function () { | ||
|
r4533 | if (!this.collapsed) { | ||
this.element.find('div.output').hide(); | ||||
this.collapsed = true; | ||||
}; | ||||
|
r4352 | }; | ||
|
r4349 | |||
|
r4352 | CodeCell.prototype.expand = function () { | ||
|
r4533 | if (this.collapsed) { | ||
this.element.find('div.output').show(); | ||||
this.collapsed = false; | ||||
}; | ||||
|
r4352 | }; | ||
|
r4349 | |||
|
r4639 | CodeCell.prototype.toggle_output = function () { | ||
if (this.collapsed) { | ||||
this.expand(); | ||||
} else { | ||||
this.collapse(); | ||||
}; | ||||
}; | ||||
|
r4352 | CodeCell.prototype.set_input_prompt = function (number) { | ||
var n = number || ' '; | ||||
this.input_prompt_number = n | ||||
this.element.find('div.input_prompt').html('In [' + n + ']:'); | ||||
}; | ||||
|
r4349 | |||
|
r4352 | CodeCell.prototype.get_code = function () { | ||
return this.code_mirror.getValue(); | ||||
}; | ||||
|
r4349 | |||
|
r4352 | CodeCell.prototype.set_code = function (code) { | ||
return this.code_mirror.setValue(code); | ||||
}; | ||||
|
r4349 | |||
|
r4352 | CodeCell.prototype.at_top = function () { | ||
var cursor = this.code_mirror.getCursor(); | ||||
if (cursor.line === 0) { | ||||
return true; | ||||
} else { | ||||
return false; | ||||
} | ||||
|
r4349 | }; | ||
|
r4352 | CodeCell.prototype.at_bottom = function () { | ||
var cursor = this.code_mirror.getCursor(); | ||||
if (cursor.line === (this.code_mirror.lineCount()-1)) { | ||||
return true; | ||||
} else { | ||||
return false; | ||||
} | ||||
|
r4349 | }; | ||
|
r4352 | CodeCell.prototype.fromJSON = function (data) { | ||
|
r4865 | console.log('Import from JSON:', data); | ||
|
r4352 | if (data.cell_type === 'code') { | ||
|
r4484 | if (data.input !== undefined) { | ||
this.set_code(data.input); | ||||
} | ||||
if (data.prompt_number !== undefined) { | ||||
this.set_input_prompt(data.prompt_number); | ||||
} else { | ||||
this.set_input_prompt(); | ||||
}; | ||||
|
r4497 | var len = data.outputs.length; | ||
for (var i=0; i<len; i++) { | ||||
this.append_output(data.outputs[i]); | ||||
}; | ||||
|
r4533 | if (data.collapsed !== undefined) { | ||
if (data.collapsed) { | ||||
this.collapse(); | ||||
}; | ||||
}; | ||||
|
r4352 | }; | ||
}; | ||||
CodeCell.prototype.toJSON = function () { | ||||
|
r4497 | var data = {}; | ||
|
r4484 | data.input = this.get_code(); | ||
data.cell_type = 'code'; | ||||
if (this.input_prompt_number !== ' ') { | ||||
data.prompt_number = this.input_prompt_number | ||||
|
r4352 | }; | ||
|
r4497 | var outputs = []; | ||
var len = this.outputs.length; | ||||
for (var i=0; i<len; i++) { | ||||
outputs[i] = this.outputs[i]; | ||||
}; | ||||
data.outputs = outputs; | ||||
|
r4484 | data.language = 'python'; | ||
|
r4533 | data.collapsed = this.collapsed; | ||
|
r4497 | // console.log('Export to JSON:',data); | ||
|
r4484 | return data; | ||
|
r4352 | }; | ||
|
r4497 | |||
|
r4352 | IPython.CodeCell = CodeCell; | ||
return IPython; | ||||
}(IPython)); | ||||