--------------------------------------------------------------- {{{1 ----------
--: Copyright © 2007 … 2023 Martin Krischik «krischik@users.sourceforge.net»
-------------------------------------------------------------------------------
--: Ada_Demo 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 3 of the License, or (at your option)
--: any later version.
--:
--: Ada_Demo 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 Ada_Demo. If not, see <http://www.gnu.org/licenses/>.
--------------------------------------------------------------- }}}1-----------

pragma License (Modified_Gpl);
pragma Ada_2022;

with Ada.Strings.Unbounded;
with Ada.Strings.Wide_Unbounded;
with Ada.Strings.Wide_Wide_Unbounded;
with GNAT.Source_Info;

---
--  @summary
--  Enhanced assertions
--
--  @description
--  Additional Asserts which produce more detailed diagnostic messages Diagnostics will be reported via the
--  Report_Assertion function. The Report function is passed as a generic ot avoid dependence to AUnit.
--
generic

   with procedure Report_Assertion
      (Condition : Boolean := False;
       Message   : String;
       Source    : String;
       Line      : Natural) is <>;

package AdaCL.Assert is

   ---------- Unbounded_String -------------------------------- {{{1 ----------

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Unbounded.Unbounded_String;
       Expected : String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Unbounded.Unbounded_String;
       Expected : Ada.Strings.Unbounded.Unbounded_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a string is of given length
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Lenght
      (Actual   : Ada.Strings.Unbounded.Unbounded_String;
       Expected : Natural;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---------- Wide_Unbounded_String --------------------------- {{{1 ----------

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Expected : Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Expected : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a string is of given length
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Lenght
      (Actual   : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Expected : Natural;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---------- Wide_Wide_Unbounded_String --------------------------- {{{1 ----------

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Expected : Wide_Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Expected : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a string is of given length
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Lenght
      (Actual   : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Expected : Natural;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---------- Boolean ----------------------------------------- {{{1 ----------

   ---
   --  Assert that Boolean is true
   --
   --: @param Actual     Actual value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Is_True
      (Actual : Boolean;
       Name   : String;
       Source : String  := GNAT.Source_Info.File;
       Line   : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that Boolean is false
   --
   --: @param Actual     Actual value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Is_False
      (Actual : Boolean;
       Name   : String;
       Source : String  := GNAT.Source_Info.File;
       Line   : Natural := GNAT.Source_Info.Line);

      ----------------------------------------------------------- }}}1 ----------

end AdaCL.Assert;

---------------------------------------------------------------- {{{ ----------
--: vim: set textwidth=0 nowrap tabstop=8 shiftwidth=3 softtabstop=3 expandtab :
--: vim: set filetype=ada fileencoding=utf-8 fileformat=unix foldmethod=marker :
--: vim: set spell spelllang=en_gb