##// END OF EJS Templates
ensure ipython-command-mode icon displayed on load
Paul Ivanov -
Show More
@@ -1,2407 +1,2408 b''
1 //----------------------------------------------------------------------------
1 //----------------------------------------------------------------------------
2 // Copyright (C) 2011 The IPython Development Team
2 // Copyright (C) 2011 The IPython Development Team
3 //
3 //
4 // Distributed under the terms of the BSD License. The full license is in
4 // Distributed under the terms of the BSD License. The full license is in
5 // the file COPYING, distributed as part of this software.
5 // the file COPYING, distributed as part of this software.
6 //----------------------------------------------------------------------------
6 //----------------------------------------------------------------------------
7
7
8 //============================================================================
8 //============================================================================
9 // Notebook
9 // Notebook
10 //============================================================================
10 //============================================================================
11
11
12 var IPython = (function (IPython) {
12 var IPython = (function (IPython) {
13 "use strict";
13 "use strict";
14
14
15 var utils = IPython.utils;
15 var utils = IPython.utils;
16
16
17 /**
17 /**
18 * A notebook contains and manages cells.
18 * A notebook contains and manages cells.
19 *
19 *
20 * @class Notebook
20 * @class Notebook
21 * @constructor
21 * @constructor
22 * @param {String} selector A jQuery selector for the notebook's DOM element
22 * @param {String} selector A jQuery selector for the notebook's DOM element
23 * @param {Object} [options] A config object
23 * @param {Object} [options] A config object
24 */
24 */
25 var Notebook = function (selector, options) {
25 var Notebook = function (selector, options) {
26 this.options = options = options || {};
26 this.options = options = options || {};
27 this.base_url = options.base_url;
27 this.base_url = options.base_url;
28 this.notebook_path = options.notebook_path;
28 this.notebook_path = options.notebook_path;
29 this.notebook_name = options.notebook_name;
29 this.notebook_name = options.notebook_name;
30 this.element = $(selector);
30 this.element = $(selector);
31 this.element.scroll();
31 this.element.scroll();
32 this.element.data("notebook", this);
32 this.element.data("notebook", this);
33 this.next_prompt_number = 1;
33 this.next_prompt_number = 1;
34 this.session = null;
34 this.session = null;
35 this.kernel = null;
35 this.kernel = null;
36 this.clipboard = null;
36 this.clipboard = null;
37 this.undelete_backup = null;
37 this.undelete_backup = null;
38 this.undelete_index = null;
38 this.undelete_index = null;
39 this.undelete_below = false;
39 this.undelete_below = false;
40 this.paste_enabled = false;
40 this.paste_enabled = false;
41 // It is important to start out in command mode to match the intial mode
41 // It is important to start out in command mode to match the intial mode
42 // of the KeyboardManager.
42 // of the KeyboardManager.
43 this.mode = 'command';
43 this.mode = 'command';
44 this.set_dirty(false);
44 this.set_dirty(false);
45 this.metadata = {};
45 this.metadata = {};
46 this._checkpoint_after_save = false;
46 this._checkpoint_after_save = false;
47 this.last_checkpoint = null;
47 this.last_checkpoint = null;
48 this.checkpoints = [];
48 this.checkpoints = [];
49 this.autosave_interval = 0;
49 this.autosave_interval = 0;
50 this.autosave_timer = null;
50 this.autosave_timer = null;
51 // autosave *at most* every two minutes
51 // autosave *at most* every two minutes
52 this.minimum_autosave_interval = 120000;
52 this.minimum_autosave_interval = 120000;
53 // single worksheet for now
53 // single worksheet for now
54 this.worksheet_metadata = {};
54 this.worksheet_metadata = {};
55 this.notebook_name_blacklist_re = /[\/\\:]/;
55 this.notebook_name_blacklist_re = /[\/\\:]/;
56 this.nbformat = 3; // Increment this when changing the nbformat
56 this.nbformat = 3; // Increment this when changing the nbformat
57 this.nbformat_minor = 0; // Increment this when changing the nbformat
57 this.nbformat_minor = 0; // Increment this when changing the nbformat
58 this.style();
58 this.style();
59 this.create_elements();
59 this.create_elements();
60 this.bind_events();
60 this.bind_events();
61 };
61 };
62
62
63 /**
63 /**
64 * Tweak the notebook's CSS style.
64 * Tweak the notebook's CSS style.
65 *
65 *
66 * @method style
66 * @method style
67 */
67 */
68 Notebook.prototype.style = function () {
68 Notebook.prototype.style = function () {
69 $('div#notebook').addClass('border-box-sizing');
69 $('div#notebook').addClass('border-box-sizing');
70 };
70 };
71
71
72 /**
72 /**
73 * Create an HTML and CSS representation of the notebook.
73 * Create an HTML and CSS representation of the notebook.
74 *
74 *
75 * @method create_elements
75 * @method create_elements
76 */
76 */
77 Notebook.prototype.create_elements = function () {
77 Notebook.prototype.create_elements = function () {
78 var that = this;
78 var that = this;
79 this.element.attr('tabindex','-1');
79 this.element.attr('tabindex','-1');
80 this.container = $("<div/>").addClass("container").attr("id", "notebook-container");
80 this.container = $("<div/>").addClass("container").attr("id", "notebook-container");
81 // We add this end_space div to the end of the notebook div to:
81 // We add this end_space div to the end of the notebook div to:
82 // i) provide a margin between the last cell and the end of the notebook
82 // i) provide a margin between the last cell and the end of the notebook
83 // ii) to prevent the div from scrolling up when the last cell is being
83 // ii) to prevent the div from scrolling up when the last cell is being
84 // edited, but is too low on the page, which browsers will do automatically.
84 // edited, but is too low on the page, which browsers will do automatically.
85 var end_space = $('<div/>').addClass('end_space');
85 var end_space = $('<div/>').addClass('end_space');
86 end_space.dblclick(function (e) {
86 end_space.dblclick(function (e) {
87 var ncells = that.ncells();
87 var ncells = that.ncells();
88 that.insert_cell_below('code',ncells-1);
88 that.insert_cell_below('code',ncells-1);
89 });
89 });
90 this.element.append(this.container);
90 this.element.append(this.container);
91 this.container.append(end_space);
91 this.container.append(end_space);
92 };
92 };
93
93
94 /**
94 /**
95 * Bind JavaScript events: key presses and custom IPython events.
95 * Bind JavaScript events: key presses and custom IPython events.
96 *
96 *
97 * @method bind_events
97 * @method bind_events
98 */
98 */
99 Notebook.prototype.bind_events = function () {
99 Notebook.prototype.bind_events = function () {
100 var that = this;
100 var that = this;
101
101
102 $([IPython.events]).on('set_next_input.Notebook', function (event, data) {
102 $([IPython.events]).on('set_next_input.Notebook', function (event, data) {
103 var index = that.find_cell_index(data.cell);
103 var index = that.find_cell_index(data.cell);
104 var new_cell = that.insert_cell_below('code',index);
104 var new_cell = that.insert_cell_below('code',index);
105 new_cell.set_text(data.text);
105 new_cell.set_text(data.text);
106 that.dirty = true;
106 that.dirty = true;
107 });
107 });
108
108
109 $([IPython.events]).on('set_dirty.Notebook', function (event, data) {
109 $([IPython.events]).on('set_dirty.Notebook', function (event, data) {
110 that.dirty = data.value;
110 that.dirty = data.value;
111 });
111 });
112
112
113 $([IPython.events]).on('trust_changed.Notebook', function (event, data) {
113 $([IPython.events]).on('trust_changed.Notebook', function (event, data) {
114 that.trusted = data.value;
114 that.trusted = data.value;
115 });
115 });
116
116
117 $([IPython.events]).on('select.Cell', function (event, data) {
117 $([IPython.events]).on('select.Cell', function (event, data) {
118 var index = that.find_cell_index(data.cell);
118 var index = that.find_cell_index(data.cell);
119 that.select(index);
119 that.select(index);
120 });
120 });
121
121
122 $([IPython.events]).on('edit_mode.Cell', function (event, data) {
122 $([IPython.events]).on('edit_mode.Cell', function (event, data) {
123 that.handle_edit_mode(data.cell);
123 that.handle_edit_mode(data.cell);
124 });
124 });
125
125
126 $([IPython.events]).on('command_mode.Cell', function (event, data) {
126 $([IPython.events]).on('command_mode.Cell', function (event, data) {
127 that.handle_command_mode(data.cell);
127 that.handle_command_mode(data.cell);
128 });
128 });
129
129
130 $([IPython.events]).on('status_autorestarting.Kernel', function () {
130 $([IPython.events]).on('status_autorestarting.Kernel', function () {
131 IPython.dialog.modal({
131 IPython.dialog.modal({
132 title: "Kernel Restarting",
132 title: "Kernel Restarting",
133 body: "The kernel appears to have died. It will restart automatically.",
133 body: "The kernel appears to have died. It will restart automatically.",
134 buttons: {
134 buttons: {
135 OK : {
135 OK : {
136 class : "btn-primary"
136 class : "btn-primary"
137 }
137 }
138 }
138 }
139 });
139 });
140 });
140 });
141
141
142 var collapse_time = function (time) {
142 var collapse_time = function (time) {
143 var app_height = $('#ipython-main-app').height(); // content height
143 var app_height = $('#ipython-main-app').height(); // content height
144 var splitter_height = $('div#pager_splitter').outerHeight(true);
144 var splitter_height = $('div#pager_splitter').outerHeight(true);
145 var new_height = app_height - splitter_height;
145 var new_height = app_height - splitter_height;
146 that.element.animate({height : new_height + 'px'}, time);
146 that.element.animate({height : new_height + 'px'}, time);
147 };
147 };
148
148
149 this.element.bind('collapse_pager', function (event, extrap) {
149 this.element.bind('collapse_pager', function (event, extrap) {
150 var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast';
150 var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast';
151 collapse_time(time);
151 collapse_time(time);
152 });
152 });
153
153
154 var expand_time = function (time) {
154 var expand_time = function (time) {
155 var app_height = $('#ipython-main-app').height(); // content height
155 var app_height = $('#ipython-main-app').height(); // content height
156 var splitter_height = $('div#pager_splitter').outerHeight(true);
156 var splitter_height = $('div#pager_splitter').outerHeight(true);
157 var pager_height = $('div#pager').outerHeight(true);
157 var pager_height = $('div#pager').outerHeight(true);
158 var new_height = app_height - pager_height - splitter_height;
158 var new_height = app_height - pager_height - splitter_height;
159 that.element.animate({height : new_height + 'px'}, time);
159 that.element.animate({height : new_height + 'px'}, time);
160 };
160 };
161
161
162 this.element.bind('expand_pager', function (event, extrap) {
162 this.element.bind('expand_pager', function (event, extrap) {
163 var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast';
163 var time = (extrap !== undefined) ? ((extrap.duration !== undefined ) ? extrap.duration : 'fast') : 'fast';
164 expand_time(time);
164 expand_time(time);
165 });
165 });
166
166
167 // Firefox 22 broke $(window).on("beforeunload")
167 // Firefox 22 broke $(window).on("beforeunload")
168 // I'm not sure why or how.
168 // I'm not sure why or how.
169 window.onbeforeunload = function (e) {
169 window.onbeforeunload = function (e) {
170 // TODO: Make killing the kernel configurable.
170 // TODO: Make killing the kernel configurable.
171 var kill_kernel = false;
171 var kill_kernel = false;
172 if (kill_kernel) {
172 if (kill_kernel) {
173 that.session.kill_kernel();
173 that.session.kill_kernel();
174 }
174 }
175 // if we are autosaving, trigger an autosave on nav-away.
175 // if we are autosaving, trigger an autosave on nav-away.
176 // still warn, because if we don't the autosave may fail.
176 // still warn, because if we don't the autosave may fail.
177 if (that.dirty) {
177 if (that.dirty) {
178 if ( that.autosave_interval ) {
178 if ( that.autosave_interval ) {
179 // schedule autosave in a timeout
179 // schedule autosave in a timeout
180 // this gives you a chance to forcefully discard changes
180 // this gives you a chance to forcefully discard changes
181 // by reloading the page if you *really* want to.
181 // by reloading the page if you *really* want to.
182 // the timer doesn't start until you *dismiss* the dialog.
182 // the timer doesn't start until you *dismiss* the dialog.
183 setTimeout(function () {
183 setTimeout(function () {
184 if (that.dirty) {
184 if (that.dirty) {
185 that.save_notebook();
185 that.save_notebook();
186 }
186 }
187 }, 1000);
187 }, 1000);
188 return "Autosave in progress, latest changes may be lost.";
188 return "Autosave in progress, latest changes may be lost.";
189 } else {
189 } else {
190 return "Unsaved changes will be lost.";
190 return "Unsaved changes will be lost.";
191 }
191 }
192 }
192 }
193 // Null is the *only* return value that will make the browser not
193 // Null is the *only* return value that will make the browser not
194 // pop up the "don't leave" dialog.
194 // pop up the "don't leave" dialog.
195 return null;
195 return null;
196 };
196 };
197 };
197 };
198
198
199 /**
199 /**
200 * Set the dirty flag, and trigger the set_dirty.Notebook event
200 * Set the dirty flag, and trigger the set_dirty.Notebook event
201 *
201 *
202 * @method set_dirty
202 * @method set_dirty
203 */
203 */
204 Notebook.prototype.set_dirty = function (value) {
204 Notebook.prototype.set_dirty = function (value) {
205 if (value === undefined) {
205 if (value === undefined) {
206 value = true;
206 value = true;
207 }
207 }
208 if (this.dirty == value) {
208 if (this.dirty == value) {
209 return;
209 return;
210 }
210 }
211 $([IPython.events]).trigger('set_dirty.Notebook', {value: value});
211 $([IPython.events]).trigger('set_dirty.Notebook', {value: value});
212 };
212 };
213
213
214 /**
214 /**
215 * Scroll the top of the page to a given cell.
215 * Scroll the top of the page to a given cell.
216 *
216 *
217 * @method scroll_to_cell
217 * @method scroll_to_cell
218 * @param {Number} cell_number An index of the cell to view
218 * @param {Number} cell_number An index of the cell to view
219 * @param {Number} time Animation time in milliseconds
219 * @param {Number} time Animation time in milliseconds
220 * @return {Number} Pixel offset from the top of the container
220 * @return {Number} Pixel offset from the top of the container
221 */
221 */
222 Notebook.prototype.scroll_to_cell = function (cell_number, time) {
222 Notebook.prototype.scroll_to_cell = function (cell_number, time) {
223 var cells = this.get_cells();
223 var cells = this.get_cells();
224 time = time || 0;
224 time = time || 0;
225 cell_number = Math.min(cells.length-1,cell_number);
225 cell_number = Math.min(cells.length-1,cell_number);
226 cell_number = Math.max(0 ,cell_number);
226 cell_number = Math.max(0 ,cell_number);
227 var scroll_value = cells[cell_number].element.position().top-cells[0].element.position().top ;
227 var scroll_value = cells[cell_number].element.position().top-cells[0].element.position().top ;
228 this.element.animate({scrollTop:scroll_value}, time);
228 this.element.animate({scrollTop:scroll_value}, time);
229 return scroll_value;
229 return scroll_value;
230 };
230 };
231
231
232 /**
232 /**
233 * Scroll to the bottom of the page.
233 * Scroll to the bottom of the page.
234 *
234 *
235 * @method scroll_to_bottom
235 * @method scroll_to_bottom
236 */
236 */
237 Notebook.prototype.scroll_to_bottom = function () {
237 Notebook.prototype.scroll_to_bottom = function () {
238 this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0);
238 this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0);
239 };
239 };
240
240
241 /**
241 /**
242 * Scroll to the top of the page.
242 * Scroll to the top of the page.
243 *
243 *
244 * @method scroll_to_top
244 * @method scroll_to_top
245 */
245 */
246 Notebook.prototype.scroll_to_top = function () {
246 Notebook.prototype.scroll_to_top = function () {
247 this.element.animate({scrollTop:0}, 0);
247 this.element.animate({scrollTop:0}, 0);
248 };
248 };
249
249
250 // Edit Notebook metadata
250 // Edit Notebook metadata
251
251
252 Notebook.prototype.edit_metadata = function () {
252 Notebook.prototype.edit_metadata = function () {
253 var that = this;
253 var that = this;
254 IPython.dialog.edit_metadata(this.metadata, function (md) {
254 IPython.dialog.edit_metadata(this.metadata, function (md) {
255 that.metadata = md;
255 that.metadata = md;
256 }, 'Notebook');
256 }, 'Notebook');
257 };
257 };
258
258
259 // Cell indexing, retrieval, etc.
259 // Cell indexing, retrieval, etc.
260
260
261 /**
261 /**
262 * Get all cell elements in the notebook.
262 * Get all cell elements in the notebook.
263 *
263 *
264 * @method get_cell_elements
264 * @method get_cell_elements
265 * @return {jQuery} A selector of all cell elements
265 * @return {jQuery} A selector of all cell elements
266 */
266 */
267 Notebook.prototype.get_cell_elements = function () {
267 Notebook.prototype.get_cell_elements = function () {
268 return this.container.children("div.cell");
268 return this.container.children("div.cell");
269 };
269 };
270
270
271 /**
271 /**
272 * Get a particular cell element.
272 * Get a particular cell element.
273 *
273 *
274 * @method get_cell_element
274 * @method get_cell_element
275 * @param {Number} index An index of a cell to select
275 * @param {Number} index An index of a cell to select
276 * @return {jQuery} A selector of the given cell.
276 * @return {jQuery} A selector of the given cell.
277 */
277 */
278 Notebook.prototype.get_cell_element = function (index) {
278 Notebook.prototype.get_cell_element = function (index) {
279 var result = null;
279 var result = null;
280 var e = this.get_cell_elements().eq(index);
280 var e = this.get_cell_elements().eq(index);
281 if (e.length !== 0) {
281 if (e.length !== 0) {
282 result = e;
282 result = e;
283 }
283 }
284 return result;
284 return result;
285 };
285 };
286
286
287 /**
287 /**
288 * Try to get a particular cell by msg_id.
288 * Try to get a particular cell by msg_id.
289 *
289 *
290 * @method get_msg_cell
290 * @method get_msg_cell
291 * @param {String} msg_id A message UUID
291 * @param {String} msg_id A message UUID
292 * @return {Cell} Cell or null if no cell was found.
292 * @return {Cell} Cell or null if no cell was found.
293 */
293 */
294 Notebook.prototype.get_msg_cell = function (msg_id) {
294 Notebook.prototype.get_msg_cell = function (msg_id) {
295 return IPython.CodeCell.msg_cells[msg_id] || null;
295 return IPython.CodeCell.msg_cells[msg_id] || null;
296 };
296 };
297
297
298 /**
298 /**
299 * Count the cells in this notebook.
299 * Count the cells in this notebook.
300 *
300 *
301 * @method ncells
301 * @method ncells
302 * @return {Number} The number of cells in this notebook
302 * @return {Number} The number of cells in this notebook
303 */
303 */
304 Notebook.prototype.ncells = function () {
304 Notebook.prototype.ncells = function () {
305 return this.get_cell_elements().length;
305 return this.get_cell_elements().length;
306 };
306 };
307
307
308 /**
308 /**
309 * Get all Cell objects in this notebook.
309 * Get all Cell objects in this notebook.
310 *
310 *
311 * @method get_cells
311 * @method get_cells
312 * @return {Array} This notebook's Cell objects
312 * @return {Array} This notebook's Cell objects
313 */
313 */
314 // TODO: we are often calling cells as cells()[i], which we should optimize
314 // TODO: we are often calling cells as cells()[i], which we should optimize
315 // to cells(i) or a new method.
315 // to cells(i) or a new method.
316 Notebook.prototype.get_cells = function () {
316 Notebook.prototype.get_cells = function () {
317 return this.get_cell_elements().toArray().map(function (e) {
317 return this.get_cell_elements().toArray().map(function (e) {
318 return $(e).data("cell");
318 return $(e).data("cell");
319 });
319 });
320 };
320 };
321
321
322 /**
322 /**
323 * Get a Cell object from this notebook.
323 * Get a Cell object from this notebook.
324 *
324 *
325 * @method get_cell
325 * @method get_cell
326 * @param {Number} index An index of a cell to retrieve
326 * @param {Number} index An index of a cell to retrieve
327 * @return {Cell} A particular cell
327 * @return {Cell} A particular cell
328 */
328 */
329 Notebook.prototype.get_cell = function (index) {
329 Notebook.prototype.get_cell = function (index) {
330 var result = null;
330 var result = null;
331 var ce = this.get_cell_element(index);
331 var ce = this.get_cell_element(index);
332 if (ce !== null) {
332 if (ce !== null) {
333 result = ce.data('cell');
333 result = ce.data('cell');
334 }
334 }
335 return result;
335 return result;
336 };
336 };
337
337
338 /**
338 /**
339 * Get the cell below a given cell.
339 * Get the cell below a given cell.
340 *
340 *
341 * @method get_next_cell
341 * @method get_next_cell
342 * @param {Cell} cell The provided cell
342 * @param {Cell} cell The provided cell
343 * @return {Cell} The next cell
343 * @return {Cell} The next cell
344 */
344 */
345 Notebook.prototype.get_next_cell = function (cell) {
345 Notebook.prototype.get_next_cell = function (cell) {
346 var result = null;
346 var result = null;
347 var index = this.find_cell_index(cell);
347 var index = this.find_cell_index(cell);
348 if (this.is_valid_cell_index(index+1)) {
348 if (this.is_valid_cell_index(index+1)) {
349 result = this.get_cell(index+1);
349 result = this.get_cell(index+1);
350 }
350 }
351 return result;
351 return result;
352 };
352 };
353
353
354 /**
354 /**
355 * Get the cell above a given cell.
355 * Get the cell above a given cell.
356 *
356 *
357 * @method get_prev_cell
357 * @method get_prev_cell
358 * @param {Cell} cell The provided cell
358 * @param {Cell} cell The provided cell
359 * @return {Cell} The previous cell
359 * @return {Cell} The previous cell
360 */
360 */
361 Notebook.prototype.get_prev_cell = function (cell) {
361 Notebook.prototype.get_prev_cell = function (cell) {
362 // TODO: off-by-one
362 // TODO: off-by-one
363 // nb.get_prev_cell(nb.get_cell(1)) is null
363 // nb.get_prev_cell(nb.get_cell(1)) is null
364 var result = null;
364 var result = null;
365 var index = this.find_cell_index(cell);
365 var index = this.find_cell_index(cell);
366 if (index !== null && index > 1) {
366 if (index !== null && index > 1) {
367 result = this.get_cell(index-1);
367 result = this.get_cell(index-1);
368 }
368 }
369 return result;
369 return result;
370 };
370 };
371
371
372 /**
372 /**
373 * Get the numeric index of a given cell.
373 * Get the numeric index of a given cell.
374 *
374 *
375 * @method find_cell_index
375 * @method find_cell_index
376 * @param {Cell} cell The provided cell
376 * @param {Cell} cell The provided cell
377 * @return {Number} The cell's numeric index
377 * @return {Number} The cell's numeric index
378 */
378 */
379 Notebook.prototype.find_cell_index = function (cell) {
379 Notebook.prototype.find_cell_index = function (cell) {
380 var result = null;
380 var result = null;
381 this.get_cell_elements().filter(function (index) {
381 this.get_cell_elements().filter(function (index) {
382 if ($(this).data("cell") === cell) {
382 if ($(this).data("cell") === cell) {
383 result = index;
383 result = index;
384 }
384 }
385 });
385 });
386 return result;
386 return result;
387 };
387 };
388
388
389 /**
389 /**
390 * Get a given index , or the selected index if none is provided.
390 * Get a given index , or the selected index if none is provided.
391 *
391 *
392 * @method index_or_selected
392 * @method index_or_selected
393 * @param {Number} index A cell's index
393 * @param {Number} index A cell's index
394 * @return {Number} The given index, or selected index if none is provided.
394 * @return {Number} The given index, or selected index if none is provided.
395 */
395 */
396 Notebook.prototype.index_or_selected = function (index) {
396 Notebook.prototype.index_or_selected = function (index) {
397 var i;
397 var i;
398 if (index === undefined || index === null) {
398 if (index === undefined || index === null) {
399 i = this.get_selected_index();
399 i = this.get_selected_index();
400 if (i === null) {
400 if (i === null) {
401 i = 0;
401 i = 0;
402 }
402 }
403 } else {
403 } else {
404 i = index;
404 i = index;
405 }
405 }
406 return i;
406 return i;
407 };
407 };
408
408
409 /**
409 /**
410 * Get the currently selected cell.
410 * Get the currently selected cell.
411 * @method get_selected_cell
411 * @method get_selected_cell
412 * @return {Cell} The selected cell
412 * @return {Cell} The selected cell
413 */
413 */
414 Notebook.prototype.get_selected_cell = function () {
414 Notebook.prototype.get_selected_cell = function () {
415 var index = this.get_selected_index();
415 var index = this.get_selected_index();
416 return this.get_cell(index);
416 return this.get_cell(index);
417 };
417 };
418
418
419 /**
419 /**
420 * Check whether a cell index is valid.
420 * Check whether a cell index is valid.
421 *
421 *
422 * @method is_valid_cell_index
422 * @method is_valid_cell_index
423 * @param {Number} index A cell index
423 * @param {Number} index A cell index
424 * @return True if the index is valid, false otherwise
424 * @return True if the index is valid, false otherwise
425 */
425 */
426 Notebook.prototype.is_valid_cell_index = function (index) {
426 Notebook.prototype.is_valid_cell_index = function (index) {
427 if (index !== null && index >= 0 && index < this.ncells()) {
427 if (index !== null && index >= 0 && index < this.ncells()) {
428 return true;
428 return true;
429 } else {
429 } else {
430 return false;
430 return false;
431 }
431 }
432 };
432 };
433
433
434 /**
434 /**
435 * Get the index of the currently selected cell.
435 * Get the index of the currently selected cell.
436
436
437 * @method get_selected_index
437 * @method get_selected_index
438 * @return {Number} The selected cell's numeric index
438 * @return {Number} The selected cell's numeric index
439 */
439 */
440 Notebook.prototype.get_selected_index = function () {
440 Notebook.prototype.get_selected_index = function () {
441 var result = null;
441 var result = null;
442 this.get_cell_elements().filter(function (index) {
442 this.get_cell_elements().filter(function (index) {
443 if ($(this).data("cell").selected === true) {
443 if ($(this).data("cell").selected === true) {
444 result = index;
444 result = index;
445 }
445 }
446 });
446 });
447 return result;
447 return result;
448 };
448 };
449
449
450
450
451 // Cell selection.
451 // Cell selection.
452
452
453 /**
453 /**
454 * Programmatically select a cell.
454 * Programmatically select a cell.
455 *
455 *
456 * @method select
456 * @method select
457 * @param {Number} index A cell's index
457 * @param {Number} index A cell's index
458 * @return {Notebook} This notebook
458 * @return {Notebook} This notebook
459 */
459 */
460 Notebook.prototype.select = function (index) {
460 Notebook.prototype.select = function (index) {
461 if (this.is_valid_cell_index(index)) {
461 if (this.is_valid_cell_index(index)) {
462 var sindex = this.get_selected_index();
462 var sindex = this.get_selected_index();
463 if (sindex !== null && index !== sindex) {
463 if (sindex !== null && index !== sindex) {
464 // If we are about to select a different cell, make sure we are
464 // If we are about to select a different cell, make sure we are
465 // first in command mode.
465 // first in command mode.
466 if (this.mode !== 'command') {
466 if (this.mode !== 'command') {
467 this.command_mode();
467 this.command_mode();
468 }
468 }
469 this.get_cell(sindex).unselect();
469 this.get_cell(sindex).unselect();
470 }
470 }
471 var cell = this.get_cell(index);
471 var cell = this.get_cell(index);
472 cell.select();
472 cell.select();
473 if (cell.cell_type === 'heading') {
473 if (cell.cell_type === 'heading') {
474 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
474 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
475 {'cell_type':cell.cell_type,level:cell.level}
475 {'cell_type':cell.cell_type,level:cell.level}
476 );
476 );
477 } else {
477 } else {
478 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
478 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
479 {'cell_type':cell.cell_type}
479 {'cell_type':cell.cell_type}
480 );
480 );
481 }
481 }
482 }
482 }
483 return this;
483 return this;
484 };
484 };
485
485
486 /**
486 /**
487 * Programmatically select the next cell.
487 * Programmatically select the next cell.
488 *
488 *
489 * @method select_next
489 * @method select_next
490 * @return {Notebook} This notebook
490 * @return {Notebook} This notebook
491 */
491 */
492 Notebook.prototype.select_next = function () {
492 Notebook.prototype.select_next = function () {
493 var index = this.get_selected_index();
493 var index = this.get_selected_index();
494 this.select(index+1);
494 this.select(index+1);
495 return this;
495 return this;
496 };
496 };
497
497
498 /**
498 /**
499 * Programmatically select the previous cell.
499 * Programmatically select the previous cell.
500 *
500 *
501 * @method select_prev
501 * @method select_prev
502 * @return {Notebook} This notebook
502 * @return {Notebook} This notebook
503 */
503 */
504 Notebook.prototype.select_prev = function () {
504 Notebook.prototype.select_prev = function () {
505 var index = this.get_selected_index();
505 var index = this.get_selected_index();
506 this.select(index-1);
506 this.select(index-1);
507 return this;
507 return this;
508 };
508 };
509
509
510
510
511 // Edit/Command mode
511 // Edit/Command mode
512
512
513 /**
513 /**
514 * Gets the index of the cell that is in edit mode.
514 * Gets the index of the cell that is in edit mode.
515 *
515 *
516 * @method get_edit_index
516 * @method get_edit_index
517 *
517 *
518 * @return index {int}
518 * @return index {int}
519 **/
519 **/
520 Notebook.prototype.get_edit_index = function () {
520 Notebook.prototype.get_edit_index = function () {
521 var result = null;
521 var result = null;
522 this.get_cell_elements().filter(function (index) {
522 this.get_cell_elements().filter(function (index) {
523 if ($(this).data("cell").mode === 'edit') {
523 if ($(this).data("cell").mode === 'edit') {
524 result = index;
524 result = index;
525 }
525 }
526 });
526 });
527 return result;
527 return result;
528 };
528 };
529
529
530 /**
530 /**
531 * Handle when a a cell blurs and the notebook should enter command mode.
531 * Handle when a a cell blurs and the notebook should enter command mode.
532 *
532 *
533 * @method handle_command_mode
533 * @method handle_command_mode
534 * @param [cell] {Cell} Cell to enter command mode on.
534 * @param [cell] {Cell} Cell to enter command mode on.
535 **/
535 **/
536 Notebook.prototype.handle_command_mode = function (cell) {
536 Notebook.prototype.handle_command_mode = function (cell) {
537 if (this.mode !== 'command') {
537 if (this.mode !== 'command') {
538 cell.command_mode();
538 cell.command_mode();
539 this.mode = 'command';
539 this.mode = 'command';
540 $([IPython.events]).trigger('command_mode.Notebook');
540 $([IPython.events]).trigger('command_mode.Notebook');
541 IPython.keyboard_manager.command_mode();
541 IPython.keyboard_manager.command_mode();
542 }
542 }
543 };
543 };
544
544
545 /**
545 /**
546 * Make the notebook enter command mode.
546 * Make the notebook enter command mode.
547 *
547 *
548 * @method command_mode
548 * @method command_mode
549 **/
549 **/
550 Notebook.prototype.command_mode = function () {
550 Notebook.prototype.command_mode = function () {
551 var cell = this.get_cell(this.get_edit_index());
551 var cell = this.get_cell(this.get_edit_index());
552 if (cell && this.mode !== 'command') {
552 if (cell && this.mode !== 'command') {
553 // We don't call cell.command_mode, but rather call cell.focus_cell()
553 // We don't call cell.command_mode, but rather call cell.focus_cell()
554 // which will blur and CM editor and trigger the call to
554 // which will blur and CM editor and trigger the call to
555 // handle_command_mode.
555 // handle_command_mode.
556 cell.focus_cell();
556 cell.focus_cell();
557 }
557 }
558 };
558 };
559
559
560 /**
560 /**
561 * Handle when a cell fires it's edit_mode event.
561 * Handle when a cell fires it's edit_mode event.
562 *
562 *
563 * @method handle_edit_mode
563 * @method handle_edit_mode
564 * @param [cell] {Cell} Cell to enter edit mode on.
564 * @param [cell] {Cell} Cell to enter edit mode on.
565 **/
565 **/
566 Notebook.prototype.handle_edit_mode = function (cell) {
566 Notebook.prototype.handle_edit_mode = function (cell) {
567 if (cell && this.mode !== 'edit') {
567 if (cell && this.mode !== 'edit') {
568 cell.edit_mode();
568 cell.edit_mode();
569 this.mode = 'edit';
569 this.mode = 'edit';
570 $([IPython.events]).trigger('edit_mode.Notebook');
570 $([IPython.events]).trigger('edit_mode.Notebook');
571 IPython.keyboard_manager.edit_mode();
571 IPython.keyboard_manager.edit_mode();
572 }
572 }
573 };
573 };
574
574
575 /**
575 /**
576 * Make a cell enter edit mode.
576 * Make a cell enter edit mode.
577 *
577 *
578 * @method edit_mode
578 * @method edit_mode
579 **/
579 **/
580 Notebook.prototype.edit_mode = function () {
580 Notebook.prototype.edit_mode = function () {
581 var cell = this.get_selected_cell();
581 var cell = this.get_selected_cell();
582 if (cell && this.mode !== 'edit') {
582 if (cell && this.mode !== 'edit') {
583 cell.unrender();
583 cell.unrender();
584 cell.focus_editor();
584 cell.focus_editor();
585 }
585 }
586 };
586 };
587
587
588 /**
588 /**
589 * Focus the currently selected cell.
589 * Focus the currently selected cell.
590 *
590 *
591 * @method focus_cell
591 * @method focus_cell
592 **/
592 **/
593 Notebook.prototype.focus_cell = function () {
593 Notebook.prototype.focus_cell = function () {
594 var cell = this.get_selected_cell();
594 var cell = this.get_selected_cell();
595 if (cell === null) {return;} // No cell is selected
595 if (cell === null) {return;} // No cell is selected
596 cell.focus_cell();
596 cell.focus_cell();
597 };
597 };
598
598
599 // Cell movement
599 // Cell movement
600
600
601 /**
601 /**
602 * Move given (or selected) cell up and select it.
602 * Move given (or selected) cell up and select it.
603 *
603 *
604 * @method move_cell_up
604 * @method move_cell_up
605 * @param [index] {integer} cell index
605 * @param [index] {integer} cell index
606 * @return {Notebook} This notebook
606 * @return {Notebook} This notebook
607 **/
607 **/
608 Notebook.prototype.move_cell_up = function (index) {
608 Notebook.prototype.move_cell_up = function (index) {
609 var i = this.index_or_selected(index);
609 var i = this.index_or_selected(index);
610 if (this.is_valid_cell_index(i) && i > 0) {
610 if (this.is_valid_cell_index(i) && i > 0) {
611 var pivot = this.get_cell_element(i-1);
611 var pivot = this.get_cell_element(i-1);
612 var tomove = this.get_cell_element(i);
612 var tomove = this.get_cell_element(i);
613 if (pivot !== null && tomove !== null) {
613 if (pivot !== null && tomove !== null) {
614 tomove.detach();
614 tomove.detach();
615 pivot.before(tomove);
615 pivot.before(tomove);
616 this.select(i-1);
616 this.select(i-1);
617 var cell = this.get_selected_cell();
617 var cell = this.get_selected_cell();
618 cell.focus_cell();
618 cell.focus_cell();
619 }
619 }
620 this.set_dirty(true);
620 this.set_dirty(true);
621 }
621 }
622 return this;
622 return this;
623 };
623 };
624
624
625
625
626 /**
626 /**
627 * Move given (or selected) cell down and select it
627 * Move given (or selected) cell down and select it
628 *
628 *
629 * @method move_cell_down
629 * @method move_cell_down
630 * @param [index] {integer} cell index
630 * @param [index] {integer} cell index
631 * @return {Notebook} This notebook
631 * @return {Notebook} This notebook
632 **/
632 **/
633 Notebook.prototype.move_cell_down = function (index) {
633 Notebook.prototype.move_cell_down = function (index) {
634 var i = this.index_or_selected(index);
634 var i = this.index_or_selected(index);
635 if (this.is_valid_cell_index(i) && this.is_valid_cell_index(i+1)) {
635 if (this.is_valid_cell_index(i) && this.is_valid_cell_index(i+1)) {
636 var pivot = this.get_cell_element(i+1);
636 var pivot = this.get_cell_element(i+1);
637 var tomove = this.get_cell_element(i);
637 var tomove = this.get_cell_element(i);
638 if (pivot !== null && tomove !== null) {
638 if (pivot !== null && tomove !== null) {
639 tomove.detach();
639 tomove.detach();
640 pivot.after(tomove);
640 pivot.after(tomove);
641 this.select(i+1);
641 this.select(i+1);
642 var cell = this.get_selected_cell();
642 var cell = this.get_selected_cell();
643 cell.focus_cell();
643 cell.focus_cell();
644 }
644 }
645 }
645 }
646 this.set_dirty();
646 this.set_dirty();
647 return this;
647 return this;
648 };
648 };
649
649
650
650
651 // Insertion, deletion.
651 // Insertion, deletion.
652
652
653 /**
653 /**
654 * Delete a cell from the notebook.
654 * Delete a cell from the notebook.
655 *
655 *
656 * @method delete_cell
656 * @method delete_cell
657 * @param [index] A cell's numeric index
657 * @param [index] A cell's numeric index
658 * @return {Notebook} This notebook
658 * @return {Notebook} This notebook
659 */
659 */
660 Notebook.prototype.delete_cell = function (index) {
660 Notebook.prototype.delete_cell = function (index) {
661 var i = this.index_or_selected(index);
661 var i = this.index_or_selected(index);
662 var cell = this.get_selected_cell();
662 var cell = this.get_selected_cell();
663 this.undelete_backup = cell.toJSON();
663 this.undelete_backup = cell.toJSON();
664 $('#undelete_cell').removeClass('disabled');
664 $('#undelete_cell').removeClass('disabled');
665 if (this.is_valid_cell_index(i)) {
665 if (this.is_valid_cell_index(i)) {
666 var old_ncells = this.ncells();
666 var old_ncells = this.ncells();
667 var ce = this.get_cell_element(i);
667 var ce = this.get_cell_element(i);
668 ce.remove();
668 ce.remove();
669 if (i === 0) {
669 if (i === 0) {
670 // Always make sure we have at least one cell.
670 // Always make sure we have at least one cell.
671 if (old_ncells === 1) {
671 if (old_ncells === 1) {
672 this.insert_cell_below('code');
672 this.insert_cell_below('code');
673 }
673 }
674 this.select(0);
674 this.select(0);
675 this.undelete_index = 0;
675 this.undelete_index = 0;
676 this.undelete_below = false;
676 this.undelete_below = false;
677 } else if (i === old_ncells-1 && i !== 0) {
677 } else if (i === old_ncells-1 && i !== 0) {
678 this.select(i-1);
678 this.select(i-1);
679 this.undelete_index = i - 1;
679 this.undelete_index = i - 1;
680 this.undelete_below = true;
680 this.undelete_below = true;
681 } else {
681 } else {
682 this.select(i);
682 this.select(i);
683 this.undelete_index = i;
683 this.undelete_index = i;
684 this.undelete_below = false;
684 this.undelete_below = false;
685 }
685 }
686 $([IPython.events]).trigger('delete.Cell', {'cell': cell, 'index': i});
686 $([IPython.events]).trigger('delete.Cell', {'cell': cell, 'index': i});
687 this.set_dirty(true);
687 this.set_dirty(true);
688 }
688 }
689 return this;
689 return this;
690 };
690 };
691
691
692 /**
692 /**
693 * Restore the most recently deleted cell.
693 * Restore the most recently deleted cell.
694 *
694 *
695 * @method undelete
695 * @method undelete
696 */
696 */
697 Notebook.prototype.undelete_cell = function() {
697 Notebook.prototype.undelete_cell = function() {
698 if (this.undelete_backup !== null && this.undelete_index !== null) {
698 if (this.undelete_backup !== null && this.undelete_index !== null) {
699 var current_index = this.get_selected_index();
699 var current_index = this.get_selected_index();
700 if (this.undelete_index < current_index) {
700 if (this.undelete_index < current_index) {
701 current_index = current_index + 1;
701 current_index = current_index + 1;
702 }
702 }
703 if (this.undelete_index >= this.ncells()) {
703 if (this.undelete_index >= this.ncells()) {
704 this.select(this.ncells() - 1);
704 this.select(this.ncells() - 1);
705 }
705 }
706 else {
706 else {
707 this.select(this.undelete_index);
707 this.select(this.undelete_index);
708 }
708 }
709 var cell_data = this.undelete_backup;
709 var cell_data = this.undelete_backup;
710 var new_cell = null;
710 var new_cell = null;
711 if (this.undelete_below) {
711 if (this.undelete_below) {
712 new_cell = this.insert_cell_below(cell_data.cell_type);
712 new_cell = this.insert_cell_below(cell_data.cell_type);
713 } else {
713 } else {
714 new_cell = this.insert_cell_above(cell_data.cell_type);
714 new_cell = this.insert_cell_above(cell_data.cell_type);
715 }
715 }
716 new_cell.fromJSON(cell_data);
716 new_cell.fromJSON(cell_data);
717 if (this.undelete_below) {
717 if (this.undelete_below) {
718 this.select(current_index+1);
718 this.select(current_index+1);
719 } else {
719 } else {
720 this.select(current_index);
720 this.select(current_index);
721 }
721 }
722 this.undelete_backup = null;
722 this.undelete_backup = null;
723 this.undelete_index = null;
723 this.undelete_index = null;
724 }
724 }
725 $('#undelete_cell').addClass('disabled');
725 $('#undelete_cell').addClass('disabled');
726 };
726 };
727
727
728 /**
728 /**
729 * Insert a cell so that after insertion the cell is at given index.
729 * Insert a cell so that after insertion the cell is at given index.
730 *
730 *
731 * Similar to insert_above, but index parameter is mandatory
731 * Similar to insert_above, but index parameter is mandatory
732 *
732 *
733 * Index will be brought back into the accissible range [0,n]
733 * Index will be brought back into the accissible range [0,n]
734 *
734 *
735 * @method insert_cell_at_index
735 * @method insert_cell_at_index
736 * @param type {string} in ['code','markdown','heading']
736 * @param type {string} in ['code','markdown','heading']
737 * @param [index] {int} a valid index where to inser cell
737 * @param [index] {int} a valid index where to inser cell
738 *
738 *
739 * @return cell {cell|null} created cell or null
739 * @return cell {cell|null} created cell or null
740 **/
740 **/
741 Notebook.prototype.insert_cell_at_index = function(type, index){
741 Notebook.prototype.insert_cell_at_index = function(type, index){
742
742
743 var ncells = this.ncells();
743 var ncells = this.ncells();
744 index = Math.min(index,ncells);
744 index = Math.min(index,ncells);
745 index = Math.max(index,0);
745 index = Math.max(index,0);
746 var cell = null;
746 var cell = null;
747
747
748 if (ncells === 0 || this.is_valid_cell_index(index) || index === ncells) {
748 if (ncells === 0 || this.is_valid_cell_index(index) || index === ncells) {
749 if (type === 'code') {
749 if (type === 'code') {
750 cell = new IPython.CodeCell(this.kernel);
750 cell = new IPython.CodeCell(this.kernel);
751 cell.set_input_prompt();
751 cell.set_input_prompt();
752 } else if (type === 'markdown') {
752 } else if (type === 'markdown') {
753 cell = new IPython.MarkdownCell();
753 cell = new IPython.MarkdownCell();
754 } else if (type === 'raw') {
754 } else if (type === 'raw') {
755 cell = new IPython.RawCell();
755 cell = new IPython.RawCell();
756 } else if (type === 'heading') {
756 } else if (type === 'heading') {
757 cell = new IPython.HeadingCell();
757 cell = new IPython.HeadingCell();
758 }
758 }
759
759
760 if(this._insert_element_at_index(cell.element,index)) {
760 if(this._insert_element_at_index(cell.element,index)) {
761 cell.render();
761 cell.render();
762 $([IPython.events]).trigger('create.Cell', {'cell': cell, 'index': index});
762 $([IPython.events]).trigger('create.Cell', {'cell': cell, 'index': index});
763 cell.refresh();
763 cell.refresh();
764 // We used to select the cell after we refresh it, but there
764 // We used to select the cell after we refresh it, but there
765 // are now cases were this method is called where select is
765 // are now cases were this method is called where select is
766 // not appropriate. The selection logic should be handled by the
766 // not appropriate. The selection logic should be handled by the
767 // caller of the the top level insert_cell methods.
767 // caller of the the top level insert_cell methods.
768 this.set_dirty(true);
768 this.set_dirty(true);
769 }
769 }
770 }
770 }
771 return cell;
771 return cell;
772
772
773 };
773 };
774
774
775 /**
775 /**
776 * Insert an element at given cell index.
776 * Insert an element at given cell index.
777 *
777 *
778 * @method _insert_element_at_index
778 * @method _insert_element_at_index
779 * @param element {dom element} a cell element
779 * @param element {dom element} a cell element
780 * @param [index] {int} a valid index where to inser cell
780 * @param [index] {int} a valid index where to inser cell
781 * @private
781 * @private
782 *
782 *
783 * return true if everything whent fine.
783 * return true if everything whent fine.
784 **/
784 **/
785 Notebook.prototype._insert_element_at_index = function(element, index){
785 Notebook.prototype._insert_element_at_index = function(element, index){
786 if (element === undefined){
786 if (element === undefined){
787 return false;
787 return false;
788 }
788 }
789
789
790 var ncells = this.ncells();
790 var ncells = this.ncells();
791
791
792 if (ncells === 0) {
792 if (ncells === 0) {
793 // special case append if empty
793 // special case append if empty
794 this.element.find('div.end_space').before(element);
794 this.element.find('div.end_space').before(element);
795 } else if ( ncells === index ) {
795 } else if ( ncells === index ) {
796 // special case append it the end, but not empty
796 // special case append it the end, but not empty
797 this.get_cell_element(index-1).after(element);
797 this.get_cell_element(index-1).after(element);
798 } else if (this.is_valid_cell_index(index)) {
798 } else if (this.is_valid_cell_index(index)) {
799 // otherwise always somewhere to append to
799 // otherwise always somewhere to append to
800 this.get_cell_element(index).before(element);
800 this.get_cell_element(index).before(element);
801 } else {
801 } else {
802 return false;
802 return false;
803 }
803 }
804
804
805 if (this.undelete_index !== null && index <= this.undelete_index) {
805 if (this.undelete_index !== null && index <= this.undelete_index) {
806 this.undelete_index = this.undelete_index + 1;
806 this.undelete_index = this.undelete_index + 1;
807 this.set_dirty(true);
807 this.set_dirty(true);
808 }
808 }
809 return true;
809 return true;
810 };
810 };
811
811
812 /**
812 /**
813 * Insert a cell of given type above given index, or at top
813 * Insert a cell of given type above given index, or at top
814 * of notebook if index smaller than 0.
814 * of notebook if index smaller than 0.
815 *
815 *
816 * default index value is the one of currently selected cell
816 * default index value is the one of currently selected cell
817 *
817 *
818 * @method insert_cell_above
818 * @method insert_cell_above
819 * @param type {string} cell type
819 * @param type {string} cell type
820 * @param [index] {integer}
820 * @param [index] {integer}
821 *
821 *
822 * @return handle to created cell or null
822 * @return handle to created cell or null
823 **/
823 **/
824 Notebook.prototype.insert_cell_above = function (type, index) {
824 Notebook.prototype.insert_cell_above = function (type, index) {
825 index = this.index_or_selected(index);
825 index = this.index_or_selected(index);
826 return this.insert_cell_at_index(type, index);
826 return this.insert_cell_at_index(type, index);
827 };
827 };
828
828
829 /**
829 /**
830 * Insert a cell of given type below given index, or at bottom
830 * Insert a cell of given type below given index, or at bottom
831 * of notebook if index greater thatn number of cell
831 * of notebook if index greater thatn number of cell
832 *
832 *
833 * default index value is the one of currently selected cell
833 * default index value is the one of currently selected cell
834 *
834 *
835 * @method insert_cell_below
835 * @method insert_cell_below
836 * @param type {string} cell type
836 * @param type {string} cell type
837 * @param [index] {integer}
837 * @param [index] {integer}
838 *
838 *
839 * @return handle to created cell or null
839 * @return handle to created cell or null
840 *
840 *
841 **/
841 **/
842 Notebook.prototype.insert_cell_below = function (type, index) {
842 Notebook.prototype.insert_cell_below = function (type, index) {
843 index = this.index_or_selected(index);
843 index = this.index_or_selected(index);
844 return this.insert_cell_at_index(type, index+1);
844 return this.insert_cell_at_index(type, index+1);
845 };
845 };
846
846
847
847
848 /**
848 /**
849 * Insert cell at end of notebook
849 * Insert cell at end of notebook
850 *
850 *
851 * @method insert_cell_at_bottom
851 * @method insert_cell_at_bottom
852 * @param {String} type cell type
852 * @param {String} type cell type
853 *
853 *
854 * @return the added cell; or null
854 * @return the added cell; or null
855 **/
855 **/
856 Notebook.prototype.insert_cell_at_bottom = function (type){
856 Notebook.prototype.insert_cell_at_bottom = function (type){
857 var len = this.ncells();
857 var len = this.ncells();
858 return this.insert_cell_below(type,len-1);
858 return this.insert_cell_below(type,len-1);
859 };
859 };
860
860
861 /**
861 /**
862 * Turn a cell into a code cell.
862 * Turn a cell into a code cell.
863 *
863 *
864 * @method to_code
864 * @method to_code
865 * @param {Number} [index] A cell's index
865 * @param {Number} [index] A cell's index
866 */
866 */
867 Notebook.prototype.to_code = function (index) {
867 Notebook.prototype.to_code = function (index) {
868 var i = this.index_or_selected(index);
868 var i = this.index_or_selected(index);
869 if (this.is_valid_cell_index(i)) {
869 if (this.is_valid_cell_index(i)) {
870 var source_element = this.get_cell_element(i);
870 var source_element = this.get_cell_element(i);
871 var source_cell = source_element.data("cell");
871 var source_cell = source_element.data("cell");
872 if (!(source_cell instanceof IPython.CodeCell)) {
872 if (!(source_cell instanceof IPython.CodeCell)) {
873 var target_cell = this.insert_cell_below('code',i);
873 var target_cell = this.insert_cell_below('code',i);
874 var text = source_cell.get_text();
874 var text = source_cell.get_text();
875 if (text === source_cell.placeholder) {
875 if (text === source_cell.placeholder) {
876 text = '';
876 text = '';
877 }
877 }
878 target_cell.set_text(text);
878 target_cell.set_text(text);
879 // make this value the starting point, so that we can only undo
879 // make this value the starting point, so that we can only undo
880 // to this state, instead of a blank cell
880 // to this state, instead of a blank cell
881 target_cell.code_mirror.clearHistory();
881 target_cell.code_mirror.clearHistory();
882 source_element.remove();
882 source_element.remove();
883 this.select(i);
883 this.select(i);
884 this.set_dirty(true);
884 this.set_dirty(true);
885 }
885 }
886 }
886 }
887 };
887 };
888
888
889 /**
889 /**
890 * Turn a cell into a Markdown cell.
890 * Turn a cell into a Markdown cell.
891 *
891 *
892 * @method to_markdown
892 * @method to_markdown
893 * @param {Number} [index] A cell's index
893 * @param {Number} [index] A cell's index
894 */
894 */
895 Notebook.prototype.to_markdown = function (index) {
895 Notebook.prototype.to_markdown = function (index) {
896 var i = this.index_or_selected(index);
896 var i = this.index_or_selected(index);
897 if (this.is_valid_cell_index(i)) {
897 if (this.is_valid_cell_index(i)) {
898 var source_element = this.get_cell_element(i);
898 var source_element = this.get_cell_element(i);
899 var source_cell = source_element.data("cell");
899 var source_cell = source_element.data("cell");
900 if (!(source_cell instanceof IPython.MarkdownCell)) {
900 if (!(source_cell instanceof IPython.MarkdownCell)) {
901 var target_cell = this.insert_cell_below('markdown',i);
901 var target_cell = this.insert_cell_below('markdown',i);
902 var text = source_cell.get_text();
902 var text = source_cell.get_text();
903 if (text === source_cell.placeholder) {
903 if (text === source_cell.placeholder) {
904 text = '';
904 text = '';
905 }
905 }
906 // We must show the editor before setting its contents
906 // We must show the editor before setting its contents
907 target_cell.unrender();
907 target_cell.unrender();
908 target_cell.set_text(text);
908 target_cell.set_text(text);
909 // make this value the starting point, so that we can only undo
909 // make this value the starting point, so that we can only undo
910 // to this state, instead of a blank cell
910 // to this state, instead of a blank cell
911 target_cell.code_mirror.clearHistory();
911 target_cell.code_mirror.clearHistory();
912 source_element.remove();
912 source_element.remove();
913 this.select(i);
913 this.select(i);
914 if ((source_cell instanceof IPython.TextCell) && source_cell.rendered) {
914 if ((source_cell instanceof IPython.TextCell) && source_cell.rendered) {
915 target_cell.render();
915 target_cell.render();
916 }
916 }
917 this.set_dirty(true);
917 this.set_dirty(true);
918 }
918 }
919 }
919 }
920 };
920 };
921
921
922 /**
922 /**
923 * Turn a cell into a raw text cell.
923 * Turn a cell into a raw text cell.
924 *
924 *
925 * @method to_raw
925 * @method to_raw
926 * @param {Number} [index] A cell's index
926 * @param {Number} [index] A cell's index
927 */
927 */
928 Notebook.prototype.to_raw = function (index) {
928 Notebook.prototype.to_raw = function (index) {
929 var i = this.index_or_selected(index);
929 var i = this.index_or_selected(index);
930 if (this.is_valid_cell_index(i)) {
930 if (this.is_valid_cell_index(i)) {
931 var source_element = this.get_cell_element(i);
931 var source_element = this.get_cell_element(i);
932 var source_cell = source_element.data("cell");
932 var source_cell = source_element.data("cell");
933 var target_cell = null;
933 var target_cell = null;
934 if (!(source_cell instanceof IPython.RawCell)) {
934 if (!(source_cell instanceof IPython.RawCell)) {
935 target_cell = this.insert_cell_below('raw',i);
935 target_cell = this.insert_cell_below('raw',i);
936 var text = source_cell.get_text();
936 var text = source_cell.get_text();
937 if (text === source_cell.placeholder) {
937 if (text === source_cell.placeholder) {
938 text = '';
938 text = '';
939 }
939 }
940 // We must show the editor before setting its contents
940 // We must show the editor before setting its contents
941 target_cell.unrender();
941 target_cell.unrender();
942 target_cell.set_text(text);
942 target_cell.set_text(text);
943 // make this value the starting point, so that we can only undo
943 // make this value the starting point, so that we can only undo
944 // to this state, instead of a blank cell
944 // to this state, instead of a blank cell
945 target_cell.code_mirror.clearHistory();
945 target_cell.code_mirror.clearHistory();
946 source_element.remove();
946 source_element.remove();
947 this.select(i);
947 this.select(i);
948 this.set_dirty(true);
948 this.set_dirty(true);
949 }
949 }
950 }
950 }
951 };
951 };
952
952
953 /**
953 /**
954 * Turn a cell into a heading cell.
954 * Turn a cell into a heading cell.
955 *
955 *
956 * @method to_heading
956 * @method to_heading
957 * @param {Number} [index] A cell's index
957 * @param {Number} [index] A cell's index
958 * @param {Number} [level] A heading level (e.g., 1 becomes &lt;h1&gt;)
958 * @param {Number} [level] A heading level (e.g., 1 becomes &lt;h1&gt;)
959 */
959 */
960 Notebook.prototype.to_heading = function (index, level) {
960 Notebook.prototype.to_heading = function (index, level) {
961 level = level || 1;
961 level = level || 1;
962 var i = this.index_or_selected(index);
962 var i = this.index_or_selected(index);
963 if (this.is_valid_cell_index(i)) {
963 if (this.is_valid_cell_index(i)) {
964 var source_element = this.get_cell_element(i);
964 var source_element = this.get_cell_element(i);
965 var source_cell = source_element.data("cell");
965 var source_cell = source_element.data("cell");
966 var target_cell = null;
966 var target_cell = null;
967 if (source_cell instanceof IPython.HeadingCell) {
967 if (source_cell instanceof IPython.HeadingCell) {
968 source_cell.set_level(level);
968 source_cell.set_level(level);
969 } else {
969 } else {
970 target_cell = this.insert_cell_below('heading',i);
970 target_cell = this.insert_cell_below('heading',i);
971 var text = source_cell.get_text();
971 var text = source_cell.get_text();
972 if (text === source_cell.placeholder) {
972 if (text === source_cell.placeholder) {
973 text = '';
973 text = '';
974 }
974 }
975 // We must show the editor before setting its contents
975 // We must show the editor before setting its contents
976 target_cell.set_level(level);
976 target_cell.set_level(level);
977 target_cell.unrender();
977 target_cell.unrender();
978 target_cell.set_text(text);
978 target_cell.set_text(text);
979 // make this value the starting point, so that we can only undo
979 // make this value the starting point, so that we can only undo
980 // to this state, instead of a blank cell
980 // to this state, instead of a blank cell
981 target_cell.code_mirror.clearHistory();
981 target_cell.code_mirror.clearHistory();
982 source_element.remove();
982 source_element.remove();
983 this.select(i);
983 this.select(i);
984 if ((source_cell instanceof IPython.TextCell) && source_cell.rendered) {
984 if ((source_cell instanceof IPython.TextCell) && source_cell.rendered) {
985 target_cell.render();
985 target_cell.render();
986 }
986 }
987 }
987 }
988 this.set_dirty(true);
988 this.set_dirty(true);
989 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
989 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
990 {'cell_type':'heading',level:level}
990 {'cell_type':'heading',level:level}
991 );
991 );
992 }
992 }
993 };
993 };
994
994
995
995
996 // Cut/Copy/Paste
996 // Cut/Copy/Paste
997
997
998 /**
998 /**
999 * Enable UI elements for pasting cells.
999 * Enable UI elements for pasting cells.
1000 *
1000 *
1001 * @method enable_paste
1001 * @method enable_paste
1002 */
1002 */
1003 Notebook.prototype.enable_paste = function () {
1003 Notebook.prototype.enable_paste = function () {
1004 var that = this;
1004 var that = this;
1005 if (!this.paste_enabled) {
1005 if (!this.paste_enabled) {
1006 $('#paste_cell_replace').removeClass('disabled')
1006 $('#paste_cell_replace').removeClass('disabled')
1007 .on('click', function () {that.paste_cell_replace();});
1007 .on('click', function () {that.paste_cell_replace();});
1008 $('#paste_cell_above').removeClass('disabled')
1008 $('#paste_cell_above').removeClass('disabled')
1009 .on('click', function () {that.paste_cell_above();});
1009 .on('click', function () {that.paste_cell_above();});
1010 $('#paste_cell_below').removeClass('disabled')
1010 $('#paste_cell_below').removeClass('disabled')
1011 .on('click', function () {that.paste_cell_below();});
1011 .on('click', function () {that.paste_cell_below();});
1012 this.paste_enabled = true;
1012 this.paste_enabled = true;
1013 }
1013 }
1014 };
1014 };
1015
1015
1016 /**
1016 /**
1017 * Disable UI elements for pasting cells.
1017 * Disable UI elements for pasting cells.
1018 *
1018 *
1019 * @method disable_paste
1019 * @method disable_paste
1020 */
1020 */
1021 Notebook.prototype.disable_paste = function () {
1021 Notebook.prototype.disable_paste = function () {
1022 if (this.paste_enabled) {
1022 if (this.paste_enabled) {
1023 $('#paste_cell_replace').addClass('disabled').off('click');
1023 $('#paste_cell_replace').addClass('disabled').off('click');
1024 $('#paste_cell_above').addClass('disabled').off('click');
1024 $('#paste_cell_above').addClass('disabled').off('click');
1025 $('#paste_cell_below').addClass('disabled').off('click');
1025 $('#paste_cell_below').addClass('disabled').off('click');
1026 this.paste_enabled = false;
1026 this.paste_enabled = false;
1027 }
1027 }
1028 };
1028 };
1029
1029
1030 /**
1030 /**
1031 * Cut a cell.
1031 * Cut a cell.
1032 *
1032 *
1033 * @method cut_cell
1033 * @method cut_cell
1034 */
1034 */
1035 Notebook.prototype.cut_cell = function () {
1035 Notebook.prototype.cut_cell = function () {
1036 this.copy_cell();
1036 this.copy_cell();
1037 this.delete_cell();
1037 this.delete_cell();
1038 };
1038 };
1039
1039
1040 /**
1040 /**
1041 * Copy a cell.
1041 * Copy a cell.
1042 *
1042 *
1043 * @method copy_cell
1043 * @method copy_cell
1044 */
1044 */
1045 Notebook.prototype.copy_cell = function () {
1045 Notebook.prototype.copy_cell = function () {
1046 var cell = this.get_selected_cell();
1046 var cell = this.get_selected_cell();
1047 this.clipboard = cell.toJSON();
1047 this.clipboard = cell.toJSON();
1048 this.enable_paste();
1048 this.enable_paste();
1049 };
1049 };
1050
1050
1051 /**
1051 /**
1052 * Replace the selected cell with a cell in the clipboard.
1052 * Replace the selected cell with a cell in the clipboard.
1053 *
1053 *
1054 * @method paste_cell_replace
1054 * @method paste_cell_replace
1055 */
1055 */
1056 Notebook.prototype.paste_cell_replace = function () {
1056 Notebook.prototype.paste_cell_replace = function () {
1057 if (this.clipboard !== null && this.paste_enabled) {
1057 if (this.clipboard !== null && this.paste_enabled) {
1058 var cell_data = this.clipboard;
1058 var cell_data = this.clipboard;
1059 var new_cell = this.insert_cell_above(cell_data.cell_type);
1059 var new_cell = this.insert_cell_above(cell_data.cell_type);
1060 new_cell.fromJSON(cell_data);
1060 new_cell.fromJSON(cell_data);
1061 var old_cell = this.get_next_cell(new_cell);
1061 var old_cell = this.get_next_cell(new_cell);
1062 this.delete_cell(this.find_cell_index(old_cell));
1062 this.delete_cell(this.find_cell_index(old_cell));
1063 this.select(this.find_cell_index(new_cell));
1063 this.select(this.find_cell_index(new_cell));
1064 }
1064 }
1065 };
1065 };
1066
1066
1067 /**
1067 /**
1068 * Paste a cell from the clipboard above the selected cell.
1068 * Paste a cell from the clipboard above the selected cell.
1069 *
1069 *
1070 * @method paste_cell_above
1070 * @method paste_cell_above
1071 */
1071 */
1072 Notebook.prototype.paste_cell_above = function () {
1072 Notebook.prototype.paste_cell_above = function () {
1073 if (this.clipboard !== null && this.paste_enabled) {
1073 if (this.clipboard !== null && this.paste_enabled) {
1074 var cell_data = this.clipboard;
1074 var cell_data = this.clipboard;
1075 var new_cell = this.insert_cell_above(cell_data.cell_type);
1075 var new_cell = this.insert_cell_above(cell_data.cell_type);
1076 new_cell.fromJSON(cell_data);
1076 new_cell.fromJSON(cell_data);
1077 new_cell.focus_cell();
1077 new_cell.focus_cell();
1078 }
1078 }
1079 };
1079 };
1080
1080
1081 /**
1081 /**
1082 * Paste a cell from the clipboard below the selected cell.
1082 * Paste a cell from the clipboard below the selected cell.
1083 *
1083 *
1084 * @method paste_cell_below
1084 * @method paste_cell_below
1085 */
1085 */
1086 Notebook.prototype.paste_cell_below = function () {
1086 Notebook.prototype.paste_cell_below = function () {
1087 if (this.clipboard !== null && this.paste_enabled) {
1087 if (this.clipboard !== null && this.paste_enabled) {
1088 var cell_data = this.clipboard;
1088 var cell_data = this.clipboard;
1089 var new_cell = this.insert_cell_below(cell_data.cell_type);
1089 var new_cell = this.insert_cell_below(cell_data.cell_type);
1090 new_cell.fromJSON(cell_data);
1090 new_cell.fromJSON(cell_data);
1091 new_cell.focus_cell();
1091 new_cell.focus_cell();
1092 }
1092 }
1093 };
1093 };
1094
1094
1095 // Split/merge
1095 // Split/merge
1096
1096
1097 /**
1097 /**
1098 * Split the selected cell into two, at the cursor.
1098 * Split the selected cell into two, at the cursor.
1099 *
1099 *
1100 * @method split_cell
1100 * @method split_cell
1101 */
1101 */
1102 Notebook.prototype.split_cell = function () {
1102 Notebook.prototype.split_cell = function () {
1103 var mdc = IPython.MarkdownCell;
1103 var mdc = IPython.MarkdownCell;
1104 var rc = IPython.RawCell;
1104 var rc = IPython.RawCell;
1105 var cell = this.get_selected_cell();
1105 var cell = this.get_selected_cell();
1106 if (cell.is_splittable()) {
1106 if (cell.is_splittable()) {
1107 var texta = cell.get_pre_cursor();
1107 var texta = cell.get_pre_cursor();
1108 var textb = cell.get_post_cursor();
1108 var textb = cell.get_post_cursor();
1109 if (cell instanceof IPython.CodeCell) {
1109 if (cell instanceof IPython.CodeCell) {
1110 // In this case the operations keep the notebook in its existing mode
1110 // In this case the operations keep the notebook in its existing mode
1111 // so we don't need to do any post-op mode changes.
1111 // so we don't need to do any post-op mode changes.
1112 cell.set_text(textb);
1112 cell.set_text(textb);
1113 var new_cell = this.insert_cell_above('code');
1113 var new_cell = this.insert_cell_above('code');
1114 new_cell.set_text(texta);
1114 new_cell.set_text(texta);
1115 } else if ((cell instanceof mdc && !cell.rendered) || (cell instanceof rc)) {
1115 } else if ((cell instanceof mdc && !cell.rendered) || (cell instanceof rc)) {
1116 // We know cell is !rendered so we can use set_text.
1116 // We know cell is !rendered so we can use set_text.
1117 cell.set_text(textb);
1117 cell.set_text(textb);
1118 var new_cell = this.insert_cell_above(cell.cell_type);
1118 var new_cell = this.insert_cell_above(cell.cell_type);
1119 // Unrender the new cell so we can call set_text.
1119 // Unrender the new cell so we can call set_text.
1120 new_cell.unrender();
1120 new_cell.unrender();
1121 new_cell.set_text(texta);
1121 new_cell.set_text(texta);
1122 }
1122 }
1123 }
1123 }
1124 };
1124 };
1125
1125
1126 /**
1126 /**
1127 * Combine the selected cell into the cell above it.
1127 * Combine the selected cell into the cell above it.
1128 *
1128 *
1129 * @method merge_cell_above
1129 * @method merge_cell_above
1130 */
1130 */
1131 Notebook.prototype.merge_cell_above = function () {
1131 Notebook.prototype.merge_cell_above = function () {
1132 var mdc = IPython.MarkdownCell;
1132 var mdc = IPython.MarkdownCell;
1133 var rc = IPython.RawCell;
1133 var rc = IPython.RawCell;
1134 var index = this.get_selected_index();
1134 var index = this.get_selected_index();
1135 var cell = this.get_cell(index);
1135 var cell = this.get_cell(index);
1136 var render = cell.rendered;
1136 var render = cell.rendered;
1137 if (!cell.is_mergeable()) {
1137 if (!cell.is_mergeable()) {
1138 return;
1138 return;
1139 }
1139 }
1140 if (index > 0) {
1140 if (index > 0) {
1141 var upper_cell = this.get_cell(index-1);
1141 var upper_cell = this.get_cell(index-1);
1142 if (!upper_cell.is_mergeable()) {
1142 if (!upper_cell.is_mergeable()) {
1143 return;
1143 return;
1144 }
1144 }
1145 var upper_text = upper_cell.get_text();
1145 var upper_text = upper_cell.get_text();
1146 var text = cell.get_text();
1146 var text = cell.get_text();
1147 if (cell instanceof IPython.CodeCell) {
1147 if (cell instanceof IPython.CodeCell) {
1148 cell.set_text(upper_text+'\n'+text);
1148 cell.set_text(upper_text+'\n'+text);
1149 } else if ((cell instanceof mdc) || (cell instanceof rc)) {
1149 } else if ((cell instanceof mdc) || (cell instanceof rc)) {
1150 cell.unrender(); // Must unrender before we set_text.
1150 cell.unrender(); // Must unrender before we set_text.
1151 cell.set_text(upper_text+'\n\n'+text);
1151 cell.set_text(upper_text+'\n\n'+text);
1152 if (render) {
1152 if (render) {
1153 // The rendered state of the final cell should match
1153 // The rendered state of the final cell should match
1154 // that of the original selected cell;
1154 // that of the original selected cell;
1155 cell.render();
1155 cell.render();
1156 }
1156 }
1157 }
1157 }
1158 this.delete_cell(index-1);
1158 this.delete_cell(index-1);
1159 this.select(this.find_cell_index(cell));
1159 this.select(this.find_cell_index(cell));
1160 }
1160 }
1161 };
1161 };
1162
1162
1163 /**
1163 /**
1164 * Combine the selected cell into the cell below it.
1164 * Combine the selected cell into the cell below it.
1165 *
1165 *
1166 * @method merge_cell_below
1166 * @method merge_cell_below
1167 */
1167 */
1168 Notebook.prototype.merge_cell_below = function () {
1168 Notebook.prototype.merge_cell_below = function () {
1169 var mdc = IPython.MarkdownCell;
1169 var mdc = IPython.MarkdownCell;
1170 var rc = IPython.RawCell;
1170 var rc = IPython.RawCell;
1171 var index = this.get_selected_index();
1171 var index = this.get_selected_index();
1172 var cell = this.get_cell(index);
1172 var cell = this.get_cell(index);
1173 var render = cell.rendered;
1173 var render = cell.rendered;
1174 if (!cell.is_mergeable()) {
1174 if (!cell.is_mergeable()) {
1175 return;
1175 return;
1176 }
1176 }
1177 if (index < this.ncells()-1) {
1177 if (index < this.ncells()-1) {
1178 var lower_cell = this.get_cell(index+1);
1178 var lower_cell = this.get_cell(index+1);
1179 if (!lower_cell.is_mergeable()) {
1179 if (!lower_cell.is_mergeable()) {
1180 return;
1180 return;
1181 }
1181 }
1182 var lower_text = lower_cell.get_text();
1182 var lower_text = lower_cell.get_text();
1183 var text = cell.get_text();
1183 var text = cell.get_text();
1184 if (cell instanceof IPython.CodeCell) {
1184 if (cell instanceof IPython.CodeCell) {
1185 cell.set_text(text+'\n'+lower_text);
1185 cell.set_text(text+'\n'+lower_text);
1186 } else if ((cell instanceof mdc) || (cell instanceof rc)) {
1186 } else if ((cell instanceof mdc) || (cell instanceof rc)) {
1187 cell.unrender(); // Must unrender before we set_text.
1187 cell.unrender(); // Must unrender before we set_text.
1188 cell.set_text(text+'\n\n'+lower_text);
1188 cell.set_text(text+'\n\n'+lower_text);
1189 if (render) {
1189 if (render) {
1190 // The rendered state of the final cell should match
1190 // The rendered state of the final cell should match
1191 // that of the original selected cell;
1191 // that of the original selected cell;
1192 cell.render();
1192 cell.render();
1193 }
1193 }
1194 }
1194 }
1195 this.delete_cell(index+1);
1195 this.delete_cell(index+1);
1196 this.select(this.find_cell_index(cell));
1196 this.select(this.find_cell_index(cell));
1197 }
1197 }
1198 };
1198 };
1199
1199
1200
1200
1201 // Cell collapsing and output clearing
1201 // Cell collapsing and output clearing
1202
1202
1203 /**
1203 /**
1204 * Hide a cell's output.
1204 * Hide a cell's output.
1205 *
1205 *
1206 * @method collapse_output
1206 * @method collapse_output
1207 * @param {Number} index A cell's numeric index
1207 * @param {Number} index A cell's numeric index
1208 */
1208 */
1209 Notebook.prototype.collapse_output = function (index) {
1209 Notebook.prototype.collapse_output = function (index) {
1210 var i = this.index_or_selected(index);
1210 var i = this.index_or_selected(index);
1211 var cell = this.get_cell(i);
1211 var cell = this.get_cell(i);
1212 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1212 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1213 cell.collapse_output();
1213 cell.collapse_output();
1214 this.set_dirty(true);
1214 this.set_dirty(true);
1215 }
1215 }
1216 };
1216 };
1217
1217
1218 /**
1218 /**
1219 * Hide each code cell's output area.
1219 * Hide each code cell's output area.
1220 *
1220 *
1221 * @method collapse_all_output
1221 * @method collapse_all_output
1222 */
1222 */
1223 Notebook.prototype.collapse_all_output = function () {
1223 Notebook.prototype.collapse_all_output = function () {
1224 $.map(this.get_cells(), function (cell, i) {
1224 $.map(this.get_cells(), function (cell, i) {
1225 if (cell instanceof IPython.CodeCell) {
1225 if (cell instanceof IPython.CodeCell) {
1226 cell.collapse_output();
1226 cell.collapse_output();
1227 }
1227 }
1228 });
1228 });
1229 // this should not be set if the `collapse` key is removed from nbformat
1229 // this should not be set if the `collapse` key is removed from nbformat
1230 this.set_dirty(true);
1230 this.set_dirty(true);
1231 };
1231 };
1232
1232
1233 /**
1233 /**
1234 * Show a cell's output.
1234 * Show a cell's output.
1235 *
1235 *
1236 * @method expand_output
1236 * @method expand_output
1237 * @param {Number} index A cell's numeric index
1237 * @param {Number} index A cell's numeric index
1238 */
1238 */
1239 Notebook.prototype.expand_output = function (index) {
1239 Notebook.prototype.expand_output = function (index) {
1240 var i = this.index_or_selected(index);
1240 var i = this.index_or_selected(index);
1241 var cell = this.get_cell(i);
1241 var cell = this.get_cell(i);
1242 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1242 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1243 cell.expand_output();
1243 cell.expand_output();
1244 this.set_dirty(true);
1244 this.set_dirty(true);
1245 }
1245 }
1246 };
1246 };
1247
1247
1248 /**
1248 /**
1249 * Expand each code cell's output area, and remove scrollbars.
1249 * Expand each code cell's output area, and remove scrollbars.
1250 *
1250 *
1251 * @method expand_all_output
1251 * @method expand_all_output
1252 */
1252 */
1253 Notebook.prototype.expand_all_output = function () {
1253 Notebook.prototype.expand_all_output = function () {
1254 $.map(this.get_cells(), function (cell, i) {
1254 $.map(this.get_cells(), function (cell, i) {
1255 if (cell instanceof IPython.CodeCell) {
1255 if (cell instanceof IPython.CodeCell) {
1256 cell.expand_output();
1256 cell.expand_output();
1257 }
1257 }
1258 });
1258 });
1259 // this should not be set if the `collapse` key is removed from nbformat
1259 // this should not be set if the `collapse` key is removed from nbformat
1260 this.set_dirty(true);
1260 this.set_dirty(true);
1261 };
1261 };
1262
1262
1263 /**
1263 /**
1264 * Clear the selected CodeCell's output area.
1264 * Clear the selected CodeCell's output area.
1265 *
1265 *
1266 * @method clear_output
1266 * @method clear_output
1267 * @param {Number} index A cell's numeric index
1267 * @param {Number} index A cell's numeric index
1268 */
1268 */
1269 Notebook.prototype.clear_output = function (index) {
1269 Notebook.prototype.clear_output = function (index) {
1270 var i = this.index_or_selected(index);
1270 var i = this.index_or_selected(index);
1271 var cell = this.get_cell(i);
1271 var cell = this.get_cell(i);
1272 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1272 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1273 cell.clear_output();
1273 cell.clear_output();
1274 this.set_dirty(true);
1274 this.set_dirty(true);
1275 }
1275 }
1276 };
1276 };
1277
1277
1278 /**
1278 /**
1279 * Clear each code cell's output area.
1279 * Clear each code cell's output area.
1280 *
1280 *
1281 * @method clear_all_output
1281 * @method clear_all_output
1282 */
1282 */
1283 Notebook.prototype.clear_all_output = function () {
1283 Notebook.prototype.clear_all_output = function () {
1284 $.map(this.get_cells(), function (cell, i) {
1284 $.map(this.get_cells(), function (cell, i) {
1285 if (cell instanceof IPython.CodeCell) {
1285 if (cell instanceof IPython.CodeCell) {
1286 cell.clear_output();
1286 cell.clear_output();
1287 }
1287 }
1288 });
1288 });
1289 this.set_dirty(true);
1289 this.set_dirty(true);
1290 };
1290 };
1291
1291
1292 /**
1292 /**
1293 * Scroll the selected CodeCell's output area.
1293 * Scroll the selected CodeCell's output area.
1294 *
1294 *
1295 * @method scroll_output
1295 * @method scroll_output
1296 * @param {Number} index A cell's numeric index
1296 * @param {Number} index A cell's numeric index
1297 */
1297 */
1298 Notebook.prototype.scroll_output = function (index) {
1298 Notebook.prototype.scroll_output = function (index) {
1299 var i = this.index_or_selected(index);
1299 var i = this.index_or_selected(index);
1300 var cell = this.get_cell(i);
1300 var cell = this.get_cell(i);
1301 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1301 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1302 cell.scroll_output();
1302 cell.scroll_output();
1303 this.set_dirty(true);
1303 this.set_dirty(true);
1304 }
1304 }
1305 };
1305 };
1306
1306
1307 /**
1307 /**
1308 * Expand each code cell's output area, and add a scrollbar for long output.
1308 * Expand each code cell's output area, and add a scrollbar for long output.
1309 *
1309 *
1310 * @method scroll_all_output
1310 * @method scroll_all_output
1311 */
1311 */
1312 Notebook.prototype.scroll_all_output = function () {
1312 Notebook.prototype.scroll_all_output = function () {
1313 $.map(this.get_cells(), function (cell, i) {
1313 $.map(this.get_cells(), function (cell, i) {
1314 if (cell instanceof IPython.CodeCell) {
1314 if (cell instanceof IPython.CodeCell) {
1315 cell.scroll_output();
1315 cell.scroll_output();
1316 }
1316 }
1317 });
1317 });
1318 // this should not be set if the `collapse` key is removed from nbformat
1318 // this should not be set if the `collapse` key is removed from nbformat
1319 this.set_dirty(true);
1319 this.set_dirty(true);
1320 };
1320 };
1321
1321
1322 /** Toggle whether a cell's output is collapsed or expanded.
1322 /** Toggle whether a cell's output is collapsed or expanded.
1323 *
1323 *
1324 * @method toggle_output
1324 * @method toggle_output
1325 * @param {Number} index A cell's numeric index
1325 * @param {Number} index A cell's numeric index
1326 */
1326 */
1327 Notebook.prototype.toggle_output = function (index) {
1327 Notebook.prototype.toggle_output = function (index) {
1328 var i = this.index_or_selected(index);
1328 var i = this.index_or_selected(index);
1329 var cell = this.get_cell(i);
1329 var cell = this.get_cell(i);
1330 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1330 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1331 cell.toggle_output();
1331 cell.toggle_output();
1332 this.set_dirty(true);
1332 this.set_dirty(true);
1333 }
1333 }
1334 };
1334 };
1335
1335
1336 /**
1336 /**
1337 * Hide/show the output of all cells.
1337 * Hide/show the output of all cells.
1338 *
1338 *
1339 * @method toggle_all_output
1339 * @method toggle_all_output
1340 */
1340 */
1341 Notebook.prototype.toggle_all_output = function () {
1341 Notebook.prototype.toggle_all_output = function () {
1342 $.map(this.get_cells(), function (cell, i) {
1342 $.map(this.get_cells(), function (cell, i) {
1343 if (cell instanceof IPython.CodeCell) {
1343 if (cell instanceof IPython.CodeCell) {
1344 cell.toggle_output();
1344 cell.toggle_output();
1345 }
1345 }
1346 });
1346 });
1347 // this should not be set if the `collapse` key is removed from nbformat
1347 // this should not be set if the `collapse` key is removed from nbformat
1348 this.set_dirty(true);
1348 this.set_dirty(true);
1349 };
1349 };
1350
1350
1351 /**
1351 /**
1352 * Toggle a scrollbar for long cell outputs.
1352 * Toggle a scrollbar for long cell outputs.
1353 *
1353 *
1354 * @method toggle_output_scroll
1354 * @method toggle_output_scroll
1355 * @param {Number} index A cell's numeric index
1355 * @param {Number} index A cell's numeric index
1356 */
1356 */
1357 Notebook.prototype.toggle_output_scroll = function (index) {
1357 Notebook.prototype.toggle_output_scroll = function (index) {
1358 var i = this.index_or_selected(index);
1358 var i = this.index_or_selected(index);
1359 var cell = this.get_cell(i);
1359 var cell = this.get_cell(i);
1360 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1360 if (cell !== null && (cell instanceof IPython.CodeCell)) {
1361 cell.toggle_output_scroll();
1361 cell.toggle_output_scroll();
1362 this.set_dirty(true);
1362 this.set_dirty(true);
1363 }
1363 }
1364 };
1364 };
1365
1365
1366 /**
1366 /**
1367 * Toggle the scrolling of long output on all cells.
1367 * Toggle the scrolling of long output on all cells.
1368 *
1368 *
1369 * @method toggle_all_output_scrolling
1369 * @method toggle_all_output_scrolling
1370 */
1370 */
1371 Notebook.prototype.toggle_all_output_scroll = function () {
1371 Notebook.prototype.toggle_all_output_scroll = function () {
1372 $.map(this.get_cells(), function (cell, i) {
1372 $.map(this.get_cells(), function (cell, i) {
1373 if (cell instanceof IPython.CodeCell) {
1373 if (cell instanceof IPython.CodeCell) {
1374 cell.toggle_output_scroll();
1374 cell.toggle_output_scroll();
1375 }
1375 }
1376 });
1376 });
1377 // this should not be set if the `collapse` key is removed from nbformat
1377 // this should not be set if the `collapse` key is removed from nbformat
1378 this.set_dirty(true);
1378 this.set_dirty(true);
1379 };
1379 };
1380
1380
1381 // Other cell functions: line numbers, ...
1381 // Other cell functions: line numbers, ...
1382
1382
1383 /**
1383 /**
1384 * Toggle line numbers in the selected cell's input area.
1384 * Toggle line numbers in the selected cell's input area.
1385 *
1385 *
1386 * @method cell_toggle_line_numbers
1386 * @method cell_toggle_line_numbers
1387 */
1387 */
1388 Notebook.prototype.cell_toggle_line_numbers = function() {
1388 Notebook.prototype.cell_toggle_line_numbers = function() {
1389 this.get_selected_cell().toggle_line_numbers();
1389 this.get_selected_cell().toggle_line_numbers();
1390 };
1390 };
1391
1391
1392 // Session related things
1392 // Session related things
1393
1393
1394 /**
1394 /**
1395 * Start a new session and set it on each code cell.
1395 * Start a new session and set it on each code cell.
1396 *
1396 *
1397 * @method start_session
1397 * @method start_session
1398 */
1398 */
1399 Notebook.prototype.start_session = function () {
1399 Notebook.prototype.start_session = function () {
1400 this.session = new IPython.Session(this, this.options);
1400 this.session = new IPython.Session(this, this.options);
1401 this.session.start($.proxy(this._session_started, this));
1401 this.session.start($.proxy(this._session_started, this));
1402 };
1402 };
1403
1403
1404
1404
1405 /**
1405 /**
1406 * Once a session is started, link the code cells to the kernel and pass the
1406 * Once a session is started, link the code cells to the kernel and pass the
1407 * comm manager to the widget manager
1407 * comm manager to the widget manager
1408 *
1408 *
1409 */
1409 */
1410 Notebook.prototype._session_started = function(){
1410 Notebook.prototype._session_started = function(){
1411 this.kernel = this.session.kernel;
1411 this.kernel = this.session.kernel;
1412 var ncells = this.ncells();
1412 var ncells = this.ncells();
1413 for (var i=0; i<ncells; i++) {
1413 for (var i=0; i<ncells; i++) {
1414 var cell = this.get_cell(i);
1414 var cell = this.get_cell(i);
1415 if (cell instanceof IPython.CodeCell) {
1415 if (cell instanceof IPython.CodeCell) {
1416 cell.set_kernel(this.session.kernel);
1416 cell.set_kernel(this.session.kernel);
1417 }
1417 }
1418 }
1418 }
1419 };
1419 };
1420
1420
1421 /**
1421 /**
1422 * Prompt the user to restart the IPython kernel.
1422 * Prompt the user to restart the IPython kernel.
1423 *
1423 *
1424 * @method restart_kernel
1424 * @method restart_kernel
1425 */
1425 */
1426 Notebook.prototype.restart_kernel = function () {
1426 Notebook.prototype.restart_kernel = function () {
1427 var that = this;
1427 var that = this;
1428 IPython.dialog.modal({
1428 IPython.dialog.modal({
1429 title : "Restart kernel or continue running?",
1429 title : "Restart kernel or continue running?",
1430 body : $("<p/>").text(
1430 body : $("<p/>").text(
1431 'Do you want to restart the current kernel? You will lose all variables defined in it.'
1431 'Do you want to restart the current kernel? You will lose all variables defined in it.'
1432 ),
1432 ),
1433 buttons : {
1433 buttons : {
1434 "Continue running" : {},
1434 "Continue running" : {},
1435 "Restart" : {
1435 "Restart" : {
1436 "class" : "btn-danger",
1436 "class" : "btn-danger",
1437 "click" : function() {
1437 "click" : function() {
1438 that.session.restart_kernel();
1438 that.session.restart_kernel();
1439 }
1439 }
1440 }
1440 }
1441 }
1441 }
1442 });
1442 });
1443 };
1443 };
1444
1444
1445 /**
1445 /**
1446 * Execute or render cell outputs and go into command mode.
1446 * Execute or render cell outputs and go into command mode.
1447 *
1447 *
1448 * @method execute_cell
1448 * @method execute_cell
1449 */
1449 */
1450 Notebook.prototype.execute_cell = function () {
1450 Notebook.prototype.execute_cell = function () {
1451 // mode = shift, ctrl, alt
1451 // mode = shift, ctrl, alt
1452 var cell = this.get_selected_cell();
1452 var cell = this.get_selected_cell();
1453 var cell_index = this.find_cell_index(cell);
1453 var cell_index = this.find_cell_index(cell);
1454
1454
1455 cell.execute();
1455 cell.execute();
1456 this.command_mode();
1456 this.command_mode();
1457 this.set_dirty(true);
1457 this.set_dirty(true);
1458 };
1458 };
1459
1459
1460 /**
1460 /**
1461 * Execute or render cell outputs and insert a new cell below.
1461 * Execute or render cell outputs and insert a new cell below.
1462 *
1462 *
1463 * @method execute_cell_and_insert_below
1463 * @method execute_cell_and_insert_below
1464 */
1464 */
1465 Notebook.prototype.execute_cell_and_insert_below = function () {
1465 Notebook.prototype.execute_cell_and_insert_below = function () {
1466 var cell = this.get_selected_cell();
1466 var cell = this.get_selected_cell();
1467 var cell_index = this.find_cell_index(cell);
1467 var cell_index = this.find_cell_index(cell);
1468
1468
1469 cell.execute();
1469 cell.execute();
1470
1470
1471 // If we are at the end always insert a new cell and return
1471 // If we are at the end always insert a new cell and return
1472 if (cell_index === (this.ncells()-1)) {
1472 if (cell_index === (this.ncells()-1)) {
1473 this.command_mode();
1473 this.command_mode();
1474 this.insert_cell_below('code');
1474 this.insert_cell_below('code');
1475 this.select(cell_index+1);
1475 this.select(cell_index+1);
1476 this.edit_mode();
1476 this.edit_mode();
1477 this.scroll_to_bottom();
1477 this.scroll_to_bottom();
1478 this.set_dirty(true);
1478 this.set_dirty(true);
1479 return;
1479 return;
1480 }
1480 }
1481
1481
1482 this.command_mode();
1482 this.command_mode();
1483 this.insert_cell_below('code');
1483 this.insert_cell_below('code');
1484 this.select(cell_index+1);
1484 this.select(cell_index+1);
1485 this.edit_mode();
1485 this.edit_mode();
1486 this.set_dirty(true);
1486 this.set_dirty(true);
1487 };
1487 };
1488
1488
1489 /**
1489 /**
1490 * Execute or render cell outputs and select the next cell.
1490 * Execute or render cell outputs and select the next cell.
1491 *
1491 *
1492 * @method execute_cell_and_select_below
1492 * @method execute_cell_and_select_below
1493 */
1493 */
1494 Notebook.prototype.execute_cell_and_select_below = function () {
1494 Notebook.prototype.execute_cell_and_select_below = function () {
1495
1495
1496 var cell = this.get_selected_cell();
1496 var cell = this.get_selected_cell();
1497 var cell_index = this.find_cell_index(cell);
1497 var cell_index = this.find_cell_index(cell);
1498
1498
1499 cell.execute();
1499 cell.execute();
1500
1500
1501 // If we are at the end always insert a new cell and return
1501 // If we are at the end always insert a new cell and return
1502 if (cell_index === (this.ncells()-1)) {
1502 if (cell_index === (this.ncells()-1)) {
1503 this.command_mode();
1503 this.command_mode();
1504 this.insert_cell_below('code');
1504 this.insert_cell_below('code');
1505 this.select(cell_index+1);
1505 this.select(cell_index+1);
1506 this.edit_mode();
1506 this.edit_mode();
1507 this.scroll_to_bottom();
1507 this.scroll_to_bottom();
1508 this.set_dirty(true);
1508 this.set_dirty(true);
1509 return;
1509 return;
1510 }
1510 }
1511
1511
1512 this.command_mode();
1512 this.command_mode();
1513 this.select(cell_index+1);
1513 this.select(cell_index+1);
1514 this.focus_cell();
1514 this.focus_cell();
1515 this.set_dirty(true);
1515 this.set_dirty(true);
1516 };
1516 };
1517
1517
1518 /**
1518 /**
1519 * Execute all cells below the selected cell.
1519 * Execute all cells below the selected cell.
1520 *
1520 *
1521 * @method execute_cells_below
1521 * @method execute_cells_below
1522 */
1522 */
1523 Notebook.prototype.execute_cells_below = function () {
1523 Notebook.prototype.execute_cells_below = function () {
1524 this.execute_cell_range(this.get_selected_index(), this.ncells());
1524 this.execute_cell_range(this.get_selected_index(), this.ncells());
1525 this.scroll_to_bottom();
1525 this.scroll_to_bottom();
1526 };
1526 };
1527
1527
1528 /**
1528 /**
1529 * Execute all cells above the selected cell.
1529 * Execute all cells above the selected cell.
1530 *
1530 *
1531 * @method execute_cells_above
1531 * @method execute_cells_above
1532 */
1532 */
1533 Notebook.prototype.execute_cells_above = function () {
1533 Notebook.prototype.execute_cells_above = function () {
1534 this.execute_cell_range(0, this.get_selected_index());
1534 this.execute_cell_range(0, this.get_selected_index());
1535 };
1535 };
1536
1536
1537 /**
1537 /**
1538 * Execute all cells.
1538 * Execute all cells.
1539 *
1539 *
1540 * @method execute_all_cells
1540 * @method execute_all_cells
1541 */
1541 */
1542 Notebook.prototype.execute_all_cells = function () {
1542 Notebook.prototype.execute_all_cells = function () {
1543 this.execute_cell_range(0, this.ncells());
1543 this.execute_cell_range(0, this.ncells());
1544 this.scroll_to_bottom();
1544 this.scroll_to_bottom();
1545 };
1545 };
1546
1546
1547 /**
1547 /**
1548 * Execute a contiguous range of cells.
1548 * Execute a contiguous range of cells.
1549 *
1549 *
1550 * @method execute_cell_range
1550 * @method execute_cell_range
1551 * @param {Number} start Index of the first cell to execute (inclusive)
1551 * @param {Number} start Index of the first cell to execute (inclusive)
1552 * @param {Number} end Index of the last cell to execute (exclusive)
1552 * @param {Number} end Index of the last cell to execute (exclusive)
1553 */
1553 */
1554 Notebook.prototype.execute_cell_range = function (start, end) {
1554 Notebook.prototype.execute_cell_range = function (start, end) {
1555 this.command_mode();
1555 this.command_mode();
1556 for (var i=start; i<end; i++) {
1556 for (var i=start; i<end; i++) {
1557 this.select(i);
1557 this.select(i);
1558 this.execute_cell();
1558 this.execute_cell();
1559 }
1559 }
1560 };
1560 };
1561
1561
1562 // Persistance and loading
1562 // Persistance and loading
1563
1563
1564 /**
1564 /**
1565 * Getter method for this notebook's name.
1565 * Getter method for this notebook's name.
1566 *
1566 *
1567 * @method get_notebook_name
1567 * @method get_notebook_name
1568 * @return {String} This notebook's name (excluding file extension)
1568 * @return {String} This notebook's name (excluding file extension)
1569 */
1569 */
1570 Notebook.prototype.get_notebook_name = function () {
1570 Notebook.prototype.get_notebook_name = function () {
1571 var nbname = this.notebook_name.substring(0,this.notebook_name.length-6);
1571 var nbname = this.notebook_name.substring(0,this.notebook_name.length-6);
1572 return nbname;
1572 return nbname;
1573 };
1573 };
1574
1574
1575 /**
1575 /**
1576 * Setter method for this notebook's name.
1576 * Setter method for this notebook's name.
1577 *
1577 *
1578 * @method set_notebook_name
1578 * @method set_notebook_name
1579 * @param {String} name A new name for this notebook
1579 * @param {String} name A new name for this notebook
1580 */
1580 */
1581 Notebook.prototype.set_notebook_name = function (name) {
1581 Notebook.prototype.set_notebook_name = function (name) {
1582 this.notebook_name = name;
1582 this.notebook_name = name;
1583 };
1583 };
1584
1584
1585 /**
1585 /**
1586 * Check that a notebook's name is valid.
1586 * Check that a notebook's name is valid.
1587 *
1587 *
1588 * @method test_notebook_name
1588 * @method test_notebook_name
1589 * @param {String} nbname A name for this notebook
1589 * @param {String} nbname A name for this notebook
1590 * @return {Boolean} True if the name is valid, false if invalid
1590 * @return {Boolean} True if the name is valid, false if invalid
1591 */
1591 */
1592 Notebook.prototype.test_notebook_name = function (nbname) {
1592 Notebook.prototype.test_notebook_name = function (nbname) {
1593 nbname = nbname || '';
1593 nbname = nbname || '';
1594 if (nbname.length>0 && !this.notebook_name_blacklist_re.test(nbname)) {
1594 if (nbname.length>0 && !this.notebook_name_blacklist_re.test(nbname)) {
1595 return true;
1595 return true;
1596 } else {
1596 } else {
1597 return false;
1597 return false;
1598 }
1598 }
1599 };
1599 };
1600
1600
1601 /**
1601 /**
1602 * Load a notebook from JSON (.ipynb).
1602 * Load a notebook from JSON (.ipynb).
1603 *
1603 *
1604 * This currently handles one worksheet: others are deleted.
1604 * This currently handles one worksheet: others are deleted.
1605 *
1605 *
1606 * @method fromJSON
1606 * @method fromJSON
1607 * @param {Object} data JSON representation of a notebook
1607 * @param {Object} data JSON representation of a notebook
1608 */
1608 */
1609 Notebook.prototype.fromJSON = function (data) {
1609 Notebook.prototype.fromJSON = function (data) {
1610 var content = data.content;
1610 var content = data.content;
1611 var ncells = this.ncells();
1611 var ncells = this.ncells();
1612 var i;
1612 var i;
1613 for (i=0; i<ncells; i++) {
1613 for (i=0; i<ncells; i++) {
1614 // Always delete cell 0 as they get renumbered as they are deleted.
1614 // Always delete cell 0 as they get renumbered as they are deleted.
1615 this.delete_cell(0);
1615 this.delete_cell(0);
1616 }
1616 }
1617 // Save the metadata and name.
1617 // Save the metadata and name.
1618 this.metadata = content.metadata;
1618 this.metadata = content.metadata;
1619 this.notebook_name = data.name;
1619 this.notebook_name = data.name;
1620 var trusted = true;
1620 var trusted = true;
1621 // Only handle 1 worksheet for now.
1621 // Only handle 1 worksheet for now.
1622 var worksheet = content.worksheets[0];
1622 var worksheet = content.worksheets[0];
1623 if (worksheet !== undefined) {
1623 if (worksheet !== undefined) {
1624 if (worksheet.metadata) {
1624 if (worksheet.metadata) {
1625 this.worksheet_metadata = worksheet.metadata;
1625 this.worksheet_metadata = worksheet.metadata;
1626 }
1626 }
1627 var new_cells = worksheet.cells;
1627 var new_cells = worksheet.cells;
1628 ncells = new_cells.length;
1628 ncells = new_cells.length;
1629 var cell_data = null;
1629 var cell_data = null;
1630 var new_cell = null;
1630 var new_cell = null;
1631 for (i=0; i<ncells; i++) {
1631 for (i=0; i<ncells; i++) {
1632 cell_data = new_cells[i];
1632 cell_data = new_cells[i];
1633 // VERSIONHACK: plaintext -> raw
1633 // VERSIONHACK: plaintext -> raw
1634 // handle never-released plaintext name for raw cells
1634 // handle never-released plaintext name for raw cells
1635 if (cell_data.cell_type === 'plaintext'){
1635 if (cell_data.cell_type === 'plaintext'){
1636 cell_data.cell_type = 'raw';
1636 cell_data.cell_type = 'raw';
1637 }
1637 }
1638
1638
1639 new_cell = this.insert_cell_at_index(cell_data.cell_type, i);
1639 new_cell = this.insert_cell_at_index(cell_data.cell_type, i);
1640 new_cell.fromJSON(cell_data);
1640 new_cell.fromJSON(cell_data);
1641 if (new_cell.cell_type == 'code' && !new_cell.output_area.trusted) {
1641 if (new_cell.cell_type == 'code' && !new_cell.output_area.trusted) {
1642 trusted = false;
1642 trusted = false;
1643 }
1643 }
1644 }
1644 }
1645 }
1645 }
1646 if (trusted != this.trusted) {
1646 if (trusted != this.trusted) {
1647 this.trusted = trusted;
1647 this.trusted = trusted;
1648 $([IPython.events]).trigger("trust_changed.Notebook", trusted);
1648 $([IPython.events]).trigger("trust_changed.Notebook", trusted);
1649 }
1649 }
1650 if (content.worksheets.length > 1) {
1650 if (content.worksheets.length > 1) {
1651 IPython.dialog.modal({
1651 IPython.dialog.modal({
1652 title : "Multiple worksheets",
1652 title : "Multiple worksheets",
1653 body : "This notebook has " + data.worksheets.length + " worksheets, " +
1653 body : "This notebook has " + data.worksheets.length + " worksheets, " +
1654 "but this version of IPython can only handle the first. " +
1654 "but this version of IPython can only handle the first. " +
1655 "If you save this notebook, worksheets after the first will be lost.",
1655 "If you save this notebook, worksheets after the first will be lost.",
1656 buttons : {
1656 buttons : {
1657 OK : {
1657 OK : {
1658 class : "btn-danger"
1658 class : "btn-danger"
1659 }
1659 }
1660 }
1660 }
1661 });
1661 });
1662 }
1662 }
1663 };
1663 };
1664
1664
1665 /**
1665 /**
1666 * Dump this notebook into a JSON-friendly object.
1666 * Dump this notebook into a JSON-friendly object.
1667 *
1667 *
1668 * @method toJSON
1668 * @method toJSON
1669 * @return {Object} A JSON-friendly representation of this notebook.
1669 * @return {Object} A JSON-friendly representation of this notebook.
1670 */
1670 */
1671 Notebook.prototype.toJSON = function () {
1671 Notebook.prototype.toJSON = function () {
1672 var cells = this.get_cells();
1672 var cells = this.get_cells();
1673 var ncells = cells.length;
1673 var ncells = cells.length;
1674 var cell_array = new Array(ncells);
1674 var cell_array = new Array(ncells);
1675 var trusted = true;
1675 var trusted = true;
1676 for (var i=0; i<ncells; i++) {
1676 for (var i=0; i<ncells; i++) {
1677 var cell = cells[i];
1677 var cell = cells[i];
1678 if (cell.cell_type == 'code' && !cell.output_area.trusted) {
1678 if (cell.cell_type == 'code' && !cell.output_area.trusted) {
1679 trusted = false;
1679 trusted = false;
1680 }
1680 }
1681 cell_array[i] = cell.toJSON();
1681 cell_array[i] = cell.toJSON();
1682 }
1682 }
1683 var data = {
1683 var data = {
1684 // Only handle 1 worksheet for now.
1684 // Only handle 1 worksheet for now.
1685 worksheets : [{
1685 worksheets : [{
1686 cells: cell_array,
1686 cells: cell_array,
1687 metadata: this.worksheet_metadata
1687 metadata: this.worksheet_metadata
1688 }],
1688 }],
1689 metadata : this.metadata
1689 metadata : this.metadata
1690 };
1690 };
1691 if (trusted != this.trusted) {
1691 if (trusted != this.trusted) {
1692 this.trusted = trusted;
1692 this.trusted = trusted;
1693 $([IPython.events]).trigger("trust_changed.Notebook", trusted);
1693 $([IPython.events]).trigger("trust_changed.Notebook", trusted);
1694 }
1694 }
1695 return data;
1695 return data;
1696 };
1696 };
1697
1697
1698 /**
1698 /**
1699 * Start an autosave timer, for periodically saving the notebook.
1699 * Start an autosave timer, for periodically saving the notebook.
1700 *
1700 *
1701 * @method set_autosave_interval
1701 * @method set_autosave_interval
1702 * @param {Integer} interval the autosave interval in milliseconds
1702 * @param {Integer} interval the autosave interval in milliseconds
1703 */
1703 */
1704 Notebook.prototype.set_autosave_interval = function (interval) {
1704 Notebook.prototype.set_autosave_interval = function (interval) {
1705 var that = this;
1705 var that = this;
1706 // clear previous interval, so we don't get simultaneous timers
1706 // clear previous interval, so we don't get simultaneous timers
1707 if (this.autosave_timer) {
1707 if (this.autosave_timer) {
1708 clearInterval(this.autosave_timer);
1708 clearInterval(this.autosave_timer);
1709 }
1709 }
1710
1710
1711 this.autosave_interval = this.minimum_autosave_interval = interval;
1711 this.autosave_interval = this.minimum_autosave_interval = interval;
1712 if (interval) {
1712 if (interval) {
1713 this.autosave_timer = setInterval(function() {
1713 this.autosave_timer = setInterval(function() {
1714 if (that.dirty) {
1714 if (that.dirty) {
1715 that.save_notebook();
1715 that.save_notebook();
1716 }
1716 }
1717 }, interval);
1717 }, interval);
1718 $([IPython.events]).trigger("autosave_enabled.Notebook", interval);
1718 $([IPython.events]).trigger("autosave_enabled.Notebook", interval);
1719 } else {
1719 } else {
1720 this.autosave_timer = null;
1720 this.autosave_timer = null;
1721 $([IPython.events]).trigger("autosave_disabled.Notebook");
1721 $([IPython.events]).trigger("autosave_disabled.Notebook");
1722 }
1722 }
1723 };
1723 };
1724
1724
1725 /**
1725 /**
1726 * Save this notebook on the server.
1726 * Save this notebook on the server.
1727 *
1727 *
1728 * @method save_notebook
1728 * @method save_notebook
1729 */
1729 */
1730 Notebook.prototype.save_notebook = function (extra_settings) {
1730 Notebook.prototype.save_notebook = function (extra_settings) {
1731 // Create a JSON model to be sent to the server.
1731 // Create a JSON model to be sent to the server.
1732 var model = {};
1732 var model = {};
1733 model.name = this.notebook_name;
1733 model.name = this.notebook_name;
1734 model.path = this.notebook_path;
1734 model.path = this.notebook_path;
1735 model.content = this.toJSON();
1735 model.content = this.toJSON();
1736 model.content.nbformat = this.nbformat;
1736 model.content.nbformat = this.nbformat;
1737 model.content.nbformat_minor = this.nbformat_minor;
1737 model.content.nbformat_minor = this.nbformat_minor;
1738 // time the ajax call for autosave tuning purposes.
1738 // time the ajax call for autosave tuning purposes.
1739 var start = new Date().getTime();
1739 var start = new Date().getTime();
1740 // We do the call with settings so we can set cache to false.
1740 // We do the call with settings so we can set cache to false.
1741 var settings = {
1741 var settings = {
1742 processData : false,
1742 processData : false,
1743 cache : false,
1743 cache : false,
1744 type : "PUT",
1744 type : "PUT",
1745 data : JSON.stringify(model),
1745 data : JSON.stringify(model),
1746 headers : {'Content-Type': 'application/json'},
1746 headers : {'Content-Type': 'application/json'},
1747 success : $.proxy(this.save_notebook_success, this, start),
1747 success : $.proxy(this.save_notebook_success, this, start),
1748 error : $.proxy(this.save_notebook_error, this)
1748 error : $.proxy(this.save_notebook_error, this)
1749 };
1749 };
1750 if (extra_settings) {
1750 if (extra_settings) {
1751 for (var key in extra_settings) {
1751 for (var key in extra_settings) {
1752 settings[key] = extra_settings[key];
1752 settings[key] = extra_settings[key];
1753 }
1753 }
1754 }
1754 }
1755 $([IPython.events]).trigger('notebook_saving.Notebook');
1755 $([IPython.events]).trigger('notebook_saving.Notebook');
1756 var url = utils.url_join_encode(
1756 var url = utils.url_join_encode(
1757 this.base_url,
1757 this.base_url,
1758 'api/notebooks',
1758 'api/notebooks',
1759 this.notebook_path,
1759 this.notebook_path,
1760 this.notebook_name
1760 this.notebook_name
1761 );
1761 );
1762 $.ajax(url, settings);
1762 $.ajax(url, settings);
1763 };
1763 };
1764
1764
1765 /**
1765 /**
1766 * Success callback for saving a notebook.
1766 * Success callback for saving a notebook.
1767 *
1767 *
1768 * @method save_notebook_success
1768 * @method save_notebook_success
1769 * @param {Integer} start the time when the save request started
1769 * @param {Integer} start the time when the save request started
1770 * @param {Object} data JSON representation of a notebook
1770 * @param {Object} data JSON representation of a notebook
1771 * @param {String} status Description of response status
1771 * @param {String} status Description of response status
1772 * @param {jqXHR} xhr jQuery Ajax object
1772 * @param {jqXHR} xhr jQuery Ajax object
1773 */
1773 */
1774 Notebook.prototype.save_notebook_success = function (start, data, status, xhr) {
1774 Notebook.prototype.save_notebook_success = function (start, data, status, xhr) {
1775 this.set_dirty(false);
1775 this.set_dirty(false);
1776 $([IPython.events]).trigger('notebook_saved.Notebook');
1776 $([IPython.events]).trigger('notebook_saved.Notebook');
1777 this._update_autosave_interval(start);
1777 this._update_autosave_interval(start);
1778 if (this._checkpoint_after_save) {
1778 if (this._checkpoint_after_save) {
1779 this.create_checkpoint();
1779 this.create_checkpoint();
1780 this._checkpoint_after_save = false;
1780 this._checkpoint_after_save = false;
1781 }
1781 }
1782 };
1782 };
1783
1783
1784 /**
1784 /**
1785 * update the autosave interval based on how long the last save took
1785 * update the autosave interval based on how long the last save took
1786 *
1786 *
1787 * @method _update_autosave_interval
1787 * @method _update_autosave_interval
1788 * @param {Integer} timestamp when the save request started
1788 * @param {Integer} timestamp when the save request started
1789 */
1789 */
1790 Notebook.prototype._update_autosave_interval = function (start) {
1790 Notebook.prototype._update_autosave_interval = function (start) {
1791 var duration = (new Date().getTime() - start);
1791 var duration = (new Date().getTime() - start);
1792 if (this.autosave_interval) {
1792 if (this.autosave_interval) {
1793 // new save interval: higher of 10x save duration or parameter (default 30 seconds)
1793 // new save interval: higher of 10x save duration or parameter (default 30 seconds)
1794 var interval = Math.max(10 * duration, this.minimum_autosave_interval);
1794 var interval = Math.max(10 * duration, this.minimum_autosave_interval);
1795 // round to 10 seconds, otherwise we will be setting a new interval too often
1795 // round to 10 seconds, otherwise we will be setting a new interval too often
1796 interval = 10000 * Math.round(interval / 10000);
1796 interval = 10000 * Math.round(interval / 10000);
1797 // set new interval, if it's changed
1797 // set new interval, if it's changed
1798 if (interval != this.autosave_interval) {
1798 if (interval != this.autosave_interval) {
1799 this.set_autosave_interval(interval);
1799 this.set_autosave_interval(interval);
1800 }
1800 }
1801 }
1801 }
1802 };
1802 };
1803
1803
1804 /**
1804 /**
1805 * Failure callback for saving a notebook.
1805 * Failure callback for saving a notebook.
1806 *
1806 *
1807 * @method save_notebook_error
1807 * @method save_notebook_error
1808 * @param {jqXHR} xhr jQuery Ajax object
1808 * @param {jqXHR} xhr jQuery Ajax object
1809 * @param {String} status Description of response status
1809 * @param {String} status Description of response status
1810 * @param {String} error HTTP error message
1810 * @param {String} error HTTP error message
1811 */
1811 */
1812 Notebook.prototype.save_notebook_error = function (xhr, status, error) {
1812 Notebook.prototype.save_notebook_error = function (xhr, status, error) {
1813 $([IPython.events]).trigger('notebook_save_failed.Notebook', [xhr, status, error]);
1813 $([IPython.events]).trigger('notebook_save_failed.Notebook', [xhr, status, error]);
1814 };
1814 };
1815
1815
1816 /**
1816 /**
1817 * Explicitly trust the output of this notebook.
1817 * Explicitly trust the output of this notebook.
1818 *
1818 *
1819 * @method trust_notebook
1819 * @method trust_notebook
1820 */
1820 */
1821 Notebook.prototype.trust_notebook = function (extra_settings) {
1821 Notebook.prototype.trust_notebook = function (extra_settings) {
1822 var body = $("<div>").append($("<p>")
1822 var body = $("<div>").append($("<p>")
1823 .text("A trusted IPython notebook may execute hidden malicious code ")
1823 .text("A trusted IPython notebook may execute hidden malicious code ")
1824 .append($("<strong>")
1824 .append($("<strong>")
1825 .append(
1825 .append(
1826 $("<em>").text("when you open it")
1826 $("<em>").text("when you open it")
1827 )
1827 )
1828 ).append(".").append(
1828 ).append(".").append(
1829 " Selecting trust will immediately reload this notebook in a trusted state."
1829 " Selecting trust will immediately reload this notebook in a trusted state."
1830 ).append(
1830 ).append(
1831 " For more information, see the "
1831 " For more information, see the "
1832 ).append($("<a>").attr("href", "http://ipython.org/security.html")
1832 ).append($("<a>").attr("href", "http://ipython.org/security.html")
1833 .text("IPython security documentation")
1833 .text("IPython security documentation")
1834 ).append(".")
1834 ).append(".")
1835 );
1835 );
1836
1836
1837 var nb = this;
1837 var nb = this;
1838 IPython.dialog.modal({
1838 IPython.dialog.modal({
1839 title: "Trust this notebook?",
1839 title: "Trust this notebook?",
1840 body: body,
1840 body: body,
1841
1841
1842 buttons: {
1842 buttons: {
1843 Cancel : {},
1843 Cancel : {},
1844 Trust : {
1844 Trust : {
1845 class : "btn-danger",
1845 class : "btn-danger",
1846 click : function () {
1846 click : function () {
1847 var cells = nb.get_cells();
1847 var cells = nb.get_cells();
1848 for (var i = 0; i < cells.length; i++) {
1848 for (var i = 0; i < cells.length; i++) {
1849 var cell = cells[i];
1849 var cell = cells[i];
1850 if (cell.cell_type == 'code') {
1850 if (cell.cell_type == 'code') {
1851 cell.output_area.trusted = true;
1851 cell.output_area.trusted = true;
1852 }
1852 }
1853 }
1853 }
1854 $([IPython.events]).on('notebook_saved.Notebook', function () {
1854 $([IPython.events]).on('notebook_saved.Notebook', function () {
1855 window.location.reload();
1855 window.location.reload();
1856 });
1856 });
1857 nb.save_notebook();
1857 nb.save_notebook();
1858 }
1858 }
1859 }
1859 }
1860 }
1860 }
1861 });
1861 });
1862 };
1862 };
1863
1863
1864 Notebook.prototype.new_notebook = function(){
1864 Notebook.prototype.new_notebook = function(){
1865 var path = this.notebook_path;
1865 var path = this.notebook_path;
1866 var base_url = this.base_url;
1866 var base_url = this.base_url;
1867 var settings = {
1867 var settings = {
1868 processData : false,
1868 processData : false,
1869 cache : false,
1869 cache : false,
1870 type : "POST",
1870 type : "POST",
1871 dataType : "json",
1871 dataType : "json",
1872 async : false,
1872 async : false,
1873 success : function (data, status, xhr){
1873 success : function (data, status, xhr){
1874 var notebook_name = data.name;
1874 var notebook_name = data.name;
1875 window.open(
1875 window.open(
1876 utils.url_join_encode(
1876 utils.url_join_encode(
1877 base_url,
1877 base_url,
1878 'notebooks',
1878 'notebooks',
1879 path,
1879 path,
1880 notebook_name
1880 notebook_name
1881 ),
1881 ),
1882 '_blank'
1882 '_blank'
1883 );
1883 );
1884 }
1884 }
1885 };
1885 };
1886 var url = utils.url_join_encode(
1886 var url = utils.url_join_encode(
1887 base_url,
1887 base_url,
1888 'api/notebooks',
1888 'api/notebooks',
1889 path
1889 path
1890 );
1890 );
1891 $.ajax(url,settings);
1891 $.ajax(url,settings);
1892 };
1892 };
1893
1893
1894
1894
1895 Notebook.prototype.copy_notebook = function(){
1895 Notebook.prototype.copy_notebook = function(){
1896 var path = this.notebook_path;
1896 var path = this.notebook_path;
1897 var base_url = this.base_url;
1897 var base_url = this.base_url;
1898 var settings = {
1898 var settings = {
1899 processData : false,
1899 processData : false,
1900 cache : false,
1900 cache : false,
1901 type : "POST",
1901 type : "POST",
1902 dataType : "json",
1902 dataType : "json",
1903 data : JSON.stringify({copy_from : this.notebook_name}),
1903 data : JSON.stringify({copy_from : this.notebook_name}),
1904 async : false,
1904 async : false,
1905 success : function (data, status, xhr) {
1905 success : function (data, status, xhr) {
1906 window.open(utils.url_join_encode(
1906 window.open(utils.url_join_encode(
1907 base_url,
1907 base_url,
1908 'notebooks',
1908 'notebooks',
1909 data.path,
1909 data.path,
1910 data.name
1910 data.name
1911 ), '_blank');
1911 ), '_blank');
1912 }
1912 }
1913 };
1913 };
1914 var url = utils.url_join_encode(
1914 var url = utils.url_join_encode(
1915 base_url,
1915 base_url,
1916 'api/notebooks',
1916 'api/notebooks',
1917 path
1917 path
1918 );
1918 );
1919 $.ajax(url,settings);
1919 $.ajax(url,settings);
1920 };
1920 };
1921
1921
1922 Notebook.prototype.rename = function (nbname) {
1922 Notebook.prototype.rename = function (nbname) {
1923 var that = this;
1923 var that = this;
1924 if (!nbname.match(/\.ipynb$/)) {
1924 if (!nbname.match(/\.ipynb$/)) {
1925 nbname = nbname + ".ipynb";
1925 nbname = nbname + ".ipynb";
1926 }
1926 }
1927 var data = {name: nbname};
1927 var data = {name: nbname};
1928 var settings = {
1928 var settings = {
1929 processData : false,
1929 processData : false,
1930 cache : false,
1930 cache : false,
1931 type : "PATCH",
1931 type : "PATCH",
1932 data : JSON.stringify(data),
1932 data : JSON.stringify(data),
1933 dataType: "json",
1933 dataType: "json",
1934 headers : {'Content-Type': 'application/json'},
1934 headers : {'Content-Type': 'application/json'},
1935 success : $.proxy(that.rename_success, this),
1935 success : $.proxy(that.rename_success, this),
1936 error : $.proxy(that.rename_error, this)
1936 error : $.proxy(that.rename_error, this)
1937 };
1937 };
1938 $([IPython.events]).trigger('rename_notebook.Notebook', data);
1938 $([IPython.events]).trigger('rename_notebook.Notebook', data);
1939 var url = utils.url_join_encode(
1939 var url = utils.url_join_encode(
1940 this.base_url,
1940 this.base_url,
1941 'api/notebooks',
1941 'api/notebooks',
1942 this.notebook_path,
1942 this.notebook_path,
1943 this.notebook_name
1943 this.notebook_name
1944 );
1944 );
1945 $.ajax(url, settings);
1945 $.ajax(url, settings);
1946 };
1946 };
1947
1947
1948 Notebook.prototype.delete = function () {
1948 Notebook.prototype.delete = function () {
1949 var that = this;
1949 var that = this;
1950 var settings = {
1950 var settings = {
1951 processData : false,
1951 processData : false,
1952 cache : false,
1952 cache : false,
1953 type : "DELETE",
1953 type : "DELETE",
1954 dataType: "json",
1954 dataType: "json",
1955 };
1955 };
1956 var url = utils.url_join_encode(
1956 var url = utils.url_join_encode(
1957 this.base_url,
1957 this.base_url,
1958 'api/notebooks',
1958 'api/notebooks',
1959 this.notebook_path,
1959 this.notebook_path,
1960 this.notebook_name
1960 this.notebook_name
1961 );
1961 );
1962 $.ajax(url, settings);
1962 $.ajax(url, settings);
1963 };
1963 };
1964
1964
1965
1965
1966 Notebook.prototype.rename_success = function (json, status, xhr) {
1966 Notebook.prototype.rename_success = function (json, status, xhr) {
1967 var name = this.notebook_name = json.name;
1967 var name = this.notebook_name = json.name;
1968 var path = json.path;
1968 var path = json.path;
1969 this.session.rename_notebook(name, path);
1969 this.session.rename_notebook(name, path);
1970 $([IPython.events]).trigger('notebook_renamed.Notebook', json);
1970 $([IPython.events]).trigger('notebook_renamed.Notebook', json);
1971 };
1971 };
1972
1972
1973 Notebook.prototype.rename_error = function (xhr, status, error) {
1973 Notebook.prototype.rename_error = function (xhr, status, error) {
1974 var that = this;
1974 var that = this;
1975 var dialog = $('<div/>').append(
1975 var dialog = $('<div/>').append(
1976 $("<p/>").addClass("rename-message")
1976 $("<p/>").addClass("rename-message")
1977 .text('This notebook name already exists.')
1977 .text('This notebook name already exists.')
1978 );
1978 );
1979 $([IPython.events]).trigger('notebook_rename_failed.Notebook', [xhr, status, error]);
1979 $([IPython.events]).trigger('notebook_rename_failed.Notebook', [xhr, status, error]);
1980 IPython.dialog.modal({
1980 IPython.dialog.modal({
1981 title: "Notebook Rename Error!",
1981 title: "Notebook Rename Error!",
1982 body: dialog,
1982 body: dialog,
1983 buttons : {
1983 buttons : {
1984 "Cancel": {},
1984 "Cancel": {},
1985 "OK": {
1985 "OK": {
1986 class: "btn-primary",
1986 class: "btn-primary",
1987 click: function () {
1987 click: function () {
1988 IPython.save_widget.rename_notebook();
1988 IPython.save_widget.rename_notebook();
1989 }}
1989 }}
1990 },
1990 },
1991 open : function (event, ui) {
1991 open : function (event, ui) {
1992 var that = $(this);
1992 var that = $(this);
1993 // Upon ENTER, click the OK button.
1993 // Upon ENTER, click the OK button.
1994 that.find('input[type="text"]').keydown(function (event, ui) {
1994 that.find('input[type="text"]').keydown(function (event, ui) {
1995 if (event.which === IPython.keyboard.keycodes.enter) {
1995 if (event.which === IPython.keyboard.keycodes.enter) {
1996 that.find('.btn-primary').first().click();
1996 that.find('.btn-primary').first().click();
1997 }
1997 }
1998 });
1998 });
1999 that.find('input[type="text"]').focus();
1999 that.find('input[type="text"]').focus();
2000 }
2000 }
2001 });
2001 });
2002 };
2002 };
2003
2003
2004 /**
2004 /**
2005 * Request a notebook's data from the server.
2005 * Request a notebook's data from the server.
2006 *
2006 *
2007 * @method load_notebook
2007 * @method load_notebook
2008 * @param {String} notebook_name and path A notebook to load
2008 * @param {String} notebook_name and path A notebook to load
2009 */
2009 */
2010 Notebook.prototype.load_notebook = function (notebook_name, notebook_path) {
2010 Notebook.prototype.load_notebook = function (notebook_name, notebook_path) {
2011 var that = this;
2011 var that = this;
2012 this.notebook_name = notebook_name;
2012 this.notebook_name = notebook_name;
2013 this.notebook_path = notebook_path;
2013 this.notebook_path = notebook_path;
2014 // We do the call with settings so we can set cache to false.
2014 // We do the call with settings so we can set cache to false.
2015 var settings = {
2015 var settings = {
2016 processData : false,
2016 processData : false,
2017 cache : false,
2017 cache : false,
2018 type : "GET",
2018 type : "GET",
2019 dataType : "json",
2019 dataType : "json",
2020 success : $.proxy(this.load_notebook_success,this),
2020 success : $.proxy(this.load_notebook_success,this),
2021 error : $.proxy(this.load_notebook_error,this),
2021 error : $.proxy(this.load_notebook_error,this),
2022 };
2022 };
2023 $([IPython.events]).trigger('notebook_loading.Notebook');
2023 $([IPython.events]).trigger('notebook_loading.Notebook');
2024 var url = utils.url_join_encode(
2024 var url = utils.url_join_encode(
2025 this.base_url,
2025 this.base_url,
2026 'api/notebooks',
2026 'api/notebooks',
2027 this.notebook_path,
2027 this.notebook_path,
2028 this.notebook_name
2028 this.notebook_name
2029 );
2029 );
2030 $.ajax(url, settings);
2030 $.ajax(url, settings);
2031 };
2031 };
2032
2032
2033 /**
2033 /**
2034 * Success callback for loading a notebook from the server.
2034 * Success callback for loading a notebook from the server.
2035 *
2035 *
2036 * Load notebook data from the JSON response.
2036 * Load notebook data from the JSON response.
2037 *
2037 *
2038 * @method load_notebook_success
2038 * @method load_notebook_success
2039 * @param {Object} data JSON representation of a notebook
2039 * @param {Object} data JSON representation of a notebook
2040 * @param {String} status Description of response status
2040 * @param {String} status Description of response status
2041 * @param {jqXHR} xhr jQuery Ajax object
2041 * @param {jqXHR} xhr jQuery Ajax object
2042 */
2042 */
2043 Notebook.prototype.load_notebook_success = function (data, status, xhr) {
2043 Notebook.prototype.load_notebook_success = function (data, status, xhr) {
2044 this.fromJSON(data);
2044 this.fromJSON(data);
2045 if (this.ncells() === 0) {
2045 if (this.ncells() === 0) {
2046 this.insert_cell_below('code');
2046 this.insert_cell_below('code');
2047 this.edit_mode(0);
2047 this.edit_mode(0);
2048 } else {
2048 } else {
2049 this.select(0);
2049 this.select(0);
2050 this.handle_command_mode(this.get_cell(0));
2050 this.handle_command_mode(this.get_cell(0));
2051 $([IPython.events]).trigger('command_mode.Notebook');
2051 }
2052 }
2052 this.set_dirty(false);
2053 this.set_dirty(false);
2053 this.scroll_to_top();
2054 this.scroll_to_top();
2054 if (data.orig_nbformat !== undefined && data.nbformat !== data.orig_nbformat) {
2055 if (data.orig_nbformat !== undefined && data.nbformat !== data.orig_nbformat) {
2055 var msg = "This notebook has been converted from an older " +
2056 var msg = "This notebook has been converted from an older " +
2056 "notebook format (v"+data.orig_nbformat+") to the current notebook " +
2057 "notebook format (v"+data.orig_nbformat+") to the current notebook " +
2057 "format (v"+data.nbformat+"). The next time you save this notebook, the " +
2058 "format (v"+data.nbformat+"). The next time you save this notebook, the " +
2058 "newer notebook format will be used and older versions of IPython " +
2059 "newer notebook format will be used and older versions of IPython " +
2059 "may not be able to read it. To keep the older version, close the " +
2060 "may not be able to read it. To keep the older version, close the " +
2060 "notebook without saving it.";
2061 "notebook without saving it.";
2061 IPython.dialog.modal({
2062 IPython.dialog.modal({
2062 title : "Notebook converted",
2063 title : "Notebook converted",
2063 body : msg,
2064 body : msg,
2064 buttons : {
2065 buttons : {
2065 OK : {
2066 OK : {
2066 class : "btn-primary"
2067 class : "btn-primary"
2067 }
2068 }
2068 }
2069 }
2069 });
2070 });
2070 } else if (data.orig_nbformat_minor !== undefined && data.nbformat_minor !== data.orig_nbformat_minor) {
2071 } else if (data.orig_nbformat_minor !== undefined && data.nbformat_minor !== data.orig_nbformat_minor) {
2071 var that = this;
2072 var that = this;
2072 var orig_vs = 'v' + data.nbformat + '.' + data.orig_nbformat_minor;
2073 var orig_vs = 'v' + data.nbformat + '.' + data.orig_nbformat_minor;
2073 var this_vs = 'v' + data.nbformat + '.' + this.nbformat_minor;
2074 var this_vs = 'v' + data.nbformat + '.' + this.nbformat_minor;
2074 var msg = "This notebook is version " + orig_vs + ", but we only fully support up to " +
2075 var msg = "This notebook is version " + orig_vs + ", but we only fully support up to " +
2075 this_vs + ". You can still work with this notebook, but some features " +
2076 this_vs + ". You can still work with this notebook, but some features " +
2076 "introduced in later notebook versions may not be available.";
2077 "introduced in later notebook versions may not be available.";
2077
2078
2078 IPython.dialog.modal({
2079 IPython.dialog.modal({
2079 title : "Newer Notebook",
2080 title : "Newer Notebook",
2080 body : msg,
2081 body : msg,
2081 buttons : {
2082 buttons : {
2082 OK : {
2083 OK : {
2083 class : "btn-danger"
2084 class : "btn-danger"
2084 }
2085 }
2085 }
2086 }
2086 });
2087 });
2087
2088
2088 }
2089 }
2089
2090
2090 // Create the session after the notebook is completely loaded to prevent
2091 // Create the session after the notebook is completely loaded to prevent
2091 // code execution upon loading, which is a security risk.
2092 // code execution upon loading, which is a security risk.
2092 if (this.session === null) {
2093 if (this.session === null) {
2093 this.start_session();
2094 this.start_session();
2094 }
2095 }
2095 // load our checkpoint list
2096 // load our checkpoint list
2096 this.list_checkpoints();
2097 this.list_checkpoints();
2097
2098
2098 // load toolbar state
2099 // load toolbar state
2099 if (this.metadata.celltoolbar) {
2100 if (this.metadata.celltoolbar) {
2100 IPython.CellToolbar.global_show();
2101 IPython.CellToolbar.global_show();
2101 IPython.CellToolbar.activate_preset(this.metadata.celltoolbar);
2102 IPython.CellToolbar.activate_preset(this.metadata.celltoolbar);
2102 }
2103 }
2103
2104
2104 $([IPython.events]).trigger('notebook_loaded.Notebook');
2105 $([IPython.events]).trigger('notebook_loaded.Notebook');
2105 };
2106 };
2106
2107
2107 /**
2108 /**
2108 * Failure callback for loading a notebook from the server.
2109 * Failure callback for loading a notebook from the server.
2109 *
2110 *
2110 * @method load_notebook_error
2111 * @method load_notebook_error
2111 * @param {jqXHR} xhr jQuery Ajax object
2112 * @param {jqXHR} xhr jQuery Ajax object
2112 * @param {String} status Description of response status
2113 * @param {String} status Description of response status
2113 * @param {String} error HTTP error message
2114 * @param {String} error HTTP error message
2114 */
2115 */
2115 Notebook.prototype.load_notebook_error = function (xhr, status, error) {
2116 Notebook.prototype.load_notebook_error = function (xhr, status, error) {
2116 $([IPython.events]).trigger('notebook_load_failed.Notebook', [xhr, status, error]);
2117 $([IPython.events]).trigger('notebook_load_failed.Notebook', [xhr, status, error]);
2117 var msg;
2118 var msg;
2118 if (xhr.status === 400) {
2119 if (xhr.status === 400) {
2119 msg = error;
2120 msg = error;
2120 } else if (xhr.status === 500) {
2121 } else if (xhr.status === 500) {
2121 msg = "An unknown error occurred while loading this notebook. " +
2122 msg = "An unknown error occurred while loading this notebook. " +
2122 "This version can load notebook formats " +
2123 "This version can load notebook formats " +
2123 "v" + this.nbformat + " or earlier.";
2124 "v" + this.nbformat + " or earlier.";
2124 }
2125 }
2125 IPython.dialog.modal({
2126 IPython.dialog.modal({
2126 title: "Error loading notebook",
2127 title: "Error loading notebook",
2127 body : msg,
2128 body : msg,
2128 buttons : {
2129 buttons : {
2129 "OK": {}
2130 "OK": {}
2130 }
2131 }
2131 });
2132 });
2132 };
2133 };
2133
2134
2134 /********************* checkpoint-related *********************/
2135 /********************* checkpoint-related *********************/
2135
2136
2136 /**
2137 /**
2137 * Save the notebook then immediately create a checkpoint.
2138 * Save the notebook then immediately create a checkpoint.
2138 *
2139 *
2139 * @method save_checkpoint
2140 * @method save_checkpoint
2140 */
2141 */
2141 Notebook.prototype.save_checkpoint = function () {
2142 Notebook.prototype.save_checkpoint = function () {
2142 this._checkpoint_after_save = true;
2143 this._checkpoint_after_save = true;
2143 this.save_notebook();
2144 this.save_notebook();
2144 };
2145 };
2145
2146
2146 /**
2147 /**
2147 * Add a checkpoint for this notebook.
2148 * Add a checkpoint for this notebook.
2148 * for use as a callback from checkpoint creation.
2149 * for use as a callback from checkpoint creation.
2149 *
2150 *
2150 * @method add_checkpoint
2151 * @method add_checkpoint
2151 */
2152 */
2152 Notebook.prototype.add_checkpoint = function (checkpoint) {
2153 Notebook.prototype.add_checkpoint = function (checkpoint) {
2153 var found = false;
2154 var found = false;
2154 for (var i = 0; i < this.checkpoints.length; i++) {
2155 for (var i = 0; i < this.checkpoints.length; i++) {
2155 var existing = this.checkpoints[i];
2156 var existing = this.checkpoints[i];
2156 if (existing.id == checkpoint.id) {
2157 if (existing.id == checkpoint.id) {
2157 found = true;
2158 found = true;
2158 this.checkpoints[i] = checkpoint;
2159 this.checkpoints[i] = checkpoint;
2159 break;
2160 break;
2160 }
2161 }
2161 }
2162 }
2162 if (!found) {
2163 if (!found) {
2163 this.checkpoints.push(checkpoint);
2164 this.checkpoints.push(checkpoint);
2164 }
2165 }
2165 this.last_checkpoint = this.checkpoints[this.checkpoints.length - 1];
2166 this.last_checkpoint = this.checkpoints[this.checkpoints.length - 1];
2166 };
2167 };
2167
2168
2168 /**
2169 /**
2169 * List checkpoints for this notebook.
2170 * List checkpoints for this notebook.
2170 *
2171 *
2171 * @method list_checkpoints
2172 * @method list_checkpoints
2172 */
2173 */
2173 Notebook.prototype.list_checkpoints = function () {
2174 Notebook.prototype.list_checkpoints = function () {
2174 var url = utils.url_join_encode(
2175 var url = utils.url_join_encode(
2175 this.base_url,
2176 this.base_url,
2176 'api/notebooks',
2177 'api/notebooks',
2177 this.notebook_path,
2178 this.notebook_path,
2178 this.notebook_name,
2179 this.notebook_name,
2179 'checkpoints'
2180 'checkpoints'
2180 );
2181 );
2181 $.get(url).done(
2182 $.get(url).done(
2182 $.proxy(this.list_checkpoints_success, this)
2183 $.proxy(this.list_checkpoints_success, this)
2183 ).fail(
2184 ).fail(
2184 $.proxy(this.list_checkpoints_error, this)
2185 $.proxy(this.list_checkpoints_error, this)
2185 );
2186 );
2186 };
2187 };
2187
2188
2188 /**
2189 /**
2189 * Success callback for listing checkpoints.
2190 * Success callback for listing checkpoints.
2190 *
2191 *
2191 * @method list_checkpoint_success
2192 * @method list_checkpoint_success
2192 * @param {Object} data JSON representation of a checkpoint
2193 * @param {Object} data JSON representation of a checkpoint
2193 * @param {String} status Description of response status
2194 * @param {String} status Description of response status
2194 * @param {jqXHR} xhr jQuery Ajax object
2195 * @param {jqXHR} xhr jQuery Ajax object
2195 */
2196 */
2196 Notebook.prototype.list_checkpoints_success = function (data, status, xhr) {
2197 Notebook.prototype.list_checkpoints_success = function (data, status, xhr) {
2197 data = $.parseJSON(data);
2198 data = $.parseJSON(data);
2198 this.checkpoints = data;
2199 this.checkpoints = data;
2199 if (data.length) {
2200 if (data.length) {
2200 this.last_checkpoint = data[data.length - 1];
2201 this.last_checkpoint = data[data.length - 1];
2201 } else {
2202 } else {
2202 this.last_checkpoint = null;
2203 this.last_checkpoint = null;
2203 }
2204 }
2204 $([IPython.events]).trigger('checkpoints_listed.Notebook', [data]);
2205 $([IPython.events]).trigger('checkpoints_listed.Notebook', [data]);
2205 };
2206 };
2206
2207
2207 /**
2208 /**
2208 * Failure callback for listing a checkpoint.
2209 * Failure callback for listing a checkpoint.
2209 *
2210 *
2210 * @method list_checkpoint_error
2211 * @method list_checkpoint_error
2211 * @param {jqXHR} xhr jQuery Ajax object
2212 * @param {jqXHR} xhr jQuery Ajax object
2212 * @param {String} status Description of response status
2213 * @param {String} status Description of response status
2213 * @param {String} error_msg HTTP error message
2214 * @param {String} error_msg HTTP error message
2214 */
2215 */
2215 Notebook.prototype.list_checkpoints_error = function (xhr, status, error_msg) {
2216 Notebook.prototype.list_checkpoints_error = function (xhr, status, error_msg) {
2216 $([IPython.events]).trigger('list_checkpoints_failed.Notebook');
2217 $([IPython.events]).trigger('list_checkpoints_failed.Notebook');
2217 };
2218 };
2218
2219
2219 /**
2220 /**
2220 * Create a checkpoint of this notebook on the server from the most recent save.
2221 * Create a checkpoint of this notebook on the server from the most recent save.
2221 *
2222 *
2222 * @method create_checkpoint
2223 * @method create_checkpoint
2223 */
2224 */
2224 Notebook.prototype.create_checkpoint = function () {
2225 Notebook.prototype.create_checkpoint = function () {
2225 var url = utils.url_join_encode(
2226 var url = utils.url_join_encode(
2226 this.base_url,
2227 this.base_url,
2227 'api/notebooks',
2228 'api/notebooks',
2228 this.notebook_path,
2229 this.notebook_path,
2229 this.notebook_name,
2230 this.notebook_name,
2230 'checkpoints'
2231 'checkpoints'
2231 );
2232 );
2232 $.post(url).done(
2233 $.post(url).done(
2233 $.proxy(this.create_checkpoint_success, this)
2234 $.proxy(this.create_checkpoint_success, this)
2234 ).fail(
2235 ).fail(
2235 $.proxy(this.create_checkpoint_error, this)
2236 $.proxy(this.create_checkpoint_error, this)
2236 );
2237 );
2237 };
2238 };
2238
2239
2239 /**
2240 /**
2240 * Success callback for creating a checkpoint.
2241 * Success callback for creating a checkpoint.
2241 *
2242 *
2242 * @method create_checkpoint_success
2243 * @method create_checkpoint_success
2243 * @param {Object} data JSON representation of a checkpoint
2244 * @param {Object} data JSON representation of a checkpoint
2244 * @param {String} status Description of response status
2245 * @param {String} status Description of response status
2245 * @param {jqXHR} xhr jQuery Ajax object
2246 * @param {jqXHR} xhr jQuery Ajax object
2246 */
2247 */
2247 Notebook.prototype.create_checkpoint_success = function (data, status, xhr) {
2248 Notebook.prototype.create_checkpoint_success = function (data, status, xhr) {
2248 data = $.parseJSON(data);
2249 data = $.parseJSON(data);
2249 this.add_checkpoint(data);
2250 this.add_checkpoint(data);
2250 $([IPython.events]).trigger('checkpoint_created.Notebook', data);
2251 $([IPython.events]).trigger('checkpoint_created.Notebook', data);
2251 };
2252 };
2252
2253
2253 /**
2254 /**
2254 * Failure callback for creating a checkpoint.
2255 * Failure callback for creating a checkpoint.
2255 *
2256 *
2256 * @method create_checkpoint_error
2257 * @method create_checkpoint_error
2257 * @param {jqXHR} xhr jQuery Ajax object
2258 * @param {jqXHR} xhr jQuery Ajax object
2258 * @param {String} status Description of response status
2259 * @param {String} status Description of response status
2259 * @param {String} error_msg HTTP error message
2260 * @param {String} error_msg HTTP error message
2260 */
2261 */
2261 Notebook.prototype.create_checkpoint_error = function (xhr, status, error_msg) {
2262 Notebook.prototype.create_checkpoint_error = function (xhr, status, error_msg) {
2262 $([IPython.events]).trigger('checkpoint_failed.Notebook');
2263 $([IPython.events]).trigger('checkpoint_failed.Notebook');
2263 };
2264 };
2264
2265
2265 Notebook.prototype.restore_checkpoint_dialog = function (checkpoint) {
2266 Notebook.prototype.restore_checkpoint_dialog = function (checkpoint) {
2266 var that = this;
2267 var that = this;
2267 checkpoint = checkpoint || this.last_checkpoint;
2268 checkpoint = checkpoint || this.last_checkpoint;
2268 if ( ! checkpoint ) {
2269 if ( ! checkpoint ) {
2269 console.log("restore dialog, but no checkpoint to restore to!");
2270 console.log("restore dialog, but no checkpoint to restore to!");
2270 return;
2271 return;
2271 }
2272 }
2272 var body = $('<div/>').append(
2273 var body = $('<div/>').append(
2273 $('<p/>').addClass("p-space").text(
2274 $('<p/>').addClass("p-space").text(
2274 "Are you sure you want to revert the notebook to " +
2275 "Are you sure you want to revert the notebook to " +
2275 "the latest checkpoint?"
2276 "the latest checkpoint?"
2276 ).append(
2277 ).append(
2277 $("<strong/>").text(
2278 $("<strong/>").text(
2278 " This cannot be undone."
2279 " This cannot be undone."
2279 )
2280 )
2280 )
2281 )
2281 ).append(
2282 ).append(
2282 $('<p/>').addClass("p-space").text("The checkpoint was last updated at:")
2283 $('<p/>').addClass("p-space").text("The checkpoint was last updated at:")
2283 ).append(
2284 ).append(
2284 $('<p/>').addClass("p-space").text(
2285 $('<p/>').addClass("p-space").text(
2285 Date(checkpoint.last_modified)
2286 Date(checkpoint.last_modified)
2286 ).css("text-align", "center")
2287 ).css("text-align", "center")
2287 );
2288 );
2288
2289
2289 IPython.dialog.modal({
2290 IPython.dialog.modal({
2290 title : "Revert notebook to checkpoint",
2291 title : "Revert notebook to checkpoint",
2291 body : body,
2292 body : body,
2292 buttons : {
2293 buttons : {
2293 Revert : {
2294 Revert : {
2294 class : "btn-danger",
2295 class : "btn-danger",
2295 click : function () {
2296 click : function () {
2296 that.restore_checkpoint(checkpoint.id);
2297 that.restore_checkpoint(checkpoint.id);
2297 }
2298 }
2298 },
2299 },
2299 Cancel : {}
2300 Cancel : {}
2300 }
2301 }
2301 });
2302 });
2302 };
2303 };
2303
2304
2304 /**
2305 /**
2305 * Restore the notebook to a checkpoint state.
2306 * Restore the notebook to a checkpoint state.
2306 *
2307 *
2307 * @method restore_checkpoint
2308 * @method restore_checkpoint
2308 * @param {String} checkpoint ID
2309 * @param {String} checkpoint ID
2309 */
2310 */
2310 Notebook.prototype.restore_checkpoint = function (checkpoint) {
2311 Notebook.prototype.restore_checkpoint = function (checkpoint) {
2311 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2312 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2312 var url = utils.url_join_encode(
2313 var url = utils.url_join_encode(
2313 this.base_url,
2314 this.base_url,
2314 'api/notebooks',
2315 'api/notebooks',
2315 this.notebook_path,
2316 this.notebook_path,
2316 this.notebook_name,
2317 this.notebook_name,
2317 'checkpoints',
2318 'checkpoints',
2318 checkpoint
2319 checkpoint
2319 );
2320 );
2320 $.post(url).done(
2321 $.post(url).done(
2321 $.proxy(this.restore_checkpoint_success, this)
2322 $.proxy(this.restore_checkpoint_success, this)
2322 ).fail(
2323 ).fail(
2323 $.proxy(this.restore_checkpoint_error, this)
2324 $.proxy(this.restore_checkpoint_error, this)
2324 );
2325 );
2325 };
2326 };
2326
2327
2327 /**
2328 /**
2328 * Success callback for restoring a notebook to a checkpoint.
2329 * Success callback for restoring a notebook to a checkpoint.
2329 *
2330 *
2330 * @method restore_checkpoint_success
2331 * @method restore_checkpoint_success
2331 * @param {Object} data (ignored, should be empty)
2332 * @param {Object} data (ignored, should be empty)
2332 * @param {String} status Description of response status
2333 * @param {String} status Description of response status
2333 * @param {jqXHR} xhr jQuery Ajax object
2334 * @param {jqXHR} xhr jQuery Ajax object
2334 */
2335 */
2335 Notebook.prototype.restore_checkpoint_success = function (data, status, xhr) {
2336 Notebook.prototype.restore_checkpoint_success = function (data, status, xhr) {
2336 $([IPython.events]).trigger('checkpoint_restored.Notebook');
2337 $([IPython.events]).trigger('checkpoint_restored.Notebook');
2337 this.load_notebook(this.notebook_name, this.notebook_path);
2338 this.load_notebook(this.notebook_name, this.notebook_path);
2338 };
2339 };
2339
2340
2340 /**
2341 /**
2341 * Failure callback for restoring a notebook to a checkpoint.
2342 * Failure callback for restoring a notebook to a checkpoint.
2342 *
2343 *
2343 * @method restore_checkpoint_error
2344 * @method restore_checkpoint_error
2344 * @param {jqXHR} xhr jQuery Ajax object
2345 * @param {jqXHR} xhr jQuery Ajax object
2345 * @param {String} status Description of response status
2346 * @param {String} status Description of response status
2346 * @param {String} error_msg HTTP error message
2347 * @param {String} error_msg HTTP error message
2347 */
2348 */
2348 Notebook.prototype.restore_checkpoint_error = function (xhr, status, error_msg) {
2349 Notebook.prototype.restore_checkpoint_error = function (xhr, status, error_msg) {
2349 $([IPython.events]).trigger('checkpoint_restore_failed.Notebook');
2350 $([IPython.events]).trigger('checkpoint_restore_failed.Notebook');
2350 };
2351 };
2351
2352
2352 /**
2353 /**
2353 * Delete a notebook checkpoint.
2354 * Delete a notebook checkpoint.
2354 *
2355 *
2355 * @method delete_checkpoint
2356 * @method delete_checkpoint
2356 * @param {String} checkpoint ID
2357 * @param {String} checkpoint ID
2357 */
2358 */
2358 Notebook.prototype.delete_checkpoint = function (checkpoint) {
2359 Notebook.prototype.delete_checkpoint = function (checkpoint) {
2359 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2360 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2360 var url = utils.url_join_encode(
2361 var url = utils.url_join_encode(
2361 this.base_url,
2362 this.base_url,
2362 'api/notebooks',
2363 'api/notebooks',
2363 this.notebook_path,
2364 this.notebook_path,
2364 this.notebook_name,
2365 this.notebook_name,
2365 'checkpoints',
2366 'checkpoints',
2366 checkpoint
2367 checkpoint
2367 );
2368 );
2368 $.ajax(url, {
2369 $.ajax(url, {
2369 type: 'DELETE',
2370 type: 'DELETE',
2370 success: $.proxy(this.delete_checkpoint_success, this),
2371 success: $.proxy(this.delete_checkpoint_success, this),
2371 error: $.proxy(this.delete_notebook_error,this)
2372 error: $.proxy(this.delete_notebook_error,this)
2372 });
2373 });
2373 };
2374 };
2374
2375
2375 /**
2376 /**
2376 * Success callback for deleting a notebook checkpoint
2377 * Success callback for deleting a notebook checkpoint
2377 *
2378 *
2378 * @method delete_checkpoint_success
2379 * @method delete_checkpoint_success
2379 * @param {Object} data (ignored, should be empty)
2380 * @param {Object} data (ignored, should be empty)
2380 * @param {String} status Description of response status
2381 * @param {String} status Description of response status
2381 * @param {jqXHR} xhr jQuery Ajax object
2382 * @param {jqXHR} xhr jQuery Ajax object
2382 */
2383 */
2383 Notebook.prototype.delete_checkpoint_success = function (data, status, xhr) {
2384 Notebook.prototype.delete_checkpoint_success = function (data, status, xhr) {
2384 $([IPython.events]).trigger('checkpoint_deleted.Notebook', data);
2385 $([IPython.events]).trigger('checkpoint_deleted.Notebook', data);
2385 this.load_notebook(this.notebook_name, this.notebook_path);
2386 this.load_notebook(this.notebook_name, this.notebook_path);
2386 };
2387 };
2387
2388
2388 /**
2389 /**
2389 * Failure callback for deleting a notebook checkpoint.
2390 * Failure callback for deleting a notebook checkpoint.
2390 *
2391 *
2391 * @method delete_checkpoint_error
2392 * @method delete_checkpoint_error
2392 * @param {jqXHR} xhr jQuery Ajax object
2393 * @param {jqXHR} xhr jQuery Ajax object
2393 * @param {String} status Description of response status
2394 * @param {String} status Description of response status
2394 * @param {String} error_msg HTTP error message
2395 * @param {String} error_msg HTTP error message
2395 */
2396 */
2396 Notebook.prototype.delete_checkpoint_error = function (xhr, status, error_msg) {
2397 Notebook.prototype.delete_checkpoint_error = function (xhr, status, error_msg) {
2397 $([IPython.events]).trigger('checkpoint_delete_failed.Notebook');
2398 $([IPython.events]).trigger('checkpoint_delete_failed.Notebook');
2398 };
2399 };
2399
2400
2400
2401
2401 IPython.Notebook = Notebook;
2402 IPython.Notebook = Notebook;
2402
2403
2403
2404
2404 return IPython;
2405 return IPython;
2405
2406
2406 }(IPython));
2407 }(IPython));
2407
2408
General Comments 0
You need to be logged in to leave comments. Login now