gcc/ada/libgnat/s-wchwts.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . W C H _ W T S                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2019, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  17 --                                                                          --
  18 -- As a special exception under Section 7 of GPL version 3, you are granted --
  19 -- additional permissions described in the GCC Runtime Library Exception,   --
  20 -- version 3.1, as published by the Free Software Foundation.               --
  21 --                                                                          --
  22 -- You should have received a copy of the GNU General Public License and    --
  23 -- a copy of the GCC Runtime Library Exception along with this program;     --
  24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  25 -- <http://www.gnu.org/licenses/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  32 --  This package contains the routine used to convert wide strings and wide
  33 --  wide strings to strings for use by wide and wide wide character attributes
  34 --  (value, image etc.) and also by the numeric IO subpackages of
  35 --  Ada.Text_IO.Wide_Text_IO and Ada.Text_IO.Wide_Wide_Text_IO.
  36
  37 with System.WCh_Con;
  38
  39 package System.WCh_WtS is
  40    pragma Pure;
  41
  42    function Wide_String_To_String
  43      (S  : Wide_String;
  44       EM : System.WCh_Con.WC_Encoding_Method) return String;
  45    --  This routine simply takes its argument and converts it to a string,
  46    --  using the internal compiler escape sequence convention (defined in
  47    --  package Widechar) to translate characters that are out of range
  48    --  of type String. In the context of the Wide_Value attribute, the
  49    --  argument is the original attribute argument, and the result is used
  50    --  in a call to the corresponding Value attribute function. If the method
  51    --  for encoding is a shift-in, shift-out convention, then it is assumed
  52    --  that normal (non-wide character) mode holds at the start and end of
  53    --  the result string. EM indicates the wide character encoding method.
  54    --  Note: in the WCEM_Brackets case, we only use the brackets encoding
  55    --  for characters greater than 16#FF#. The lowest index of the returned
  56    --  String is equal to S'First.
  57
  58    function Wide_Wide_String_To_String
  59      (S  : Wide_Wide_String;
  60       EM : System.WCh_Con.WC_Encoding_Method) return String;
  61    --  Same processing, except for Wide_Wide_String
  62
  63 end System.WCh_WtS;