External classes are treated as exported.
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(target) {"
102 + "\n return function() {"
103 + "\n return target['" + invokerMethod + "'].apply(target, arguments);"
109 for (String r : asBinary.toArray()) {
110 append("\n ").append(getExportsObject()).append("['registerResource']('");
111 append(r).append("', '");
112 InputStream is = this.resources.get(r);
113 byte[] arr = new byte[is.available()];
116 if (offset == arr.length) {
117 byte[] tmp = new byte[arr.length * 2];
118 System.arraycopy(arr, 0, tmp, 0, arr.length);
121 int len = is.read(arr, offset, arr.length - offset);
127 if (offset != arr.length) {
128 byte[] tmp = new byte[offset];
129 System.arraycopy(arr, 0, tmp, 0, offset);
140 @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
141 private static String btoa(byte[] arr) {
142 return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
145 protected abstract void generatePrologue() throws IOException;
147 protected abstract void generateEpilogue() throws IOException;
149 protected abstract String getExportsObject();
151 protected abstract boolean isExternalClass(String className);
154 protected final void declaredClass(ClassData classData, String mangledName)
156 if (exportedSymbols.isExported(classData)) {
157 append("\n").append(getExportsObject()).append("['")
160 .append(accessClass(mangledName))
165 protected String generateClass(String className) throws IOException {
166 ClassData classData = classDataCache.getClassData(className);
167 if (classData == null) {
168 throw new IOException("Can't find class " + className);
170 return compile(classData);
174 protected void declaredField(FieldData fieldData,
176 String mangledName) throws IOException {
177 if (exportedSymbols.isExported(fieldData)) {
178 exportMember(destObject, mangledName);
183 protected void declaredMethod(MethodData methodData,
185 String mangledName) throws IOException {
186 if (isHierarchyExported(methodData)) {
187 exportMember(destObject, mangledName);
191 private void exportMember(String destObject, String memberName)
193 append("\n").append(destObject).append("['")
196 .append(destObject).append(".").append(memberName)
200 private void generateBody(StringArray names) throws IOException {
201 StringArray processed = new StringArray();
202 StringArray initCode = new StringArray();
203 StringArray skipClass = new StringArray();
204 for (String baseClass : names.toArray()) {
205 references.add(baseClass);
208 for (String n : references.toArray()) {
209 if (skipClass.contains(n)) {
212 if (processed.contains(n)) {
220 InputStream is = resources.get(name + ".class");
222 lazyReference(this, name);
227 String ic = generateClass(name);
229 initCode.add(ic == null ? "" : ic);
230 } catch (RuntimeException ex) {
231 throw new IOException("Error while compiling " + name + "\n", ex);
235 for (String resource : scripts.toArray()) {
236 while (resource.startsWith("/")) {
237 resource = resource.substring(1);
239 InputStream emul = resources.get(resource);
241 throw new IOException("Can't find " + resource);
243 readResource(emul, this);
244 asBinary.remove(resource);
246 scripts = new StringArray();
248 StringArray toInit = StringArray.asList(references.toArray());
251 for (String ic : toInit.toArray()) {
252 int indx = processed.indexOf(ic);
254 final String theCode = initCode.toArray()[indx];
255 if (!theCode.isEmpty()) {
256 append(theCode).append("\n");
258 initCode.toArray()[indx] = "";
264 private static void readResource(InputStream emul, Appendable out) throws IOException {
268 int ch = emul.read();
272 if (ch < 0 || ch > 255) {
273 throw new IOException("Invalid char in emulation " + ch);
280 out.append((char)ch);
287 out.append('/').append((char)ch);
310 static String toString(String name) throws IOException {
311 StringBuilder sb = new StringBuilder();
312 // compile(sb, name);
313 return sb.toString().toString();
316 private StringArray scripts = new StringArray();
317 private StringArray references = new StringArray();
320 protected boolean requireReference(String cn) {
321 if (references.contains(cn)) {
329 protected void requireScript(String resourcePath) {
330 scripts.add(resourcePath);
334 String assignClass(String className) {
335 return "vm." + className + " = ";
339 String accessClass(String className) {
340 return "vm." + className;
344 protected String accessField(String object, String mangledName,
345 String[] fieldInfoName) throws IOException {
346 final FieldData field =
347 classDataCache.findField(fieldInfoName[0],
350 return accessNonVirtualMember(object, mangledName,
351 (field != null) ? field.cls : null);
355 protected String accessStaticMethod(
358 String[] fieldInfoName) throws IOException {
359 final MethodData method =
360 classDataCache.findMethod(fieldInfoName[0],
363 return accessNonVirtualMember(object, mangledName,
364 (method != null) ? method.cls : null);
368 protected String accessVirtualMethod(
371 String[] fieldInfoName) throws IOException {
372 final ClassData referencedClass =
373 classDataCache.getClassData(fieldInfoName[0]);
374 final MethodData method =
375 classDataCache.findMethod(referencedClass,
380 && !isExternalClass(method.cls.getClassName())
381 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
382 || ((referencedClass.getAccessFlags()
383 & ByteCodeParser.ACC_FINAL) != 0)
384 || !isHierarchyExported(method))) {
385 return object + "." + mangledName;
388 return accessThroughInvoker(object, mangledName);
391 private String accessThroughInvoker(String object, String mangledName) {
392 if (!invokerMethods.contains(mangledName)) {
393 invokerMethods.add(mangledName);
395 return "invoker." + mangledName + '(' + object + ')';
398 private boolean isHierarchyExported(final MethodData methodData)
400 if (exportedSymbols.isExported(methodData)) {
403 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
404 | ByteCodeParser.ACC_STATIC)) != 0) {
408 final ExportedMethodFinder exportedMethodFinder =
409 new ExportedMethodFinder(exportedSymbols);
411 classDataCache.findMethods(
413 methodData.getName(),
414 methodData.getInternalSig(),
415 exportedMethodFinder);
417 return (exportedMethodFinder.getFound() != null);
420 private String accessNonVirtualMember(String object,
422 ClassData declaringClass) {
423 return ((declaringClass != null)
424 && !isExternalClass(declaringClass.getClassName()))
425 ? object + "." + mangledName
426 : object + "['" + mangledName + "']";
429 private final class ExportedMethodFinder
430 implements ClassDataCache.TraversalCallback<MethodData> {
431 private final ExportedSymbols exportedSymbols;
432 private MethodData found;
434 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
435 this.exportedSymbols = exportedSymbols;
439 public boolean traverse(final MethodData methodData) {
442 exportedSymbols.isExported(methodData) ||
443 isExternalClass(methodData.cls.getClassName())
448 } catch (final IOException e) {
454 public MethodData getFound() {
459 private static final class Standalone extends VM {
460 private Standalone(Appendable out,
461 Bck2Brwsr.Resources resources,
462 StringArray explicitlyExported, StringArray asBinary
464 super(out, resources, explicitlyExported, asBinary);
468 protected void generatePrologue() throws IOException {
469 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
473 protected void generateEpilogue() throws IOException {
477 + " var extensions = [];\n"
478 + " function replaceAll(s, target, replacement) {\n"
481 + " var indx = s.indexOf(target, pos);\n"
482 + " if (indx === -1) {\n"
485 + " pos = indx + replacement.length;\n"
486 + " s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
489 + " function mangleClass(name) {\n"
490 + " name = replaceAll(name, '_', '_1');\n"
491 + " name = replaceAll(name, '.', '_');\n"
494 + " var pending = [];\n"
495 + " var pendingClasses = [];\n"
496 + " function extensionLoaded(ev) {\n"
497 + " var at = pending.indexOf(ev.target);\n"
498 + " pending.splice(at, 1);\n"
499 + " if (pending.length === 0) {\n"
500 + " for (var i = 0; i < pendingClasses.length; i += 3) {\n"
501 + " invokeMethod(pendingClasses[i], pendingClasses[i + 1], pendingClasses[i + 2]);\n"
503 + " pendingClasses = [];\n"
506 + " function invokeMethod(vm, n, args) {\n"
507 + " var clazz = vm.loadClass(n);\n"
509 + " var seek = args[0];\n"
510 + " var prefix = seek.indexOf('__') == -1 ? seek + '__' : seek;\n"
511 + " args = Array.prototype.slice.call(args, 1);\n"
512 + " var found = '';\n"
513 + " for (var m in clazz) {\n"
514 + " if (m.indexOf(prefix) === 0) {\n"
515 + " return clazz[m].apply(null, args);\n"
517 + " found += m.toString() + '\\n'\n"
519 + " throw 'Cannot find ' + seek + ' in ' + n + ' found:\\n' + found;\n"
522 + " function extensionError(ev) {\n"
523 + " console.log('error loading ' + ev.target.src);\n"
524 + " extensionLoaded(ev);\n"
526 + " function loadExtension(url) {\n"
527 + " if (url.substring(url.length - 4) == '.jar')\n"
528 + " url = url.substring(0, url.length - 4) + '.js';\n"
529 + " var script = document.createElement('script');\n"
530 + " script.type = 'text/javascript';\n"
531 + " script.src = url;\n"
532 + " script.onload = extensionLoaded;\n"
533 + " script.onerror = extensionError;\n"
534 + " document.getElementsByTagName('head')[0].appendChild(script);\n"
535 + " pending.push(script);\n"
537 + " global.bck2brwsr = function() {\n"
538 + " var args = Array.prototype.slice.apply(arguments);\n"
539 + " var resources = {};\n"
540 + " function registerResource(n, a64) {\n"
541 + " var str = atob(a64);\n"
543 + " for (var i = 0; i < str.length; i++) {\n"
544 + " var ch = str.charCodeAt(i) & 0xff;\n"
545 + " if (ch > 127) ch -= 256;\n"
548 + " if (!resources[n]) resources[n] = [arr];\n"
549 + " else resources[n].push(arr);\n"
551 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
552 + " function initVM() {\n"
553 + " var clsArray = vm['java_lang_reflect_Array'];\n"
554 + " if (clsArray) clsArray(false);\n"
556 + " for (var i = 0; i < extensions.length; ++i) {\n"
557 + " extensions[i](vm);\n"
559 + " vm['registerResource'] = null;\n"
560 + " var knownExtensions = extensions.length;\n"
561 + " var loader = {};\n"
562 + " var loadBytes = function(name, skip) {\n"
563 + " skip = typeof skip == 'number' ? skip : 0;\n"
564 + " var arr = resources[name];\n"
566 + " var arrSize = arr.length;\n"
567 + " if (skip < arrSize) return arr[skip];\n"
568 + " skip -= arrSize;\n"
570 + " var arrSize = 0;\n"
572 + " for (var i = 0; i < args.length; i++) {\n"
573 + " var at = args[i];\n"
574 + " if(!at) continue;\n"
576 + " if (typeof at === 'string' && at.substring(at.length - 3) === '.js') {\n"
577 + " loadExtension(at);\n"
578 + " args[i] = null;\n"
579 + " } else if (typeof at === 'function') ret = at(name, skip);\n"
581 + " var cp = vm['org_apidesign_vm4brwsr_ClassPath'];\n"
582 + " if (!cp) throw 'Core Java library not registered. Cannot load from ' + at;\n"
583 + " ret = cp(false).\n"
584 + " loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II(name, args, i, skip);\n"
586 + " if (ret) return ret;\n"
588 + " while (knownExtensions < extensions.length) {\n"
589 + " vm['registerResource'] = registerResource;\n"
590 + " extensions[knownExtensions++](vm);\n"
591 + " vm['registerResource'] = null;\n"
594 + " var arr = resources[name];\n"
595 + " return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
597 + " var reload = function(name, arr, keep) {\n"
598 + " if (!arr) throw 'Cannot find ' + name;\n"
599 + " var lazy = vm['org_apidesign_vm4brwsr_VMLazy'];\n"
600 + " if (!lazy) throw 'No bck2brwsr VM module to compile ' + name;\n"
602 + " var attr = mangleClass(name);\n"
603 + " delete vm[attr];\n"
605 + " return lazy(false)\n"
606 + " ['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
607 + " (vm, name, args, arr);\n"
609 + " var loadClass = function(name) {\n"
610 + " var attr = mangleClass(name);\n"
611 + " var fn = vm[attr];\n"
612 + " if (fn) return fn(false);\n"
614 + " var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
615 + " return reload(name, arr, true);\n"
616 + " } catch (err) {\n"
617 + " fn = vm[attr];\n"
618 + " if (fn) return fn(false);\n"
622 + " if (vm['loadClass']) {\n"
623 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
625 + " vm['loadClass'] = loadClass;\n"
626 + " vm['_reload'] = reload;\n"
627 + " vm['loadBytes'] = loadBytes;\n"
629 + " loader.loadClass = function(name) {\n"
630 + " if (pending.length === 0) {\n"
632 + " var c = loadClass(name);\n"
633 + " c['invoke'] = function() {\n"
634 + " return invokeMethod(vm, name, arguments);\n"
637 + " } catch (err) {\n"
638 + " if (pending.length === 0) throw err;\n"
641 + " pendingClasses.push(vm);\n"
642 + " pendingClasses.push(name);\n"
643 + " pendingClasses.push(null);\n"
645 + " 'invoke' : function() {\n"
646 + " if (pending.length === 0) {\n"
647 + " invokeMethod(vm, name, arguments);\n"
650 + " pendingClasses.push(vm);\n"
651 + " pendingClasses.push(name);\n"
652 + " pendingClasses.push(arguments);\n"
656 + " return loader;\n"
659 " global.bck2brwsr.register = function(config, extension) {\n"
660 + " if (!config || config['magic'] !== 'kafíčko') {\n"
661 + " console.log('Will not register: ' + extension);\n"
664 + " extensions.push(extension);\n"
665 + " var cp = config['classpath'];\n"
666 + " if (cp) for (var i = 0; i < cp.length; i++) {\n"
667 + " loadExtension(cp[i]);\n"
675 protected String getExportsObject() {
680 protected boolean isExternalClass(String className) {
685 private static final class Extension extends VM {
686 private final StringArray extensionClasses;
687 private final StringArray classpath;
689 private Extension(Appendable out, Bck2Brwsr.Resources resources,
690 String[] extClassesArray, StringArray explicitlyExported,
691 StringArray asBinary, StringArray classpath
693 super(out, resources, explicitlyExported, asBinary);
694 this.extensionClasses = StringArray.asList(extClassesArray);
695 this.classpath = classpath;
699 protected void generatePrologue() throws IOException {
701 "bck2brwsr.register({\n"
702 + " 'magic' : 'kafíčko'"
704 if (classpath != null && classpath.toArray().length > 0) {
706 ",\n 'classpath' : [\n"
709 for (String s : classpath.toArray()) {
710 append(sep).append("'").append(s).append("'");
718 "\n}, function(exports) {\n"
719 + " var vm = {};\n");
720 append(" function link(n) {\n"
721 + " return function() {\n"
722 + " var cls = n['replace__Ljava_lang_String_2CC']"
723 + "('/', '_').toString();\n"
724 + " var dot = n['replace__Ljava_lang_String_2CC']"
725 + "('/', '.').toString();\n"
726 + " exports.loadClass(dot);\n"
727 + " vm[cls] = exports[cls];\n"
728 + " return vm[cls](arguments);\n"
735 protected void generateEpilogue() throws IOException {
740 protected String generateClass(String className) throws IOException {
741 if (isExternalClass(className)) {
742 append("\n").append(assignClass(
743 className.replace('/', '_')))
751 return super.generateClass(className);
755 protected String getExportsObject() {
760 protected boolean isExternalClass(String className) {
761 return !extensionClasses.contains(className);
765 private static void lazyReference(Appendable out, String n) throws IOException {
766 String cls = n.replace('/', '_');
767 String dot = n.replace('/', '.');
769 out.append("\nvm.").append(cls).append(" = function() {");
770 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
771 out.append("\n delete vm.").append(cls).append(";");
772 out.append("\n var c = vm.loadClass('").append(dot).append("');");
773 out.append("\n return vm.").append(cls).append("(instance);");