Add 'Lkql_Path' GPR attribute handling

Author: HugoGGuerrier

lkql_checker/doc/gnatcheck_rm/using_gnatcheck.rst

@@ -368,6 +368,16 @@ GNATcheck:
   file defining this attribute, then, an error is emitted and ``gnatcheck``
   will exit with an error code.
 
+``Lkql_Path``
+  Value is a list of directories to add to the ``LKQL_PATH`` environment
+  variable when GNATcheck is spawning the LKQL engine. This variable is
+  used to resolve module importations in LKQL sources. If not absolute, paths
+  provided through this attribute are relatives to the project file defining
+  it.
+
+  This attributes may work combined with the ``--lkql-path`` switch, in that
+  case, all directories are added to the ``LKQL_PATH`` environment variable.
+
 ``Switches``
   Index is a language name. Value is a list of additional switches to be used
   when invoking ``gnatcheck``.
@@ -388,6 +398,7 @@ GNATcheck:
     * ``-eL``
     * ``-r, --rule [rule_name]`` (use ``Rules`` attribute instead)
     * ``--rule-file=filename`` (use ``Rule_File`` attribute instead)
+    * ``--lkql-path=dir`` (use ``Lkql_Path`` attributes instead)
     * ``--target`` (use the ``Target`` GPR attribute instead)
     * ``--RTS`` (use the ``Runtime`` GPR attribute instead)
 

lkql_checker/src/gnatcheck-projects.adb

@@ -70,6 +70,8 @@ package body Gnatcheck.Projects is
      (GPR2."+" ("Check"), GPR2."+" ("Rules"));
    Rule_File_Attr        : constant GPR2.Q_Attribute_Id :=
      (GPR2."+" ("Check"), GPR2."+" ("Rule_File"));
+   Lkql_Path_Attr        : constant GPR2.Q_Attribute_Id :=
+     (GPR2."+" ("Check"), GPR2."+" ("Lkql_Path"));
    Default_Switches_Attr : constant GPR2.Q_Attribute_Id :=
      (GPR2."+" ("Check"), GPR2."+" ("Default_Switches"));
    Switches_Attr         : constant GPR2.Q_Attribute_Id :=
@@ -274,6 +276,17 @@ package body Gnatcheck.Projects is
          end;
       end if;
 
+      --  Process the LKQL path
+      if Proj.Has_Attribute (Lkql_Path_Attr) then
+         List_Val := Load_List_Attribute (Lkql_Path_Attr);
+         for Path of List_Val.all loop
+            Additional_Lkql_Paths.Append
+              (if Is_Absolute_Path (Path.all)
+               then Path.all
+               else Gnatcheck_Prj.Get_Project_Relative_File (Path.all));
+         end loop;
+      end if;
+
       --  Process additional GNATcheck switches
       if Proj.Has_Attribute (Switches_Attr, Ada_Idx) then
          List_Val := Load_List_Attribute (Switches_Attr, Indexed => True);
@@ -753,6 +766,17 @@ package body Gnatcheck.Projects is
         (Rule_File_Attr,
          "Value is the name of an LKQL rule file to use when running "
          & "GNATcheck in this project.");
