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