jaroslav@298
|
1 |
/**
|
jaroslav@298
|
2 |
* Back 2 Browser Bytecode Translator
|
jaroslav@298
|
3 |
* Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
|
jaroslav@298
|
4 |
*
|
jaroslav@298
|
5 |
* This program is free software: you can redistribute it and/or modify
|
jaroslav@298
|
6 |
* it under the terms of the GNU General Public License as published by
|
jaroslav@298
|
7 |
* the Free Software Foundation, version 2 of the License.
|
jaroslav@298
|
8 |
*
|
jaroslav@298
|
9 |
* This program is distributed in the hope that it will be useful,
|
jaroslav@298
|
10 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
jaroslav@298
|
11 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
jaroslav@298
|
12 |
* GNU General Public License for more details.
|
jaroslav@298
|
13 |
*
|
jaroslav@298
|
14 |
* You should have received a copy of the GNU General Public License
|
jaroslav@298
|
15 |
* along with this program. Look for COPYING file in the top folder.
|
jaroslav@298
|
16 |
* If not, see http://opensource.org/licenses/GPL-2.0.
|
jaroslav@298
|
17 |
*/
|
jaroslav@298
|
18 |
package org.apidesign.vm4brwsr;
|
jaroslav@298
|
19 |
|
jaroslav@298
|
20 |
import java.io.IOException;
|
jaroslav@298
|
21 |
import java.io.InputStream;
|
jaroslav@298
|
22 |
|
jaroslav@298
|
23 |
/** Build your own virtual machine! Use methods in this class to generate
|
jaroslav@298
|
24 |
* a skeleton JVM in JavaScript that contains pre-compiled classes of your
|
jaroslav@298
|
25 |
* choice. The generated script defines one JavaScript method that can
|
jaroslav@298
|
26 |
* be used to bootstrap and load the virtual machine: <pre>
|
jaroslav@298
|
27 |
* var vm = bck2brwsr();
|
jaroslav@298
|
28 |
* var main = vm.loadClass('org.your.pkg.Main');
|
jaroslav@298
|
29 |
* main.main__V_3Ljava_lang_String_2(null);
|
jaroslav@298
|
30 |
* </pre>
|
jaroslav@298
|
31 |
* In case one wants to initialize the virtual machine with ability to
|
jaroslav@298
|
32 |
* load classes lazily when needed, one can provide a loader function to
|
jaroslav@298
|
33 |
* when creating the virtual machine: <pre>
|
jaroslav@298
|
34 |
* var vm = bck2brwsr(function(resource) {
|
jaroslav@298
|
35 |
* return null; // byte[] for the resource
|
jaroslav@298
|
36 |
* });
|
jaroslav@298
|
37 |
* </pre>
|
jaroslav@424
|
38 |
* In this scenario, when a request for an unknown class is made, the loader
|
jaroslav@298
|
39 |
* function is asked for its byte code and the system dynamically transforms
|
jaroslav@298
|
40 |
* it to JavaScript.
|
jaroslav@729
|
41 |
* <p>
|
jaroslav@729
|
42 |
* Instead of a loader function, one can also provide a URL to a JAR file.
|
jaroslav@729
|
43 |
* The <code>bck2brwsr</code> system will do its best to download the file
|
jaroslav@729
|
44 |
* and provide loader function for it automatically.
|
jaroslav@729
|
45 |
* <p>
|
jaroslav@729
|
46 |
* One can provide as many loader functions and JAR URL references as necessary.
|
jaroslav@729
|
47 |
* Then the initialization code would look like:<pre>
|
jaroslav@729
|
48 |
* var vm = bck2brwsr(url1, url2, fnctn1, url3, functn2);
|
jaroslav@729
|
49 |
* </pre>
|
jaroslav@729
|
50 |
* The provided URLs and loader functions will be consulted one by one.
|
jaroslav@298
|
51 |
*
|
jaroslav@298
|
52 |
* @author Jaroslav Tulach <jtulach@netbeans.org>
|
jaroslav@298
|
53 |
*/
|
jaroslav@298
|
54 |
public final class Bck2Brwsr {
|
jaroslav@874
|
55 |
private final ObfuscationLevel level;
|
jaroslav@874
|
56 |
private final StringArray classes;
|
jaroslav@874
|
57 |
private final Resources res;
|
jaroslav@874
|
58 |
|
jaroslav@874
|
59 |
private Bck2Brwsr(ObfuscationLevel level, StringArray classes, Resources resources) {
|
jaroslav@874
|
60 |
this.level = level;
|
jaroslav@874
|
61 |
this.classes = classes;
|
jaroslav@874
|
62 |
this.res = resources;
|
jaroslav@298
|
63 |
}
|
jaroslav@874
|
64 |
|
jaroslav@874
|
65 |
/** Helper method to generate virtual machine from bytes served by a <code>resources</code>
|
jaroslav@298
|
66 |
* provider.
|
lubomir@849
|
67 |
*
|
jaroslav@298
|
68 |
* @param out the output to write the generated JavaScript to
|
jaroslav@298
|
69 |
* @param resources provider of class files to use
|
jaroslav@298
|
70 |
* @param classes additional classes to include in the generated script
|
jaroslav@298
|
71 |
* @throws IOException I/O exception can be thrown when something goes wrong
|
jaroslav@298
|
72 |
*/
|
jaroslav@298
|
73 |
public static void generate(Appendable out, Resources resources, String... classes) throws IOException {
|
jaroslav@874
|
74 |
newCompiler().resources(resources).addRootClasses(classes).generate(out);
|
lubomir@849
|
75 |
}
|
lubomir@849
|
76 |
|
jaroslav@874
|
77 |
/** Helper method to generate virtual machine from bytes served by a class loader.
|
lubomir@849
|
78 |
*
|
lubomir@849
|
79 |
* @param out the output to write the generated JavaScript to
|
lubomir@849
|
80 |
* @param loader class loader to load needed classes from
|
lubomir@849
|
81 |
* @param classes additional classes to include in the generated script
|
lubomir@849
|
82 |
* @throws IOException I/O exception can be thrown when something goes wrong
|
lubomir@849
|
83 |
*/
|
lubomir@849
|
84 |
public static void generate(Appendable out, ClassLoader loader, String... classes) throws IOException {
|
jaroslav@874
|
85 |
newCompiler().resources(loader).addRootClasses(classes).generate(out);
|
jaroslav@874
|
86 |
}
|
jaroslav@874
|
87 |
|
jaroslav@874
|
88 |
/** Creates new instance of Bck2Brwsr compiler which is ready to generate
|
jaroslav@874
|
89 |
* empty Bck2Brwsr virtual machine. The instance can be further
|
jaroslav@874
|
90 |
* configured by calling chain of methods. For example:
|
jaroslav@874
|
91 |
* <pre>
|
jaroslav@874
|
92 |
* {@link #createCompiler()}.{@link #resources(org.apidesign.vm4brwsr.Bck2Brwsr.Resources) resources(loader)}.{@link #addRootClasses(java.lang.String[]) addRootClasses("your/Clazz")}.{@link #generate(java.lang.Appendable) generate(out)};
|
jaroslav@874
|
93 |
* </pre>
|
jaroslav@874
|
94 |
*
|
jaroslav@874
|
95 |
* @return new instance of the Bck2Brwsr compiler
|
jaroslav@874
|
96 |
* @since 0.5
|
jaroslav@874
|
97 |
*/
|
jaroslav@874
|
98 |
public static Bck2Brwsr newCompiler() {
|
jaroslav@874
|
99 |
StringArray arr = StringArray.asList(VM.class.getName().replace('.', '/'));
|
jaroslav@874
|
100 |
return new Bck2Brwsr(ObfuscationLevel.NONE, arr, null);
|
lubomir@849
|
101 |
}
|
lubomir@849
|
102 |
|
jaroslav@874
|
103 |
/** Creates new instance of the Bck2Brwsr compiler which inherits
|
jaroslav@874
|
104 |
* all values from <code>this</code> instance and adds additional classes
|
jaroslav@874
|
105 |
* to the list of those that should be compiled by the {@link #generate(java.lang.Appendable)}
|
jaroslav@874
|
106 |
* method.
|
jaroslav@874
|
107 |
*
|
jaroslav@874
|
108 |
* @param classes the classes to add to the compilation
|
jaroslav@874
|
109 |
* @return new instance of the compiler
|
jaroslav@874
|
110 |
*/
|
jaroslav@874
|
111 |
public Bck2Brwsr addRootClasses(String... classes) {
|
jaroslav@874
|
112 |
if (classes.length == 0) {
|
jaroslav@874
|
113 |
return this;
|
jaroslav@874
|
114 |
} else {
|
jaroslav@874
|
115 |
return new Bck2Brwsr(level, this.classes.addAndNew(classes), res);
|
jaroslav@874
|
116 |
}
|
jaroslav@874
|
117 |
}
|
jaroslav@874
|
118 |
|
jaroslav@874
|
119 |
/** Changes the obfuscation level for the compiler by creating new instance
|
jaroslav@874
|
120 |
* which inherits all values from <code>this</code> and adjust the level
|
jaroslav@874
|
121 |
* of obfuscation.
|
jaroslav@874
|
122 |
*
|
jaroslav@874
|
123 |
* @param level the new level of obfuscation
|
jaroslav@874
|
124 |
* @return new instance of the compiler with changed level of obfuscation
|
jaroslav@874
|
125 |
* @since 0.5
|
jaroslav@874
|
126 |
*/
|
jaroslav@874
|
127 |
public Bck2Brwsr obfuscation(ObfuscationLevel level) {
|
jaroslav@874
|
128 |
return new Bck2Brwsr(level, classes, res);
|
jaroslav@874
|
129 |
}
|
jaroslav@874
|
130 |
|
jaroslav@874
|
131 |
/** A way to change the provider of additional resources (classes) for the
|
jaroslav@874
|
132 |
* compiler.
|
jaroslav@874
|
133 |
*
|
jaroslav@874
|
134 |
* @param res the implementation of resources provider
|
jaroslav@874
|
135 |
* @return new instance of the compiler with all values remaining the same, just
|
jaroslav@874
|
136 |
* with different resources provider
|
jaroslav@874
|
137 |
* @since 0.5
|
jaroslav@874
|
138 |
*/
|
jaroslav@874
|
139 |
public Bck2Brwsr resources(Resources res) {
|
jaroslav@874
|
140 |
return new Bck2Brwsr(level, classes, res);
|
jaroslav@874
|
141 |
}
|
jaroslav@874
|
142 |
|
jaroslav@874
|
143 |
/** A way to change the provider of additional resources (classes) for the
|
jaroslav@874
|
144 |
* compiler by specifying classloader to use for loading them.
|
jaroslav@874
|
145 |
*
|
jaroslav@874
|
146 |
* @param loader class loader to load the resources from
|
jaroslav@874
|
147 |
* @return new instance of the compiler with all values being the same, just
|
jaroslav@874
|
148 |
* different resources provider
|
jaroslav@874
|
149 |
* @since 0.5
|
jaroslav@874
|
150 |
*/
|
jaroslav@874
|
151 |
public Bck2Brwsr resources(final ClassLoader loader) {
|
jaroslav@1365
|
152 |
return resources(loader, false);
|
jaroslav@1365
|
153 |
}
|
jaroslav@1365
|
154 |
|
jaroslav@1365
|
155 |
/** A way to change the provider of additional resources (classes) for the
|
jaroslav@1365
|
156 |
* compiler by specifying classloader to use for loading them.
|
jaroslav@1365
|
157 |
*
|
jaroslav@1365
|
158 |
* @param loader class loader to load the resources from
|
jaroslav@1365
|
159 |
* @param ignoreBootClassPath <code>true</code> if classes loaded
|
jaroslav@1365
|
160 |
* from <code>rt.jar</code>
|
jaroslav@1365
|
161 |
* @return new instance of the compiler with all values being the same, just
|
jaroslav@1365
|
162 |
* different resources provider
|
jaroslav@1365
|
163 |
* @since 0.9
|
jaroslav@1365
|
164 |
*/
|
jaroslav@1365
|
165 |
public Bck2Brwsr resources(final ClassLoader loader, boolean ignoreBootClassPath) {
|
jaroslav@1365
|
166 |
return resources(new LdrRsrcs(loader, ignoreBootClassPath));
|
jaroslav@874
|
167 |
}
|
jaroslav@874
|
168 |
|
jaroslav@874
|
169 |
/** Generates virtual machine based on previous configuration of the
|
jaroslav@874
|
170 |
* compiler.
|
lubomir@849
|
171 |
*
|
lubomir@849
|
172 |
* @param out the output to write the generated JavaScript to
|
lubomir@860
|
173 |
* @since 0.5
|
lubomir@849
|
174 |
*/
|
jaroslav@874
|
175 |
public void generate(Appendable out) throws IOException {
|
jaroslav@1359
|
176 |
Resources r = res != null ? res : new LdrRsrcs(Bck2Brwsr.class.getClassLoader(), false);
|
jaroslav@874
|
177 |
if (level != ObfuscationLevel.NONE) {
|
lubomir@849
|
178 |
try {
|
jaroslav@874
|
179 |
ClosureWrapper.produceTo(out, level, r, classes);
|
lubomir@849
|
180 |
return;
|
lubomir@849
|
181 |
} catch (IOException ex) {
|
lubomir@849
|
182 |
throw ex;
|
lubomir@849
|
183 |
} catch (Throwable ex) {
|
lubomir@849
|
184 |
out.append("/* Failed to obfuscate: " + ex.getMessage()
|
lubomir@849
|
185 |
+ " */\n");
|
lubomir@849
|
186 |
}
|
jaroslav@750
|
187 |
}
|
lubomir@849
|
188 |
|
jaroslav@874
|
189 |
VM.compile(r, out, classes);
|
jaroslav@298
|
190 |
}
|
jaroslav@298
|
191 |
|
jaroslav@298
|
192 |
/** Provider of resources (classes and other files). The
|
jaroslav@298
|
193 |
* {@link #generate(java.lang.Appendable, org.apidesign.vm4brwsr.Bck2Brwsr.Resources, java.lang.String[])
|
jaroslav@298
|
194 |
* generator method} will call back here for all classes needed during
|
jaroslav@298
|
195 |
* translation to JavaScript.
|
jaroslav@298
|
196 |
*/
|
jaroslav@298
|
197 |
public interface Resources {
|
jaroslav@298
|
198 |
/** Loads given resource (class or other file like image). The
|
jaroslav@298
|
199 |
* resource name to load bytes for the {@link String} class
|
jaroslav@298
|
200 |
* would be <code>"java/lang/String.class"</code>.
|
jaroslav@298
|
201 |
*
|
jaroslav@298
|
202 |
* @param resource path to resource to load
|
jaroslav@298
|
203 |
* @return the input stream for the resource
|
jaroslav@298
|
204 |
* @throws IOException can be thrown if the loading fails on some error
|
jaroslav@298
|
205 |
* or the file cannot be found
|
jaroslav@298
|
206 |
*/
|
jaroslav@298
|
207 |
public InputStream get(String resource) throws IOException;
|
jaroslav@298
|
208 |
}
|
jaroslav@298
|
209 |
}
|