lkql_checker: base executable name on Lkql_Checker_Mode

Author: thvnx

lkql_checker/src/lkql_checker-diagnoses.adb

@@ -1695,7 +1695,7 @@ package body Lkql_Checker.Diagnoses is
 
    procedure Print_Out_Diagnoses is
       Max_Diagnoses      : constant Natural :=
-        (if Options.Mode = Gnatkp_Mode then 0 else Arg.Max_Diagnoses.Get);
+        (if Mode = Gnatkp_Mode then 0 else Arg.Max_Diagnoses.Get);
       Diagnoses_Reported : Natural := 0;
       Limit_Exceeded     : Boolean := False;
 
@@ -1798,7 +1798,7 @@ package body Lkql_Checker.Diagnoses is
 
          Report (Trim (Minute_Of_Check'Img, Left));
 
-         Report (Executable & " version : " & Version_String);
+         Report (Lkql_Checker_Mode_Image & " version : " & Version_String);
 
          Report_No_EOL ("command line      : ");
          Print_Command_Line;
@@ -1923,7 +1923,7 @@ package body Lkql_Checker.Diagnoses is
       Pragma_Name : constant Text_Type := To_Lower (El.F_Id.Text);
       Pragma_Args : constant LAL.Analysis.Base_Assoc_List := El.F_Args;
       Tool_Name   : constant Text_Type :=
-        (if Options.Mode = Gnatkp_Mode then "gnatkp" else "gnatcheck");
+        (if Mode = Gnatkp_Mode then "gnatkp" else "gnatcheck");
    begin
       return
         Pragma_Name in "annotate" | "gnat_annotate"
@@ -2270,7 +2270,7 @@ package body Lkql_Checker.Diagnoses is
          return;
       end if;
 
-      if Options.Mode = Gnatkp_Mode then
+      if Mode = Gnatkp_Mode then
          Match (Match_Kp_Exempt_Comment, Text, Matches);
       else
          Match (Match_Rule_Exempt_Comment, Text, Matches);

lkql_checker/src/lkql_checker-options.adb

@@ -1,4 +1,6 @@
 with GNAT.Command_Line; use GNAT.Command_Line;
+with Ada.Command_Line;  use Ada.Command_Line;
+with Ada.Directories;   use Ada.Directories;
 
 with Lkql_Checker.Output;       use Lkql_Checker.Output;
 with Lkql_Checker.Projects;     use Lkql_Checker.Projects;

lkql_checker/src/lkql_checker-options.ads

@@ -6,8 +6,6 @@
 --  This package defines options that are supposed to be of a common interest
 --  for all the tools.
 
-with Ada.Command_Line;      use Ada.Command_Line;
-with Ada.Directories;       use Ada.Directories;
 with Ada.Environment_Variables;
 with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
 
@@ -33,9 +31,6 @@ package Lkql_Checker.Options is
    Version_String : constant String :=
      Lkql_Checker_Version & " (" & Date & ")";
 
-   Executable : constant String := Base_Name (Command_Name);
-   --  Name of the current executable (e.g. "gnatcheck" or "gnatkp")
-
    Custom_Worker_Var : constant String := "GNATCHECK_WORKER";
    --  The name of the environment variable used to define a custom worker
    --  executable.
@@ -69,9 +64,6 @@ package Lkql_Checker.Options is
    --  tool (includes both wrong parameters and wrong combinations of correct
    --  parameters).
 
-   Mode : Lkql_Checker_Mode := Gnatcheck_Mode;
-   --  Set the mode of the driver, either GNATcheck or GNATkp modes.
-
    Legacy : Boolean := False;
    --  If True, run in legacy mode, with no support for additional rule files.
 
@@ -704,10 +696,12 @@ package Lkql_Checker.Options is
       --  the specified ``Default_Name``.
 
       function Text_Report_File_Path return String
-      is (Resolve_Report_File (Text_Output.Get, Executable & ".out"));
+      is (Resolve_Report_File
+            (Text_Output.Get, Lkql_Checker_Mode_Image & ".out"));
 
       function XML_Report_File_Path return String
-      is (Resolve_Report_File (XML_Output.Get, Executable & ".xml"));
+      is (Resolve_Report_File
+            (XML_Output.Get, Lkql_Checker_Mode_Image & ".xml"));
    end Arg;
 
    --------------------------

lkql_checker/src/lkql_checker-output.adb

@@ -126,7 +126,7 @@ package body Lkql_Checker.Output is
       Log_Message : Boolean := False)
    is
       Final_Message : constant String :=
-        (if Tool_Name then Executable & ": " else "")
+        (if Tool_Name then Lkql_Checker_Mode_Image & ": " else "")
         & (if Location /= "" then Location & ": " else "")
         & (case Tag is
              when Info    => "info: ",
@@ -255,7 +255,7 @@ package body Lkql_Checker.Output is
 
    procedure Print_Version_Info is
    begin
-      Print (Executable & " " & Version_String);
+      Print (Lkql_Checker_Mode_Image & " " & Version_String);
       Print
         ("Copyright (C) " & "2004" & '-' & Current_Year & ", AdaCore.",
          Log_Message => False);
@@ -363,7 +363,8 @@ package body Lkql_Checker.Output is
    begin
       if Log_File_Name = null then
          Log_File_Name :=
-           new String'(Global_Report_Dir.all & Executable & ".log");
+           new String'
+             (Global_Report_Dir.all & Lkql_Checker_Mode_Image & ".log");
       end if;
 
       Open_Or_Create (Log_File_Name.all, Out_File, Log_File);
@@ -432,7 +433,7 @@ package body Lkql_Checker.Output is
    begin
       pragma Style_Checks ("M200"); -- Allow long lines
 
-      if Options.Mode = Gnatkp_Mode then
+      if Mode = Gnatkp_Mode then
          Put_Line ("gnatkp: the GNAT known problem detector");
          Put_Line
            ("usage: gnatkp -Pproject [options] [-rules [-from=file] {+Rkp_id[:param]}]");

lkql_checker/src/lkql_checker-projects-aggregate.adb

@@ -199,13 +199,13 @@ package body Lkql_Checker.Projects.Aggregate is
       Exit_Code : Integer;
 
       Full_Tool_Name : constant String_Access :=
-        Locate_Exec_On_Path (Executable);
+        Locate_Exec_On_Path (Lkql_Checker_Mode_Image);
 
    begin
       if Full_Tool_Name = null then
          Error
            ("cannot locate "
-            & Executable
+            & Lkql_Checker_Mode_Image
             & " on PATH, possible installation problem");
          raise Fatal_Error;
       end if;

lkql_checker/src/lkql_checker-projects.adb

@@ -1169,7 +1169,7 @@ package body Lkql_Checker.Projects is
       --  If GNATcheck is in KP mode and there is a command line specified KP
       --  version, we have to iterate over all implemented rules to enable
       --  those which match the version.
-      if Options.Mode = Gnatkp_Mode
+      if Mode = Gnatkp_Mode
         and then Arg.KP_Version.Get /= Null_Unbounded_String
       then
          for Rule_Cursor in All_Rules.Iterate loop
@@ -1211,7 +1211,7 @@ package body Lkql_Checker.Projects is
       Active_Rule_Present := not All_Rule_Instances.Is_Empty;
 
       if not (Active_Rule_Present or else Analyze_Compiler_Output) then
-         if Options.Mode = Gnatkp_Mode
+         if Mode = Gnatkp_Mode
            and then Arg.KP_Version.Get /= Null_Unbounded_String
          then
             Error ("no rule for the given kp-version");

lkql_checker/src/lkql_checker-rules-rule_table.adb

@@ -1556,7 +1556,7 @@ package body Lkql_Checker.Rules.Rule_Table is
       Set : Rule_Sets.Set;
 
    begin
-      if Options.Mode = Gnatkp_Mode then
+      if Mode = Gnatkp_Mode then
          Print ("gnatkp currently implements the following detectors:");
 
          if Arg.KP_Version.Get /= Null_Unbounded_String then
@@ -1592,7 +1592,9 @@ package body Lkql_Checker.Rules.Rule_Table is
             end loop;
          end if;
       else
-         Print (Executable & " currently implements the following rules:");
+         Print
+           (Lkql_Checker_Mode_Image
+            & " currently implements the following rules:");
 
          for Rule in All_Rules.Iterate loop
             Set.Include (All_Rules (Rule));
@@ -1607,7 +1609,7 @@ package body Lkql_Checker.Rules.Rule_Table is
          end if;
 
          Print
-           (Executable
+           (Lkql_Checker_Mode_Image
             & " allows activation of the following checks "
             & "provided by GNAT");
          Print

lkql_checker/src/lkql_checker.ads

@@ -7,4 +7,16 @@
 
 package Lkql_Checker is
    type Lkql_Checker_Mode is (Gnatcheck_Mode, Gnatkp_Mode);
+
+   Mode : Lkql_Checker_Mode;
+   --  The mode of the driver, either GNATcheck or GNATkp.
+
+   function Lkql_Checker_Mode_Image return String;
+   --  Get the Lkql_Checker_Mode image.
+   --
+   --  TODO: Use the Put_Image attribute for Lkql_Checker_Mode instead when
+   --  switching to Ada_2022.
+private
+   function Lkql_Checker_Mode_Name (Mode : Lkql_Checker_Mode) return String;
+   --  Return the name associated to the given Mode.
 end Lkql_Checker;

lkql_checker/src/main.adb

@@ -391,8 +391,8 @@ procedure Main (Mode : Lkql_Checker_Mode) is
 
    use Ada.Strings.Unbounded;
 begin
-   --  Set GNATcheck mode
-   Lkql_Checker.Options.Mode := Mode;
+   --  Set the Lkql_Checker global mode
+   Lkql_Checker.Mode := Mode;
 
    Initialize_Environment;
 
@@ -663,7 +663,9 @@ exception
    when Parameter_Error =>
       --  The diagnosis is already generated
       Print
-        ("try """ & Executable & " --help"" for more information.",
+        ("try """
+         & Lkql_Checker_Mode_Image
+         & " --help"" for more information.",
          Log_Message => False);
       OS_Exit (E_Error);