gitweb on Svarog

projekti pod git sistemom za održavanje verzija -- projects under the git version control system
mjc2wsl removed some unneeded variables from the start
[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("VAR < tempa := 0, tempb := 0, tempres :=0,\n\t");
196 ret.append("mjvm_locals := ARRAY(1,0), ");
197 ret.append("\n\tmjvm_statics := ARRAY("+numWords+",0), ");
198 ret.append("\n\tmjvm_arrays := < >, ");
199 ret.append("\n\tmjvm_objects := < >, ");
200 ret.append("\n mjvm_estack := < >, mjvm_mstack := < > > : ");
202 return ret.toString();
205 public String createStandardEnd(){
206 return "SKIP\nENDVAR";
209 private String createLocal(int i) {
210 // arrays start at 1 in WSL, so we need an offset
211 return "mjvm_locals[" + (i + 1) + "]";
214 private String createStatic(int i) {
215 return "mjvm_statics[" + (i + 1) + "]";
218 private String createArray(int i) {
219 return "mjvm_arrays[" + i + "]";
222 private String createArray(String i) {
223 return "mjvm_arrays[" + i + "]";
226 private String createObject(String i) {
227 return "mjvm_objects[" + i + "]";
230 /**
231 * Creates a WSL comment with care to quote chars.
232 */
233 public static String createComment(String str){
234 return createComment(str, C_REG);
237 /**
238 * Creates a WSL comment with care to quote chars, of the
239 * given type. Types are given as char constants. They can be
240 * default comments, comments that contain the original code
241 * in them, or additional comments regarding the translation
242 * process.
243 */
244 public static String createComment(String str, char type) {
245 return "C:\"" + type + str.replace("\"", "''") + "\";";
248 //Expression stack
250 private String createToEStack(int i) {
251 String res = "mjvm_estack := <" + i + " > ++ mjvm_estack;";
252 if (genPrintEStackOnChange)
253 res += "PRINT(\"eStack\",mjvm_estack);";
254 return res;
257 private String createToEStack(String i) {
258 String res = "mjvm_estack := <" + i + " > ++ mjvm_estack;";
259 if (genPrintEStackOnChange)
260 res += "PRINT(\"eStack\",mjvm_estack);";
261 return res;
264 private String createFromEStack(String st) {
265 String res = st
266 + " := HEAD(mjvm_estack); mjvm_estack := TAIL(mjvm_estack);";
267 if (genPrintEStackOnChange)
268 res += "PRINT(\"eStack\",mjvm_estack);";
269 return res;
272 private String createPopEStack() {
273 String res = "mjvm_estack := TAIL(mjvm_estack);";
274 if (genPrintEStackOnChange)
275 res += "PRINT(\"eStack\",mjvm_estack);";
276 return res;
279 private String createTopTwoEStack() {
280 return createFromEStack("tempa") + "\n" + createFromEStack("tempb");
283 private String createTopEStack() {
284 return createFromEStack("tempa");
287 //Method stack
289 private String createToMStack(int i) {
290 return "mjvm_mstack := <" + i + " > ++ mjvm_mstack;";
293 private String createToMStack(String i) {
294 return "mjvm_mstack := <" + i + " > ++ mjvm_mstack;";
297 private String createFromMStack(String st) {
298 return st + " := HEAD(mjvm_mstack); mjvm_mstack := TAIL(mjvm_mstack);";
301 private String getRelationFor(int opcode) throws Exception {
302 switch (opcode) {
303 case jeq: return "=";
304 case jne: return "<>";
305 case jlt: return "<";
306 case jle: return "<=";
307 case jgt: return ">";
308 case jge: return ">=";
310 throw new Exception("Wrong opcode for a relation");
313 private boolean isJumpCode(int opcode) {
314 return (opcode >= jmp) && (opcode <= jge);
317 public void convertStream(InputStream ins) throws Exception{
318 mainIn = ins;
319 //process start
320 byte m = (byte) get();
321 byte j = (byte) get();
322 if (m!='M' || j !='J')
323 throw new Exception("Wrong start of bytecode file");
324 int codesize = get4();
325 int numberOfWords = get4();
326 int mainAdr = get4();
328 prl(createStandardStart(numberOfWords));
329 prl("SKIP;\n ACTIONS A_S_start:\n A_S_start == CALL a" + (14 + mainAdr)
330 + " END");
331 int op = get();
332 while (op >= 0) {
333 if (originalInComments)
334 prl(createComment(describeOpCode(op), C_OC));
335 prl("a" + counter + " == ");
336 if (genPrintForEachAddress) {
337 prl("PRINT(\"a" + counter + "\");");
338 if (genPauseAfterEachAddress)
339 prl("debug_disposable_string := @Read_Line(Standard_Input_Port);");
341 switch (op) {
342 case load: {
343 prl(createToEStack(createLocal(get())));
344 break;
346 case load_0:
347 case load_1:
348 case load_2:
349 case load_3: {
350 prl(createToEStack(createLocal(op - load_0)));
351 break;
353 case store: {
354 prl(createFromEStack(createLocal(get())));
355 break;
357 case store_0:
358 case store_1:
359 case store_2:
360 case store_3: {
361 prl(createFromEStack(createLocal(op - store_0)));
362 break;
365 case getstatic: {
366 prl(createToEStack(createStatic(get2())));
367 break;
369 case putstatic: {
370 prl(createFromEStack(createStatic(get2())));
371 break;
374 case getfield: {
375 int f = get2();
376 prl(createTopEStack());
377 prl(createToEStack(createObject("tempa") + "[" + (f + 1) + "]"));
378 break;
380 case putfield: {
381 int f = get2();
382 // we need to use a temparray as a pointer, WSL
383 // otherwise tries to access it as a list of lists and fails
384 prl(createTopTwoEStack());
385 prl("VAR < tempArray := " + createObject("tempb") + " > :");
386 prl("tempArray[" + (f + 1) + "]:=tempa ENDVAR;");
387 break;
390 case const_: {
391 prl(createToEStack(get4()));
392 break;
395 case const_0:
396 case const_1:
397 case const_2:
398 case const_3:
399 case const_4:
400 case const_5: {
401 prl(createToEStack(op - const_0));
402 break;
405 case add: {
406 prl(createTopTwoEStack());
407 prl("tempres := tempb + tempa;");
408 prl(createToEStack("tempres"));
409 break;
411 case sub: {
412 prl(createTopTwoEStack());
413 prl("tempres := tempb - tempa;");
414 prl(createToEStack("tempres"));
415 break;
417 case mul: {
418 prl(createTopTwoEStack());
419 prl("tempres := tempb * tempa;");
420 prl(createToEStack("tempres"));
421 break;
423 case div: {
424 prl(createTopTwoEStack());
425 prl("IF tempa = 0 THEN ERROR(\"division by zero\") FI;");
426 prl("tempres := tempb DIV tempa;");
427 prl(createToEStack("tempres"));
428 break;
430 case rem: {
431 prl(createTopTwoEStack());
432 prl("IF tempa = 0 THEN ERROR(\"division by zero\") FI;");
433 prl("tempres := tempb MOD tempa;");
434 prl(createToEStack("tempres"));
435 break;
438 case neg: {
439 prl(createTopEStack());
440 prl(createToEStack("-tempa"));
441 break;
444 case shl: {
445 prl(createTopTwoEStack());
446 prl("VAR <tempres :=tempb, i:=1 >:");
447 prl("\tFOR i:=1 TO tempa STEP 1 DO tempres := tempres * 2 OD;");
448 prl(createToEStack("tempres"));
449 prl("ENDVAR;");
450 break;
452 case shr: {
453 prl(createTopTwoEStack());
454 prl("VAR <tempres :=tempb, i:=1 >:");
455 prl("\tFOR i:=1 TO tempa STEP 1 DO tempres := tempres DIV 2 OD;");
456 prl(createToEStack("tempres"));
457 prl("ENDVAR;");
458 break;
461 case inc: {
462 int b1 = get(), b2 = get();
463 prl(createLocal(b1) + " := " + createLocal(b1) + " + " + b2 + ";");
464 break;
467 case new_: {
468 int size = get2();
469 // TODO maybe objects and arrays should be in the same list?
470 prl("mjvm_objects := mjvm_objects ++ < ARRAY(" + size
471 + ",0) >;");
472 prl(createToEStack("LENGTH(mjvm_objects)"));
473 break;
475 case newarray: {
476 get();// 0 - bytes, 1 - words; ignore for now
477 // TODO take into consideration 0/1
478 prl(createTopEStack());
479 prl("mjvm_arrays := mjvm_arrays ++ < ARRAY(tempa,0) >;");
480 prl(createToEStack("LENGTH(mjvm_arrays)"));
481 break;
484 case aload:
485 case baload: {
486 prl(createTopTwoEStack());
487 prl(createToEStack(createArray("tempb") + "[tempa+1]"));
488 break;
490 case astore:
491 case bastore: {
492 prl(createFromEStack("tempres"));
493 prl(createTopTwoEStack());
494 // we need to use a temparray as a pointer, WSL
495 // otherwise tries to access it as a list of lists and fails
496 prl("VAR < tempArray := " + createArray("tempb") + " > :");
497 prl("tempArray[tempa+1]:=tempres ENDVAR;");
498 break;
500 case arraylength: {
501 prl(createTopEStack());
502 prl("tempb := LENGTH("+ createArray("tempa") + ");");
503 prl(createToEStack("tempb"));
504 break;
507 case dup: {
508 prl(createTopEStack());
509 prl(createToEStack("tempa"));
510 prl(createToEStack("tempa"));
511 break;
513 case dup2: {
514 prl(createTopTwoEStack());
515 prl(createToEStack("tempb"));
516 prl(createToEStack("tempa"));
517 prl(createToEStack("tempb"));
518 prl(createToEStack("tempa"));
519 break;
522 case pop: {
523 prl(createPopEStack());
524 break;
527 case jmp: {
528 prl("CALL a" + (counter + get2()) + ";");
529 break;
532 case jeq:
533 case jne:
534 case jlt:
535 case jle:
536 case jgt:
537 case jge: {
538 prl(createTopTwoEStack());
539 prl("IF tempb " + getRelationFor(op) + " tempa THEN CALL a"
540 + (counter + get2()) + " ELSE CALL a" + (counter + 1)
541 + " FI;");
542 break;
545 case call: {
546 prl("CALL a" + (counter + get2()) + ";");
547 break;
550 case return_: {
551 // we let the actions return
552 // there is nothing to clean up
553 prl("SKIP END b" + counter + " ==");
554 break;
556 case enter: {
557 int parameters = get();
559 int locals = get();
560 prl(createToMStack("mjvm_locals"));
561 prl("mjvm_locals := ARRAY(" + locals + ",0);");
562 for (int i = parameters - 1; i >= 0; i--)
563 prl(createFromEStack(createLocal(i)));
564 break;
566 case exit: {
567 prl(createFromMStack("mjvm_locals"));
568 break;
571 // read, print
572 case bread: {
573 // TODO make it a char for read
574 messages.message("char is read like a number", TransMessages.M_WAR);
575 prl(createComment("char is read like a number", C_SPEC));
577 case read: {
578 prl("tempa := @String_To_Num(@Read_Line(Standard_Input_Port));");
579 prl(createToEStack("tempa"));
580 break;
583 // the prints
584 case bprint: {
585 // TODO need to make it a char on print
586 messages.message("chars will be printed as number codes", TransMessages.M_WAR);
587 prl(createComment("char will be printed as a number code",
588 C_SPEC));
590 case print: {
591 // TODO printing numbers needs different lengths of spacing
592 prl(createTopTwoEStack());
593 pr(createComment("print spacing", C_SPEC));
594 prl("IF tempa>1 THEN FOR i:=2 TO tempa STEP 1 DO PRINFLUSH(\" \") OD FI;");
595 prl("PRINFLUSH(tempb);");
596 break;
599 case trap: {
600 prl("ERROR(\"Runtime error: trap(" + get() + ")\");");
601 break;
604 default:
605 prl(createComment("unknown op error: " + op, C_ERR));
606 messages.message("unknown op error: " + op, TransMessages.M_ERR);
607 break;
610 boolean wasJump = isJumpCode(op);
611 op = get();
612 if (op >= 0)
613 if (wasJump)
614 prl("SKIP END");
615 else
616 prl("CALL a" + counter + " END");
618 prl("\nSKIP END\nENDACTIONS;\n");
619 prl(createStandardEnd());
622 public void convertFile(File f) {
623 try {
624 convertStream(new FileInputStream(f));
625 } catch (Exception ex) {
626 ex.printStackTrace();
630 public void printHelp() {
631 printVersion();
632 printUsage();
633 printHelpOutput();
634 printHelpHelp();
637 public void printLongHelp() {
638 printVersion();
639 printUsage();
640 System.out.println();
641 printHelpOutput();
642 System.out.println();
643 printHelpGenerating();
644 System.out.println();
645 printHelpHelp();
648 public void printHelpOutput() {
649 System.out.println("Output options:");
650 System.out.println(" --screen print output to screen");
651 System.out.println(" -o --oc[+-] include original code in comments");
652 System.out.println(" -v verbose, print warning messages");
653 System.out.println(" -q quiet; don't print even the error messages");
654 System.out.println(" -d print detailed debug messages");
657 public void printHelpGenerating() {
658 System.out.println("Options for generating extra code for tracking code execution");
659 System.out.println(" --genEStackPrint generate print for all EStack changes");
660 System.out.println(" --genAddrPrint generate prints after every address of the original code ");
661 System.out.println(" --genAddrPause generate a pause after every address of the original code ");
662 System.out.println(" --genAddr short for --genAddrPrint and --genAddrPause");
663 System.out.println(" --genAll short for applying all code generation");
666 public void printHelpHelp() {
667 System.out.println("Help and info options");
668 System.out.println(" -h basic help");
669 System.out.println(" --help print more detailed help");
670 System.out.println(" --version or -version print version and exit");
673 public void printUsage(){
674 System.out.println("usage:\n\t mjc2wsl {options} filename [outfile]");
677 public void printVersion() {
678 System.out.println("MicroJava bytecode to WSL converter. v " + versionN
679 + ", by Doni Pracner");
682 public String makeDefaultOutName(String inname){
683 String rez = inname;
684 if (inname.endsWith(".obj"))
685 rez = rez.substring(0, rez.length() - 4);
686 return rez + ".wsl";
689 public void run(String[] args) {
690 if (args.length == 0) {
691 printHelp();
692 } else {
693 int i = 0;
694 while (i < args.length && args[i].charAt(0) == '-') {
695 if (args[i].compareTo("-h") == 0) {
696 printHelp();
697 return;
698 } else if (args[i].compareTo("--help") == 0) {
699 printLongHelp();
700 return;
701 } else if (args[i].compareTo("--version") == 0
702 || args[i].compareTo("-version") == 0) {
703 printVersion();
704 return;
705 } else if (args[i].compareTo("-o") == 0
706 || args[i].startsWith("--oc")) {
707 if (args[i].length() == 2)
708 originalInComments = true;
709 else if (args[i].length() == 5)
710 originalInComments = args[i].charAt(4) == '+';
711 else
712 originalInComments = true;
713 } else if (args[i].compareTo("--screen") == 0) {
714 out = new PrintWriter(System.out);
715 } else if (args[i].compareTo("-d") == 0) {
716 messages.setPrintLevel(TransMessages.M_DEB);// print debug info
717 } else if (args[i].compareTo("-v") == 0) {
718 messages.setPrintLevel(TransMessages.M_WAR);// print warnings
719 } else if (args[i].compareTo("-q") == 0) {
720 messages.setPrintLevel(TransMessages.M_QUIET);// no printing
721 } else if (args[i].compareToIgnoreCase("--genEStackPrint") == 0) {
722 genPrintEStackOnChange = true;
723 } else if (args[i].compareToIgnoreCase("--genAddrPause") == 0) {
724 genPauseAfterEachAddress = true;
725 } else if (args[i].compareToIgnoreCase("--genAddrPrint") == 0) {
726 genPrintForEachAddress = true;
727 } else if (args[i].compareToIgnoreCase("--genAddr") == 0) {
728 genPrintForEachAddress = true;
729 genPauseAfterEachAddress = true;
730 } else if (args[i].compareToIgnoreCase("--genAll") == 0) {
731 genPrintEStackOnChange = true;
732 genPrintForEachAddress = true;
733 genPauseAfterEachAddress = true;
735 i++;
738 if (i >= args.length) {
739 System.out.println("no filename supplied");
740 System.exit(2);
742 File f = new File(args[i]);
744 if (i + 1 < args.length) {
745 try {
746 out = new PrintWriter(args[i + 1]);
747 } catch (Exception e) {
748 System.err.println("error in opening out file:");
749 e.printStackTrace();
752 if (out == null) {
753 // if not set to screen, or a file, make a default filename
754 try {
755 out = new PrintWriter(makeDefaultOutName(args[i]));
756 } catch (Exception e) {
757 System.err.println("error in opening out file:");
758 e.printStackTrace();
761 if (f.exists()) {
762 Calendar now = Calendar.getInstance();
763 convertFile(f);
764 long mili = Calendar.getInstance().getTimeInMillis()
765 - now.getTimeInMillis();
766 System.out.println("conversion time:" + mili + " ms");
767 messages.printMessageCounters();
768 out.close();
769 } else
770 System.out.println("file does not exist");
774 public static void main(String[] args) {
775 new mjc2wsl().run(args);
Svarog.pmf.uns.ac.rs/gitweb maintanance Doni Pracner