Merge with default to get correct behavior of the contructor property of prototype
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.constructor = CLS;");
111 out.append("\n p.$instOf_").append(className).append(" = true;");
112 for (String superInterface : jc.getSuperInterfaces()) {
113 out.append("\n p.$instOf_").append(superInterface.replace('/', '_')).append(" = true;");
115 out.append("\n CLS.$class = java_lang_Class(true);");
116 out.append("\n CLS.$class.jvmName = '").append(jc.getClassName()).append("';");
118 out.append("\n if (arguments.length === 0) {");
119 out.append("\n if (!(this instanceof CLS)) {");
120 out.append("\n return new CLS();");
122 for (FieldData v : jc.getFields()) {
124 out.append("\n this.fld_").
125 append(v.getName()).append(initField(v));
128 out.append("\n return this;");
130 out.append("\n return arguments[0] ? new CLS() : CLS.prototype;");
132 StringBuilder sb = new StringBuilder();
133 for (String init : toInitilize.toArray()) {
134 sb.append("\n").append(init).append("();");
136 return sb.toString();
138 private void generateStaticMethod(String prefix, MethodData m, StringArray toInitilize) throws IOException {
139 if (javaScriptBody(prefix, m, true)) {
142 StringBuilder argsCnt = new StringBuilder();
143 final String mn = findMethodName(m, argsCnt);
144 out.append(prefix).append(mn).append(" = function");
145 if (mn.equals("classV")) {
146 toInitilize.add(className(jc) + "(false)." + mn);
150 for (int index = 0, i = 0; i < argsCnt.length(); i++) {
152 out.append("arg").append(String.valueOf(index));
154 final String desc = null;// XXX findDescriptor(args.get(i).getDescriptor());
155 if (argsCnt.charAt(i) == '1') {
161 out.append(") {").append("\n");
162 final byte[] code = m.getCode();
164 int len = m.getMaxLocals();
165 for (int index = argsCnt.length(), i = argsCnt.length(); i < len; i++) {
167 out.append("arg").append(String.valueOf(i)).append(";\n");
169 out.append(" var s = new Array();\n");
172 out.append(" /* no code found for ").append(m.getInternalSig()).append(" */\n");
177 private void generateInstanceMethod(String prefix, MethodData m) throws IOException {
178 if (javaScriptBody(prefix, m, false)) {
181 StringBuilder argsCnt = new StringBuilder();
182 final String mn = findMethodName(m, argsCnt);
183 out.append(prefix).append(mn).append(" = function");
186 for (int index = 1, i = 0; i < argsCnt.length(); i++) {
188 out.append("arg").append(String.valueOf(index));
189 if (argsCnt.charAt(i) == '1') {
195 out.append(") {").append("\n");
196 final byte[] code = m.getCode();
198 int len = m.getMaxLocals();
199 for (int index = argsCnt.length(), i = argsCnt.length(); i < len; i++) {
201 out.append("arg").append(String.valueOf(i + 1)).append(";\n");
203 out.append(";\n var s = new Array();\n");
206 out.append(" /* no code found for ").append(m.getInternalSig()).append(" */\n");
211 private void produceCode(byte[] byteCodes) throws IOException {
212 out.append("\n var gt = 0;\n for(;;) switch(gt) {\n");
213 for (int i = 0; i < byteCodes.length; i++) {
215 out.append(" case " + i).append(": ");
216 final int c = readByte(byteCodes, i);
223 out.append("s.push(arg0);");
230 out.append("s.push(arg1);");
237 out.append("s.push(arg2);");
244 out.append("s.push(arg3);");
251 final int indx = readByte(byteCodes, ++i);
252 out.append("s.push(arg").append(indx + ");");
260 final int indx = readByte(byteCodes, ++i);
261 out.append("arg" + indx).append(" = s.pop();");
269 out.append("arg0 = s.pop();");
276 out.append("arg1 = s.pop();");
283 out.append("arg2 = s.pop();");
290 out.append("arg3 = s.pop();");
296 out.append("s.push(s.pop() + s.pop());");
302 out.append("{ var tmp = s.pop(); s.push(s.pop() - tmp); }");
308 out.append("s.push(s.pop() * s.pop());");
312 out.append("{ var tmp = s.pop(); s.push(Math.floor(s.pop() / tmp)); }");
316 out.append("{ var tmp = s.pop(); s.push(s.pop() / tmp); }");
322 out.append("{ var d = s.pop(); s.push(s.pop() % d); }");
326 out.append("s.push(s.pop() & s.pop());");
330 out.append("s.push(s.pop() | s.pop());");
334 out.append("s.push(s.pop() ^ s.pop());");
340 out.append("s.push(- s.pop());");
344 out.append("{ var v = s.pop(); s.push(s.pop() << v); }");
348 out.append("{ var v = s.pop(); s.push(s.pop() >> v); }");
352 out.append("{ var v = s.pop(); s.push(s.pop() >>> v); }");
355 final int varIndx = readByte(byteCodes, ++i);
356 final int incrBy = byteCodes[++i];
358 out.append("arg" + varIndx).append("++;");
360 out.append("arg" + varIndx).append(" += " + incrBy).append(";");
365 out.append("return;");
372 out.append("return s.pop();");
383 out.append("/* number conversion */");
389 out.append("s.push(Math.floor(s.pop()));");
394 out.append("/* number conversion */");
396 case opc_aconst_null:
397 out.append("s.push(null);");
400 out.append("s.push(-1);");
406 out.append("s.push(0);");
412 out.append("s.push(1);");
416 out.append("s.push(2);");
419 out.append("s.push(3);");
422 out.append("s.push(4);");
425 out.append("s.push(5);");
428 int indx = readByte(byteCodes, ++i);
429 String v = encodeConstant(indx);
430 out.append("s.push(").append(v).append(");");
435 int indx = readIntArg(byteCodes, i);
437 String v = encodeConstant(indx);
438 out.append("s.push(").append(v).append(");");
446 out.append("{ var delta = s.pop() - s.pop(); s.push(delta < 0 ?-1 : (delta == 0 ? 0 : 1)); }");
450 i = generateIf(byteCodes, i, "===");
453 i = generateIf(byteCodes, i, "!=");
455 case opc_if_icmpeq: {
456 i = generateIf(byteCodes, i, "==");
460 int indx = i + readIntArg(byteCodes, i);
461 out.append("if (s.pop() == 0) { gt = " + indx);
462 out.append("; continue; }");
467 int indx = i + readIntArg(byteCodes, i);
468 out.append("if (s.pop() != 0) { gt = " + indx);
469 out.append("; continue; }");
474 int indx = i + readIntArg(byteCodes, i);
475 out.append("if (s.pop() < 0) { gt = " + indx);
476 out.append("; continue; }");
481 int indx = i + readIntArg(byteCodes, i);
482 out.append("if (s.pop() <= 0) { gt = " + indx);
483 out.append("; continue; }");
488 int indx = i + readIntArg(byteCodes, i);
489 out.append("if (s.pop() > 0) { gt = " + indx);
490 out.append("; continue; }");
495 int indx = i + readIntArg(byteCodes, i);
496 out.append("if (s.pop() >= 0) { gt = " + indx);
497 out.append("; continue; }");
501 case opc_ifnonnull: {
502 int indx = i + readIntArg(byteCodes, i);
503 out.append("if (s.pop() !== null) { gt = " + indx);
504 out.append("; continue; }");
509 int indx = i + readIntArg(byteCodes, i);
510 out.append("if (s.pop() === null) { gt = " + indx);
511 out.append("; continue; }");
516 i = generateIf(byteCodes, i, "!=");
519 i = generateIf(byteCodes, i, ">");
522 i = generateIf(byteCodes, i, ">=");
525 i = generateIf(byteCodes, i, "<");
528 i = generateIf(byteCodes, i, "<=");
531 int indx = i + readIntArg(byteCodes, i);
532 out.append("gt = " + indx).append("; continue;");
536 case opc_lookupswitch: {
537 int table = i / 4 * 4 + 4;
538 int dflt = i + readInt4(byteCodes, table);
540 int n = readInt4(byteCodes, table);
542 out.append("switch (s.pop()) {\n");
544 int cnstnt = readInt4(byteCodes, table);
546 int offset = i + readInt4(byteCodes, table);
548 out.append(" case " + cnstnt).append(": gt = " + offset).append("; continue;\n");
550 out.append(" default: gt = " + dflt).append("; continue;\n}");
554 case opc_tableswitch: {
555 int table = i / 4 * 4 + 4;
556 int dflt = i + readInt4(byteCodes, table);
558 int low = readInt4(byteCodes, table);
560 int high = readInt4(byteCodes, table);
562 out.append("switch (s.pop()) {\n");
563 while (low <= high) {
564 int offset = i + readInt4(byteCodes, table);
566 out.append(" case " + low).append(": gt = " + offset).append("; continue;\n");
569 out.append(" default: gt = " + dflt).append("; continue;\n}");
573 case opc_invokeinterface: {
574 i = invokeVirtualMethod(byteCodes, i) + 2;
577 case opc_invokevirtual:
578 i = invokeVirtualMethod(byteCodes, i);
580 case opc_invokespecial:
581 i = invokeStaticMethod(byteCodes, i, false);
583 case opc_invokestatic:
584 i = invokeStaticMethod(byteCodes, i, true);
587 int indx = readIntArg(byteCodes, i);
588 String ci = jc.getClassName(indx);
589 out.append("s.push(new ");
590 out.append(ci.replace('/','_'));
597 int type = byteCodes[i++];
598 out.append("s.push(new Array(s.pop()).fillNulls());");
601 case opc_anewarray: {
602 i += 2; // skip type of array
603 out.append("s.push(new Array(s.pop()).fillNulls());");
606 case opc_multianewarray: {
608 int dim = readByte(byteCodes, ++i);
609 out.append("{ var a0 = new Array(s.pop()).fillNulls();");
610 for (int d = 1; d < dim; d++) {
611 out.append("\n var l" + d).append(" = s.pop();");
612 out.append("\n for (var i" + d).append (" = 0; i" + d).
613 append(" < a" + (d - 1)).
614 append(".length; i" + d).append("++) {");
615 out.append("\n var a" + d).
616 append (" = new Array(l" + d).append(").fillNulls();");
617 out.append("\n a" + (d - 1)).append("[i" + d).append("] = a" + d).
620 for (int d = 1; d < dim; d++) {
623 out.append("\ns.push(a0); }");
626 case opc_arraylength:
627 out.append("s.push(s.pop().length);");
637 out.append("{ var value = s.pop(); var indx = s.pop(); s.pop()[indx] = value; }");
648 out.append("{ var indx = s.pop(); s.push(s.pop()[indx]); }");
652 out.append("s.pop();");
654 out.append("s.pop();");
657 out.append("s.push(s[s.length - 1]);");
660 out.append("{ var v1 = s.pop(); var v2 = s.pop(); s.push(v1); s.push(v2); s.push(v1); }");
663 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); }");
666 out.append("s.push(" + byteCodes[++i] + ");");
669 out.append("s.push(" + readIntArg(byteCodes, i) + ");");
673 int indx = readIntArg(byteCodes, i);
674 String[] fi = jc.getFieldInfoName(indx);
675 out.append("s.push(s.pop().fld_").
676 append(fi[1]).append(");");
680 case opc_getstatic: {
681 int indx = readIntArg(byteCodes, i);
682 String[] fi = jc.getFieldInfoName(indx);
683 out.append("s.push(").append(fi[0].replace('/', '_'));
684 out.append('.').append(fi[1]).append(");");
689 case opc_putstatic: {
690 int indx = readIntArg(byteCodes, i);
691 String[] fi = jc.getFieldInfoName(indx);
692 out.append(fi[0].replace('/', '_'));
693 out.append('.').append(fi[1]).append(" = s.pop();");
699 int indx = readIntArg(byteCodes, i);
700 String[] fi = jc.getFieldInfoName(indx);
701 out.append("{ var v = s.pop(); s.pop().fld_")
702 .append(fi[1]).append(" = v; }");
706 case opc_checkcast: {
707 int indx = readIntArg(byteCodes, i);
708 final String type = jc.getClassName(indx);
709 if (!type.startsWith("[")) {
710 // no way to check arrays right now
711 out.append("if(s[s.length - 1].$instOf_")
712 .append(type.replace('/', '_'))
713 .append(" != 1) throw {};"); // XXX proper exception
718 case opc_instanceof: {
719 int indx = readIntArg(byteCodes, i);
720 final String type = jc.getClassName(indx);
721 out.append("s.push(s.pop().$instOf_")
722 .append(type.replace('/', '_'))
723 .append(" ? 1 : 0);");
728 out.append("{ var t = s.pop(); s = new Array(1); s[0] = t; throw t; }");
732 out.append("throw 'unknown bytecode " + c + "';");
737 for (int j = prev; j <= i; j++) {
739 final int cc = readByte(byteCodes, j);
740 out.append(Integer.toString(cc));
747 private int generateIf(byte[] byteCodes, int i, final String test) throws IOException {
748 int indx = i + readIntArg(byteCodes, i);
749 out.append("if (s.pop() ").append(test).append(" s.pop()) { gt = " + indx);
750 out.append("; continue; }");
754 private int readIntArg(byte[] byteCodes, int offsetInstruction) {
755 final int indxHi = byteCodes[offsetInstruction + 1] << 8;
756 final int indxLo = byteCodes[offsetInstruction + 2];
757 return (indxHi & 0xffffff00) | (indxLo & 0xff);
759 private int readInt4(byte[] byteCodes, int offsetInstruction) {
760 final int d = byteCodes[offsetInstruction + 0] << 24;
761 final int c = byteCodes[offsetInstruction + 1] << 16;
762 final int b = byteCodes[offsetInstruction + 2] << 8;
763 final int a = byteCodes[offsetInstruction + 3];
764 return (d & 0xff000000) | (c & 0xff0000) | (b & 0xff00) | (a & 0xff);
766 private int readByte(byte[] byteCodes, int offsetInstruction) {
767 return (byteCodes[offsetInstruction] + 256) % 256;
770 private static void countArgs(String descriptor, boolean[] hasReturnType, StringBuilder sig, StringBuilder cnt) {
772 Boolean count = null;
773 boolean array = false;
774 int firstPos = sig.length();
775 while (i < descriptor.length()) {
776 char ch = descriptor.charAt(i++);
800 if (ch == 'J' || ch == 'D') {
806 hasReturnType[0] = true;
807 sig.insert(firstPos, ch);
809 sig.insert(firstPos, 'A');
816 hasReturnType[0] = false;
817 sig.insert(firstPos, 'V');
820 int next = descriptor.indexOf(';', i);
826 sig.append(descriptor.substring(i, next).replace('/', '_'));
829 sig.insert(firstPos, descriptor.substring(i, next).replace('/', '_'));
830 sig.insert(firstPos, ch);
832 sig.insert(firstPos, 'A');
834 hasReturnType[0] = true;
842 break; // invalid character
847 private String findMethodName(MethodData m, StringBuilder cnt) {
848 StringBuilder name = new StringBuilder();
849 if ("<init>".equals(m.getName())) { // NOI18N
850 name.append("cons"); // NOI18N
851 } else if ("<clinit>".equals(m.getName())) { // NOI18N
852 name.append("class"); // NOI18N
854 name.append(m.getName());
857 boolean hasReturn[] = { false };
858 countArgs(findDescriptor(m.getInternalSig()), hasReturn, name, cnt);
859 return name.toString();
862 private String findMethodName(String[] mi, StringBuilder cnt, boolean[] hasReturn) {
863 StringBuilder name = new StringBuilder();
864 String descr = mi[2];//mi.getDescriptor();
866 if ("<init>".equals(nm)) { // NOI18N
867 name.append("cons"); // NOI18N
871 countArgs(findDescriptor(descr), hasReturn, name, cnt);
872 return name.toString();
875 private int invokeStaticMethod(byte[] byteCodes, int i, boolean isStatic)
877 int methodIndex = readIntArg(byteCodes, i);
878 String[] mi = jc.getFieldInfoName(methodIndex);
879 boolean[] hasReturn = { false };
880 StringBuilder cnt = new StringBuilder();
881 String mn = findMethodName(mi, cnt, hasReturn);
883 for (int j = cnt.length() - 1; j >= 0; j--) {
884 out.append("var v" + j).append(" = s.pop(); ");
888 out.append("s.push(");
890 final String in = mi[0];
891 out.append(in.replace('/', '_'));
892 out.append("(false).");
897 out.append("s.pop()");
900 for (int j = 0; j < cnt.length(); j++) {
914 private int invokeVirtualMethod(byte[] byteCodes, int i)
916 int methodIndex = readIntArg(byteCodes, i);
917 String[] mi = jc.getFieldInfoName(methodIndex);
918 boolean[] hasReturn = { false };
919 StringBuilder cnt = new StringBuilder();
920 String mn = findMethodName(mi, cnt, hasReturn);
922 for (int j = cnt.length() - 1; j >= 0; j--) {
923 out.append("var v" + j).append(" = s.pop(); ");
925 out.append("var self = s.pop(); ");
927 out.append("s.push(");
933 for (int j = 0; j < cnt.length(); j++) {
946 private void addReference(String cn) throws IOException {
947 if (requireReference(cn)) {
948 out.append(" /* needs ").append(cn).append(" */");
952 private void outType(String d, StringBuilder out) {
954 while (d.charAt(0) == '[') {
958 if (d.charAt(0) == 'L') {
959 assert d.charAt(d.length() - 1) == ';';
960 out.append(d.replace('/', '_').substring(0, d.length() - 1));
966 private String encodeConstant(int entryIndex) {
967 String s = jc.stringValue(entryIndex, true);
971 private String findDescriptor(String d) {
972 return d.replace('[', 'A');
975 private boolean javaScriptBody(String prefix, MethodData m, boolean isStatic) throws IOException {
976 byte[] arr = m.findAnnotationData(true);
980 final String jvmType = "Lorg/apidesign/bck2brwsr/core/JavaScriptBody;";
981 class P extends AnnotationParser {
983 String[] args = new String[30];
987 protected void visitAttr(String type, String attr, String value) {
988 if (type.equals(jvmType)) {
989 if ("body".equals(attr)) {
991 } else if ("args".equals(attr)) {
994 throw new IllegalArgumentException(attr);
1001 if (p.body == null) {
1004 StringBuilder cnt = new StringBuilder();
1005 out.append(prefix).append(findMethodName(m, cnt));
1006 out.append(" = function(");
1010 out.append(p.args[0]);
1017 for (int i = 0; i < cnt.length(); i++) {
1019 out.append(p.args[index]);
1023 out.append(") {").append("\n");
1025 out.append("\n}\n");
1028 private static String className(ClassData jc) {
1029 //return jc.getName().getInternalName().replace('/', '_');
1030 return jc.getClassName().replace('/', '_');
1033 private static String[] findAnnotation(
1034 byte[] arr, ClassData cd, final String className,
1035 final String... attrNames
1036 ) throws IOException {
1040 final String[] values = new String[attrNames.length];
1041 final boolean[] found = { false };
1042 final String jvmType = "L" + className.replace('.', '/') + ";";
1043 AnnotationParser ap = new AnnotationParser() {
1045 protected void visitAttr(String type, String attr, String value) {
1046 if (type.equals(jvmType)) {
1048 for (int i = 0; i < attrNames.length; i++) {
1049 if (attrNames[i].equals(attr)) {
1058 return found[0] ? values : null;
1061 private CharSequence initField(FieldData v) {
1062 final String is = v.getInternalSig();
1063 if (is.length() == 1) {
1064 switch (is.charAt(0)) {
1070 case 'I': return " = 0;";
1072 case 'D': return " = 0.0;";
1074 throw new IllegalStateException(is);