Add No_Dependency check

Author: raph-amiard

lkql_checker/doc/generated/list_of_rules.rst

@@ -107,6 +107,7 @@ GNATcheck rules.
 * :ref:`Nested_Paths`
 * :ref:`Nested_Subprograms`
 * :ref:`No_Closing_Names`
+* :ref:`No_Dependence`
 * :ref:`No_Explicit_Real_Range`
 * :ref:`No_Inherited_Classwide_Pre`
 * :ref:`No_Others_In_Exception_Handlers`

lkql_checker/doc/generated/predefined_rules.rst

@@ -6123,6 +6123,39 @@ A line containing one or more identifiers may end with a comment.
 
 
 
+.. _No_Dependence:
+
+``No_Dependence``
+^^^^^^^^^^^^^^^^^
+
+.. index:: No_Dependence
+
+Flag every explicit dependency (with clause) to any of the library units
+designated by names passed as parameters.
+
+This rule has the following optional parameter for the ``+R`` option and for
+LKQL rule options files:
+
+*Unit_Names: list[string]*
+   List of fully qualified names designating the library units that
+   should not be explicitly depended upon.
+
+The list of unit names is case insensitive. Any case can be used both in
+the parameter or in the code's with clauses.
+
+.. rubric:: Example
+
+.. code-block:: ada
+   :emphasize-lines: 2
+
+   --  if the rule is activated as +RNo_Dependence:Unchecked_Conversion
+   with Unchecked_Conversion; -- FLAG
+
+   package Foo is
+   end Foo;
+
+
+
 .. _Numeric_Format:
 
 ``Numeric_Format``

lkql_checker/share/lkql/no_dependence.lkql

@@ -0,0 +1,30 @@
+import stdlib
+
+@check(category="Style", subcategory="Readability", message="Forbidden dependency")
+fun no_dependence(node, unit_names=[]) =
+    |" Flag every explicit dependency (with clause) to any of the library units
+    |" designated by names passed as parameters.
+    |"
+    |" This rule has the following optional parameter for the ``+R`` option and for
+    |" LKQL rule options files:
+    |"
+    |" *Unit_Names: list[string]*
+    |"    List of fully qualified names designating the library units that
+    |"    should not be explicitly depended upon.
+    |"
+    |" The list of unit names is case insensitive. Any case can be used both in
+    |" the parameter or in the code's with clauses.
+    |"
+    |" .. rubric:: Example
+    |"
+    |" .. code-block:: ada
+    |"    :emphasize-lines: 2
+    |"
+    |"    --  if the rule is activated as +RNo_Dependence:Unchecked_Conversion
+    |"    with Unchecked_Conversion; -- FLAG
+    |"
+    |"    package Foo is
+    |"    end Foo;
+    node is n@Name(
+        any parent(depth=2): WithClause
+    ) when stdlib.any([name.to_lower_case == n.text.to_lower_case for name in unit_names])

testsuite/tests/checks/no_dependence/custom-unchecked_conversion.ads

@@ -0,0 +1,2 @@
+package Custom.Unchecked_Conversion is
+end Custom.Unchecked_Conversion;

testsuite/tests/checks/no_dependence/custom.ads

@@ -0,0 +1,2 @@
+package Custom is
+end Custom;

testsuite/tests/checks/no_dependence/test.adb

@@ -0,0 +1,8 @@
+with Ada.Unchecked_Conversion; -- FLAG
+with Unchecked_Conversion; -- FLAG
+with Custom.Unchecked_Conversion; -- NOFLAG
+
+procedure Test is
+begin
+   null;
+end Test;

testsuite/tests/checks/no_dependence/test.out

@@ -0,0 +1,8 @@
+test.adb:1:6: rule violation: Forbidden dependency
+1 | with Ada.Unchecked_Conversion; -- FLAG
+  |      ^^^^^^^^^^^^^^^^^^^^^^^^
+
+test.adb:2:6: rule violation: Forbidden dependency
+2 | with Unchecked_Conversion; -- FLAG
+  |      ^^^^^^^^^^^^^^^^^^^^
+

testsuite/tests/checks/no_dependence/test.yaml

@@ -0,0 +1,5 @@
+driver: 'checker'
+rule_name: no_dependence
+rule_arguments:
+    no_dependence.unit_names: '["ada.unchecked_conversion", "unchecked_conversion"]'
+input_sources: ['test.adb']

testsuite/tests/gnatcheck/xml_help/test.out

@@ -391,6 +391,7 @@ testsuite_driver: No output file generated by gnatcheck
          <spin switch="+Rmin_identifier_length" label="identifier too short" min="0" max="99999" default="-1" separator=":"/>
          <check switch="+Rmisnamed_controlling_parameters" label="first parameter should have name 'This' and proper type"/>
          <field switch="+Rname_clashes" separator=":" label="use of forbidden identifier"/>
+         <field switch="+Rno_dependence" separator=":" label="Forbidden dependency"/>
          <check switch="+Rnumeric_format" label="incorrect format for numeric literal"/>
          <check switch="+Robject_declarations_out_of_order" label="object declarations should precede program unit declarations"/>
          <check switch="+Rone_construct_per_line" label="more than one construct on the same line"/>
@@ -906,6 +907,7 @@ testsuite_driver: No output file generated by gnatcheck
          <spin switch="+Rmin_identifier_length" label="identifier too short" min="0" max="99999" default="-1" separator=":"/>
          <check switch="+Rmisnamed_controlling_parameters" label="first parameter should have name 'This' and proper type"/>
          <field switch="+Rname_clashes" separator=":" label="use of forbidden identifier"/>
+         <field switch="+Rno_dependence" separator=":" label="Forbidden dependency"/>
          <check switch="+Rnumeric_format" label="incorrect format for numeric literal"/>
          <check switch="+Robject_declarations_out_of_order" label="object declarations should precede program unit declarations"/>
          <check switch="+Rone_construct_per_line" label="more than one construct on the same line"/>