rt/vm/src/main/java/org/apidesign/vm4brwsr/VM.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Thu, 22 May 2014 19:06:44 +0200
branchclosure
changeset 1587 bf08bd96d408
parent 1584 7b6295731c30
child 1589 b66d6e7756bb
permissions -rw-r--r--
Don't include @JavaScriptResource resources in generated JavaScript
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     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.
     8  *
     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.
    13  *
    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.
    17  */
    18 package org.apidesign.vm4brwsr;
    19 
    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;
    26 
    27 /** Generator of JavaScript from bytecode of classes on classpath of the VM.
    28  *
    29  * @author Jaroslav Tulach <jtulach@netbeans.org>
    30  */
    31 abstract class VM extends ByteCodeToJavaScript {
    32     protected final ClassDataCache classDataCache;
    33 
    34     private final Bck2Brwsr.Resources resources;
    35     private final ExportedSymbols exportedSymbols;
    36     private final StringArray invokerMethods;
    37     private final StringArray asBinary;
    38 
    39     private VM(
    40         Appendable out, Bck2Brwsr.Resources resources, 
    41         StringArray explicitlyExported, StringArray asBinary
    42     ) {
    43         super(out);
    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;
    49     }
    50 
    51     static {
    52         // uses VMLazy to load dynamic classes
    53         boolean assertsOn = false;
    54         assert assertsOn = true;
    55         if (assertsOn) {
    56             VMLazy.init();
    57             ClassPath.init();
    58         }
    59     }
    60 
    61     @Override
    62     boolean debug(String msg) throws IOException {
    63         return false;
    64     }
    65     
    66     static void compile(Appendable out, 
    67         Bck2Brwsr config
    68     ) throws IOException {
    69         String[] both = config.classes().toArray();
    70         
    71         final StringArray fixedNames = new StringArray();
    72         fixedNames.add(Class.class.getName().replace('.', '/'));
    73         fixedNames.add(ArithmeticException.class.getName().replace('.', '/'));
    74         
    75         VM vm;
    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()
    81             );
    82         } else {
    83             if (config.includeVM()) {
    84                 fixedNames.add(VM.class.getName().replace('.', '/'));
    85             }
    86             vm = new Standalone(out, 
    87                 config.getResources(), config.exported(),
    88                 config.allResources()
    89             );
    90         }            
    91         vm.doCompile(fixedNames.addAndNew(both));
    92     }
    93 
    94     private void doCompile(StringArray names) throws IOException {
    95         generatePrologue();
    96         append(
    97                 "\n  var invoker = {};");
    98         generateBody(names);
    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);"
   103                 + "\n    };"
   104                 + "\n  };"
   105             );
   106         }
   107         
   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()];
   113             int offset = 0;
   114             for (;;) {
   115                 if (offset == arr.length) {
   116                     byte[] tmp = new byte[arr.length * 2];
   117                     System.arraycopy(arr, 0, tmp, 0, arr.length);
   118                     arr = tmp;
   119                 }
   120                 int len = is.read(arr, offset, arr.length - offset);
   121                 if (len == -1) {
   122                     break;
   123                 }
   124                 offset += len;
   125             }
   126             if (offset != arr.length) {
   127                 byte[] tmp = new byte[offset];
   128                 System.arraycopy(arr, 0, tmp, 0, offset);
   129                 arr = tmp;
   130             }
   131             append(btoa(arr));
   132             append("');");
   133         }
   134         
   135         append("\n");
   136         generateEpilogue();
   137     }
   138 
   139     @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
   140     private static String btoa(byte[] arr) {
   141         return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
   142     }
   143 
   144     protected abstract void generatePrologue() throws IOException;
   145 
   146     protected abstract void generateEpilogue() throws IOException;
   147 
   148     protected abstract String getExportsObject();
   149 
   150     protected abstract boolean isExternalClass(String className);
   151 
   152     @Override
   153     protected final void declaredClass(ClassData classData, String mangledName)
   154             throws IOException {
   155         if (exportedSymbols.isExported(classData)) {
   156             append("\n").append(getExportsObject()).append("['")
   157                                                .append(mangledName)
   158                                                .append("'] = ")
   159                             .append(accessClass(mangledName))
   160                .append(";\n");
   161         }
   162     }
   163 
   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);
   168         }
   169         return compile(classData);
   170     }
   171 
   172     @Override
   173     protected void declaredField(FieldData fieldData,
   174                                  String destObject,
   175                                  String mangledName) throws IOException {
   176         if (exportedSymbols.isExported(fieldData)) {
   177             exportMember(destObject, mangledName);
   178         }
   179     }
   180 
   181     @Override
   182     protected void declaredMethod(MethodData methodData,
   183                                   String destObject,
   184                                   String mangledName) throws IOException {
   185         if (isHierarchyExported(methodData)) {
   186             exportMember(destObject, mangledName);
   187         }
   188     }
   189 
   190     private void exportMember(String destObject, String memberName)
   191             throws IOException {
   192         append("\n").append(destObject).append("['")
   193                                            .append(memberName)
   194                                            .append("'] = ")
   195                         .append(destObject).append(".").append(memberName)
   196            .append(";\n");
   197     }
   198 
   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);
   205             for (;;) {
   206                 String name = null;
   207                 for (String n : references.toArray()) {
   208                     if (skipClass.contains(n)) {
   209                         continue;
   210                     }
   211                     if (processed.contains(n)) {
   212                         continue;
   213                     }
   214                     name = n;
   215                 }
   216                 if (name == null) {
   217                     break;
   218                 }
   219                 InputStream is = resources.get(name + ".class");
   220                 if (is == null) {
   221                     lazyReference(this, name);
   222                     skipClass.add(name);
   223                     continue;
   224                 }
   225                 try {
   226                     String ic = generateClass(name);
   227                     processed.add(name);
   228                     initCode.add(ic == null ? "" : ic);
   229                 } catch (RuntimeException ex) {
   230                     throw new IOException("Error while compiling " + name + "\n", ex);
   231                 }
   232             }
   233 
   234             for (String resource : scripts.toArray()) {
   235                 while (resource.startsWith("/")) {
   236                     resource = resource.substring(1);
   237                 }
   238                 InputStream emul = resources.get(resource);
   239                 if (emul == null) {
   240                     throw new IOException("Can't find " + resource);
   241                 }
   242                 readResource(emul, this);
   243                 asBinary.remove(resource);
   244             }
   245             scripts = new StringArray();
   246 
   247             StringArray toInit = StringArray.asList(references.toArray());
   248             toInit.reverse();
   249 
   250             for (String ic : toInit.toArray()) {
   251                 int indx = processed.indexOf(ic);
   252                 if (indx >= 0) {
   253                     final String theCode = initCode.toArray()[indx];
   254                     if (!theCode.isEmpty()) {
   255                         append(theCode).append("\n");
   256                     }
   257                     initCode.toArray()[indx] = "";
   258                 }
   259             }
   260         }
   261     }
   262 
   263     private static void readResource(InputStream emul, Appendable out) throws IOException {
   264         try {
   265             int state = 0;
   266             for (;;) {
   267                 int ch = emul.read();
   268                 if (ch == -1) {
   269                     break;
   270                 }
   271                 if (ch < 0 || ch > 255) {
   272                     throw new IOException("Invalid char in emulation " + ch);
   273                 }
   274                 switch (state) {
   275                     case 0: 
   276                         if (ch == '/') {
   277                             state = 1;
   278                         } else {
   279                             out.append((char)ch);
   280                         }
   281                         break;
   282                     case 1:
   283                         if (ch == '*') {
   284                             state = 2;
   285                         } else {
   286                             out.append('/').append((char)ch);
   287                             state = 0;
   288                         }
   289                         break;
   290                     case 2:
   291                         if (ch == '*') {
   292                             state = 3;
   293                         }
   294                         break;
   295                     case 3:
   296                         if (ch == '/') {
   297                             state = 0;
   298                         } else {
   299                             state = 2;
   300                         }
   301                         break;
   302                 }
   303             }
   304         } finally {
   305             emul.close();
   306         }
   307     }
   308 
   309     static String toString(String name) throws IOException {
   310         StringBuilder sb = new StringBuilder();
   311 //        compile(sb, name);
   312         return sb.toString().toString();
   313     }
   314 
   315     private StringArray scripts = new StringArray();
   316     private StringArray references = new StringArray();
   317     
   318     @Override
   319     protected boolean requireReference(String cn) {
   320         if (references.contains(cn)) {
   321             return false;
   322         }
   323         references.add(cn);
   324         return true;
   325     }
   326 
   327     @Override
   328     protected void requireScript(String resourcePath) {
   329         scripts.add(resourcePath);
   330     }
   331 
   332     @Override
   333     String assignClass(String className) {
   334         return "vm." + className + " = ";
   335     }
   336     
   337     @Override
   338     String accessClass(String className) {
   339         return "vm." + className;
   340     }
   341 
   342     @Override
   343     protected String accessField(String object, String mangledName,
   344                                  String[] fieldInfoName) throws IOException {
   345         final FieldData field =
   346                 classDataCache.findField(fieldInfoName[0],
   347                                          fieldInfoName[1],
   348                                          fieldInfoName[2]);
   349         return accessNonVirtualMember(object, mangledName,
   350                                       (field != null) ? field.cls : null);
   351     }
   352 
   353     @Override
   354     protected String accessStaticMethod(
   355                              String object,
   356                              String mangledName,
   357                              String[] fieldInfoName) throws IOException {
   358         final MethodData method =
   359                 classDataCache.findMethod(fieldInfoName[0],
   360                                           fieldInfoName[1],
   361                                           fieldInfoName[2]);
   362         return accessNonVirtualMember(object, mangledName,
   363                                       (method != null) ? method.cls : null);
   364     }
   365 
   366     @Override
   367     protected String accessVirtualMethod(
   368                              String object,
   369                              String mangledName,
   370                              String[] fieldInfoName) throws IOException {
   371         final ClassData referencedClass =
   372                 classDataCache.getClassData(fieldInfoName[0]);
   373         final MethodData method =
   374                 classDataCache.findMethod(referencedClass,
   375                                           fieldInfoName[1],
   376                                           fieldInfoName[2]);
   377 
   378         if ((method != null)
   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;
   385         }
   386 
   387         return accessThroughInvoker(object, mangledName);
   388     }
   389 
   390     private String accessThroughInvoker(String object, String mangledName) {
   391         if (!invokerMethods.contains(mangledName)) {
   392             invokerMethods.add(mangledName);
   393         }
   394         return "invoker." + mangledName + '(' + object + ')';
   395     }
   396 
   397     private boolean isHierarchyExported(final MethodData methodData)
   398             throws IOException {
   399         if (exportedSymbols.isExported(methodData)) {
   400             return true;
   401         }
   402         if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
   403                                       | ByteCodeParser.ACC_STATIC)) != 0) {
   404             return false;
   405         }
   406 
   407         final ExportedMethodFinder exportedMethodFinder =
   408                 new ExportedMethodFinder(exportedSymbols);
   409 
   410         classDataCache.findMethods(
   411                 methodData.cls,
   412                 methodData.getName(),
   413                 methodData.getInternalSig(),
   414                 exportedMethodFinder);
   415 
   416         return (exportedMethodFinder.getFound() != null);
   417     }
   418 
   419     private String accessNonVirtualMember(String object,
   420                                           String mangledName,
   421                                           ClassData declaringClass) {
   422         return ((declaringClass != null)
   423                     && !isExternalClass(declaringClass.getClassName()))
   424                             ? object + "." + mangledName
   425                             : object + "['" + mangledName + "']";
   426     }
   427 
   428     private static final class ExportedMethodFinder
   429             implements ClassDataCache.TraversalCallback<MethodData> {
   430         private final ExportedSymbols exportedSymbols;
   431         private MethodData found;
   432 
   433         public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
   434             this.exportedSymbols = exportedSymbols;
   435         }
   436 
   437         @Override
   438         public boolean traverse(final MethodData methodData) {
   439             try {
   440                 if (exportedSymbols.isExported(methodData)) {
   441                     found = methodData;
   442                     return false;
   443                 }
   444             } catch (final IOException e) {
   445             }
   446 
   447             return true;
   448         }
   449 
   450         public MethodData getFound() {
   451             return found;
   452         }
   453     }
   454 
   455     private static final class Standalone extends VM {
   456         private Standalone(Appendable out,
   457             Bck2Brwsr.Resources resources, 
   458             StringArray explicitlyExported, StringArray asBinary
   459         ) {
   460             super(out, resources, explicitlyExported, asBinary);
   461         }
   462 
   463         @Override
   464         protected void generatePrologue() throws IOException {
   465             append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
   466         }
   467 
   468         @Override
   469         protected void generateEpilogue() throws IOException {
   470             append(
   471                   "  return vm;\n"
   472                 + "  };\n"
   473                 + "  var extensions = [];\n"
   474                 + "  function replaceAll(s, target, replacement) {\n"
   475                 + "    var pos = 0;\n"
   476                 + "    for (;;) {\n"
   477                 + "      var indx = s.indexOf(target, pos);\n"
   478                 + "      if (indx === -1) {\n"
   479                 + "        return s;\n"
   480                 + "      }\n"
   481                 + "      pos = indx + replacement.length;\n"
   482                 + "      s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
   483                 + "    }\n"
   484                 + "  }\n"
   485                 + "  function mangleClass(name) {\n"
   486                 + "    name = replaceAll(name, '_', '_1');\n"
   487                 + "    name = replaceAll(name, '.', '_');\n"
   488                 + "    return name;\n"
   489                 + "  };\n"
   490                 + "  global.bck2brwsr = function() {\n"
   491                 + "    var args = Array.prototype.slice.apply(arguments);\n"
   492                 + "    var resources = {};\n"
   493                 + "    function registerResource(n, a64) {\n"
   494                 + "      var str = atob(a64);\n"
   495                 + "      var arr = [];\n"
   496                 + "      for (var i = 0; i < str.length; i++) {\n"
   497                 + "        var ch = str.charCodeAt(i) & 0xff;\n"
   498                 + "        if (ch > 127) ch -= 256;\n"
   499                 + "        arr.push(ch);\n"
   500                 + "      }\n"
   501                 + "      if (!resources[n]) resources[n] = [arr];\n"
   502                 + "      else resources[n].push(arr);\n"
   503                 + "    }\n"
   504                 + "    var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
   505                 + "    function initVM() {\n"
   506                 + "      var clsArray = vm['java_lang_reflect_Array'];\n"
   507                 + "      if (clsArray) clsArray(false);\n"
   508                 + "    }\n"
   509                 + "    for (var i = 0; i < extensions.length; ++i) {\n"
   510                 + "      extensions[i](vm);\n"
   511                 + "    }\n"
   512                 + "    vm['registerResource'] = null;\n"
   513                 + "    var knownExtensions = extensions.length;\n"
   514                 + "    var loader = {};\n"
   515                 + "    var loadBytes = function(name, skip) {\n"
   516                 + "      skip = typeof skip == 'number' ? skip : 0;\n"
   517                 + "      var arr = resources[name];\n"
   518                 + "      if (arr) {\n"
   519                 + "        var arrSize = arr.length;\n"
   520                 + "        if (skip < arrSize) return arr[skip];\n"
   521                 + "        skip -= arrSize;\n"
   522                 + "      } else {\n"
   523                 + "        var arrSize = 0;\n"
   524                 + "      };\n"
   525                 + "      for (var i = 0; i < args.length; i++) {\n"
   526                 + "        var at = args[i];\n"
   527                 + "        var ret;\n"
   528                 + "        if (typeof at === 'function') ret = at(name, skip);\n"
   529                 + "        else ret = vm['org_apidesign_vm4brwsr_ClassPath'](false).\n"
   530                 + "          loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II(name, args, i, skip);\n"
   531                 + "        if (ret !== null) return ret;\n"
   532                 + "      }\n"
   533                 + "      while (knownExtensions < extensions.length) {\n"
   534                 + "        vm['registerResource'] = registerResource;\n"
   535                 + "        extensions[knownExtensions++](vm);\n"
   536                 + "        vm['registerResource'] = null;\n"
   537                 + "        initVM();\n"
   538                 + "      }\n"
   539                 + "      var arr = resources[name];\n"
   540                 + "      return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
   541                 + "    }\n"
   542                 + "    var reload = function(name, arr, keep) {;\n"
   543                 + "      if (!keep) {\n"
   544                 + "        var attr = mangleClass(name);\n"
   545                 + "        delete vm[attr];\n"
   546                 + "      }\n"
   547                 + "      return vm['org_apidesign_vm4brwsr_VMLazy'](false)\n"
   548                 + "        ['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
   549                 + "        (vm, name, args, arr);\n"
   550                 + "    };\n"
   551                 + "    loader.loadClass = function(name) {\n"
   552                 + "      var attr = mangleClass(name);\n"
   553                 + "      var fn = vm[attr];\n"
   554                 + "      if (fn) return fn(false);\n"
   555                 + "      try {\n"
   556                 + "        var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
   557                 + "        return reload(name, arr, true);\n"
   558                 + "      } catch (err) {\n"
   559                 + "        fn = vm[attr];\n"
   560                 + "        if (fn) return fn(false);\n"
   561                 + "        throw err;\n"
   562                 + "      }\n"
   563                 + "    }\n"
   564                 + "    if (vm['loadClass']) {\n"
   565                 + "      throw 'Cannot initialize the bck2brwsr VM twice!';\n"
   566                 + "    }\n"
   567                 + "    vm['loadClass'] = loader.loadClass;\n"
   568                 + "    vm['_reload'] = reload;\n"
   569                 + "    vm['loadBytes'] = loadBytes;\n"
   570                 + "    initVM();\n"
   571                 + "    return loader;\n"
   572                 + "  };\n");
   573             append(
   574                   "  global.bck2brwsr.registerExtension = function(extension) {\n"
   575                 + "    extensions.push(extension);\n"
   576                 + "    return null;\n"
   577                 + "  };\n");
   578             append("}(this));");
   579         }
   580 
   581         @Override
   582         protected String getExportsObject() {
   583             return "vm";
   584         }
   585 
   586         @Override
   587         protected boolean isExternalClass(String className) {
   588             return false;
   589         }
   590     }
   591 
   592     private static final class Extension extends VM {
   593         private final StringArray extensionClasses;
   594 
   595         private Extension(Appendable out, Bck2Brwsr.Resources resources,
   596             String[] extClassesArray, StringArray explicitlyExported,
   597             StringArray asBinary
   598         ) {
   599             super(out, resources, explicitlyExported, asBinary);
   600             this.extensionClasses = StringArray.asList(extClassesArray);
   601         }
   602 
   603         @Override
   604         protected void generatePrologue() throws IOException {
   605             append("bck2brwsr.registerExtension(function(exports) {\n"
   606                            + "  var vm = {};\n");
   607             append("  function link(n) {\n"
   608                 + "    return function() {\n"
   609                 + "      var cls = n['replace__Ljava_lang_String_2CC']"
   610                                        + "('/', '_').toString();\n"
   611                 + "      var dot = n['replace__Ljava_lang_String_2CC']"
   612                                        + "('/', '.').toString();\n"
   613                 + "      exports.loadClass(dot);\n"
   614                 + "      vm[cls] = exports[cls];\n"
   615                 + "      return vm[cls](arguments);\n"
   616                 + "    };\n"
   617                 + "  };\n"
   618             );
   619         }
   620 
   621         @Override
   622         protected void generateEpilogue() throws IOException {
   623             append("});");
   624         }
   625 
   626         @Override
   627         protected String generateClass(String className) throws IOException {
   628             if (isExternalClass(className)) {
   629                 append("\n").append(assignClass(
   630                                             className.replace('/', '_')))
   631                    .append("link('")
   632                    .append(className)
   633                    .append("');");
   634 
   635                 return null;
   636             }
   637 
   638             return super.generateClass(className);
   639         }
   640 
   641         @Override
   642         protected String getExportsObject() {
   643             return "exports";
   644         }
   645 
   646         @Override
   647         protected boolean isExternalClass(String className) {
   648             return !extensionClasses.contains(className);
   649         }
   650     }
   651     
   652     private static void lazyReference(Appendable out, String n) throws IOException {
   653         String cls = n.replace('/', '_');
   654         String dot = n.replace('/', '.');
   655         
   656         out.append("\nvm.").append(cls).append(" = function() {");
   657         out.append("\n  var instance = arguments.length == 0 || arguments[0] === true;");
   658         out.append("\n  delete vm.").append(cls).append(";");
   659         out.append("\n  var c = vm.loadClass('").append(dot).append("');");
   660         out.append("\n  return vm.").append(cls).append("(instance);");
   661         out.append("\n}");
   662     }
   663 }