gcc/ada/s-wchwts.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME COMPONENTS                          --
   4 --                                                                          --
   5 --                       S Y S T E M . W C H _ W T S                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                            $Revision: 1.7 $                              --
  10 --                                                                          --
  11 --          Copyright (C) 1992-1998 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  This package contains the routine used to convert wide strings to
  37 --  strings for use by wide character attributes (value, image etc.) and
  38 --  also by the numeric IO subpackages of Ada.Text_IO.Wide_Text_IO.
  39
  40 with System.WCh_Con;
  41
  42 package System.WCh_WtS is
  43 pragma Pure (WCh_WtS);
  44
  45    function Wide_String_To_String
  46      (S    : Wide_String;
  47       EM   : System.WCh_Con.WC_Encoding_Method)
  48       return String;
  49    --  This routine simply takes its argument and converts it to a string,
  50    --  using the internal compiler escape sequence convention (defined in
  51    --  package Widechar) to translate characters that are out of range
  52    --  of type String. In the context of the Wide_Value attribute, the
  53    --  argument is the original attribute argument, and the result is used
  54    --  in a call to the corresponding Value attribute function. If the method
  55    --  for encoding is a shift-in, shift-out convention, then it is assumed
  56    --  that normal (non-wide character) mode holds at the start and end of
  57    --  the result string. EM indicates the wide character encoding method.
  58    --  Note: in the WCEM_Brackets case, we only use the brackets encoding
  59    --  for characters greater than 16#FF#.
  60
  61 end System.WCh_WtS;