--  VHDL code formatter.
--  Copyright (C) 2019 Tristan Gingold
--
--  GHDL is free software; you can redistribute it and/or modify it under
--  the terms of the GNU General Public License as published by the Free
--  Software Foundation; either version 2, or (at your option) any later
--  version.
--
--  GHDL 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.  See the GNU General Public License
--  for more details.
--
--  You should have received a copy of the GNU General Public License
--  along with GHDL; see the file COPYING.  If not, write to the Free
--  Software Foundation, 59 Temple Place - Suite 330, Boston, MA
--  02111-1307, USA.

with Grt.Vstrings;
with Grt.Types;
with Vhdl.Nodes; use Vhdl.Nodes;

package Vhdl.Formatters is
   --  Format/pretty print the file F.
   procedure Format (F : Iir_Design_File);

   --  Reindent the file.
   procedure Indent (F : Iir_Design_File;
                     First_Line : Positive := 1;
                     Last_Line : Positive := Positive'Last);

   type Vstring_Acc is access Grt.Vstrings.Vstring;

   --  Reindent all lines of F between [First_Line; Last_Line] to HANDLE.
   procedure Indent_String (F : Iir_Design_File;
                            Handle : Vstring_Acc;
                            First_Line : Positive := 1;
                            Last_Line : Positive := Positive'Last);

   function Allocate_Handle return Vstring_Acc;
   function Get_Length (Handle : Vstring_Acc) return Natural;
   function Get_C_String (Handle : Vstring_Acc)
                         return Grt.Types.Ghdl_C_String;
   procedure Free_Handle (Handle : Vstring_Acc);
end Vhdl.Formatters;