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.javap.AnnotationParser;
23 import org.apidesign.javap.ClassData;
24 import org.apidesign.javap.FieldData;
25 import org.apidesign.javap.MethodData;
26 import static org.apidesign.javap.RuntimeConstants.*;
28 /** Translator of the code inside class files to JavaScript.
30 * @author Jaroslav Tulach <jtulach@netbeans.org>
32 public abstract class ByteCodeToJavaScript {
34 private final Appendable out;
36 protected ByteCodeToJavaScript(Appendable out) {
40 /* Collects additional required resources.
42 * @param internalClassName classes that were referenced and should be loaded in order the
43 * generated JavaScript code works properly. The names are in internal
44 * JVM form so String is <code>java/lang/String</code>.
46 protected abstract boolean requireReference(String internalClassName);
49 * @param resourcePath name of resources to read
51 protected abstract void requireScript(String resourcePath);
53 /** Allows subclasses to redefine what field a function representing a
54 * class gets assigned. By default it returns the suggested name followed
55 * by <code>" = "</code>;
57 * @param className suggested name of the class
59 protected String assignClass(String className) {
60 return className + " = ";
64 * Converts a given class file to a JavaScript version.
66 * @param classFile input stream with code of the .class file
67 * @return the initialization code for this class, if any. Otherwise <code>null</code>
69 * @throws IOException if something goes wrong during read or write or translating
72 public String compile(InputStream classFile) throws IOException {
73 this.jc = new ClassData(classFile);
74 byte[] arrData = jc.findAnnotationData(true);
75 String[] arr = findAnnotation(arrData, jc,
76 "org.apidesign.bck2brwsr.core.ExtraJavaScript",
77 "resource", "processByteCode"
80 requireScript(arr[0]);
81 if ("0".equals(arr[1])) {
85 StringArray toInitilize = new StringArray();
86 final String className = className(jc);
87 out.append("\n\n").append(assignClass(className));
88 out.append("function CLS() {");
89 out.append("\n if (!CLS.prototype.$instOf_").append(className).append(") {");
90 for (FieldData v : jc.getFields()) {
92 out.append("\n CLS.").append(v.getName()).append(initField(v));
95 // ClassName sc = jc.getSuperClass();
96 String sc = jc.getSuperClassName(); // with _
98 out.append("\n var p = CLS.prototype = ").
99 append(sc.replace('/', '_')).append("(true);");
101 out.append("\n var p = CLS.prototype;");
103 for (MethodData m : jc.getMethods()) {
105 generateStaticMethod("\n p.", m, toInitilize);
107 generateInstanceMethod("\n p.", m);
110 out.append("\n p.$instOf_").append(className).append(" = true;");
111 for (String superInterface : jc.getSuperInterfaces()) {
112 out.append("\n p.$instOf_").append(superInterface.replace('/', '_')).append(" = true;");
114 out.append("\n if (arguments.length === 0) {");
115 out.append("\n return new CLS();");
118 out.append("\n if (arguments.length === 0) {");
119 for (FieldData v : jc.getFields()) {
121 out.append("\n this.fld_").
122 append(v.getName()).append(initField(v));
125 out.append("\n return this;");
127 out.append("\n return new CLS;");
129 StringBuilder sb = new StringBuilder();
130 for (String init : toInitilize.toArray()) {
131 sb.append("\n").append(init).append("();");
133 return sb.toString();
135 private void generateStaticMethod(String prefix, MethodData m, StringArray toInitilize) throws IOException {
136 if (javaScriptBody(prefix, m, true)) {
139 StringBuilder argsCnt = new StringBuilder();
140 final String mn = findMethodName(m, argsCnt);
141 out.append(prefix).append(mn).append(" = function");
142 if (mn.equals("classV")) {
143 toInitilize.add(className(jc) + "(true)." + mn);
147 for (int index = 0, i = 0; i < argsCnt.length(); i++) {
149 out.append("arg").append(String.valueOf(index));
151 final String desc = null;// XXX findDescriptor(args.get(i).getDescriptor());
152 if (argsCnt.charAt(i) == '1') {
158 out.append(") {").append("\n");
159 final byte[] code = m.getCode();
161 int len = m.getMaxLocals();
162 for (int index = argsCnt.length(), i = argsCnt.length(); i < len; i++) {
164 out.append("arg").append(String.valueOf(i)).append(";\n");
166 out.append(" var s = new Array();\n");
169 out.append(" /* no code found for ").append(m.getInternalSig()).append(" */\n");
174 private void generateInstanceMethod(String prefix, MethodData m) throws IOException {
175 if (javaScriptBody(prefix, m, false)) {
178 StringBuilder argsCnt = new StringBuilder();
179 final String mn = findMethodName(m, argsCnt);
180 out.append(prefix).append(mn).append(" = function");
183 for (int index = 1, i = 0; i < argsCnt.length(); i++) {
185 out.append("arg").append(String.valueOf(index));
186 if (argsCnt.charAt(i) == '1') {
192 out.append(") {").append("\n");
193 final byte[] code = m.getCode();
195 int len = m.getMaxLocals();
196 for (int index = argsCnt.length(), i = argsCnt.length(); i < len; i++) {
198 out.append("arg").append(String.valueOf(i + 1)).append(";\n");
200 out.append(";\n var s = new Array();\n");
203 out.append(" /* no code found for ").append(m.getInternalSig()).append(" */\n");
208 private void produceCode(byte[] byteCodes) throws IOException {
209 out.append("\n var gt = 0;\n for(;;) switch(gt) {\n");
210 for (int i = 0; i < byteCodes.length; i++) {
212 out.append(" case " + i).append(": ");
213 final int c = readByte(byteCodes, i);
220 out.append("s.push(arg0);");
227 out.append("s.push(arg1);");
234 out.append("s.push(arg2);");
241 out.append("s.push(arg3);");
248 final int indx = readByte(byteCodes, ++i);
249 out.append("s.push(arg").append(indx + ");");
257 final int indx = readByte(byteCodes, ++i);
258 out.append("arg" + indx).append(" = s.pop();");
266 out.append("arg0 = s.pop();");
273 out.append("arg1 = s.pop();");
280 out.append("arg2 = s.pop();");
287 out.append("arg3 = s.pop();");
293 out.append("s.push(s.pop() + s.pop());");
299 out.append("{ var tmp = s.pop(); s.push(s.pop() - tmp); }");
305 out.append("s.push(s.pop() * s.pop());");
309 out.append("{ var tmp = s.pop(); s.push(Math.floor(s.pop() / tmp)); }");
313 out.append("{ var tmp = s.pop(); s.push(s.pop() / tmp); }");
319 out.append("{ var d = s.pop(); s.push(s.pop() % d); }");
323 out.append("s.push(s.pop() & s.pop());");
327 out.append("s.push(s.pop() | s.pop());");
331 out.append("s.push(s.pop() ^ s.pop());");
337 out.append("s.push(- s.pop());");
341 out.append("{ var v = s.pop(); s.push(s.pop() << v); }");
345 out.append("{ var v = s.pop(); s.push(s.pop() >> v); }");
349 out.append("{ var v = s.pop(); s.push(s.pop() >>> v); }");
352 final int varIndx = readByte(byteCodes, ++i);
353 final int incrBy = byteCodes[++i];
355 out.append("arg" + varIndx).append("++;");
357 out.append("arg" + varIndx).append(" += " + incrBy).append(";");
362 out.append("return;");
369 out.append("return s.pop();");
380 out.append("/* number conversion */");
386 out.append("s.push(Math.floor(s.pop()));");
391 out.append("/* number conversion */");
393 case opc_aconst_null:
394 out.append("s.push(null);");
397 out.append("s.push(-1);");
403 out.append("s.push(0);");
409 out.append("s.push(1);");
413 out.append("s.push(2);");
416 out.append("s.push(3);");
419 out.append("s.push(4);");
422 out.append("s.push(5);");
425 int indx = readByte(byteCodes, ++i);
426 String v = encodeConstant(indx);
427 out.append("s.push(").append(v).append(");");
432 int indx = readIntArg(byteCodes, i);
434 String v = encodeConstant(indx);
435 out.append("s.push(").append(v).append(");");
443 out.append("{ var delta = s.pop() - s.pop(); s.push(delta < 0 ?-1 : (delta == 0 ? 0 : 1)); }");
447 i = generateIf(byteCodes, i, "===");
450 i = generateIf(byteCodes, i, "!=");
452 case opc_if_icmpeq: {
453 i = generateIf(byteCodes, i, "==");
457 int indx = i + readIntArg(byteCodes, i);
458 out.append("if (s.pop() == 0) { gt = " + indx);
459 out.append("; continue; }");
464 int indx = i + readIntArg(byteCodes, i);
465 out.append("if (s.pop() != 0) { gt = " + indx);
466 out.append("; continue; }");
471 int indx = i + readIntArg(byteCodes, i);
472 out.append("if (s.pop() < 0) { gt = " + indx);
473 out.append("; continue; }");
478 int indx = i + readIntArg(byteCodes, i);
479 out.append("if (s.pop() <= 0) { gt = " + indx);
480 out.append("; continue; }");
485 int indx = i + readIntArg(byteCodes, i);
486 out.append("if (s.pop() > 0) { gt = " + indx);
487 out.append("; continue; }");
492 int indx = i + readIntArg(byteCodes, i);
493 out.append("if (s.pop() >= 0) { gt = " + indx);
494 out.append("; continue; }");
498 case opc_ifnonnull: {
499 int indx = i + readIntArg(byteCodes, i);
500 out.append("if (s.pop() !== null) { gt = " + indx);
501 out.append("; continue; }");
506 int indx = i + readIntArg(byteCodes, i);
507 out.append("if (s.pop() === null) { gt = " + indx);
508 out.append("; continue; }");
513 i = generateIf(byteCodes, i, "!=");
516 i = generateIf(byteCodes, i, ">");
519 i = generateIf(byteCodes, i, ">=");
522 i = generateIf(byteCodes, i, "<");
525 i = generateIf(byteCodes, i, "<=");
528 int indx = i + readIntArg(byteCodes, i);
529 out.append("gt = " + indx).append("; continue;");
533 case opc_lookupswitch: {
534 int table = i / 4 * 4 + 4;
535 int dflt = i + readInt4(byteCodes, table);
537 int n = readInt4(byteCodes, table);
539 out.append("switch (s.pop()) {\n");
541 int cnstnt = readInt4(byteCodes, table);
543 int offset = i + readInt4(byteCodes, table);
545 out.append(" case " + cnstnt).append(": gt = " + offset).append("; continue;\n");
547 out.append(" default: gt = " + dflt).append("; continue;\n}");
551 case opc_tableswitch: {
552 int table = i / 4 * 4 + 4;
553 int dflt = i + readInt4(byteCodes, table);
555 int low = readInt4(byteCodes, table);
557 int high = readInt4(byteCodes, table);
559 out.append("switch (s.pop()) {\n");
560 while (low <= high) {
561 int offset = i + readInt4(byteCodes, table);
563 out.append(" case " + low).append(": gt = " + offset).append("; continue;\n");
566 out.append(" default: gt = " + dflt).append("; continue;\n}");
570 case opc_invokeinterface: {
571 i = invokeVirtualMethod(byteCodes, i) + 2;
574 case opc_invokevirtual:
575 i = invokeVirtualMethod(byteCodes, i);
577 case opc_invokespecial:
578 i = invokeStaticMethod(byteCodes, i, false);
580 case opc_invokestatic:
581 i = invokeStaticMethod(byteCodes, i, true);
584 int indx = readIntArg(byteCodes, i);
585 String ci = jc.getClassName(indx);
586 out.append("s.push(");
587 out.append("new ").append(ci.replace('/','_'));
594 int type = byteCodes[i++];
595 out.append("s.push(new Array(s.pop()).fillNulls());");
598 case opc_anewarray: {
599 i += 2; // skip type of array
600 out.append("s.push(new Array(s.pop()).fillNulls());");
603 case opc_multianewarray: {
605 int dim = readByte(byteCodes, ++i);
606 out.append("{ var a0 = new Array(s.pop()).fillNulls();");
607 for (int d = 1; d < dim; d++) {
608 out.append("\n var l" + d).append(" = s.pop();");
609 out.append("\n for (var i" + d).append (" = 0; i" + d).
610 append(" < a" + (d - 1)).
611 append(".length; i" + d).append("++) {");
612 out.append("\n var a" + d).
613 append (" = new Array(l" + d).append(").fillNulls();");
614 out.append("\n a" + (d - 1)).append("[i" + d).append("] = a" + d).
617 for (int d = 1; d < dim; d++) {
620 out.append("\ns.push(a0); }");
623 case opc_arraylength:
624 out.append("s.push(s.pop().length);");
634 out.append("{ var value = s.pop(); var indx = s.pop(); s.pop()[indx] = value; }");
645 out.append("{ var indx = s.pop(); s.push(s.pop()[indx]); }");
649 out.append("s.pop();");
651 out.append("s.pop();");
654 out.append("s.push(s[s.length - 1]);");
657 out.append("{ var v1 = s.pop(); var v2 = s.pop(); s.push(v1); s.push(v2); s.push(v1); }");
660 out.append("{ var v1 = s.pop(); var v2 = s.pop(); var v3 = s.pop(); s.push(v1); s.push(v3); s.push(v2); s.push(v1); }");
663 out.append("s.push(" + byteCodes[++i] + ");");
666 out.append("s.push(" + readIntArg(byteCodes, i) + ");");
670 int indx = readIntArg(byteCodes, i);
671 String[] fi = jc.getFieldInfoName(indx);
672 out.append("s.push(s.pop().fld_").
673 append(fi[1]).append(");");
677 case opc_getstatic: {
678 int indx = readIntArg(byteCodes, i);
679 String[] fi = jc.getFieldInfoName(indx);
680 out.append("s.push(").append(fi[0].replace('/', '_'));
681 out.append('.').append(fi[1]).append(");");
686 case opc_putstatic: {
687 int indx = readIntArg(byteCodes, i);
688 String[] fi = jc.getFieldInfoName(indx);
689 out.append(fi[0].replace('/', '_'));
690 out.append('.').append(fi[1]).append(" = s.pop();");
696 int indx = readIntArg(byteCodes, i);
697 String[] fi = jc.getFieldInfoName(indx);
698 out.append("{ var v = s.pop(); s.pop().fld_")
699 .append(fi[1]).append(" = v; }");
703 case opc_checkcast: {
704 int indx = readIntArg(byteCodes, i);
705 final String type = jc.getClassName(indx);
706 if (!type.startsWith("[")) {
707 // no way to check arrays right now
708 out.append("if(s[s.length - 1].$instOf_")
709 .append(type.replace('/', '_'))
710 .append(" != 1) throw {};"); // XXX proper exception
715 case opc_instanceof: {
716 int indx = readIntArg(byteCodes, i);
717 final String type = jc.getClassName(indx);
718 out.append("s.push(s.pop().$instOf_")
719 .append(type.replace('/', '_'))
720 .append(" ? 1 : 0);");
725 out.append("{ var t = s.pop(); s = new Array(1); s[0] = t; throw t; }");
729 out.append("throw 'unknown bytecode " + c + "';");
734 for (int j = prev; j <= i; j++) {
736 final int cc = readByte(byteCodes, j);
737 out.append(Integer.toString(cc));
744 private int generateIf(byte[] byteCodes, int i, final String test) throws IOException {
745 int indx = i + readIntArg(byteCodes, i);
746 out.append("if (s.pop() ").append(test).append(" s.pop()) { gt = " + indx);
747 out.append("; continue; }");
751 private int readIntArg(byte[] byteCodes, int offsetInstruction) {
752 final int indxHi = byteCodes[offsetInstruction + 1] << 8;
753 final int indxLo = byteCodes[offsetInstruction + 2];
754 return (indxHi & 0xffffff00) | (indxLo & 0xff);
756 private int readInt4(byte[] byteCodes, int offsetInstruction) {
757 final int d = byteCodes[offsetInstruction + 0] << 24;
758 final int c = byteCodes[offsetInstruction + 1] << 16;
759 final int b = byteCodes[offsetInstruction + 2] << 8;
760 final int a = byteCodes[offsetInstruction + 3];
761 return (d & 0xff000000) | (c & 0xff0000) | (b & 0xff00) | (a & 0xff);
763 private int readByte(byte[] byteCodes, int offsetInstruction) {
764 return (byteCodes[offsetInstruction] + 256) % 256;
767 private static void countArgs(String descriptor, boolean[] hasReturnType, StringBuilder sig, StringBuilder cnt) {
769 Boolean count = null;
770 boolean array = false;
771 int firstPos = sig.length();
772 while (i < descriptor.length()) {
773 char ch = descriptor.charAt(i++);
797 if (ch == 'J' || ch == 'D') {
803 hasReturnType[0] = true;
804 sig.insert(firstPos, ch);
806 sig.insert(firstPos, 'A');
813 hasReturnType[0] = false;
814 sig.insert(firstPos, 'V');
817 int next = descriptor.indexOf(';', i);
823 sig.append(descriptor.substring(i, next).replace('/', '_'));
826 sig.insert(firstPos, descriptor.substring(i, next).replace('/', '_'));
827 sig.insert(firstPos, ch);
829 sig.insert(firstPos, 'A');
831 hasReturnType[0] = true;
839 break; // invalid character
844 private String findMethodName(MethodData m, StringBuilder cnt) {
845 StringBuilder name = new StringBuilder();
846 if ("<init>".equals(m.getName())) { // NOI18N
847 name.append("cons"); // NOI18N
848 } else if ("<clinit>".equals(m.getName())) { // NOI18N
849 name.append("class"); // NOI18N
851 name.append(m.getName());
854 boolean hasReturn[] = { false };
855 countArgs(findDescriptor(m.getInternalSig()), hasReturn, name, cnt);
856 return name.toString();
859 private String findMethodName(String[] mi, StringBuilder cnt, boolean[] hasReturn) {
860 StringBuilder name = new StringBuilder();
861 String descr = mi[2];//mi.getDescriptor();
863 if ("<init>".equals(nm)) { // NOI18N
864 name.append("cons"); // NOI18N
868 countArgs(findDescriptor(descr), hasReturn, name, cnt);
869 return name.toString();
872 private int invokeStaticMethod(byte[] byteCodes, int i, boolean isStatic)
874 int methodIndex = readIntArg(byteCodes, i);
875 String[] mi = jc.getFieldInfoName(methodIndex);
876 boolean[] hasReturn = { false };
877 StringBuilder cnt = new StringBuilder();
878 String mn = findMethodName(mi, cnt, hasReturn);
880 for (int j = cnt.length() - 1; j >= 0; j--) {
881 out.append("var v" + j).append(" = s.pop(); ");
885 out.append("s.push(");
887 final String in = mi[0];
888 out.append(in.replace('/', '_'));
889 out.append("(true).");
894 out.append("s.pop()");
897 for (int j = 0; j < cnt.length(); j++) {
911 private int invokeVirtualMethod(byte[] byteCodes, int i)
913 int methodIndex = readIntArg(byteCodes, i);
914 String[] mi = jc.getFieldInfoName(methodIndex);
915 boolean[] hasReturn = { false };
916 StringBuilder cnt = new StringBuilder();
917 String mn = findMethodName(mi, cnt, hasReturn);
919 for (int j = cnt.length() - 1; j >= 0; j--) {
920 out.append("var v" + j).append(" = s.pop(); ");
922 out.append("var self = s.pop(); ");
924 out.append("s.push(");
930 for (int j = 0; j < cnt.length(); j++) {
943 private void addReference(String cn) throws IOException {
944 if (requireReference(cn)) {
945 out.append(" /* needs ").append(cn).append(" */");
949 private void outType(String d, StringBuilder out) {
951 while (d.charAt(0) == '[') {
955 if (d.charAt(0) == 'L') {
956 assert d.charAt(d.length() - 1) == ';';
957 out.append(d.replace('/', '_').substring(0, d.length() - 1));
963 private String encodeConstant(int entryIndex) {
964 String s = jc.stringValue(entryIndex, true);
968 private String findDescriptor(String d) {
969 return d.replace('[', 'A');
972 private boolean javaScriptBody(String prefix, MethodData m, boolean isStatic) throws IOException {
973 byte[] arr = m.findAnnotationData(true);
977 final String jvmType = "Lorg/apidesign/bck2brwsr/core/JavaScriptBody;";
978 class P extends AnnotationParser {
980 String[] args = new String[30];
984 protected void visitAttr(String type, String attr, String value) {
985 if (type.equals(jvmType)) {
986 if ("body".equals(attr)) {
988 } else if ("args".equals(attr)) {
991 throw new IllegalArgumentException(attr);
998 if (p.body == null) {
1001 StringBuilder cnt = new StringBuilder();
1002 out.append(prefix).append(findMethodName(m, cnt));
1003 out.append(" = function(");
1007 out.append(p.args[0]);
1014 for (int i = 0; i < cnt.length(); i++) {
1016 out.append(p.args[index]);
1020 out.append(") {").append("\n");
1022 out.append("\n}\n");
1025 private static String className(ClassData jc) {
1026 //return jc.getName().getInternalName().replace('/', '_');
1027 return jc.getClassName().replace('/', '_');
1030 private static String[] findAnnotation(
1031 byte[] arr, ClassData cd, final String className,
1032 final String... attrNames
1033 ) throws IOException {
1037 final String[] values = new String[attrNames.length];
1038 final boolean[] found = { false };
1039 final String jvmType = "L" + className.replace('.', '/') + ";";
1040 AnnotationParser ap = new AnnotationParser() {
1042 protected void visitAttr(String type, String attr, String value) {
1043 if (type.equals(jvmType)) {
1045 for (int i = 0; i < attrNames.length; i++) {
1046 if (attrNames[i].equals(attr)) {
1055 return found[0] ? values : null;
1058 private CharSequence initField(FieldData v) {
1059 final String is = v.getInternalSig();
1060 if (is.length() == 1) {
1061 switch (is.charAt(0)) {
1067 case 'I': return " = 0;";
1069 case 'D': return " = 0.0;";
1071 throw new IllegalStateException(is);