spotless reformat

Author: 0sak

build.gradle

@@ -71,26 +71,8 @@ tasks.withType(Test).configureEach {
 }
 
 spotless {
-
-    format 'misc', {
-        // define the files to apply `misc` to
-        target '*.gradle', '.gitattributes', '.gitignore', '.editorconfig', '*.cff' , '*.md', 'gradlew', 'gradlew.bat'
-
-        // define the steps to apply to those files
-        trimTrailingWhitespace()
-        indentWithTabs() // or spaces. Takes an integer argument if you don't like 4
-        endWithNewline()
-    }
     java {
-        // don't need to set target, it is inferred from java
-
-        // apply a specific flavor of google-java-format
-        googleJavaFormat('1.17.0').aosp().reflowLongStrings().skipJavadocFormatting()
-        // fix formatting of type annotations
-        formatAnnotations()
-        // make sure every file has the following copyright header.
-        // optionally, Spotless can set copyright years by digging
-        // through git history (see "license" section below)
-        licenseHeader '/* (C)$YEAR */'
+        googleJavaFormat().aosp().reflowLongStrings()
+        target '**/*.java'
     }
 }

src/main/java/CBuilder/Expression.java

@@ -1,7 +1,8 @@
 package CBuilder;
 
 /**
- * Something that returns the C representation of a MiniPython object, e. g. a function call or a literal.
+ * Something that returns the C representation of a MiniPython object, e. g. a function call or a
+ * literal.
  */
 public interface Expression extends Statement {
 
@@ -11,5 +12,4 @@ public interface Expression extends Statement {
      * @return A String with the c-code that evaluates to the containing MiniPython object.
      */
     String buildExpression();
-
 }

src/main/java/CBuilder/ManualTest.java

@@ -1,10 +1,11 @@
 package CBuilder;
 
+import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
+
 import CBuilder.objects.MPyClass;
 import CBuilder.objects.functions.Function;
 import CBuilder.objects.functions.ReturnStatement;
 import CBuilder.variables.VariableDeclaration;
-
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -16,59 +17,45 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
-
-/**
- * Entrypoint to creating C code from a MiniPython AST.
- */
+/** Entrypoint to creating C code from a MiniPython AST. */
 public class ProgramBuilder {
 
-    /**
-     * Definition of the c-runtime header files.
-     */
+    /** Definition of the c-runtime header files. */
     private static final String[] headers = {
-            // allow usage of assertions
-            "assert",
-            // aliases mapping python names to the internal c names
-            "mpy_aliases",
-            // ref-counting
-            "mpy_obj",
-            // initialisation
-            "builtins-setup",
-            // building function args
-            "function-args",
-            "literals/tuple",
-            "literals/int",
-            "literals/boolean",
-            "literals/str",
-            "type-hierarchy/object",
-            // custom objects
-            "type-hierarchy/type",
+        // allow usage of assertions
+        "assert",
+        // aliases mapping python names to the internal c names
+        "mpy_aliases",
+        // ref-counting
+        "mpy_obj",
+        // initialisation
+        "builtins-setup",
+        // building function args
+        "function-args",
+        "literals/tuple",
+        "literals/int",
+        "literals/boolean",
+        "literals/str",
+        "type-hierarchy/object",
+        // custom objects
+        "type-hierarchy/type",
     };
 
-    /**
-     * A list of all statements in the global scope.
-     */
+    /** A list of all statements in the global scope. */
     private final List<Statement> statements;
 
-    /**
-     * A list of all defined variables in the global scope.
-     */
+    /** A list of all defined variables in the global scope. */
     private final List<VariableDeclaration> globalVariables;
 
-    /**
-     * A list of all defined functions in the global scope.
-     */
+    /** A list of all defined functions in the global scope. */
     private final List<Function> globalFunctions;
 
-    /**
-     * A list of all defined classes in th global scope.
-     */
+    /** A list of all defined classes in th global scope. */
     private final List<MPyClass> classes;
 
     /**
-     * Create a new program with empty global scope.
-     * Allows to manually specify options regarding c-code generation.
+     * Create a new program with empty global scope. Allows to manually specify options regarding
+     * c-code generation.
      */
     public ProgramBuilder() {
         statements = new LinkedList<>();
@@ -78,14 +65,15 @@ public ProgramBuilder() {
     }
 
     /**
-     * Add a new statement to the global scope.
-     * The resulting statement list more or less represents the program's main method.
+     * Add a new statement to the global scope. The resulting statement list more or less represents
+     * the program's main method.
      *
      * @param statement The statement to add.
      */
     public void addStatement(Statement statement) {
         if (statement instanceof ReturnStatement) {
-            // I'd prefer to have this type safe (i. e. different statement interfaces for global/non-global scope,
+            // I'd prefer to have this type safe (i. e. different statement interfaces for
+            // global/non-global scope,
             // but this is just a prototype after all and shouldn't happen too often anyway)
             throw new IllegalArgumentException("Cannot return from global scope");
         }
@@ -204,8 +192,11 @@ public String buildProgram() {
 
         body.append("return 0;\n");
 
-        program.append(body.toString().lines().map(string -> "\t" + string + "\n").collect(
-                Collectors.joining()));
+        program.append(
+                body.toString()
+                        .lines()
+                        .map(string -> "\t" + string + "\n")
+                        .collect(Collectors.joining()));
         program.append("}\n");
 
         return program.toString();
@@ -235,7 +226,12 @@ public void writeProgram(Path destDir) {
 
         try {
             Path output = Path.of(destDir.toString(), "src/program.c");
-            java.nio.file.Files.writeString(output, this.buildProgram(), java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE, java.nio.file.StandardOpenOption.TRUNCATE_EXISTING);
+            java.nio.file.Files.writeString(
+                    output,
+                    this.buildProgram(),
+                    java.nio.file.StandardOpenOption.CREATE,
+                    java.nio.file.StandardOpenOption.WRITE,
+                    java.nio.file.StandardOpenOption.TRUNCATE_EXISTING);
         } catch (java.io.IOException e) {
             throw new RuntimeException("Failed to write 'program.c'!", e);
         }
@@ -250,13 +246,18 @@ public void writeProgram(Path destDir) {
      */
     public void copyFolder(Path srcDir, Path destDir) throws IOException {
         try (Stream<Path> stream = Files.walk(srcDir)) {
-            stream.forEach(source -> {
-                try {
-                    Files.copy(source, destDir.resolve(srcDir.relativize(source)), REPLACE_EXISTING);
-                } catch (IOException e) {
-                    throw new RuntimeException("Failed to copy template folder to output directory", e);
-                }
-            });
+            stream.forEach(
+                    source -> {
+                        try {
+                            Files.copy(
+                                    source,
+                                    destDir.resolve(srcDir.relativize(source)),
+                                    REPLACE_EXISTING);
+                        } catch (IOException e) {
+                            throw new RuntimeException(
+                                    "Failed to copy template folder to output directory", e);
+                        }
+                    });
         }
     }
 
@@ -265,29 +266,37 @@ public void copyFolder(Path srcDir, Path destDir) throws IOException {
      *
      * @param resourcePath The Path to the jar archive.
      * @param targetLocation The output directory.
-     * @throws URISyntaxException Will be thrown if the c-runtime can not be found in the application resources.
+     * @throws URISyntaxException Will be thrown if the c-runtime can not be found in the
+     *     application resources.
      * @throws IOException Will be thrown if a needed file or folder is not accessible.
      */
-    public void copyFolderFromJar(String resourcePath, final Path targetLocation) throws URISyntaxException, IOException {
+    public void copyFolderFromJar(String resourcePath, final Path targetLocation)
+            throws URISyntaxException, IOException {
         URI resource = getClass().getResource("/c-runtime").toURI();
 
         try (FileSystem fileSystem = FileSystems.newFileSystem(resource, Map.of())) {
             final Path jarArchive = fileSystem.getPath(resourcePath);
-            Files.walkFileTree(jarArchive, new SimpleFileVisitor<>() {
-                @Override
-                public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
-                    Files.createDirectories(targetLocation.resolve(jarArchive.relativize(dir).toString()));
-                    return FileVisitResult.CONTINUE;
-                }
-
-                @Override
-                public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
-                    Files.copy(file, targetLocation.resolve(jarArchive.relativize(file).toString()), REPLACE_EXISTING);
-                    return FileVisitResult.CONTINUE;
-                }
-
-            });
+            Files.walkFileTree(
+                    jarArchive,
+                    new SimpleFileVisitor<>() {
+                        @Override
+                        public FileVisitResult preVisitDirectory(
+                                Path dir, BasicFileAttributes attrs) throws IOException {
+                            Files.createDirectories(
+                                    targetLocation.resolve(jarArchive.relativize(dir).toString()));
+                            return FileVisitResult.CONTINUE;
+                        }
+
+                        @Override
+                        public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
+                                throws IOException {
+                            Files.copy(
+                                    file,
+                                    targetLocation.resolve(jarArchive.relativize(file).toString()),
+                                    REPLACE_EXISTING);
+                            return FileVisitResult.CONTINUE;
+                        }
+                    });
         }
     }
-
 }

src/main/java/CBuilder/ProgramBuilder.java

@@ -1,13 +1,9 @@
 package CBuilder;
 
-/**
- * Representation of a reference to a MiniPython variable, i. e. a variable name.
- */
+/** Representation of a reference to a MiniPython variable, i. e. a variable name. */
 public class Reference implements Expression {
 
-    /**
-     * The name of the reference.
-     */
+    /** The name of the reference. */
     protected String name;
 
     /**
@@ -24,7 +20,9 @@ public Reference(String name) {
      *
      * @return The name of the reference.
      */
-    public String getName() { return this.name; }
+    public String getName() {
+        return this.name;
+    }
 
     @Override
     public String buildExpression() {
@@ -35,5 +33,4 @@ public String buildExpression() {
     public String buildStatement() {
         return name + ";\n";
     }
-
 }

src/main/java/CBuilder/Reference.java

@@ -1,7 +1,8 @@
 package CBuilder;
 
 /**
- * C representation of anything that does something in MiniPython, e. g. assignments, control structures, function calls.
+ * C representation of anything that does something in MiniPython, e. g. assignments, control
+ * structures, function calls.
  */
 public interface Statement {
 
@@ -11,5 +12,4 @@ public interface Statement {
      * @return A String which represents the c-code of the statement.
      */
     String buildStatement();
-
 }

src/main/java/CBuilder/Statement.java

@@ -4,28 +4,19 @@
 import CBuilder.conditions.conditionalStatement.ElifStatement;
 import CBuilder.conditions.conditionalStatement.ElseStatement;
 import CBuilder.conditions.conditionalStatement.IfStatement;
-
 import java.util.List;
 import java.util.Optional;
 
-/**
- * A MiniPython if (/else if/else) block.
- */
+/** A MiniPython if (/else if/else) block. */
 public class IfThenElseStatement implements Statement {
 
-    /**
-     * The containing if block.
-     */
+    /** The containing if block. */
     private IfStatement ifStatement;
 
-    /**
-     * A list of the containing elif blocks.
-     */
+    /** A list of the containing elif blocks. */
     private Optional<List<ElifStatement>> elifStatements;
 
-    /**
-     * The containing else block.
-     */
+    /** The containing else block. */
     private Optional<ElseStatement> elseStatement;
 
     /**
@@ -35,7 +26,10 @@ public class IfThenElseStatement implements Statement {
      * @param elifStatements An optional list of elif statements.
      * @param elseStatement An optional else statement.
      */
-    public IfThenElseStatement(IfStatement ifStatement, Optional<List<ElifStatement>> elifStatements, Optional<ElseStatement> elseStatement) {
+    public IfThenElseStatement(
+            IfStatement ifStatement,
+            Optional<List<ElifStatement>> elifStatements,
+            Optional<ElseStatement> elseStatement) {
         this.ifStatement = ifStatement;
         this.elifStatements = elifStatements;
         this.elseStatement = elseStatement;