Better to not do any processign as '...*/*...' string can break our simple check. Keep comments in and let obfuscator remove them
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;
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 StringArray();
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 fixedNames.add(Object.class.getName().replace('.', '/'));
74 fixedNames.add(Class.class.getName().replace('.', '/'));
75 fixedNames.add(ArithmeticException.class.getName().replace('.', '/'));
78 if (config.isExtension()) {
79 fixedNames.add(VM.class.getName().replace('.', '/'));
80 vm = new Extension(out,
81 config.getResources(), both, config.exported(),
82 config.allResources(), config.classpath()
85 if (config.includeVM()) {
86 fixedNames.add(VM.class.getName().replace('.', '/'));
88 vm = new Standalone(out,
89 config.getResources(), config.exported(),
93 vm.doCompile(fixedNames.addAndNew(both));
96 private void doCompile(StringArray names) throws IOException {
99 "\n var invoker = {};");
101 for (String invokerMethod: invokerMethods.toArray()) {
102 append("\n invoker." + invokerMethod + " = function() {"
103 + "\n var target = arguments[0];"
104 + "\n return target['" + invokerMethod + "'].apply(target, Array.prototype.slice.call(arguments, 1));"
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);
153 protected abstract void lazyReference(Appendable out, String n) throws IOException;
156 protected final void declaredClass(ClassData classData, String mangledName)
158 if (exportedSymbols.isExported(classData)) {
159 append("\n").append(getExportsObject()).append("['")
162 .append(accessClass(mangledName))
168 protected String generateClass(String className) throws IOException {
169 ClassData classData = classDataCache.getClassData(className);
170 if (classData == null) {
171 throw new IOException("Can't find class " + className);
173 return compile(classData);
177 protected void declaredField(FieldData fieldData,
179 String mangledName) throws IOException {
180 if (exportedSymbols.isExported(fieldData)) {
181 exportMember(destObject, mangledName);
186 protected void declaredMethod(MethodData methodData,
188 String mangledName) throws IOException {
189 if (isHierarchyExported(methodData)) {
190 exportMember(destObject, mangledName);
194 private void exportMember(String destObject, String memberName)
196 append("\n").append(destObject).append("['")
198 .append("'] = m;\n");
201 private void generateBody(StringArray names) throws IOException {
202 StringArray processed = new StringArray();
203 StringArray initCode = new StringArray();
204 StringArray skipClass = new StringArray();
205 for (String baseClass : names.toArray()) {
206 references.add(baseClass);
209 for (String n : references.toArray()) {
210 if (skipClass.contains(n)) {
213 if (processed.contains(n)) {
221 InputStream is = resources.get(name + ".class");
223 lazyReference(this, name);
228 String ic = generateClass(name);
230 initCode.add(ic == null ? "" : ic);
231 } catch (RuntimeException ex) {
232 throw new IOException("Error while compiling " + name + "\n", ex);
236 for (String resource : scripts.toArray()) {
237 while (resource.startsWith("/")) {
238 resource = resource.substring(1);
240 requireResourceImpl(resource);
241 asBinary.remove(resource);
243 scripts = new StringArray();
245 StringArray toInit = StringArray.asList(references.toArray());
248 for (String ic : toInit.toArray()) {
249 int indx = processed.indexOf(ic);
251 final String theCode = initCode.toArray()[indx];
252 if (!theCode.isEmpty()) {
253 append(theCode).append("\n");
255 initCode.toArray()[indx] = "";
261 final void requireResourceImpl(String resource) throws IOException {
262 InputStream emul = resources.get(resource);
264 throw new IOException("Can't find " + resource);
266 append("\n// resource from ").append(resource).append("\n");
267 readResource(emul, this);
271 private static void readResource(InputStream emul, Appendable out) throws IOException {
275 int ch = emul.read();
279 if (ch < 0 || ch > 255) {
280 throw new IOException("Invalid char in emulation " + ch);
282 out.append((char)ch);
289 static String toString(String name) throws IOException {
290 StringBuilder sb = new StringBuilder();
291 // compile(sb, name);
292 return sb.toString().toString();
295 private StringArray scripts = new StringArray();
296 private StringArray references = new StringArray();
299 protected boolean requireReference(String cn) {
300 if (references.contains(cn)) {
308 protected void requireScript(String resourcePath) {
309 scripts.add(resourcePath);
313 String assignClass(String className) {
314 return "vm." + className + " = ";
318 String accessClass(String className) {
319 return "vm." + className;
323 protected String accessField(String object, String mangledName,
324 String[] fieldInfoName) throws IOException {
325 final FieldData field =
326 classDataCache.findField(fieldInfoName[0],
329 return accessNonVirtualMember(object, mangledName,
330 (field != null) ? field.cls : null);
334 protected String accessStaticMethod(
337 String[] fieldInfoName) throws IOException {
338 final MethodData method =
339 classDataCache.findMethod(fieldInfoName[0],
342 return accessNonVirtualMember(object, mangledName,
343 (method != null) ? method.cls : null);
347 protected String accessVirtualMethod(
350 String[] fieldInfoName,
352 ) throws IOException {
353 final ClassData referencedClass =
354 classDataCache.getClassData(fieldInfoName[0]);
355 final MethodData method =
356 classDataCache.findMethod(referencedClass,
361 && !isExternalClass(method.cls.getClassName())
362 && (((method.access & ByteCodeParser.ACC_FINAL) != 0)
363 || ((referencedClass.getAccessFlags()
364 & ByteCodeParser.ACC_FINAL) != 0)
365 || !isHierarchyExported(method))) {
366 return object + "." + mangledName + '(';
369 return accessThroughInvoker(object, mangledName, params > 1 ? "," : "");
372 private String accessThroughInvoker(String object, String mangledName, String sep) {
373 if (!invokerMethods.contains(mangledName)) {
374 invokerMethods.add(mangledName);
376 return "invoker." + mangledName + '(' + object + sep;
379 private boolean isHierarchyExported(final MethodData methodData)
381 if (exportedSymbols.isExported(methodData)) {
384 if ((methodData.access & (ByteCodeParser.ACC_PRIVATE
385 | ByteCodeParser.ACC_STATIC)) != 0) {
389 final ExportedMethodFinder exportedMethodFinder =
390 new ExportedMethodFinder(exportedSymbols);
392 classDataCache.findMethods(
394 methodData.getName(),
395 methodData.getInternalSig(),
396 exportedMethodFinder);
398 return (exportedMethodFinder.getFound() != null);
401 private String accessNonVirtualMember(String object,
403 ClassData declaringClass) {
404 if (declaringClass == null) {
405 return object + "['" + mangledName + "']";
407 final String className = declaringClass.getClassName();
409 "java/lang/Object".equals(className) ||
410 "java/lang/reflect/Array".equals(className) ||
411 isExternalClass(className)
413 return object + "['" + mangledName + "']";
415 return object + "." + mangledName;
418 private final class ExportedMethodFinder
419 implements ClassDataCache.TraversalCallback<MethodData> {
420 private final ExportedSymbols exportedSymbols;
421 private MethodData found;
423 public ExportedMethodFinder(final ExportedSymbols exportedSymbols) {
424 this.exportedSymbols = exportedSymbols;
428 public boolean traverse(final MethodData methodData) {
431 exportedSymbols.isExported(methodData) ||
432 isExternalClass(methodData.cls.getClassName())
437 } catch (final IOException e) {
443 public MethodData getFound() {
448 private static final class Standalone extends VM {
449 private Standalone(Appendable out,
450 Bck2Brwsr.Resources resources,
451 StringArray explicitlyExported, StringArray asBinary
453 super(out, resources, explicitlyExported, asBinary);
457 protected void generatePrologue() throws IOException {
458 append("(function VM(global) {var fillInVMSkeleton = function(vm) {");
462 protected void generateEpilogue() throws IOException {
466 + " var extensions = [];\n"
467 + " function replaceAll(s, target, replacement) {\n"
470 + " var indx = s.indexOf(target, pos);\n"
471 + " if (indx === -1) {\n"
474 + " pos = indx + replacement.length;\n"
475 + " s = s.substring(0, indx) + replacement + s.substring(indx + target.length);\n"
478 + " function mangleClass(name) {\n"
479 + " name = replaceAll(name, '_', '_1');\n"
480 + " name = replaceAll(name, '.', '_');\n"
483 + " var pending = [];\n"
484 + " var pendingClasses = [];\n"
485 + " function extensionLoaded(ev) {\n"
486 + " var at = pending.indexOf(ev.target);\n"
487 + " pending.splice(at, 1);\n"
488 + " if (pending.length === 0) {\n"
489 + " for (var i = 0; i < pendingClasses.length; i += 3) {\n"
490 + " invokeMethod(pendingClasses[i], pendingClasses[i + 1], pendingClasses[i + 2]);\n"
492 + " pendingClasses = [];\n"
495 + " function invokeMethod(vm, n, args) {\n"
496 + " var clazz = vm.loadClass(n);\n"
498 + " var seek = args[0];\n"
499 + " var prefix = seek.indexOf('__') == -1 ? seek + '__' : seek;\n"
500 + " args = Array.prototype.slice.call(args, 1);\n"
501 + " var found = '';\n"
502 + " for (var m in clazz) {\n"
503 + " if (m.indexOf(prefix) === 0) {\n"
504 + " return clazz[m].apply(null, args);\n"
506 + " found += m.toString() + '\\n'\n"
508 + " throw 'Cannot find ' + seek + ' in ' + n + ' found:\\n' + found;\n"
511 + " function extensionError(ev) {\n"
512 + " console.log('error loading ' + ev.target.src);\n"
513 + " extensionLoaded(ev);\n"
515 + " function loadExtension(url) {\n"
516 + " if (url.substring(url.length - 4) == '.jar')\n"
517 + " url = url.substring(0, url.length - 4) + '.js';\n"
518 + " var script = document.createElement('script');\n"
519 + " script.type = 'text/javascript';\n"
520 + " script.src = url;\n"
521 + " script.onload = extensionLoaded;\n"
522 + " script.onerror = extensionError;\n"
523 + " document.getElementsByTagName('head')[0].appendChild(script);\n"
524 + " pending.push(script);\n"
526 + " global.bck2brwsr = function() {\n"
527 + " var args = Array.prototype.slice.apply(arguments);\n"
528 + " var resources = {};\n"
529 + " function registerResource(n, a64) {\n"
530 + " var frm = atob || window.atob;\n"
531 + " var str = frm(a64);\n"
533 + " for (var i = 0; i < str.length; i++) {\n"
534 + " var ch = str.charCodeAt(i) & 0xff;\n"
535 + " if (ch > 127) ch -= 256;\n"
538 + " if (!resources[n]) resources[n] = [arr];\n"
539 + " else resources[n].push(arr);\n"
541 + " var vm = fillInVMSkeleton({ 'registerResource' : registerResource });\n"
542 + " function initVM() {\n"
543 + " var clsArray = vm['java_lang_reflect_Array'];\n"
544 + " if (clsArray) clsArray(false);\n"
546 + " for (var i = 0; i < extensions.length; ++i) {\n"
547 + " extensions[i](vm);\n"
549 + " vm['registerResource'] = null;\n"
550 + " var knownExtensions = extensions.length;\n"
551 + " var loader = {};\n"
552 + " var loadBytes = function(name, skip) {\n"
553 + " skip = typeof skip == 'number' ? skip : 0;\n"
554 + " var arr = resources[name];\n"
556 + " var arrSize = arr.length;\n"
557 + " if (skip < arrSize) return arr[skip];\n"
558 + " skip -= arrSize;\n"
560 + " var arrSize = 0;\n"
562 + " for (var i = 0; i < args.length; i++) {\n"
563 + " var at = args[i];\n"
564 + " if(!at) continue;\n"
566 + " if (typeof at === 'string' && at.substring(at.length - 3) === '.js') {\n"
567 + " loadExtension(at);\n"
568 + " args[i] = null;\n"
569 + " } else if (typeof at === 'function') ret = at(name, skip);\n"
571 + " var cp = vm['org_apidesign_vm4brwsr_ClassPath'];\n"
572 + " if (!cp) throw 'Core Java library not registered. Cannot load from ' + at;\n"
573 + " ret = cp(false).\n"
574 + " loadBytes___3BLjava_lang_String_2Ljava_lang_Object_2II(name, args, i, skip);\n"
576 + " if (ret) return ret;\n"
578 + " while (knownExtensions < extensions.length) {\n"
579 + " vm['registerResource'] = registerResource;\n"
580 + " extensions[knownExtensions++](vm);\n"
581 + " vm['registerResource'] = null;\n"
584 + " var arr = resources[name];\n"
585 + " return (arr && arr.length > arrSize) ? arr[arrSize] : null;\n"
587 + " var reload = function(name, arr, keep) {\n"
588 + " if (!arr) throw 'Cannot find ' + name;\n"
589 + " var lazy = vm['org_apidesign_vm4brwsr_VMLazy'];\n"
590 + " if (!lazy) throw 'No bck2brwsr VM module to compile ' + name;\n"
592 + " var attr = mangleClass(name);\n"
593 + " delete vm[attr];\n"
595 + " return lazy(false)\n"
596 + " ['load__Ljava_lang_Object_2Ljava_lang_Object_2Ljava_lang_String_2_3Ljava_lang_Object_2_3B']\n"
597 + " (vm, name, args, arr);\n"
599 + " var loadClass = function(name) {\n"
600 + " var attr = mangleClass(name);\n"
601 + " var fn = vm[attr];\n"
602 + " if (fn) return fn(false);\n"
604 + " var arr = loadBytes(replaceAll(name, '.', '/') + '.class');\n"
605 + " return reload(name, arr, true);\n"
606 + " } catch (err) {\n"
607 + " fn = vm[attr];\n"
608 + " if (fn) return fn(false);\n"
612 + " if (vm['loadClass']) {\n"
613 + " throw 'Cannot initialize the bck2brwsr VM twice!';\n"
615 + " vm['loadClass'] = loadClass;\n"
616 + " vm['_reload'] = reload;\n"
617 + " vm['loadBytes'] = loadBytes;\n"
619 + " loader.loadClass = function(name) {\n"
620 + " if (pending.length === 0) {\n"
622 + " var c = loadClass(name);\n"
623 + " c['invoke'] = function() {\n"
624 + " return invokeMethod(vm, name, arguments);\n"
627 + " } catch (err) {\n"
628 + " if (pending.length === 0) throw err;\n"
631 + " pendingClasses.push(vm);\n"
632 + " pendingClasses.push(name);\n"
633 + " pendingClasses.push(null);\n"
635 + " 'invoke' : function() {\n"
636 + " if (pending.length === 0) {\n"
637 + " invokeMethod(vm, name, arguments);\n"
640 + " pendingClasses.push(vm);\n"
641 + " pendingClasses.push(name);\n"
642 + " pendingClasses.push(arguments);\n"
646 + " return loader;\n"
649 " global.bck2brwsr.register = function(config, extension) {\n"
650 + " if (!config || config['magic'] !== 'kafíčko') {\n"
651 + " console.log('Will not register: ' + extension);\n"
654 + " extensions.push(extension);\n"
655 + " var cp = config['classpath'];\n"
656 + " if (cp) for (var i = 0; i < cp.length; i++) {\n"
657 + " loadExtension(cp[i]);\n"
665 protected String getExportsObject() {
670 protected boolean isExternalClass(String className) {
675 protected void lazyReference(Appendable out, String n) throws IOException {
676 String cls = n.replace('/', '_');
677 String dot = n.replace('/', '.');
679 out.append("\nvm.").append(cls).append(" = function() {");
680 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
681 out.append("\n delete vm.").append(cls).append(";");
682 out.append("\n var c = vm.loadClass('").append(dot).append("');");
683 out.append("\n return vm.").append(cls).append("(instance);");
688 protected void requireResource(String resourcePath) throws IOException {
689 requireResourceImpl(resourcePath);
693 private static final class Extension extends VM {
694 private final StringArray extensionClasses;
695 private final StringArray classpath;
697 private Extension(Appendable out, Bck2Brwsr.Resources resources,
698 String[] extClassesArray, StringArray explicitlyExported,
699 StringArray asBinary, StringArray classpath
700 ) throws IOException {
701 super(out, resources, explicitlyExported, asBinary);
702 this.extensionClasses = StringArray.asList(extClassesArray);
703 this.classpath = classpath;
707 protected void generatePrologue() throws IOException {
709 "bck2brwsr.register({\n"
710 + " 'magic' : 'kafíčko'"
712 if (classpath != null && classpath.toArray().length > 0) {
714 ",\n 'classpath' : [\n"
717 for (String s : classpath.toArray()) {
718 append(sep).append("'").append(s).append("'");
726 "\n}, function(exports) {\n"
727 + " var vm = {};\n");
728 append(" function link(n, assign) {\n"
729 + " return function() {\n"
730 + " var cls = n['replace__Ljava_lang_String_2CC']"
731 + "('/', '_').toString();\n"
732 + " var dot = n['replace__Ljava_lang_String_2CC']"
733 + "('/', '.').toString();\n"
734 + " exports.loadClass(dot);\n"
735 + " assign(exports[cls]);\n"
736 + " return exports[cls](arguments);\n"
743 protected void generateEpilogue() throws IOException {
745 if (exportedCount == 0) {
746 throw new IOException("Creating library without any exported symbols is useless!");
751 protected String generateClass(String className) throws IOException {
752 if (isExternalClass(className)) {
753 final String cls = className.replace('/', '_');
754 append("\n").append(assignClass(cls))
757 .append("', function(f) { ").append(assignClass(cls)).append(" f; });");
762 return super.generateClass(className);
766 protected String getExportsObject() {
771 protected boolean isExternalClass(String className) {
772 return !extensionClasses.contains(className);
776 protected void lazyReference(Appendable out, String n) throws IOException {
777 String cls = n.replace('/', '_');
779 out.append("\nvm.").append(cls).append(" = function() {");
780 out.append("\n var instance = arguments.length == 0 || arguments[0] === true;");
781 out.append("\n delete vm.").append(cls).append(";");
782 out.append("\n return link('").append(n).append("', function(f) { vm.");
783 out.append(cls).append(" = f;})(instance);");
788 protected void requireResource(String resourcePath) throws IOException {
789 requireResourceImpl(resourcePath);