libadalang_tools_24.0.0_d864b5a8/src/tgen/tgen-gen_strategies.adb

  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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
------------------------------------------------------------------------------
--                                                                          --
--                                  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/>.                                          --
------------------------------------------------------------------------------

with Ada.Characters.Latin_9;
with Ada.Characters;
with Ada.Strings.Fixed;
with Ada.Strings.Maps;

with Langkit_Support.Text; use Langkit_Support.Text;

with GNATCOLL.VFS; use GNATCOLL.VFS;

with TGen.Files;                use TGen.Files;
with TGen.Gen_Strategies_Utils; use TGen.Gen_Strategies_Utils;
with TGen.LAL_Utils;            use TGen.LAL_Utils;
with TGen.Strategies;
with TGen.Types.Translation;    use TGen.Types.Translation;

package body TGen.Gen_Strategies is

   procedure Try_Load_Tests
     (Context  : in out Generation_Context;
      Filename : String);
   --  Check if there are already tests generated for the unit in the output
   --  dir; if there are, load them in the context, otherwise create an empty
   --  JSON object for the unit in the Context.Test_Vectors test-cases map.

   ----------------
   -- Initialize --
   ----------------

   procedure Initialize
     (Context    : in out Generation_Context;
      Output_Dir : Unbounded_String) is
   begin
      Context.Output_Dir := Output_Dir;
      Prepare_Output_Dirs (Context);
   end Initialize;

   --------------
   -- Finalize --
   --------------

   procedure Generate_Artifacts (Context : in out Generation_Context) is
   begin
      if not Context.Codegen_Required then
         --  Fully static test value generation is ON

         Dump_JSON (Context);
         return;
      end if;

      for Package_Data of Context.Packages_Data loop
         null;
      end loop;
   end Generate_Artifacts;

   ----------------------------------
   -- Distinct_Type_Parent_Package --
   ----------------------------------

   function Distinct_Type_Parent_Package
     (Parameters_Data : Parameters_Data_Vector)
         return String_Ordered_Set
   is
      S : String_Ordered_Set;

   begin
      for Data of Parameters_Data loop
         if not S.Contains
           (To_UTF8 (To_Text (Data.Type_Parent_Package)))
         then
            S.Insert (To_UTF8 (To_Text (Data.Type_Parent_Package)));
         end if;
      end loop;

      return S;
   end Distinct_Type_Parent_Package;

   function Distinct_Type_Parent_Package
     (Subprogram_Data : Subprograms_Data_Vector)
      return String_Ordered_Set
   is
      S : String_Ordered_Set;
   begin
      for Subprogram of Subprogram_Data loop
         S.Union (Distinct_Type_Parent_Package (Subprogram.Parameters_Data));
      end loop;
      return S;
   end Distinct_Type_Parent_Package;

   ------------
   -- Indent --
   ------------

   function Indent (Amount : Natural; Str : String) return String is
      Res    : Unbounded_String;
      Indent : constant String (1 .. Amount) := [others => ' '];
   begin
      Append (Res, Indent);
      for C of Str loop
         Append (Res, C);
         if C = Ada.Characters.Latin_9.LF then
            Append (Res, Indent);
         end if;
      end loop;
      return +Res;
   end Indent;

   ---------------------
   -- Number_Of_Lines --
   ---------------------

   function Number_Of_Lines (Str : String) return Natural is
   begin
      return Ada.Strings.Fixed.Count
        (Str,
         Ada.Strings.Maps.To_Set
           (Ada.Characters.Latin_9.LF)) + 1;
   end Number_Of_Lines;

   procedure Collect_Type_Translations (Subp : Basic_Decl'Class);

   -------------------------------
   -- Collect_Type_Translations --
   -------------------------------

   procedure Collect_Type_Translations (Subp : Basic_Decl'Class)
   is
      Subp_Translation_Res : constant Translation_Result :=
        Translate (Subp.P_Subp_Spec_Or_Null);
   begin
      if not Subp_Translation_Res.Success then
         raise Program_Error with To_String (Subp_Translation_Res.Diagnostics);
      end if;
   end Collect_Type_Translations;

   ---------------
   -- Dump_JSON --
   ---------------

   procedure Dump_JSON
     (Context : Generation_Context) is
      use Unit_To_JSON_Maps;
   begin
      for Unit_JSON_Cursor in Context.Test_Vectors.Iterate loop
         declare
            File : constant Virtual_File :=
              Get_Output_Dir (Context) / (+(+Key (Unit_JSON_Cursor)));
            JSON_Unit_Writable_File : Writable_File :=
              Write_File (File);
         begin
            Write
              (JSON_Unit_Writable_File,
               Element (Unit_JSON_Cursor).Write (Compact => False));
            Close (JSON_Unit_Writable_File);
         end;
      end loop;
   end Dump_JSON;

   ---------------------------
   -- Generate_Test_Vectors --
   ---------------------------

   procedure Generate_Test_Vectors
     (Context  : in out Generation_Context;
      Nb_Tests : Positive;
      Subp     : Basic_Decl'Class;
      Subp_UID : Unbounded_String := Null_Unbounded_String)
   is
      Subp_Data : Subprogram_Data :=
        Extract_Subprogram_Data (Subp);
      JSON_Filename      : constant String :=
        JSON_Test_Filename (Subp.As_Basic_Decl);
      Function_JSON      : JSON_Value := Create_Object;
      Test_Vectors_JSON  : JSON_Array := Empty_Array;
      Test_Vector_Values : JSON_Array;
      Test_Vector_JSON   : JSON_Value := Create_Object;

   begin
      Collect_Type_Translations (Subp);
      Subp_Data.All_Params_Static := True;
      for Param of Subp_Data.Parameters_Data loop
         declare
            Ignore_P_Qualified_Name : constant Ada_Qualified_Name :=
              To_Qualified_Name (+Param.Type_Fully_Qualified_Name);
            Param_Type : constant SP.Ref :=
              TGen.Types.Translation.Translation_Cache.Element
                (To_Qualified_Name (+Param.Type_Fully_Qualified_Name));
         begin
            Subp_Data.All_Params_Static :=
               Subp_Data.All_Params_Static
               and then Param_Type.Get.Supports_Static_Gen;
            Subp_Data.Some_Param_Static :=
               Subp_Data.Some_Param_Static
               or else Param_Type.Get.Supports_Static_Gen;
            if not Context.Type_And_Param_Strategies.Contains
                 (Param.Type_Fully_Qualified_Name)
            then
               Context.Type_And_Param_Strategies.Insert
                 (Param.Type_Fully_Qualified_Name,
                  Try_Generate_Static (Param_Type));
            end if;
         end;
      end loop;

      --  Do not generate any JSON if none of the types are supported.

      if not Subp_Data.Some_Param_Static then
         return;
      end if;

      --  Try to load pre-existing tests, if any, or create an empty unit JSON
      --  if there is not such file on disk.

      if not Context.Test_Vectors.Contains (+JSON_Filename) then
         Try_Load_Tests (Context, JSON_Filename);
      end if;

      declare
         use Unit_To_JSON_Maps;
         Unit_JSON : constant Unit_To_JSON_Maps.Reference_Type :=
           Context.Test_Vectors.Reference (+JSON_Filename);
      begin
         --  Identify if there are already JSON tests for this subp

         if Unit_JSON.Has_Field (+Subp_UID) then
            Function_JSON := Unit_JSON.Get (+Subp_UID);
            Test_Vectors_JSON := Function_JSON.Get ("test_vectors");
         else
            Function_JSON.Set_Field
              ("fully_qualified_name", +Subp_Data.Fully_Qualified_Name);
            Function_JSON.Set_Field
              ("package_name", +Subp_Data.Parent_Package);
            Function_JSON.Set_Field
              ("generation_complete", Create (Subp_Data.All_Params_Static));
            if not Is_Null (Subp.P_Subp_Spec_Or_Null.P_Returns) then
               Function_JSON.Set_Field
                 ("return_type",
                  Create (+Subp_Data.Return_Type_Fully_Qualified_Name));
            end if;
         end if;

         for J in 1 .. Nb_Tests loop
            Test_Vector_Values := Empty_Array;
            Test_Vector_JSON := Create_Object;
            for Param of Subp_Data.Parameters_Data loop
               declare
                  Param_JSON : constant JSON_Value := Create_Object;
                  Param_Type : constant SP.Ref :=
                    TGen.Types.Translation.Translation_Cache.Element
                      (To_Qualified_Name (+Param.Type_Fully_Qualified_Name));
               begin
                  Param_JSON.Set_Field ("name", Create (+Param.Name));
                  Param_JSON.Set_Field
                    ("type_name", Create (+Param.Type_Fully_Qualified_Name));
                  declare
                     Strat : Strategies.Strategy_Type'Class :=
                       Strategies.Strategy_Type
                         (Context.Type_And_Param_Strategies.Element
                            (Param.Type_Fully_Qualified_Name));
                  begin
                     Param_JSON.Set_Field
                       ("value",
                          (Param_Type.Get.Encode (Strat.Generate
                             (Strategies.Disc_Value_Maps.Empty_Map))));
                  end;
                  Append (Test_Vector_Values, Param_JSON);
               end;
            end loop;
            Test_Vector_JSON.Set_Field ("param_values", Test_Vector_Values);
            Test_Vector_JSON.Set_Field ("origin", "TGen");

            if not Is_Empty (Test_Vector_Values) then
               Append (Test_Vectors_JSON, Test_Vector_JSON);
            end if;
         end loop;
         Function_JSON.Set_Field ("test_vectors", Test_Vectors_JSON);
         Unit_JSON.Set_Field (+Subp_UID, Function_JSON);
      end;
   end Generate_Test_Vectors;

   --------------------
   -- Try_Load_Tests --
   --------------------

   procedure Try_Load_Tests
     (Context  : in out Generation_Context;
      Filename : String)
   is
      use Unit_To_JSON_Maps;

      JSON_File : constant Virtual_File :=
        Get_Output_Dir (Context) / (+Filename);
      JSON_Content : JSON_Value := Create_Object;
   begin
      if JSON_File.Is_Regular_File then
         JSON_Content := TGen.JSON.Read
           (JSON_File.Read_File.all, +JSON_File.Full_Name);
         if JSON_Content.Kind = JSON_Object_Type then
            Context.Test_Vectors.Insert (+Filename, JSON_Content);
            return;
         end if;
      end if;
      Context.Test_Vectors.Insert (+Filename, JSON_Content);
   end Try_Load_Tests;

end TGen.Gen_Strategies;