Show More
@@ -1,868 +1,874 b'' | |||
|
1 | 1 | //---------------------------------------------------------------------------- |
|
2 | 2 | // Copyright (C) 2008 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 | // OutputArea |
|
10 | 10 | //============================================================================ |
|
11 | 11 | |
|
12 | 12 | /** |
|
13 | 13 | * @module IPython |
|
14 | 14 | * @namespace IPython |
|
15 | 15 | * @submodule OutputArea |
|
16 | 16 | */ |
|
17 | 17 | var IPython = (function (IPython) { |
|
18 | 18 | "use strict"; |
|
19 | 19 | |
|
20 | 20 | var utils = IPython.utils; |
|
21 | 21 | |
|
22 | 22 | /** |
|
23 | 23 | * @class OutputArea |
|
24 | 24 | * |
|
25 | 25 | * @constructor |
|
26 | 26 | */ |
|
27 | 27 | |
|
28 | 28 | var OutputArea = function (selector, prompt_area) { |
|
29 | 29 | this.selector = selector; |
|
30 | 30 | this.wrapper = $(selector); |
|
31 | 31 | this.outputs = []; |
|
32 | 32 | this.collapsed = false; |
|
33 | 33 | this.scrolled = false; |
|
34 | 34 | this.trusted = true; |
|
35 | 35 | this.clear_queued = null; |
|
36 | 36 | if (prompt_area === undefined) { |
|
37 | 37 | this.prompt_area = true; |
|
38 | 38 | } else { |
|
39 | 39 | this.prompt_area = prompt_area; |
|
40 | 40 | } |
|
41 | 41 | this.create_elements(); |
|
42 | 42 | this.style(); |
|
43 | 43 | this.bind_events(); |
|
44 | 44 | }; |
|
45 | 45 | |
|
46 | 46 | |
|
47 | 47 | /** |
|
48 | 48 | * Class prototypes |
|
49 | 49 | **/ |
|
50 | 50 | |
|
51 | 51 | OutputArea.prototype.create_elements = function () { |
|
52 | 52 | this.element = $("<div/>"); |
|
53 | 53 | this.collapse_button = $("<div/>"); |
|
54 | 54 | this.prompt_overlay = $("<div/>"); |
|
55 | 55 | this.wrapper.append(this.prompt_overlay); |
|
56 | 56 | this.wrapper.append(this.element); |
|
57 | 57 | this.wrapper.append(this.collapse_button); |
|
58 | 58 | }; |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | OutputArea.prototype.style = function () { |
|
62 | 62 | this.collapse_button.hide(); |
|
63 | 63 | this.prompt_overlay.hide(); |
|
64 | 64 | |
|
65 | 65 | this.wrapper.addClass('output_wrapper'); |
|
66 | 66 | this.element.addClass('output'); |
|
67 | 67 | |
|
68 | 68 | this.collapse_button.addClass("btn output_collapsed"); |
|
69 | 69 | this.collapse_button.attr('title', 'click to expand output'); |
|
70 | 70 | this.collapse_button.text('. . .'); |
|
71 | 71 | |
|
72 | 72 | this.prompt_overlay.addClass('out_prompt_overlay prompt'); |
|
73 | 73 | this.prompt_overlay.attr('title', 'click to expand output; double click to hide output'); |
|
74 | 74 | |
|
75 | 75 | this.collapse(); |
|
76 | 76 | }; |
|
77 | 77 | |
|
78 | 78 | /** |
|
79 | 79 | * Should the OutputArea scroll? |
|
80 | 80 | * Returns whether the height (in lines) exceeds a threshold. |
|
81 | 81 | * |
|
82 | 82 | * @private |
|
83 | 83 | * @method _should_scroll |
|
84 | 84 | * @param [lines=100]{Integer} |
|
85 | 85 | * @return {Bool} |
|
86 | 86 | * |
|
87 | 87 | */ |
|
88 | 88 | OutputArea.prototype._should_scroll = function (lines) { |
|
89 | 89 | if (lines <=0 ){ return } |
|
90 | 90 | if (!lines) { |
|
91 | 91 | lines = 100; |
|
92 | 92 | } |
|
93 | 93 | // line-height from http://stackoverflow.com/questions/1185151 |
|
94 | 94 | var fontSize = this.element.css('font-size'); |
|
95 | 95 | var lineHeight = Math.floor(parseInt(fontSize.replace('px','')) * 1.5); |
|
96 | 96 | |
|
97 | 97 | return (this.element.height() > lines * lineHeight); |
|
98 | 98 | }; |
|
99 | 99 | |
|
100 | 100 | |
|
101 | 101 | OutputArea.prototype.bind_events = function () { |
|
102 | 102 | var that = this; |
|
103 | 103 | this.prompt_overlay.dblclick(function () { that.toggle_output(); }); |
|
104 | 104 | this.prompt_overlay.click(function () { that.toggle_scroll(); }); |
|
105 | 105 | |
|
106 | 106 | this.element.resize(function () { |
|
107 | 107 | // FIXME: Firefox on Linux misbehaves, so automatic scrolling is disabled |
|
108 | 108 | if ( IPython.utils.browser[0] === "Firefox" ) { |
|
109 | 109 | return; |
|
110 | 110 | } |
|
111 | 111 | // maybe scroll output, |
|
112 | 112 | // if it's grown large enough and hasn't already been scrolled. |
|
113 | 113 | if ( !that.scrolled && that._should_scroll(OutputArea.auto_scroll_threshold)) { |
|
114 | 114 | that.scroll_area(); |
|
115 | 115 | } |
|
116 | 116 | }); |
|
117 | 117 | this.collapse_button.click(function () { |
|
118 | 118 | that.expand(); |
|
119 | 119 | }); |
|
120 | 120 | }; |
|
121 | 121 | |
|
122 | 122 | |
|
123 | 123 | OutputArea.prototype.collapse = function () { |
|
124 | 124 | if (!this.collapsed) { |
|
125 | 125 | this.element.hide(); |
|
126 | 126 | this.prompt_overlay.hide(); |
|
127 | 127 | if (this.element.html()){ |
|
128 | 128 | this.collapse_button.show(); |
|
129 | 129 | } |
|
130 | 130 | this.collapsed = true; |
|
131 | 131 | } |
|
132 | 132 | }; |
|
133 | 133 | |
|
134 | 134 | |
|
135 | 135 | OutputArea.prototype.expand = function () { |
|
136 | 136 | if (this.collapsed) { |
|
137 | 137 | this.collapse_button.hide(); |
|
138 | 138 | this.element.show(); |
|
139 | 139 | this.prompt_overlay.show(); |
|
140 | 140 | this.collapsed = false; |
|
141 | 141 | } |
|
142 | 142 | }; |
|
143 | 143 | |
|
144 | 144 | |
|
145 | 145 | OutputArea.prototype.toggle_output = function () { |
|
146 | 146 | if (this.collapsed) { |
|
147 | 147 | this.expand(); |
|
148 | 148 | } else { |
|
149 | 149 | this.collapse(); |
|
150 | 150 | } |
|
151 | 151 | }; |
|
152 | 152 | |
|
153 | 153 | |
|
154 | 154 | OutputArea.prototype.scroll_area = function () { |
|
155 | 155 | this.element.addClass('output_scroll'); |
|
156 | 156 | this.prompt_overlay.attr('title', 'click to unscroll output; double click to hide'); |
|
157 | 157 | this.scrolled = true; |
|
158 | 158 | }; |
|
159 | 159 | |
|
160 | 160 | |
|
161 | 161 | OutputArea.prototype.unscroll_area = function () { |
|
162 | 162 | this.element.removeClass('output_scroll'); |
|
163 | 163 | this.prompt_overlay.attr('title', 'click to scroll output; double click to hide'); |
|
164 | 164 | this.scrolled = false; |
|
165 | 165 | }; |
|
166 | 166 | |
|
167 | 167 | /** |
|
168 | 168 | * |
|
169 | 169 | * Scroll OutputArea if height supperior than a threshold (in lines). |
|
170 | 170 | * |
|
171 | 171 | * Threshold is a maximum number of lines. If unspecified, defaults to |
|
172 | 172 | * OutputArea.minimum_scroll_threshold. |
|
173 | 173 | * |
|
174 | 174 | * Negative threshold will prevent the OutputArea from ever scrolling. |
|
175 | 175 | * |
|
176 | 176 | * @method scroll_if_long |
|
177 | 177 | * |
|
178 | 178 | * @param [lines=20]{Number} Default to 20 if not set, |
|
179 | 179 | * behavior undefined for value of `0`. |
|
180 | 180 | * |
|
181 | 181 | **/ |
|
182 | 182 | OutputArea.prototype.scroll_if_long = function (lines) { |
|
183 | 183 | var n = lines | OutputArea.minimum_scroll_threshold; |
|
184 | 184 | if(n <= 0){ |
|
185 | 185 | return |
|
186 | 186 | } |
|
187 | 187 | |
|
188 | 188 | if (this._should_scroll(n)) { |
|
189 | 189 | // only allow scrolling long-enough output |
|
190 | 190 | this.scroll_area(); |
|
191 | 191 | } |
|
192 | 192 | }; |
|
193 | 193 | |
|
194 | 194 | |
|
195 | 195 | OutputArea.prototype.toggle_scroll = function () { |
|
196 | 196 | if (this.scrolled) { |
|
197 | 197 | this.unscroll_area(); |
|
198 | 198 | } else { |
|
199 | 199 | // only allow scrolling long-enough output |
|
200 | 200 | this.scroll_if_long(); |
|
201 | 201 | } |
|
202 | 202 | }; |
|
203 | 203 | |
|
204 | 204 | |
|
205 | 205 | // typeset with MathJax if MathJax is available |
|
206 | 206 | OutputArea.prototype.typeset = function () { |
|
207 | 207 | if (window.MathJax){ |
|
208 | 208 | MathJax.Hub.Queue(["Typeset",MathJax.Hub]); |
|
209 | 209 | } |
|
210 | 210 | }; |
|
211 | 211 | |
|
212 | 212 | |
|
213 | 213 | OutputArea.prototype.handle_output = function (msg) { |
|
214 | 214 | var json = {}; |
|
215 | 215 | var msg_type = json.output_type = msg.header.msg_type; |
|
216 | 216 | var content = msg.content; |
|
217 | 217 | if (msg_type === "stream") { |
|
218 | 218 | json.text = content.data; |
|
219 | 219 | json.stream = content.name; |
|
220 | 220 | } else if (msg_type === "display_data") { |
|
221 | 221 | json = content.data; |
|
222 | 222 | json.output_type = msg_type; |
|
223 | 223 | json.metadata = content.metadata; |
|
224 | 224 | } else if (msg_type === "pyout") { |
|
225 | 225 | json = content.data; |
|
226 | 226 | json.output_type = msg_type; |
|
227 | 227 | json.metadata = content.metadata; |
|
228 | 228 | json.prompt_number = content.execution_count; |
|
229 | 229 | } else if (msg_type === "pyerr") { |
|
230 | 230 | json.ename = content.ename; |
|
231 | 231 | json.evalue = content.evalue; |
|
232 | 232 | json.traceback = content.traceback; |
|
233 | 233 | } |
|
234 | 234 | this.append_output(json); |
|
235 | 235 | }; |
|
236 | 236 | |
|
237 | 237 | |
|
238 | 238 | OutputArea.prototype.rename_keys = function (data, key_map) { |
|
239 | 239 | var remapped = {}; |
|
240 | 240 | for (var key in data) { |
|
241 | 241 | var new_key = key_map[key] || key; |
|
242 | 242 | remapped[new_key] = data[key]; |
|
243 | 243 | } |
|
244 | 244 | return remapped; |
|
245 | 245 | }; |
|
246 | 246 | |
|
247 | 247 | |
|
248 | 248 | OutputArea.output_types = [ |
|
249 | 249 | 'application/javascript', |
|
250 | 250 | 'text/html', |
|
251 | 251 | 'text/latex', |
|
252 | 252 | 'image/svg+xml', |
|
253 | 253 | 'image/png', |
|
254 | 254 | 'image/jpeg', |
|
255 | 255 | 'application/pdf', |
|
256 | 256 | 'text/plain' |
|
257 | 257 | ]; |
|
258 | 258 | |
|
259 | 259 | OutputArea.prototype.validate_output = function (json) { |
|
260 | 260 | // scrub invalid outputs |
|
261 | 261 | // TODO: right now everything is a string, but JSON really shouldn't be. |
|
262 | 262 | // nbformat 4 will fix that. |
|
263 | 263 | $.map(OutputArea.output_types, function(key){ |
|
264 | 264 | if (json[key] !== undefined && typeof json[key] !== 'string') { |
|
265 | 265 | console.log("Invalid type for " + key, json[key]); |
|
266 | 266 | delete json[key]; |
|
267 | 267 | } |
|
268 | 268 | }); |
|
269 | 269 | return json; |
|
270 | 270 | }; |
|
271 | 271 | |
|
272 | 272 | OutputArea.prototype.append_output = function (json) { |
|
273 | 273 | this.expand(); |
|
274 | 274 | // Clear the output if clear is queued. |
|
275 | 275 | var needs_height_reset = false; |
|
276 | 276 | if (this.clear_queued) { |
|
277 | 277 | this.clear_output(false); |
|
278 | 278 | needs_height_reset = true; |
|
279 | 279 | } |
|
280 | 280 | |
|
281 | 281 | // validate output data types |
|
282 | 282 | json = this.validate_output(json); |
|
283 | 283 | |
|
284 | 284 | if (json.output_type === 'pyout') { |
|
285 | 285 | this.append_pyout(json); |
|
286 | 286 | } else if (json.output_type === 'pyerr') { |
|
287 | 287 | this.append_pyerr(json); |
|
288 | 288 | } else if (json.output_type === 'display_data') { |
|
289 | 289 | this.append_display_data(json); |
|
290 | 290 | } else if (json.output_type === 'stream') { |
|
291 | 291 | this.append_stream(json); |
|
292 | 292 | } |
|
293 | 293 | |
|
294 | 294 | this.outputs.push(json); |
|
295 | 295 | |
|
296 | 296 | // Only reset the height to automatic if the height is currently |
|
297 | 297 | // fixed (done by wait=True flag on clear_output). |
|
298 | 298 | if (needs_height_reset) { |
|
299 | 299 | this.element.height(''); |
|
300 | 300 | } |
|
301 | 301 | |
|
302 | 302 | var that = this; |
|
303 | 303 | setTimeout(function(){that.element.trigger('resize');}, 100); |
|
304 | 304 | }; |
|
305 | 305 | |
|
306 | 306 | |
|
307 | 307 | OutputArea.prototype.create_output_area = function () { |
|
308 | 308 | var oa = $("<div/>").addClass("output_area"); |
|
309 | 309 | if (this.prompt_area) { |
|
310 | 310 | oa.append($('<div/>').addClass('prompt')); |
|
311 | 311 | } |
|
312 | 312 | return oa; |
|
313 | 313 | }; |
|
314 | 314 | |
|
315 | 315 | |
|
316 | 316 | function _get_metadata_key(metadata, key, mime) { |
|
317 | 317 | var mime_md = metadata[mime]; |
|
318 | 318 | // mime-specific higher priority |
|
319 | 319 | if (mime_md && mime_md[key] !== undefined) { |
|
320 | 320 | return mime_md[key]; |
|
321 | 321 | } |
|
322 | 322 | // fallback on global |
|
323 | 323 | return metadata[key]; |
|
324 | 324 | } |
|
325 | 325 | |
|
326 | 326 | OutputArea.prototype.create_output_subarea = function(md, classes, mime) { |
|
327 | 327 | var subarea = $('<div/>').addClass('output_subarea').addClass(classes); |
|
328 | 328 | if (_get_metadata_key(md, 'isolated', mime)) { |
|
329 | 329 | // Create an iframe to isolate the subarea from the rest of the |
|
330 | 330 | // document |
|
331 | 331 | var iframe = $('<iframe/>').addClass('box-flex1'); |
|
332 | 332 | iframe.css({'height':1, 'width':'100%', 'display':'block'}); |
|
333 | 333 | iframe.attr('frameborder', 0); |
|
334 | 334 | iframe.attr('scrolling', 'auto'); |
|
335 | 335 | |
|
336 | 336 | // Once the iframe is loaded, the subarea is dynamically inserted |
|
337 | 337 | iframe.on('load', function() { |
|
338 | 338 | // Workaround needed by Firefox, to properly render svg inside |
|
339 | 339 | // iframes, see http://stackoverflow.com/questions/10177190/ |
|
340 | 340 | // svg-dynamically-added-to-iframe-does-not-render-correctly |
|
341 | 341 | this.contentDocument.open(); |
|
342 | 342 | |
|
343 | 343 | // Insert the subarea into the iframe |
|
344 | 344 | // We must directly write the html. When using Jquery's append |
|
345 | 345 | // method, javascript is evaluated in the parent document and |
|
346 | 346 | // not in the iframe document. At this point, subarea doesn't |
|
347 | 347 | // contain any user content. |
|
348 | 348 | this.contentDocument.write(subarea.html()); |
|
349 | 349 | |
|
350 | 350 | this.contentDocument.close(); |
|
351 | 351 | |
|
352 | 352 | var body = this.contentDocument.body; |
|
353 | 353 | // Adjust the iframe height automatically |
|
354 | 354 | iframe.height(body.scrollHeight + 'px'); |
|
355 | 355 | }); |
|
356 | 356 | |
|
357 | 357 | // Elements should be appended to the inner subarea and not to the |
|
358 | 358 | // iframe |
|
359 | 359 | iframe.append = function(that) { |
|
360 | 360 | subarea.append(that); |
|
361 | 361 | }; |
|
362 | 362 | |
|
363 | 363 | return iframe; |
|
364 | 364 | } else { |
|
365 | 365 | return subarea; |
|
366 | 366 | } |
|
367 | 367 | } |
|
368 | 368 | |
|
369 | 369 | |
|
370 | 370 | OutputArea.prototype._append_javascript_error = function (err, element) { |
|
371 | 371 | // display a message when a javascript error occurs in display output |
|
372 | 372 | var msg = "Javascript error adding output!" |
|
373 | 373 | if ( element === undefined ) return; |
|
374 | 374 | element |
|
375 | 375 | .append($('<div/>').text(msg).addClass('js-error')) |
|
376 | 376 | .append($('<div/>').text(err.toString()).addClass('js-error')) |
|
377 | 377 | .append($('<div/>').text('See your browser Javascript console for more details.').addClass('js-error')); |
|
378 | 378 | }; |
|
379 | 379 | |
|
380 | 380 | OutputArea.prototype._safe_append = function (toinsert) { |
|
381 | 381 | // safely append an item to the document |
|
382 | 382 | // this is an object created by user code, |
|
383 | 383 | // and may have errors, which should not be raised |
|
384 | 384 | // under any circumstances. |
|
385 | 385 | try { |
|
386 | 386 | this.element.append(toinsert); |
|
387 | 387 | } catch(err) { |
|
388 | 388 | console.log(err); |
|
389 | 389 | // Create an actual output_area and output_subarea, which creates |
|
390 | 390 | // the prompt area and the proper indentation. |
|
391 | 391 | var toinsert = this.create_output_area(); |
|
392 | 392 | var subarea = $('<div/>').addClass('output_subarea'); |
|
393 | 393 | toinsert.append(subarea); |
|
394 | 394 | this._append_javascript_error(err, subarea); |
|
395 | 395 | this.element.append(toinsert); |
|
396 | 396 | } |
|
397 | 397 | }; |
|
398 | 398 | |
|
399 | 399 | |
|
400 | 400 | OutputArea.prototype.append_pyout = function (json) { |
|
401 | 401 | var n = json.prompt_number || ' '; |
|
402 | 402 | var toinsert = this.create_output_area(); |
|
403 | 403 | if (this.prompt_area) { |
|
404 | 404 | toinsert.find('div.prompt').addClass('output_prompt').text('Out[' + n + ']:'); |
|
405 | 405 | } |
|
406 | 406 | var inserted = this.append_mime_type(json, toinsert); |
|
407 | 407 | if (inserted) { |
|
408 | 408 | inserted.addClass('output_pyout'); |
|
409 | 409 | } |
|
410 | 410 | this._safe_append(toinsert); |
|
411 | 411 | // If we just output latex, typeset it. |
|
412 | 412 | if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) { |
|
413 | 413 | this.typeset(); |
|
414 | 414 | } |
|
415 | 415 | }; |
|
416 | 416 | |
|
417 | 417 | |
|
418 | 418 | OutputArea.prototype.append_pyerr = function (json) { |
|
419 | 419 | var tb = json.traceback; |
|
420 | 420 | if (tb !== undefined && tb.length > 0) { |
|
421 | 421 | var s = ''; |
|
422 | 422 | var len = tb.length; |
|
423 | 423 | for (var i=0; i<len; i++) { |
|
424 | 424 | s = s + tb[i] + '\n'; |
|
425 | 425 | } |
|
426 | 426 | s = s + '\n'; |
|
427 | 427 | var toinsert = this.create_output_area(); |
|
428 | this.append_text(s, {}, toinsert).addClass('output_pyerr'); | |
|
428 | var append_text = OutputArea.append_map['text/plain']; | |
|
429 | if (append_text) { | |
|
430 | append_text.apply(this, [s, {}, toinsert]).addClass('output_pyerr'); | |
|
431 | } | |
|
429 | 432 | this._safe_append(toinsert); |
|
430 | 433 | } |
|
431 | 434 | }; |
|
432 | 435 | |
|
433 | 436 | |
|
434 | 437 | OutputArea.prototype.append_stream = function (json) { |
|
435 | 438 | // temporary fix: if stream undefined (json file written prior to this patch), |
|
436 | 439 | // default to most likely stdout: |
|
437 | if (json.stream == undefined){ | |
|
440 | if (json.stream === undefined){ | |
|
438 | 441 | json.stream = 'stdout'; |
|
439 | 442 | } |
|
440 | 443 | var text = json.text; |
|
441 | 444 | var subclass = "output_"+json.stream; |
|
442 | 445 | if (this.outputs.length > 0){ |
|
443 | 446 | // have at least one output to consider |
|
444 | 447 | var last = this.outputs[this.outputs.length-1]; |
|
445 | 448 | if (last.output_type == 'stream' && json.stream == last.stream){ |
|
446 | 449 | // latest output was in the same stream, |
|
447 | 450 | // so append directly into its pre tag |
|
448 | 451 | // escape ANSI & HTML specials: |
|
449 | 452 | var pre = this.element.find('div.'+subclass).last().find('pre'); |
|
450 | 453 | var html = utils.fixCarriageReturn( |
|
451 | 454 | pre.html() + utils.fixConsole(text)); |
|
452 | 455 | // The only user content injected with this HTML call is |
|
453 | 456 | // escaped by the fixConsole() method. |
|
454 | 457 | pre.html(html); |
|
455 | 458 | return; |
|
456 | 459 | } |
|
457 | 460 | } |
|
458 | 461 | |
|
459 | 462 | if (!text.replace("\r", "")) { |
|
460 | 463 | // text is nothing (empty string, \r, etc.) |
|
461 | 464 | // so don't append any elements, which might add undesirable space |
|
462 | 465 | return; |
|
463 | 466 | } |
|
464 | 467 | |
|
465 | 468 | // If we got here, attach a new div |
|
466 | 469 | var toinsert = this.create_output_area(); |
|
467 | this.append_text(text, {}, toinsert).addClass("output_stream "+subclass); | |
|
470 | var append_text = OutputArea.append_map['text/plain']; | |
|
471 | if (append_text) { | |
|
472 | append_text.apply(this, [text, {}, toinsert]).addClass("output_stream " + subclass); | |
|
473 | } | |
|
468 | 474 | this._safe_append(toinsert); |
|
469 | 475 | }; |
|
470 | 476 | |
|
471 | 477 | |
|
472 | 478 | OutputArea.prototype.append_display_data = function (json) { |
|
473 | 479 | var toinsert = this.create_output_area(); |
|
474 | 480 | if (this.append_mime_type(json, toinsert)) { |
|
475 | 481 | this._safe_append(toinsert); |
|
476 | 482 | // If we just output latex, typeset it. |
|
477 | 483 | if ((json['text/latex'] !== undefined) || (json['text/html'] !== undefined)) { |
|
478 | 484 | this.typeset(); |
|
479 | 485 | } |
|
480 | 486 | } |
|
481 | 487 | }; |
|
482 | 488 | |
|
483 | 489 | |
|
484 | 490 | OutputArea.safe_outputs = { |
|
485 | 491 | 'text/plain' : true, |
|
486 | 492 | 'text/latex' : true, |
|
487 | 493 | 'image/png' : true, |
|
488 | 494 | 'image/jpeg' : true |
|
489 | 495 | }; |
|
490 | 496 | |
|
491 | 497 | OutputArea.prototype.append_mime_type = function (json, element) { |
|
492 | 498 | for (var type_i in OutputArea.display_order) { |
|
493 | 499 | var type = OutputArea.display_order[type_i]; |
|
494 | 500 | var append = OutputArea.append_map[type]; |
|
495 | 501 | if ((json[type] !== undefined) && append) { |
|
496 | 502 | var value = json[type]; |
|
497 | 503 | if (!this.trusted && !OutputArea.safe_outputs[type]) { |
|
498 | 504 | // not trusted, sanitize HTML |
|
499 | 505 | if (type==='text/html' || type==='text/svg') { |
|
500 | 506 | value = IPython.security.sanitize_html(value); |
|
501 | 507 | } else { |
|
502 | 508 | // don't display if we don't know how to sanitize it |
|
503 | 509 | console.log("Ignoring untrusted " + type + " output."); |
|
504 | 510 | continue; |
|
505 | 511 | } |
|
506 | 512 | } |
|
507 | 513 | var md = json.metadata || {}; |
|
508 | 514 | var toinsert = append.apply(this, [value, md, element]); |
|
509 | 515 | $([IPython.events]).trigger('output_appended.OutputArea', [type, value, md, toinsert]); |
|
510 | 516 | return toinsert; |
|
511 | 517 | } |
|
512 | 518 | } |
|
513 | 519 | return null; |
|
514 | 520 | }; |
|
515 | 521 | |
|
516 | 522 | |
|
517 | 523 | var append_html = function (html, md, element) { |
|
518 | 524 | var type = 'text/html'; |
|
519 | 525 | var toinsert = this.create_output_subarea(md, "output_html rendered_html", type); |
|
520 | 526 | IPython.keyboard_manager.register_events(toinsert); |
|
521 | 527 | toinsert.append(html); |
|
522 | 528 | element.append(toinsert); |
|
523 | 529 | return toinsert; |
|
524 | 530 | }; |
|
525 | 531 | |
|
526 | 532 | |
|
527 | 533 | var append_javascript = function (js, md, element) { |
|
528 | 534 | // We just eval the JS code, element appears in the local scope. |
|
529 | 535 | var type = 'application/javascript'; |
|
530 | 536 | var toinsert = this.create_output_subarea(md, "output_javascript", type); |
|
531 | 537 | IPython.keyboard_manager.register_events(toinsert); |
|
532 | 538 | element.append(toinsert); |
|
533 | 539 | // FIXME TODO : remove `container element for 3.0` |
|
534 | 540 | //backward compat, js should be eval'ed in a context where `container` is defined. |
|
535 | 541 | var container = element; |
|
536 | 542 | container.show = function(){console.log('Warning "container.show()" is deprecated.')}; |
|
537 | 543 | // end backward compat |
|
538 | 544 | try { |
|
539 | 545 | eval(js); |
|
540 | 546 | } catch(err) { |
|
541 | 547 | console.log(err); |
|
542 | 548 | this._append_javascript_error(err, toinsert); |
|
543 | 549 | } |
|
544 | 550 | return toinsert; |
|
545 | 551 | }; |
|
546 | 552 | |
|
547 | 553 | |
|
548 | 554 | var append_text = function (data, md, element) { |
|
549 | 555 | var type = 'text/plain'; |
|
550 | 556 | var toinsert = this.create_output_subarea(md, "output_text", type); |
|
551 | 557 | // escape ANSI & HTML specials in plaintext: |
|
552 | 558 | data = utils.fixConsole(data); |
|
553 | 559 | data = utils.fixCarriageReturn(data); |
|
554 | 560 | data = utils.autoLinkUrls(data); |
|
555 | 561 | // The only user content injected with this HTML call is |
|
556 | 562 | // escaped by the fixConsole() method. |
|
557 | 563 | toinsert.append($("<pre/>").html(data)); |
|
558 | 564 | element.append(toinsert); |
|
559 | 565 | return toinsert; |
|
560 | 566 | }; |
|
561 | 567 | |
|
562 | 568 | |
|
563 | 569 | var append_svg = function (svg, md, element) { |
|
564 | 570 | var type = 'image/svg+xml'; |
|
565 | 571 | var toinsert = this.create_output_subarea(md, "output_svg", type); |
|
566 | 572 | toinsert.append(svg); |
|
567 | 573 | element.append(toinsert); |
|
568 | 574 | return toinsert; |
|
569 | 575 | }; |
|
570 | 576 | |
|
571 | 577 | |
|
572 | 578 | OutputArea.prototype._dblclick_to_reset_size = function (img) { |
|
573 | 579 | // wrap image after it's loaded on the page, |
|
574 | 580 | // otherwise the measured initial size will be incorrect |
|
575 | 581 | img.on("load", function (){ |
|
576 | 582 | var h0 = img.height(); |
|
577 | 583 | var w0 = img.width(); |
|
578 | 584 | if (!(h0 && w0)) { |
|
579 | 585 | // zero size, don't make it resizable |
|
580 | 586 | return; |
|
581 | 587 | } |
|
582 | 588 | img.resizable({ |
|
583 | 589 | aspectRatio: true, |
|
584 | 590 | autoHide: true |
|
585 | 591 | }); |
|
586 | 592 | img.dblclick(function () { |
|
587 | 593 | // resize wrapper & image together for some reason: |
|
588 | 594 | img.parent().height(h0); |
|
589 | 595 | img.height(h0); |
|
590 | 596 | img.parent().width(w0); |
|
591 | 597 | img.width(w0); |
|
592 | 598 | }); |
|
593 | 599 | }); |
|
594 | 600 | }; |
|
595 | 601 | |
|
596 | 602 | var set_width_height = function (img, md, mime) { |
|
597 | 603 | // set width and height of an img element from metadata |
|
598 | 604 | var height = _get_metadata_key(md, 'height', mime); |
|
599 | 605 | if (height !== undefined) img.attr('height', height); |
|
600 | 606 | var width = _get_metadata_key(md, 'width', mime); |
|
601 | 607 | if (width !== undefined) img.attr('width', width); |
|
602 | 608 | }; |
|
603 | 609 | |
|
604 | 610 | var append_png = function (png, md, element) { |
|
605 | 611 | var type = 'image/png'; |
|
606 | 612 | var toinsert = this.create_output_subarea(md, "output_png", type); |
|
607 | 613 | var img = $("<img/>").attr('src','data:image/png;base64,'+png); |
|
608 | 614 | set_width_height(img, md, 'image/png'); |
|
609 | 615 | this._dblclick_to_reset_size(img); |
|
610 | 616 | toinsert.append(img); |
|
611 | 617 | element.append(toinsert); |
|
612 | 618 | return toinsert; |
|
613 | 619 | }; |
|
614 | 620 | |
|
615 | 621 | |
|
616 | 622 | var append_jpeg = function (jpeg, md, element) { |
|
617 | 623 | var type = 'image/jpeg'; |
|
618 | 624 | var toinsert = this.create_output_subarea(md, "output_jpeg", type); |
|
619 | 625 | var img = $("<img/>").attr('src','data:image/jpeg;base64,'+jpeg); |
|
620 | 626 | set_width_height(img, md, 'image/jpeg'); |
|
621 | 627 | this._dblclick_to_reset_size(img); |
|
622 | 628 | toinsert.append(img); |
|
623 | 629 | element.append(toinsert); |
|
624 | 630 | return toinsert; |
|
625 | 631 | }; |
|
626 | 632 | |
|
627 | 633 | |
|
628 | 634 | var append_pdf = function (pdf, md, element) { |
|
629 | 635 | var type = 'application/pdf'; |
|
630 | 636 | var toinsert = this.create_output_subarea(md, "output_pdf", type); |
|
631 | 637 | var a = $('<a/>').attr('href', 'data:application/pdf;base64,'+pdf); |
|
632 | 638 | a.attr('target', '_blank'); |
|
633 | 639 | a.text('View PDF') |
|
634 | 640 | toinsert.append(a); |
|
635 | 641 | element.append(toinsert); |
|
636 | 642 | return toinsert; |
|
637 | 643 | } |
|
638 | 644 | |
|
639 | 645 | var append_latex = function (latex, md, element) { |
|
640 | 646 | // This method cannot do the typesetting because the latex first has to |
|
641 | 647 | // be on the page. |
|
642 | 648 | var type = 'text/latex'; |
|
643 | 649 | var toinsert = this.create_output_subarea(md, "output_latex", type); |
|
644 | 650 | toinsert.append(latex); |
|
645 | 651 | element.append(toinsert); |
|
646 | 652 | return toinsert; |
|
647 | 653 | }; |
|
648 | 654 | |
|
649 | 655 | |
|
650 | 656 | OutputArea.prototype.append_raw_input = function (msg) { |
|
651 | 657 | var that = this; |
|
652 | 658 | this.expand(); |
|
653 | 659 | var content = msg.content; |
|
654 | 660 | var area = this.create_output_area(); |
|
655 | 661 | |
|
656 | 662 | // disable any other raw_inputs, if they are left around |
|
657 | 663 | $("div.output_subarea.raw_input").remove(); |
|
658 | 664 | |
|
659 | 665 | area.append( |
|
660 | 666 | $("<div/>") |
|
661 | 667 | .addClass("box-flex1 output_subarea raw_input") |
|
662 | 668 | .append( |
|
663 | 669 | $("<span/>") |
|
664 | 670 | .addClass("input_prompt") |
|
665 | 671 | .text(content.prompt) |
|
666 | 672 | ) |
|
667 | 673 | .append( |
|
668 | 674 | $("<input/>") |
|
669 | 675 | .addClass("raw_input") |
|
670 | 676 | .attr('type', 'text') |
|
671 | 677 | .attr("size", 47) |
|
672 | 678 | .keydown(function (event, ui) { |
|
673 | 679 | // make sure we submit on enter, |
|
674 | 680 | // and don't re-execute the *cell* on shift-enter |
|
675 | 681 | if (event.which === IPython.keyboard.keycodes.enter) { |
|
676 | 682 | that._submit_raw_input(); |
|
677 | 683 | return false; |
|
678 | 684 | } |
|
679 | 685 | }) |
|
680 | 686 | ) |
|
681 | 687 | ); |
|
682 | 688 | |
|
683 | 689 | this.element.append(area); |
|
684 | 690 | var raw_input = area.find('input.raw_input'); |
|
685 | 691 | // Register events that enable/disable the keyboard manager while raw |
|
686 | 692 | // input is focused. |
|
687 | 693 | IPython.keyboard_manager.register_events(raw_input); |
|
688 | 694 | // Note, the following line used to read raw_input.focus().focus(). |
|
689 | 695 | // This seemed to be needed otherwise only the cell would be focused. |
|
690 | 696 | // But with the modal UI, this seems to work fine with one call to focus(). |
|
691 | 697 | raw_input.focus(); |
|
692 | 698 | } |
|
693 | 699 | |
|
694 | 700 | OutputArea.prototype._submit_raw_input = function (evt) { |
|
695 | 701 | var container = this.element.find("div.raw_input"); |
|
696 | 702 | var theprompt = container.find("span.input_prompt"); |
|
697 | 703 | var theinput = container.find("input.raw_input"); |
|
698 | 704 | var value = theinput.val(); |
|
699 | 705 | var content = { |
|
700 | 706 | output_type : 'stream', |
|
701 | 707 | name : 'stdout', |
|
702 | 708 | text : theprompt.text() + value + '\n' |
|
703 | 709 | } |
|
704 | 710 | // remove form container |
|
705 | 711 | container.parent().remove(); |
|
706 | 712 | // replace with plaintext version in stdout |
|
707 | 713 | this.append_output(content, false); |
|
708 | 714 | $([IPython.events]).trigger('send_input_reply.Kernel', value); |
|
709 | 715 | } |
|
710 | 716 | |
|
711 | 717 | |
|
712 | 718 | OutputArea.prototype.handle_clear_output = function (msg) { |
|
713 | 719 | // msg spec v4 had stdout, stderr, display keys |
|
714 | 720 | // v4.1 replaced these with just wait |
|
715 | 721 | // The default behavior is the same (stdout=stderr=display=True, wait=False), |
|
716 | 722 | // so v4 messages will still be properly handled, |
|
717 | 723 | // except for the rarely used clearing less than all output. |
|
718 | 724 | this.clear_output(msg.content.wait || false); |
|
719 | 725 | }; |
|
720 | 726 | |
|
721 | 727 | |
|
722 | 728 | OutputArea.prototype.clear_output = function(wait) { |
|
723 | 729 | if (wait) { |
|
724 | 730 | |
|
725 | 731 | // If a clear is queued, clear before adding another to the queue. |
|
726 | 732 | if (this.clear_queued) { |
|
727 | 733 | this.clear_output(false); |
|
728 | 734 | }; |
|
729 | 735 | |
|
730 | 736 | this.clear_queued = true; |
|
731 | 737 | } else { |
|
732 | 738 | |
|
733 | 739 | // Fix the output div's height if the clear_output is waiting for |
|
734 | 740 | // new output (it is being used in an animation). |
|
735 | 741 | if (this.clear_queued) { |
|
736 | 742 | var height = this.element.height(); |
|
737 | 743 | this.element.height(height); |
|
738 | 744 | this.clear_queued = false; |
|
739 | 745 | } |
|
740 | 746 | |
|
741 | 747 | // clear all, no need for logic |
|
742 | 748 | this.element.html(""); |
|
743 | 749 | this.outputs = []; |
|
744 | 750 | this.trusted = true; |
|
745 | 751 | this.unscroll_area(); |
|
746 | 752 | return; |
|
747 | 753 | }; |
|
748 | 754 | }; |
|
749 | 755 | |
|
750 | 756 | |
|
751 | 757 | // JSON serialization |
|
752 | 758 | |
|
753 | 759 | OutputArea.prototype.fromJSON = function (outputs) { |
|
754 | 760 | var len = outputs.length; |
|
755 | 761 | var data; |
|
756 | 762 | |
|
757 | 763 | for (var i=0; i<len; i++) { |
|
758 | 764 | data = outputs[i]; |
|
759 | 765 | var msg_type = data.output_type; |
|
760 | 766 | if (msg_type === "display_data" || msg_type === "pyout") { |
|
761 | 767 | // convert short keys to mime keys |
|
762 | 768 | // TODO: remove mapping of short keys when we update to nbformat 4 |
|
763 | 769 | data = this.rename_keys(data, OutputArea.mime_map_r); |
|
764 | 770 | data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map_r); |
|
765 | 771 | } |
|
766 | 772 | |
|
767 | 773 | this.append_output(data); |
|
768 | 774 | } |
|
769 | 775 | }; |
|
770 | 776 | |
|
771 | 777 | |
|
772 | 778 | OutputArea.prototype.toJSON = function () { |
|
773 | 779 | var outputs = []; |
|
774 | 780 | var len = this.outputs.length; |
|
775 | 781 | var data; |
|
776 | 782 | for (var i=0; i<len; i++) { |
|
777 | 783 | data = this.outputs[i]; |
|
778 | 784 | var msg_type = data.output_type; |
|
779 | 785 | if (msg_type === "display_data" || msg_type === "pyout") { |
|
780 | 786 | // convert mime keys to short keys |
|
781 | 787 | data = this.rename_keys(data, OutputArea.mime_map); |
|
782 | 788 | data.metadata = this.rename_keys(data.metadata, OutputArea.mime_map); |
|
783 | 789 | } |
|
784 | 790 | outputs[i] = data; |
|
785 | 791 | } |
|
786 | 792 | return outputs; |
|
787 | 793 | }; |
|
788 | 794 | |
|
789 | 795 | /** |
|
790 | 796 | * Class properties |
|
791 | 797 | **/ |
|
792 | 798 | |
|
793 | 799 | /** |
|
794 | 800 | * Threshold to trigger autoscroll when the OutputArea is resized, |
|
795 | 801 | * typically when new outputs are added. |
|
796 | 802 | * |
|
797 | 803 | * Behavior is undefined if autoscroll is lower than minimum_scroll_threshold, |
|
798 | 804 | * unless it is < 0, in which case autoscroll will never be triggered |
|
799 | 805 | * |
|
800 | 806 | * @property auto_scroll_threshold |
|
801 | 807 | * @type Number |
|
802 | 808 | * @default 100 |
|
803 | 809 | * |
|
804 | 810 | **/ |
|
805 | 811 | OutputArea.auto_scroll_threshold = 100; |
|
806 | 812 | |
|
807 | 813 | /** |
|
808 | 814 | * Lower limit (in lines) for OutputArea to be made scrollable. OutputAreas |
|
809 | 815 | * shorter than this are never scrolled. |
|
810 | 816 | * |
|
811 | 817 | * @property minimum_scroll_threshold |
|
812 | 818 | * @type Number |
|
813 | 819 | * @default 20 |
|
814 | 820 | * |
|
815 | 821 | **/ |
|
816 | 822 | OutputArea.minimum_scroll_threshold = 20; |
|
817 | 823 | |
|
818 | 824 | |
|
819 | 825 | |
|
820 | 826 | OutputArea.mime_map = { |
|
821 | 827 | "text/plain" : "text", |
|
822 | 828 | "text/html" : "html", |
|
823 | 829 | "image/svg+xml" : "svg", |
|
824 | 830 | "image/png" : "png", |
|
825 | 831 | "image/jpeg" : "jpeg", |
|
826 | 832 | "text/latex" : "latex", |
|
827 | 833 | "application/json" : "json", |
|
828 | 834 | "application/javascript" : "javascript", |
|
829 | 835 | }; |
|
830 | 836 | |
|
831 | 837 | OutputArea.mime_map_r = { |
|
832 | 838 | "text" : "text/plain", |
|
833 | 839 | "html" : "text/html", |
|
834 | 840 | "svg" : "image/svg+xml", |
|
835 | 841 | "png" : "image/png", |
|
836 | 842 | "jpeg" : "image/jpeg", |
|
837 | 843 | "latex" : "text/latex", |
|
838 | 844 | "json" : "application/json", |
|
839 | 845 | "javascript" : "application/javascript", |
|
840 | 846 | }; |
|
841 | 847 | |
|
842 | 848 | OutputArea.display_order = [ |
|
843 | 849 | 'application/javascript', |
|
844 | 850 | 'text/html', |
|
845 | 851 | 'text/latex', |
|
846 | 852 | 'image/svg+xml', |
|
847 | 853 | 'image/png', |
|
848 | 854 | 'image/jpeg', |
|
849 | 855 | 'application/pdf', |
|
850 | 856 | 'text/plain' |
|
851 | 857 | ]; |
|
852 | 858 | |
|
853 | 859 | OutputArea.append_map = { |
|
854 | 860 | "text/plain" : append_text, |
|
855 | 861 | "text/html" : append_html, |
|
856 | 862 | "image/svg+xml" : append_svg, |
|
857 | 863 | "image/png" : append_png, |
|
858 | 864 | "image/jpeg" : append_jpeg, |
|
859 | 865 | "text/latex" : append_latex, |
|
860 | 866 | "application/javascript" : append_javascript, |
|
861 | 867 | "application/pdf" : append_pdf |
|
862 | 868 | }; |
|
863 | 869 | |
|
864 | 870 | IPython.OutputArea = OutputArea; |
|
865 | 871 | |
|
866 | 872 | return IPython; |
|
867 | 873 | |
|
868 | 874 | }(IPython)); |
General Comments 0
You need to be logged in to leave comments.
Login now