gcc/ada/s-wchstw.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . W C H _ S T W                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2005 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 2,  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.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  This package contains the routine used to convert strings to wide (wide)
  35 --  strings for use by wide (wide) character attributes (value, image etc.)
  36
  37 with System.WCh_Con;
  38
  39 package System.WCh_StW is
  40 pragma Pure (WCh_StW);
  41
  42    function String_To_Wide_String
  43      (S  : String;
  44       EM : System.WCh_Con.WC_Encoding_Method) return Wide_String;
  45    --  This routine simply takes its argument and converts it to wide string
  46    --  format. In the context of the Wide_Image attribute, the argument is
  47    --  the corresponding 'Image attribute. Any wide character escape sequences
  48    --  in the string are converted to the corresponding wide character value.
  49    --  No syntax checks are made, it is assumed that any such sequences are
  50    --  validly formed (this must be assured by the caller), and results from
  51    --  the fact that Wide_Image is only used on strings that have been built
  52    --  by the compiler, such as images of enumeration literals. If the method
  53    --  for encoding is a shift-in, shift-out convention, then it is assumed
  54    --  that normal (non-wide character) mode holds at the start and end of
  55    --  the argument string. EM indicates the wide character encoding method.
  56    --  Note: in the WCEM_Brackets case, the brackets escape sequence is used
  57    --  only for codes greater than 16#FF#.
  58
  59    function String_To_Wide_Wide_String
  60      (S  : String;
  61       EM : System.WCh_Con.WC_Encoding_Method) return Wide_Wide_String;
  62    --  Same function with Wide_Wide_String output
  63
  64 end System.WCh_StW;