Merge pull request #14 from polystat/develop

Latest changes

.github/workflows/gradle-build.yml

@@ -28,3 +28,7 @@ jobs:
         with:
           arguments: build
 
+      - uses: gradle/gradle-build-action@v1
+        with:
+          arguments: test
+

README.md

@@ -6,4 +6,63 @@
 
 [![Gradle Build](https://github.com/polystat/j2eo/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/polystat/j2eo/actions/workflows/gradle-build.yml)
 
-This is a translator of Java to [EOLANG](https://www.eolang.org).
+This is a translator of Java to [EOLANG](https://www.eolang.org).
+
+---
+
+## Motivation
+
+This project is a part of Polystat project, the goal of which is to statically analyze different languages using EOLANG,
+the implementation of phi-calculus. In order to do that, the first step is to convert source language into EO. This
+particular repository contains translator from Java to EO.
+
+---
+
+## Decisions
+
+**Q**: Why do we implement yet another Java parser?
+
+**A**: Publicly available parsers only support older versions of Java, while we aim to support the latest version (
+currently 16). Thus, we had to create our own parser.
+
+---
+
+**Q**: Why do we implement EO AST?
+
+**A**: Working with AST instead of raw strings allows utilization of Java compiler's type checking to minimize amount of
+bugs in our code. It is also much easier to work with abstraction layer than with strings.
+
+---
+
+## Usage
+
+> ⚠️ NOTE: for now, the entire pipeline is not available. Project is Work In Progress.
+
+```shell
+java -jar j2eo.jar <source package directory> -o <output directory>
+```
+
+---
+
+## How does it work?
+
+- First, the Java source code files are parsed recursively.
+- Then, for each file, translator converts Java AST to EO AST.
+- Then, EO AST is printed out as a source code to output directory in the same directory structure.
+
+## NOT covered Java features list
+
+- Type Erasure
+- Subtyping
+- Conversions
+- Casting
+- Modules
+- Exceptions
+- Asserts
+- Throws
+- ``synchronized`` blocks
+- ``try``/``catch`` blocks
+- ``yeild`` feature
+- Threads and Locks
+
+In general, we cover **91 feature of 112** described in the Java language specification.

build.gradle.kts

@@ -27,8 +27,8 @@ repositories {
 }
 
 dependencies {
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.6.0")
-    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.0")
+    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.0")
 }
 
 tasks.withType(JavaCompile::class).configureEach {
@@ -78,8 +78,9 @@ fun runBison() =
                 workingDir = File(".")
                 executable = "bin/win_bison.exe"
                 args = mutableListOf(
-                    "-r",
-                    "all",
+                    "--report=states,lookaheads",
+                 // "-r", "all",
+                 // "--debug", "--help", "--stacktrace",
                     "--report-file=${reportFilePath}",
                     "--output=${javaParserFilePath}",
                     javaGrammarFilePath
@@ -90,8 +91,7 @@ fun runBison() =
                 workingDir = File(".")
                 executable = "bin/bison_mac"
                 args = mutableListOf(
-                    "-r",
-                    "all",
+                    "-r", "all",
                     "--report-file=${reportFilePath}",
                     "--output=${javaParserFilePath}",
                     javaGrammarFilePath
@@ -102,8 +102,7 @@ fun runBison() =
                 workingDir = File(".")
                 executable = "bison"
                 args = mutableListOf(
-                    "-r",
-                    "all",
+                    "-r", "all",
                     "--report-file=${reportFilePath}",
                     "--output=${javaParserFilePath}",
                     javaGrammarFilePath
@@ -125,7 +124,7 @@ fun generateMD5(filepath: String): String {
         val buffer = ByteArray(8192)
         var read = 0
         do {
-            digest.update(buffer, 0, read);
+            digest.update(buffer, 0, read)
             read = inputStream.read(buffer)
         } while (read > 0)
     }

src/main/java/eotree/EOAnonExpr.java

@@ -0,0 +1,12 @@
+package eotree;
+
+public class EOAnonExpr extends EOBnd {
+    public EOAnonExpr(EOExpr expr) {
+        super(expr);
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return expr.generateEO(indent);
+    }
+}

src/main/java/eotree/EOAttribute.java

@@ -0,0 +1,26 @@
+package eotree;
+
+/**
+ * EBNF representation:
+ * <code>
+ * '@' | name [ '...' ]
+ * </code>
+ */
+public class EOAttribute extends EONode {
+    public static final EOAttribute DECORATEE = new EOAttribute("@", false);
+    public static final EOAttribute PARENT    = new EOAttribute("^", false);
+    public static final EOAttribute CURRENT   = new EOAttribute("$", false);
+
+    public String  name;
+    public boolean isVarArg;
+
+    public EOAttribute(String name, boolean isVarArg) {
+        this.name = name;
+        this.isVarArg = isVarArg;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return name + (isVarArg ? " ..." : "");
+    }
+}

src/main/java/eotree/EOAttributes.java

@@ -0,0 +1,21 @@
+package eotree;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class EOAttributes extends EONode {
+    public List<EOAttribute> attributes;
+
+    public EOAttributes(List<EOAttribute> attributes) {
+        this.attributes = attributes;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return "[" +
+               attributes.stream()
+                       .map(attribute -> attribute.generateEO(indent))
+                       .collect(Collectors.joining(" "))
+               + "]";
+    }
+}

src/main/java/eotree/EOBnd.java

@@ -0,0 +1,9 @@
+package eotree;
+
+public abstract class EOBnd extends EONode {
+    public EOExpr expr;
+
+    public EOBnd(EOExpr expr) {
+        this.expr = expr;
+    }
+}

src/main/java/eotree/EOBndExpr.java

@@ -0,0 +1,15 @@
+package eotree;
+
+public class EOBndExpr extends EOBnd {
+    public EOBndName bndName;
+
+    public EOBndExpr(EOExpr expr, EOBndName bndName) {
+        super(expr);
+        this.bndName = bndName;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return expr.generateEO(indent) + " > " + bndName.generateEO(0);
+    }
+}

src/main/java/eotree/EOBndName.java

@@ -0,0 +1,14 @@
+package eotree;
+
+public class EOBndName extends EONode {
+    public String name;
+
+    public EOBndName(String name) {
+        this.name = name;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return name;
+    }
+}

src/main/java/eotree/EOComment.java

@@ -0,0 +1,20 @@
+package eotree;
+
+/**
+ * EBNF representation:
+ * <code>
+ * '#' ANY EOL
+ * </code>
+ */
+public class EOComment extends EONode {
+    public String comment;
+
+    public EOComment(String comment) {
+        this.comment = comment;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return "# " + comment;
+    }
+}

src/main/java/eotree/EOCopy.java

@@ -0,0 +1,21 @@
+package eotree;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class EOCopy extends EOExpr {
+    public EOExpr      trg;
+    public List<EOBnd> args;
+
+    public EOCopy(EOExpr trg, List<EOBnd> args) {
+        this.trg = trg;
+        this.args = args;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return trg.generateEO(indent) + args.stream()
+                .map(arg -> " " + arg.generateEO(indent + 1))
+                .collect(Collectors.joining());
+    }
+}

src/main/java/eotree/EODot.java

@@ -0,0 +1,22 @@
+package eotree;
+
+import java.util.Optional;
+
+public class EODot extends EOExpr {
+    public Optional<EOExpr> src;
+    public String           name;
+
+    public EODot(Optional<EOExpr> src, String name) {
+        this.src = src;
+        this.name = name;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return
+                src
+                        .map(eoExpr -> eoExpr.generateEO(indent) + ".")
+                        .orElse(indent(indent))
+                + name;
+    }
+}

src/main/java/eotree/EOExpr.java

@@ -0,0 +1,4 @@
+package eotree;
+
+public abstract class EOExpr extends EONode {
+}

src/main/java/eotree/EOLicense.java

@@ -0,0 +1,30 @@
+package eotree;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * EBNF representation:
+ * <code>
+ * { comment EOL } EOL
+ * </code>
+ */
+public class EOLicense extends EONode {
+    public List<EOComment> comments;
+
+    public EOLicense(List<EOComment> comments) {
+        this.comments = comments;
+    }
+
+    public EOLicense(EOComment... comments) {
+        this(Arrays.stream(comments).collect(Collectors.toList()));
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return comments.stream()
+                .map(comment -> comment.generateEO(indent))
+                .collect(Collectors.joining("\n"));
+    }
+}

src/main/java/eotree/EOMeta.java

@@ -0,0 +1,22 @@
+package eotree;
+
+/**
+ * EBNF representation:
+ * <code>
+ * '+' name '␣' ANY EOL
+ * </code>
+ */
+public class EOMeta extends EONode {
+    public String name;
+    public String value;
+
+    public EOMeta(String name, String value) {
+        this.name = name;
+        this.value = value;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return "+" + name + " " + value;
+    }
+}

src/main/java/eotree/EOMetas.java

@@ -0,0 +1,31 @@
+package eotree;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+/**
+ * EBNF representation:
+ * <code>
+ * { meta EOL } EOL
+ * </code>
+ */
+public class EOMetas extends EONode {
+    public Optional<String> packageName;
+    public List<EOMeta>     metas;
+
+    public EOMetas(Optional<String> packageName, List<EOMeta> metas) {
+        this.packageName = packageName;
+        this.metas = metas;
+    }
+
+    @Override
+    public String generateEO(int indent) {
+        return packageName
+                       .map(p -> "+package " + p + "\n")
+                       .orElse("") +
+               metas.stream()
+                       .map(m -> m.generateEO(indent))
+                       .collect(Collectors.joining("\n"));
+    }
+}

src/main/java/eotree/EONode.java

@@ -0,0 +1,11 @@
+package eotree;
+
+public abstract class EONode {
+    public static final int INDENT_SIZE = 2;
+
+    public static String indent(int indent) {
+        return " ".repeat(indent * INDENT_SIZE);
+    }
+
+    public abstract String generateEO(int indent);
+}