-- CXA4025.A
--
--                             Grant of Unlimited Rights
--
--     Under contracts F33600-87-D-0337, F33600-84-D-0280, MDA903-79-C-0687,
--     F08630-91-C-0015, and DCA100-97-D-0025, the U.S. Government obtained 
--     unlimited rights in the software and documentation contained herein.
--     Unlimited rights are defined in DFAR 252.227-7013(a)(19).  By making 
--     this public release, the Government intends to confer upon all 
--     recipients unlimited rights  equal to those held by the Government.  
--     These rights include rights to use, duplicate, release or disclose the 
--     released technical data and computer software in whole or in part, in 
--     any manner and for any purpose whatsoever, and to have or permit others 
--     to do so.
--
--                                    DISCLAIMER
--
--     ALL MATERIALS OR INFORMATION HEREIN RELEASED, MADE AVAILABLE OR
--     DISCLOSED ARE AS IS.  THE GOVERNMENT MAKES NO EXPRESS OR IMPLIED 
--     WARRANTY AS TO ANY MATTER WHATSOEVER, INCLUDING THE CONDITIONS OF THE
--     SOFTWARE, DOCUMENTATION OR OTHER INFORMATION RELEASED, MADE AVAILABLE 
--     OR DISCLOSED, OR THE OWNERSHIP, MERCHANTABILITY, OR FITNESS FOR A
--     PARTICULAR PURPOSE OF SAID MATERIAL.
--*
--
-- OBJECTIVE:
--      Check that the functionality found in packages Ada.Strings.Wide_Maps,
--      Ada.Strings.Wide_Fixed, and Ada.Strings.Wide_Maps.Wide_Constants
--      is available and produces correct results.
--
-- TEST DESCRIPTION:
--      This test validates the subprograms found in the various Wide_Map
--      and Wide_String packages.  It is based on the tests CXA4024 and
--      CXA4026, which are tests for the complementary "non-wide" packages.
--      
--      The functions found in CXA4025_0 provide mapping capability, when
--      used in conjunction with Wide_Character_Mapping_Function objects.
--
--       
-- CHANGE HISTORY:
--      23 Jun 95   SAIC    Initial prerelease version.
--      15 Apr 96   SAIC    Incorporated reviewer comments for ACVC 2.1.
--
--!

package CXA4025_0 is
   -- Functions used to supply mapping capability.
   function Map_To_Lower_Case (From : Wide_Character) return Wide_Character;
   function Map_To_Upper_Case (From : Wide_Character) return Wide_Character;
end CXA4025_0;

with Ada.Characters.Handling;
package body CXA4025_0 is
      -- Function Map_To_Lower_Case will return the lower case form of 
      -- Wide_Characters in the range 'A'..'Z' only, and return the input
      -- wide_character otherwise.

      function Map_To_Lower_Case (From : Wide_Character) 
         return Wide_Character is
      begin
         return Ada.Characters.Handling.To_Wide_Character(
                  Ada.Characters.Handling.To_Lower(
                    Ada.Characters.Handling.To_Character(From)));
      end Map_To_Lower_Case;

      -- Function Map_To_Upper_Case will return the upper case form of 
      -- Wide_Characters in the range 'a'..'z', or whose position is in one
      -- of the ranges 223..246 or 248..255, provided the wide_character has
      -- an upper case form.               

      function Map_To_Upper_Case (From : Wide_Character) 
        return Wide_Character is
      begin
         return Ada.Characters.Handling.To_Wide_Character(
                  Ada.Characters.Handling.To_Upper(
                    Ada.Characters.Handling.To_Character(From)));
      end Map_To_Upper_Case;

end CXA4025_0;


with CXA4025_0;
with Report;
with Ada.Characters.Handling;
with Ada.Characters.Latin_1;
with Ada.Exceptions;
with Ada.Strings;
with Ada.Strings.Wide_Maps;
with Ada.Strings.Wide_Maps.Wide_Constants;
with Ada.Strings.Wide_Fixed;

