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