Auto-fix: Add support for 'use_record_aggregates'

Author: HugoGGuerrier

lkql_checker/share/lkql/use_record_aggregates.lkql

@@ -6,8 +6,34 @@ fun assign_stmts(n, prefix) =
         => [n] & assign_stmts(n.next_sibling(), prefix)
     | * => []
 
+fun replace_by_aggregate(node, ctx) =
+    |" Replace all consecutive AssignStmt, starting from the ``node`` by a
+    |" record aggregate.
+    {
+        val assigns = assign_stmts(node, node.f_dest.f_prefix);
+        assigns.reduce(
+            (ctx, a) => ctx.remove(a),
+            ctx.insert_before(
+                assigns[1],
+                new AssignStmt(
+                    f_dest=node.f_dest.f_prefix,
+                    f_expr=new Aggregate(
+                        f_ancestor_expr=null,
+                        f_assocs=new AssocList([
+                            new AggregateAssoc(
+                                f_designators=new AlternativesList([a.f_dest.f_suffix]),
+                                f_r_expr=a.f_expr
+                            ) for a in assigns
+                        ].to_list)
+                    )
+                )
+            )
+        )
+    }
+
 @check(message="component assignments may be replaced by an aggregate",
-       category="Style", subcategory="Programming Practice")
+       category="Style", subcategory="Programming Practice",
+       auto_fix=replace_by_aggregate)
 fun use_record_aggregates(node) =
     |" Flag the first statement in the sequence of assignment statements if the targets
     |" of all these assignment statements are components of the same record objects,

testsuite/tests/checks/use_record_aggregates/assign.adb

@@ -13,7 +13,7 @@ procedure Assign is
 begin
    null;
    O1.Comp1 := 1;   --  FLAG
-   O1.Comp2 := 1;   --  NOFLAG (flag only first assignment)
+   O1.Comp2 := 2;   --  NOFLAG (flag only first assignment)
 
    O2.Comp1 := 1;   --  NOFLAG (single component)
 
@@ -26,7 +26,7 @@ begin
    begin
       null;
       O3.Comp1 := 1;   --  FLAG
-      O3.Comp2 := 1;   --  NOFLAG
+      O3.Comp2 := 2;   --  NOFLAG
    end;
 
    begin
@@ -56,7 +56,7 @@ begin
 
       Obj.A := 1;   --  NOFLAG (tagged)
       Obj.B := 1;   --  NOFLAG
-   end
+   end;
 
    declare
       type List is record

testsuite/tests/checks/use_record_aggregates/test.out

@@ -6,3 +6,78 @@ assign.adb:28:7: rule violation: component assignments may be replaced by an agg
 28 |       O3.Comp1 := 1;   --  FLAG
    |       ^^^^^^^^^^^^^^
 
+Patched "assign.adb":
+=====================
+
+procedure Assign is
+   type Rec1 is record
+      Comp1, Comp2 : Integer;
+   end record;
+
+   type Rec2 is record
+      Comp1 : Integer;
+   end record;
+
+   O1, O3 : Rec1;
+   O2 : Rec2;
+
+begin
+   null;
+   O1:=(Comp1 =>1,Comp2 =>2);O2.Comp1 := 1;   --  NOFLAG (single component)
+
+   begin
+      O1.Comp1 := 1;   --  NOFLAG (not consecutive assignments on O1)
+      O2.Comp2 := 1;
+      O1.Comp2 := 1;
+   end;
+
+   begin
+      null;
+      O3:=(Comp1 =>1,Comp2 =>2);end;
+
+   begin
+      O3.Comp1 := 1;   --  NOFLAG
+
+      if True then
+         null;
+      end if;
+
+      O3.Comp2 := 1;   --  NOFLAG
+   end;
+
+   declare
+      type Rec_Discr (D : Integer) is record
+         A, B : Integer;
+      end record;
+
+      type Rec_Tagged is tagged record
+         A, B : Integer;
+      end record;
+
+      Discr : Rec_Discr (1);
+      Obj   : Rec_Tagged;
+   begin
+      Discr.A := 1;   --  NOFLAG (discriminants)
+      Discr.B := 1;   --  NOFLAG
+
+      Obj.A := 1;   --  NOFLAG (tagged)
+      Obj.B := 1;   --  NOFLAG
+   end;
+
+   declare
+      type List is record
+         Prev, Next : Integer;
+      end record;
+
+      type Rec is record
+         L : List;
+      end record;
+
+      Obj1, Obj2 : Rec;
+
+   begin
+      Obj1.L.Next := 0;   --  NOFLAG
+      Obj2.L.Prev := 0;   --  NOFLAG
+   end;
+end Assign;
+

testsuite/tests/checks/use_record_aggregates/test.yaml

@@ -1,3 +1,4 @@
 driver: 'checker'
 rule_name: use_record_aggregates
 project: 'prj.gpr'
+auto_fix: True