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@1583
|
56 |
private final StringArray exported;
|
jaroslav@874
|
57 |
private final StringArray classes;
|
jaroslav@1493
|
58 |
private final StringArray resources;
|
jaroslav@874
|
59 |
private final Resources res;
|
jaroslav@1584
|
60 |
private final Boolean extension;
|
jaroslav@874
|
61 |
|
jaroslav@1584
|
62 |
private Bck2Brwsr(
|
jaroslav@1584
|
63 |
ObfuscationLevel level,
|
jaroslav@1584
|
64 |
StringArray exported, StringArray classes, StringArray resources,
|
jaroslav@1584
|
65 |
Resources res, Boolean extension
|
jaroslav@1584
|
66 |
) {
|
jaroslav@874
|
67 |
this.level = level;
|
jaroslav@1583
|
68 |
this.exported = exported;
|
jaroslav@874
|
69 |
this.classes = classes;
|
jaroslav@1493
|
70 |
this.resources = resources;
|
jaroslav@1493
|
71 |
this.res = res;
|
lubomir@1029
|
72 |
this.extension = extension;
|
jaroslav@298
|
73 |
}
|
jaroslav@874
|
74 |
|
jaroslav@874
|
75 |
/** Helper method to generate virtual machine from bytes served by a <code>resources</code>
|
jaroslav@298
|
76 |
* provider.
|
lubomir@849
|
77 |
*
|
jaroslav@298
|
78 |
* @param out the output to write the generated JavaScript to
|
jaroslav@298
|
79 |
* @param resources provider of class files to use
|
jaroslav@298
|
80 |
* @param classes additional classes to include in the generated script
|
jaroslav@298
|
81 |
* @throws IOException I/O exception can be thrown when something goes wrong
|
jaroslav@298
|
82 |
*/
|
jaroslav@298
|
83 |
public static void generate(Appendable out, Resources resources, String... classes) throws IOException {
|
jaroslav@874
|
84 |
newCompiler().resources(resources).addRootClasses(classes).generate(out);
|
lubomir@849
|
85 |
}
|
lubomir@849
|
86 |
|
jaroslav@874
|
87 |
/** Helper method to generate virtual machine from bytes served by a class loader.
|
lubomir@849
|
88 |
*
|
lubomir@849
|
89 |
* @param out the output to write the generated JavaScript to
|
lubomir@849
|
90 |
* @param loader class loader to load needed classes from
|
lubomir@849
|
91 |
* @param classes additional classes to include in the generated script
|
lubomir@849
|
92 |
* @throws IOException I/O exception can be thrown when something goes wrong
|
lubomir@849
|
93 |
*/
|
lubomir@849
|
94 |
public static void generate(Appendable out, ClassLoader loader, String... classes) throws IOException {
|
jaroslav@874
|
95 |
newCompiler().resources(loader).addRootClasses(classes).generate(out);
|
jaroslav@874
|
96 |
}
|
jaroslav@874
|
97 |
|
jaroslav@874
|
98 |
/** Creates new instance of Bck2Brwsr compiler which is ready to generate
|
jaroslav@874
|
99 |
* empty Bck2Brwsr virtual machine. The instance can be further
|
jaroslav@874
|
100 |
* configured by calling chain of methods. For example:
|
jaroslav@874
|
101 |
* <pre>
|
jaroslav@874
|
102 |
* {@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
|
103 |
* </pre>
|
jaroslav@874
|
104 |
*
|
jaroslav@874
|
105 |
* @return new instance of the Bck2Brwsr compiler
|
jaroslav@874
|
106 |
* @since 0.5
|
jaroslav@874
|
107 |
*/
|
jaroslav@874
|
108 |
public static Bck2Brwsr newCompiler() {
|
jaroslav@1493
|
109 |
return new Bck2Brwsr(ObfuscationLevel.NONE, new StringArray(), new StringArray(), new StringArray(), null, false);
|
lubomir@849
|
110 |
}
|
jaroslav@1583
|
111 |
|
jaroslav@1583
|
112 |
/** Adds exported classes or packages. If the string ends
|
jaroslav@1583
|
113 |
* with slash, it is considered a name of package. If it does not,
|
jaroslav@1583
|
114 |
* it is a name of a class (without <code>.class</code> suffix).
|
jaroslav@1583
|
115 |
* The exported classes are prevented from being obfuscated.
|
jaroslav@1583
|
116 |
* All public classes in exported packages are prevented from
|
jaroslav@1583
|
117 |
* being obfuscated. By listing the packages or classes in this
|
jaroslav@1583
|
118 |
* method, these classes are not guaranteed to be included in
|
jaroslav@1583
|
119 |
* the generated script. Use {@link #addClasses} to include
|
jaroslav@1583
|
120 |
* the classes.
|
jaroslav@1583
|
121 |
*
|
jaroslav@1583
|
122 |
* @param exported names of classes and packages to treat as exported
|
jaroslav@1583
|
123 |
* @return new instances of the Bck2Brwsr compiler which inherits
|
jaroslav@1583
|
124 |
* all values from <code>this</code> except list of exported classes
|
jaroslav@1583
|
125 |
*/
|
jaroslav@1583
|
126 |
public Bck2Brwsr addExported(String... exported) {
|
jaroslav@1583
|
127 |
return new Bck2Brwsr(
|
jaroslav@1583
|
128 |
level, this.exported.addAndNew(exported),
|
jaroslav@1583
|
129 |
classes, resources, res, extension
|
jaroslav@1583
|
130 |
);
|
jaroslav@1583
|
131 |
}
|
lubomir@849
|
132 |
|
jaroslav@1491
|
133 |
/** Adds additional classes
|
jaroslav@1491
|
134 |
* to the list of those that should be included in the generated
|
jaroslav@1491
|
135 |
* JavaScript file.
|
jaroslav@1491
|
136 |
* These classes are guaranteed to be available in the
|
jaroslav@1491
|
137 |
* generated virtual machine code accessible using their fully
|
jaroslav@1491
|
138 |
* qualified name. This brings the same behavior as if the
|
jaroslav@1491
|
139 |
* classes were added by {@link #addClasses(java.lang.String...) } and
|
jaroslav@1583
|
140 |
* exported via {@link #addExported(java.lang.String...)}.
|
jaroslav@874
|
141 |
*
|
jaroslav@874
|
142 |
* @param classes the classes to add to the compilation
|
jaroslav@1491
|
143 |
* @return new instance of the Bck2Brwsr compiler which inherits
|
jaroslav@1491
|
144 |
* all values from <code>this</code>
|
jaroslav@874
|
145 |
*/
|
jaroslav@874
|
146 |
public Bck2Brwsr addRootClasses(String... classes) {
|
jaroslav@874
|
147 |
if (classes.length == 0) {
|
jaroslav@874
|
148 |
return this;
|
jaroslav@1583
|
149 |
}
|
jaroslav@1583
|
150 |
return addExported(classes).addClasses(classes);
|
jaroslav@874
|
151 |
}
|
jaroslav@874
|
152 |
|
jaroslav@1491
|
153 |
/** Adds additional classes
|
jaroslav@1491
|
154 |
* to the list of those that should be included in the generated
|
jaroslav@1491
|
155 |
* JavaScript file. These classes are guaranteed to be present,
|
jaroslav@1491
|
156 |
* but they may not be accessible through their fully qualified
|
jaroslav@1491
|
157 |
* name.
|
jaroslav@1491
|
158 |
*
|
jaroslav@1491
|
159 |
* @param classes the classes to add to the compilation
|
jaroslav@1491
|
160 |
* @return new instance of the Bck2Brwsr compiler which inherits
|
jaroslav@1491
|
161 |
* all values from <code>this</code>
|
jaroslav@1491
|
162 |
* @since 0.9
|
jaroslav@1491
|
163 |
*/
|
jaroslav@1491
|
164 |
public Bck2Brwsr addClasses(String... classes) {
|
jaroslav@1491
|
165 |
if (classes.length == 0) {
|
jaroslav@1491
|
166 |
return this;
|
jaroslav@1491
|
167 |
} else {
|
jaroslav@1583
|
168 |
return new Bck2Brwsr(level, exported,
|
jaroslav@1583
|
169 |
this.classes.addAndNew(classes), resources, res,
|
jaroslav@1491
|
170 |
extension);
|
jaroslav@1491
|
171 |
}
|
jaroslav@1491
|
172 |
}
|
jaroslav@1491
|
173 |
|
jaroslav@1493
|
174 |
/** These resources should be made available in the compiled file in
|
jaroslav@1493
|
175 |
* binary form. These resources can then be loaded
|
jaroslav@1493
|
176 |
* by {@link ClassLoader#getResource(java.lang.String)} and similar
|
jaroslav@1493
|
177 |
* methods.
|
jaroslav@1493
|
178 |
*
|
jaroslav@1493
|
179 |
* @param resources names of the resources to be loaded by {@link Resources#get(java.lang.String)}
|
jaroslav@1493
|
180 |
* @return new instance of the Bck2Brwsr compiler which inherits
|
jaroslav@1493
|
181 |
* all values from <code>this</code> just adds few more resource names
|
jaroslav@1493
|
182 |
* for processing
|
jaroslav@1493
|
183 |
* @since 0.9
|
jaroslav@1493
|
184 |
*/
|
jaroslav@1493
|
185 |
public Bck2Brwsr addResources(String... resources) {
|
jaroslav@1493
|
186 |
if (resources.length == 0) {
|
jaroslav@1493
|
187 |
return this;
|
jaroslav@1493
|
188 |
} else {
|
jaroslav@1583
|
189 |
return new Bck2Brwsr(level, exported, this.classes,
|
jaroslav@1493
|
190 |
this.resources.addAndNew(resources), res, extension
|
jaroslav@1493
|
191 |
);
|
jaroslav@874
|
192 |
}
|
jaroslav@874
|
193 |
}
|
jaroslav@874
|
194 |
|
jaroslav@874
|
195 |
/** Changes the obfuscation level for the compiler by creating new instance
|
jaroslav@874
|
196 |
* which inherits all values from <code>this</code> and adjust the level
|
jaroslav@874
|
197 |
* of obfuscation.
|
jaroslav@874
|
198 |
*
|
jaroslav@874
|
199 |
* @param level the new level of obfuscation
|
jaroslav@874
|
200 |
* @return new instance of the compiler with changed level of obfuscation
|
jaroslav@874
|
201 |
* @since 0.5
|
jaroslav@874
|
202 |
*/
|
jaroslav@874
|
203 |
public Bck2Brwsr obfuscation(ObfuscationLevel level) {
|
jaroslav@1583
|
204 |
return new Bck2Brwsr(level, exported, classes, resources, res, extension);
|
jaroslav@874
|
205 |
}
|
jaroslav@874
|
206 |
|
jaroslav@874
|
207 |
/** A way to change the provider of additional resources (classes) for the
|
jaroslav@874
|
208 |
* compiler.
|
jaroslav@874
|
209 |
*
|
jaroslav@874
|
210 |
* @param res the implementation of resources provider
|
jaroslav@874
|
211 |
* @return new instance of the compiler with all values remaining the same, just
|
jaroslav@874
|
212 |
* with different resources provider
|
jaroslav@874
|
213 |
* @since 0.5
|
jaroslav@874
|
214 |
*/
|
jaroslav@874
|
215 |
public Bck2Brwsr resources(Resources res) {
|
jaroslav@1583
|
216 |
return new Bck2Brwsr(level, exported, classes, resources, res, extension);
|
lubomir@1029
|
217 |
}
|
lubomir@1029
|
218 |
|
jaroslav@1491
|
219 |
/** Should one generate a library? By default the system generates
|
jaroslav@1491
|
220 |
* all transitive classes needed by the the transitive closure of
|
jaroslav@1491
|
221 |
* {@link #addRootClasses(java.lang.String...)} and {@link #addClasses(java.lang.String...)}.
|
jaroslav@1491
|
222 |
* By turning on the library mode, only classes explicitly listed
|
jaroslav@1491
|
223 |
* will be included in the archive. The others will be referenced
|
jaroslav@1491
|
224 |
* as external ones.
|
jaroslav@1491
|
225 |
*
|
jaroslav@1491
|
226 |
* @param library turn on the library mode?
|
jaroslav@1491
|
227 |
* @return new instance of the compiler with library flag changed
|
jaroslav@1491
|
228 |
* @since 0.9
|
jaroslav@1491
|
229 |
*/
|
jaroslav@1491
|
230 |
public Bck2Brwsr library(boolean library) {
|
jaroslav@1583
|
231 |
return new Bck2Brwsr(level, exported, classes, resources, res, library);
|
jaroslav@874
|
232 |
}
|
jaroslav@1584
|
233 |
|
jaroslav@1584
|
234 |
/** Turns on the standalone mode. E.g. acts like {@link #library(boolean) library(false)},
|
jaroslav@1584
|
235 |
* but also allows to specify whether the <em>Bck2Brwsr VM</em> should
|
jaroslav@1584
|
236 |
* be included at all. If not, only the skeleton of the launcher is
|
jaroslav@1584
|
237 |
* generated without any additional VM classes referenced.
|
jaroslav@1584
|
238 |
*
|
jaroslav@1584
|
239 |
* @param includeVM should the VM be compiled in, or left out
|
jaroslav@1584
|
240 |
* @return new instance of the compiler with standalone mode on
|
jaroslav@1584
|
241 |
* @since 0.9
|
jaroslav@1584
|
242 |
*/
|
jaroslav@1584
|
243 |
public Bck2Brwsr standalone(boolean includeVM) {
|
jaroslav@1584
|
244 |
return new Bck2Brwsr(level, exported, classes, resources, res, includeVM ? false : null);
|
jaroslav@1584
|
245 |
}
|
jaroslav@874
|
246 |
|
jaroslav@874
|
247 |
/** A way to change the provider of additional resources (classes) for the
|
jaroslav@874
|
248 |
* compiler by specifying classloader to use for loading them.
|
jaroslav@874
|
249 |
*
|
jaroslav@874
|
250 |
* @param loader class loader to load the resources from
|
jaroslav@874
|
251 |
* @return new instance of the compiler with all values being the same, just
|
jaroslav@874
|
252 |
* different resources provider
|
jaroslav@874
|
253 |
* @since 0.5
|
jaroslav@874
|
254 |
*/
|
jaroslav@874
|
255 |
public Bck2Brwsr resources(final ClassLoader loader) {
|
jaroslav@1365
|
256 |
return resources(loader, false);
|
jaroslav@1365
|
257 |
}
|
jaroslav@1365
|
258 |
|
jaroslav@1365
|
259 |
/** A way to change the provider of additional resources (classes) for the
|
jaroslav@1365
|
260 |
* compiler by specifying classloader to use for loading them.
|
jaroslav@1365
|
261 |
*
|
jaroslav@1365
|
262 |
* @param loader class loader to load the resources from
|
jaroslav@1365
|
263 |
* @param ignoreBootClassPath <code>true</code> if classes loaded
|
jaroslav@1365
|
264 |
* from <code>rt.jar</code>
|
jaroslav@1365
|
265 |
* @return new instance of the compiler with all values being the same, just
|
jaroslav@1365
|
266 |
* different resources provider
|
jaroslav@1365
|
267 |
* @since 0.9
|
jaroslav@1365
|
268 |
*/
|
jaroslav@1365
|
269 |
public Bck2Brwsr resources(final ClassLoader loader, boolean ignoreBootClassPath) {
|
jaroslav@1365
|
270 |
return resources(new LdrRsrcs(loader, ignoreBootClassPath));
|
jaroslav@874
|
271 |
}
|
jaroslav@874
|
272 |
|
jaroslav@874
|
273 |
/** Generates virtual machine based on previous configuration of the
|
jaroslav@874
|
274 |
* compiler.
|
lubomir@849
|
275 |
*
|
lubomir@849
|
276 |
* @param out the output to write the generated JavaScript to
|
lubomir@860
|
277 |
* @since 0.5
|
lubomir@849
|
278 |
*/
|
jaroslav@874
|
279 |
public void generate(Appendable out) throws IOException {
|
jaroslav@874
|
280 |
if (level != ObfuscationLevel.NONE) {
|
lubomir@849
|
281 |
try {
|
jaroslav@1493
|
282 |
ClosureWrapper.produceTo(out, level, this);
|
lubomir@849
|
283 |
return;
|
lubomir@849
|
284 |
} catch (IOException ex) {
|
lubomir@849
|
285 |
throw ex;
|
lubomir@849
|
286 |
} catch (Throwable ex) {
|
lubomir@849
|
287 |
out.append("/* Failed to obfuscate: " + ex.getMessage()
|
lubomir@849
|
288 |
+ " */\n");
|
lubomir@849
|
289 |
}
|
jaroslav@750
|
290 |
}
|
lubomir@849
|
291 |
|
jaroslav@1493
|
292 |
VM.compile(out, this);
|
jaroslav@298
|
293 |
}
|
jaroslav@298
|
294 |
|
jaroslav@1493
|
295 |
//
|
jaroslav@1493
|
296 |
// Internal getters
|
jaroslav@1493
|
297 |
//
|
jaroslav@1493
|
298 |
|
jaroslav@1493
|
299 |
Resources getResources() {
|
jaroslav@1513
|
300 |
return res != null ? res : new LdrRsrcs(Bck2Brwsr.class.getClassLoader(), false);
|
jaroslav@1493
|
301 |
}
|
jaroslav@1493
|
302 |
|
jaroslav@1495
|
303 |
StringArray allResources() {
|
jaroslav@1495
|
304 |
return resources;
|
jaroslav@1495
|
305 |
}
|
jaroslav@1495
|
306 |
|
jaroslav@1583
|
307 |
StringArray classes() {
|
jaroslav@1583
|
308 |
return classes;
|
jaroslav@1583
|
309 |
}
|
jaroslav@1583
|
310 |
|
jaroslav@1583
|
311 |
StringArray exported() {
|
jaroslav@1583
|
312 |
return exported;
|
jaroslav@1493
|
313 |
}
|
jaroslav@1493
|
314 |
|
jaroslav@1493
|
315 |
boolean isExtension() {
|
jaroslav@1584
|
316 |
return Boolean.TRUE.equals(extension);
|
jaroslav@1584
|
317 |
}
|
jaroslav@1584
|
318 |
|
jaroslav@1584
|
319 |
boolean includeVM() {
|
jaroslav@1584
|
320 |
return extension != null;
|
jaroslav@874
|
321 |
}
|
lubomir@1086
|
322 |
|
jaroslav@298
|
323 |
/** Provider of resources (classes and other files). The
|
jaroslav@298
|
324 |
* {@link #generate(java.lang.Appendable, org.apidesign.vm4brwsr.Bck2Brwsr.Resources, java.lang.String[])
|
jaroslav@298
|
325 |
* generator method} will call back here for all classes needed during
|
jaroslav@298
|
326 |
* translation to JavaScript.
|
jaroslav@298
|
327 |
*/
|
jaroslav@298
|
328 |
public interface Resources {
|
jaroslav@298
|
329 |
/** Loads given resource (class or other file like image). The
|
jaroslav@298
|
330 |
* resource name to load bytes for the {@link String} class
|
jaroslav@298
|
331 |
* would be <code>"java/lang/String.class"</code>.
|
jaroslav@298
|
332 |
*
|
jaroslav@298
|
333 |
* @param resource path to resource to load
|
jaroslav@298
|
334 |
* @return the input stream for the resource
|
jaroslav@298
|
335 |
* @throws IOException can be thrown if the loading fails on some error
|
jaroslav@298
|
336 |
* or the file cannot be found
|
jaroslav@298
|
337 |
*/
|
jaroslav@298
|
338 |
public InputStream get(String resource) throws IOException;
|
jaroslav@298
|
339 |
}
|
jaroslav@298
|
340 |
}
|