Help generation: add the ability to generate an image from inlined Scilab code
[scilab.git] / scilab / modules / helptools / src / java / org / scilab / modules / helptools / image / ScilabImageConverter.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12
13 package org.scilab.modules.helptools.image;
14
15 import java.io.BufferedOutputStream;
16 import java.io.BufferedReader;
17 import java.io.File;
18 import java.io.FileInputStream;
19 import java.io.FileNotFoundException;
20 import java.io.FileOutputStream;
21 import java.io.FileReader;
22 import java.io.IOException;
23 import java.io.OutputStream;
24 import java.util.Map;
25
26 import org.scilab.modules.commons.ScilabCommons;
27
28 /**
29  * Scilab code to PNG converter
30  */
31 public class ScilabImageConverter implements ExternalImageConverter {
32
33     private static ScilabImageConverter instance;
34     private final StringBuilder buffer;
35
36     private ScilabImageConverter() {
37         buffer = new StringBuilder(8192);
38     }
39
40     public String getMimeType() {
41         return "image/scilab";
42     }
43
44     public String getFileWithScilabCode() {
45         if (buffer.length() != 0) {
46             try {
47                 File f = File.createTempFile("help-", ".sce", new File(ScilabCommons.getTMPDIR()));
48                 BufferedOutputStream out = new BufferedOutputStream(new FileOutputStream(f));
49                 byte[] arr = buffer.toString().getBytes();
50                 out.write(arr, 0, arr.length);
51                 out.flush();
52                 out.close();
53
54                 return f.getAbsolutePath();
55             } catch (Exception e) {
56                 System.err.println("Cannot generate the file with Scilab code to execute:\n" + e);
57             } finally {
58                 instance = null;
59             }
60         }
61
62         instance = null;
63
64         return null;
65     }
66
67     /**
68      * Since this a singleton class...
69      * @return this
70      */
71     public static ScilabImageConverter getInstance() {
72         if (instance == null) {
73             instance = new ScilabImageConverter();
74         }
75
76         return instance;
77     }
78
79     /**
80      * {@inheritDoc}
81      */
82     public String convertToImage(String currentFile, String code, Map<String, String> attributes, File imageFile, String imageName) {
83         code = code.replace("<image>", "").replace("</image>", "");
84         return convertToPNG(currentFile, code, imageFile, imageName);
85     }
86
87     /**
88      * {@inheritDoc}
89      */
90     public String convertToImage(File code, Map<String, String> attributes, File imageFile, String imageName) {
91         try {
92             BufferedReader in = new BufferedReader(new FileReader(code));
93             StringBuilder buffer = new StringBuilder(8192);
94             String line;
95
96             while ((line = in.readLine()) != null) {
97                 buffer.append(line).append("\n");
98             }
99
100             in.close();
101
102             return convertToPNG(code.getName(), buffer.toString(), imageFile, imageName);
103         } catch (Exception e) {
104             System.err.println("Problem when exporting Scilab code to " + imageFile + "!\n" + e.toString());
105         }
106
107         return null;
108     }
109
110     private final String convertToPNG(String currentFile, String code, File imageFile, String imageName) {
111         buffer.append("__olddrv__=driver();\n");
112         buffer.append("disp(\"Generate image " + imageName + " from Scilab code in file " + new File(currentFile).getName() + "\");\n");
113         buffer.append("driver(\"png\");\n");
114         buffer.append("xinit(\"").append(imageFile.getAbsolutePath()).append("\");\n");
115         buffer.append(code).append("\n");
116         buffer.append("xend();\n");
117         buffer.append("driver(__olddrv__);\n");
118
119         return "<img src=\'" + imageName + "\'/>";
120     }
121 }