// Copyright (c) IPython Development Team. // Distributed under the terms of the Modified BSD License. define([ 'base/js/namespace', 'jquery', 'base/js/utils', 'base/js/dialog', 'notebook/js/textcell', 'notebook/js/codecell', 'services/sessions/js/session', 'notebook/js/celltoolbar', 'components/marked/lib/marked', 'highlight', 'notebook/js/mathjaxutils', 'base/js/keyboard', 'notebook/js/tooltip', 'notebook/js/celltoolbarpresets/default', 'notebook/js/celltoolbarpresets/rawcell', 'notebook/js/celltoolbarpresets/slideshow', ], function ( IPython, $, utils, dialog, textcell, codecell, session, celltoolbar, marked, hljs, mathjaxutils, keyboard, tooltip, default_celltoolbar, rawcell_celltoolbar, slideshow_celltoolbar ) { var Notebook = function (selector, options) { // Constructor // // A notebook contains and manages cells. // // Parameters: // selector: string // options: dictionary // Dictionary of keyword arguments. // events: $(Events) instance // keyboard_manager: KeyboardManager instance // save_widget: SaveWidget instance // config: dictionary // base_url : string // notebook_path : string // notebook_name : string this.config = options.config || {}; this.base_url = options.base_url; this.notebook_path = options.notebook_path; this.notebook_name = options.notebook_name; this.events = options.events; this.keyboard_manager = options.keyboard_manager; this.save_widget = options.save_widget; this.tooltip = new tooltip.Tooltip(this.events); this.ws_url = options.ws_url; // default_kernel_name is a temporary measure while we implement proper // kernel selection and delayed start. Do not rely on it. this.default_kernel_name = 'python'; // TODO: This code smells (and the other `= this` line a couple lines down) // We need a better way to deal with circular instance references. this.keyboard_manager.notebook = this; this.save_widget.notebook = this; mathjaxutils.init(); if (marked) { marked.setOptions({ gfm : true, tables: true, langPrefix: "language-", highlight: function(code, lang) { if (!lang) { // no language, no highlight return code; } var highlighted; try { highlighted = hljs.highlight(lang, code, false); } catch(err) { highlighted = hljs.highlightAuto(code); } return highlighted.value; } }); } this.element = $(selector); this.element.scroll(); this.element.data("notebook", this); this.next_prompt_number = 1; this.session = null; this.kernel = null; this.clipboard = null; this.undelete_backup = null; this.undelete_index = null; this.undelete_below = false; this.paste_enabled = false; // It is important to start out in command mode to match the intial mode // of the KeyboardManager. this.mode = 'command'; this.set_dirty(false); this.metadata = {}; this._checkpoint_after_save = false; this.last_checkpoint = null; this.checkpoints = []; this.autosave_interval = 0; this.autosave_timer = null; // autosave *at most* every two minutes this.minimum_autosave_interval = 120000; // single worksheet for now this.worksheet_metadata = {}; this.notebook_name_blacklist_re = /[\/\\:]/; this.nbformat = 3; // Increment this when changing the nbformat this.nbformat_minor = 0; // Increment this when changing the nbformat this.codemirror_mode = 'ipython'; this.create_elements(); this.bind_events(); this.save_notebook = function() { // don't allow save until notebook_loaded this.save_notebook_error(null, null, "Load failed, save is disabled"); }; // Trigger cell toolbar registration. default_celltoolbar.register(this, options.events); rawcell_celltoolbar.register(this, options.events); slideshow_celltoolbar.register(this, options.events); }; /** * Tweak the notebook's CSS style. * * @method style */ Notebook.prototype.style = function () { console.log('Notebook.style() is now a empty function, please consider removing.'); }; /** * Create an HTML and CSS representation of the notebook. * * @method create_elements */ Notebook.prototype.create_elements = function () { var that = this; this.element.attr('tabindex','-1'); this.container = $("
").addClass("container").attr("id", "notebook-container"); // 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 end_space = $('').addClass('end_space'); end_space.dblclick(function (e) { var ncells = that.ncells(); that.insert_cell_below('code',ncells-1); }); this.element.append(this.container); this.container.append(end_space); }; /** * Bind JavaScript events: key presses and custom IPython events. * * @method bind_events */ Notebook.prototype.bind_events = function () { var that = this; this.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; }); this.events.on('set_dirty.Notebook', function (event, data) { that.dirty = data.value; }); this.events.on('trust_changed.Notebook', function (event, data) { that.trusted = data.value; }); this.events.on('select.Cell', function (event, data) { var index = that.find_cell_index(data.cell); that.select(index); }); this.events.on('edit_mode.Cell', function (event, data) { that.handle_edit_mode(data.cell); }); this.events.on('command_mode.Cell', function (event, data) { that.handle_command_mode(data.cell); }); this.events.on('status_autorestarting.Kernel', function () { dialog.modal({ notebook: that, keyboard_manager: that.keyboard_manager, title: "Kernel Restarting", body: "The kernel appears to have died. It will restart automatically.", buttons: { OK : { class : "btn-primary" } } }); }); this.events.on('spec_changed.Kernel', function(event, data) { that.set_kernelspec_metadata(data); if (data.codemirror_mode) { that.set_codemirror_mode(data.codemirror_mode); } }); var collapse_time = function (time) { var app_height = $('#ipython-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) { var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast'; collapse_time(time); }); var expand_time = function (time) { var app_height = $('#ipython-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) { var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast'; expand_time(time); }); // Firefox 22 broke $(window).on("beforeunload") // I'm not sure why or how. window.onbeforeunload = function (e) { // TODO: Make killing the kernel configurable. var kill_kernel = false; if (kill_kernel) { that.session.kill_kernel(); } // if we are autosaving, trigger an autosave on nav-away. // still warn, because if we don't the autosave may fail. if (that.dirty) { if ( that.autosave_interval ) { // schedule autosave in a timeout // this gives you a chance to forcefully discard changes // by reloading the page if you *really* want to. // the timer doesn't start until you *dismiss* the dialog. setTimeout(function () { if (that.dirty) { that.save_notebook(); } }, 1000); return "Autosave in progress, latest changes may be lost."; } else { return "Unsaved changes will be lost."; } } // Null is the *only* return value that will make the browser not // pop up the "don't leave" dialog. return null; }; }; /** * Set the dirty flag, and trigger the set_dirty.Notebook event * * @method set_dirty */ Notebook.prototype.set_dirty = function (value) { if (value === undefined) { value = true; } if (this.dirty == value) { return; } this.events.trigger('set_dirty.Notebook', {value: value}); }; /** * Scroll the top of the page to a given cell. * * @method scroll_to_cell * @param {Number} cell_number An index of the cell to view * @param {Number} time Animation time in milliseconds * @return {Number} Pixel offset from the top of the container */ Notebook.prototype.scroll_to_cell = function (cell_number, time) { var cells = this.get_cells(); time = time || 0; cell_number = Math.min(cells.length-1,cell_number); cell_number = Math.max(0 ,cell_number); var scroll_value = cells[cell_number].element.position().top-cells[0].element.position().top ; this.element.animate({scrollTop:scroll_value}, time); return scroll_value; }; /** * Scroll to the bottom of the page. * * @method scroll_to_bottom */ Notebook.prototype.scroll_to_bottom = function () { this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0); }; /** * Scroll to the top of the page. * * @method scroll_to_top */ Notebook.prototype.scroll_to_top = function () { this.element.animate({scrollTop:0}, 0); }; // Edit Notebook metadata Notebook.prototype.edit_metadata = function () { var that = this; dialog.edit_metadata({ md: this.metadata, callback: function (md) { that.metadata = md; }, name: 'Notebook', notebook: this, keyboard_manager: this.keyboard_manager}); }; Notebook.prototype.set_kernelspec_metadata = function(ks) { var tostore = {}; $.map(ks, function(value, field) { if (field !== 'argv' && field !== 'env') { tostore[field] = value; } }); this.metadata.kernelspec = tostore; } // Cell indexing, retrieval, etc. /** * Get all cell elements in the notebook. * * @method get_cell_elements * @return {jQuery} A selector of all cell elements */ Notebook.prototype.get_cell_elements = function () { return this.container.children("div.cell"); }; /** * Get a particular cell element. * * @method get_cell_element * @param {Number} index An index of a cell to select * @return {jQuery} A selector of the given 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; }; /** * Try to get a particular cell by msg_id. * * @method get_msg_cell * @param {String} msg_id A message UUID * @return {Cell} Cell or null if no cell was found. */ Notebook.prototype.get_msg_cell = function (msg_id) { return codecell.CodeCell.msg_cells[msg_id] || null; }; /** * Count the cells in this notebook. * * @method ncells * @return {Number} The number of cells in this notebook */ Notebook.prototype.ncells = function () { return this.get_cell_elements().length; }; /** * Get all Cell objects in this notebook. * * @method get_cells * @return {Array} This notebook's Cell objects */ // 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"); }); }; /** * Get a Cell object from this notebook. * * @method get_cell * @param {Number} index An index of a cell to retrieve * @return {Cell} A particular 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; }; /** * Get the cell below a given cell. * * @method get_next_cell * @param {Cell} cell The provided cell * @return {Cell} The next cell */ Notebook.prototype.get_next_cell = function (cell) { var result = null; var index = this.find_cell_index(cell); if (this.is_valid_cell_index(index+1)) { result = this.get_cell(index+1); } return result; }; /** * Get the cell above a given cell. * * @method get_prev_cell * @param {Cell} cell The provided cell * @return {Cell} The previous cell */ Notebook.prototype.get_prev_cell = function (cell) { // TODO: off-by-one // nb.get_prev_cell(nb.get_cell(1)) is null var result = null; var index = this.find_cell_index(cell); if (index !== null && index > 1) { result = this.get_cell(index-1); } return result; }; /** * Get the numeric index of a given cell. * * @method find_cell_index * @param {Cell} cell The provided cell * @return {Number} The cell's numeric index */ 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; }; /** * Get a given index , or the selected index if none is provided. * * @method index_or_selected * @param {Number} index A cell's index * @return {Number} The given index, or selected index if none is provided. */ 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; }; /** * Get the currently selected cell. * @method get_selected_cell * @return {Cell} The selected cell */ Notebook.prototype.get_selected_cell = function () { var index = this.get_selected_index(); return this.get_cell(index); }; /** * Check whether a cell index is valid. * * @method is_valid_cell_index * @param {Number} index A cell index * @return True if the index is valid, false otherwise */ Notebook.prototype.is_valid_cell_index = function (index) { if (index !== null && index >= 0 && index < this.ncells()) { return true; } else { return false; } }; /** * Get the index of the currently selected cell. * @method get_selected_index * @return {Number} The selected cell's numeric index */ 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. /** * Programmatically select a cell. * * @method select * @param {Number} index A cell's index * @return {Notebook} This notebook */ Notebook.prototype.select = function (index) { if (this.is_valid_cell_index(index)) { var sindex = this.get_selected_index(); if (sindex !== null && index !== sindex) { // If we are about to select a different cell, make sure we are // first in command mode. if (this.mode !== 'command') { this.command_mode(); } this.get_cell(sindex).unselect(); } var cell = this.get_cell(index); cell.select(); if (cell.cell_type === 'heading') { this.events.trigger('selected_cell_type_changed.Notebook', {'cell_type':cell.cell_type,level:cell.level} ); } else { this.events.trigger('selected_cell_type_changed.Notebook', {'cell_type':cell.cell_type} ); } } return this; }; /** * Programmatically select the next cell. * * @method select_next * @return {Notebook} This notebook */ Notebook.prototype.select_next = function () { var index = this.get_selected_index(); this.select(index+1); return this; }; /** * Programmatically select the previous cell. * * @method select_prev * @return {Notebook} This notebook */ Notebook.prototype.select_prev = function () { var index = this.get_selected_index(); this.select(index-1); return this; }; // Edit/Command mode /** * Gets the index of the cell that is in edit mode. * * @method get_edit_index * * @return index {int} **/ Notebook.prototype.get_edit_index = function () { var result = null; this.get_cell_elements().filter(function (index) { if ($(this).data("cell").mode === 'edit') { result = index; } }); return result; }; /** * Handle when a a cell blurs and the notebook should enter command mode. * * @method handle_command_mode * @param [cell] {Cell} Cell to enter command mode on. **/ Notebook.prototype.handle_command_mode = function (cell) { if (this.mode !== 'command') { cell.command_mode(); this.mode = 'command'; this.events.trigger('command_mode.Notebook'); this.keyboard_manager.command_mode(); } }; /** * Make the notebook enter command mode. * * @method command_mode **/ Notebook.prototype.command_mode = function () { var cell = this.get_cell(this.get_edit_index()); if (cell && this.mode !== 'command') { // We don't call cell.command_mode, but rather call cell.focus_cell() // which will blur and CM editor and trigger the call to // handle_command_mode. cell.focus_cell(); } }; /** * Handle when a cell fires it's edit_mode event. * * @method handle_edit_mode * @param [cell] {Cell} Cell to enter edit mode on. **/ Notebook.prototype.handle_edit_mode = function (cell) { if (cell && this.mode !== 'edit') { cell.edit_mode(); this.mode = 'edit'; this.events.trigger('edit_mode.Notebook'); this.keyboard_manager.edit_mode(); } }; /** * Make a cell enter edit mode. * * @method edit_mode **/ Notebook.prototype.edit_mode = function () { var cell = this.get_selected_cell(); if (cell && this.mode !== 'edit') { cell.unrender(); cell.focus_editor(); } }; /** * Focus the currently selected cell. * * @method focus_cell **/ Notebook.prototype.focus_cell = function () { var cell = this.get_selected_cell(); if (cell === null) {return;} // No cell is selected cell.focus_cell(); }; // Cell movement /** * Move given (or selected) cell up and select it. * * @method move_cell_up * @param [index] {integer} cell index * @return {Notebook} This notebook **/ Notebook.prototype.move_cell_up = function (index) { var i = this.index_or_selected(index); if (this.is_valid_cell_index(i) && 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); var cell = this.get_selected_cell(); cell.focus_cell(); } this.set_dirty(true); } return this; }; /** * Move given (or selected) cell down and select it * * @method move_cell_down * @param [index] {integer} cell index * @return {Notebook} This notebook **/ Notebook.prototype.move_cell_down = function (index) { var i = this.index_or_selected(index); if (this.is_valid_cell_index(i) && this.is_valid_cell_index(i+1)) { 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); var cell = this.get_selected_cell(); cell.focus_cell(); } } this.set_dirty(); return this; }; // Insertion, deletion. /** * Delete a cell from the notebook. * * @method delete_cell * @param [index] A cell's numeric index * @return {Notebook} This notebook */ Notebook.prototype.delete_cell = function (index) { var i = this.index_or_selected(index); var cell = this.get_selected_cell(); this.undelete_backup = cell.toJSON(); $('#undelete_cell').removeClass('disabled'); if (this.is_valid_cell_index(i)) { var old_ncells = this.ncells(); var ce = this.get_cell_element(i); ce.remove(); if (i === 0) { // Always make sure we have at least one cell. if (old_ncells === 1) { this.insert_cell_below('code'); } this.select(0); this.undelete_index = 0; this.undelete_below = false; } else if (i === old_ncells-1 && i !== 0) { this.select(i-1); this.undelete_index = i - 1; this.undelete_below = true; } else { this.select(i); this.undelete_index = i; this.undelete_below = false; } this.events.trigger('delete.Cell', {'cell': cell, 'index': i}); this.set_dirty(true); } return this; }; /** * Restore the most recently deleted cell. * * @method undelete */ Notebook.prototype.undelete_cell = function() { if (this.undelete_backup !== null && this.undelete_index !== null) { var current_index = this.get_selected_index(); if (this.undelete_index < current_index) { current_index = current_index + 1; } if (this.undelete_index >= this.ncells()) { this.select(this.ncells() - 1); } else { this.select(this.undelete_index); } var cell_data = this.undelete_backup; var new_cell = null; if (this.undelete_below) { new_cell = this.insert_cell_below(cell_data.cell_type); } else { new_cell = this.insert_cell_above(cell_data.cell_type); } new_cell.fromJSON(cell_data); if (this.undelete_below) { this.select(current_index+1); } else { this.select(current_index); } this.undelete_backup = null; this.undelete_index = null; } $('#undelete_cell').addClass('disabled'); }; /** * Insert a cell so that after insertion the cell is at given index. * * If cell type is not provided, it will default to the type of the * currently active cell. * * Similar to insert_above, but index parameter is mandatory * * Index will be brought back into the accessible range [0,n] * * @method insert_cell_at_index * @param [type] {string} in ['code','markdown','heading'], defaults to 'code' * @param [index] {int} a valid index where to insert cell * * @return cell {cell|null} created cell or null **/ Notebook.prototype.insert_cell_at_index = function(type, index){ var ncells = this.ncells(); index = Math.min(index,ncells); index = Math.max(index,0); var cell = null; type = type || this.get_selected_cell().cell_type; if (ncells === 0 || this.is_valid_cell_index(index) || index === ncells) { var cell_options = { events: this.events, config: this.config, keyboard_manager: this.keyboard_manager, notebook: this, tooltip: this.tooltip, }; if (type === 'code') { cell = new codecell.CodeCell(this.kernel, cell_options); cell.set_input_prompt(); } else if (type === 'markdown') { cell = new textcell.MarkdownCell(cell_options); } else if (type === 'raw') { cell = new textcell.RawCell(cell_options); } else if (type === 'heading') { cell = new textcell.HeadingCell(cell_options); } if(this._insert_element_at_index(cell.element,index)) { cell.render(); this.events.trigger('create.Cell', {'cell': cell, 'index': index}); cell.refresh(); // We used to select the cell after we refresh it, but there // are now cases were this method is called where select is // not appropriate. The selection logic should be handled by the // caller of the the top level insert_cell methods. this.set_dirty(true); } } return cell; }; /** * Insert an element at given cell index. * * @method _insert_element_at_index * @param element {dom element} a cell element * @param [index] {int} a valid index where to inser cell * @private * * return true if everything whent fine. **/ Notebook.prototype._insert_element_at_index = function(element, index){ if (element === undefined){ return false; } var ncells = this.ncells(); if (ncells === 0) { // special case append if empty this.element.find('div.end_space').before(element); } else if ( ncells === index ) { // special case append it the end, but not empty this.get_cell_element(index-1).after(element); } else if (this.is_valid_cell_index(index)) { // otherwise always somewhere to append to this.get_cell_element(index).before(element); } else { return false; } if (this.undelete_index !== null && index <= this.undelete_index) { this.undelete_index = this.undelete_index + 1; this.set_dirty(true); } return true; }; /** * Insert a cell of given type above given index, or at top * of notebook if index smaller than 0. * * default index value is the one of currently selected cell * * @method insert_cell_above * @param [type] {string} cell type * @param [index] {integer} * * @return handle to created cell or null **/ Notebook.prototype.insert_cell_above = function (type, index) { index = this.index_or_selected(index); return this.insert_cell_at_index(type, index); }; /** * Insert a cell of given type below given index, or at bottom * of notebook if index greater than number of cells * * default index value is the one of currently selected cell * * @method insert_cell_below * @param [type] {string} cell type * @param [index] {integer} * * @return handle to created cell or null * **/ Notebook.prototype.insert_cell_below = function (type, index) { index = this.index_or_selected(index); return this.insert_cell_at_index(type, index+1); }; /** * Insert cell at end of notebook * * @method insert_cell_at_bottom * @param {String} type cell type * * @return the added cell; or null **/ Notebook.prototype.insert_cell_at_bottom = function (type){ var len = this.ncells(); return this.insert_cell_below(type,len-1); }; /** * Turn a cell into a code cell. * * @method to_code * @param {Number} [index] A cell's index */ Notebook.prototype.to_code = function (index) { var i = this.index_or_selected(index); if (this.is_valid_cell_index(i)) { var source_element = this.get_cell_element(i); var source_cell = source_element.data("cell"); if (!(source_cell instanceof codecell.CodeCell)) { var target_cell = this.insert_cell_below('code',i); var text = source_cell.get_text(); if (text === source_cell.placeholder) { text = ''; } target_cell.set_text(text); // make this value the starting point, so that we can only undo // to this state, instead of a blank cell target_cell.code_mirror.clearHistory(); source_element.remove(); this.select(i); var cursor = source_cell.code_mirror.getCursor(); target_cell.code_mirror.setCursor(cursor); this.set_dirty(true); } } }; /** * Turn a cell into a Markdown cell. * * @method to_markdown * @param {Number} [index] A cell's index */ Notebook.prototype.to_markdown = function (index) { var i = this.index_or_selected(index); if (this.is_valid_cell_index(i)) { var source_element = this.get_cell_element(i); var source_cell = source_element.data("cell"); if (!(source_cell instanceof textcell.MarkdownCell)) { var target_cell = this.insert_cell_below('markdown',i); var text = source_cell.get_text(); if (text === source_cell.placeholder) { text = ''; } // We must show the editor before setting its contents target_cell.unrender(); target_cell.set_text(text); // make this value the starting point, so that we can only undo // to this state, instead of a blank cell target_cell.code_mirror.clearHistory(); source_element.remove(); this.select(i); if ((source_cell instanceof textcell.TextCell) && source_cell.rendered) { target_cell.render(); } var cursor = source_cell.code_mirror.getCursor(); target_cell.code_mirror.setCursor(cursor); this.set_dirty(true); } } }; /** * Turn a cell into a raw text cell. * * @method to_raw * @param {Number} [index] A cell's index */ Notebook.prototype.to_raw = function (index) { var i = this.index_or_selected(index); if (this.is_valid_cell_index(i)) { var source_element = this.get_cell_element(i); var source_cell = source_element.data("cell"); var target_cell = null; if (!(source_cell instanceof textcell.RawCell)) { target_cell = this.insert_cell_below('raw',i); var text = source_cell.get_text(); if (text === source_cell.placeholder) { text = ''; } // We must show the editor before setting its contents target_cell.unrender(); target_cell.set_text(text); // make this value the starting point, so that we can only undo // to this state, instead of a blank cell target_cell.code_mirror.clearHistory(); source_element.remove(); this.select(i); var cursor = source_cell.code_mirror.getCursor(); target_cell.code_mirror.setCursor(cursor); this.set_dirty(true); } } }; /** * Turn a cell into a heading cell. * * @method to_heading * @param {Number} [index] A cell's index * @param {Number} [level] A heading level (e.g., 1 becomes <h1>) */ Notebook.prototype.to_heading = function (index, level) { var level = level || 1; var i = this.index_or_selected(index); if (this.is_valid_cell_index(i)) { var source_element = this.get_cell_element(i); var source_cell = source_element.data("cell"); var target_cell = null; if (source_cell instanceof textcell.HeadingCell) { source_cell.set_level(level); } else { target_cell = this.insert_cell_below('heading',i); var text = source_cell.get_text(); if (text === source_cell.placeholder) { text = ''; } // We must show the editor before setting its contents target_cell.set_level(level); target_cell.unrender(); target_cell.set_text(text); // make this value the starting point, so that we can only undo // to this state, instead of a blank cell target_cell.code_mirror.clearHistory(); source_element.remove(); this.select(i); var cursor = source_cell.code_mirror.getCursor(); target_cell.code_mirror.setCursor(cursor); if ((source_cell instanceof textcell.TextCell) && source_cell.rendered) { target_cell.render(); } } this.set_dirty(true); this.events.trigger('selected_cell_type_changed.Notebook', {'cell_type':'heading',level:level} ); } }; // Cut/Copy/Paste /** * Enable UI elements for pasting cells. * * @method enable_paste */ Notebook.prototype.enable_paste = function () { var that = this; if (!this.paste_enabled) { $('#paste_cell_replace').removeClass('disabled') .on('click', function () {that.paste_cell_replace();}); $('#paste_cell_above').removeClass('disabled') .on('click', function () {that.paste_cell_above();}); $('#paste_cell_below').removeClass('disabled') .on('click', function () {that.paste_cell_below();}); this.paste_enabled = true; } }; /** * Disable UI elements for pasting cells. * * @method disable_paste */ Notebook.prototype.disable_paste = function () { if (this.paste_enabled) { $('#paste_cell_replace').addClass('disabled').off('click'); $('#paste_cell_above').addClass('disabled').off('click'); $('#paste_cell_below').addClass('disabled').off('click'); this.paste_enabled = false; } }; /** * Cut a cell. * * @method cut_cell */ Notebook.prototype.cut_cell = function () { this.copy_cell(); this.delete_cell(); }; /** * Copy a cell. * * @method copy_cell */ Notebook.prototype.copy_cell = function () { var cell = this.get_selected_cell(); this.clipboard = cell.toJSON(); this.enable_paste(); }; /** * Replace the selected cell with a cell in the clipboard. * * @method paste_cell_replace */ Notebook.prototype.paste_cell_replace = function () { if (this.clipboard !== null && this.paste_enabled) { var cell_data = this.clipboard; var new_cell = this.insert_cell_above(cell_data.cell_type); new_cell.fromJSON(cell_data); var old_cell = this.get_next_cell(new_cell); this.delete_cell(this.find_cell_index(old_cell)); this.select(this.find_cell_index(new_cell)); } }; /** * Paste a cell from the clipboard above the selected cell. * * @method paste_cell_above */ Notebook.prototype.paste_cell_above = function () { if (this.clipboard !== null && this.paste_enabled) { var cell_data = this.clipboard; var new_cell = this.insert_cell_above(cell_data.cell_type); new_cell.fromJSON(cell_data); new_cell.focus_cell(); } }; /** * Paste a cell from the clipboard below the selected cell. * * @method paste_cell_below */ Notebook.prototype.paste_cell_below = function () { if (this.clipboard !== null && this.paste_enabled) { var cell_data = this.clipboard; var new_cell = this.insert_cell_below(cell_data.cell_type); new_cell.fromJSON(cell_data); new_cell.focus_cell(); } }; // Split/merge /** * Split the selected cell into two, at the cursor. * * @method split_cell */ Notebook.prototype.split_cell = function () { var mdc = textcell.MarkdownCell; var rc = textcell.RawCell; var cell = this.get_selected_cell(); if (cell.is_splittable()) { var texta = cell.get_pre_cursor(); var textb = cell.get_post_cursor(); if (cell instanceof codecell.CodeCell) { // In this case the operations keep the notebook in its existing mode // so we don't need to do any post-op mode changes. cell.set_text(textb); var new_cell = this.insert_cell_above('code'); new_cell.set_text(texta); } else if ((cell instanceof mdc && !cell.rendered) || (cell instanceof rc)) { // We know cell is !rendered so we can use set_text. cell.set_text(textb); var new_cell = this.insert_cell_above(cell.cell_type); // Unrender the new cell so we can call set_text. new_cell.unrender(); new_cell.set_text(texta); } } }; /** * Combine the selected cell into the cell above it. * * @method merge_cell_above */ Notebook.prototype.merge_cell_above = function () { var mdc = textcell.MarkdownCell; var rc = textcell.RawCell; var index = this.get_selected_index(); var cell = this.get_cell(index); var render = cell.rendered; if (!cell.is_mergeable()) { return; } if (index > 0) { var upper_cell = this.get_cell(index-1); if (!upper_cell.is_mergeable()) { return; } var upper_text = upper_cell.get_text(); var text = cell.get_text(); if (cell instanceof codecell.CodeCell) { cell.set_text(upper_text+'\n'+text); } else if ((cell instanceof mdc) || (cell instanceof rc)) { cell.unrender(); // Must unrender before we set_text. cell.set_text(upper_text+'\n\n'+text); if (render) { // The rendered state of the final cell should match // that of the original selected cell; cell.render(); } } this.delete_cell(index-1); this.select(this.find_cell_index(cell)); } }; /** * Combine the selected cell into the cell below it. * * @method merge_cell_below */ Notebook.prototype.merge_cell_below = function () { var mdc = textcell.MarkdownCell; var rc = textcell.RawCell; var index = this.get_selected_index(); var cell = this.get_cell(index); var render = cell.rendered; if (!cell.is_mergeable()) { return; } if (index < this.ncells()-1) { var lower_cell = this.get_cell(index+1); if (!lower_cell.is_mergeable()) { return; } var lower_text = lower_cell.get_text(); var text = cell.get_text(); if (cell instanceof codecell.CodeCell) { cell.set_text(text+'\n'+lower_text); } else if ((cell instanceof mdc) || (cell instanceof rc)) { cell.unrender(); // Must unrender before we set_text. cell.set_text(text+'\n\n'+lower_text); if (render) { // The rendered state of the final cell should match // that of the original selected cell; cell.render(); } } this.delete_cell(index+1); this.select(this.find_cell_index(cell)); } }; // Cell collapsing and output clearing /** * Hide a cell's output. * * @method collapse_output * @param {Number} index A cell's numeric index */ Notebook.prototype.collapse_output = function (index) { var i = this.index_or_selected(index); var cell = this.get_cell(i); if (cell !== null && (cell instanceof codecell.CodeCell)) { cell.collapse_output(); this.set_dirty(true); } }; /** * Hide each code cell's output area. * * @method collapse_all_output */ Notebook.prototype.collapse_all_output = function () { $.map(this.get_cells(), function (cell, i) { if (cell instanceof codecell.CodeCell) { cell.collapse_output(); } }); // this should not be set if the `collapse` key is removed from nbformat this.set_dirty(true); }; /** * Show a cell's output. * * @method expand_output * @param {Number} index A cell's numeric index */ Notebook.prototype.expand_output = function (index) { var i = this.index_or_selected(index); var cell = this.get_cell(i); if (cell !== null && (cell instanceof codecell.CodeCell)) { cell.expand_output(); this.set_dirty(true); } }; /** * Expand each code cell's output area, and remove scrollbars. * * @method expand_all_output */ Notebook.prototype.expand_all_output = function () { $.map(this.get_cells(), function (cell, i) { if (cell instanceof codecell.CodeCell) { cell.expand_output(); } }); // this should not be set if the `collapse` key is removed from nbformat this.set_dirty(true); }; /** * Clear the selected CodeCell's output area. * * @method clear_output * @param {Number} index A cell's numeric index */ Notebook.prototype.clear_output = function (index) { var i = this.index_or_selected(index); var cell = this.get_cell(i); if (cell !== null && (cell instanceof codecell.CodeCell)) { cell.clear_output(); this.set_dirty(true); } }; /** * Clear each code cell's output area. * * @method clear_all_output */ Notebook.prototype.clear_all_output = function () { $.map(this.get_cells(), function (cell, i) { if (cell instanceof codecell.CodeCell) { cell.clear_output(); } }); this.set_dirty(true); }; /** * Scroll the selected CodeCell's output area. * * @method scroll_output * @param {Number} index A cell's numeric index */ Notebook.prototype.scroll_output = function (index) { var i = this.index_or_selected(index); var cell = this.get_cell(i); if (cell !== null && (cell instanceof codecell.CodeCell)) { cell.scroll_output(); this.set_dirty(true); } }; /** * Expand each code cell's output area, and add a scrollbar for long output. * * @method scroll_all_output */ Notebook.prototype.scroll_all_output = function () { $.map(this.get_cells(), function (cell, i) { if (cell instanceof codecell.CodeCell) { cell.scroll_output(); } }); // this should not be set if the `collapse` key is removed from nbformat this.set_dirty(true); }; /** Toggle whether a cell's output is collapsed or expanded. * * @method toggle_output * @param {Number} index A cell's numeric index */ Notebook.prototype.toggle_output = function (index) { var i = this.index_or_selected(index); var cell = this.get_cell(i); if (cell !== null && (cell instanceof codecell.CodeCell)) { cell.toggle_output(); this.set_dirty(true); } }; /** * Hide/show the output of all cells. * * @method toggle_all_output */ Notebook.prototype.toggle_all_output = function () { $.map(this.get_cells(), function (cell, i) { if (cell instanceof codecell.CodeCell) { cell.toggle_output(); } }); // this should not be set if the `collapse` key is removed from nbformat this.set_dirty(true); }; /** * Toggle a scrollbar for long cell outputs. * * @method toggle_output_scroll * @param {Number} index A cell's numeric index */ Notebook.prototype.toggle_output_scroll = function (index) { var i = this.index_or_selected(index); var cell = this.get_cell(i); if (cell !== null && (cell instanceof codecell.CodeCell)) { cell.toggle_output_scroll(); this.set_dirty(true); } }; /** * Toggle the scrolling of long output on all cells. * * @method toggle_all_output_scrolling */ Notebook.prototype.toggle_all_output_scroll = function () { $.map(this.get_cells(), function (cell, i) { if (cell instanceof codecell.CodeCell) { cell.toggle_output_scroll(); } }); // this should not be set if the `collapse` key is removed from nbformat this.set_dirty(true); }; // Other cell functions: line numbers, ... /** * Toggle line numbers in the selected cell's input area. * * @method cell_toggle_line_numbers */ Notebook.prototype.cell_toggle_line_numbers = function() { this.get_selected_cell().toggle_line_numbers(); }; /** * Set the codemirror mode for all code cells, including the default for * new code cells. * * @method set_codemirror_mode */ Notebook.prototype.set_codemirror_mode = function(newmode){ if (newmode === this.codemirror_mode) { return; } this.codemirror_mode = newmode; codecell.CodeCell.options_default.cm_config.mode = newmode; modename = newmode.name || newmode that = this; CodeMirror.requireMode(modename, function(){ $.map(that.get_cells(), function(cell, i) { if (cell.cell_type === 'code'){ cell.code_mirror.setOption('mode', newmode); // This is currently redundant, because cm_config ends up as // codemirror's own .options object, but I don't want to // rely on that. cell.cm_config.mode = newmode; } }); }) }; // Session related things /** * Start a new session and set it on each code cell. * * @method start_session */ Notebook.prototype.start_session = function (kernel_name) { if (kernel_name === undefined) { kernel_name = this.default_kernel_name; } this.session = new session.Session({ base_url: this.base_url, ws_url: this.ws_url, notebook_path: this.notebook_path, notebook_name: this.notebook_name, // For now, create all sessions with the 'python' kernel, which is the // default. Later, the user will be able to select kernels. This is // overridden if KernelManager.kernel_cmd is specified for the server. kernel_name: kernel_name, notebook: this}); this.session.start($.proxy(this._session_started, this)); }; /** * Once a session is started, link the code cells to the kernel and pass the * comm manager to the widget manager * */ Notebook.prototype._session_started = function(){ this.kernel = this.session.kernel; var ncells = this.ncells(); for (var i=0; i