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