libadalang_tools_24.0.0_d864b5a8/src/tgen/tgen_rts/tgen-types-discrete_types.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
------------------------------------------------------------------------------
--                                                                          --
--                                  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/>.                                          --
------------------------------------------------------------------------------
--
--  Common functions for manipulation and generation of discrete types

with Ada.Containers.Vectors;
with Ada.Containers.Ordered_Sets;

with TGen.Strategies; use TGen.Strategies;
with TGen.Types.Constraints; use TGen.Types.Constraints;

package TGen.Types.Discrete_Types is

   type Discrete_Typ is new Scalar_Typ with null record;

   type Int_Range is record
      Min, Max : Big_Integer;
   end record;

   function To_String (Rang : Int_Range) return String is
     ("[" & Big_Int.To_String (Rang.Min) & ", "
      & Big_Int.To_String (Rang.Max) & "]");

   function "<" (L, R : Int_Range) return Boolean is
     (if Big_Int."=" (L.Min, R.Min)
      then Big_Int."<" (L.Max, R.Max)
      else Big_Int."<" (L.Min, R.Min));

   function "=" (L, R : Int_Range) return Boolean is
     (Big_Int."=" (L.Min, R.Min) and then Big_Int."=" (L.Max, R.Max));

   --  Utilities for interval sets

   package Alternatives_Sets is new Ada.Containers.Ordered_Sets
     (Element_Type => Int_Range,
      "<"          => "<",
      "="          => "=");
   subtype Alternatives_Set is Alternatives_Sets.Set;

   package Alternatives_Set_Vectors is new Ada.Containers.Vectors
     (Index_Type   => Positive,
      Element_Type => Alternatives_Set,
      "="          => Alternatives_Sets."=");
   subtype Alternatives_Set_Vector is Alternatives_Set_Vectors.Vector;

   function Draw (Intervals : Alternatives_Set) return Big_Integer;
   --  Draw a value within one of the intervals defined in Intervals

   function Low_Bound (Self : Discrete_Typ) return Big_Integer with
     Pre => Self.Is_Static;
   --  Return the lowest bound of Self

   function High_Bound (Self : Discrete_Typ) return Big_Integer with
     Pre => Self.Is_Static;
   --  Return the highest bound of Self

   function Lit_Image (Self : Discrete_Typ; Lit : Big_Integer) return String;
   --  Returns the image of the Litteral whose "position" is Lit. For integer
   --  types, this is simply Lit'Image, for enum types, this corresponds to
   --  the image of the enum litteral at position Lit.

   overriding function Default_Strategy
     (Self : Discrete_Typ) return Strategy_Type'Class;
   --  Generate a strategy to statically generate (in one pass) values for Self

   function Generate_Static_Common
     (Self : Discrete_Typ'Class) return Strategy_Type'Class;
   --  Generate a strategy to statically generate (in one pass) values for Self

   type Sample_Strategy_Type is new Strategy_Type
     with record
      T       : SP.Ref;
      Samples : Alternatives_Set_Vector;
   end record;

   overriding function Generate
     (S            : in out Sample_Strategy_Type;
      Disc_Context : Disc_Value_Map) return JSON_Value;
   --  Given a static sampling strategy, generate one single value from it

   function Generate_Sampling_Strategy
     (Self    : Discrete_Typ;
      Samples : Alternatives_Set_Vector) return Strategy_Type'Class;
   --  Generate a static (single pass generation) sampling strategy for Self

   type Index_Kind is (Start_Index, End_Index);

   type Array_Index_Strategy_Type is new Strategy_Type with
      record
         T : SP.Ref;
         Average_Size, Min_Size, Max_Size : Natural;
         Index : Index_Kind;
         Other_Index_Constraint : Discrete_Constraint_Value;
         Fallback_Strategy : Strategy_Acc;
      end record;

   overriding function Generate
     (S            : in out Array_Index_Strategy_Type;
      Disc_Context : Disc_Value_Map) return JSON_Value;

   type Identity_Constraint_Strategy_Type is new Strategy_Type with
      record
         T          : SP.Ref;
         Constraint : Discrete_Constraint_Value;
      end record;
   --  A strategy that simply generates the value of a constraint (if it is a
   --  discriminant constraint, return the value of the discriminant, if it is
   --  a literal constraint, return the literal).

   overriding function Generate
     (S            : in out Identity_Constraint_Strategy_Type;
      Disc_Context : Disc_Value_Map) return JSON_Value;

   function Generate_Array_Index_Constraint_Strategy
     (Self       : Discrete_Typ'Class;
      Var_Name   : Unbounded_String;
      Constraint : TGen.Types.Constraints.Index_Constraint)
      return Strategy_Type'Class;
   --  When the type appear as an array index constraint, we need to have a
   --  special strategy, as it will control the size of the array. We don't
   --  want to be generating huge array.
   --
   --  Note that the other index constraint may not be bound at the strategy
   --  generation time, in which case we will fallback on a random strategy
   --  generation. The size will be coerced when generating a value for the
   --  other index constraint.
   --
   --  TODO: we may revisit this, suppose that we will always generate the
   --  Start_Index first (assuming both index constraints are discriminants),
   --  and that we should always generate a Self.Low_Bound for it. This will
   --  relax a bit the constraints when generating the higher bound (we may not
   --  be able to generate an array of the picked size, if the generated random
   --  value for the Start_Index is too high).

   function Generate_Identity_Constraint_Strategy
     (Self       : Discrete_Typ'Class;
      Constraint : Discrete_Constraint_Value)
      return Strategy_Type'Class;

   function As_Discrete_Typ (Self : SP.Ref) return Discrete_Typ'Class is
     (Discrete_Typ'Class (Self.Unchecked_Get.all));
   pragma Inline_Always (As_Discrete_Typ);

end TGen.Types.Discrete_Types;