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