Merge branch 'topic/rule_violation_tags' into 'master'

Add a "rule violation" tag to all rule violation messages

See merge request eng/libadalang/langkit-query-language!388

Author: HugoGGuerrier

lkql_checker/src/gnatcheck-diagnoses.adb

@@ -174,7 +174,7 @@ package body Gnatcheck.Diagnoses is
    --  boolean parameter is used to define the needed indentation level
 
    function Strip_Tag (Diag : String) return String;
-   --  Strip trailing " [-gnatxxx]", if any
+   --  Strip trailing GNAT tag following the format " [-gnat<x>]", if any
 
    ----------------------------------------------------------------------
    --  Data structures and local routines for rule exemption mechanism --
@@ -1682,11 +1682,11 @@ package body Gnatcheck.Diagnoses is
 
       function Preprocess_Diag (Diag : String) return String;
       --  Add GPS_Prefix if Progress_Indicator_Mode is True, and remove any
-      --  training [-gnatwxxx].
+      --  trailing GNAT tag following the "[-gnat<x>]" format.
 
       procedure Counted_Print_Diagnosis
         (Position : Error_Messages_Storage.Cursor);
-      --  Print Diagnosis until reaching Max_Diagnoses
+      --  Print diagnosis until reaching Max_Diagnoses
 
       ---------------------
       -- Preprocess_Diag --
