------------------------------------------------------------------------------
--                                  G P S                                   --
--                                                                          --
--                       Copyright (C) 2018-2019, AdaCore                   --
--                                                                          --
-- This is free software;  you can redistribute it  and/or modify it  under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion.  This software is distributed in the hope  that it will be useful, --
-- but WITHOUT ANY WARRANTY;  without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public --
-- License for  more details.  You should have  received  a copy of the GNU --
-- General  Public  License  distributed  with  this  software;   see  file --
-- COPYING3.  If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license.                                                          --
------------------------------------------------------------------------------
with CodePeer.Bridge.Inspection_Readers.Base;

private package CodePeer.Bridge.Inspection_Readers.V6 is

   type Inspection_Reader_V6 is
     limited new Base.Base_Inspection_Reader with private;

   function Create_Inspection_Reader_V6
     (Kernel          : not null GPS.Kernel.Kernel_Handle;
      Base_Directory  : GNATCOLL.VFS.Virtual_File;
      Root_Inspection : Code_Analysis.CodePeer_Data_Access;
      Messages        : access CodePeer.Message_Maps.Map)
      return not null Inspection_Reader_Access;

private

   type Message_Subprogram_Pair is record
      Message    : CodePeer.Message_Access;
      Subprogram : Positive;
   end record;

   function Hash
     (Item : Message_Subprogram_Pair) return Ada.Containers.Hash_Type;
   --  Hash function to use Message_Subprogram_Pair in standard hashed
   --  containers.

   package Message_Subprogram_Sets is
     new Ada.Containers.Hashed_Sets
       (Message_Subprogram_Pair, Hash, "=", "=");

   type Inspection_Reader_V6 is
     limited new Base.Base_Inspection_Reader with record
      Subprogram_Map  : Positive_Subprogram_Maps.Map;
      Subprogram_Node : Code_Analysis.Subprogram_Access;

      Postponed       : Message_Subprogram_Sets.Set;
      --  Set of messages which is not associated to subprograms due to missing
      --  of subprogram mapping at message processing time.

      Backtrace_Mode  : Boolean := False;
      --  Set inside of "backtrace" element.
   end record;

   overriding procedure Start_Element
     (Self  : in out Inspection_Reader_V6;
      Name  : String;
      Attrs : Sax.Attributes.Attributes'Class);

   overriding procedure End_Element
     (Self  : in out Inspection_Reader_V6;
      Name  : String);

   overriding procedure Start_Message
     (Self  : in out Inspection_Reader_V6;
      Attrs : Sax.Attributes.Attributes'Class);

   overriding procedure End_Message (Self : in out Inspection_Reader_V6);

   overriding procedure Start_Subprogram
     (Self  : in out Inspection_Reader_V6;
      Attrs : Sax.Attributes.Attributes'Class);

   overriding function Subprogram_Node
     (Self : Inspection_Reader_V6)
      return Code_Analysis.Subprogram_Access;

   overriding procedure End_Document (Self : in out Inspection_Reader_V6);

end CodePeer.Bridge.Inspection_Readers.V6;
