Move all options related classes to a 'options' package

HugoGGuerrier · HugoGGuerrier · commit a1335ca29880 · 2024-12-10T16:55:33.000+01:00
Do this for same reasons as for the 'cli' package.
Also inline EngineMode and AutoFixMode enum in the 'LKQLOptions' class.
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/BaseLKQLChecker.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/BaseLKQLChecker.java
@@ -5,8 +5,8 @@
 
 package com.adacore.lkql_jit.cli;
 
-import com.adacore.lkql_jit.LKQLOptions;
-import com.adacore.lkql_jit.RuleInstance;
+import com.adacore.lkql_jit.options.LKQLOptions;
+import com.adacore.lkql_jit.options.RuleInstance;
 import java.util.*;
 import java.util.concurrent.Callable;
 import org.graalvm.launcher.AbstractLanguageLauncher;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/GNATCheckWorker.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/GNATCheckWorker.java
@@ -5,9 +5,8 @@
 
 package com.adacore.lkql_jit.cli;
 
-import com.adacore.lkql_jit.EngineMode;
-import com.adacore.lkql_jit.LKQLOptions;
-import com.adacore.lkql_jit.RuleInstance;
+import com.adacore.lkql_jit.options.LKQLOptions;
+import com.adacore.lkql_jit.options.RuleInstance;
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
@@ -206,7 +205,7 @@ protected int executeScript(Context.Builder contextBuilder) {
 
         // Forward the command line options to the options object builder
         optionsBuilder
-                .engineMode(EngineMode.CHECKER)
+                .engineMode(LKQLOptions.EngineMode.CHECKER)
                 .verbose(this.args.verbose)
                 .projectFile(this.args.project)
                 .subprojectFile(this.args.subProject)
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLChecker.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLChecker.java
@@ -5,8 +5,7 @@
 
 package com.adacore.lkql_jit.cli;
 
-import com.adacore.lkql_jit.EngineMode;
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import picocli.CommandLine;
 
 /**
@@ -44,6 +43,9 @@ public LKQLChecker(LKQLChecker.Args args) {
 
     @Override
     protected LKQLOptions getOptions() {
-        return getBaseOptionsBuilder().engineMode(EngineMode.CHECKER).checkerDebug(true).build();
+        return getBaseOptionsBuilder()
+                .engineMode(LKQLOptions.EngineMode.CHECKER)
+                .checkerDebug(true)
+                .build();
     }
 }
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLDocAPI.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLDocAPI.java
@@ -5,7 +5,7 @@
 
 package com.adacore.lkql_jit.cli;
 
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import java.io.BufferedWriter;
 import java.io.IOException;
 import java.nio.file.FileSystems;
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLFix.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLFix.java
@@ -5,9 +5,7 @@
 
 package com.adacore.lkql_jit.cli;
 
-import com.adacore.lkql_jit.AutoFixMode;
-import com.adacore.lkql_jit.EngineMode;
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import java.util.Arrays;
 import java.util.Iterator;
 import picocli.CommandLine;
@@ -33,7 +31,7 @@ public static class Args extends BaseLKQLChecker.Args {
                         "Mode to apply auto fixes (default is DISPLAY)"
                                 + "%nPossible values: ${COMPLETION-CANDIDATES}",
                 completionCandidates = AutoFixModeCompletion.class)
-        public AutoFixMode autoFixMode = AutoFixMode.DISPLAY;
+        public LKQLOptions.AutoFixMode autoFixMode = LKQLOptions.AutoFixMode.DISPLAY;
 
         @Override
         public Integer call() {
@@ -46,7 +44,7 @@ public Integer call() {
     public static class AutoFixModeCompletion implements Iterable<String> {
         @Override
         public Iterator<String> iterator() {
-            return Arrays.stream(AutoFixMode.values()).map(Object::toString).iterator();
+            return Arrays.stream(LKQLOptions.AutoFixMode.values()).map(Object::toString).iterator();
         }
     }
 
@@ -61,7 +59,7 @@ public LKQLFix(LKQLFix.Args args) {
     @Override
     protected LKQLOptions getOptions() {
         return getBaseOptionsBuilder()
-                .engineMode(EngineMode.FIXER)
+                .engineMode(LKQLOptions.EngineMode.FIXER)
                 .checkerDebug(true)
                 .autoFixMode(((Args) args).autoFixMode)
                 .build();
diff --git a/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLLauncher.java b/lkql_jit/cli/src/main/java/com/adacore/lkql_jit/cli/LKQLLauncher.java
@@ -5,8 +5,7 @@
 
 package com.adacore.lkql_jit.cli;
 
-import com.adacore.lkql_jit.EngineMode;
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -164,7 +163,7 @@ protected int executeScript(Context.Builder contextBuilder) {
 
         // Forward the command line options to the options object builder
         optionsBuilder
-                .engineMode(EngineMode.INTERPRETER)
+                .engineMode(LKQLOptions.EngineMode.INTERPRETER)
                 .verbose(this.args.verbose)
                 .projectFile(this.args.project)
                 .target(this.args.target)
diff --git a/lkql_jit/language/pom.xml b/lkql_jit/language/pom.xml
@@ -114,6 +114,12 @@
             <artifactId>libadalang</artifactId>
             <version>${config.libadalangVersion}</version>
         </dependency>
+        <dependency>
+            <groupId>com.adacore</groupId>
+            <artifactId>options</artifactId>
+            <version>0.1.0</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
 </project>
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
@@ -13,6 +13,8 @@
 import com.adacore.lkql_jit.checker.UnitChecker;
 import com.adacore.lkql_jit.checker.utils.CheckerUtils;
 import com.adacore.lkql_jit.exception.LKQLRuntimeException;
+import com.adacore.lkql_jit.options.LKQLOptions;
+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;
@@ -250,7 +252,7 @@ public LKQLOptions getOptions() {
         return this.options;
     }
 
-    public EngineMode getEngineMode() {
+    public LKQLOptions.EngineMode getEngineMode() {
         return this.getOptions().engineMode();
     }
 
@@ -327,7 +329,7 @@ public boolean isCheckerDebug() {
     }
 
     @CompilerDirectives.TruffleBoundary
-    public AutoFixMode getAutoFixMode() {
+    public LKQLOptions.AutoFixMode getAutoFixMode() {
         return this.getOptions().autoFixMode();
     }
 
@@ -709,7 +711,7 @@ private void initCheckerCaches() {
                 }
 
                 // If the engine is in "fixer" mode, check that the rule has an auto-fixing function
-                if (getEngineMode() == EngineMode.FIXER && checker.autoFix == null) {
+                if (getEngineMode() == LKQLOptions.EngineMode.FIXER && checker.autoFix == null) {
                     throw LKQLRuntimeException.fromMessage(
                             "Rule \""
                                     + instance.ruleName()
diff --git a/lkql_jit/language/src/main/java/com/adacore/lkql_jit/checker/built_ins/NodeCheckerFunction.java b/lkql_jit/language/src/main/java/com/adacore/lkql_jit/checker/built_ins/NodeCheckerFunction.java
@@ -6,7 +6,6 @@
 package com.adacore.lkql_jit.checker.built_ins;
 
 import com.adacore.libadalang.Libadalang;
-import com.adacore.lkql_jit.EngineMode;
 import com.adacore.lkql_jit.LKQLContext;
 import com.adacore.lkql_jit.LKQLLanguage;
 import com.adacore.lkql_jit.LKQLTypeSystemGen;
@@ -17,6 +16,7 @@
 import com.adacore.lkql_jit.exception.LKQLRuntimeException;
 import com.adacore.lkql_jit.exception.LangkitException;
 import com.adacore.lkql_jit.nodes.expressions.Expr;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import com.adacore.lkql_jit.runtime.values.LKQLFunction;
 import com.adacore.lkql_jit.runtime.values.LKQLUnit;
 import com.adacore.lkql_jit.utils.LKQLTypesHelper;
@@ -171,7 +171,8 @@ public Object executeGeneric(VirtualFrame frame) {
             }
 
             // If the engine is in fixing mode and the current unit has some modification
-            if (context.getEngineMode() == EngineMode.FIXER && context.hasRewritingContext()) {
+            if (context.getEngineMode() == LKQLOptions.EngineMode.FIXER
+                    && context.hasRewritingContext()) {
                 // Apply the current rewriting context
                 final var applyRes = context.applyOrCloseRewritingContext();
                 if (!applyRes.success) {
@@ -331,9 +332,10 @@ private void applyNodeRule(
             }
 
             if (ruleResult) {
-                if (context.getEngineMode() == EngineMode.CHECKER) {
+                if (context.getEngineMode() == LKQLOptions.EngineMode.CHECKER) {
                     reportViolation(context, checker, node);
-                } else if (context.getEngineMode() == EngineMode.FIXER && checker.autoFix != null) {
+                } else if (context.getEngineMode() == LKQLOptions.EngineMode.FIXER
+                        && checker.autoFix != null) {
                     callAutoFix(
                             context, context.getRewritingContext(), interopLibrary, checker, node);
                 }
diff --git a/lkql_jit/language/src/main/java/com/adacore/lkql_jit/nodes/root_nodes/TopLevelRootNode.java b/lkql_jit/language/src/main/java/com/adacore/lkql_jit/nodes/root_nodes/TopLevelRootNode.java
@@ -5,9 +5,9 @@
 
 package com.adacore.lkql_jit.nodes.root_nodes;
 
-import com.adacore.lkql_jit.EngineMode;
 import com.adacore.lkql_jit.LKQLLanguage;
 import com.adacore.lkql_jit.nodes.TopLevelList;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import com.oracle.truffle.api.frame.VirtualFrame;
 
 /**
@@ -56,7 +56,9 @@ public TopLevelRootNode(
     public Object execute(VirtualFrame frame) {
         // If the checker mode is activated add all rule imports
         final var engineMode = LKQLLanguage.getContext(this.program).getEngineMode();
-        if (!fromImport && (engineMode == EngineMode.CHECKER || engineMode == EngineMode.FIXER)) {
+        if (!fromImport
+                && (engineMode == LKQLOptions.EngineMode.CHECKER
+                        || engineMode == LKQLOptions.EngineMode.FIXER)) {
             this.program.addRuleImports();
         }
 
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/AutoFixMode.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/AutoFixMode.java
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/EngineMode.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/EngineMode.java
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/JSONUtils.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/JSONUtils.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit; //
+package com.adacore.lkql_jit.options; //
 
 import java.util.Map;
 import java.util.stream.Collectors;
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/LKQLOptions.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/LKQLOptions.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit;
+package com.adacore.lkql_jit.options;
 
 import java.util.*;
 import java.util.stream.Collectors;
@@ -167,6 +167,32 @@ public enum DiagnosticOutputMode {
         GNATCHECK
     }
 
+    /** This enum represents the mode for the auto fixes application. */
+    public enum AutoFixMode {
+        /** Display the patched analysis unit to stdout. */
+        DISPLAY,
+
+        /** Create a new file alongside the original one, containing the patched analysis unit. */
+        NEW_FILE,
+
+        /** Replace the content of the original file with the patched analysis unit. */
+        PATCH_FILE
+    }
+
+    /** Represents the mode the LKQL engine runs on. */
+    public enum EngineMode {
+        /** LKQL engine is just going to run the provided LKQL script, without doing more. */
+        INTERPRETER,
+
+        /** LKQL engine will seek for defined rules and make them accessible. */
+        CHECKER,
+
+        /**
+         * LKQL engine will seek for rules and check that they all define an auto-fixing function.
+         */
+        FIXER
+    }
+
     /** Util class to build a new LKQL options object. */
     public static final class Builder {
 
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/RuleInstance.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/RuleInstance.java
@@ -3,7 +3,7 @@
 //  SPDX-License-Identifier: GPL-3.0-or-later
 //
 
-package com.adacore.lkql_jit;
+package com.adacore.lkql_jit.options;
 
 import java.util.Map;
 import java.util.Optional;
diff --git a/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/package-info.java b/lkql_jit/options/src/main/java/com/adacore/lkql_jit/options/package-info.java
@@ -1,2 +1,2 @@
 /** This package contains all classes and tools to forward options to the LKQL engine. */
-package com.adacore.lkql_jit;
+package com.adacore.lkql_jit.options;
diff --git a/testsuite/tests/interop/function/Main.java b/testsuite/tests/interop/function/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/iterator/Main.java b/testsuite/tests/interop/iterator/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/list/Main.java b/testsuite/tests/interop/list/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/list_comp/Main.java b/testsuite/tests/interop/list_comp/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/namespace/Main.java b/testsuite/tests/interop/namespace/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/null/Main.java b/testsuite/tests/interop/null/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/object/Main.java b/testsuite/tests/interop/object/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/pattern/Main.java b/testsuite/tests/interop/pattern/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/property/Main.java b/testsuite/tests/interop/property/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/selector/Main.java b/testsuite/tests/interop/selector/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/tuple/Main.java b/testsuite/tests/interop/tuple/Main.java
@@ -1,4 +1,4 @@
-import com.adacore.lkql_jit.LKQLOptions;
+import com.adacore.lkql_jit.options.LKQLOptions;
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Value;
 
diff --git a/testsuite/tests/interop/unit/Main.java b/testsuite/tests/interop/unit/Main.java

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`	`import com.adacore.lkql_jit.checker.UnitChecker;`
`14`	`14`	`import com.adacore.lkql_jit.checker.utils.CheckerUtils;`
`15`	`15`	`import com.adacore.lkql_jit.exception.LKQLRuntimeException;`
	`16`	`+import com.adacore.lkql_jit.options.LKQLOptions;`
	`17`	`+import com.adacore.lkql_jit.options.RuleInstance;`
`16`	`18`	`import com.adacore.lkql_jit.runtime.CallStack;`
`17`	`19`	`import com.adacore.lkql_jit.runtime.GlobalScope;`
`18`	`20`	`import com.adacore.lkql_jit.utils.Constants;`
`@@ -250,7 +252,7 @@ public LKQLOptions getOptions() {`
`250`	`252`	`return this.options;`
`251`	`253`	`}`
`252`	`254`
`253`		`- public EngineMode getEngineMode() {`
	`255`	`+ public LKQLOptions.EngineMode getEngineMode() {`
`254`	`256`	`return this.getOptions().engineMode();`
`255`	`257`	`}`
`256`	`258`
`@@ -327,7 +329,7 @@ public boolean isCheckerDebug() {`
`327`	`329`	`}`
`328`	`330`
`329`	`331`	`@CompilerDirectives.TruffleBoundary`
`330`		`- public AutoFixMode getAutoFixMode() {`
	`332`	`+ public LKQLOptions.AutoFixMode getAutoFixMode() {`
`331`	`333`	`return this.getOptions().autoFixMode();`
`332`	`334`	`}`
`333`	`335`
`@@ -709,7 +711,7 @@ private void initCheckerCaches() {`
`709`	`711`	`}`
`710`	`712`
`711`	`713`	`// If the engine is in "fixer" mode, check that the rule has an auto-fixing function`
`712`		`- if (getEngineMode() == EngineMode.FIXER && checker.autoFix == null) {`
	`714`	`+ if (getEngineMode() == LKQLOptions.EngineMode.FIXER && checker.autoFix == null) {`
`713`	`715`	`throw LKQLRuntimeException.fromMessage(`
`714`	`716`	`"Rule \""`
`715`	`717`	`+ instance.ruleName()`