1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- S Y S T E M . W C H _ S T W --
9 -- Copyright (C) 1992-2007, Free Software Foundation, Inc. --
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. --
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. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 -- This package contains the routine used to convert strings to wide (wide)
35 -- strings for use by wide (wide) image attribute.
39 package System.WCh_StW is
42 procedure String_To_Wide_String
46 EM : System.WCh_Con.WC_Encoding_Method);
47 -- This routine simply takes its argument and converts it to wide string
48 -- format, storing the result in R (1 .. L), with L being set appropriately
49 -- on return. The caller guarantees that R is long enough to accomodate the
50 -- result. This is used in the context of the Wide_Image attribute, where
51 -- the argument is the corresponding 'Image attribute. Any wide character
52 -- escape sequences in the string are converted to the corresponding wide
53 -- character value. No syntax checks are made, it is assumed that any such
54 -- sequences are validly formed (this must be assured by the caller), and
55 -- results from the fact that Wide_Image is only used on strings that have
56 -- been built by the compiler, such as images of enumeration literals. If
57 -- the method for encoding is a shift-in, shift-out convention, then it is
58 -- assumed that normal (non-wide character) mode holds at the start and end
59 -- of the argument string. EM indicates the wide character encoding method.
60 -- Note: in the WCEM_Brackets case, the brackets escape sequence is used
61 -- only for codes greater than 16#FF#.
63 procedure String_To_Wide_Wide_String
65 R : out Wide_Wide_String;
67 EM : System.WCh_Con.WC_Encoding_Method);
68 -- Same function with Wide_Wide_String output