libadalang_tools_24.0.0_d864b5a8/src/tgen/tgen-gen_strategies_utils.ads

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
------------------------------------------------------------------------------
--                                                                          --
--                                  TGen                                    --
--                                                                          --
--                       Copyright (C) 2022, AdaCore                        --
--                                                                          --
-- TGen  is  free software; you can redistribute it and/or modify it  under --
-- under  terms of  the  GNU General  Public License  as  published by  the --
-- Free  Software  Foundation;  either version 3, or  (at your option)  any --
-- later version. This software  is distributed in the hope that it will be --
-- useful but  WITHOUT  ANY  WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY  or  FITNESS  FOR A PARTICULAR PURPOSE.                  --
--                                                                          --
-- As a special  exception  under  Section 7  of  GPL  version 3,  you are  --
-- granted additional  permissions described in the  GCC  Runtime  Library  --
-- Exception, version 3.1, as published by the Free Software Foundation.    --
--                                                                          --
-- You should have received a copy of the GNU General Public License and a  --
-- copy of the GCC Runtime Library Exception along with this program;  see  --
-- the files COPYING3 and COPYING.RUNTIME respectively.  If not, see        --
-- <http://www.gnu.org/licenses/>.                                          --
------------------------------------------------------------------------------
--
--  This unit provides utilities needed to generate testing strategies

with Ada.Containers.Ordered_Maps;
with Ada.Strings.Wide_Wide_Unbounded;

with Libadalang.Analysis; use Libadalang.Analysis;
with Libadalang.Common;
with Langkit_Support.Text; use Langkit_Support.Text;

with TGen.Context; use TGen.Context;
with TGen.LAL_Utils; use TGen.LAL_Utils;
with TGen.Strings; use TGen.Strings;
with TGen.Subprograms; use TGen.Subprograms;
with TGen.Types; use TGen.Types;

with GNATCOLL.Projects; use GNATCOLL.Projects;

package TGen.Gen_Strategies_Utils is

   use Libadalang.Common;

   function Extract_Package_Data
     (Pkg_Decl : Package_Decl)
      return Package_Data;
   --  Extract unit information from Pkg_Decl

   function Extract_Subprogram_Data
     (Subp : Basic_Decl'Class)
      return Subprogram_Data
     with Pre => not Subp.Is_Null;
   --  Extracts a Subprogram_Data object from Subp

   function Extract_Parameters_Data
     (Subp : Basic_Decl'Class)
      return Parameters_Data_Vector
     with Pre => not Subp.Is_Null;
   --  Returns a vector of Parameters_Data objects extracted from each
   --  parameter of Subp.

   function Gen_Random_Function_Name
     (T : Typ'Class) return String is
      ("Gen_" & T.Type_Name);
   --  Return the name of the function generating random values for type T

   function Strat_Param_Name (Param : Parameter_Data) return String is
     ("Strat_" & (+Param.Name));
   --  Return the name of the strategy generating values for Param

   function Param_Strat_Package_Name (Package_Name : String) return String is
     (Package_Name & ".Param_Strategies");

   function Type_Strat_Package_Name (Package_Name : String) return String;

   function Strip (Package_Name : String) return String;
   --  Strip the last dotted name. ??? What happens if no dotted name

   function Gen_Param_Function_Name
     (Subp_Data : Subprogram_Data;
      Param : Parameter_Data) return String is
     ((+Subp_Data.Name) & "_" & (+Param.Name));

   function Gen_Param_Full_Function_Name
     (Subp_Data : Subprogram_Data;
      Param : Parameter_Data) return String is
     (Param_Strat_Package_Name (+Subp_Data.Parent_Package) & "."
      & (+Subp_Data.Name) & "_" & (+Param.Name));

   package Param_Vectors_Maps is new Ada.Containers.Ordered_Maps
     (Key_Type => Unbounded_Text_Type,
      Element_Type => Parameters_Data_Vector,
      "<" => Ada.Strings.Wide_Wide_Unbounded."<",
      "=" => Parameters_Data_Vectors."=");

   subtype Param_Vector_Map is Param_Vectors_Maps.Map;

   function Unit_To_Filename
     (Project   : Project_Type;
      Unit_Name : String;
      Part      : Unit_Parts) return String;
   --  Return the filename associates to unit Unit_Name

   function Is_Subprogram (Decl : Basic_Decl'Class) return Boolean is
     (not Decl.Is_Null
      and then (Decl.P_Is_Subprogram
                or else Decl.Kind in Ada_Generic_Subp_Decl_Range)
      and then not (Decl.Kind in Ada_Enum_Literal_Decl_Range));
   --  Checks if Decl is a subprogram excluding enum literals

   function Get_Subp_Params (Subp : Basic_Decl'Class) return Params
     with Inline,
          Pre => Is_Subprogram (Subp)
                 or else (not Subp.Is_Null
                          and then Subp.Kind in
                            Ada_Generic_Subp_Instantiation);
   --  Gets the Params node associated to Subp, if it exists.
   --  If it doesn't exist returns No_Params.

   function Get_Subp_Spec (Subp : Basic_Decl'Class) return Base_Subp_Spec
     with Inline,
          Pre => Is_Subprogram (Subp)
                 or else (not Subp.Is_Null
                          and then Subp.Kind in
                            Ada_Generic_Subp_Instantiation);
   --  Gets the Subp_Spec node associated to Subp

   function Get_Subp_Spec_Params
     (Subp_Spec : Base_Subp_Spec'Class)
      return Params;
   --  Gets the Params node associated to Subp_Spec, if it exists.
   --  If it doesn't exist returns No_Params.

   function Get_All_Types (Self : Typ'Class) return Typ_Set;
   --  Return the set of all types a type is composed of

end TGen.Gen_Strategies_Utils;