gitweb on Svarog

projekti pod git sistemom za održavanje verzija -- projects under the git version control system
8ee7852c13a9ff67570e5db945b44caeca8fa0b9
[mjc2wsl.git] / src / mjc2wsl.java
1 /*
2 Copyright (C) 2014 Doni Pracner
4 This file is part of mjc2wsl.
6 mjc2wsl is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 mjc2wsl is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with mjc2wsl. If not, see <http://www.gnu.org/licenses/>.
18 */
19 import java.io.*;
20 import java.util.*;
22 /**
23 * This program converts file from compiled MicroJava bytecode to WSL language
24 * which is a part of the FermaT Transformation system. MicroJava is a subset
25 * used in Compiler Construction courses by Hanspeter Moessenboeck, not
26 * "Java ME".
27 *
28 * @author Doni Pracner, http://perun.dmi.rs/pracner http://quemaster.com
29 */
30 public class mjc2wsl{
31 public static String versionN = "0.1.5";
33 private TransMessages messages = new TransMessages();
35 private boolean genPauseAfterEachAddress=false,
36 genPrintForEachAddress = false,
37 genPrintEStackOnChange = false;
39 /** Constant used for marking a regular comment from the original file */
40 public static final char C_REG = ' ';
41 /**
42 * Constant used for marking when original code is inserted in the file,
43 * next to the translations
44 */
45 public static final char C_OC = '#';
46 /** Constant used for marking special messages from the translator */
47 public static final char C_SPEC = '&';
48 /** Constant used for marking error messages from the translator */
49 public static final char C_ERR = '!';
51 /** instruction code in MicroJava bytecode. */
52 public static final int
53 load = 1,
54 load_0 = 2,
55 load_1 = 3,
56 load_2 = 4,
57 load_3 = 5,
58 store = 6,
59 store_0 = 7,
60 store_1 = 8,
61 store_2 = 9,
62 store_3 = 10,
63 getstatic = 11,
64 putstatic = 12,
65 getfield = 13,
66 putfield = 14,
67 const_0 = 15,
68 const_1 = 16,
69 const_2 = 17,
70 const_3 = 18,
71 const_4 = 19,
72 const_5 = 20,
73 const_m1 = 21,
74 const_ = 22,
75 add = 23,
76 sub = 24,
77 mul = 25,
78 div = 26,
79 rem = 27,
80 neg = 28,
81 shl = 29,
82 shr = 30,
83 inc = 31,
84 new_ = 32,
85 newarray = 33,
86 aload = 34,
87 astore = 35,
88 baload = 36,
89 bastore = 37,
90 arraylength = 38,
91 pop = 39,
92 dup = 40,
93 dup2 = 41,
94 jmp = 42,
95 jeq = 43,
96 jne = 44,
97 jlt = 45,
98 jle = 46,
99 jgt = 47,
100 jge = 48,
101 call = 49,
102 return_ = 50,
103 enter = 51,
104 exit = 52,
105 read = 53,
106 print = 54,
107 bread = 55,
108 bprint = 56,
109 trap = 57;
111 private boolean originalInComments = false;
113 private HashMap<Integer,String> opMap = null;
115 private String opCodeFile = "mj-bytecodes.properties";
117 private HashMap<Integer, String> getOpMap() {
118 if (opMap == null) {
119 opMap = new HashMap<Integer, String>(60, 0.98f);
120 try {
121 BufferedReader in = new BufferedReader(new InputStreamReader(
122 getClass().getResourceAsStream(opCodeFile)));
123 String str = in.readLine();
124 while (str != null) {
125 String[] ss = str.split("=");
126 opMap.put(Integer.parseInt(ss[0]), ss[1]);
127 str = in.readLine();
129 in.close();
130 } catch (Exception ex) {
131 ex.printStackTrace();
134 return opMap;
137 public String getOpString(int op) {
138 return getOpMap().get(op);
141 public String describeOpCode(int op) {
142 return op + " (" + getOpString(op) + ")";
145 private InputStream mainIn;
146 private PrintWriter out = null;
147 private int counter = -1;
149 private void pr(int i){
150 out.print(i);
153 private void pr(char i){
154 out.print(i);
157 private void pr(String i){
158 out.print(i);
161 private void prl(String i){
162 out.println(i);
165 private int get() {
166 int res = -1;
167 try {
168 res = mainIn.read();
169 if (res >= 0)
170 res = res << 24 >>> 24;
171 } catch (IOException ex) {
172 ex.printStackTrace();
174 counter++;
175 return res;
178 private int get2() {
179 return (get() * 256 + get()) << 16 >> 16;
182 private int get4() {
183 return (get2() << 16) + (get2() << 16 >>> 16);
186 public String createStandardStart(){
187 return createStandardStart(10);
190 public String createStandardStart(int numWords){
191 StringBuilder ret = new StringBuilder(
192 "C:\" This file automatically converted from microjava bytecode\";\n"
193 +"C:\" with mjc2wsl v "+versionN+"\";\n");
195 ret.append("BEGIN ");
196 ret.append("VAR < tempa := 0, tempb := 0, tempres :=0,\n\t");
197 ret.append("mjvm_locals := ARRAY(1,0), ");
198 ret.append("\n\tmjvm_statics := ARRAY("+numWords+",0), ");
199 ret.append("\n\tmjvm_arrays := < >, ");
200 ret.append("\n\tmjvm_objects := < >, ");
201 ret.append("\n mjvm_estack := < >, mjvm_mstack := < > > : ");
203 return ret.toString();
206 public String createStandardEnd(){
207 StringBuilder ret = new StringBuilder("SKIP\nENDVAR");
208 ret.append("\nWHERE\n");
210 ret.append("\nPROC Print_MJ(val, format VAR)==\n");
211 ret.append(createComment("print spacing", C_SPEC));
213 ret.append("\n\tIF format>1 THEN\n\t\tFOR i:=2 TO ");
214 ret.append("format STEP 1 DO PRINFLUSH(\" \") OD\n");
215 ret.append("\tFI;\n\tPRINFLUSH(val)\nEND\n");
217 ret.append("\nEND\n");
219 return ret.toString();
222 private String createLocal(int i) {
223 // arrays start at 1 in WSL, so we need an offset
224 return "mjvm_locals[" + (i + 1) + "]";
227 private String createStatic(int i) {
228 return "mjvm_statics[" + (i + 1) + "]";
231 private String createArray(int i) {
232 return "mjvm_arrays[" + i + "]";
235 private String createArray(String i) {
236 return "mjvm_arrays[" + i + "]";
239 private String createObject(String i) {
240 return "mjvm_objects[" + i + "]";
243 /**
244 * Creates a WSL comment with care to quote chars.
245 */
246 public static String createComment(String str){
247 return createComment(str, C_REG);
250 /**
251 * Creates a WSL comment with care to quote chars, of the
252 * given type. Types are given as char constants. They can be
253 * default comments, comments that contain the original code
254 * in them, or additional comments regarding the translation
255 * process.
256 */
257 public static String createComment(String str, char type) {
258 return "C:\"" + type + str.replace("\"", "''") + "\";";
261 //Expression stack
263 private String createToEStack(int i) {
264 String res = "mjvm_estack := <" + i + " > ++ mjvm_estack;";
265 if (genPrintEStackOnChange)
266 res += "PRINT(\"eStack\",mjvm_estack);";
267 return res;
270 private String createToEStack(String i) {
271 String res = "mjvm_estack := <" + i + " > ++ mjvm_estack;";
272 if (genPrintEStackOnChange)
273 res += "PRINT(\"eStack\",mjvm_estack);";
274 return res;
277 private String createFromEStack(String st) {
278 String res = st
279 + " := HEAD(mjvm_estack); mjvm_estack := TAIL(mjvm_estack);";
280 if (genPrintEStackOnChange)
281 res += "PRINT(\"eStack\",mjvm_estack);";
282 return res;
285 private String createPopEStack() {
286 String res = "mjvm_estack := TAIL(mjvm_estack);";
287 if (genPrintEStackOnChange)
288 res += "PRINT(\"eStack\",mjvm_estack);";
289 return res;
292 private String createTopTwoEStack() {
293 return createFromEStack("tempa") + "\n" + createFromEStack("tempb");
296 private String createTopEStack() {
297 return createFromEStack("tempa");
300 //Method stack
302 private String createToMStack(int i) {
303 return "mjvm_mstack := <" + i + " > ++ mjvm_mstack;";
306 private String createToMStack(String i) {
307 return "mjvm_mstack := <" + i + " > ++ mjvm_mstack;";
310 private String createFromMStack(String st) {
311 return st + " := HEAD(mjvm_mstack); mjvm_mstack := TAIL(mjvm_mstack);";
314 private String getRelationFor(int opcode) throws Exception {
315 switch (opcode) {
316 case jeq: return "=";
317 case jne: return "<>";
318 case jlt: return "<";
319 case jle: return "<=";
320 case jgt: return ">";
321 case jge: return ">=";
323 throw new Exception("Wrong opcode for a relation");
326 private boolean isJumpCode(int opcode) {
327 return (opcode >= jmp) && (opcode <= jge);
330 public void convertStream(InputStream ins) throws Exception{
331 mainIn = ins;
332 //process start
333 byte m = (byte) get();
334 byte j = (byte) get();
335 if (m!='M' || j !='J')
336 throw new Exception("Wrong start of bytecode file");
337 int codesize = get4();
338 int numberOfWords = get4();
339 int mainAdr = get4();
341 prl(createStandardStart(numberOfWords));
342 prl("SKIP;\n ACTIONS A_S_start:\n A_S_start == CALL a" + (14 + mainAdr)
343 + " END");
344 int op = get();
345 while (op >= 0) {
346 if (originalInComments)
347 prl(createComment(describeOpCode(op), C_OC));
348 prl("a" + counter + " == ");
349 if (genPrintForEachAddress) {
350 prl("PRINT(\"a" + counter + "\");");
351 if (genPauseAfterEachAddress)
352 prl("debug_disposable_string := @Read_Line(Standard_Input_Port);");
354 switch (op) {
355 case load: {
356 prl(createToEStack(createLocal(get())));
357 break;
359 case load_0:
360 case load_1:
361 case load_2:
362 case load_3: {
363 prl(createToEStack(createLocal(op - load_0)));
364 break;
366 case store: {
367 prl(createFromEStack(createLocal(get())));
368 break;
370 case store_0:
371 case store_1:
372 case store_2:
373 case store_3: {
374 prl(createFromEStack(createLocal(op - store_0)));
375 break;
378 case getstatic: {
379 prl(createToEStack(createStatic(get2())));
380 break;
382 case putstatic: {
383 prl(createFromEStack(createStatic(get2())));
384 break;
387 case getfield: {
388 int f = get2();
389 prl(createTopEStack());
390 prl(createToEStack(createObject("tempa") + "[" + (f + 1) + "]"));
391 break;
393 case putfield: {
394 int f = get2();
395 // we need to use a temparray as a pointer, WSL
396 // otherwise tries to access it as a list of lists and fails
397 prl(createTopTwoEStack());
398 prl("VAR < tempArray := " + createObject("tempb") + " > :");
399 prl("tempArray[" + (f + 1) + "]:=tempa ENDVAR;");
400 break;
403 case const_: {
404 prl(createToEStack(get4()));
405 break;
408 case const_0:
409 case const_1:
410 case const_2:
411 case const_3:
412 case const_4:
413 case const_5: {
414 prl(createToEStack(op - const_0));
415 break;
418 case add: {
419 prl(createTopTwoEStack());
420 prl("tempres := tempb + tempa;");
421 prl(createToEStack("tempres"));
422 break;
424 case sub: {
425 prl(createTopTwoEStack());
426 prl("tempres := tempb - tempa;");
427 prl(createToEStack("tempres"));
428 break;
430 case mul: {
431 prl(createTopTwoEStack());
432 prl("tempres := tempb * tempa;");
433 prl(createToEStack("tempres"));
434 break;
436 case div: {
437 prl(createTopTwoEStack());
438 prl("IF tempa = 0 THEN ERROR(\"division by zero\") FI;");
439 prl("tempres := tempb DIV tempa;");
440 prl(createToEStack("tempres"));
441 break;
443 case rem: {
444 prl(createTopTwoEStack());
445 prl("IF tempa = 0 THEN ERROR(\"division by zero\") FI;");
446 prl("tempres := tempb MOD tempa;");
447 prl(createToEStack("tempres"));
448 break;
451 case neg: {
452 prl(createTopEStack());
453 prl(createToEStack("-tempa"));
454 break;
457 case shl: {
458 prl(createTopTwoEStack());
459 prl("VAR <tempres :=tempb, i:=1 >:");
460 prl("\tFOR i:=1 TO tempa STEP 1 DO tempres := tempres * 2 OD;");
461 prl(createToEStack("tempres"));
462 prl("ENDVAR;");
463 break;
465 case shr: {
466 prl(createTopTwoEStack());
467 prl("VAR <tempres :=tempb, i:=1 >:");
468 prl("\tFOR i:=1 TO tempa STEP 1 DO tempres := tempres DIV 2 OD;");
469 prl(createToEStack("tempres"));
470 prl("ENDVAR;");
471 break;
474 case inc: {
475 int b1 = get(), b2 = get();
476 prl(createLocal(b1) + " := " + createLocal(b1) + " + " + b2 + ";");
477 break;
480 case new_: {
481 int size = get2();
482 // TODO maybe objects and arrays should be in the same list?
483 prl("mjvm_objects := mjvm_objects ++ < ARRAY(" + size
484 + ",0) >;");
485 prl(createToEStack("LENGTH(mjvm_objects)"));
486 break;
488 case newarray: {
489 get();// 0 - bytes, 1 - words; ignore for now
490 // TODO take into consideration 0/1
491 prl(createTopEStack());
492 prl("mjvm_arrays := mjvm_arrays ++ < ARRAY(tempa,0) >;");
493 prl(createToEStack("LENGTH(mjvm_arrays)"));
494 break;
497 case aload:
498 case baload: {
499 prl(createTopTwoEStack());
500 prl(createToEStack(createArray("tempb") + "[tempa+1]"));
501 break;
503 case astore:
504 case bastore: {
505 prl(createFromEStack("tempres"));
506 prl(createTopTwoEStack());
507 // we need to use a temparray as a pointer, WSL
508 // otherwise tries to access it as a list of lists and fails
509 prl("VAR < tempArray := " + createArray("tempb") + " > :");
510 prl("tempArray[tempa+1]:=tempres ENDVAR;");
511 break;
513 case arraylength: {
514 prl(createTopEStack());
515 prl("tempb := LENGTH("+ createArray("tempa") + ");");
516 prl(createToEStack("tempb"));
517 break;
520 case dup: {
521 prl(createTopEStack());
522 prl(createToEStack("tempa"));
523 prl(createToEStack("tempa"));
524 break;
526 case dup2: {
527 prl(createTopTwoEStack());
528 prl(createToEStack("tempb"));
529 prl(createToEStack("tempa"));
530 prl(createToEStack("tempb"));
531 prl(createToEStack("tempa"));
532 break;
535 case pop: {
536 prl(createPopEStack());
537 break;
540 case jmp: {
541 prl("CALL a" + (counter + get2()) + ";");
542 break;
545 case jeq:
546 case jne:
547 case jlt:
548 case jle:
549 case jgt:
550 case jge: {
551 prl(createTopTwoEStack());
552 prl("IF tempb " + getRelationFor(op) + " tempa THEN CALL a"
553 + (counter + get2()) + " ELSE CALL a" + (counter + 1)
554 + " FI;");
555 break;
558 case call: {
559 prl("CALL a" + (counter + get2()) + ";");
560 break;
563 case return_: {
564 // we let the actions return
565 // there is nothing to clean up
566 prl("SKIP END b" + counter + " ==");
567 break;
569 case enter: {
570 int parameters = get();
572 int locals = get();
573 prl(createToMStack("mjvm_locals"));
574 prl("mjvm_locals := ARRAY(" + locals + ",0);");
575 for (int i = parameters - 1; i >= 0; i--)
576 prl(createFromEStack(createLocal(i)));
577 break;
579 case exit: {
580 prl(createFromMStack("mjvm_locals"));
581 break;
584 // read, print
585 case bread: {
586 // TODO make it a char for read
587 messages.message("char is read like a number", TransMessages.M_WAR);
588 prl(createComment("char is read like a number", C_SPEC));
590 case read: {
591 prl("tempa := @String_To_Num(@Read_Line(Standard_Input_Port));");
592 prl(createToEStack("tempa"));
593 break;
596 // the prints
597 case bprint: {
598 // TODO need to make it a char on print
599 messages.message("chars will be printed as number codes", TransMessages.M_WAR);
600 prl(createComment("char will be printed as a number code",
601 C_SPEC));
603 case print: {
604 // TODO printing numbers needs different lengths of spacing
605 prl(createTopTwoEStack());
606 prl("Print_MJ(tempb,tempa);");
607 break;
610 case trap: {
611 prl("ERROR(\"Runtime error: trap(" + get() + ")\");");
612 break;
615 default:
616 prl(createComment("unknown op error: " + op, C_ERR));
617 messages.message("unknown op error: " + op, TransMessages.M_ERR);
618 break;
621 boolean wasJump = isJumpCode(op);
622 op = get();
623 if (op >= 0)
624 if (wasJump)
625 prl("SKIP END");
626 else
627 prl("CALL a" + counter + " END");
629 prl("\nSKIP END\nENDACTIONS;\n");
630 prl(createStandardEnd());
633 public void convertFile(File f) {
634 try {
635 convertStream(new FileInputStream(f));
636 } catch (Exception ex) {
637 ex.printStackTrace();
641 public void printHelp() {
642 printVersion();
643 printUsage();
644 printHelpOutput();
645 printHelpHelp();
648 public void printLongHelp() {
649 printVersion();
650 printUsage();
651 System.out.println();
652 printHelpOutput();
653 System.out.println();
654 printHelpGenerating();
655 System.out.println();
656 printHelpHelp();
659 public void printHelpOutput() {
660 System.out.println("Output options:");
661 System.out.println(" --screen print output to screen");
662 System.out.println(" -o --oc[+-] include original code in comments");
663 System.out.println(" -v verbose, print warning messages");
664 System.out.println(" -q quiet; don't print even the error messages");
665 System.out.println(" -d print detailed debug messages");
668 public void printHelpGenerating() {
669 System.out.println("Options for generating extra code for tracking code execution");
670 System.out.println(" --genEStackPrint generate print for all EStack changes");
671 System.out.println(" --genAddrPrint generate prints after every address of the original code ");
672 System.out.println(" --genAddrPause generate a pause after every address of the original code ");
673 System.out.println(" --genAddr short for --genAddrPrint and --genAddrPause");
674 System.out.println(" --genAll short for applying all code generation");
677 public void printHelpHelp() {
678 System.out.println("Help and info options");
679 System.out.println(" -h basic help");
680 System.out.println(" --help print more detailed help");
681 System.out.println(" --version or -version print version and exit");
684 public void printUsage(){
685 System.out.println("usage:\n\t mjc2wsl {options} filename [outfile]");
688 public void printVersion() {
689 System.out.println("MicroJava bytecode to WSL converter. v " + versionN
690 + ", by Doni Pracner");
693 public String makeDefaultOutName(String inname){
694 String rez = inname;
695 if (inname.endsWith(".obj"))
696 rez = rez.substring(0, rez.length() - 4);
697 return rez + ".wsl";
700 public void run(String[] args) {
701 if (args.length == 0) {
702 printHelp();
703 } else {
704 int i = 0;
705 while (i < args.length && args[i].charAt(0) == '-') {
706 if (args[i].compareTo("-h") == 0) {
707 printHelp();
708 return;
709 } else if (args[i].compareTo("--help") == 0) {
710 printLongHelp();
711 return;
712 } else if (args[i].compareTo("--version") == 0
713 || args[i].compareTo("-version") == 0) {
714 printVersion();
715 return;
716 } else if (args[i].compareTo("-o") == 0
717 || args[i].startsWith("--oc")) {
718 if (args[i].length() == 2)
719 originalInComments = true;
720 else if (args[i].length() == 5)
721 originalInComments = args[i].charAt(4) == '+';
722 else
723 originalInComments = true;
724 } else if (args[i].compareTo("--screen") == 0) {
725 out = new PrintWriter(System.out);
726 } else if (args[i].compareTo("-d") == 0) {
727 messages.setPrintLevel(TransMessages.M_DEB);// print debug info
728 } else if (args[i].compareTo("-v") == 0) {
729 messages.setPrintLevel(TransMessages.M_WAR);// print warnings
730 } else if (args[i].compareTo("-q") == 0) {
731 messages.setPrintLevel(TransMessages.M_QUIET);// no printing
732 } else if (args[i].compareToIgnoreCase("--genEStackPrint") == 0) {
733 genPrintEStackOnChange = true;
734 } else if (args[i].compareToIgnoreCase("--genAddrPause") == 0) {
735 genPauseAfterEachAddress = true;
736 } else if (args[i].compareToIgnoreCase("--genAddrPrint") == 0) {
737 genPrintForEachAddress = true;
738 } else if (args[i].compareToIgnoreCase("--genAddr") == 0) {
739 genPrintForEachAddress = true;
740 genPauseAfterEachAddress = true;
741 } else if (args[i].compareToIgnoreCase("--genAll") == 0) {
742 genPrintEStackOnChange = true;
743 genPrintForEachAddress = true;
744 genPauseAfterEachAddress = true;
746 i++;
749 if (i >= args.length) {
750 System.out.println("no filename supplied");
751 System.exit(2);
753 File f = new File(args[i]);
755 if (i + 1 < args.length) {
756 try {
757 out = new PrintWriter(args[i + 1]);
758 } catch (Exception e) {
759 System.err.println("error in opening out file:");
760 e.printStackTrace();
763 if (out == null) {
764 // if not set to screen, or a file, make a default filename
765 try {
766 out = new PrintWriter(makeDefaultOutName(args[i]));
767 } catch (Exception e) {
768 System.err.println("error in opening out file:");
769 e.printStackTrace();
772 if (f.exists()) {
773 Calendar now = Calendar.getInstance();
774 convertFile(f);
775 long mili = Calendar.getInstance().getTimeInMillis()
776 - now.getTimeInMillis();
777 System.out.println("conversion time:" + mili + " ms");
778 messages.printMessageCounters();
779 out.close();
780 } else
781 System.out.println("file does not exist");
785 public static void main(String[] args) {
786 new mjc2wsl().run(args);
Svarog.pmf.uns.ac.rs/gitweb maintanance Doni Pracner