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;
37 private final StringArray asBinary;
40 Appendable out, Bck2Brwsr.Resources resources,
41 StringArray explicitlyExported, StringArray asBinary
44 this.resources = resources;
45 this.classDataCache = new ClassDataCache(resources);
46 this.exportedSymbols = new ExportedSymbols(resources, explicitlyExported);
47 this.invokerMethods = new StringArray();
48 this.asBinary = asBinary;
52 // uses VMLazy to load dynamic classes
53 boolean assertsOn = false;
54 assert assertsOn = true;
62 boolean debug(String msg) throws IOException {
66 static void compile(Appendable out,
68 ) throws IOException {
69 String[] both = config.classes().toArray();
71 final StringArray fixedNames = new StringArray();
72 fixedNames.add(Class.class.getName().replace('.', '/'));
73 fixedNames.add(ArithmeticException.class.getName().replace('.', '/'));
76 if (config.isExtension()) {
77 fixedNames.add(VM.class.getName().replace('.', '/'));
78 vm = new Extension(out,
79 config.getResources(), both, config.exported(),
83 if (config.includeVM()) {
84 fixedNames.add(VM.class.getName().replace('.', '/'));
86 vm = new Standalone(out,
87 config.getResources(), config.exported(),
91 vm.doCompile(fixedNames.addAndNew(both));
94 private void doCompile(StringArray names) throws IOException {
97 "\n var invoker = {};");
99 for (String invokerMethod: invokerMethods.toArray()) {
100 append("\n invoker." + invokerMethod + " = function(target) {"
101 + "\n return function() {"
102 + "\n return target['" + invokerMethod + "'].apply(target, arguments);"
108 for (String r : asBinary.toArray()) {
109 append("\n ").append(getExportsObject()).append("['registerResource']('");
110 append(r).append("', '");
111 InputStream is = this.resources.get(r);
112 byte[] arr = new byte[is.available()];
115 if (offset == arr.length) {
116 byte[] tmp = new byte[arr.length * 2];
117 System.arraycopy(arr, 0, tmp, 0, arr.length);
120 int len = is.read(arr, offset, arr.length - offset);
126 if (offset != arr.length) {
127 byte[] tmp = new byte[offset];
128 System.arraycopy(arr, 0, tmp, 0, offset);
139 @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
140 private static String btoa(byte[] arr) {
141 return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
144 protected abstract void generatePrologue() throws IOException;
146 protected abstract void generateEpilogue() throws IOException;
148 protected abstract String getExportsObject();
150 protected abstract boolean isExternalClass(String className);
153 protected final void declaredClass(ClassData classData, String mangledName)
155 if (exportedSymbols.isExported(classData)) {
156 append("\n").append(getExportsObject()).append("['")
159 .append(accessClass(mangledName))
164 protected String generateClass(String className) throws IOException {
165 ClassData classData = classDataCache.getClassData(className);
166 if (classData == null) {
167 throw new IOException("Can't find class " + className);
169 return compile(classData);
173 protected void declaredField(FieldData fieldData,
175 String mangledName) throws IOException {
176 if (exportedSymbols.isExported(fieldData)) {
177 exportMember(destObject, mangledName);
182 protected void declaredMethod(MethodData methodData,
184 String mangledName) throws IOException {
185 if (isHierarchyExported(methodData)) {
186 exportMember(destObject, mangledName);
190 private void exportMember(String destObject, String memberName)
192 append("\n").append(destObject).append("['")
195 .append(destObject).append(".").append(memberName)
199 private void generateBody(StringArray names) throws IOException {
200 StringArray processed = new StringArray();
201 StringArray initCode = new StringArray();
202 StringArray skipClass = new StringArray();
203 for (String baseClass : names.toArray()) {
204 references.add(baseClass);
207 for (String n : references.toArray()) {
208 if (skipClass.contains(n)) {
211 if (processed.contains(n)) {
219 InputStream is = resources.get(name + ".class");
221 lazyReference(this, name);
226 String ic = generateClass(name);
228 initCode.add(ic == null ? "" : ic);
229 } catch (RuntimeException ex) {
230 throw new IOException("Error while compiling " + name + "\n", ex);
234 for (String resource : scripts.toArray()) {
235 while (resource.startsWith("/")) {
236 resource = resource.substring(1);
238 InputStream emul = resources.get(resource);
240 throw new IOException("Can't find " + resource);
242 readResource(emul, this);
243 asBinary.remove(resource);
245 scripts = new StringArray();
247 StringArray toInit = StringArray.asList(references.toArray());
250 for (String ic : toInit.toArray()) {
251 int indx = processed.indexOf(ic);
253 final String theCode = initCode.toArray()[indx];
254 if (!theCode.isEmpty()) {
255 append(theCode).append("\n");
257 initCode.toArray()[indx] = "";
263 private static void readResource(InputStream emul, Appendable out) throws IOException {
267 int ch = emul.read();
271 if (ch < 0 || ch > 255) {
272 throw new IOException("Invalid char in emulation " + ch);
279 out.append((char)ch);
286 out.append('/').append((char)ch);
309 static String toString(String name) throws IOException {
310 StringBuilder sb = new StringBuilder();
311 // compile(sb, name);
312 return sb.toString().toString();
315 private StringArray scripts = new StringArray();
316 private StringArray references = new StringArray();
319 protected boolean requireReference(String cn) {
320 if (references.contains(cn)) {
328 protected void requireScript(String resourcePath) {
329 scripts.add(resourcePath);
333 String assignClass(String className) {
334 return "vm." + className + " = ";
338 String accessClass(String className) {
339 return "vm." + className;
343 protected String accessField(String object, String mangledName,
344 String[] fieldInfoName) throws IOException {
345 final FieldData field =
346 classDataCache.findField(fieldInfoName[0],
349 return accessNonVirtualMember(object, mangledName,
350 (field != null) ? field.cls : null);
354 protected String accessStaticMethod(
357 String[] fieldInfoName) throws IOException {
358 final MethodData method =
359 classDataCache.findMethod(fieldInfoName[0],
362 return accessNonVirtualMember(object, mangledName,
363 (method != null) ? method.cls : null);
367 protected String accessVirtualMethod(
370 String[] fieldInfoName) throws IOException {
371 final ClassData referencedClass =
372 classDataCache.getClassData(fieldInfoName[0]);
373 final MethodData method =
374 classDataCache.findMethod(referencedClass,
379 && !isExternalClass(method.cls.getClassName())
380 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
381 || ((referencedClass.getAccessFlags()
382 & ByteCodeParser.ACC_FINAL) != 0)
383 || !isHierarchyExported(method))) {
384 return object + "." + mangledName;
387 return accessThroughInvoker(object, mangledName);
390 private String accessThroughInvoker(String object, String mangledName) {
391 if (!invokerMethods.contains(mangledName)) {
392 invokerMethods.add(mangledName);
394 return "invoker." + mangledName + '(' + object + ')';
397 private boolean isHierarchyExported(final MethodData methodData)
399 if (exportedSymbols.isExported(methodData)) {
402 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
403 | ByteCodeParser.ACC_STATIC)) != 0) {
407 final ExportedMethodFinder exportedMethodFinder =
408 new ExportedMethodFinder(exportedSymbols);
410 classDataCache.findMethods(
412 methodData.getName(),
413 methodData.getInternalSig(),
414 exportedMethodFinder);
416 return (exportedMethodFinder.getFound() != null);
419 private String accessNonVirtualMember(String object,
421 ClassData declaringClass) {
422 return ((declaringClass != null)
423 && !isExternalClass(declaringClass.getClassName()))
424 ? object + "." + mangledName
425 : object + "['" + mangledName + "']";
428 private static final class ExportedMethodFinder
429 implements ClassDataCache.TraversalCallback<MethodData> {
430 private final ExportedSymbols exportedSymbols;
431 private MethodData found;
433 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
434 this.exportedSymbols = exportedSymbols;
438 public boolean traverse(final MethodData methodData) {
440 if (exportedSymbols.isExported(methodData)) {
444 } catch (final IOException e) {
450 public MethodData getFound() {
455 private static final class Standalone extends VM {
456 private Standalone(Appendable out,
457 Bck2Brwsr.Resources resources,
458 StringArray explicitlyExported, StringArray asBinary
460 super(out, resources, explicitlyExported, asBinary);
464 protected void generatePrologue() throws IOException {
465 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
469 protected void generateEpilogue() throws IOException {
473 + " var extensions = [];\n"
474 + " function replaceAll(s, target, replacement) {\n"
477 + " var indx = s.indexOf(target, pos);\n"
478 + " if (indx === -1) {\n"
481 + " pos = indx + replacement.length;\n"
482 + " s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
485 + " function mangleClass(name) {\n"
486 + " name = replaceAll(name, '_', '_1');\n"
487 + " name = replaceAll(name, '.', '_');\n"
490 + " global.bck2brwsr = function() {\n"
491 + " var args = Array.prototype.slice.apply(arguments);\n"
492 + " var resources = {};\n"
493 + " function loadExtension(url) {\n"
494 + " var xhr = new XMLHttpRequest();\n"
495 + " xhr.open('GET', url, false);\n"
497 + " var script = document.createElement('script');\n"
498 + " script.type = 'text/javascript';\n"
499 + " script.text = xhr.responseText;\n"
500 + " document.getElementsByTagName('head')[0].appendChild(script);\n"
502 + " function registerResource(n, a64) {\n"
503 + " var str = atob(a64);\n"
505 + " for (var i = 0; i < str.length; i++) {\n"
506 + " var ch = str.charCodeAt(i) & 0xff;\n"
507 + " if (ch > 127) ch -= 256;\n"
510 + " if (!resources[n]) resources[n] = [arr];\n"
511 + " else resources[n].push(arr);\n"
513 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
514 + " function initVM() {\n"
515 + " var clsArray = vm['java_lang_reflect_Array'];\n"
516 + " if (clsArray) clsArray(false);\n"
518 + " for (var i = 0; i < extensions.length; ++i) {\n"
519 + " extensions[i](vm);\n"
521 + " vm['registerResource'] = null;\n"
522 + " var knownExtensions = extensions.length;\n"
523 + " var loader = {};\n"
524 + " var loadBytes = function(name, skip) {\n"
525 + " skip = typeof skip == 'number' ? skip : 0;\n"
526 + " var arr = resources[name];\n"
528 + " var arrSize = arr.length;\n"
529 + " if (skip < arrSize) return arr[skip];\n"
530 + " skip -= arrSize;\n"
532 + " var arrSize = 0;\n"
534 + " for (var i = 0; i < args.length; i++) {\n"
535 + " var at = args[i];\n"
536 + " if(!at) continue;\n"
538 + " if (typeof at === 'string' && at.substring(at.length - 3) === '.js') {\n"
539 + " loadExtension(at);\n"
540 + " args[i] = null;\n"
541 + " } else if (typeof at === 'function') ret = at(name, skip);\n"
543 + " var cp = vm['org_apidesign_vm4brwsr_ClassPath'];\n"
544 + " if (!cp) throw 'Core Java library not registered. Cannot load from ' + at;\n"
545 + " ret = cp(false).\n"
546 + " loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II(name, args, i, skip);\n"
548 + " if (ret) return ret;\n"
550 + " while (knownExtensions < extensions.length) {\n"
551 + " vm['registerResource'] = registerResource;\n"
552 + " extensions[knownExtensions++](vm);\n"
553 + " vm['registerResource'] = null;\n"
556 + " var arr = resources[name];\n"
557 + " return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
559 + " var reload = function(name, arr, keep) {;\n"
561 + " var attr = mangleClass(name);\n"
562 + " delete vm[attr];\n"
564 + " return vm['org_apidesign_vm4brwsr_VMLazy'](false)\n"
565 + " ['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
566 + " (vm, name, args, arr);\n"
568 + " loader.loadClass = function(name) {\n"
569 + " var attr = mangleClass(name);\n"
570 + " var fn = vm[attr];\n"
571 + " if (fn) return fn(false);\n"
573 + " var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
574 + " return reload(name, arr, true);\n"
575 + " } catch (err) {\n"
576 + " fn = vm[attr];\n"
577 + " if (fn) return fn(false);\n"
581 + " if (vm['loadClass']) {\n"
582 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
584 + " vm['loadClass'] = loader.loadClass;\n"
585 + " vm['_reload'] = reload;\n"
586 + " vm['loadBytes'] = loadBytes;\n"
588 + " return loader;\n"
591 " global.bck2brwsr.registerExtension = function(extension) {\n"
592 + " extensions.push(extension);\n"
599 protected String getExportsObject() {
604 protected boolean isExternalClass(String className) {
609 private static final class Extension extends VM {
610 private final StringArray extensionClasses;
612 private Extension(Appendable out, Bck2Brwsr.Resources resources,
613 String[] extClassesArray, StringArray explicitlyExported,
616 super(out, resources, explicitlyExported, asBinary);
617 this.extensionClasses = StringArray.asList(extClassesArray);
621 protected void generatePrologue() throws IOException {
622 append("bck2brwsr.registerExtension(function(exports) {\n"
623 + " var vm = {};\n");
624 append(" function link(n) {\n"
625 + " return function() {\n"
626 + " var cls = n['replace__Ljava_lang_String_2CC']"
627 + "('/', '_').toString();\n"
628 + " var dot = n['replace__Ljava_lang_String_2CC']"
629 + "('/', '.').toString();\n"
630 + " exports.loadClass(dot);\n"
631 + " vm[cls] = exports[cls];\n"
632 + " return vm[cls](arguments);\n"
639 protected void generateEpilogue() throws IOException {
644 protected String generateClass(String className) throws IOException {
645 if (isExternalClass(className)) {
646 append("\n").append(assignClass(
647 className.replace('/', '_')))
655 return super.generateClass(className);
659 protected String getExportsObject() {
664 protected boolean isExternalClass(String className) {
665 return !extensionClasses.contains(className);
669 private static void lazyReference(Appendable out, String n) throws IOException {
670 String cls = n.replace('/', '_');
671 String dot = n.replace('/', '.');
673 out.append("\nvm.").append(cls).append(" = function() {");
674 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
675 out.append("\n delete vm.").append(cls).append(";");
676 out.append("\n var c = vm.loadClass('").append(dot).append("');");
677 out.append("\n return vm.").append(cls).append("(instance);");