manual dump: rename Done formal to Has_Manual_Indication

And make it an `out` parameter, rather than an `in out`.

Author: Jugst3r

tools/gnatcov/instrument-ada_unit.adb

@@ -7799,10 +7799,10 @@ package body Instrument.Ada_Unit is
    ------------------------------------
 
    overriding procedure Replace_Manual_Dump_Indication
-     (Self   : in out Ada_Instrumenter_Type;
-      Done   : in out Boolean;
-      Prj    : in out Prj_Desc;
-      Source : GNATCOLL.Projects.File_Info)
+     (Self                  : in out Ada_Instrumenter_Type;
+      Prj                   : in out Prj_Desc;
+      Source                : GNATCOLL.Projects.File_Info;
+      Has_Manual_Indication : out Boolean)
    is
       Instrumented_Filename : constant String :=
         +(Prj.Output_Dir & "/" & GNATCOLL.VFS."+" (Source.File.Base_Name));
@@ -7853,7 +7853,7 @@ package body Instrument.Ada_Unit is
                   --  The pragma statement to be replaced by the actual call
                   --  to Dump_Buffers has been found.
 
-                  if not Done then
+                  if not Has_Manual_Indication then
                      Start_Rewriting (Rewriter, Self, Prj, File_To_Search);
                   end if;
 
@@ -7870,7 +7870,7 @@ package body Instrument.Ada_Unit is
                   begin
                      --  Add the with clause only once in the file
 
-                     if not Done then
+                     if not Has_Manual_Indication then
                         Insert_Last
                           (Handle (Unit.Root.As_Compilation_Unit.F_Prelude),
                            Create_From_Template
@@ -7891,7 +7891,7 @@ package body Instrument.Ada_Unit is
                            Rule => Call_Stmt_Rule));
                   end;
 
-                  Done := True;
+                  Has_Manual_Indication := True;
                   return Over;
                end if;
             end;
@@ -7913,11 +7913,12 @@ package body Instrument.Ada_Unit is
       --  initialized which will lead to finalization issues. To avoid this,
       --  make sure it is set to No_Rewriting_Handle.
 
+      Has_Manual_Indication := False;
       Rewriter.Handle := No_Rewriting_Handle;
 
       Unit.Root.Traverse (Find_And_Replace_Pragma'Access);
 
-      if Done then
+      if Has_Manual_Indication then
          Create_Directory_If_Not_Exists
            (GNATCOLL.VFS."+" (Source.Project.Object_Dir.Base_Dir_Name));
          Create_Directory_If_Not_Exists (+Prj.Output_Dir);

tools/gnatcov/instrument-ada_unit.ads

@@ -86,10 +86,10 @@ package Instrument.Ada_Unit is
       Prj           : Prj_Desc);
 
    overriding procedure Replace_Manual_Dump_Indication
-     (Self   : in out Ada_Instrumenter_Type;
-      Done   : in out Boolean;
-      Prj    : in out Prj_Desc;
-      Source : GNATCOLL.Projects.File_Info);
+     (Self                  : in out Ada_Instrumenter_Type;
+      Prj                   : in out Prj_Desc;
+      Source                : GNATCOLL.Projects.File_Info;
+      Has_Manual_Indication : out Boolean);
    --  Once the instrumentation has finished, if the dump trigger is "manual"
    --  we expect the user to have indicated the place where a call to the
    --  manual dump buffers procedure should be inserted by the pragma

tools/gnatcov/instrument-c.adb

@@ -3838,10 +3838,10 @@ package body Instrument.C is
    ------------------------------------
 
    overriding procedure Replace_Manual_Dump_Indication
-     (Self   : in out C_Family_Instrumenter_Type;
-      Done   : in out Boolean;
-      Prj    : in out Prj_Desc;
-      Source : GNATCOLL.Projects.File_Info)
+     (Self                  : in out C_Family_Instrumenter_Type;
+      Prj                   : in out Prj_Desc;
+      Source                : GNATCOLL.Projects.File_Info;
+      Has_Manual_Indication : out Boolean)
    is
       use GNATCOLL.VFS;
       Orig_Filename : constant String := +Source.File.Full_Name;
@@ -3902,7 +3902,7 @@ package body Instrument.C is
 
                if Matches (0) /= No_Match then
                   Contents := Contents & Dump_Procedure & "();";
-                  Done := True;
+                  Has_Manual_Indication := True;
                else
                   Contents := Contents & Line;
                end if;
@@ -3913,7 +3913,7 @@ package body Instrument.C is
 
          Ada.Text_IO.Close (File);
 
-         if Done then
+         if Has_Manual_Indication then
             --  Content now holds the text of the original file with calls to
             --  the manual dump procedure where the indications and its extern
             --  declaration were. Replace the original content of the file with

tools/gnatcov/instrument-c.ads

@@ -54,10 +54,10 @@ package Instrument.C is
       Prj         : Prj_Desc);
 
    overriding procedure Replace_Manual_Dump_Indication
-     (Self   : in out C_Family_Instrumenter_Type;
-      Done   : in out Boolean;
-      Prj    : in out Prj_Desc;
-      Source : GNATCOLL.Projects.File_Info);
+     (Self                  : in out C_Family_Instrumenter_Type;
+      Prj                   : in out Prj_Desc;
+      Source                : GNATCOLL.Projects.File_Info;
+      Has_Manual_Indication : out Boolean);
    --  Preprocess Source and look through the text content of the preprocessed
    --  file looking for manual dump indications. The C-like languages, the
    --  expected indication is the comment alone on its line:

tools/gnatcov/instrument-common.ads

@@ -486,14 +486,17 @@ package Instrument.Common is
    --  the instrumented source files.
 
    procedure Replace_Manual_Dump_Indication
-     (Self   : in out Language_Instrumenter;
-      Done   : in out Boolean;
-      Prj    : in out Prj_Desc;
-      Source : GNATCOLL.Projects.File_Info) is null;
+     (Self                  : in out Language_Instrumenter;
+      Prj                   : in out Prj_Desc;
+      Source                : GNATCOLL.Projects.File_Info;
+      Has_Manual_Indication : out Boolean) is null;
    --  Look for the pragma (for Ada) or comment (for C family languages)
    --  indicating where the user wishes to the buffers to be dumped in Source.
    --  When found, replace it with a call to the buffers dump procedure defined
    --  in the dump helper unit.
+   --
+   --  Has_Manual_Indication indicates whether a manual dump indication was
+   --  found - and replaced with a call to dump buffers - in the given source.
 
    function New_File
      (Prj : Prj_Desc; Name : String) return String;

tools/gnatcov/instrument-projects.adb

@@ -865,9 +865,9 @@ is
                Contained_Indication : Boolean := False;
             begin
                Instrumenter.Replace_Manual_Dump_Indication
-                 (Contained_Indication,
-                  Prj_Info.Desc,
-                  Source);
+                 (Prj_Info.Desc,
+                  Source,
+                  Contained_Indication);
 
                if Contained_Indication and then not Is_Root_Prj then