+      Add
+        (Lkql_Path_Attr,
+         Index_Type           => GPR2.Project.Registry.Attribute.No_Index,
+         Value                => List,
+         Value_Case_Sensitive => True,
+         Is_Allowed_In        => Everywhere);
+      GPR2.Project.Registry.Attribute.Description.Set_Attribute_Description
+        (Lkql_Path_Attr,
+         "Value is a list of directories to add to the LKQL_PATH environment "
+         & "variable when GNATcheck is spawning the LKQL engine. This "
+         & "variable is used to resolve module importations in LKQL sources.");
       Add
         (Switches_Attr,
          Index_Type           => Language_Index,

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/prj.gpr

@@ -0,0 +1,6 @@
+project Prj is
+   package Check is
+      for Rule_File use "without_overlapping.lkql";
+      for Lkql_Path use ("rule_configs");
+   end Check;
+end Prj;

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

@@ -19,6 +19,13 @@ main.adb:3:04: rule violation: redundant null statement [redundant_null_statemen
 main.adb:4:04: rule violation: goto statement [goto_statements]
 main.adb:9:07: rule violation: goto statement [goto_statements]
 
+Providing search paths through the GPR file
+===========================================
+
+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

@@ -20,6 +20,8 @@ tests:
     extra_args:
       - --lkql-path
       - rule_configs
+  - label: Providing search paths through the GPR file
+    project: prj
 
   # Error testing
   - label: Rule file with an invalid importation

testsuite/tests/gnatcheck/print_gpr_registry/test.out

@@ -1 +1 @@
-{"packages":[{"attributes":[{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"LANGUAGE_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Index is a language name. Value is a list of switches to be used when invoking 'gnatcheck' for a source of the language, if there is no applicable attribute Switches.","attribute_name":"Default_Switches"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"LANGUAGE_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Index is a language name. Value is a list of switches to be used when invoking 'gnatcheck' for a source of the language.","attribute_name":"Switches"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":false,"value_is_set":false},"attribute_descr":"Value is a list of GNATcheck rule names to enable when running GNATcheck on this project.","attribute_name":"Rules"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"SINGLE","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Value is the name of an LKQL rule file to use when running GNATcheck in this project.","attribute_name":"Rule_File"}],"package_descr":"This package specifies the options used when calling the checking tool 'gnatcheck'. Its attribute Default_Switches has the same semantics as for the package Builder. The first string should always be -rules to specify that all the other options belong to the -rules section of the parameters to 'gnatcheck'.","package_name":"Check","projects_kind":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true}},{"attributes":[{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"If you want to override ada default file extensions (ada, ads, adb, spc & bdy), use this attribute which includes a list of file patterns where you can specify the following meta characters: * : matches any string of 0 or more characters, ? : matches any character,  [list of chars] : matches any character listed, [char-char] : matches any character in given range, [^list of chars] : matches any character not listed. These patterns are case insensitive.","attribute_name":"File_Patterns"}],"package_descr":"This package specifies the options used when calling the tool 'codepeer'.","package_name":"Codepeer","projects_kind":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true}}]}
+{"packages":[{"attributes":[{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"LANGUAGE_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Index is a language name. Value is a list of switches to be used when invoking 'gnatcheck' for a source of the language, if there is no applicable attribute Switches.","attribute_name":"Default_Switches"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"LANGUAGE_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Index is a language name. Value is a list of switches to be used when invoking 'gnatcheck' for a source of the language.","attribute_name":"Switches"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":false,"value_is_set":false},"attribute_descr":"Value is a list of GNATcheck rule names to enable when running GNATcheck on this project.","attribute_name":"Rules"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"SINGLE","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Value is the name of an LKQL rule file to use when running GNATcheck in this project.","attribute_name":"Rule_File"},{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"Value is a list of directories to add to the LKQL_PATH environment variable when GNATcheck is spawning the LKQL engine. This variable is used to resolve module importations in LKQL sources.","attribute_name":"Lkql_Path"}],"package_descr":"This package specifies the options used when calling the checking tool 'gnatcheck'. Its attribute Default_Switches has the same semantics as for the package Builder. The first string should always be -rules to specify that all the other options belong to the -rules section of the parameters to 'gnatcheck'.","package_name":"Check","projects_kind":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true}},{"attributes":[{"attribute_def":{"builtin":false,"config_concatenable":false,"empty_value":"ALLOW","has_default_in":{"abstract":false,"aggregate":false,"aggregate_library":false,"configuration":false,"library":false,"standard":false},"index_optional":false,"index_type":"NO_INDEX","inherit_from_extended":"NOT_INHERITED","is_allowed_in":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true},"is_toolchain_config":false,"value":"LIST","value_case_sensitive":true,"value_is_set":false},"attribute_descr":"If you want to override ada default file extensions (ada, ads, adb, spc & bdy), use this attribute which includes a list of file patterns where you can specify the following meta characters: * : matches any string of 0 or more characters, ? : matches any character,  [list of chars] : matches any character listed, [char-char] : matches any character in given range, [^list of chars] : matches any character not listed. These patterns are case insensitive.","attribute_name":"File_Patterns"}],"package_descr":"This package specifies the options used when calling the tool 'codepeer'.","package_name":"Codepeer","projects_kind":{"abstract":true,"aggregate":true,"aggregate_library":true,"configuration":true,"library":true,"standard":true}}]}