Migrate the '-cargs' section to Opt_Parse

Also refactor the way arguments are collected when spawning a new
GPRbuild process.

Author: HugoGGuerrier

lkql_checker/src/gnatcheck-compiler.adb

@@ -1924,13 +1924,23 @@ package body Gnatcheck.Compiler is
    --------------------
 
    function Spawn_GPRbuild (Output_File : String) return Process_Id is
+
       Pid         : Process_Id;
       GPRbuild    : String_Access := Locate_Exec_On_Path (GPRbuild_Exec);
       Prj         : constant String := Gnatcheck_Prj.Source_Prj;
       Last_Source : constant SF_Id := Last_Argument_Source;
       Args        : Argument_List (1 .. 128 + Integer (Last_Source));
       Num_Args    : Integer := 0;
 
+      procedure Add_Arg (Arg : String);
+      --  Add an argument to the local argument list ``Args``.
+
+      procedure Add_Arg (Arg : String) is
+      begin
+         Num_Args := @ + 1;
+         Args (Num_Args) := new String'(Arg);
+      end Add_Arg;
+
       use Ada.Strings.Unbounded;
    begin
       if GPRbuild = null then
@@ -1950,51 +1960,67 @@ package body Gnatcheck.Compiler is
       Num_Args := 8;
 
       if Target /= Null_Unbounded_String then
-         Num_Args := @ + 1;
-         Args (Num_Args) := new String'("--target=" & To_String (Target));
+         Add_Arg ("--target=" & To_String (Target));
       end if;
 
       if Arg.Jobs.Get > 1 then
-         Num_Args := @ + 1;
-         Args (Num_Args) := new String'("-j" & Image (Arg.Jobs.Get));
+         Add_Arg ("-j" & Image (Arg.Jobs.Get));
       end if;
 
       if Prj /= "" then
-         Num_Args := @ + 1;
-         Args (Num_Args) := new String'("-P" & Prj);
+         Add_Arg ("-P" & Prj);
       end if;
 
       if Arg.Follow_Symbolic_Links.Get then
-         Num_Args := @ + 1;
-         Args (Num_Args) := new String'("-eL");
+         Add_Arg ("-eL");
       end if;
 
       --  If files are specified explicitly, only compile these files
 
       if (Argument_File_Specified and then not Arg.Transitive_Closure.Get)
         or else Arg.Source_Files_Specified
       then
-         Num_Args := @ + 1;
-         Args (Num_Args) := new String'("-u");
+         Add_Arg ("-u");
 
          for SF in First_SF_Id .. Last_Source loop
-            Num_Args := @ + 1;
-            Args (Num_Args) := new String'(Short_Source_Name (SF));
+            Add_Arg (Short_Source_Name (SF));
          end loop;
       else
          if Arg.Transitive_Closure.Get then
-            Num_Args := @ + 1;
-            Args (Num_Args) := new String'("-U");
+            Add_Arg ("-U");
          end if;
 
          if not Main_Unit.Is_Empty then
             for MU of Main_Unit loop
-               Num_Args := @ + 1;
-               Args (Num_Args) := new String'(String (MU));
+               Add_Arg (String (MU));
             end loop;
          end if;
       end if;
 
+      --  Append options specified through the "-cargs" section
+      for Option of Arg.Cargs_Section.Get loop
+         Add_Arg (To_String (Option));
+      end loop;
+
+      if Analyze_Compiler_Output then
+         Add_Arg ("-gnatec=" & Gnatcheck_Config_File.all);
+         Add_Arg ("-gnatcU");
+         Add_Arg ("-gnatwnA.d");
+
+         if Use_gnatw_Option then
+            Add_Arg (Get_Warning_Option);
+         end if;
+
+         Add_Arg ("-gnatyN");
+
+         if Use_gnaty_Option then
+            for S of Split (Get_Style_Option, ' ') loop
+               Add_Arg (S);
+            end loop;
+         end if;
+      end if;
+
+      --  Add scenario variables to the compiler command
       Append_Variables (Args, Num_Args);
 
       if Arg.Debug_Mode.Get then
@@ -2004,17 +2030,13 @@ package body Gnatcheck.Compiler is
             Put (" " & Args (J).all);
          end loop;
 
-         for S of Compiler_Arg_List.all loop
-            Put (" " & S.all);
-         end loop;
-
          New_Line;
       end if;
 
       Pid :=
         Non_Blocking_Spawn
           (GPRbuild.all,
-           Args (1 .. Num_Args) & Compiler_Arg_List.all,
+           Args (1 .. Num_Args),
            Output_File & ".out",
            Output_File);
       Free (GPRbuild);

lkql_checker/src/gnatcheck-options.adb

@@ -4,8 +4,6 @@ with Gnatcheck.Output;       use Gnatcheck.Output;
 with Gnatcheck.Projects;     use Gnatcheck.Projects;
 with Gnatcheck.Source_Table; use Gnatcheck.Source_Table;
 
-with GNATCOLL.Strings; use GNATCOLL.Strings;
-
 with System.Multiprocessors;
 
 package body Gnatcheck.Options is
@@ -86,6 +84,15 @@ package body Gnatcheck.Options is
       end;
    end Max_Diagnoses_Convert;
 
+   --------------------
+   -- Is_New_Section --
+   --------------------
+
+   function Is_New_Section (Arg : XString) return Boolean is
+   begin
+      return Arg = "-rules" or else Arg = "-cargs";
+   end Is_New_Section;
+
    --------------------
    -- Scan_Arguments --
    --------------------
