Move LKQL engine option classes to a different module

HugoGGuerrier · HugoGGuerrier · commit 2f7f1c7b0577 · 2024-10-07T09:01:17.000Z
Move those classes to make the dependency graph cleaner, going from:
'language -&gt; cli'
to:
'language -&gt; options &lt;- cli'

Rational: On a structural POV, this makes not sense that the "language"
depends on the "cli" module.
diff --git a/lkql_jit/cli/pom.xml b/lkql_jit/cli/pom.xml
@@ -45,6 +45,7 @@
                                 <includes>
                                     <include>org.graalvm.sdk:launcher-common</include>
                                     <include>info.picocli:picocli</include>
+                                    <include>com.adacore:options</include>
                                     <include>org.json:json</include>
                                 </includes>
                             </artifactSet>
@@ -105,9 +106,9 @@
         </dependency>
 
         <dependency>
-            <groupId>org.json</groupId>
-            <artifactId>json</artifactId>
-            <version>20240303</version>
+            <groupId>com.adacore</groupId>
+            <artifactId>options</artifactId>
+            <version>0.1.0</version>
         </dependency>
 
         <dependency>
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/GNATCheckWorker.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/GNATCheckWorker.java
@@ -3,10 +3,8 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit.drivers;
+package com.adacore.lkql_jit;
 
-import com.adacore.lkql_jit.options.JsonUtils;
-import com.adacore.lkql_jit.options.RuleInstance;
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLChecker.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLChecker.java
@@ -3,10 +3,8 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit.drivers;
+package com.adacore.lkql_jit;
 
-import com.adacore.lkql_jit.options.JsonUtils;
-import com.adacore.lkql_jit.options.RuleInstance;
 import java.io.File;
 import java.util.*;
 import java.util.concurrent.Callable;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLDoc.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLDoc.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit.drivers;
+package com.adacore.lkql_jit;
 
 import java.io.BufferedWriter;
 import java.io.IOException;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLLauncher.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLLauncher.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit.drivers;
+package com.adacore.lkql_jit;
 
 import java.io.File;
 import java.io.IOException;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLMain.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLMain.java
@@ -5,10 +5,6 @@
 
 package com.adacore.lkql_jit;
 
-import com.adacore.lkql_jit.drivers.GNATCheckWorker;
-import com.adacore.lkql_jit.drivers.LKQLChecker;
-import com.adacore.lkql_jit.drivers.LKQLDoc;
-import com.adacore.lkql_jit.drivers.LKQLLauncher;
 import java.util.concurrent.Callable;
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/options/package-info.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/options/package-info.java
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/package-info.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/package-info.java
@@ -2,4 +2,4 @@
  * This package contains all drivers for the LKQL JIT engine. Those are standard entry points for
  * user and tools like GNATcheck.
  */
-package com.adacore.lkql_jit.drivers;
+package com.adacore.lkql_jit;
diff --git a/lkql_jit/language/pom.xml b/lkql_jit/language/pom.xml
@@ -38,7 +38,7 @@
                                 <includes>
                                     <include>com.adacore:liblkqllang</include>
                                     <include>com.adacore:libadalang</include>
-                                    <include>com.adacore:cli</include>
+                                    <include>com.adacore:options</include>
                                     <include>org.json:json</include>
                                 </includes>
                             </artifactSet>
@@ -99,7 +99,7 @@
 
         <dependency>
             <groupId>com.adacore</groupId>
-            <artifactId>cli</artifactId>
+            <artifactId>options</artifactId>
             <version>0.1.0</version>
         </dependency>
 
diff --git a/lkql_jit/language/src/main/java/com/adacore/lkql_jit/LKQLContext.java b/lkql_jit/language/src/main/java/com/adacore/lkql_jit/LKQLContext.java
@@ -11,8 +11,6 @@
 import com.adacore.lkql_jit.checker.*;
 import com.adacore.lkql_jit.checker.utils.CheckerUtils;
 import com.adacore.lkql_jit.exception.LKQLRuntimeException;
-import com.adacore.lkql_jit.options.JsonUtils;
-import com.adacore.lkql_jit.options.RuleInstance;
 import com.adacore.lkql_jit.runtime.CallStack;
 import com.adacore.lkql_jit.runtime.GlobalScope;
 import com.adacore.lkql_jit.utils.Constants;
diff --git a/lkql_jit/language/src/main/java/com/adacore/lkql_jit/LKQLLanguage.java b/lkql_jit/language/src/main/java/com/adacore/lkql_jit/LKQLLanguage.java
@@ -192,7 +192,7 @@ public final class LKQLLanguage extends TruffleLanguage<LKQLContext> {
      * </pre>
      *
      * The default value if this option is an empty object. See the {@link
-     * com.adacore.lkql_jit.options.RuleInstance RuleInstance} class for more information about rule
+     * com.adacore.lkql_jit.RuleInstance RuleInstance} class for more information about rule
      * instance JSON encoding.
      */
     @Option(
diff --git a/lkql_jit/options/pom.xml b/lkql_jit/options/pom.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <artifactId>lkql_jit</artifactId>
+        <groupId>com.adacore</groupId>
+        <version>0.1.0</version>
+    </parent>
+
+    <artifactId>options</artifactId>
+
+    <build>
+        <plugins>
+            <!-- Skip the Spotless check because everything is handled by the parent -->
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.40.0</version>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20240303</version>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/JsonUtils.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/JsonUtils.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit.options;
+package com.adacore.lkql_jit; //
 
 import java.util.Map;
 import java.util.stream.Collectors;
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/RuleInstance.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/RuleInstance.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit.options;
+package com.adacore.lkql_jit;
 
 import java.util.Map;
 import java.util.Optional;
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/package-info.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/package-info.java
@@ -0,0 +1,2 @@
+/** This package contains all classes and tools to forward options to the LKQL engine. */
+package com.adacore.lkql_jit;
diff --git a/lkql_jit/pom.xml b/lkql_jit/pom.xml
@@ -10,6 +10,7 @@
     <version>0.1.0</version>
     <modules>
         <module>language</module>
+        <module>options</module>
         <module>cli</module>
         <module>native</module>
         <module>component</module>
@@ -122,6 +123,7 @@
                     <java>
                         <includes>
                             <include>language/src/main/java/**/*.java</include>
+                            <include>options/src/main/java/**/*.java</include>
                             <include>cli/src/main/java/**/*.java</include>
                             <include>benchmarks/src/test/java/**/*.java</include>
                         </includes>
