add prompts: bookmark name input, zoom loading confirm. base implementation, needs...
[mandelbrot.git] / xulapp / chrome / mandelbrot / content / mandelbrot.js
1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is KaiRo.at Mandelbrot, XULRunner version.
15  *
16  * The Initial Developer of the Original Code is
17  * Robert Kaiser <kairo@kairo.at>.
18  * Portions created by the Initial Developer are Copyright (C) 2008
19  * the Initial Developer. All Rights Reserved.
20  *
21  * Contributor(s):
22  *   Robert Kaiser <kairo@kairo.at>
23  *
24  * Alternatively, the contents of this file may be used under the terms of
25  * either the GNU General Public License Version 2 or later (the "GPL"), or
26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27  * in which case the provisions of the GPL or the LGPL are applicable instead
28  * of those above. If you wish to allow use of your version of this file only
29  * under the terms of either the GPL or the LGPL, and not to allow others to
30  * use your version of this file under the terms of the MPL, indicate your
31  * decision by deleting the provisions above and replace them with the notice
32  * and other provisions required by the GPL or the LGPL. If you do not delete
33  * the provisions above, a recipient may use your version of this file under
34  * the terms of any one of the MPL, the GPL or the LGPL.
35  *
36  * ***** END LICENSE BLOCK ***** */
37
38 var gColorPalette = [];
39 var gPref = Components.classes["@mozilla.org/preferences-service;1"]
40                       .getService(Components.interfaces.nsIPrefService)
41                       .getBranch(null);
42 var gStartTime = 0;
43
44 function Startup() {
45   updateIterMenu();
46   updatePaletteMenu();
47   document.getElementById("statusLabel").value =
48       document.getElementById("mbrotBundle").getString("statusEmpty");
49 }
50
51 function drawImage() {
52   let canvas = document.getElementById("mbrotImage");
53   let context = canvas.getContext("2d");
54
55   document.getElementById("drawButton").hidden = true;
56
57   document.getElementById("statusLabel").value =
58       document.getElementById("mbrotBundle").getString("statusDrawing");
59
60   let Cr_min = -2.0;
61   let Cr_max = 1.0;
62   try {
63     Cr_min = parseFloat(gPref.getCharPref("mandelbrot.last_image.Cr_min"));
64     Cr_max = parseFloat(gPref.getCharPref("mandelbrot.last_image.Cr_max"));
65   }
66   catch (e) { }
67   if ((Cr_min < -2) || (Cr_min > 2) ||
68       (Cr_max < -2) || (Cr_max > 2) || (Cr_min >= Cr_max)) {
69     Cr_min = -2.0; Cr_max = 1.0;
70   }
71   gPref.setCharPref("mandelbrot.last_image.Cr_min", Cr_min);
72   gPref.setCharPref("mandelbrot.last_image.Cr_max", Cr_max);
73
74   let Ci_min = -1.5;
75   let Ci_max = 1.5;
76   try {
77     Ci_min = parseFloat(gPref.getCharPref("mandelbrot.last_image.Ci_min"));
78     Ci_max = parseFloat(gPref.getCharPref("mandelbrot.last_image.Ci_max"));
79   }
80   catch (e) { }
81   if ((Ci_min < -2) || (Ci_min > 2) ||
82       (Ci_max < -2) || (Ci_max > 2) || (Ci_min >= Ci_max)) {
83     Ci_min = -2.0; Ci_max = 1.0;
84   }
85   gPref.setCharPref("mandelbrot.last_image.Ci_min", Ci_min);
86   gPref.setCharPref("mandelbrot.last_image.Ci_max", Ci_max);
87
88   let iterMax = gPref.getIntPref("mandelbrot.iteration_max");
89   let algorithm = gPref.getCharPref("mandelbrot.use_algorithm");
90
91   let iWidth = 0;
92   try {
93     iWidth = gPref.getIntPref("mandelbrot.image.width");
94   }
95   catch (e) { }
96   if ((iWidth < 10) || (iWidth > 5000)) {
97     iWidth = 300;
98     gPref.setIntPref("mandelbrot.image.width", iWidth);
99   }
100   let iHeight = 0;
101   try {
102     iHeight = gPref.getIntPref("mandelbrot.image.height");
103   }
104   catch (e) { }
105   if ((iHeight < 10) || (iHeight > 5000)) {
106     iHeight = 300;
107     gPref.setIntPref("mandelbrot.image.height", iHeight);
108   }
109
110   canvas.width = iWidth;
111   canvas.height = iHeight;
112
113   context.fillStyle = "rgba(255, 255, 255, 127)";
114   context.fillRect(0, 0, canvas.width, canvas.height);
115
116   gStartTime = new Date();
117
118   drawLine(0, [Cr_min, Cr_max, Ci_min, Ci_max],
119               canvas, context, iterMax, algorithm);
120 }
121
122 function drawLine(line, dimensions, canvas, context, iterMax, algorithm) {
123     let Cr_min = dimensions[0];
124     let Cr_max = dimensions[1];
125     let Cr_scale = Cr_max - Cr_min;
126
127     let Ci_min = dimensions[2];
128     let Ci_max = dimensions[3];
129     let Ci_scale = Ci_max - Ci_min;
130
131     let pixels = [];
132     for (var img_y = line; img_y < canvas.height && img_y < line+8; img_y++)
133       for (let img_x = 0; img_x < canvas.width; img_x++) {
134         let C = new complex(Cr_min + (img_x / canvas.width) * Cr_scale,
135                             Ci_min + (img_y / canvas.height) * Ci_scale);
136         pixels.push.apply(pixels, drawPoint(context, img_x, img_y, C, iterMax, algorithm));
137       }
138     context.putImageData({width: canvas.width, height: pixels.length/4/canvas.width, data: pixels}, 0, line);
139
140     if (img_y < canvas.height)
141       setTimeout(drawLine, 0, img_y, dimensions, canvas, context, iterMax, algorithm);
142     else if (gStartTime)
143       EndCalc();
144 }
145
146 function EndCalc() {
147   let endTime = new Date();
148   let timeUsed = (endTime.getTime() - gStartTime.getTime()) / 1000;
149   document.getElementById("statusLabel").value =
150       document.getElementById("mbrotBundle").getFormattedString("statusTime", [timeUsed.toFixed(3)]);
151   gStartTime = 0;
152 }
153
154 function complex(aReal, aImag) {
155   this.r = aReal;
156   this.i = aImag;
157 }
158 complex.prototype = {
159   square: function() {
160     return new complex(this.r * this.r - this.i * this.i,
161                        2 * this.r * this.i);
162   },
163   dist: function() {
164     return Math.sqrt(this.r * this.r + this.i * this.i);
165   },
166   add: function(aComplex) {
167     return new complex(this.r + aComplex.r, this.i + aComplex.i);
168   }
169 }
170
171 function mandelbrotValueOO (aC, aIterMax) {
172   // this would be nice code in general but it looks like JS objects are too heavy for normal use.
173   let Z = new complex(0.0, 0.0);
174   for (var iter = 0; iter < aIterMax; iter++) {
175     Z = Z.square().add(aC);
176     if (Z.r * Z.r + Z.i * Z.i > 256) { break; }
177   }
178   return iter;
179 }
180
181 function mandelbrotValueNumeric (aC, aIterMax) {
182   // optimized numeric code for fast calculation
183   let Cr = aC.r, Ci = aC.i;
184   let Zr = 0.0, Zi = 0.0;
185   let Zr2 = Zr * Zr, Zi2 = Zi * Zi;
186   for (var iter = 0; iter < aIterMax; iter++) {
187     Zi = 2 * Zr * Zi + Ci;
188     Zr = Zr2 - Zi2 + Cr;
189
190     Zr2 = Zr * Zr; Zi2 = Zi * Zi;
191     if (Zr2 + Zi2 > 256) { break; }
192   }
193   return iter;
194 }
195
196 function getColor(aIterValue, aIterMax) {
197   let standardizedValue = Math.round(aIterValue * 1024 / aIterMax);
198   if (gColorPalette && gColorPalette.length)
199     return gColorPalette[standardizedValue];
200
201   // fallback to simple b/w if for some reason we don't have a palette
202   if (aIterValue == aIterMax)
203     return [0, 0, 0, 255];
204   else
205     return [255, 255, 255, 255];
206 }
207
208 function getColorPalette(palName) {
209   var palette = [];
210   switch (palName) {
211     case 'bw':
212       for (let i = 0; i < 1024; i++) {
213         palette[i] = [255, 255, 255, 255];
214       }
215       palette[1024] = [0, 0, 0, 255];
216       break;
217     case 'kairo':
218       // outer areas
219       for (let i = 0; i < 32; i++) {
220         let cc1 = Math.floor(i * 127 / 31);
221         let cc2 = 170 - Math.floor(i * 43 / 31);
222         palette[i] = [cc1, cc2, cc1, 255];
223       }
224       // inner areas
225       for (let i = 0; i < 51; i++) {
226         let cc = Math.floor(i * 170 / 50);
227         palette[32 + i] = [cc, 0, (170-cc), 255];
228       }
229       // corona
230       for (let i = 0; i < 101; i++) {
231         let cc = Math.floor(i * 200 / 100);
232         palette[83 + i] = [255, cc, 0, 255];
233       }
234       // inner corona
235       for (let i = 0; i < 201; i++) {
236         let cc1 = 255 - Math.floor(i * 85 / 200);
237         let cc2 = 200 - Math.floor(i * 30 / 200);
238         let cc3 = Math.floor(i * 170 / 200);
239         palette[184 + i] = [cc1, cc2, cc3, 255];
240       }
241       for (let i = 0; i < 301; i++) {
242         let cc1 = 170 - Math.floor(i * 43 / 300);
243         let cc2 = 170 + Math.floor(i * 85 / 300);
244         palette[385 + i] = [cc1, cc1, cc2, 255];
245       }
246       for (let i = 0; i < 338; i++) {
247         let cc = 127 + Math.floor(i * 128 / 337);
248         palette[686 + i] = [cc, cc, 255, 255];
249       }
250       palette[1024] = [0, 0, 0, 255];
251       break;
252     case 'rainbow-linear1':
253       for (let i = 0; i < 256; i++) {
254         palette[i] = [i, 0, 0, 255];
255         palette[256 + i] = [255, i, 0, 255];
256         palette[512 + i] = [255 - i, 255, i, 255];
257         palette[768 + i] = [i, 255-i, 255, 255];
258       }
259       palette[1024] = [0, 0, 0, 255];
260       break;
261   }
262 /*
263 Select Case palnr
264 Case 1  'Standard-Palette (QB-Colors)
265      For i = 0 To 1024
266          xx = CInt(i * 500 / 1024 + 2)
267          If xx <= 15 Then clr = xx
268          If xx > 15 Then clr = CInt(Sqr((xx - 15 + 1) * 15 ^ 2 / 485))
269          If xx >= 500 Then clr = 0
270          palette(i) = QBColor(clr)
271      Next
272 Case 3  'Regenbogen-Palette 1 (qu.)
273      For i = 0 To 33
274          clr = CInt(i * 255 / 33)
275          palette(i) = RGB(clr, 0, 0)
276      Next
277      For i = 0 To 136
278          clr = CInt(i * 255 / 136)
279          palette(34 + i) = RGB(255, clr, 0)
280      Next
281      For i = 0 To 306
282          clr = CInt(i * 255 / 306)
283          palette(171 + i) = RGB(255 - clr, 255, clr)
284      Next
285      For i = 0 To 545
286          clr = CInt(i * 255 / 545)
287          palette(478 + i) = RGB(clr, 255 - clr, 255)
288      Next
289 Case 4  'Regenbogen-Palette 2 (linear)
290      For i = 0 To 204
291          clr = CInt(i * 255 / 204)
292          palette(i) = RGB(255, clr, 0)
293          palette(204 + i) = RGB(255 - clr, 255, 0)
294          palette(409 + i) = RGB(0, 255, clr)
295          palette(614 + i) = RGB(0, 255 - clr, 255)
296          palette(819 + i) = RGB(clr, 0, 255)
297      Next
298 Case 5  'Regenbogen-Palette 2 (qu.)
299      For i = 0 To 18
300          clr = CInt(i * 255 / 18)
301          palette(i) = RGB(255, clr, 0)
302      Next
303      For i = 0 To 73
304          clr = CInt(i * 255 / 73)
305          palette(20 + i) = RGB(255 - clr, 255, 0)
306      Next
307      For i = 0 To 167
308          clr = CInt(i * 255 / 167)
309          palette(93 + i) = RGB(0, 255, clr)
310      Next
311      For i = 0 To 297
312          clr = CInt(i * 255 / 297)
313          palette(261 + i) = RGB(0, 255 - clr, 255)
314      Next
315      For i = 0 To 464
316          clr = CInt(i * 255 / 464)
317          palette(559 + i) = RGB(clr, 0, 255)
318      Next
319 */
320   return palette;
321 }
322
323 function drawPoint(context, img_x, img_y, C, iterMax, algorithm) {
324   var itVal;
325   switch (algorithm) {
326     case 'oo':
327       itVal = mandelbrotValueOO(C, iterMax);
328       break;
329     case 'numeric':
330     default:
331       itVal = mandelbrotValueNumeric(C, iterMax);
332       break;
333   }
334   return getColor(itVal, iterMax);
335 }
336
337 /***** pure UI functions *****/
338
339 var zoomstart;
340
341 function mouseevent(etype, event) {
342   let canvas = document.getElementById("mbrotImage");
343   switch (etype) {
344     case 'down':
345       if (event.button == 0)
346         // left button - start dragzoom
347         zoomstart = {x: event.clientX - canvas.offsetLeft,
348                      y: event.clientY - canvas.offsetTop};
349       break;
350     case 'up':
351       if (event.button == 0) {
352         var prompts = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
353                                 .getService(Components.interfaces.nsIPromptService);
354         var ok = prompts.confirm(null, "XXX Zoom in",
355             zoomstart.x + ',' + zoomstart.y + '-' +
356             (event.clientX - canvas.offsetLeft) + ',' +
357             (event.clientY - canvas.offsetTop));
358         // ok is now true if OK was clicked, and false if cancel was clicked
359       }
360       zoomstart = undefined;
361     break;
362   }
363 }
364
365 function saveImage() {
366   const bundle = document.getElementById("mbrotBundle");
367   const nsIFilePicker = Components.interfaces.nsIFilePicker;
368   var fp = null;
369   try {
370     fp = Components.classes["@mozilla.org/filepicker;1"]
371                    .createInstance(nsIFilePicker);
372   } catch (e) {}
373   if (!fp) return;
374   var promptString = bundle.getString("savePrompt");
375   fp.init(window, promptString, nsIFilePicker.modeSave);
376   fp.appendFilter(bundle.getString("pngFilterName"), "*.png");
377   fp.defaultString = "mandelbrot.png";
378
379   var fpResult = fp.show();
380   if (fpResult != nsIFilePicker.returnCancel) {
381     saveCanvas(document.getElementById("mbrotImage"), fp.file);
382   }
383 }
384
385 function updateBookmarkMenu(aParent) {
386   document.getElementById("bookmarkSave").disabled =
387     (!document.getElementById("drawButton").hidden || (gStartTime > 0));
388
389   while (aParent.hasChildNodes() &&
390          aParent.lastChild.id != 'bookmarkSeparator')
391     aParent.removeChild(aParent.lastChild);
392
393   var file = Components.classes["@mozilla.org/file/directory_service;1"]
394                        .getService(Components.interfaces.nsIProperties)
395                        .get("ProfD", Components.interfaces.nsIFile);
396   file.append("mandelbookmarks.sqlite");
397   if (file.exists()) {
398     var connection = Components.classes["@mozilla.org/storage/service;1"]
399                                .getService(Components.interfaces.mozIStorageService)
400                                .openDatabase(file);
401     try {
402       if (connection.tableExists("bookmarks")) {
403         var statement = connection.createStatement(
404             "SELECT name FROM bookmarks ORDER BY ROWID DESC");
405         while (statement.executeStep())
406           aParent.appendChild(document.createElement("menuitem"))
407                  .setAttribute("label", statement.getString(0));
408         statement.reset();
409         statement.finalize();
410         return;
411       }
412     } finally {
413       connection.close();
414     }
415   }
416   // Create the "Nothing Available" Menu item and disable it.
417   var na = aParent.appendChild(document.createElement("menuitem"));
418   na.setAttribute("label",
419                   document.getElementById("mbrotBundle").getString("noBookmarks"));
420   na.setAttribute("disabled", "true");
421 }
422
423 function callBookmark(evtarget) {
424 }
425
426 function saveBookmark() {
427   // retrieve wanted bookmark name with a prompt
428   var mbrotBundle = document.getElementById("mbrotBundle");
429   var prompts = Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
430                           .getService(Components.interfaces.nsIPromptService);
431   var input = {value: ""}; // empty default value
432   var ok = prompts.prompt(null, "XXX Title", "XXX Please enter a name for the bookmark", input, null, {});
433   // ok is true if OK is pressed, false if Cancel. input.value holds the value of the edit field if "OK" was pressed.
434   if (!ok || !input.value)
435     return
436
437   var bmName = input.value;
438
439   // Open or create the bookmarks database.
440   var file = Components.classes["@mozilla.org/file/directory_service;1"]
441                        .getService(Components.interfaces.nsIProperties)
442                        .get("ProfD", Components.interfaces.nsIFile);
443   file.append("mandelbookmarks.sqlite");
444   var connection = Components.classes["@mozilla.org/storage/service;1"]
445                              .getService(Components.interfaces.mozIStorageService)
446                              .openDatabase(file);
447   connection.beginTransaction();
448   if (!connection.tableExists("bookmarks"))
449     connection.createTable("bookmarks", "name TEXT, iteration_max INTEGER, Cr_min REAL, Cr_max REAL, Ci_min REAL, Ci_max REAL");
450   // NULL. The value is a NULL value.
451   // INTEGER. The value is a signed integer, stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the value.
452   // REAL. The value is a floating point value, stored as an 8-byte IEEE floating point number.
453   // TEXT. The value is a text string, stored using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
454
455   // Put value of the current image into the bookmarks table
456   var statement = connection.createStatement(
457       "INSERT INTO bookmarks (name,iteration_max,Cr_min,Cr_max,Ci_min,Ci_max) VALUES (?1,?2,?3,?4,?5,?6)");
458   statement.bindStringParameter(0, bmName);
459   statement.bindStringParameter(1, gPref.getIntPref("mandelbrot.iteration_max"));
460   statement.bindStringParameter(2, parseFloat(gPref.getCharPref("mandelbrot.last_image.Cr_min")));
461   statement.bindStringParameter(3, parseFloat(gPref.getCharPref("mandelbrot.last_image.Cr_max")));
462   statement.bindStringParameter(4, parseFloat(gPref.getCharPref("mandelbrot.last_image.Ci_min")));
463   statement.bindStringParameter(5, parseFloat(gPref.getCharPref("mandelbrot.last_image.Ci_max")));
464   statement.execute();
465   statement.finalize();
466   connection.commitTransaction();
467   connection.close();
468 }
469
470 function updateIterMenu() {
471   try {
472     var currentIter = gPref.getIntPref("mandelbrot.iteration_max");
473   }
474   catch(e) {
475     var currentIter = 0;
476   }
477   if (currentIter < 10) {
478     currentIter = 500;
479     setIter(currentIter);
480   }
481
482   var popup = document.getElementById("menu_iterPopup");
483   var item = popup.firstChild;
484   while (item) {
485     if (item.getAttribute("name") == "iter") {
486       if (item.getAttribute("value") == currentIter)
487         item.setAttribute("checked","true");
488       else
489         item.removeAttribute("checked");
490     }
491     item = item.nextSibling;
492   }
493 }
494
495 function setIter(aIter) {
496   gPref.setIntPref("mandelbrot.iteration_max", aIter);
497 }
498
499 function updatePaletteMenu() {
500   try {
501     var currentPalette = gPref.getCharPref("mandelbrot.color_palette");
502   }
503   catch(e) {
504     var currentPalette = '';
505   }
506   if (!currentPalette.length) {
507     currentPalette = 'kairo';
508     setPalette(currentPalette);
509   }
510   if (!gColorPalette || !gColorPalette.length)
511     gColorPalette = getColorPalette(currentPalette);
512
513   var popup = document.getElementById("menu_palettePopup");
514   var item = popup.firstChild;
515   while (item) {
516     if (item.getAttribute("name") == "palette") {
517       if (item.getAttribute("value") == currentPalette)
518         item.setAttribute("checked", "true");
519       else
520         item.removeAttribute("checked");
521     }
522     item = item.nextSibling;
523   }
524 }
525
526 function setPalette(aPaletteID) {
527   gPref.setCharPref("mandelbrot.color_palette", aPaletteID);
528   gColorPalette = getColorPalette(aPaletteID);
529 }
530
531 function imgSettings() {
532   window.openDialog("chrome://mandelbrot/content/image-settings.xul");
533 }
534
535 function updateDebugMenu() {
536   var jitMenuItem = document.getElementById("jitEnabled");
537   jitMenuItem.setAttribute("checked", gPref.getBoolPref("javascript.options.jit.chrome"));
538 }
539
540 function toggleJITState(jitMenuItem) {
541   var jitEnabled = !gPref.getBoolPref("javascript.options.jit.chrome");
542   gPref.setBoolPref("javascript.options.jit.chrome", jitEnabled)
543   jitMenuItem.setAttribute("checked", jitEnabled? "true" : "false");
544 }
545
546 function updateAlgoMenu() {
547   try {
548     var currentAlgo = gPref.getCharPref("mandelbrot.use_algorithm");
549   }
550   catch(e) {
551     var currentAlgo = '';
552   }
553   if (!currentAlgo.length) {
554     currentAlgo = 'numeric';
555     setAlgorithm(currentAlgo);
556   }
557
558   var popup = document.getElementById("menu_algoPopup");
559   var item = popup.firstChild;
560   while (item) {
561     if (item.getAttribute("name") == "algorithm") {
562       if (item.getAttribute("value") == currentAlgo)
563         item.setAttribute("checked", "true");
564       else
565         item.removeAttribute("checked");
566     }
567     item = item.nextSibling;
568   }
569 }
570
571 function setAlgorithm(algoID) {
572   gPref.setCharPref("mandelbrot.use_algorithm", algoID);
573 }
574
575 function addonsManager(aPane) {
576   var theEM = Components.classes["@mozilla.org/appshell/window-mediator;1"]
577                         .getService(Components.interfaces.nsIWindowMediator)
578                         .getMostRecentWindow("Extension:Manager");
579   if (theEM) {
580     theEM.focus();
581     if (aPane)
582       theEM.showView(aPane);
583     return;
584   }
585
586   const EMURL = "chrome://mozapps/content/extensions/extensions.xul";
587   const EMFEATURES = "all,dialog=no";
588   if (aPane)
589     window.openDialog(EMURL, "", EMFEATURES, aPane);
590   else
591     window.openDialog(EMURL, "", EMFEATURES);
592 }
593
594 function errorConsole() {
595   toOpenWindowByType("global:console", "chrome://global/content/console.xul");
596 }
597
598 /***** helper functions from external sources *****/
599
600 // function below is based on http://developer.mozilla.org/en/docs/Code_snippets:Canvas
601 // custom modifications:
602 //   - use "a"-prefix on function arguments
603 //   - take an nsILocalFile as aDestFile argument
604 //   - always do silent download
605 function saveCanvas(aCanvas, aDestFile) {
606   // create a data url from the canvas and then create URIs of the source and targets  
607   var io = Components.classes["@mozilla.org/network/io-service;1"]
608                      .getService(Components.interfaces.nsIIOService);
609   var source = io.newURI(aCanvas.toDataURL("image/png", ""), "UTF8", null);
610
611   // prepare to save the canvas data
612   var persist = Components.classes["@mozilla.org/embedding/browser/nsWebBrowserPersist;1"]
613                           .createInstance(Components.interfaces.nsIWebBrowserPersist);
614
615   persist.persistFlags = Components.interfaces.nsIWebBrowserPersist.PERSIST_FLAGS_REPLACE_EXISTING_FILES;
616   persist.persistFlags |= Components.interfaces.nsIWebBrowserPersist.PERSIST_FLAGS_AUTODETECT_APPLY_CONVERSION;
617
618   // save the canvas data to the file
619   persist.saveURI(source, null, null, null, null, aDestFile);
620 }
621
622 // function below is from http://developer.mozilla.org/en/docs/How_to_Quit_a_XUL_Application
623 function quitApp(aForceQuit) {
624   var appStartup = Components.classes['@mozilla.org/toolkit/app-startup;1']
625                              .getService(Components.interfaces.nsIAppStartup);
626
627   // eAttemptQuit will try to close each XUL window, but the XUL window can cancel the quit
628   // process if there is unsaved data. eForceQuit will quit no matter what.
629   var quitSeverity = aForceQuit ? Components.interfaces.nsIAppStartup.eForceQuit :
630                                   Components.interfaces.nsIAppStartup.eAttemptQuit;
631   appStartup.quit(quitSeverity);
632 }
633
634 // functions below are from comm-central/suite/common/tasksOverlay.js
635 function toOpenWindow(aWindow) {
636   try {
637     // Try to focus the previously focused window e.g. message compose body
638     aWindow.document.commandDispatcher.focusedWindow.focus();
639   } catch (e) {
640     // e.g. full-page plugin or non-XUL document; just raise the top window
641     aWindow.focus();
642   }
643 }
644
645 function toOpenWindowByType(inType, uri, features) {
646   // don't do several loads in parallel
647   if (uri in window)
648     return;
649
650   var topWindow = Components.classes["@mozilla.org/appshell/window-mediator;1"]
651                             .getService(Components.interfaces.nsIWindowMediator)
652                             .getMostRecentWindow(inType);
653   if ( topWindow )
654     toOpenWindow( topWindow );
655   else {
656     // open the requested window, but block it until it's fully loaded
657     function newWindowLoaded(event) {
658       // make sure that this handler is called only once
659       window.removeEventListener("unload", newWindowLoaded, false);
660       window[uri].removeEventListener("load", newWindowLoaded, false);
661       delete window[uri];
662     }
663     // remember the newly loading window until it's fully loaded
664     // or until the current window passes away
665     window[uri] = window.openDialog(uri, "", features || "all,dialog=no");
666     window[uri].addEventListener("load", newWindowLoaded, false);
667     window.addEventListener("unload", newWindowLoaded, false);
668   }
669 }