procedure CXA4025 is
begin
   Report.Test ("CXA4025",
                "Check that subprograms defined in packages "       &
                "Ada.Strings.Wide_Maps and Ada.Strings.Wide_Fixed " &
                "produce correct results");

   Test_Block:
   declare

      package ACL1 renames Ada.Characters.Latin_1;

      use Ada.Characters, Ada.Strings;
      use Ada.Exceptions;
      use type Wide_Maps.Wide_Character_Set; 

      subtype LC_Characters is Wide_Character range 'a'..'z';

      Last_Letter    : constant := 26;
      Vowels         : constant Wide_Maps.Wide_Character_Sequence := "aeiou";
      TC_String      : constant Wide_String := "A Standard String";

      Alphabet       : Wide_Maps.Wide_Character_Sequence (1..Last_Letter);
      Alphabet_Set,
      Consonant_Set,
      Vowel_Set      : Wide_Maps.Wide_Character_Set;

      String_20      : Wide_String(1..20)    := "ABCDEFGHIJKLMNOPQRST";
      String_40      : Wide_String(1..40)    := "abcdefghijklmnopqrst" & 
                                                String_20;
      String_80      : Wide_String(1..80)    := String_40 & String_40;
      TC_String_5    : Wide_String(1..5)     := "ABCDE";

      -- The following strings are used in examination of the Translation
      -- subprograms.
      New_Character_String : Wide_String(1..12) :=
        Handling.To_Wide_String( 
          ACL1.LC_A_Grave          & ACL1.LC_A_Ring  & ACL1.LC_AE_Diphthong &
          ACL1.LC_C_Cedilla        & ACL1.LC_E_Acute & ACL1.LC_I_Circumflex &
          ACL1.LC_Icelandic_Eth    & ACL1.LC_N_Tilde & 
          ACL1.LC_O_Oblique_Stroke & ACL1.LC_Icelandic_Thorn & 
          ACL1.LC_German_Sharp_S   & ACL1.LC_Y_Diaeresis);  

      -- Note that there is no upper case version of the last two
      -- characters from above.
 
      TC_New_Character_String : Wide_String(1..12) :=
        Handling.To_Wide_String(
          ACL1.UC_A_Grave          & ACL1.UC_A_Ring  & ACL1.UC_AE_Diphthong &
          ACL1.UC_C_Cedilla        & ACL1.UC_E_Acute & ACL1.UC_I_Circumflex &
          ACL1.UC_Icelandic_Eth    & ACL1.UC_N_Tilde &
          ACL1.UC_O_Oblique_Stroke & ACL1.UC_Icelandic_Thorn &  
          ACL1.LC_German_Sharp_S   & ACL1.LC_Y_Diaeresis);  

      -- Access objects that will be provided as parameters to the 
      -- subprograms.
      Map_To_Lower_Case_Ptr : Wide_Maps.Wide_Character_Mapping_Function :=
                                CXA4025_0.Map_To_Lower_Case'Access;
      Map_To_Upper_Case_Ptr : Wide_Maps.Wide_Character_Mapping_Function :=
                                CXA4025_0.Map_To_Upper_Case'Access;

   begin

      -- 
      -- Testing of functionality found in Package Ada.Strings.Wide_Maps.
      -- 

      -- Load the alphabet strings for use in creating sets.
      for i in 0..25 loop
         Alphabet(i+1) := Wide_Character'Val(Wide_Character'Pos('a')+i);
      end loop;

      -- Initialize a series of Character_Set objects.
      Alphabet_Set    := Wide_Maps.To_Set(Alphabet);
      Vowel_Set       := Wide_Maps.To_Set(Vowels);
      Consonant_Set   := Vowel_Set  XOR  Alphabet_Set;

      -- Evaluation of Set operator "-".
      if 
         (Alphabet_Set - Consonant_Set) /=
                                  "AND"(Alphabet_Set, "NOT"(Consonant_Set)) or
         (Alphabet_Set - Vowel_Set) /= "AND"(Alphabet_Set, "NOT"(Vowel_Set)) 
      then
         Report.Failed("Incorrect result from ""-"" operator for sets");
      end if;

      -- Evaluation of Functions To_Domain and To_Range.
      declare
         Null_Sequence  : constant Wide_Maps.Wide_Character_Sequence := "";
         TC_UC_Sequence : constant Wide_Maps.Wide_Character_Sequence :=
                                     "ZYXWVUTSRQPONMABCDEFGHIJKL";
         TC_LC_Sequence : constant Wide_Maps.Wide_Character_Sequence :=
                                     "zyxwvutsrqponmabcdefghijkl";
         TC_Upper_to_Lower_Map  : Wide_Maps.Wide_Character_Mapping :=
                                    Wide_Maps.To_Mapping(TC_UC_Sequence,
                                                         TC_LC_Sequence);
         TC_Lower_to_Upper_Map  : Wide_Maps.Wide_Character_Mapping :=
                                    Wide_Maps.To_Mapping(TC_LC_Sequence,
                                                         TC_UC_Sequence);
      begin
         declare
            TC_Domain : constant Wide_Maps.Wide_Character_Sequence := 
                             Wide_Maps.To_Domain(TC_Upper_to_Lower_Map);
            TC_Range  : constant Wide_Maps.Wide_Character_Sequence :=
                             Wide_Maps.To_Range(TC_Lower_to_Upper_Map);
         begin
            -- Function To_Domain returns the shortest Wide_Character_Sequence
            -- value such that each wide character not in the result maps to
            -- itself, and all wide characters in the result are in ascending 
            -- order.
            if TC_Domain /= "ABCDEFGHIJKLMNOPQRSTUVWXYZ" then
               Report.Failed("Incorrect result from To_Domain with " &
                             "TC_Upper_to_Lower_Map as input");
            end if;

            -- The lower bound on the returned Wide_Character_Sequence value
            -- from To_Domain must be 1.
            if TC_Domain'First /= 1 then
               Report.Failed("Incorrect lower bound returned from To_Domain");
            end if;

            -- Check contents of result of To_Range.
            if TC_Range /= "ABCDEFGHIJKLMNOPQRSTUVWXYZ" then
               Report.Failed("Incorrect result from To_Range with " &
                             "TC_Lower_to_Upper_Map as input");
            end if;

            -- The lower bound on the returned Character_Sequence value
            -- must be 1.
            if TC_Range'First /= 1 then
               Report.Failed("Incorrect lower bound returned from To_Range");
            end if;

            if TC_Range'Last /= TC_LC_Sequence'Length then
               Report.Failed("Incorrect upper bound returned from To_Range");
            end if;
         end;

         -- Both function To_Domain and To_Range return the null string 
         -- when provided the Identity character map as an input parameter.
         if Wide_Maps.To_Domain(Wide_Maps.Identity) /= Null_Sequence or
            Wide_Maps.To_Range(Wide_Maps.Identity)  /= Null_Sequence 
         then
            Report.Failed("Null sequence not returned from To_Domain or " &
                          "To_Range when provided the Identity map as input");
         end if;
      exception
         when others => 
           Report.Failed("Exception raised during the evaluation of " &
                         "Function To_Domain and To_Range");
      end;

      -- Testing of functionality found in Package Ada.Strings.Wide_Fixed.
      -- 
      -- Function Index, Forward direction search.

      if Wide_Fixed.Index("CoMpLeTeLy MiXeD CaSe StRiNg",
                          "MIXED CASE STRING",
                          Ada.Strings.Forward,
                          Map_To_Upper_Case_Ptr)               /= 12 or
         Wide_Fixed.Index("STRING WITH NO MATCHING PATTERNS",
                          "WITH",
                          Ada.Strings.Forward,
                          Map_To_Lower_Case_Ptr)               /= 0  
      then
         Report.Failed("Incorrect results from Function Index, going "    &
                       "in Forward direction, using a Character Mapping " &
                       "Function parameter");
      end if;

      -- Function Index, Backward direction search.
      if Wide_Fixed.Index("Case of a Mixed Case String", 
                          "case", 
                          Ada.Strings.Backward,
                          Map_To_Lower_Case_Ptr)               /= 17   or
         Wide_Fixed.Index("WOULD MATCH BUT FOR THE CASE",
                          "WOULD MATCH BUT FOR THE CASE",
                          Ada.Strings.Backward,
                          Map_To_Lower_Case_Ptr)               /= 0
      then
         Report.Failed("Incorrect results from Function Index, going "     &
                       "in Backward direction, using a Character Mapping " &
                       "Function parameter");
      end if;

      -- Function Count.
      if Wide_Fixed.Count("ABABABA", "ABA",   Map_To_Upper_Case_Ptr) /= 2 or
         Wide_Fixed.Count("",        "match", Map_To_Lower_Case_Ptr) /= 0
      then
         Report.Failed("Incorrect results from Function Count, using " &
                       "a Character Mapping Function parameter");
      end if;

      -- Function Translate.
      if Wide_Fixed.Translate(Source  => "A Sample Mixed Case String",
                              Mapping => Map_To_Lower_Case_Ptr) /= 
         "a sample mixed case string"                             or
         Wide_Fixed.Translate(New_Character_String,
                              Map_To_Upper_Case_Ptr)            /=
         TC_New_Character_String
      then
         Report.Failed("Incorrect results from Function Translate, using " &
                       "a Wide_Character Mapping Function parameter");
      end if;

      -- Procedure Translate.
      declare
         use Ada.Strings.Wide_Fixed;
         Str : Wide_String(1..19) := "A Mixed Case String";
      begin
         Translate(Source => Str, Mapping => Map_To_Lower_Case_Ptr);
         if Str /= "a mixed case string" then
            Report.Failed("Incorrect result from Procedure Translate - 1");
         end if;

         Translate(New_Character_String, Map_To_Upper_Case_Ptr);
         if New_Character_String /= TC_New_Character_String then
            Report.Failed("Incorrect result from Procedure Translate - 2");
         end if;
      end;

      -- Procedure Trim.
      declare
         use Ada.Strings.Wide_Fixed;
         Trim_String : Wide_String(1..30) := "    A string of characters    ";
      begin
         Trim(Trim_String, Ada.Strings.Left, Ada.Strings.Right, 'x');
         if Trim_String /= "xxxxA string of characters    " then
            Report.Failed("Incorrect result from Procedure Trim, trim " &
                          "side = left, justify = right, pad = x");
         end if;

         Trim(Trim_String, Ada.Strings.Right, Ada.Strings.Center);
         if Trim_String /= "  xxxxA string of characters  " then
            Report.Failed("Incorrect result from Procedure Trim, trim " &
                          "side = right, justify = center, default pad");
         end if;
      end;

      -- Procedure Head.
      declare
         Fixed_String : Wide_String(1..20) := "A sample test string";
      begin
         Wide_Fixed.Head(Source => Fixed_String, Count => 14, 
                         Justify => Ada.Strings.Center, Pad => '$');
         if Fixed_String /= "$$$A sample test $$$" then
            Report.Failed("Incorrect result from Procedure Head, " &
                          "justify = center, pad = $");
         end if;

         Wide_Fixed.Head(Fixed_String, 11, Ada.Strings.Right);
         if Fixed_String /= "         $$$A sample" then
            Report.Failed("Incorrect result from Procedure Head, " &
                          "justify = right, default pad");
         end if;
      end;

      -- Procedure Tail.
      declare
         use Ada.Strings.Wide_Fixed;
         Tail_String : Wide_String(1..20) := "ABCDEFGHIJKLMNOPQRST";
      begin
         -- Default left justify.
         Tail(Source => Tail_String, Count => 10, Pad => '-'); 
         if Tail_String /= "KLMNOPQRST----------" then
            Report.Failed("Incorrect result from Procedure Tail, " &
                          "default justify, pad = -");
         end if;

         Tail(Tail_String, 6, Ada.Strings.Center, 'a');
         if Tail_String /= "aaaaaaa------aaaaaaa" then
            Report.Failed("Incorrect result from Procedure Tail, " &
                          "justify = center, pad = a");
         end if;
      end;

   exception
      when The_Error : others => 
         Report.Failed ("The following exception was raised in the " &
                        "Test_Block: " & Exception_Name(The_Error));
   end Test_Block;

   Report.Result;

end CXA4025;