home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / s-wchcon.ads < prev    next >
Text File  |  1996-09-28  |  8KB  |  155 lines
  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. --                            $Revision: 1.5 $                              --
  10. --                                                                          --
  11. --           Copyright (c) 1992,1993,1994 NYU, All Rights Reserved          --
  12. --                                                                          --
  13. -- The GNAT library is free software; you can redistribute it and/or modify --
  14. -- it under terms of the GNU Library General Public License as published by --
  15. -- the Free Software  Foundation; either version 2, or (at your option) any --
  16. -- later version.  The GNAT library is distributed in the hope that it will --
  17. -- be useful, but WITHOUT ANY WARRANTY;  without even  the implied warranty --
  18. -- of MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See the  GNU --
  19. -- Library  General  Public  License for  more  details.  You  should  have --
  20. -- received  a copy of the GNU  Library  General Public License  along with --
  21. -- the GNAT library;  see the file  COPYING.LIB.  If not, write to the Free --
  22. -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.        --
  23. --                                                                          --
  24. ------------------------------------------------------------------------------
  25.  
  26. --  This package defines the codes used to identify the encoding method for
  27. --  wide characters in string and character constants. This is needed both
  28. --  at compile time and at runtime (for the wide character runtime routines)
  29.  
  30. package System.WCh_Con is
  31. pragma Pure (WCh_Con);
  32.  
  33.    -------------------------------------
  34.    -- Wide_Character Encoding Methods --
  35.    -------------------------------------
  36.  
  37.    --  A wide character encoding method is a method for uniquely representing
  38.    --  a Wide_Character value using a one or more Character values. Two types
  39.    --  of encoding method are supported by GNAT:
  40.  
  41.    --    An escape encoding method uses ESC as the first character of the
  42.    --    sequence, and subsequent characters determine the wide character
  43.    --    value that is represented. Any character other than ESC stands
  44.    --    for itself as a single byte (i.e. any character in Latin-1, other
  45.    --    than ESC itself, is represented as a single character: itself).
  46.  
  47.    --    An upper half encoding method uses a character in the upper half
  48.    --    range (i.e. in the range 16#80# .. 16#FF#) as the first byte of
  49.    --    a wide character encoding sequence. Subsequent characters are
  50.    --    used to determine the wide character value that is represented.
  51.    --    Any character in the lower half (16#00# .. 16#7F#) represents
  52.    --    itself as a single character.
  53.  
  54.    --  Note that GNAT does not currently support escape-in, escape-out
  55.    --  encoding methods, where an escape sequence is used to set a mode
  56.    --  used to recognize subsequent characters. All encoding methods use
  57.    --  individual character-by-character encodings, so that a sequence of
  58.    --  wide characters is represented by a sequence of encodings.
  59.  
  60.    --  To add new encoding methods, the following steps are required:
  61.  
  62.    --     1.  Define a code for a new value of type WC_Encoding_Method
  63.    --     2.  Adjust the definition of WC_Encoding_Method accordingly
  64.    --     3.  Provide appropriate conversion routines in System.Wch_Cnv
  65.    --     4.  Adjust definition of WC_Longest_Sequence if necessary
  66.    --     5.  Add an entry in WC_Encoding_Letters for the new method
  67.  
  68.    --  Note that the WC_Encoding_Method values must be kept ordered so that
  69.    --  the definitions of the subtypes WC_Upper_Half_Encoding_Method and
  70.    --  WC_ESC_Encoding_Method are still correct.
  71.  
  72.    --------------------------------
  73.    -- Compatibility Requirements --
  74.    --------------------------------
  75.  
  76.    --  When a unit is compiled with a particular option, any units that it
  77.    --  with's are compiled with the same setting. Basically this means that
  78.    --  all units in a program which contain wide character encodings must
  79.    --  use a consistent encoding method. At bind time, the binder checks
  80.    --  that all units in the program are either compiled in WCEM_None mode,
  81.    --  meaning that they have no wide character encodings, or that they are
  82.    --  compiled in a consistent mode. It is not permitted to mix two modes
  83.    --  (other than WCEM_None) in a single program.
  84.  
  85.    ---------------------------------
  86.    -- Encoding Method Definitions --
  87.    ---------------------------------
  88.  
  89.    type WC_Encoding_Method is range 0 .. 4;
  90.    --  Type covering the range of values used to represent wide character
  91.    --  encoding methods. An enumeration type might be a little neater, but
  92.    --  more trouble than it's worth, given the need to pass these values
  93.    --  from the compiler to the backend, and to record them in the ALI file.
  94.  
  95.    WCEM_None : constant WC_Encoding_Method := 0;
  96.    --       No wide character encoding is permitted in the source program.
  97.    --       This is the default. A unit compiled with this option can be
  98.    --       used with units compiled with any other option.
  99.  
  100.    WCEM_Hex : constant WC_Encoding_Method := 1;
  101.    --       The wide character with code 16#abcd# is represented by the
  102.    --       escape sequence ESC a b c d (five characters, where abcd are
  103.    --       ASCII hex characters, using upper case for letters). This
  104.    --       method is easy to deal with in external environments that do
  105.    --       not support wide characters, and covers the whole BMP. This
  106.    --       is the default encoding method.
  107.  
  108.    WCEM_Upper : constant WC_Encoding_Method := 2;
  109.    --       The wide character with encoding 16#abcd#, where the upper bit
  110.    --       is on (i.e. a is in the range 8-F) is represented as two bytes
  111.    --       16#ab# and 16#cd#. The second byte may never be a format control
  112.    --       character, but is not required to be in the upper half. This
  113.    --       method can be also used for shift-JIS or EUC where the internal
  114.    --       coding matches the external coding.
  115.  
  116.    WCEM_Shift_JIS : constant WC_Encoding_Method := 3;
  117.    --       A wide character is represented by a two character sequence
  118.    --       16#ab# and 16#cd#, with the restrictions described for upper
  119.    --       half encoding as described above. The internal character code
  120.    --       is the corresponding JIS character according to the standard
  121.    --       algorithm for Shift-JIS conversion. See the body of package
  122.    --       System.JIS_Conversions for further details.
  123.  
  124.    WCEM_EUC : constant WC_Encoding_Method := 4;
  125.    --       A wide character is represented by a two character sequence
  126.    --       16#ab# and 16#cd#, with both characters being in the upper half.
  127.    --       The internal character code is the corresponding JIS character
  128.    --       according to the EUC encoding algorithm. See the body of package
  129.    --       System.JIS_Conversions for further details.
  130.  
  131.    WC_Encoding_Letters : constant array (WC_Encoding_Method) of Character :=
  132.      (WCEM_None      => 'n',
  133.       WCEM_Hex       => 'h',
  134.       WCEM_Upper     => 'u',
  135.       WCEM_Shift_JIS => 's',
  136.       WCEM_EUC       => 'e');
  137.    --  Letters used for selection of wide character encoding method in the
  138.    --  compiler options (-gnatj? switch) and for Wide_Text_IO (wcem parameter
  139.    --  in the form string).
  140.  
  141.    subtype WC_ESC_Encoding_Method is
  142.      WC_Encoding_Method range WCEM_Hex .. WCEM_Hex;
  143.    --  Encoding methods using an ESC character at the start of the sequence.
  144.  
  145.    subtype WC_Upper_Half_Encoding_Method is
  146.      WC_Encoding_Method range WCEM_Upper .. WCEM_EUC;
  147.    --  Encoding methods using an upper half character (16#80#..16#FF) at
  148.    --  the start of the sequence.
  149.  
  150.    WC_Longest_Sequence : constant := 5;
  151.    --  The longest number of characters that can be used for a wide
  152.    --  character sequence for any of the active encoding methods.
  153.  
  154. end System.WCh_Con;
  155.