2 * Back 2 Browser Bytecode Translator
3 * Copyright (C) 2012-2015 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 StringBuilder invokerMethods;
37 private final StringArray asBinary;
41 Appendable out, Bck2Brwsr.Resources resources,
42 StringArray explicitlyExported, StringArray asBinary
45 this.resources = resources;
46 this.classDataCache = new ClassDataCache(resources);
47 this.exportedSymbols = new ExportedSymbols(resources, explicitlyExported);
48 this.invokerMethods = new StringBuilder();
49 this.asBinary = asBinary;
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.classes().toArray();
72 final StringArray fixedNames = new StringArray();
73 boolean addThree = false;
76 if (config.isExtension()) {
77 fixedNames.add(VM.class.getName().replace('.', '/'));
78 vm = new Extension(out,
79 config.getResources(), both, config.exported(),
80 config.allResources(), config.classpath()
84 if (config.includeVM()) {
85 fixedNames.add(VM.class.getName().replace('.', '/'));
88 vm = new Standalone(out,
89 config.getResources(), config.exported(),
94 fixedNames.add(Object.class.getName().replace('.', '/'));
95 fixedNames.add(Class.class.getName().replace('.', '/'));
96 fixedNames.add(ArithmeticException.class.getName().replace('.', '/'));
98 vm.doCompile(fixedNames.addAndNew(both));
101 private void doCompile(StringArray names) throws IOException {
103 append("\n var invoker = {};");
104 append("\n function registerClass(vm, name, fn) {");
105 append("\n if (!vm[name]) vm[name] = fn;");
106 append("\n return vm[name];");
109 append(invokerMethods);
111 for (String r : asBinary.toArray()) {
112 append("\n ").append(getExportsObject()).append("['registerResource']('");
113 append(r).append("', '");
114 InputStream is = this.resources.get(r);
115 int avail = is.available();
119 byte[] arr = new byte[avail];
122 if (offset == arr.length) {
123 byte[] tmp = new byte[arr.length * 2];
124 System.arraycopy(arr, 0, tmp, 0, arr.length);
127 int len = is.read(arr, offset, arr.length - offset);
133 if (offset != arr.length) {
134 byte[] tmp = new byte[offset];
135 System.arraycopy(arr, 0, tmp, 0, offset);
146 @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
147 private static String btoa(byte[] arr) {
148 return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
151 protected abstract void generatePrologue() throws IOException;
153 protected abstract void generateEpilogue() throws IOException;
155 protected abstract String getExportsObject();
157 protected abstract boolean isExternalClass(String className);
159 protected abstract void lazyReference(Appendable out, String n) throws IOException;
162 protected final void declareClass(ClassData classData, String mangledName)
164 if (exportedSymbols.isExported(classData)) {
165 append("registerClass(").append(getExportsObject()).append(",'")
176 protected String generateClass(String className) throws IOException {
177 ClassData classData = classDataCache.getClassData(className);
178 if (classData == null) {
179 throw new IOException("Can't find class " + className);
181 return compile(classData);
185 protected void declaredField(FieldData fieldData,
187 String mangledName) throws IOException {
188 if (exportedSymbols.isExported(fieldData)) {
189 exportMember(destObject, mangledName);
194 protected void declaredMethod(MethodData methodData,
196 String mangledName) throws IOException {
197 if (isHierarchyExported(methodData)) {
198 exportMember(destObject, mangledName);
202 private void exportMember(String destObject, String memberName)
204 append("\n").append(destObject).append("['")
206 .append("'] = m;\n");
209 private void generateBody(StringArray names) throws IOException {
210 StringArray processed = new StringArray();
211 StringArray initCode = new StringArray();
212 StringArray skipClass = new StringArray();
213 for (String baseClass : names.toArray()) {
214 references.add(baseClass);
217 for (String n : references.toArray()) {
218 if (skipClass.contains(n)) {
221 if (processed.contains(n)) {
229 InputStream is = resources.get(name + ".class");
231 lazyReference(this, name);
236 String ic = generateClass(name);
238 initCode.add(ic == null ? "" : ic);
239 } catch (RuntimeException ex) {
240 throw new IOException("Error while compiling " + name + "\n", ex);
244 for (String resource : scripts.toArray()) {
245 while (resource.startsWith("/")) {
246 resource = resource.substring(1);
248 requireResourceImpl(resource);
249 asBinary.remove(resource);
251 scripts = new StringArray();
253 StringArray toInit = StringArray.asList(references.toArray());
256 for (String ic : toInit.toArray()) {
257 int indx = processed.indexOf(ic);
259 final String theCode = initCode.toArray()[indx];
260 if (!theCode.isEmpty()) {
261 append(theCode).append("\n");
263 initCode.toArray()[indx] = "";
269 final void requireResourceImpl(String resource) throws IOException {
270 InputStream emul = resources.get(resource);
272 throw new IOException("Can't find " + resource);
274 append("\n// resource from ").append(resource).append("\n");
276 readResource(emul, this);
280 private static void readResource(InputStream emul, Appendable out) throws IOException {
283 int ch = emul.read();
287 if (ch < 0 || ch > 255) {
288 throw new IOException("Invalid char in emulation " + ch);
298 out.append("\\n\"\n + \"");
307 out.append((char)ch);
315 static String toString(String name) throws IOException {
316 StringBuilder sb = new StringBuilder();
317 // compile(sb, name);
318 return sb.toString().toString();
321 private StringArray scripts = new StringArray();
322 private StringArray references = new StringArray();
325 protected boolean requireReference(String cn) {
326 return references.addIfMissing(cn);
330 protected void requireScript(String resourcePath) {
331 scripts.add(resourcePath);
335 String assignClass(String className) {
336 return "vm." + className + " = ";
340 String accessClass(String className) {
341 return "vm." + className;
345 protected FieldData findField(String[] fieldInfoName) throws IOException {
346 FieldData field = classDataCache.findField(
347 fieldInfoName[0], fieldInfoName[1], fieldInfoName[2]
349 return field != null && canAccessDirectly(field.cls) ? field : null;
353 protected String accessField(String object, FieldData field, String[] fieldInfoName)
355 if (field != null && !field.isStatic()) {
356 return "fld_" + object + "_" + field.getName();
358 String mangledName = "_" + fieldInfoName[1];
359 return accessNonVirtualMember(
360 object, mangledName, field != null ? field.cls : null
366 protected String accessStaticMethod(
369 String[] fieldInfoName) throws IOException {
370 final MethodData method =
371 classDataCache.findMethod(fieldInfoName[0],
374 return accessNonVirtualMember(object, mangledName,
375 (method != null) ? method.cls : null);
379 protected String accessVirtualMethod(
382 String[] fieldInfoName,
384 ) throws IOException {
385 final ClassData referencedClass =
386 classDataCache.getClassData(fieldInfoName[0]);
387 final MethodData method =
388 classDataCache.findMethod(referencedClass,
393 && !isExternalClass(method.cls.getClassName())
394 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
395 || ((referencedClass.getAccessFlags()
396 & ByteCodeParser.ACC_FINAL) != 0)
397 || !isHierarchyExported(method))) {
398 return object + "." + mangledName + '(';
401 return accessThroughInvoker(object, mangledName, params);
404 private String accessThroughInvoker(String object, String mangledName, int params)
406 String def = "\n invoker." + mangledName + " = function(target";
407 if (invokerMethods.indexOf(def) == -1) {
408 invokerMethods.append(def);
409 for (int j = 0; j < params; j++) {
410 invokerMethods.append(", p").append(j);
412 invokerMethods.append(") {\n return target['").
413 append(mangledName).append("'](");
414 for (int j = 0; j < params; j++) {
416 invokerMethods.append(",");
418 invokerMethods.append("p").append(j);
420 invokerMethods.append(");\n };");
422 return "invoker." + mangledName + '(' + object + (params > 1 ? "," : "");
425 private boolean isHierarchyExported(final MethodData methodData)
427 if (exportedSymbols.isExported(methodData)) {
430 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
431 | ByteCodeParser.ACC_STATIC)) != 0) {
435 final ExportedMethodFinder exportedMethodFinder =
436 new ExportedMethodFinder(exportedSymbols);
438 classDataCache.findMethods(
440 methodData.getName(),
441 methodData.getInternalSig(),
442 exportedMethodFinder);
444 return (exportedMethodFinder.getFound() != null);
447 private boolean canAccessDirectly(ClassData declaringClass) {
448 if (declaringClass == null) {
451 final String className = declaringClass.getClassName();
453 "java/lang/Object".equals(className) ||
454 "java/lang/reflect/Array".equals(className) ||
455 isExternalClass(className)
462 private String accessNonVirtualMember(
463 String object, String mangledName, ClassData declaringClass
465 return canAccessDirectly(declaringClass) ?
466 object + "." + mangledName :
467 object + "['" + mangledName + "']";
470 private final class ExportedMethodFinder
471 implements ClassDataCache.TraversalCallback<MethodData> {
472 private final ExportedSymbols exportedSymbols;
473 private MethodData found;
475 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
476 this.exportedSymbols = exportedSymbols;
480 public boolean traverse(final MethodData methodData) {
483 exportedSymbols.isExported(methodData) ||
484 isExternalClass(methodData.cls.getClassName())
489 } catch (final IOException e) {
495 public MethodData getFound() {
500 private static final class Standalone extends VM {
501 private Standalone(Appendable out,
502 Bck2Brwsr.Resources resources,
503 StringArray explicitlyExported, StringArray asBinary
505 super(out, resources, explicitlyExported, asBinary);
509 protected void generatePrologue() throws IOException {
510 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
514 protected void generateEpilogue() throws IOException {
518 + " var extensions = [];\n"
519 + " function replaceAll(s, target, replacement) {\n"
522 + " var indx = s.indexOf(target, pos);\n"
523 + " if (indx === -1) {\n"
526 + " pos = indx + replacement.length;\n"
527 + " s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
530 + " function mangleClass(name) {\n"
531 + " name = replaceAll(name, '_', '_1');\n"
532 + " name = replaceAll(name, '.', '_');\n"
535 + " var pending = [];\n"
536 + " var pendingClasses = [];\n"
537 + " function extensionLoaded(ev) {\n"
538 + " var at = pending.indexOf(ev.target);\n"
539 + " pending.splice(at, 1);\n"
540 + " if (pending.length === 0) {\n"
541 + " for (var i = 0; i < pendingClasses.length; i += 3) {\n"
542 + " invokeMethod(pendingClasses[i], pendingClasses[i + 1], pendingClasses[i + 2]);\n"
544 + " pendingClasses = [];\n"
547 + " function invokeMethod(vm, n, args) {\n"
548 + " var clazz = vm.loadClass(n);\n"
550 + " var seek = args[0];\n"
551 + " var prefix = seek.indexOf('__') == -1 ? seek + '__' : seek;\n"
552 + " args = Array.prototype.slice.call(args, 1);\n"
553 + " var found = '';\n"
554 + " for (var m in clazz) {\n"
555 + " if (m.indexOf(prefix) === 0) {\n"
556 + " return clazz[m].apply(null, args);\n"
558 + " found += m.toString() + '\\n'\n"
560 + " throw 'Cannot find ' + seek + ' in ' + n + ' found:\\n' + found;\n"
563 + " function extensionError(ev) {\n"
564 + " console.log('error loading ' + ev.target.src);\n"
565 + " extensionLoaded(ev);\n"
567 + " function loadExtension(url) {\n"
568 + " if (url.substring(url.length - 4) == '.jar')\n"
569 + " url = url.substring(0, url.length - 4) + '.js';\n"
570 + " var script = document.createElement('script');\n"
571 + " script.type = 'text/javascript';\n"
572 + " script.src = url;\n"
573 + " script.onload = extensionLoaded;\n"
574 + " script.onerror = extensionError;\n"
575 + " document.getElementsByTagName('head')[0].appendChild(script);\n"
576 + " pending.push(script);\n"
578 + " global.bck2brwsr = function() {\n"
579 + " var args = Array.prototype.slice.apply(arguments);\n"
580 + " var resources = {};\n"
581 + " function registerResource(n, a64) {\n"
582 + " var frm = atob || window.atob;\n"
583 + " var str = frm(a64);\n"
585 + " for (var i = 0; i < str.length; i++) {\n"
586 + " var ch = str.charCodeAt(i) & 0xff;\n"
587 + " if (ch > 127) ch -= 256;\n"
590 + " if (!resources[n]) resources[n] = [arr];\n"
591 + " else resources[n].push(arr);\n"
593 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
594 + " function initVM() {\n"
595 + " var clsArray = vm['java_lang_reflect_Array'];\n"
596 + " if (clsArray) clsArray(false);\n"
598 + " for (var i = 0; i < extensions.length; ++i) {\n"
599 + " extensions[i](vm);\n"
601 + " vm['registerResource'] = null;\n"
602 + " var knownExtensions = extensions.length;\n"
603 + " var loader = {};\n"
604 + " var classPath;\n"
605 + " var loadBytes = function(name, skip) {\n"
606 + " skip = typeof skip == 'number' ? skip : 0;\n"
607 + " var arr = resources[name];\n"
609 + " var arrSize = arr.length;\n"
610 + " if (skip < arrSize) return arr[skip];\n"
611 + " skip -= arrSize;\n"
613 + " var arrSize = 0;\n"
615 + " for (var i = 0; i < args.length; i++) {\n"
616 + " var at = args[i];\n"
617 + " if(!at) continue;\n"
619 + " if (typeof at === 'string' && at.substring(at.length - 3) === '.js') {\n"
620 + " loadExtension(at);\n"
621 + " args[i] = null;\n"
622 + " } else if (typeof at === 'function') ret = at(name, skip);\n"
624 + " if (classPath === undefined) {\n"
625 + " classPath = null;\n"
627 + " classPath = vm.loadClass('org.apidesign.vm4brwsr.ClassPath');\n"
628 + " } catch (err) {\n"
631 + " if (!classPath) {\n"
632 + " if (name !== 'org/apidesign/vm4brwsr/ClassPath.class') {\n"
633 + " throw 'Core Java library not registered. Cannot load from ' + at;\n"
637 + " ret = classPath['loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II'](name, args, i, skip);\n"
640 + " if (ret) return ret;\n"
642 + " while (knownExtensions < extensions.length) {\n"
643 + " vm['registerResource'] = registerResource;\n"
644 + " extensions[knownExtensions++](vm);\n"
645 + " vm['registerResource'] = null;\n"
648 + " var arr = resources[name];\n"
649 + " return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
651 + " var reload = function(name, arr, keep) {\n"
652 + " if (!arr) throw 'Cannot find ' + name;\n"
653 + " var err = null;\n"
655 + " var lazy = loadClass('org.apidesign.vm4brwsr.VMLazy');\n"
660 + " throw 'No bck2brwsr VM module to compile ' + name + ':\\n' + err;\n"
663 + " var attr = mangleClass(name);\n"
664 + " delete vm[attr];\n"
666 + " return lazy['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
667 + " (vm, name, args, arr);\n"
669 + " var loadClass = function(name) {\n"
670 + " var attr = mangleClass(name);\n"
671 + " var fn = vm[attr];\n"
672 + " if (fn) return fn(false);\n"
674 + " var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
675 + " return reload(name, arr, true);\n"
676 + " } catch (err) {\n"
677 + " fn = vm[attr];\n"
678 + " if (fn) return fn(false);\n"
682 + " if (vm['loadClass']) {\n"
683 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
685 + " vm['loadClass'] = loadClass;\n"
686 + " vm['_reload'] = reload;\n"
687 + " vm['loadBytes'] = loadBytes;\n"
689 + " loader.loadClass = function(name) {\n"
690 + " if (pending.length === 0) {\n"
692 + " var c = loadClass(name);\n"
693 + " c['invoke'] = function() {\n"
694 + " return invokeMethod(vm, name, arguments);\n"
697 + " } catch (err) {\n"
698 + " if (pending.length === 0) throw err;\n"
701 + " pendingClasses.push(vm);\n"
702 + " pendingClasses.push(name);\n"
703 + " pendingClasses.push(null);\n"
705 + " 'invoke' : function() {\n"
706 + " if (pending.length === 0) {\n"
707 + " invokeMethod(vm, name, arguments);\n"
710 + " pendingClasses.push(vm);\n"
711 + " pendingClasses.push(name);\n"
712 + " pendingClasses.push(arguments);\n"
716 + " return loader;\n"
719 " global.bck2brwsr.register = function(config, extension) {\n"
720 + " if (!config || config['magic'] !== 'kafčo') {\n"
721 + " console.log('Will not register: ' + extension);\n"
724 + " var cs = typeof document == 'undefined' ? null : document['currentScript'];\n"
725 + " var csUrl = cs ? cs['src'] : null;\n"
726 + " var prefix = csUrl ? csUrl['replace'](/\\/[^\\/]*$/,'/') : '';\n"
727 + " extensions.push(extension);\n"
728 + " var cp = config['classpath'];\n"
729 + " if (cp) for (var i = 0; i < cp.length; i++) {\n"
730 + " loadExtension(prefix + cp[i]);\n"
738 protected String getExportsObject() {
743 protected boolean isExternalClass(String className) {
748 protected void lazyReference(Appendable out, String n) throws IOException {
749 String cls = n.replace('/', '_');
750 String dot = n.replace('/', '.');
752 out.append("\nvm.").append(cls).append(" = function() {");
753 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
754 out.append("\n delete vm.").append(cls).append(";");
755 out.append("\n var c = vm.loadClass('").append(dot).append("');");
756 out.append("\n return vm.").append(cls).append("(instance);");
761 protected void requireResource(String resourcePath) throws IOException {
762 requireResourceImpl(resourcePath);
763 super.asBinary.remove(resourcePath);
767 private static final class Extension extends VM {
768 private final StringArray extensionClasses;
769 private final StringArray classpath;
771 private Extension(Appendable out, Bck2Brwsr.Resources resources,
772 String[] extClassesArray, StringArray explicitlyExported,
773 StringArray asBinary, StringArray classpath
774 ) throws IOException {
775 super(out, resources, explicitlyExported, asBinary);
776 this.extensionClasses = StringArray.asList(extClassesArray);
777 this.classpath = classpath;
781 protected void generatePrologue() throws IOException {
783 "bck2brwsr.register({\n"
784 + " 'magic' : 'kafčo'"
786 if (classpath != null && classpath.toArray().length > 0) {
788 ",\n 'classpath' : [\n"
791 for (String s : classpath.toArray()) {
792 append(sep).append("'").append(s).append("'");
800 "\n}, function(exports) {\n"
801 + " var vm = {};\n");
802 append(" function link(n, assign) {\n"
803 + " function replaceAll(s, o, n) {\n"
806 + " var indx = s.indexOf(o, pos);\n"
807 + " if (indx === -1) {\n"
810 + " pos = indx + n.length;\n"
811 + " s = s.substring(0, indx) + n + s.substring(indx + o.length);\n"
814 + " return function() {\n"
815 + " var no_ = replaceAll(n, '_', '_1');\n"
816 + " var cls = replaceAll(no_, '/', '_');\n"
817 + " var dot = replaceAll(n, '/', '.');\n"
818 + " exports.loadClass(dot);\n"
819 + " assign(exports[cls]);\n"
820 + " return exports[cls](arguments);\n"
827 protected void generateEpilogue() throws IOException {
829 if (exportedCount == 0) {
830 throw new IOException("Creating library without any exported symbols is useless!");
835 String accessClass(String className) {
836 if (this.extensionClasses.contains(className.replace('_', '/'))) {
839 return super.accessClass(className);
843 protected String generateClass(String className) throws IOException {
844 if (isExternalClass(className)) {
845 final String cls = className.replace("_", "_1").replace('/', '_');
846 append("\n").append(assignClass(cls))
849 .append("', function(f) { ").append(assignClass(cls)).append(" f; });");
854 return super.generateClass(className);
858 protected String getExportsObject() {
863 protected boolean isExternalClass(String className) {
864 return !extensionClasses.contains(className);
868 protected void lazyReference(Appendable out, String n) throws IOException {
869 String cls = n.replace('/', '_');
871 out.append("\nvm.").append(cls).append(" = function() {");
872 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
873 out.append("\n delete vm.").append(cls).append(";");
874 out.append("\n return link('").append(n).append("', function(f) { vm.");
875 out.append(cls).append(" = f;})(instance);");
880 protected void requireResource(String resourcePath) throws IOException {
881 requireResourceImpl(resourcePath);
882 super.asBinary.remove(resourcePath);