Merging from default branch and resolving conflicts. mvn install -DskipTests passes OK.
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()];
105 int len = is.read(arr);
106 if (len != arr.length) {
107 throw new IOException("Not read as much as expected for " + r + " expected: " + arr.length + " was: " + len);
117 @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
118 private static String btoa(byte[] arr) {
119 return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
122 protected abstract void generatePrologue() throws IOException;
124 protected abstract void generateEpilogue() throws IOException;
126 protected abstract String getExportsObject();
128 protected abstract boolean isExternalClass(String className);
131 protected final void declaredClass(ClassData classData, String mangledName)
133 if (exportedSymbols.isExported(classData)) {
134 append("\n").append(getExportsObject()).append("['")
137 .append(accessClass(mangledName))
142 protected String generateClass(String className) throws IOException {
143 ClassData classData = classDataCache.getClassData(className);
144 if (classData == null) {
145 throw new IOException("Can't find class " + className);
147 return compile(classData);
151 protected void declaredField(FieldData fieldData,
153 String mangledName) throws IOException {
154 if (exportedSymbols.isExported(fieldData)) {
155 exportMember(destObject, mangledName);
160 protected void declaredMethod(MethodData methodData,
162 String mangledName) throws IOException {
163 if (isHierarchyExported(methodData)) {
164 exportMember(destObject, mangledName);
168 private void exportMember(String destObject, String memberName)
170 append("\n").append(destObject).append("['")
173 .append(destObject).append(".").append(memberName)
177 private void generateBody(StringArray names) throws IOException {
178 StringArray processed = new StringArray();
179 StringArray initCode = new StringArray();
180 StringArray skipClass = new StringArray();
181 for (String baseClass : names.toArray()) {
182 references.add(baseClass);
185 for (String n : references.toArray()) {
186 if (skipClass.contains(n)) {
189 if (processed.contains(n)) {
197 InputStream is = resources.get(name + ".class");
199 lazyReference(this, name);
204 String ic = generateClass(name);
206 initCode.add(ic == null ? "" : ic);
207 } catch (RuntimeException ex) {
208 throw new IOException("Error while compiling " + name + "\n", ex);
212 for (String resource : scripts.toArray()) {
213 while (resource.startsWith("/")) {
214 resource = resource.substring(1);
216 InputStream emul = resources.get(resource);
218 throw new IOException("Can't find " + resource);
220 readResource(emul, this);
222 scripts = new StringArray();
224 StringArray toInit = StringArray.asList(references.toArray());
227 for (String ic : toInit.toArray()) {
228 int indx = processed.indexOf(ic);
230 final String theCode = initCode.toArray()[indx];
231 if (!theCode.isEmpty()) {
232 append(theCode).append("\n");
234 initCode.toArray()[indx] = "";
242 + " function mangleClass(name) {\n"
243 + " return name.replace__Ljava_lang_String_2Ljava_lang_CharSequence_2Ljava_lang_CharSequence_2(\n"
244 + " '_', '_1').replace__Ljava_lang_String_2CC('.','_');\n"
246 + " global.bck2brwsr = function() {\n"
247 + " var args = Array.prototype.slice.apply(arguments);\n"
248 + " var vm = fillInVMSkeleton({});\n"
249 + " var loader = {};\n"
250 + " loader.vm = vm;\n"
251 + " loader.loadClass = function(name) {\n"
252 + " var attr = mangleClass(name);\n"
253 + " var fn = vm[attr];\n"
254 + " if (fn) return fn(false);\n"
255 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
256 + " load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
258 + " if (vm.loadClass) {\n"
259 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
261 + " vm.loadClass = loader.loadClass;\n"
262 + " vm._reload = function(name, byteCode) {;\n"
263 + " var attr = mangleClass(name);\n"
264 + " delete vm[attr];\n"
265 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
266 + " reload__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B(loader, name, args, byteCode);\n"
268 + " vm.loadBytes = function(name, skip) {\n"
269 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
270 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, name, args, typeof skip == 'number' ? skip : 0);\n"
272 + " vm.java_lang_reflect_Array(false);\n"
273 + " vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
274 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, null, args, 0);\n"
275 + " return loader;\n"
281 private static void readResource(InputStream emul, Appendable out) throws IOException {
285 int ch = emul.read();
289 if (ch < 0 || ch > 255) {
290 throw new IOException("Invalid char in emulation " + ch);
297 out.append((char)ch);
304 out.append('/').append((char)ch);
327 static String toString(String name) throws IOException {
328 StringBuilder sb = new StringBuilder();
329 // compile(sb, name);
330 return sb.toString().toString();
333 private StringArray scripts = new StringArray();
334 private StringArray references = new StringArray();
337 protected boolean requireReference(String cn) {
338 if (references.contains(cn)) {
346 protected void requireScript(String resourcePath) {
347 scripts.add(resourcePath);
351 String assignClass(String className) {
352 return "vm." + className + " = ";
356 String accessClass(String className) {
357 return "vm." + className;
361 protected String accessField(String object, String mangledName,
362 String[] fieldInfoName) throws IOException {
363 final FieldData field =
364 classDataCache.findField(fieldInfoName[0],
367 return accessNonVirtualMember(object, mangledName,
368 (field != null) ? field.cls : null);
372 protected String accessStaticMethod(
375 String[] fieldInfoName) throws IOException {
376 final MethodData method =
377 classDataCache.findMethod(fieldInfoName[0],
380 return accessNonVirtualMember(object, mangledName,
381 (method != null) ? method.cls : null);
385 protected String accessVirtualMethod(
388 String[] fieldInfoName) throws IOException {
389 final ClassData referencedClass =
390 classDataCache.getClassData(fieldInfoName[0]);
391 final MethodData method =
392 classDataCache.findMethod(referencedClass,
397 && !isExternalClass(method.cls.getClassName())
398 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
399 || ((referencedClass.getAccessFlags()
400 & ByteCodeParser.ACC_FINAL) != 0)
401 || !isHierarchyExported(method))) {
402 return object + "." + mangledName;
405 return accessThroughInvoker(object, mangledName);
408 private String accessThroughInvoker(String object, String mangledName) {
409 if (!invokerMethods.contains(mangledName)) {
410 invokerMethods.add(mangledName);
412 return "invoker." + mangledName + '(' + object + ')';
415 private boolean isHierarchyExported(final MethodData methodData)
417 if (exportedSymbols.isExported(methodData)) {
420 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
421 | ByteCodeParser.ACC_STATIC)) != 0) {
425 final ExportedMethodFinder exportedMethodFinder =
426 new ExportedMethodFinder(exportedSymbols);
428 classDataCache.findMethods(
430 methodData.getName(),
431 methodData.getInternalSig(),
432 exportedMethodFinder);
434 return (exportedMethodFinder.getFound() != null);
437 private String accessNonVirtualMember(String object,
439 ClassData declaringClass) {
440 return ((declaringClass != null)
441 && !isExternalClass(declaringClass.getClassName()))
442 ? object + "." + mangledName
443 : object + "['" + mangledName + "']";
446 private static final class ExportedMethodFinder
447 implements ClassDataCache.TraversalCallback<MethodData> {
448 private final ExportedSymbols exportedSymbols;
449 private MethodData found;
451 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
452 this.exportedSymbols = exportedSymbols;
456 public boolean traverse(final MethodData methodData) {
458 if (exportedSymbols.isExported(methodData)) {
462 } catch (final IOException e) {
468 public MethodData getFound() {
473 private static final class Standalone extends VM {
474 private Standalone(Appendable out, Bck2Brwsr.Resources resources, StringArray explicitlyExported) {
475 super(out, resources, explicitlyExported);
479 protected void generatePrologue() throws IOException {
480 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
484 protected void generateEpilogue() throws IOException {
488 + " var extensions = [];\n"
489 + " global.bck2brwsr = function() {\n"
490 + " var args = Array.prototype.slice.apply(arguments);\n"
491 + " var resources = {};\n"
492 + " function registerResource(n, a64) {\n"
493 + " var str = atob(a64);\n"
495 + " for (var i = 0; i < str.length; i++) {\n"
496 + " var ch = str.charCodeAt(i) & 0xff;\n"
497 + " if (ch > 127) ch -= 256;\n"
500 + " if (!resources[n]) resources[n] = [arr];\n"
501 + " else resources[n].push(arr);\n"
503 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
504 + " for (var i = 0; i < extensions.length; ++i) {\n"
505 + " extensions[i](vm);\n"
507 + " vm.registerResource = null;\n"
508 + " var knownExtensions = extensions.length;\n"
509 + " var loader = {};\n"
510 + " loader.vm = vm;\n"
511 + " loader.loadClass = function(name) {\n"
512 + " var attr = name.replace__Ljava_lang_String_2CC('.','_');\n"
513 + " var fn = vm[attr];\n"
514 + " if (fn) return fn(false);\n"
516 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
517 + " load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
518 + " } catch (err) {\n"
519 + " while (knownExtensions < extensions.length) {\n"
520 + " vm.registerResource = registerResource;\n"
521 + " extensions[knownExtensions++](vm);\n"
522 + " vm.registerResource = null;\n"
524 + " fn = vm[attr];\n"
525 + " if (fn) return fn(false);\n"
529 + " if (vm.loadClass) {\n"
530 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
532 + " vm.loadClass = loader.loadClass;\n"
533 + " vm.loadBytes = function(name, skip) {\n"
534 + " if (resources[name]) return resources[name][0];\n"
535 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
536 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, name, args, typeof skip == 'number' ? skip : 0);\n"
538 + " vm.java_lang_reflect_Array(false);\n"
539 + " vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
540 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2I(loader, null, args, 0);\n"
541 + " return loader;\n"
544 " global.bck2brwsr.registerExtension = function(extension) {\n"
545 + " extensions.push(extension);\n"
552 protected String getExportsObject() {
557 protected boolean isExternalClass(String className) {
562 private static final class Extension extends VM {
563 private final StringArray extensionClasses;
565 private Extension(Appendable out, Bck2Brwsr.Resources resources,
566 String[] extClassesArray, StringArray explicitlyExported) {
567 super(out, resources, explicitlyExported);
568 this.extensionClasses = StringArray.asList(extClassesArray);
572 protected void generatePrologue() throws IOException {
573 append("bck2brwsr.registerExtension(function(exports) {\n"
574 + " var vm = {};\n");
575 append(" function link(n, inst) {\n"
576 + " var cls = n['replace__Ljava_lang_String_2CC']"
577 + "('/', '_').toString();\n"
578 + " var dot = n['replace__Ljava_lang_String_2CC']"
579 + "('/', '.').toString();\n"
580 + " exports.loadClass(dot);\n"
581 + " vm[cls] = exports[cls];\n"
582 + " return vm[cls](inst);\n"
587 protected void generateEpilogue() throws IOException {
592 protected String generateClass(String className) throws IOException {
593 if (isExternalClass(className)) {
594 append("\n").append(assignClass(
595 className.replace('/', '_')))
596 .append("function() {\n return link('")
598 .append("', arguments.length == 0 || arguments[0] === true);"
604 return super.generateClass(className);
608 protected String getExportsObject() {
613 protected boolean isExternalClass(String className) {
614 return !extensionClasses.contains(className);
618 private static void lazyReference(Appendable out, String n) throws IOException {
619 String cls = n.replace('/', '_');
620 String dot = n.replace('/', '.');
622 out.append("\nvm.").append(cls).append(" = function() {");
623 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
624 out.append("\n delete vm.").append(cls).append(";");
625 out.append("\n var c = vm.loadClass('").append(dot).append("');");
626 out.append("\n return vm.").append(cls).append("(instance);");