Support for exporting whole packages. addRootClasses defined in terms of addClasses and addExported.
2 * Back 2 Browser Bytecode Translator
3 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. Look for COPYING file in the top folder.
16 * If not, see http://opensource.org/licenses/GPL-2.0.
18 package org.apidesign.vm4brwsr;
20 import java.io.IOException;
21 import java.io.InputStream;
23 /** Build your own virtual machine! Use methods in this class to generate
24 * a skeleton JVM in JavaScript that contains pre-compiled classes of your
25 * choice. The generated script defines one JavaScript method that can
26 * be used to bootstrap and load the virtual machine: <pre>
27 * var vm = bck2brwsr();
28 * var main = vm.loadClass('org.your.pkg.Main');
29 * main.main__V_3Ljava_lang_String_2(null);
31 * In case one wants to initialize the virtual machine with ability to
32 * load classes lazily when needed, one can provide a loader function to
33 * when creating the virtual machine: <pre>
34 * var vm = bck2brwsr(function(resource) {
35 * return null; // byte[] for the resource
38 * In this scenario, when a request for an unknown class is made, the loader
39 * function is asked for its byte code and the system dynamically transforms
42 * Instead of a loader function, one can also provide a URL to a JAR file.
43 * The <code>bck2brwsr</code> system will do its best to download the file
44 * and provide loader function for it automatically.
46 * One can provide as many loader functions and JAR URL references as necessary.
47 * Then the initialization code would look like:<pre>
48 * var vm = bck2brwsr(url1, url2, fnctn1, url3, functn2);
50 * The provided URLs and loader functions will be consulted one by one.
52 * @author Jaroslav Tulach <jtulach@netbeans.org>
54 public final class Bck2Brwsr {
55 private final ObfuscationLevel level;
56 private final StringArray exported;
57 private final StringArray classes;
58 private final StringArray resources;
59 private final Resources res;
60 private final boolean extension;
62 private Bck2Brwsr(ObfuscationLevel level, StringArray exported, StringArray classes, StringArray resources, Resources res, boolean extension) {
64 this.exported = exported;
65 this.classes = classes;
66 this.resources = resources;
68 this.extension = extension;
71 /** Helper method to generate virtual machine from bytes served by a <code>resources</code>
74 * @param out the output to write the generated JavaScript to
75 * @param resources provider of class files to use
76 * @param classes additional classes to include in the generated script
77 * @throws IOException I/O exception can be thrown when something goes wrong
79 public static void generate(Appendable out, Resources resources, String... classes) throws IOException {
80 newCompiler().resources(resources).addRootClasses(classes).generate(out);
83 /** Helper method to generate virtual machine from bytes served by a class loader.
85 * @param out the output to write the generated JavaScript to
86 * @param loader class loader to load needed classes from
87 * @param classes additional classes to include in the generated script
88 * @throws IOException I/O exception can be thrown when something goes wrong
90 public static void generate(Appendable out, ClassLoader loader, String... classes) throws IOException {
91 newCompiler().resources(loader).addRootClasses(classes).generate(out);
94 /** Creates new instance of Bck2Brwsr compiler which is ready to generate
95 * empty Bck2Brwsr virtual machine. The instance can be further
96 * configured by calling chain of methods. For example:
98 * {@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)};
101 * @return new instance of the Bck2Brwsr compiler
104 public static Bck2Brwsr newCompiler() {
105 return new Bck2Brwsr(ObfuscationLevel.NONE, new StringArray(), new StringArray(), new StringArray(), null, false);
108 /** Adds exported classes or packages. If the string ends
109 * with slash, it is considered a name of package. If it does not,
110 * it is a name of a class (without <code>.class</code> suffix).
111 * The exported classes are prevented from being obfuscated.
112 * All public classes in exported packages are prevented from
113 * being obfuscated. By listing the packages or classes in this
114 * method, these classes are not guaranteed to be included in
115 * the generated script. Use {@link #addClasses} to include
118 * @param exported names of classes and packages to treat as exported
119 * @return new instances of the Bck2Brwsr compiler which inherits
120 * all values from <code>this</code> except list of exported classes
122 public Bck2Brwsr addExported(String... exported) {
123 return new Bck2Brwsr(
124 level, this.exported.addAndNew(exported),
125 classes, resources, res, extension
129 /** Adds additional classes
130 * to the list of those that should be included in the generated
132 * These classes are guaranteed to be available in the
133 * generated virtual machine code accessible using their fully
134 * qualified name. This brings the same behavior as if the
135 * classes were added by {@link #addClasses(java.lang.String...) } and
136 * exported via {@link #addExported(java.lang.String...)}.
138 * @param classes the classes to add to the compilation
139 * @return new instance of the Bck2Brwsr compiler which inherits
140 * all values from <code>this</code>
142 public Bck2Brwsr addRootClasses(String... classes) {
143 if (classes.length == 0) {
146 return addExported(classes).addClasses(classes);
149 /** Adds additional classes
150 * to the list of those that should be included in the generated
151 * JavaScript file. These classes are guaranteed to be present,
152 * but they may not be accessible through their fully qualified
155 * @param classes the classes to add to the compilation
156 * @return new instance of the Bck2Brwsr compiler which inherits
157 * all values from <code>this</code>
160 public Bck2Brwsr addClasses(String... classes) {
161 if (classes.length == 0) {
164 return new Bck2Brwsr(level, exported,
165 this.classes.addAndNew(classes), resources, res,
170 /** These resources should be made available in the compiled file in
171 * binary form. These resources can then be loaded
172 * by {@link ClassLoader#getResource(java.lang.String)} and similar
175 * @param resources names of the resources to be loaded by {@link Resources#get(java.lang.String)}
176 * @return new instance of the Bck2Brwsr compiler which inherits
177 * all values from <code>this</code> just adds few more resource names
181 public Bck2Brwsr addResources(String... resources) {
182 if (resources.length == 0) {
185 return new Bck2Brwsr(level, exported, this.classes,
186 this.resources.addAndNew(resources), res, extension
191 /** Changes the obfuscation level for the compiler by creating new instance
192 * which inherits all values from <code>this</code> and adjust the level
195 * @param level the new level of obfuscation
196 * @return new instance of the compiler with changed level of obfuscation
199 public Bck2Brwsr obfuscation(ObfuscationLevel level) {
200 return new Bck2Brwsr(level, exported, classes, resources, res, extension);
203 /** A way to change the provider of additional resources (classes) for the
206 * @param res the implementation of resources provider
207 * @return new instance of the compiler with all values remaining the same, just
208 * with different resources provider
211 public Bck2Brwsr resources(Resources res) {
212 return new Bck2Brwsr(level, exported, classes, resources, res, extension);
215 /** Should one generate a library? By default the system generates
216 * all transitive classes needed by the the transitive closure of
217 * {@link #addRootClasses(java.lang.String...)} and {@link #addClasses(java.lang.String...)}.
218 * By turning on the library mode, only classes explicitly listed
219 * will be included in the archive. The others will be referenced
222 * @param library turn on the library mode?
223 * @return new instance of the compiler with library flag changed
226 public Bck2Brwsr library(boolean library) {
227 return new Bck2Brwsr(level, exported, classes, resources, res, library);
230 /** A way to change the provider of additional resources (classes) for the
231 * compiler by specifying classloader to use for loading them.
233 * @param loader class loader to load the resources from
234 * @return new instance of the compiler with all values being the same, just
235 * different resources provider
238 public Bck2Brwsr resources(final ClassLoader loader) {
239 return resources(loader, false);
242 /** A way to change the provider of additional resources (classes) for the
243 * compiler by specifying classloader to use for loading them.
245 * @param loader class loader to load the resources from
246 * @param ignoreBootClassPath <code>true</code> if classes loaded
247 * from <code>rt.jar</code>
248 * @return new instance of the compiler with all values being the same, just
249 * different resources provider
252 public Bck2Brwsr resources(final ClassLoader loader, boolean ignoreBootClassPath) {
253 return resources(new LdrRsrcs(loader, ignoreBootClassPath));
256 /** Generates virtual machine based on previous configuration of the
259 * @param out the output to write the generated JavaScript to
262 public void generate(Appendable out) throws IOException {
263 if (level != ObfuscationLevel.NONE) {
265 ClosureWrapper.produceTo(out, level, this);
267 } catch (IOException ex) {
269 } catch (Throwable ex) {
270 out.append("/* Failed to obfuscate: " + ex.getMessage()
275 VM.compile(out, this);
282 Resources getResources() {
283 return res != null ? res : new LdrRsrcs(Bck2Brwsr.class.getClassLoader(), false);
286 StringArray allResources() {
290 StringArray classes() {
294 StringArray exported() {
298 boolean isExtension() {
302 /** Provider of resources (classes and other files). The
303 * {@link #generate(java.lang.Appendable, org.apidesign.vm4brwsr.Bck2Brwsr.Resources, java.lang.String[])
304 * generator method} will call back here for all classes needed during
305 * translation to JavaScript.
307 public interface Resources {
308 /** Loads given resource (class or other file like image). The
309 * resource name to load bytes for the {@link String} class
310 * would be <code>"java/lang/String.class"</code>.
312 * @param resource path to resource to load
313 * @return the input stream for the resource
314 * @throws IOException can be thrown if the loading fails on some error
315 * or the file cannot be found
317 public InputStream get(String resource) throws IOException;