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;
22 import org.apidesign.vm4brwsr.ByteCodeParser.ClassData;
23 import org.apidesign.vm4brwsr.ByteCodeParser.FieldData;
24 import org.apidesign.vm4brwsr.ByteCodeParser.MethodData;
26 /** Generator of JavaScript from bytecode of classes on classpath of the VM.
28 * @author Jaroslav Tulach <jtulach@netbeans.org>
30 abstract class VM extends ByteCodeToJavaScript {
31 protected final ClassDataCache classDataCache;
33 private final Bck2Brwsr.Resources resources;
34 private final ExportedSymbols exportedSymbols;
35 private final StringArray invokerMethods;
37 private VM(Appendable out, Bck2Brwsr.Resources resources) {
39 this.resources = resources;
40 this.classDataCache = new ClassDataCache(resources);
41 this.exportedSymbols = new ExportedSymbols(resources);
42 this.invokerMethods = new StringArray();
46 // uses VMLazy to load dynamic classes
47 boolean assertsOn = false;
48 assert assertsOn = true;
56 boolean debug(String msg) throws IOException {
60 static void compileStandalone(Bck2Brwsr.Resources l, Appendable out, StringArray names) throws IOException {
61 VM vm = new Standalone(out, l);
65 static void compileExtension(Bck2Brwsr.Resources l, Appendable out, StringArray names) throws IOException {
66 VM vm = new Extension(out, l);
70 private void doCompile(StringArray names) throws IOException {
73 "\n var invoker = function Invoker() {"
74 + "\n return Invoker.target[Invoker.method]"
75 + ".apply(Invoker.target, arguments);"
78 for (String invokerMethod: invokerMethods.toArray()) {
79 out.append("\n invoker." + invokerMethod + " = function(target) {"
80 + "\n invoker.target = target;"
81 + "\n invoker.method = '" + invokerMethod + "';"
82 + "\n return invoker;"
89 protected abstract void generatePrologue() throws IOException;
91 protected abstract void generateEpilogue() throws IOException;
93 protected abstract String generateClass(String className)
96 protected abstract String getExportsObject();
99 protected final void declaredClass(ClassData classData, String mangledName)
101 if (exportedSymbols.isExported(classData)) {
102 out.append("\n").append(getExportsObject()).append("['")
105 .append(accessClass(mangledName))
111 protected void declaredField(FieldData fieldData,
113 String mangledName) throws IOException {
114 if (exportedSymbols.isExported(fieldData)) {
115 exportMember(destObject, mangledName);
120 protected void declaredMethod(MethodData methodData,
122 String mangledName) throws IOException {
123 if (exportedSymbols.isExported(methodData)) {
124 exportMember(destObject, mangledName);
128 private void exportMember(String destObject, String memberName)
130 out.append("\n").append(destObject).append("['")
133 .append(destObject).append(".").append(memberName)
137 private void generateBody(StringArray names) throws IOException {
138 StringArray processed = new StringArray();
139 StringArray initCode = new StringArray();
140 for (String baseClass : names.toArray()) {
141 references.add(baseClass);
144 for (String n : references.toArray()) {
145 if (processed.contains(n)) {
155 String ic = generateClass(name);
157 initCode.add(ic == null ? "" : ic);
158 } catch (RuntimeException ex) {
159 if (out instanceof CharSequence) {
160 CharSequence seq = (CharSequence)out;
161 int lastBlock = seq.length();
162 while (lastBlock-- > 0) {
163 if (seq.charAt(lastBlock) == '{') {
167 throw new IOException("Error while compiling " + name + "\n"
168 + seq.subSequence(lastBlock + 1, seq.length()), ex
171 throw new IOException("Error while compiling " + name + "\n"
178 for (String resource : scripts.toArray()) {
179 while (resource.startsWith("/")) {
180 resource = resource.substring(1);
182 InputStream emul = resources.get(resource);
184 throw new IOException("Can't find " + resource);
186 readResource(emul, out);
188 scripts = new StringArray();
190 StringArray toInit = StringArray.asList(references.toArray());
193 for (String ic : toInit.toArray()) {
194 int indx = processed.indexOf(ic);
196 final String theCode = initCode.toArray()[indx];
197 if (!theCode.isEmpty()) {
198 out.append(theCode).append("\n");
200 initCode.toArray()[indx] = "";
206 private static void readResource(InputStream emul, Appendable out) throws IOException {
210 int ch = emul.read();
214 if (ch < 0 || ch > 255) {
215 throw new IOException("Invalid char in emulation " + ch);
222 out.append((char)ch);
229 out.append('/').append((char)ch);
252 static String toString(String name) throws IOException {
253 StringBuilder sb = new StringBuilder();
254 // compile(sb, name);
255 return sb.toString().toString();
258 private StringArray scripts = new StringArray();
259 private StringArray references = new StringArray();
262 protected boolean requireReference(String cn) {
263 if (references.contains(cn)) {
271 protected void requireScript(String resourcePath) {
272 scripts.add(resourcePath);
276 String assignClass(String className) {
277 return "vm." + className + " = ";
281 String accessClass(String className) {
282 return "vm." + className;
286 protected String accessField(String object, String mangledName,
287 String[] fieldInfoName) throws IOException {
288 final FieldData field =
289 classDataCache.findField(fieldInfoName[0],
292 return accessNonVirtualMember(object, mangledName,
293 (field != null) ? field.cls : null);
297 protected String accessStaticMethod(
300 String[] fieldInfoName) throws IOException {
301 final MethodData method =
302 classDataCache.findMethod(fieldInfoName[0],
305 return accessNonVirtualMember(object, mangledName,
306 (method != null) ? method.cls : null);
310 protected String accessVirtualMethod(
313 String[] fieldInfoName) throws IOException {
314 final ClassData referencedClass =
315 classDataCache.getClassData(fieldInfoName[0]);
316 final MethodData method =
317 classDataCache.findMethod(referencedClass,
322 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
323 || ((referencedClass.getAccessFlags()
324 & ByteCodeParser.ACC_FINAL) != 0)
325 || !exportedSymbols.isExported(method))) {
326 return object + "." + mangledName;
329 return accessThroughInvoker(object, mangledName);
332 private String accessThroughInvoker(String object, String mangledName) {
333 if (!invokerMethods.contains(mangledName)) {
334 invokerMethods.add(mangledName);
336 return "invoker." + mangledName + '(' + object + ')';
339 private static String accessNonVirtualMember(String object,
341 ClassData declaringClass) {
342 return (declaringClass != null) ? object + "." + mangledName
343 : object + "['" + mangledName + "']";
346 private static final class Standalone extends VM {
347 private Standalone(Appendable out, Bck2Brwsr.Resources resources) {
348 super(out, resources);
352 protected void generatePrologue() throws IOException {
353 out.append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
357 protected void generateEpilogue() throws IOException {
361 + " var extensions = [];\n"
362 + " global.bck2brwsr = function() {\n"
363 + " var args = Array.prototype.slice.apply(arguments);\n"
364 + " var vm = fillInVMSkeleton({});\n"
365 + " for (var i = 0; i < extensions.length; ++i) {\n"
366 + " extensions[i](vm);\n"
368 + " var loader = {};\n"
369 + " loader.vm = vm;\n"
370 + " loader.loadClass = function(name) {\n"
371 + " var attr = name.replace__Ljava_lang_String_2CC('.','_');\n"
372 + " var fn = vm[attr];\n"
373 + " if (fn) return fn(false);\n"
374 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
375 + " load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
377 + " if (vm.loadClass) {\n"
378 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
380 + " vm.loadClass = loader.loadClass;\n"
381 + " vm.loadBytes = function(name) {\n"
382 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
383 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
385 + " vm.java_lang_reflect_Array(false);\n"
386 + " vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
387 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, null, args);\n"
388 + " return loader;\n"
391 " global.bck2brwsr.registerExtension"
392 + " = function(extension) {\n"
393 + " extensions.push(extension);\n"
395 out.append("}(this));");
399 protected String generateClass(String className) throws IOException {
400 ClassData classData = classDataCache.getClassData(className);
401 if (classData == null) {
402 throw new IOException("Can't find class " + className);
404 return compile(classData);
408 protected String getExportsObject() {
413 private static final class Extension extends VM {
414 private Extension(Appendable out, Bck2Brwsr.Resources resources) {
415 super(out, resources);
419 protected void generatePrologue() throws IOException {
420 out.append("bck2brwsr.registerExtension(function(exports) {\n"
421 + " var vm = {};\n");
422 out.append(" function link(n, inst) {\n"
423 + " var cls = n.replace__Ljava_lang_String_2CC("
424 + "'/', '_').toString();\n"
425 + " var dot = n.replace__Ljava_lang_String_2CC("
426 + "'/', '.').toString();\n"
427 + " exports.loadClass(dot);\n"
428 + " vm[cls] = exports[cls];\n"
429 + " return vm[cls](inst);\n"
434 protected void generateEpilogue() throws IOException {
439 protected String generateClass(String className) throws IOException {
440 ClassData classData = classDataCache.getClassData(className);
441 if (classData == null) {
442 out.append("\n").append(assignClass(
443 className.replace('/', '_')))
444 .append("function() {\n return link('")
446 .append("', arguments.length == 0 || arguments[0] === true);"
452 return compile(classData);
456 protected String getExportsObject() {