Using cummulative factory with the hope to prevent enormous increase in overloaded 'generate' methods
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 import java.util.Enumeration;
25 /** Build your own virtual machine! Use methods in this class to generate
26 * a skeleton JVM in JavaScript that contains pre-compiled classes of your
27 * choice. The generated script defines one JavaScript method that can
28 * be used to bootstrap and load the virtual machine: <pre>
29 * var vm = bck2brwsr();
30 * var main = vm.loadClass('org.your.pkg.Main');
31 * main.main__V_3Ljava_lang_String_2(null);
33 * In case one wants to initialize the virtual machine with ability to
34 * load classes lazily when needed, one can provide a loader function to
35 * when creating the virtual machine: <pre>
36 * var vm = bck2brwsr(function(resource) {
37 * return null; // byte[] for the resource
40 * In this scenario, when a request for an unknown class is made, the loader
41 * function is asked for its byte code and the system dynamically transforms
44 * Instead of a loader function, one can also provide a URL to a JAR file.
45 * The <code>bck2brwsr</code> system will do its best to download the file
46 * and provide loader function for it automatically.
48 * One can provide as many loader functions and JAR URL references as necessary.
49 * Then the initialization code would look like:<pre>
50 * var vm = bck2brwsr(url1, url2, fnctn1, url3, functn2);
52 * The provided URLs and loader functions will be consulted one by one.
54 * @author Jaroslav Tulach <jtulach@netbeans.org>
56 public final class Bck2Brwsr {
57 private final ObfuscationLevel level;
58 private final StringArray classes;
59 private final Resources res;
61 private Bck2Brwsr(ObfuscationLevel level, StringArray classes, Resources resources) {
63 this.classes = classes;
67 /** Helper method to generate virtual machine from bytes served by a <code>resources</code>
70 * @param out the output to write the generated JavaScript to
71 * @param resources provider of class files to use
72 * @param classes additional classes to include in the generated script
73 * @throws IOException I/O exception can be thrown when something goes wrong
75 public static void generate(Appendable out, Resources resources, String... classes) throws IOException {
76 newCompiler().resources(resources).addRootClasses(classes).generate(out);
79 /** Helper method to generate virtual machine from bytes served by a class loader.
81 * @param out the output to write the generated JavaScript to
82 * @param loader class loader to load needed classes from
83 * @param classes additional classes to include in the generated script
84 * @throws IOException I/O exception can be thrown when something goes wrong
86 public static void generate(Appendable out, ClassLoader loader, String... classes) throws IOException {
87 newCompiler().resources(loader).addRootClasses(classes).generate(out);
90 /** Creates new instance of Bck2Brwsr compiler which is ready to generate
91 * empty Bck2Brwsr virtual machine. The instance can be further
92 * configured by calling chain of methods. For example:
94 * {@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)};
97 * @return new instance of the Bck2Brwsr compiler
100 public static Bck2Brwsr newCompiler() {
101 StringArray arr = StringArray.asList(VM.class.getName().replace('.', '/'));
102 return new Bck2Brwsr(ObfuscationLevel.NONE, arr, null);
105 /** Creates new instance of the Bck2Brwsr compiler which inherits
106 * all values from <code>this</code> instance and adds additional classes
107 * to the list of those that should be compiled by the {@link #generate(java.lang.Appendable)}
110 * @param classes the classes to add to the compilation
111 * @return new instance of the compiler
113 public Bck2Brwsr addRootClasses(String... classes) {
114 if (classes.length == 0) {
117 return new Bck2Brwsr(level, this.classes.addAndNew(classes), res);
121 /** Changes the obfuscation level for the compiler by creating new instance
122 * which inherits all values from <code>this</code> and adjust the level
125 * @param level the new level of obfuscation
126 * @return new instance of the compiler with changed level of obfuscation
129 public Bck2Brwsr obfuscation(ObfuscationLevel level) {
130 return new Bck2Brwsr(level, classes, res);
133 /** A way to change the provider of additional resources (classes) for the
136 * @param res the implementation of resources provider
137 * @return new instance of the compiler with all values remaining the same, just
138 * with different resources provider
141 public Bck2Brwsr resources(Resources res) {
142 return new Bck2Brwsr(level, classes, res);
145 /** A way to change the provider of additional resources (classes) for the
146 * compiler by specifying classloader to use for loading them.
148 * @param loader class loader to load the resources from
149 * @return new instance of the compiler with all values being the same, just
150 * different resources provider
153 public Bck2Brwsr resources(final ClassLoader loader) {
154 return resources(new LdrRsrcs(loader));
157 /** Generates virtual machine based on previous configuration of the
160 * @param out the output to write the generated JavaScript to
163 public void generate(Appendable out) throws IOException {
164 Resources r = res != null ? res : new LdrRsrcs(Bck2Brwsr.class.getClassLoader());
165 if (level != ObfuscationLevel.NONE) {
167 ClosureWrapper.produceTo(out, level, r, classes);
169 } catch (IOException ex) {
171 } catch (Throwable ex) {
172 out.append("/* Failed to obfuscate: " + ex.getMessage()
177 VM.compile(r, out, classes);
180 /** Provider of resources (classes and other files). The
181 * {@link #generate(java.lang.Appendable, org.apidesign.vm4brwsr.Bck2Brwsr.Resources, java.lang.String[])
182 * generator method} will call back here for all classes needed during
183 * translation to JavaScript.
185 public interface Resources {
186 /** Loads given resource (class or other file like image). The
187 * resource name to load bytes for the {@link String} class
188 * would be <code>"java/lang/String.class"</code>.
190 * @param resource path to resource to load
191 * @return the input stream for the resource
192 * @throws IOException can be thrown if the loading fails on some error
193 * or the file cannot be found
195 public InputStream get(String resource) throws IOException;