gcc/ada/s-wchcon.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . W C H _ C O N                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2006, 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 defines the codes used to identify the encoding method for
  35 --  wide characters in string and character constants. This is needed both
  36 --  at compile time and at runtime (for the wide character runtime routines)
  37
  38 --  This unit may be used directly from an application program by providing
  39 --  an appropriate WITH, and the interface can be expected to remain stable.
  40
  41 package System.WCh_Con is
  42    pragma Pure;
  43
  44    -------------------------------------
  45    -- Wide_Character Encoding Methods --
  46    -------------------------------------
  47
  48    --  A wide character encoding method is a method for uniquely representing
  49    --  a Wide_Character or Wide_Wide_Character value using a one or more
  50    --  Character values. Three types of encoding method are supported by GNAT:
  51
  52    --    An escape encoding method uses ESC as the first character of the
  53    --    sequence, and subsequent characters determine the wide character
  54    --    value that is represented. Any character other than ESC stands
  55    --    for itself as a single byte (i.e. any character in Latin-1, other
  56    --    than ESC itself, is represented as a single character: itself).
  57
  58    --    An upper half encoding method uses a character in the upper half
  59    --    range (i.e. in the range 16#80# .. 16#FF#) as the first byte of
  60    --    a wide character encoding sequence. Subsequent characters are
  61    --    used to determine the wide character value that is represented.
  62    --    Any character in the lower half (16#00# .. 16#7F#) represents
  63    --    itself as a single character.
  64
  65    --    The brackets notation, where a wide character is represented by the
  66    --    sequence ["xx"] or ["xxxx"] or ["xxxxxx"] where xx are hexadecimal
  67    --    characters. Note that currently this is the only encoding that
  68    --    supports the full UTF-32 range.
  69
  70    --  Note that GNAT does not currently support escape-in, escape-out
  71    --  encoding methods, where an escape sequence is used to set a mode
  72    --  used to recognize subsequent characters. All encoding methods use
  73    --  individual character-by-character encodings, so that a sequence of
  74    --  wide characters is represented by a sequence of encodings.
  75
  76    --  To add new encoding methods, the following steps are required:
  77
  78    --     1.  Define a code for a new value of type WC_Encoding_Method
  79    --     2.  Adjust the definition of WC_Encoding_Method accordingly
  80    --     3.  Provide appropriate conversion routines in System.Wch_Cnv
  81    --     4.  Adjust definition of WC_Longest_Sequence if necessary
  82    --     5.  Add an entry in WC_Encoding_Letters for the new method
  83    --     6.  Add proper code to s-wchstw.adb, s-wchwts.adb, s-widwch.adb
  84    --     7.  Update documentation (remember section on form strings)
  85
  86    --  Note that the WC_Encoding_Method values must be kept ordered so that
  87    --  the definitions of the subtypes WC_Upper_Half_Encoding_Method and
  88    --  WC_ESC_Encoding_Method are still correct.
  89
  90    ---------------------------------
  91    -- Encoding Method Definitions --
  92    ---------------------------------
  93
  94    type WC_Encoding_Method is range 1 .. 6;
  95    --  Type covering the range of values used to represent wide character
  96    --  encoding methods. An enumeration type might be a little neater, but
  97    --  more trouble than it's worth, given the need to pass these values
  98    --  from the compiler to the backend, and to record them in the ALI file.
  99
 100    WCEM_Hex : constant WC_Encoding_Method := 1;
 101    --  The wide character with code 16#abcd# is represented by the escape
 102    --  sequence ESC a b c d (five characters, where abcd are ASCII hex
 103    --  characters, using upper case for letters). This method is easy
 104    --  to deal with in external environments that do not support wide
 105    --  characters, and covers the whole BMP. This is the default encoding
 106    --  method.
 107
 108    WCEM_Upper : constant WC_Encoding_Method := 2;
 109    --  The wide character with encoding 16#abcd#, where the upper bit is on
 110    --  (i.e. a is in the range 8-F) is represented as two bytes 16#ab# and
 111    --  16#cd#. The second byte may never be a format control character, but
 112    --  is not required to be in the upper half. This method can be also used
 113    --  for shift-JIS or EUC where the internal coding matches the external
 114    --  coding.
 115
 116    WCEM_Shift_JIS : constant WC_Encoding_Method := 3;
 117    --  A wide character is represented by a two character sequence 16#ab#
 118    --  and 16#cd#, with the restrictions described for upper half encoding
 119    --  as described above. The internal character code is the corresponding
 120    --  JIS character according to the standard algorithm for Shift-JIS
 121    --  conversion. See the body of package System.JIS_Conversions for
 122    --  further details.
 123
 124    WCEM_EUC : constant WC_Encoding_Method := 4;
 125    --  A wide character is represented by a two character sequence 16#ab# and
 126    --  16#cd#, with both characters being in the upper half set. The internal
 127    --  character code is the corresponding JIS character according to the EUC
 128    --  encoding algorithm. See the body of package System.JIS_Conversions for
 129    --  further details.
 130
 131    WCEM_UTF8 : constant WC_Encoding_Method := 5;
 132    --  An ISO 10646-1 BMP/Unicode wide character is represented in
 133    --  UCS Transformation Format 8 (UTF-8) as defined in Annex R of ISO
 134    --  10646-1/Am.2.  Depending on the character value, a Unicode character
 135    --  is represented as the one to six byte sequence.
 136    --
 137    --    16#0000_0000#-16#0000_007f#: 2#0xxxxxxx#
 138    --    16#0000_0080#-16#0000_07ff#: 2#110xxxxx# 2#10xxxxxx#
 139    --    16#0000_0800#-16#0000_ffff#: 2#1110xxxx# 2#10xxxxxx# 2#10xxxxxx#
 140    --    16#0001_0000#-16#001F_FFFF#: 2#11110xxx# 2#10xxxxxx# 2#10xxxxxx#
 141    --                                 2#10xxxxxx#
 142    --    16#0020_0000#-16#03FF_FFFF#: 2#111110xx# 2#10xxxxxx# 2#10xxxxxx#
 143    --                                 2#10xxxxxx# 2#10xxxxxx#
 144    --    16#0400_0000#-16#7FFF_FFFF#: 2#1111110x# 2#10xxxxxx# 2#10xxxxxx#
 145    --                                 2#10xxxxxx# 2#10xxxxxx# 2#10xxxxxx#
 146    --
 147    --  where the xxx bits correspond to the left-padded bits of the
 148    --  16-bit character value. Note that all lower half ASCII characters
 149    --  are represented as ASCII bytes and all upper half characters and
 150    --  other wide characters are represented as sequences of upper-half.
 151
 152    WCEM_Brackets : constant WC_Encoding_Method := 6;
 153    --  A wide character is represented using one of the following sequences:
 154    --
 155    --    ["xx"]
 156    --    ["xxxx"]
 157    --    ["xxxxxx"]
 158    --    ["xxxxxxxx"]
 159    --
 160    --  where xx are hexadecimal digits representing the character code.
 161
 162    WC_Encoding_Letters : constant array (WC_Encoding_Method) of Character :=
 163      (WCEM_Hex       => 'h',
 164       WCEM_Upper     => 'u',
 165       WCEM_Shift_JIS => 's',
 166       WCEM_EUC       => 'e',
 167       WCEM_UTF8      => '8',
 168       WCEM_Brackets  => 'b');
 169    --  Letters used for selection of wide character encoding method in the
 170    --  compiler options (-gnatW? switch) and for Wide_Text_IO (WCEM parameter
 171    --  in the form string).
 172
 173    subtype WC_ESC_Encoding_Method is
 174      WC_Encoding_Method range WCEM_Hex .. WCEM_Hex;
 175    --  Encoding methods using an ESC character at the start of the sequence
 176
 177    subtype WC_Upper_Half_Encoding_Method is
 178      WC_Encoding_Method range WCEM_Upper .. WCEM_UTF8;
 179    --  Encoding methods using an upper half character (16#80#..16#FF) at
 180    --  the start of the sequence.
 181
 182    WC_Longest_Sequence : constant := 10;
 183    --  The longest number of characters that can be used for a wide character
 184    --  or wide wide character sequence for any of the active encoding methods.
 185
 186    function Get_WC_Encoding_Method (C : Character) return WC_Encoding_Method;
 187    --  Given a character C, returns corresponding encoding method (see array
 188    --  WC_Encoding_Letters above). Raises Constraint_Error if not in list.
 189
 190    function Get_WC_Encoding_Method (S : String) return WC_Encoding_Method;
 191    --  Given a lower case string that is one of hex, upper, shift_jis, euc,
 192    --  utf8, brackets, return the corresponding encoding method. Raises
 193    --  Constraint_Error if not in list.
 194
 195 end System.WCh_Con;