@@ -128,14 +135,6 @@ package body Gnatcheck.Options is
 
       procedure Process_Sections is
       begin
-         --  Processing the 'cargs' section
-
-         Goto_Section ("cargs", Parser => Parser);
-
-         while Getopt ("*", Parser => Parser) /= ASCII.NUL loop
-            Store_Compiler_Option (Full_Switch (Parser => Parser));
-         end loop;
-
          --  Processing the 'rules' section
          Goto_Section ("rules", Parser => Parser);
 

lkql_checker/src/gnatcheck-options.ads

@@ -17,6 +17,7 @@ with Gnatcheck.Projects;
 with Gnatcheck.String_Utilities; use Gnatcheck.String_Utilities;
 
 with GNATCOLL.Opt_Parse; use GNATCOLL.Opt_Parse;
+with GNATCOLL.Strings;   use GNATCOLL.Strings;
 
 with GPR2.Options;
 
@@ -203,6 +204,8 @@ package Gnatcheck.Options is
    function Project_Verbosity_Convert (Arg : String) return Natural;
    function Max_Diagnoses_Convert (Arg : String) return Max_Diagnoses_Count;
 
+   function Is_New_Section (Arg : XString) return Boolean;
+
    package Arg is
       Parser : Argument_Parser :=
         Create_Argument_Parser
@@ -625,6 +628,19 @@ package Gnatcheck.Options is
            Short  => "-W",
            Help   => "Treat warning messages as errors");
 
+      package Cargs_Section is new
+        Parse_Option_List
+          (Parser              => Parser,
+           Long                => "-cargs",
+           Name                => "Compiler options",
+           Accumulate          => True,
+           Arg_Number          => Multiple_Args,
+           Allow_Empty         => True,
+           Arg_Type            => Unbounded_String,
+           List_Stop_Predicate => Is_New_Section,
+           Help                => "options forwarded to the compiler",
+           Legacy_Long_Form    => True);
+
       ----------------------
       -- Option shortcuts --
       ----------------------

lkql_checker/src/gnatcheck-projects.adb

@@ -11,9 +11,7 @@ with Ada.Strings;             use Ada.Strings;
 with Ada.Strings.Fixed;       use Ada.Strings.Fixed;
 
 with GNAT.Directory_Operations;
-with GNAT.Regexp;       use GNAT.Regexp;
-with GNAT.String_Split; use GNAT.String_Split;
-with GNAT.Table;
+with GNAT.Regexp; use GNAT.Regexp;
 
 with Gnatcheck.Compiler;         use Gnatcheck.Compiler;
 with Gnatcheck.Diagnoses;
@@ -1108,24 +1106,6 @@ package body Gnatcheck.Projects is
         and then LKQL_Rule_File_Name = Null_Unbounded_String;
    end Is_Rule_Options_Empty;
 
-   ---------------------------
-   -- Store_Compiler_Option --
-   ---------------------------
-
-   package Compiler_Switches is new
-     GNAT.Table
-       (Table_Component_Type => String_Access,
-        Table_Index_Type     => Natural,
-        Table_Low_Bound      => 1,
-        Table_Initial        => 20,
-        Table_Increment      => 100,
-        Table_Name           => "Compiler options");
-
-   procedure Store_Compiler_Option (Switch : String) is
-   begin
-      Compiler_Switches.Append (new String'(Switch));
-   end Store_Compiler_Option;
-
    ----------------------
    -- Check_Parameters --
    ----------------------
@@ -1185,24 +1165,6 @@ package body Gnatcheck.Projects is
         or Check_Restrictions
         or Arg.Check_Semantic.Get;
 
-      if Analyze_Compiler_Output then
-         Store_Compiler_Option ("-gnatec=" & Gnatcheck_Config_File.all);
-         Store_Compiler_Option ("-gnatcU");
-         Store_Compiler_Option ("-gnatwnA.d");
-
-         if Use_gnatw_Option then
-            Store_Compiler_Option (Get_Warning_Option);
-         end if;
-
-         Store_Compiler_Option ("-gnatyN");
-
-         if Use_gnaty_Option then
-            for S of Create (Get_Style_Option, " ") loop
-               Store_Compiler_Option (S);
-            end loop;
-         end if;
-      end if;
-
       --  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.
@@ -1273,13 +1235,6 @@ package body Gnatcheck.Projects is
 
       Sources_Left := Total_Sources;
 
-      --  Save compiler switches computed in Compiler_Arg_List
-
-      Compiler_Arg_List :=
-        new Argument_List'
-          (String_List
-             (Compiler_Switches.Table (1 .. Compiler_Switches.Last)));
-
       <<Processing_Aggregate_Project>>
 
       Ada.Directories.Create_Path (Global_Report_Dir.all);

lkql_checker/src/gnatcheck-projects.ads

@@ -201,9 +201,6 @@ package Gnatcheck.Projects is
    --  Raises Gnatcheck.Common.Parameter_Error if any of these check fails,
    --  stores the name of the configuration project file otherwise.
 
-   procedure Store_Compiler_Option (Switch : String);
-   --  Stores a compiler option as is.
-
    function Is_Specified (My_Project : Arg_Project_Type) return Boolean;
    --  Checks if the argument represents a project that corresponds to some
    --  project file specified as a tool parameter.