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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548 | --
-- Copyright (C) 2022-2023, AdaCore
--
-- SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
--
with Ada.Text_IO; use Ada.Text_IO;
with Ada.Characters.Latin_1;
with Langkit_Support.Text;
with Libadalang.Common;
with Ada.Containers; use Ada.Containers;
with LAL_Refactor.Output;
with Ada.Containers.Hashed_Sets;
with Ada.Containers.Ordered_Sets;
with Ada.Containers.Hashed_Maps;
package body LAL_Refactor.Tools.Scope_Declarations_Tool is
package LALCO renames Libadalang.Common;
package Text renames Langkit_Support.Text;
function Hash (N : LAL.Defining_Name) return Ada.Containers.Hash_Type is
(N.As_Ada_Node.Hash);
function Hash (N : LAL.Object_Decl) return Ada.Containers.Hash_Type is
(N.As_Ada_Node.Hash);
function Hash (N : LAL.Declarative_Part) return Ada.Containers.Hash_Type is
(N.As_Ada_Node.Hash);
package Defining_Name_Sets is new
Ada.Containers.Hashed_Sets
(Element_Type => LAL.Defining_Name,
Hash => Hash,
Equivalent_Elements => LAL."=",
"=" => LAL."=");
package Object_Decl_Sets is new
Ada.Containers.Hashed_Sets
(Element_Type => LAL.Object_Decl,
Hash => Hash,
Equivalent_Elements => LAL."=",
"=" => LAL."=");
package Defining_Name_To_Decl_Part is new
Ada.Containers.Hashed_Maps
(Key_Type => LAL.Defining_Name,
Element_Type => LAL.Declarative_Part,
Hash => Hash,
Equivalent_Keys => LAL."=",
"=" => LAL."=");
package Defining_Name_To_Int is new
Ada.Containers.Hashed_Maps
(Key_Type => LAL.Defining_Name,
Element_Type => Integer,
Hash => Hash,
Equivalent_Keys => LAL."=",
"=" => "=");
package Decl_Part_Sets is new
Ada.Containers.Hashed_Sets
(Element_Type => LAL.Declarative_Part,
Hash => Hash,
Equivalent_Elements => LAL."=",
"=" => LAL."=");
package Integer_Sets is new
Ada.Containers.Ordered_Sets
(Element_Type => Integer);
type Positions is (First, Middle, Last);
Edit_Info : Modify_Info;
---------
-- "<" --
---------
function "<" (L, R : LAL.Ada_Node) return Boolean is
begin
if L.Unit.Get_Filename < R.Unit.Get_Filename then
return True;
else
if L.Unit.Get_Filename > R.Unit.Get_Filename then
return False;
else
return (Start_Sloc (LAL.Sloc_Range (L)) <
Start_Sloc (LAL.Sloc_Range (R)));
end if;
end if;
end "<";
------------------------
-- Scope_Declarations --
------------------------
function Scope_Declarations (Unit_Array : LAL.Analysis_Unit_Array)
return Modify_Info is
Edit_Info : Obj_Decl_To_Edit_Map.Map;
-- Store the Edit_Map to the relevant Object Declaration node
Obj_Decl_To_Names : Obj_Decl_To_Defining_Name.Map;
-- Store the variables that can be scoped more narrowly
Decl_To_Check : Defining_Name_Sets.Set;
-- The set stores the defining_names that still haven't been refered
Last_Decl_For_Name : Defining_Name_To_Decl_Part.Map;
-- This map stores the defining_names that can be scoped more narrowly
-- and the destination declarative part that the defining name can be
-- moved to.
Name_Ref_Count : Defining_Name_To_Int.Map;
-- Count the number of reference of the defining name in the recent
-- subprogram.
Obj_Decl_To_Modify : Object_Decl_Sets.Set;
-- Stores the Object declarations to be modified
Decl_Parts : Decl_Part_Sets.Set;
-- Stores the declarative part nodes.
Removable_Decl_Part : Decl_Part_To_Edit_Map.Map;
-- Stores the Declarative Part that can be removed.
procedure Process_Decl (Decl_Part : LAL.Declarative_Part);
-- Process the declarative part
-- 1. first check all the defining name in the decl_to_check that how
-- many time it is refered in the recent subfunction, if the number
-- is equal to the previous count, which means this defining name is
-- not refered in other part, i.e. could be scoped to this decl_part
-- add or update this defining name and the relevent decl_part to the
-- last_decl_for_name.
-- 2. If the number is positive but not equal to the previous, which
-- means the name are both refer in this subpart and other parts,
-- i.e. this name can't be scoped more narrowly, so we delete it from
-- the set.
-- 3. Add all the variables delared in this declarative_part and their
-- reference number.
function Find_Decl_Part (Node : LAL.Ada_Node'Class)
return LALCO.Visit_Status;
-- go through the AST to find all the decl part.
procedure Generate_Edit (Decl_Part : LAL.Declarative_Part);
-- generate the text edit information
------------------
-- Process_Decl --
------------------
procedure Process_Decl (Decl_Part : LAL.Declarative_Part) is
Father : constant LAL.Ada_Node := Decl_Part.Parent;
begin
declare
Name_Checked_Done : Defining_Name_Sets.Set;
begin
for Name of Decl_To_Check loop
-- We previously concluded that the amount of refs
-- in this declarative part is smaller than
-- the total amount of refs of this name.
-- So, if there is at least one ref in this declarative
-- part, then for sure we cannot move.
if Name.P_Find_Refs (Father)'Length = Name_Ref_Count (Name)
then
Last_Decl_For_Name.Include (Name, Decl_Part);
Obj_Decl_To_Modify.Include
(Name.P_Basic_Decl.As_Object_Decl);
else
if Name.P_Find_Refs (Father)'Length > 0 then
Name_Checked_Done.Include (Name);
end if;
end if;
end loop;
for Name of Name_Checked_Done loop
Decl_To_Check.Exclude (Name);
end loop;
end;
for Decl of Decl_Part.F_Decls loop
if Decl.Kind in LALCO.Ada_Object_Decl_Range then
for Name of Decl.As_Object_Decl.F_Ids loop
-- We initialize the amount of refs for each defining name
-- since the P_Find_Refs will return also the decl itself
-- we put -1 in the end.
Name_Ref_Count.Include
(Name.As_Defining_Name,
Name.P_Find_Refs (Father)'Length - 1);
Decl_To_Check.Include (Name.As_Defining_Name);
end loop;
end if;
end loop;
end Process_Decl;
--------------------
-- Find_Decl_Part --
--------------------
function Find_Decl_Part (Node : LAL.Ada_Node'Class)
return LALCO.Visit_Status is
begin
if Node.Kind in LALCO.Ada_Declarative_Part_Range then
Decl_Parts.Include (Node.As_Declarative_Part);
Process_Decl (Node.As_Declarative_Part);
end if;
return LALCO.Into;
end Find_Decl_Part;
-------------------
-- Generate_Edit --
-------------------
procedure Generate_Edit (Decl_Part : LAL.Declarative_Part) is
Is_Empty : Boolean := True;
Has_Decl : Boolean := False;
Edit_Map_Of_Decl_Part : ReFac.Text_Edit_Map;
procedure Generate_Edit (Obj : LAL.Object_Decl);
procedure Generate_Edit (Obj : LAL.Object_Decl) is
Text_To_Add, Tmp_Text : Unbounded_String;
Edit_Texts : ReFac.Text_Edit_Map;
Text_Edit : ReFac.Text_Edit;
Name_Count, Modify_Count : Integer := 0;
Names : Defining_Name_Ordered_Sets.Set;
function Check_Position (List_Node : LAL.Ada_Node'Class;
Name_Node : LAL.Defining_Name'Class)
return Positions;
-- Check the position of the name in the name list
function Delete_Position (Name : LAL.Ada_Node'Class;
Position : Positions)
return Source_Location_Range;
-- Get the delete sloc by the location
procedure Delete_Names_in_List;
-- Generate the edit text of delete name in the list
--------------------
-- Check_Position --
--------------------
function Check_Position (List_Node : LAL.Ada_Node'Class;
Name_Node : LAL.Defining_Name'Class)
return Positions
is
begin
if Name_Node.Child_Index = 0 then
return First;
else
if Name_Node.Child_Index =
LAL.Children (List_Node)'Length - 1
then
return Last;
else
return Middle;
end if;
end if;
end Check_Position;
---------------------
-- Delete_Position --
---------------------
function Delete_Position (Name : LAL.Ada_Node'Class;
Position : Positions)
return Source_Location_Range
is
Deletable_Range, Next_Range,
Previous_Range : Source_Location_Range;
begin
Deletable_Range := LAL.Sloc_Range (Name);
if Position /= Last then
Next_Range :=
LAL.Sloc_Range (LAL.Next_Sibling (Name));
Deletable_Range.End_Column := Next_Range.Start_Column;
Deletable_Range.End_Line := Next_Range.Start_Line;
end if;
if Position /= First then
Previous_Range :=
LAL.Sloc_Range (LAL.Previous_Sibling (Name));
Deletable_Range.Start_Column := Previous_Range.End_Column;
Deletable_Range.Start_Line := Previous_Range.End_Line;
end if;
return Deletable_Range;
end Delete_Position;
--------------------------
-- Delete_Names_in_List --
--------------------------
procedure Delete_Names_in_List
is
Name_List : constant LAL.Defining_Name_List :=
Obj.F_Ids;
Name_Position : Positions;
Last_Position : Positions := First;
Last_Sloc, Last_Sloc_Start : Source_Location :=
No_Source_Location;
Delete_Last : Boolean := False;
Deletable_Range : Source_Location_Range;
begin
for Name_Node of Name_List loop
if Names.Contains (Name_Node.As_Defining_Name) then
Name_Position := Check_Position (Name_List, Name_Node);
if Name_Position = Last then
Delete_Last := True;
end if;
Deletable_Range := Delete_Position
(Name_Node.As_Ada_Node, Name_Position);
if Start_Sloc (Deletable_Range) < Last_Sloc then
Last_Sloc := End_Sloc (Deletable_Range);
else
if Last_Sloc /= No_Source_Location then
if Last_Position = First then
Text_Edit.Location := Make_Range
(Last_Sloc_Start, Last_Sloc);
Text_Edit.Text := Null_Unbounded_String;
ReFac.Safe_Insert (Edit_Texts,
Obj.Unit.Get_Filename,
Text_Edit);
else
Text_Edit.Location := Make_Range
(Last_Sloc_Start, Last_Sloc);
Text_Edit.Text := To_Unbounded_String (", ");
ReFac.Safe_Insert (Edit_Texts,
Obj.Unit.Get_Filename,
Text_Edit);
end if;
Last_Position := Name_Position;
end if;
Last_Position := Name_Position;
Last_Sloc_Start := Start_Sloc (Deletable_Range);
Last_Sloc := End_Sloc (Deletable_Range);
end if;
end if;
end loop;
if Delete_Last or Last_Position = First then
Text_Edit.Location := Make_Range
(Last_Sloc_Start, Last_Sloc);
Text_Edit.Text := Null_Unbounded_String;
ReFac.Safe_Insert (Edit_Texts,
Obj.Unit.Get_Filename,
Text_Edit);
else
Text_Edit.Location := Make_Range
(Last_Sloc_Start, Last_Sloc);
Text_Edit.Text := To_Unbounded_String (", ");
ReFac.Safe_Insert (Edit_Texts,
Obj.Unit.Get_Filename,
Text_Edit);
end if;
end Delete_Names_in_List;
begin
for Name of Obj.F_Ids loop
Name_Count := Name_Count + 1;
if Last_Decl_For_Name.Contains (Name.As_Defining_Name) then
Modify_Count := Modify_Count + 1;
Names.Include (Name.As_Defining_Name);
end if;
end loop;
Obj_Decl_To_Names.Include (Obj, Names);
Tmp_Text := Null_Unbounded_String;
declare
Delete_Lenth : Integer;
Tmp_String : constant String := Text.Image (Obj.Text);
begin
Delete_Lenth := Integer (Obj.F_Ids.Sloc_Range.End_Column -
Obj.Sloc_Range.Start_Column) + 1;
for I in Tmp_String'Range loop
if I > Delete_Lenth then
Tmp_Text := Tmp_Text & Tmp_String (I);
end if;
end loop;
end;
if Name_Count = Modify_Count then
Text_Edit.Location := Obj.Sloc_Range;
Text_Edit.Text := Null_Unbounded_String;
ReFac.Safe_Insert (Edit_Texts,
Obj.Unit.Get_Filename,
Text_Edit);
else
Delete_Names_in_List;
Is_Empty := False;
end if;
for Name of Names loop
Text_To_Add := Null_Unbounded_String;
Text_To_Add := Text_To_Add & Text.Image (Name.Text);
Text_To_Add := Text_To_Add & Tmp_Text
& Ada.Characters.Latin_1.LF;
declare
Last_Decl : constant LAL.Declarative_Part :=
Last_Decl_For_Name (Name);
Location : Source_Location_Range :=
Last_Decl.Child (1).Sloc_Range;
begin
Location.End_Column := Location.Start_Column;
Location.End_Line := Location.Start_Line;
Text_Edit.Location := Location;
Text_Edit.Text := Text_To_Add;
ReFac.Safe_Insert (Edit_Texts,
Last_Decl.Unit.Get_Filename,
Text_Edit);
ReFac.Safe_Insert (Edit_Map_Of_Decl_Part,
Last_Decl.Unit.Get_Filename,
Text_Edit);
end;
end loop;
Edit_Info.Insert (Obj, Edit_Texts);
end Generate_Edit;
begin
for Decl of Decl_Part.F_Decls loop
if Decl.Kind in LALCO.Ada_Object_Decl_Range then
if not Obj_Decl_To_Modify.Contains (Decl.As_Object_Decl) then
Is_Empty := False;
else
Generate_Edit (Decl.As_Object_Decl);
end if;
else
Is_Empty := False;
end if;
Has_Decl := True;
end loop;
if Is_Empty and Has_Decl then
declare
Text_Delete : ReFac.Text_Edit;
begin
Text_Delete.Text := Null_Unbounded_String;
Text_Delete.Location := Decl_Part.Sloc_Range;
ReFac.Safe_Insert (Edit_Map_Of_Decl_Part,
Decl_Part.Unit.Get_Filename,
Text_Delete);
end;
Removable_Decl_Part.Insert (Decl_Part, Edit_Map_Of_Decl_Part);
end if;
end Generate_Edit;
begin
for Unit of Unit_Array loop
Unit.Root.Traverse (Find_Decl_Part'Access);
end loop;
for Decl_Part of Decl_Parts loop
Generate_Edit (Decl_Part);
end loop;
return (Obj_Decl_To_Names, Edit_Info, Removable_Decl_Part);
end Scope_Declarations;
procedure Run (Unit_Array : LAL.Analysis_Unit_Array;
Stream : in out
VSS.Text_Streams.Output_Text_Stream'Class) is
begin
Edit_Info := Scope_Declarations (Unit_Array);
LAL_Refactor.Output.JSON_Serialize (Edit_Info, Stream);
end Run;
function Interact return ReFac.Text_Edit_Map is
Count : Integer := 0;
Last : Integer;
Index_Set : Integer_Sets.Set;
Output_Map : ReFac.Text_Edit_Map;
Is_Apply_All : Boolean := False;
begin
Put_Line ("There is(are)"
& Edit_Info.Object_To_Decl.Length'Image
& " object declaration(s) that could be scoped:");
for Obj_Decl in Edit_Info.Object_To_Decl.Iterate loop
Count := Count + 1;
Put_Line (Count'Image & ". "
& Text.Image (Obj_Decl.Key.Text)
& " in Line"
& Obj_Decl.Key.Sloc_Range.Start_Line'Image);
end loop;
Put_Line ("Please Enter the Changes that you would like to apply, "
& "entre 0 to apply all the changes");
declare
Selection : String (1 .. 3 * Count) := [others => ' '];
Index_Select : Integer := 0;
Flag : Boolean := False;
begin
Get_Line (Selection, Last);
for I in 1 .. Last loop
case Selection (I) is
when ' ' =>
if Flag then
Flag := False;
if Index_Select > Count then
Put_Line ("Please Enter Legal Value");
else
Index_Set.Insert (Index_Select);
end if;
Index_Select := 0;
end if;
when '0' =>
if not Flag then
Is_Apply_All := True;
exit;
else
Index_Select := Index_Select * 10;
end if;
when '1' =>
Flag := True;
Index_Select := Index_Select * 10 + 1;
when '2' =>
Flag := True;
Index_Select := Index_Select * 10 + 2;
when '3' =>
Flag := True;
Index_Select := Index_Select * 10 + 3;
when '4' =>
Flag := True;
Index_Select := Index_Select * 10 + 4;
when '5' =>
Flag := True;
Index_Select := Index_Select * 10 + 5;
when '6' =>
Flag := True;
Index_Select := Index_Select * 10 + 6;
when '7' =>
Flag := True;
Index_Select := Index_Select * 10 + 7;
when '8' =>
Flag := True;
Index_Select := Index_Select * 10 + 8;
when '9' =>
Flag := True;
Index_Select := Index_Select * 10 + 9;
when others =>
Put_Line ("Please Enter Legal Value");
end case;
end loop;
if Flag then
Flag := False;
if Index_Select > Count then
Put_Line ("Please Enter Legal Value");
else
Index_Set.Insert (Index_Select);
end if;
Index_Select := 0;
end if;
end;
Count := 0;
for Obj_Decl in Edit_Info.Object_To_Decl.Iterate loop
Count := Count + 1;
if Index_Set.Contains (Count) or Is_Apply_All then
ReFac.Merge (Output_Map, Edit_Info.Edit_Info (Obj_Decl.Key));
end if;
end loop;
return Output_Map;
end Interact;
end LAL_Refactor.Tools.Scope_Declarations_Tool;
|