@@ -3029,8 +3029,19 @@ package body Gnatcheck.Diagnoses is
            (Ada.Strings.Fixed.Trim (Line_Number'Image (Sloc.Line), Left)
             & ':' & Column_Str);
       end Image;
+
+      Tag_String : constant String :=
+        (case Self.Diagnosis_Kind is
+         when Rule_Violation =>
+           (if Self.Justification /= Null_Unbounded_String
+            then "rule violation (exempted): "
+            else "rule violation: "),
+         when Exemption_Warning => "warning: ",
+         when others => "");
    begin
-      return To_String (Self.File) & ":" & Image (Self.Sloc) & ": "
+      return To_String (Self.File) & ":"
+        & Image (Self.Sloc) & ": "
+        & Tag_String
         & To_String (Self.Text);
    end Image;
 

lkql_checker/src/gnatcheck-output.ads

@@ -42,13 +42,13 @@ package Gnatcheck.Output is
    --  Reports that a required file could not be found
 
    procedure Error (Message : String);
-   --  Sends into Stderr the error message in the form 'Tool_Name: Message'
+   --  Sends ``Message`` into stderr, prefixed by "tool_name: error: ".
 
    procedure Warning (Message : String);
-   --  Same as ``Error``
+   --  Sends ``Message`` into stderr, prefixed by "tool_name: warning: ".
 
    procedure Info (Message : String);
-   --  Sends Message into Stderr (with no tool name prefix).
+   --  Sends ``Message`` into stderr, prefixed by "tool_name: info: ".
 
    procedure Info_In_Tty (Message : String);
    --  Same as ``Info`` but send the message only if Stderr is a TTY. Also,

testsuite/tests/gnatcheck/absolute_output_files/test.out

@@ -1,5 +1,5 @@
    no exempted violations detected
-main.adb:3:05: goto statement
+main.adb:3:05: rule violation: goto statement
    no rule exemption problems detected
    no language violations detected
    no internal error detected

testsuite/tests/gnatcheck/aggregate_project_external_vars/test.out

@@ -1,2 +1,2 @@
-test.ads:2:12: declaration of local package
-test.ads:2:12: declaration of local package
+test.ads:2:12: rule violation: declaration of local package
+test.ads:2:12: rule violation: declaration of local package

testsuite/tests/gnatcheck/all_rules/test.out

@@ -1,8 +1,8 @@
-main.adb:1:19: use clause for package
-main.adb:1:23: use clause
-main.adb:1:37: end of line comment
-main.adb:3:01: possible occurrence of KP U727-033 if float operation performed before first context switch on leon targets
-main.adb:3:11: declaration of library level subprogram
-main.adb:3:37: end of line comment
-main.adb:6:05: goto statement
-main.adb:6:37: end of line comment
+main.adb:1:19: rule violation: use clause for package
+main.adb:1:23: rule violation: use clause
+main.adb:1:37: rule violation: end of line comment
+main.adb:3:01: rule violation: possible occurrence of KP U727-033 if float operation performed before first context switch on leon targets
+main.adb:3:11: rule violation: declaration of library level subprogram
+main.adb:3:37: rule violation: end of line comment
+main.adb:6:05: rule violation: goto statement
+main.adb:6:37: rule violation: end of line comment

testsuite/tests/gnatcheck/check_package/rule_file_attr/test.out

@@ -1,13 +1,13 @@
 Without additional rule file
 ============================
 
-main.adb:3:04: goto statement
+main.adb:3:04: rule violation: goto statement
 
 With additional rule file
 =========================
 
 gnatcheck: error: only one LKQL configuration file is allowed
-main.adb:3:04: goto statement
+main.adb:3:04: rule violation: goto statement
 >>>program returned status code 6
 
 With invalid attribute value

testsuite/tests/gnatcheck/check_package/rules_attr/test.out

@@ -1,13 +1,13 @@
 Without additional rules
 ========================
 
-main.adb:4:04: goto statement
+main.adb:4:04: rule violation: goto statement
 
 With additional rules
 =====================
 
-main.adb:3:04: redundant null statement
-main.adb:4:04: goto statement
+main.adb:3:04: rule violation: redundant null statement
+main.adb:4:04: rule violation: goto statement
 
 With invalid attribute value
 ============================

testsuite/tests/gnatcheck/check_package/switches_attr/test.out

@@ -1,7 +1,7 @@
 Without additional switches
 ===========================
 
-main.adb:3:04: goto statement [goto_statements]
+main.adb:3:04: rule violation: goto statement [goto_statements]
 
 With a disallowed switch
 ========================

testsuite/tests/gnatcheck/command_line_rules/test.out

@@ -1,2 +1,2 @@
-main.adb:3:04: goto statement
-main.adb:4:04: redundant null statement
+main.adb:3:04: rule violation: goto statement
+main.adb:4:04: rule violation: redundant null statement

testsuite/tests/gnatcheck/config_pragmas/test.out

@@ -1,7 +1,7 @@
-main.adb:1:01: [<PragmaNode gnat.adc:1:1-1:24>, <PragmaNode gnat.adc:2:1-2:75>, <PragmaNode gnat.adc:3:1-3:73>, <PragmaNode gnat.adc:4:1-4:25>, <PragmaNode gnat.adc:5:1-5:47>]
+main.adb:1:01: rule violation: [<PragmaNode gnat.adc:1:1-1:24>, <PragmaNode gnat.adc:2:1-2:75>, <PragmaNode gnat.adc:3:1-3:73>, <PragmaNode gnat.adc:4:1-4:25>, <PragmaNode gnat.adc:5:1-5:47>]
 
-main.adb:1:01: []
+main.adb:1:01: rule violation: []
 
-main.adb:1:01: [<PragmaNode gnat.adc:1:1-1:24>, <PragmaNode gnat.adc:2:1-2:75>, <PragmaNode gnat.adc:3:1-3:73>, <PragmaNode gnat.adc:4:1-4:25>, <PragmaNode gnat.adc:5:1-5:47>]
+main.adb:1:01: rule violation: [<PragmaNode gnat.adc:1:1-1:24>, <PragmaNode gnat.adc:2:1-2:75>, <PragmaNode gnat.adc:3:1-3:73>, <PragmaNode gnat.adc:4:1-4:25>, <PragmaNode gnat.adc:5:1-5:47>]
 
-main.adb:1:01: []
+main.adb:1:01: rule violation: []