Add '--lkql-path' CLI option to GNATcheck

Author: HugoGGuerrier

lkql_checker/doc/gnatcheck_rm/using_gnatcheck.rst

@@ -239,6 +239,13 @@ The following switches control the general ``gnatcheck`` behavior
   Specify the charset of the source files. By default, ``ISO-8859-1`` is
   used if no charset is specified.
 
+  .. index:: --lkql-path
+
+``--lkql-path=dir``
+  Specify directory to add to the ``LKQL_PATH`` environment variable when
+  GNATcheck is spawning the LKQL engine. You can specify this option multiple
+  times to add multiple directories.
+
   .. index:: --rules-dir
 
 ``--rules-dir=dir``

lkql_checker/src/gnatcheck-options.ads

@@ -14,6 +14,7 @@ with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
 with GNAT.OS_Lib;
 
 with Gnatcheck.Projects;
+with Gnatcheck.String_Utilities; use Gnatcheck.String_Utilities;
 
 with GNATCOLL.Opt_Parse; use GNATCOLL.Opt_Parse;
 
@@ -179,6 +180,10 @@ package Gnatcheck.Options is
    --  This variable should contain a full list of compilation options to be
    --  passed to gcc.
 
+   Additional_Lkql_Paths : String_Vector;
+   --  Additional paths to add to the ``LKQL_PATH`` environment variable when
+   --  spawning the LKQL worker.
+
    Instance_Help_Emitted : Boolean := False;
    --  Whether the help message about the new instance system has already been
    --  emitted. This message should be removed in 26.0.
@@ -272,6 +277,16 @@ package Gnatcheck.Options is
              "specify the charset of the source files (default is "
              & "latin-1)");
 
+      package Lkql_Path is new
+        Parse_Option_List
+          (Parser     => Parser,
+           Long       => "--lkql-path",
+           Arg_Type   => Unbounded_String,
+           Accumulate => True,
+           Help       =>
+             "specify directories to add to the 'LKQL_PATH' environment "
+             & "variable when spawning the LKQL worker");
+
       package Rules_Dirs is new
         Parse_Option_List
           (Parser     => Parser,

lkql_checker/src/gnatcheck-projects.adb

@@ -1266,6 +1266,7 @@ package body Gnatcheck.Projects is
             Disallow (Arg.Transitive_Closure.This, "-U" & In_Project_Msg);
             Disallow (Arg.Scenario_Vars.This, "-Xname=val" & In_Project_Msg);
             Disallow (Arg.Follow_Symbolic_Links.This, "-eL" & In_Project_Msg);
+            Disallow (Arg.Lkql_Path.This, "--lkql-path" & In_Project_Msg);
             Disallow (Arg.Rules.This, "-r" & In_Project_Msg);
             Disallow (Arg.Rule_File.This, "--rule-file" & In_Project_Msg);
             Disallow (Arg.Target.This, "--target" & In_Project_Msg);
@@ -1291,6 +1292,7 @@ package body Gnatcheck.Projects is
          Allow (Arg.Aggregate_Subproject.This);
          Allow (Arg.Project_File.This);
          Allow (Arg.Follow_Symbolic_Links.This);
+         Allow (Arg.Lkql_Path.This);
          Allow (Arg.Rules.This);
          Allow (Arg.Rule_File.This);
          Allow (Arg.Target.This);

lkql_checker/src/gnatcheck_main.adb

@@ -129,6 +129,10 @@ procedure Gnatcheck_Main is
 
          Add_Path ("LD_LIBRARY_PATH", Lib);
          Add_Path ("LD_LIBRARY_PATH", Lib_LAL);
+
+         for Path of Additional_Lkql_Paths loop
+            Add_Path ("LKQL_PATH", Path);
+         end loop;
       end;
 
       Free (Executable);
@@ -484,6 +488,13 @@ begin
       Add_Rule_By_Name (To_String (Rule), Prepend => True);
    end loop;
 
+   --  Add the command-line LKQL_PATH elements to the vector of additional
+   --  searching paths.
+   for Working_Dir_Path of Arg.Lkql_Path.Get loop
+      Additional_Lkql_Paths.Append
+        (Normalize_Pathname (To_String (Working_Dir_Path)));
+   end loop;
+
    --  Then analyze the command-line parameters
 
    Gnatcheck_Prj.Scan_Arguments;

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/test.out

@@ -12,6 +12,13 @@ main.adb:4:04: rule violation: goto statement [goto_statements]
 main.adb:4:04: rule violation: goto statement [unconditional_goto|goto_statements]
 main.adb:9:07: rule violation: goto statement [goto_statements]
 
+Providing search paths through the '--lkql-path' CLI option
+===========================================================
+
+main.adb:3:04: rule violation: redundant null statement [redundant_null_statements]
+main.adb:4:04: rule violation: goto statement [goto_statements]
+main.adb:9:07: rule violation: goto statement [goto_statements]
+
 Rule file with an invalid importation
 =====================================
 

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/test.yaml

@@ -15,6 +15,11 @@ tests:
     lkql_rule_file: with_overlapping.lkql
     lkql_path:
       - rule_configs
+  - label: Providing search paths through the '--lkql-path' CLI option
+    lkql_rule_file: without_overlapping.lkql
+    extra_args:
+      - --lkql-path
+      - rule_configs
 
   # Error testing
   - label: Rule file with an invalid importation