//---------------------------------------------------------------------------- // 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. //---------------------------------------------------------------------------- //============================================================================ // Notebook //============================================================================ var IPython = (function (IPython) { var utils = IPython.utils; var key = IPython.utils.keycodes; var Notebook = function (selector) { this.read_only = IPython.read_only; this.element = $(selector); this.element.scroll(); this.element.data("notebook", this); this.next_prompt_number = 1; this.kernel = null; this.clipboard = null; this.paste_enabled = false; this.dirty = false; this.metadata = {}; this.control_key_active = false; this.notebook_id = null; this.notebook_name = null; this.notebook_name_blacklist_re = /[\/\\]/; this.nbformat = 3 // Increment this when changing the nbformat this.style(); this.create_elements(); this.bind_events(); }; Notebook.prototype.style = function () { $('div#notebook').addClass('border-box-sizing'); }; Notebook.prototype.create_elements = function () { // We add this end_space div to the end of the notebook div to: // i) provide a margin between the last cell and the end of the notebook // ii) to prevent the div from scrolling up when the last cell is being // edited, but is too low on the page, which browsers will do automatically. var that = this; var end_space = $('
').addClass('end_space').height("30%"); end_space.dblclick(function (e) { if (that.read_only) return; var ncells = that.ncells(); that.insert_cell_below('code',ncells-1); }); this.element.append(end_space); $('div#notebook').addClass('border-box-sizing'); }; Notebook.prototype.bind_events = function () { var that = this; $([IPython.events]).on('set_next_input.Notebook', function (event, data) { var index = that.find_cell_index(data.cell); var new_cell = that.insert_cell_below('code',index); new_cell.set_text(data.text); that.dirty = true; }); $([IPython.events]).on('set_dirty.Notebook', function (event, data) { that.dirty = data.value; }); $([IPython.events]).on('select.Cell', function (event, data) { var index = that.find_cell_index(data.cell); that.select(index); }); $(document).keydown(function (event) { // console.log(event); if (that.read_only) return true; // Save (CTRL+S) or (AppleKey+S) //metaKey = applekey on mac if ((event.ctrlKey || event.metaKey) && event.keyCode==83) { that.save_notebook(); event.preventDefault(); return false; } else if (event.which === key.ESC) { // Intercept escape at highest level to avoid closing // websocket connection with firefox event.preventDefault(); } if (event.which === key.UPARROW && !event.shiftKey) { var cell = that.get_selected_cell(); if (cell.at_top()) { event.preventDefault(); that.select_prev(); }; } else if (event.which === key.DOWNARROW && !event.shiftKey) { var cell = that.get_selected_cell(); if (cell.at_bottom()) { event.preventDefault(); that.select_next(); }; } else if (event.which === key.ENTER && event.shiftKey) { that.execute_selected_cell(); return false; } else if (event.which === key.ENTER && event.ctrlKey) { that.execute_selected_cell({terminal:true}); return false; } else if (event.which === 77 && event.ctrlKey && that.control_key_active == false) { that.control_key_active = true; return false; } else if (event.which === 88 && that.control_key_active) { // Cut selected cell = x that.cut_cell(); that.control_key_active = false; return false; } else if (event.which === 67 && that.control_key_active) { // Copy selected cell = c that.copy_cell(); that.control_key_active = false; return false; } else if (event.which === 86 && that.control_key_active) { // Paste selected cell = v that.paste_cell(); that.control_key_active = false; return false; } else if (event.which === 68 && that.control_key_active) { // Delete selected cell = d that.delete_cell(); that.control_key_active = false; return false; } else if (event.which === 65 && that.control_key_active) { // Insert code cell above selected = a that.insert_cell_above('code'); that.control_key_active = false; return false; } else if (event.which === 66 && that.control_key_active) { // Insert code cell below selected = b that.insert_cell_below('code'); that.control_key_active = false; return false; } else if (event.which === 89 && that.control_key_active) { // To code = y that.to_code(); that.control_key_active = false; return false; } else if (event.which === 77 && that.control_key_active) { // To markdown = m that.to_markdown(); that.control_key_active = false; return false; } else if (event.which === 84 && that.control_key_active) { // To Raw = t that.to_raw(); that.control_key_active = false; return false; } else if (event.which === 49 && that.control_key_active) { // To Heading 1 = 1 that.to_heading(undefined, 1); that.control_key_active = false; return false; } else if (event.which === 50 && that.control_key_active) { // To Heading 2 = 2 that.to_heading(undefined, 2); that.control_key_active = false; return false; } else if (event.which === 51 && that.control_key_active) { // To Heading 3 = 3 that.to_heading(undefined, 3); that.control_key_active = false; return false; } else if (event.which === 52 && that.control_key_active) { // To Heading 4 = 4 that.to_heading(undefined, 4); that.control_key_active = false; return false; } else if (event.which === 53 && that.control_key_active) { // To Heading 5 = 5 that.to_heading(undefined, 5); that.control_key_active = false; return false; } else if (event.which === 54 && that.control_key_active) { // To Heading 6 = 6 that.to_heading(undefined, 6); that.control_key_active = false; return false; } else if (event.which === 79 && that.control_key_active) { // Toggle output = o that.toggle_output(); that.control_key_active = false; return false; } else if (event.which === 83 && that.control_key_active) { // Save notebook = s that.save_notebook(); that.control_key_active = false; return false; } else if (event.which === 74 && that.control_key_active) { // Move cell down = j that.move_cell_down(); that.control_key_active = false; return false; } else if (event.which === 75 && that.control_key_active) { // Move cell up = k that.move_cell_up(); that.control_key_active = false; return false; } else if (event.which === 80 && that.control_key_active) { // Select previous = p that.select_prev(); that.control_key_active = false; return false; } else if (event.which === 78 && that.control_key_active) { // Select next = n that.select_next(); that.control_key_active = false; return false; } else if (event.which === 76 && that.control_key_active) { // Toggle line numbers = l that.cell_toggle_line_numbers(); that.control_key_active = false; return false; } else if (event.which === 73 && that.control_key_active) { // Interrupt kernel = i that.kernel.interrupt(); that.control_key_active = false; return false; } else if (event.which === 190 && that.control_key_active) { // Restart kernel = . # matches qt console that.restart_kernel(); that.control_key_active = false; return false; } else if (event.which === 72 && that.control_key_active) { // Show keyboard shortcuts = h IPython.quick_help.show_keyboard_shortcuts(); that.control_key_active = false; return false; } else if (that.control_key_active) { that.control_key_active = false; return true; }; return true; }); var collapse_time = function(time){ var app_height = $('div#main_app').height(); // content height var splitter_height = $('div#pager_splitter').outerHeight(true); var new_height = app_height - splitter_height; that.element.animate({height : new_height + 'px'}, time); } this.element.bind('collapse_pager', function (event,extrap) { time = (extrap != undefined) ? ((extrap.duration != undefined ) ? extrap.duration : 'fast') : 'fast'; collapse_time(time); }); var expand_time = function(time) { var app_height = $('div#main_app').height(); // content height var splitter_height = $('div#pager_splitter').outerHeight(true); var pager_height = $('div#pager').outerHeight(true); var new_height = app_height - pager_height - splitter_height; that.element.animate({height : new_height + 'px'}, time); } this.element.bind('expand_pager', function (event, extrap) { time = (extrap != undefined) ? ((extrap.duration != undefined ) ? extrap.duration : 'fast') : 'fast'; expand_time(time); }); $(window).bind('beforeunload', function () { // TODO: Make killing the kernel configurable. var kill_kernel = false; if (kill_kernel) { that.kernel.kill(); } if (that.dirty && ! that.read_only) { return "You have unsaved changes that will be lost if you leave this page."; }; // Null is the *only* return value that will make the browser not // pop up the "don't leave" dialog. return null; }); }; Notebook.prototype.scroll_to_bottom = function () { this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0); }; Notebook.prototype.scroll_to_top = function () { this.element.animate({scrollTop:0}, 0); }; // Cell indexing, retrieval, etc. Notebook.prototype.get_cell_elements = function () { return this.element.children("div.cell"); }; Notebook.prototype.get_cell_element = function (index) { var result = null; var e = this.get_cell_elements().eq(index); if (e.length !== 0) { result = e; } return result; }; Notebook.prototype.ncells = function (cell) { return this.get_cell_elements().length; }; // TODO: we are often calling cells as cells()[i], which we should optimize // to cells(i) or a new method. Notebook.prototype.get_cells = function () { return this.get_cell_elements().toArray().map(function (e) { return $(e).data("cell"); }); }; Notebook.prototype.get_cell = function (index) { var result = null; var ce = this.get_cell_element(index); if (ce !== null) { result = ce.data('cell'); } return result; } Notebook.prototype.get_next_cell = function (cell) { var result = null; var index = this.find_cell_index(cell); if (index !== null && index < this.ncells()) { result = this.get_cell(index+1); } return result; } Notebook.prototype.get_prev_cell = function (cell) { var result = null; var index = this.find_cell_index(cell); if (index !== null && index > 1) { result = this.get_cell(index-1); } return result; } Notebook.prototype.find_cell_index = function (cell) { var result = null; this.get_cell_elements().filter(function (index) { if ($(this).data("cell") === cell) { result = index; }; }); return result; }; Notebook.prototype.index_or_selected = function (index) { var i; if (index === undefined || index === null) { i = this.get_selected_index(); if (i === null) { i = 0; } } else { i = index; } return i; }; Notebook.prototype.get_selected_cell = function () { var index = this.get_selected_index(); return this.get_cell(index); }; Notebook.prototype.is_valid_cell_index = function (index) { if (index !== null && index >= 0 && index < this.ncells()) { return true; } else { return false; }; } Notebook.prototype.get_selected_index = function () { var result = null; this.get_cell_elements().filter(function (index) { if ($(this).data("cell").selected === true) { result = index; }; }); return result; }; // Cell selection. Notebook.prototype.select = function (index) { if (index !== undefined && index >= 0 && index < this.ncells()) { sindex = this.get_selected_index() if (sindex !== null && index !== sindex) { this.get_cell(sindex).unselect(); }; var cell = this.get_cell(index) cell.select(); if (cell.cell_type === 'heading') { $([IPython.events]).trigger('selected_cell_type_changed.Notebook', {'cell_type':cell.cell_type,level:cell.level} ); } else { $([IPython.events]).trigger('selected_cell_type_changed.Notebook', {'cell_type':cell.cell_type} ); }; }; return this; }; Notebook.prototype.select_next = function () { var index = this.get_selected_index(); if (index !== null && index >= 0 && (index+1) < this.ncells()) { this.select(index+1); }; return this; }; Notebook.prototype.select_prev = function () { var index = this.get_selected_index(); if (index !== null && index >= 0 && (index-1) < this.ncells()) { this.select(index-1); }; return this; }; // Cell movement Notebook.prototype.move_cell_up = function (index) { var i = this.index_or_selected(); if (i !== null && i < this.ncells() && i > 0) { var pivot = this.get_cell_element(i-1); var tomove = this.get_cell_element(i); if (pivot !== null && tomove !== null) { tomove.detach(); pivot.before(tomove); this.select(i-1); }; }; this.dirty = true; return this; }; Notebook.prototype.move_cell_down = function (index) { var i = this.index_or_selected(); if (i !== null && i < (this.ncells()-1) && i >= 0) { var pivot = this.get_cell_element(i+1); var tomove = this.get_cell_element(i); if (pivot !== null && tomove !== null) { tomove.detach(); pivot.after(tomove); this.select(i+1); }; }; this.dirty = true; return this; }; Notebook.prototype.sort_cells = function () { // This is not working right now. Calling this will actually crash // the browser. I think there is an infinite loop in here... var ncells = this.ncells(); var sindex = this.get_selected_index(); var swapped; do { swapped = false; for (var i=1; i