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(Object.class.getName().replace('.', '/'));
73 fixedNames.add(Class.class.getName().replace('.', '/'));
74 fixedNames.add(ArithmeticException.class.getName().replace('.', '/'));
77 if (config.isExtension()) {
78 fixedNames.add(VM.class.getName().replace('.', '/'));
79 vm = new Extension(out,
80 config.getResources(), both, config.exported(),
81 config.allResources(), config.classpath()
84 if (config.includeVM()) {
85 fixedNames.add(VM.class.getName().replace('.', '/'));
87 vm = new Standalone(out,
88 config.getResources(), config.exported(),
92 vm.doCompile(fixedNames.addAndNew(both));
95 private void doCompile(StringArray names) throws IOException {
98 "\n var invoker = {};");
100 for (String invokerMethod: invokerMethods.toArray()) {
101 append("\n invoker." + invokerMethod + " = function() {"
102 + "\n var target = arguments[0];"
103 + "\n return target['" + invokerMethod + "'].apply(target, Array.prototype.slice.call(arguments, 1));"
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,
372 ) throws IOException {
373 final ClassData referencedClass =
374 classDataCache.getClassData(fieldInfoName[0]);
375 final MethodData method =
376 classDataCache.findMethod(referencedClass,
381 && !isExternalClass(method.cls.getClassName())
382 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
383 || ((referencedClass.getAccessFlags()
384 & ByteCodeParser.ACC_FINAL) != 0)
385 || !isHierarchyExported(method))) {
386 return object + "." + mangledName + '(';
389 return accessThroughInvoker(object, mangledName, params > 1 ? "," : "");
392 private String accessThroughInvoker(String object, String mangledName, String sep) {
393 if (!invokerMethods.contains(mangledName)) {
394 invokerMethods.add(mangledName);
396 return "invoker." + mangledName + '(' + object + sep;
399 private boolean isHierarchyExported(final MethodData methodData)
401 if (exportedSymbols.isExported(methodData)) {
404 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
405 | ByteCodeParser.ACC_STATIC)) != 0) {
409 final ExportedMethodFinder exportedMethodFinder =
410 new ExportedMethodFinder(exportedSymbols);
412 classDataCache.findMethods(
414 methodData.getName(),
415 methodData.getInternalSig(),
416 exportedMethodFinder);
418 return (exportedMethodFinder.getFound() != null);
421 private String accessNonVirtualMember(String object,
423 ClassData declaringClass) {
424 return ((declaringClass != null)
425 && !isExternalClass(declaringClass.getClassName()))
426 ? object + "." + mangledName
427 : object + "['" + mangledName + "']";
430 private final class ExportedMethodFinder
431 implements ClassDataCache.TraversalCallback<MethodData> {
432 private final ExportedSymbols exportedSymbols;
433 private MethodData found;
435 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
436 this.exportedSymbols = exportedSymbols;
440 public boolean traverse(final MethodData methodData) {
443 exportedSymbols.isExported(methodData) ||
444 isExternalClass(methodData.cls.getClassName())
449 } catch (final IOException e) {
455 public MethodData getFound() {
460 private static final class Standalone extends VM {
461 private Standalone(Appendable out,
462 Bck2Brwsr.Resources resources,
463 StringArray explicitlyExported, StringArray asBinary
465 super(out, resources, explicitlyExported, asBinary);
469 protected void generatePrologue() throws IOException {
470 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
474 protected void generateEpilogue() throws IOException {
478 + " var extensions = [];\n"
479 + " function replaceAll(s, target, replacement) {\n"
482 + " var indx = s.indexOf(target, pos);\n"
483 + " if (indx === -1) {\n"
486 + " pos = indx + replacement.length;\n"
487 + " s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
490 + " function mangleClass(name) {\n"
491 + " name = replaceAll(name, '_', '_1');\n"
492 + " name = replaceAll(name, '.', '_');\n"
495 + " var pending = [];\n"
496 + " var pendingClasses = [];\n"
497 + " function extensionLoaded(ev) {\n"
498 + " var at = pending.indexOf(ev.target);\n"
499 + " pending.splice(at, 1);\n"
500 + " if (pending.length === 0) {\n"
501 + " for (var i = 0; i < pendingClasses.length; i += 3) {\n"
502 + " invokeMethod(pendingClasses[i], pendingClasses[i + 1], pendingClasses[i + 2]);\n"
504 + " pendingClasses = [];\n"
507 + " function invokeMethod(vm, n, args) {\n"
508 + " var clazz = vm.loadClass(n);\n"
510 + " var seek = args[0];\n"
511 + " var prefix = seek.indexOf('__') == -1 ? seek + '__' : seek;\n"
512 + " args = Array.prototype.slice.call(args, 1);\n"
513 + " var found = '';\n"
514 + " for (var m in clazz) {\n"
515 + " if (m.indexOf(prefix) === 0) {\n"
516 + " return clazz[m].apply(null, args);\n"
518 + " found += m.toString() + '\\n'\n"
520 + " throw 'Cannot find ' + seek + ' in ' + n + ' found:\\n' + found;\n"
523 + " function extensionError(ev) {\n"
524 + " console.log('error loading ' + ev.target.src);\n"
525 + " extensionLoaded(ev);\n"
527 + " function loadExtension(url) {\n"
528 + " if (url.substring(url.length - 4) == '.jar')\n"
529 + " url = url.substring(0, url.length - 4) + '.js';\n"
530 + " var script = document.createElement('script');\n"
531 + " script.type = 'text/javascript';\n"
532 + " script.src = url;\n"
533 + " script.onload = extensionLoaded;\n"
534 + " script.onerror = extensionError;\n"
535 + " document.getElementsByTagName('head')[0].appendChild(script);\n"
536 + " pending.push(script);\n"
538 + " global.bck2brwsr = function() {\n"
539 + " var args = Array.prototype.slice.apply(arguments);\n"
540 + " var resources = {};\n"
541 + " function registerResource(n, a64) {\n"
542 + " var str = atob(a64);\n"
544 + " for (var i = 0; i < str.length; i++) {\n"
545 + " var ch = str.charCodeAt(i) & 0xff;\n"
546 + " if (ch > 127) ch -= 256;\n"
549 + " if (!resources[n]) resources[n] = [arr];\n"
550 + " else resources[n].push(arr);\n"
552 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
553 + " function initVM() {\n"
554 + " var clsArray = vm['java_lang_reflect_Array'];\n"
555 + " if (clsArray) clsArray(false);\n"
557 + " for (var i = 0; i < extensions.length; ++i) {\n"
558 + " extensions[i](vm);\n"
560 + " vm['registerResource'] = null;\n"
561 + " var knownExtensions = extensions.length;\n"
562 + " var loader = {};\n"
563 + " var loadBytes = function(name, skip) {\n"
564 + " skip = typeof skip == 'number' ? skip : 0;\n"
565 + " var arr = resources[name];\n"
567 + " var arrSize = arr.length;\n"
568 + " if (skip < arrSize) return arr[skip];\n"
569 + " skip -= arrSize;\n"
571 + " var arrSize = 0;\n"
573 + " for (var i = 0; i < args.length; i++) {\n"
574 + " var at = args[i];\n"
575 + " if(!at) continue;\n"
577 + " if (typeof at === 'string' && at.substring(at.length - 3) === '.js') {\n"
578 + " loadExtension(at);\n"
579 + " args[i] = null;\n"
580 + " } else if (typeof at === 'function') ret = at(name, skip);\n"
582 + " var cp = vm['org_apidesign_vm4brwsr_ClassPath'];\n"
583 + " if (!cp) throw 'Core Java library not registered. Cannot load from ' + at;\n"
584 + " ret = cp(false).\n"
585 + " loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II(name, args, i, skip);\n"
587 + " if (ret) return ret;\n"
589 + " while (knownExtensions < extensions.length) {\n"
590 + " vm['registerResource'] = registerResource;\n"
591 + " extensions[knownExtensions++](vm);\n"
592 + " vm['registerResource'] = null;\n"
595 + " var arr = resources[name];\n"
596 + " return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
598 + " var reload = function(name, arr, keep) {\n"
599 + " if (!arr) throw 'Cannot find ' + name;\n"
600 + " var lazy = vm['org_apidesign_vm4brwsr_VMLazy'];\n"
601 + " if (!lazy) throw 'No bck2brwsr VM module to compile ' + name;\n"
603 + " var attr = mangleClass(name);\n"
604 + " delete vm[attr];\n"
606 + " return lazy(false)\n"
607 + " ['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
608 + " (vm, name, args, arr);\n"
610 + " var loadClass = function(name) {\n"
611 + " var attr = mangleClass(name);\n"
612 + " var fn = vm[attr];\n"
613 + " if (fn) return fn(false);\n"
615 + " var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
616 + " return reload(name, arr, true);\n"
617 + " } catch (err) {\n"
618 + " fn = vm[attr];\n"
619 + " if (fn) return fn(false);\n"
623 + " if (vm['loadClass']) {\n"
624 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
626 + " vm['loadClass'] = loadClass;\n"
627 + " vm['_reload'] = reload;\n"
628 + " vm['loadBytes'] = loadBytes;\n"
630 + " loader.loadClass = function(name) {\n"
631 + " if (pending.length === 0) {\n"
633 + " var c = loadClass(name);\n"
634 + " c['invoke'] = function() {\n"
635 + " return invokeMethod(vm, name, arguments);\n"
638 + " } catch (err) {\n"
639 + " if (pending.length === 0) throw err;\n"
642 + " pendingClasses.push(vm);\n"
643 + " pendingClasses.push(name);\n"
644 + " pendingClasses.push(null);\n"
646 + " 'invoke' : function() {\n"
647 + " if (pending.length === 0) {\n"
648 + " invokeMethod(vm, name, arguments);\n"
651 + " pendingClasses.push(vm);\n"
652 + " pendingClasses.push(name);\n"
653 + " pendingClasses.push(arguments);\n"
657 + " return loader;\n"
660 " global.bck2brwsr.register = function(config, extension) {\n"
661 + " if (!config || config['magic'] !== 'kafíčko') {\n"
662 + " console.log('Will not register: ' + extension);\n"
665 + " extensions.push(extension);\n"
666 + " var cp = config['classpath'];\n"
667 + " if (cp) for (var i = 0; i < cp.length; i++) {\n"
668 + " loadExtension(cp[i]);\n"
676 protected String getExportsObject() {
681 protected boolean isExternalClass(String className) {
686 private static final class Extension extends VM {
687 private final StringArray extensionClasses;
688 private final StringArray classpath;
690 private Extension(Appendable out, Bck2Brwsr.Resources resources,
691 String[] extClassesArray, StringArray explicitlyExported,
692 StringArray asBinary, StringArray classpath
694 super(out, resources, explicitlyExported, asBinary);
695 this.extensionClasses = StringArray.asList(extClassesArray);
696 this.classpath = classpath;
700 protected void generatePrologue() throws IOException {
702 "bck2brwsr.register({\n"
703 + " 'magic' : 'kafíčko'"
705 if (classpath != null && classpath.toArray().length > 0) {
707 ",\n 'classpath' : [\n"
710 for (String s : classpath.toArray()) {
711 append(sep).append("'").append(s).append("'");
719 "\n}, function(exports) {\n"
720 + " var vm = {};\n");
721 append(" function link(n) {\n"
722 + " return function() {\n"
723 + " var cls = n['replace__Ljava_lang_String_2CC']"
724 + "('/', '_').toString();\n"
725 + " var dot = n['replace__Ljava_lang_String_2CC']"
726 + "('/', '.').toString();\n"
727 + " exports.loadClass(dot);\n"
728 + " vm[cls] = exports[cls];\n"
729 + " return vm[cls](arguments);\n"
736 protected void generateEpilogue() throws IOException {
741 protected String generateClass(String className) throws IOException {
742 if (isExternalClass(className)) {
743 append("\n").append(assignClass(
744 className.replace('/', '_')))
752 return super.generateClass(className);
756 protected String getExportsObject() {
761 protected boolean isExternalClass(String className) {
762 return !extensionClasses.contains(className);
766 private static void lazyReference(Appendable out, String n) throws IOException {
767 String cls = n.replace('/', '_');
768 String dot = n.replace('/', '.');
770 out.append("\nvm.").append(cls).append(" = function() {");
771 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
772 out.append("\n delete vm.").append(cls).append(";");
773 out.append("\n var c = vm.loadClass('").append(dot).append("');");
774 out.append("\n return vm.").append(cls).append("(instance);");