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 = function Invoker() {"
90 + "\n return Invoker.target[Invoker.method]"
91 + ".apply(Invoker.target, arguments);"
94 for (String invokerMethod: invokerMethods.toArray()) {
95 out.append("\n invoker." + invokerMethod + " = function(target) {"
96 + "\n invoker.target = target;"
97 + "\n invoker.method = '" + invokerMethod + "';"
98 + "\n return invoker;"
102 for (String r : asBinary.toArray()) {
103 out.append("\n ").append(getExportsObject()).append(".registerResource('");
104 out.append(r).append("', '");
105 InputStream is = this.resources.get(r);
106 byte[] arr = new byte[is.available()];
107 int len = is.read(arr);
108 if (len != arr.length) {
109 throw new IOException("Not read as much as expected for " + r + " expected: " + arr.length + " was: " + len);
111 out.append(btoa(arr));
119 @JavaScriptBody(args = { "arr" }, body = "return btoa(arr);")
120 private static String btoa(byte[] arr) {
121 return javax.xml.bind.DatatypeConverter.printBase64Binary(arr);
124 protected abstract void generatePrologue() throws IOException;
126 protected abstract void generateEpilogue() throws IOException;
128 protected abstract String getExportsObject();
130 protected abstract boolean isExternalClass(String className);
133 protected final void declaredClass(ClassData classData, String mangledName)
135 if (exportedSymbols.isExported(classData)) {
136 out.append("\n").append(getExportsObject()).append("['")
139 .append(accessClass(mangledName))
144 protected String generateClass(String className) throws IOException {
145 ClassData classData = classDataCache.getClassData(className);
146 if (classData == null) {
147 throw new IOException("Can't find class " + className);
149 return compile(classData);
153 protected void declaredField(FieldData fieldData,
155 String mangledName) throws IOException {
156 if (exportedSymbols.isExported(fieldData)) {
157 exportMember(destObject, mangledName);
162 protected void declaredMethod(MethodData methodData,
164 String mangledName) throws IOException {
165 if (isHierarchyExported(methodData)) {
166 exportMember(destObject, mangledName);
170 private void exportMember(String destObject, String memberName)
172 out.append("\n").append(destObject).append("['")
175 .append(destObject).append(".").append(memberName)
179 private void generateBody(StringArray names) throws IOException {
180 StringArray processed = new StringArray();
181 StringArray initCode = new StringArray();
182 for (String baseClass : names.toArray()) {
183 references.add(baseClass);
186 for (String n : references.toArray()) {
187 if (processed.contains(n)) {
197 String ic = generateClass(name);
199 initCode.add(ic == null ? "" : ic);
200 } catch (RuntimeException ex) {
201 if (out instanceof CharSequence) {
202 CharSequence seq = (CharSequence)out;
203 int lastBlock = seq.length();
204 while (lastBlock-- > 0) {
205 if (seq.charAt(lastBlock) == '{') {
209 throw new IOException("Error while compiling " + name + "\n"
210 + seq.subSequence(lastBlock + 1, seq.length()), ex
213 throw new IOException("Error while compiling " + name + "\n"
220 for (String resource : scripts.toArray()) {
221 while (resource.startsWith("/")) {
222 resource = resource.substring(1);
224 InputStream emul = resources.get(resource);
226 throw new IOException("Can't find " + resource);
228 readResource(emul, out);
230 scripts = new StringArray();
232 StringArray toInit = StringArray.asList(references.toArray());
235 for (String ic : toInit.toArray()) {
236 int indx = processed.indexOf(ic);
238 final String theCode = initCode.toArray()[indx];
239 if (!theCode.isEmpty()) {
240 out.append(theCode).append("\n");
242 initCode.toArray()[indx] = "";
248 private static void readResource(InputStream emul, Appendable out) throws IOException {
252 int ch = emul.read();
256 if (ch < 0 || ch > 255) {
257 throw new IOException("Invalid char in emulation " + ch);
264 out.append((char)ch);
271 out.append('/').append((char)ch);
294 static String toString(String name) throws IOException {
295 StringBuilder sb = new StringBuilder();
296 // compile(sb, name);
297 return sb.toString().toString();
300 private StringArray scripts = new StringArray();
301 private StringArray references = new StringArray();
304 protected boolean requireReference(String cn) {
305 if (references.contains(cn)) {
313 protected void requireScript(String resourcePath) {
314 scripts.add(resourcePath);
318 String assignClass(String className) {
319 return "vm." + className + " = ";
323 String accessClass(String className) {
324 return "vm." + className;
328 protected String accessField(String object, String mangledName,
329 String[] fieldInfoName) throws IOException {
330 final FieldData field =
331 classDataCache.findField(fieldInfoName[0],
334 return accessNonVirtualMember(object, mangledName,
335 (field != null) ? field.cls : null);
339 protected String accessStaticMethod(
342 String[] fieldInfoName) throws IOException {
343 final MethodData method =
344 classDataCache.findMethod(fieldInfoName[0],
347 return accessNonVirtualMember(object, mangledName,
348 (method != null) ? method.cls : null);
352 protected String accessVirtualMethod(
355 String[] fieldInfoName) throws IOException {
356 final ClassData referencedClass =
357 classDataCache.getClassData(fieldInfoName[0]);
358 final MethodData method =
359 classDataCache.findMethod(referencedClass,
364 && !isExternalClass(method.cls.getClassName())
365 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
366 || ((referencedClass.getAccessFlags()
367 & ByteCodeParser.ACC_FINAL) != 0)
368 || !isHierarchyExported(method))) {
369 return object + "." + mangledName;
372 return accessThroughInvoker(object, mangledName);
375 private String accessThroughInvoker(String object, String mangledName) {
376 if (!invokerMethods.contains(mangledName)) {
377 invokerMethods.add(mangledName);
379 return "invoker." + mangledName + '(' + object + ')';
382 private boolean isHierarchyExported(final MethodData methodData)
384 if (exportedSymbols.isExported(methodData)) {
387 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
388 | ByteCodeParser.ACC_STATIC)) != 0) {
392 final ExportedMethodFinder exportedMethodFinder =
393 new ExportedMethodFinder(exportedSymbols);
395 classDataCache.findMethods(
397 methodData.getName(),
398 methodData.getInternalSig(),
399 exportedMethodFinder);
401 return (exportedMethodFinder.getFound() != null);
404 private String accessNonVirtualMember(String object,
406 ClassData declaringClass) {
407 return ((declaringClass != null)
408 && !isExternalClass(declaringClass.getClassName()))
409 ? object + "." + mangledName
410 : object + "['" + mangledName + "']";
413 private static final class ExportedMethodFinder
414 implements ClassDataCache.TraversalCallback<MethodData> {
415 private final ExportedSymbols exportedSymbols;
416 private MethodData found;
418 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
419 this.exportedSymbols = exportedSymbols;
423 public boolean traverse(final MethodData methodData) {
425 if (exportedSymbols.isExported(methodData)) {
429 } catch (final IOException e) {
435 public MethodData getFound() {
440 private static final class Standalone extends VM {
441 private Standalone(Appendable out, Bck2Brwsr.Resources resources, StringArray explicitlyExported) {
442 super(out, resources, explicitlyExported);
446 protected void generatePrologue() throws IOException {
447 out.append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
451 protected void generateEpilogue() throws IOException {
455 + " var extensions = [];\n"
456 + " global.bck2brwsr = function() {\n"
457 + " var args = Array.prototype.slice.apply(arguments);\n"
458 + " var resources = {};\n"
459 + " function registerResource(n, a64) {\n"
460 + " var str = atob(a64);\n"
462 + " for (var i = 0; i < str.length; i++) {\n"
463 + " var ch = str.charCodeAt(i) & 0xff;\n"
464 + " if (ch > 127) ch -= 256;\n"
467 + " if (!resources[n]) resources[n] = [arr];\n"
468 + " else resources[n].push(arr);\n"
470 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
471 + " for (var i = 0; i < extensions.length; ++i) {\n"
472 + " extensions[i](vm);\n"
474 + " vm.registerResource = null;\n"
475 + " var knownExtensions = extensions.length;\n"
476 + " var loader = {};\n"
477 + " loader.vm = vm;\n"
478 + " loader.loadClass = function(name) {\n"
479 + " var attr = name.replace__Ljava_lang_String_2CC('.','_');\n"
480 + " var fn = vm[attr];\n"
481 + " if (fn) return fn(false);\n"
483 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
484 + " load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
485 + " } catch (err) {\n"
486 + " while (knownExtensions < extensions.length) {\n"
487 + " vm.registerResource = registerResource;\n"
488 + " extensions[knownExtensions++](vm);\n"
489 + " vm.registerResource = null;\n"
491 + " fn = vm[attr];\n"
492 + " if (fn) return fn(false);\n"
496 + " if (vm.loadClass) {\n"
497 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
499 + " vm.loadClass = loader.loadClass;\n"
500 + " vm.loadBytes = function(name) {\n"
501 + " if (resources[name]) return resources[name][0];\n"
502 + " return vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
503 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, name, args);\n"
505 + " vm.java_lang_reflect_Array(false);\n"
506 + " vm.org_apidesign_vm4brwsr_VMLazy(false).\n"
507 + " loadBytes___3BLjava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2(loader, null, args);\n"
508 + " return loader;\n"
511 " global.bck2brwsr.registerExtension = function(extension) {\n"
512 + " extensions.push(extension);\n"
515 out.append("}(this));");
519 protected String getExportsObject() {
524 protected boolean isExternalClass(String className) {
529 private static final class Extension extends VM {
530 private final StringArray extensionClasses;
532 private Extension(Appendable out, Bck2Brwsr.Resources resources,
533 String[] extClassesArray, StringArray explicitlyExported) {
534 super(out, resources, explicitlyExported);
535 this.extensionClasses = StringArray.asList(extClassesArray);
539 protected void generatePrologue() throws IOException {
540 out.append("bck2brwsr.registerExtension(function(exports) {\n"
541 + " var vm = {};\n");
542 out.append(" function link(n, inst) {\n"
543 + " var cls = n['replace__Ljava_lang_String_2CC']"
544 + "('/', '_').toString();\n"
545 + " var dot = n['replace__Ljava_lang_String_2CC']"
546 + "('/', '.').toString();\n"
547 + " exports.loadClass(dot);\n"
548 + " vm[cls] = exports[cls];\n"
549 + " return vm[cls](inst);\n"
554 protected void generateEpilogue() throws IOException {
559 protected String generateClass(String className) throws IOException {
560 if (isExternalClass(className)) {
561 out.append("\n").append(assignClass(
562 className.replace('/', '_')))
563 .append("function() {\n return link('")
565 .append("', arguments.length == 0 || arguments[0] === true);"
571 return super.generateClass(className);
575 protected String getExportsObject() {
580 protected boolean isExternalClass(String className) {
581 return !extensionClasses.contains(className);