//---------------------------------------------------------------------------- // 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. //---------------------------------------------------------------------------- //============================================================================ // CodeCell //============================================================================ /** * An extendable module that provide base functionnality to create cell for notebook. * @module IPython * @namespace IPython * @submodule CodeCell */ /* 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 IPython = (function (IPython) { "use strict"; var utils = IPython.utils; var key = IPython.utils.keycodes; /** * A Cell conceived to write code. * * 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. * @class CodeCell * @extends IPython.Cell * * @constructor * @param {Object|null} kernel * @param {object|undefined} [options] * @param [options.cm_config] {object} config to pass to CodeMirror */ var CodeCell = function (kernel, options) { this.kernel = kernel || null; this.collapsed = false; // 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; var cm_overwrite_options = { onKeyEvent: $.proxy(this.handle_keyevent,this) }; options = this.mergeopt(CodeCell, options, {cm_config:cm_overwrite_options}); IPython.Cell.apply(this,[options]); // Attributes we want to override in this subclass. this.cell_type = "code"; var that = this; this.element.focusout( function() { that.auto_highlight(); } ); }; CodeCell.options_default = { cm_config : { extraKeys: { "Tab" : "indentMore", "Shift-Tab" : "indentLess", "Backspace" : "delSpaceToPrevTabStop", "Cmd-/" : "toggleComment", "Ctrl-/" : "toggleComment" }, mode: 'ipython', theme: 'ipython', matchBrackets: true, autoCloseBrackets: true } }; CodeCell.msg_cells = {}; CodeCell.prototype = new IPython.Cell(); /** * @method auto_highlight */ CodeCell.prototype.auto_highlight = function () { this._auto_highlight(IPython.config.cell_magic_highlight); }; /** @method create_element */ CodeCell.prototype.create_element = function () { IPython.Cell.prototype.create_element.apply(this, arguments); var cell = $('
').addClass('cell border-box-sizing code_cell'); cell.attr('tabindex','2'); var input = $('').addClass('input'); var prompt = $('').addClass('prompt input_prompt'); var inner_cell = $('').addClass('inner_cell'); this.celltoolbar = new IPython.CellToolbar(this); inner_cell.append(this.celltoolbar.element); var input_area = $('').addClass('input_area'); this.code_mirror = CodeMirror(input_area.get(0), this.cm_config); $(this.code_mirror.getInputField()).attr("spellcheck", "false"); inner_cell.append(input_area); input.append(prompt).append(inner_cell); var widget_area = $('') .addClass('widget-area') .hide(); this.widget_area = widget_area; var widget_prompt = $('') .addClass('prompt') .appendTo(widget_area); var widget_subarea = $('') .addClass('widget-subarea') .appendTo(widget_area); this.widget_subarea = widget_subarea; var widget_clear_buton = $('') .addClass('close') .html('×') .click(function() { widget_area.slideUp('', function(){ widget_subarea.html(''); }); }) .appendTo(widget_prompt); var output = $(''); cell.append(input).append(widget_area).append(output); this.element = cell; this.output_area = new IPython.OutputArea(output, true); this.completer = new IPython.Completer(this); }; /** @method bind_events */ CodeCell.prototype.bind_events = function () { IPython.Cell.prototype.bind_events.apply(this); var that = this; this.element.focusout( function() { that.auto_highlight(); } ); }; CodeCell.prototype.handle_keyevent = function (editor, event) { // console.log('CM', this.mode, event.which, event.type) if (this.mode === 'command') { return true; } else if (this.mode === 'edit') { return this.handle_codemirror_keyevent(editor, event); } }; /** * 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 */ CodeCell.prototype.handle_codemirror_keyevent = function (editor, event) { var that = this; // whatever key is pressed, first, cancel the tooltip request before // they are sent, and remove tooltip if any, except for tab again var tooltip_closed = null; if (event.type === 'keydown' && event.which != key.TAB ) { tooltip_closed = IPython.tooltip.remove_and_cancel_tooltip(); } var cur = editor.getCursor(); if (event.keyCode === key.ENTER){ this.auto_highlight(); } if (event.keyCode === key.ENTER && (event.shiftKey || event.ctrlKey || event.altKey)) { // Always ignore shift-enter in CodeMirror as we handle it. return true; } else if (event.which === 40 && event.type === 'keypress' && IPython.tooltip.time_before_tooltip >= 0) { // 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 IPython.tooltip.pending(that, true); } else if (event.which === key.UPARROW && event.type === 'keydown') { // If we are not at the top, let CM handle the up arrow and // prevent the global keydown handler from handling it. if (!that.at_top()) { event.stop(); return false; } else { return true; } } else if (event.which === key.ESC && event.type === 'keydown') { // First see if the tooltip is active and if so cancel it. if (tooltip_closed) { // The call to remove_and_cancel_tooltip above in L177 doesn't pass // force=true. Because of this it won't actually close the tooltip // if it is in sticky mode. Thus, we have to check again if it is open // and close it with force=true. if (!IPython.tooltip._hidden) { IPython.tooltip.remove_and_cancel_tooltip(true); } // If we closed the tooltip, don't let CM or the global handlers // handle this event. event.stop(); return true; } if (that.code_mirror.options.keyMap === "vim-insert") { // vim keyMap is active and in insert mode. In this case we leave vim // insert mode, but remain in notebook edit mode. // Let' CM handle this event and prevent global handling. event.stop(); return false; } else { // vim keyMap is not active. Leave notebook edit mode. // Don't let CM handle the event, defer to global handling. return true; } } else if (event.which === key.DOWNARROW && event.type === 'keydown') { // If we are not at the bottom, let CM handle the down arrow and // prevent the global keydown handler from handling it. if (!that.at_bottom()) { event.stop(); return false; } else { return true; } } else if (event.keyCode === key.TAB && event.type === 'keydown' && event.shiftKey) { if (editor.somethingSelected()){ var anchor = editor.getCursor("anchor"); var head = editor.getCursor("head"); if( anchor.line != head.line){ return false; } } IPython.tooltip.request(that); event.stop(); return true; } else if (event.keyCode === key.TAB && event.type == 'keydown') { // Tab completion. IPython.tooltip.remove_and_cancel_tooltip(); if (editor.somethingSelected()) { return false; } var pre_cursor = editor.getRange({line:cur.line,ch:0},cur); if (pre_cursor.trim() === "") { // Don't autocomplete if the part of the line before the cursor // is empty. In this case, let CodeMirror handle indentation. return false; } else { event.stop(); this.completer.startCompletion(); return true; } } else { // keypress/keyup also trigger on TAB press, and we don't want to // use those to disable tab completion. return false; } return false; }; // Kernel related calls. CodeCell.prototype.set_kernel = function (kernel) { this.kernel = kernel; }; /** * Execute current code cell to the kernel * @method execute */ CodeCell.prototype.execute = function () { this.output_area.clear_output(); // Clear widget area this.widget_subarea.html(''); this.widget_subarea.height(''); this.widget_area.height(''); this.widget_area.hide(); this.set_input_prompt('*'); this.element.addClass("running"); if (this.last_msg_id) { this.kernel.clear_callbacks_for_msg(this.last_msg_id); } var callbacks = this.get_callbacks(); var old_msg_id = this.last_msg_id; this.last_msg_id = this.kernel.execute(this.get_text(), callbacks, {silent: false, store_history: true}); if (old_msg_id) { delete CodeCell.msg_cells[old_msg_id]; } CodeCell.msg_cells[this.last_msg_id] = this; }; /** * Construct the default callbacks for * @method get_callbacks */ CodeCell.prototype.get_callbacks = function () { return { shell : { reply : $.proxy(this._handle_execute_reply, this), payload : { set_next_input : $.proxy(this._handle_set_next_input, this), page : $.proxy(this._open_with_pager, this) } }, 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) }; }; CodeCell.prototype._open_with_pager = function (payload) { $([IPython.events]).trigger('open_with_text.Pager', payload); }; /** * @method _handle_execute_reply * @private */ CodeCell.prototype._handle_execute_reply = function (msg) { this.set_input_prompt(msg.content.execution_count); this.element.removeClass("running"); $([IPython.events]).trigger('set_dirty.Notebook', {value: true}); }; /** * @method _handle_set_next_input * @private */ CodeCell.prototype._handle_set_next_input = function (payload) { var data = {'cell': this, 'text': payload.text}; $([IPython.events]).trigger('set_next_input.Notebook', data); }; /** * @method _handle_input_request * @private */ CodeCell.prototype._handle_input_request = function (msg) { this.output_area.append_raw_input(msg); }; // Basic cell manipulation. CodeCell.prototype.select = function () { var cont = IPython.Cell.prototype.select.apply(this); if (cont) { this.code_mirror.refresh(); this.auto_highlight(); } return cont; }; CodeCell.prototype.render = function () { var cont = IPython.Cell.prototype.render.apply(this); // Always execute, even if we are already in the rendered state return cont; }; CodeCell.prototype.unrender = function () { // CodeCell is always rendered return false; }; /** * Determine whether or not the unfocus event should be aknowledged. * * @method should_cancel_blur * * @return results {bool} Whether or not to ignore the cell's blur event. **/ CodeCell.prototype.should_cancel_blur = function () { // Cancel this unfocus event if the base wants to cancel or the cell // completer is open or the tooltip is open. return IPython.Cell.prototype.should_cancel_blur.apply(this) || (this.completer && this.completer.is_visible()) || (IPython.tooltip && IPython.tooltip.is_visible()); }; 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); }; CodeCell.prototype.collapse_output = function () { this.collapsed = true; this.output_area.collapse(); }; CodeCell.prototype.expand_output = function () { this.collapsed = false; this.output_area.expand(); this.output_area.unscroll_area(); }; CodeCell.prototype.scroll_output = function () { this.output_area.expand(); this.output_area.scroll_if_long(); }; CodeCell.prototype.toggle_output = function () { this.collapsed = Boolean(1 - this.collapsed); this.output_area.toggle_output(); }; CodeCell.prototype.toggle_output_scroll = function () { this.output_area.toggle_scroll(); }; CodeCell.input_prompt_classical = function (prompt_value, lines_number) { var ns; if (prompt_value == undefined) { ns = " "; } else { ns = encodeURIComponent(prompt_value); } return 'In [' + ns + ']:'; }; CodeCell.input_prompt_continuation = function (prompt_value, lines_number) { var html = [CodeCell.input_prompt_classical(prompt_value, lines_number)]; for(var i=1; i < lines_number; i++) { html.push(['...:']); } return html.join('