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.bck2brwsr.core.JavaScriptBody;
23 import org.apidesign.vm4brwsr.ByteCodeParser.ClassData;
24 import org.apidesign.vm4brwsr.ByteCodeParser.FieldData;
25 import org.apidesign.vm4brwsr.ByteCodeParser.MethodData;
27 /** Generator of JavaScript from bytecode of classes on classpath of the VM.
29 * @author Jaroslav Tulach <jtulach@netbeans.org>
31 abstract class VM extends ByteCodeToJavaScript {
32 protected final ClassDataCache classDataCache;
34 private final Bck2Brwsr.Resources resources;
35 private final ExportedSymbols exportedSymbols;
36 private final StringArray invokerMethods;
38 private static final Class<?> FIXED_DEPENDENCIES[] = {
40 ArithmeticException.class,
44 private VM(Appendable out, Bck2Brwsr.Resources resources, StringArray explicitlyExported) {
46 this.resources = resources;
47 this.classDataCache = new ClassDataCache(resources);
48 this.exportedSymbols = new ExportedSymbols(resources, explicitlyExported);
49 this.invokerMethods = new StringArray();
53 // uses VMLazy to load dynamic classes
54 boolean assertsOn = false;
55 assert assertsOn = true;
63 boolean debug(String msg) throws IOException {
67 static void compile(Appendable out,
69 ) throws IOException {
70 String[] both = config.allClasses();
72 VM vm = config.isExtension() ?
73 new Extension(out, config.getResources(), both, config.rootClasses())
75 new Standalone(out, config.getResources(), config.rootClasses());
77 final StringArray fixedNames = new StringArray();
79 for (final Class<?> fixedClass: FIXED_DEPENDENCIES) {
80 fixedNames.add(fixedClass.getName().replace('.', '/'));
83 vm.doCompile(fixedNames.addAndNew(both), config.allResources());
86 private void doCompile(StringArray names, StringArray asBinary) throws IOException {
89 "\n var invoker = {};");
91 for (String invokerMethod: invokerMethods.toArray()) {
92 append("\n invoker." + invokerMethod + " = function(target) {"
93 + "\n return function() {"
94 + "\n return target['" + invokerMethod + "'].apply(target, arguments);"
100 for (String r : asBinary.toArray()) {
101 append("\n ").append(getExportsObject()).append(".registerResource('");
102 append(r).append("', '");
103 InputStream is = this.resources.get(r);
104 byte[] arr = new byte[is.available()];
107 if (offset == arr.length) {
108 byte[] tmp = new byte[arr.length * 2];
109 System.arraycopy(arr, 0, tmp, 0, arr.length);
112 int len = is.read(arr, offset, arr.length - offset);
118 if (offset != arr.length) {
119 byte[] tmp = new byte[offset];
120 System.arraycopy(arr, 0, tmp, 0, offset);
131 @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
132 private static String btoa(byte[] arr) {
133 return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
136 protected abstract void generatePrologue() throws IOException;
138 protected abstract void generateEpilogue() throws IOException;
140 protected abstract String getExportsObject();
142 protected abstract boolean isExternalClass(String className);
145 protected final void declaredClass(ClassData classData, String mangledName)
147 if (exportedSymbols.isExported(classData)) {
148 append("\n").append(getExportsObject()).append("['")
151 .append(accessClass(mangledName))
156 protected String generateClass(String className) throws IOException {
157 ClassData classData = classDataCache.getClassData(className);
158 if (classData == null) {
159 throw new IOException("Can't find class " + className);
161 return compile(classData);
165 protected void declaredField(FieldData fieldData,
167 String mangledName) throws IOException {
168 if (exportedSymbols.isExported(fieldData)) {
169 exportMember(destObject, mangledName);
174 protected void declaredMethod(MethodData methodData,
176 String mangledName) throws IOException {
177 if (isHierarchyExported(methodData)) {
178 exportMember(destObject, mangledName);
182 private void exportMember(String destObject, String memberName)
184 append("\n").append(destObject).append("['")
187 .append(destObject).append(".").append(memberName)
191 private void generateBody(StringArray names) throws IOException {
192 StringArray processed = new StringArray();
193 StringArray initCode = new StringArray();
194 StringArray skipClass = new StringArray();
195 for (String baseClass : names.toArray()) {
196 references.add(baseClass);
199 for (String n : references.toArray()) {
200 if (skipClass.contains(n)) {
203 if (processed.contains(n)) {
211 InputStream is = resources.get(name + ".class");
213 lazyReference(this, name);
218 String ic = generateClass(name);
220 initCode.add(ic == null ? "" : ic);
221 } catch (RuntimeException ex) {
222 throw new IOException("Error while compiling " + name + "\n", ex);
226 for (String resource : scripts.toArray()) {
227 while (resource.startsWith("/")) {
228 resource = resource.substring(1);
230 InputStream emul = resources.get(resource);
232 throw new IOException("Can't find " + resource);
234 readResource(emul, this);
236 scripts = new StringArray();
238 StringArray toInit = StringArray.asList(references.toArray());
241 for (String ic : toInit.toArray()) {
242 int indx = processed.indexOf(ic);
244 final String theCode = initCode.toArray()[indx];
245 if (!theCode.isEmpty()) {
246 append(theCode).append("\n");
248 initCode.toArray()[indx] = "";
256 + " function mangleClass(name) {\n"
257 + " return name.replace__Ljava_lang_String_2Ljava_lang_CharSequence_2Ljava_lang_CharSequence_2(\n"
258 + " '_', '_1').replace__Ljava_lang_String_2CC('.','_');\n"
260 + " global.bck2brwsr = function() {\n"
261 + " var args = Array.prototype.slice.apply(arguments);\n"
262 + " var vm = fillInVMSkeleton({});\n"
263 + " var loader = {};\n"
264 + " loader.vm = vm;\n"
265 + " loader.loadClass = function(name) {\n"
266 + " var attr = mangleClass(name);\n"
267 + " var fn = vm[attr];\n"
268 + " if (fn) return fn(false);\n"
269 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
270 + " load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
272 + " if (vm.loadClass) {\n"
273 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
275 + " vm.loadClass = loader.loadClass;\n"
276 + " vm._reload = function(name, byteCode) {;\n"
277 + " var attr = mangleClass(name);\n"
278 + " delete vm[attr];\n"
279 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
280 + " reload__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B(loader, name, args, byteCode);\n"
282 + " vm.loadBytes = function(name, skip) {\n"
283 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
284 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, name, args, typeof skip == 'number' ? skip : 0);\n"
286 + " vm.java_lang_reflect_Array(false);\n"
287 + " vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
288 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, null, args, 0);\n"
289 + " return loader;\n"
295 private static void readResource(InputStream emul, Appendable out) throws IOException {
299 int ch = emul.read();
303 if (ch < 0 || ch > 255) {
304 throw new IOException("Invalid char in emulation " + ch);
311 out.append((char)ch);
318 out.append('/').append((char)ch);
341 static String toString(String name) throws IOException {
342 StringBuilder sb = new StringBuilder();
343 // compile(sb, name);
344 return sb.toString().toString();
347 private StringArray scripts = new StringArray();
348 private StringArray references = new StringArray();
351 protected boolean requireReference(String cn) {
352 if (references.contains(cn)) {
360 protected void requireScript(String resourcePath) {
361 scripts.add(resourcePath);
365 String assignClass(String className) {
366 return "vm." + className + " = ";
370 String accessClass(String className) {
371 return "vm." + className;
375 protected String accessField(String object, String mangledName,
376 String[] fieldInfoName) throws IOException {
377 final FieldData field =
378 classDataCache.findField(fieldInfoName[0],
381 return accessNonVirtualMember(object, mangledName,
382 (field != null) ? field.cls : null);
386 protected String accessStaticMethod(
389 String[] fieldInfoName) throws IOException {
390 final MethodData method =
391 classDataCache.findMethod(fieldInfoName[0],
394 return accessNonVirtualMember(object, mangledName,
395 (method != null) ? method.cls : null);
399 protected String accessVirtualMethod(
402 String[] fieldInfoName) throws IOException {
403 final ClassData referencedClass =
404 classDataCache.getClassData(fieldInfoName[0]);
405 final MethodData method =
406 classDataCache.findMethod(referencedClass,
411 && !isExternalClass(method.cls.getClassName())
412 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
413 || ((referencedClass.getAccessFlags()
414 & ByteCodeParser.ACC_FINAL) != 0)
415 || !isHierarchyExported(method))) {
416 return object + "." + mangledName;
419 return accessThroughInvoker(object, mangledName);
422 private String accessThroughInvoker(String object, String mangledName) {
423 if (!invokerMethods.contains(mangledName)) {
424 invokerMethods.add(mangledName);
426 return "invoker." + mangledName + '(' + object + ')';
429 private boolean isHierarchyExported(final MethodData methodData)
431 if (exportedSymbols.isExported(methodData)) {
434 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
435 | ByteCodeParser.ACC_STATIC)) != 0) {
439 final ExportedMethodFinder exportedMethodFinder =
440 new ExportedMethodFinder(exportedSymbols);
442 classDataCache.findMethods(
444 methodData.getName(),
445 methodData.getInternalSig(),
446 exportedMethodFinder);
448 return (exportedMethodFinder.getFound() != null);
451 private String accessNonVirtualMember(String object,
453 ClassData declaringClass) {
454 return ((declaringClass != null)
455 && !isExternalClass(declaringClass.getClassName()))
456 ? object + "." + mangledName
457 : object + "['" + mangledName + "']";
460 private static final class ExportedMethodFinder
461 implements ClassDataCache.TraversalCallback<MethodData> {
462 private final ExportedSymbols exportedSymbols;
463 private MethodData found;
465 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
466 this.exportedSymbols = exportedSymbols;
470 public boolean traverse(final MethodData methodData) {
472 if (exportedSymbols.isExported(methodData)) {
476 } catch (final IOException e) {
482 public MethodData getFound() {
487 private static final class Standalone extends VM {
488 private Standalone(Appendable out, Bck2Brwsr.Resources resources, StringArray explicitlyExported) {
489 super(out, resources, explicitlyExported);
493 protected void generatePrologue() throws IOException {
494 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
498 protected void generateEpilogue() throws IOException {
502 + " var extensions = [];\n"
503 + " function mangleClass(name) {\n"
504 + " return name.replace__Ljava_lang_String_2Ljava_lang_CharSequence_2Ljava_lang_CharSequence_2(\n"
505 + " '_', '_1').replace__Ljava_lang_String_2CC('.','_');\n"
507 + " global.bck2brwsr = function() {\n"
508 + " var args = Array.prototype.slice.apply(arguments);\n"
509 + " var resources = {};\n"
510 + " function registerResource(n, a64) {\n"
511 + " var str = atob(a64);\n"
513 + " for (var i = 0; i < str.length; i++) {\n"
514 + " var ch = str.charCodeAt(i) & 0xff;\n"
515 + " if (ch > 127) ch -= 256;\n"
518 + " if (!resources[n]) resources[n] = [arr];\n"
519 + " else resources[n].push(arr);\n"
521 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
522 + " for (var i = 0; i < extensions.length; ++i) {\n"
523 + " extensions[i](vm);\n"
525 + " vm.registerResource = null;\n"
526 + " var knownExtensions = extensions.length;\n"
527 + " var loader = {};\n"
528 + " loader.vm = vm;\n"
529 + " loader.loadClass = function(name) {\n"
530 + " var attr = mangleClass(name);\n"
531 + " var fn = vm[attr];\n"
532 + " if (fn) return fn(false);\n"
534 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
535 + " load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
536 + " } catch (err) {\n"
537 + " while (knownExtensions < extensions.length) {\n"
538 + " vm.registerResource = registerResource;\n"
539 + " extensions[knownExtensions++](vm);\n"
540 + " vm.registerResource = null;\n"
542 + " fn = vm[attr];\n"
543 + " if (fn) return fn(false);\n"
547 + " if (vm.loadClass) {\n"
548 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
550 + " vm.loadClass = loader.loadClass;\n"
551 + " vm._reload = function(name, byteCode) {;\n"
552 + " var attr = mangleClass(name);\n"
553 + " delete vm[attr];\n"
554 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
555 + " reload__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B(loader, name, args, byteCode);\n"
557 + " vm.loadBytes = function(name, skip) {\n"
558 + " skip = typeof skip == 'number' ? skip : 0;\n"
559 + " var arr = resources[name];\n"
561 + " var arrSize = arr.length;\n"
562 + " if (skip < arrSize) return arr[skip];\n"
563 + " skip -= arrSize;\n"
565 + " var arrSize = 0;\n"
567 + " var ret = vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
568 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, name, args, skip);\n"
569 + " if (ret !== null) return ret;\n"
570 + " while (knownExtensions < extensions.length) {\n"
571 + " vm.registerResource = registerResource;\n"
572 + " extensions[knownExtensions++](vm);\n"
573 + " vm.registerResource = null;\n"
575 + " var arr = resources[name];\n"
576 + " return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
578 + " vm.java_lang_reflect_Array(false);\n"
579 + " vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
580 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, null, args, 0);\n"
581 + " return loader;\n"
584 " global.bck2brwsr.registerExtension = function(extension) {\n"
585 + " extensions.push(extension);\n"
592 protected String getExportsObject() {
597 protected boolean isExternalClass(String className) {
602 private static final class Extension extends VM {
603 private final StringArray extensionClasses;
605 private Extension(Appendable out, Bck2Brwsr.Resources resources,
606 String[] extClassesArray, StringArray explicitlyExported) {
607 super(out, resources, explicitlyExported);
608 this.extensionClasses = StringArray.asList(extClassesArray);
612 protected void generatePrologue() throws IOException {
613 append("bck2brwsr.registerExtension(function(exports) {\n"
614 + " var vm = {};\n");
615 append(" function link(n) {\n"
616 + " return function() {\n"
617 + " var cls = n['replace__Ljava_lang_String_2CC']"
618 + "('/', '_').toString();\n"
619 + " var dot = n['replace__Ljava_lang_String_2CC']"
620 + "('/', '.').toString();\n"
621 + " exports.loadClass(dot);\n"
622 + " vm[cls] = exports[cls];\n"
623 + " return vm[cls](arguments);\n"
630 protected void generateEpilogue() throws IOException {
635 protected String generateClass(String className) throws IOException {
636 if (isExternalClass(className)) {
637 append("\n").append(assignClass(
638 className.replace('/', '_')))
646 return super.generateClass(className);
650 protected String getExportsObject() {
655 protected boolean isExternalClass(String className) {
656 return !extensionClasses.contains(className);
660 private static void lazyReference(Appendable out, String n) throws IOException {
661 String cls = n.replace('/', '_');
662 String dot = n.replace('/', '.');
664 out.append("\nvm.").append(cls).append(" = function() {");
665 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
666 out.append("\n delete vm.").append(cls).append(";");
667 out.append("\n var c = vm.loadClass('").append(dot).append("');");
668 out.append("\n return vm.").append(cls).append("(instance);");