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 / i-pacdec.ads < prev    next >
Text File  |  1996-09-28  |  7KB  |  142 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --            I N T E R F A C E S . P A C K E D _ D E C I M A L             --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --            (Version for IBM Mainframe Packed Decimal Format)             --
  9. --                                                                          --
  10. --                            $Revision: 1.2 $                              --
  11. --                                                                          --
  12. -- The GNAT library is free software; you can redistribute it and/or modify --
  13. -- it under terms of the GNU Library General Public License as published by --
  14. -- the Free Software  Foundation; either version 2, or (at your option) any --
  15. -- later version.  The GNAT library is distributed in the hope that it will --
  16. -- be useful, but WITHOUT ANY WARRANTY;  without even  the implied warranty --
  17. -- of MERCHANTABILITY  or  FITNESS FOR  A PARTICULAR PURPOSE.  See the  GNU --
  18. -- Library  General  Public  License for  more  details.  You  should  have --
  19. -- received  a copy of the GNU  Library  General Public License  along with --
  20. -- the GNAT library;  see the file  COPYING.LIB.  If not, write to the Free --
  21. -- Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.        --
  22. --                                                                          --
  23. ------------------------------------------------------------------------------
  24.  
  25. --  This unit defines the packed decimal format used by GNAT in response to
  26. --  a specication of Machine_Radix 10 for a decimal fixed-point type. The
  27. --  format and operations are completely encapsulated in this unit, so all
  28. --  that is necessary to compile using different packed decimal formats is
  29. --  to replace this single unit.
  30.  
  31. --  Note that the compiler access the spec of this unit during compilation
  32. --  to obtain the data length that needs allocating, so the correct version
  33. --  of the spec must be available to the compiler, and must correspond to
  34. --  the spec and body made available to the linker, and all units of a given
  35. --  program must be compiled with the same version of the spec and body.
  36. --  This consistency will be enforced automatically using the normal binder
  37. --  consistency checking, since any unit declaring Machine_Radix 10 types or
  38. --  containing operations on such data will implicitly with Packed_Decimal.
  39.  
  40. with System;
  41.  
  42. package Interfaces.Packed_Decimal is
  43.  
  44.    ------------------------
  45.    -- Format Description --
  46.    ------------------------
  47.  
  48.    --  IBM Mainframe packed decimal format uses a byte string of length one
  49.    --  to 10 bytes, with the most significant byte first. Each byte contains
  50.    --  two decimal digits (with the high order digit in the left nibble, and
  51.    --  the low order four bits contain the sign, using the following code:
  52.  
  53.    --     16#A#  2#1010#   positive
  54.    --     16#B#  2#1011#   negative
  55.    --     16#C#  2#1100#   positive (preferred representation)
  56.    --     16#D#  2#1101#   negative (preferred representation)
  57.    --     16#E#  2#1110#   positive
  58.    --     16#F#  2#1011#   positive
  59.  
  60.    --  In this package, all six sign representations are interpreted as
  61.    --  shown above when an operand is read, when an operand is written,
  62.    --  the preferred representations are always used. Constraint_Error
  63.    --  is raised if any other bit pattern is found in the sign nibble,
  64.    --  or if a digit nibble contains an invalid digit code.
  65.  
  66.    --  Some examples follow:
  67.  
  68.    --     05 76 3C      +5763
  69.    --     00 01 1D        -11
  70.    --     00 04 4E        +44 (non-standard sign)
  71.    --     00 00 00      invalid (incorrect sign nibble)
  72.    --     0A 01 1C      invalid (bad digit)
  73.  
  74.    ------------------
  75.    -- Length Array --
  76.    ------------------
  77.  
  78.    --  The following array must be declared in exactly the form shown, since
  79.    --  the compiler accesses the associated tree to determine the size to be
  80.    --  allocated to a machine radix 10 type, depending on the number of digits.
  81.  
  82.    subtype Byte_Length is Positive range 1 .. 10;
  83.    --  Range of possible byte lengths
  84.  
  85.    Packed_Size : constant array (1 .. 18) of Byte_Length :=
  86.       (01 => 01,    -- Length in bytes for digits 1
  87.        02 => 02,    -- Length in bytes for digits 2
  88.        03 => 02,    -- Length in bytes for digits 2
  89.        04 => 03,    -- Length in bytes for digits 2
  90.        05 => 03,    -- Length in bytes for digits 2
  91.        06 => 04,    -- Length in bytes for digits 2
  92.        07 => 04,    -- Length in bytes for digits 2
  93.        08 => 05,    -- Length in bytes for digits 2
  94.        09 => 05,    -- Length in bytes for digits 2
  95.        10 => 06,    -- Length in bytes for digits 2
  96.        11 => 06,    -- Length in bytes for digits 2
  97.        12 => 07,    -- Length in bytes for digits 2
  98.        13 => 07,    -- Length in bytes for digits 2
  99.        14 => 08,    -- Length in bytes for digits 2
  100.        15 => 08,    -- Length in bytes for digits 2
  101.        16 => 09,    -- Length in bytes for digits 2
  102.        17 => 09,    -- Length in bytes for digits 2
  103.        18 => 10);   -- Length in bytes for digits 2
  104.  
  105.    -------------------------
  106.    -- Conversion Routines --
  107.    -------------------------
  108.  
  109.    subtype D32 is Positive range 1 .. 9;
  110.    --  Used to represent number of digits in a packed decimal value that
  111.    --  can be represented in a 32-bit binary signed integer form.
  112.  
  113.    subtype D64 is Positive range 10 .. 18;
  114.    --  Used to represent number of digits in a packed decimal value that
  115.    --  requires a 64-bit signed binary integer for representing all values.
  116.  
  117.    function Packed_To_Int32 (P : System.Address; D : D32) return Integer_32;
  118.    --  The argument P is the address of a packed decimal value and D is the
  119.    --  number of digits (in the range 1 .. 9, as implied by the subtype).
  120.    --  The returned result is the corresponding signed binary value. The
  121.    --  exception Constraint_Error is raised if the input is invalid.
  122.  
  123.    function Packed_To_Int64 (P : System.Address; D : D64) return Integer_64;
  124.    --  The argument P is the address of a packed decimal value and D is the
  125.    --  number of digits (in the range 10 .. 18, as implied by the subtype).
  126.    --  The returned result is the corresponding signed binary value. The
  127.    --  exception Constraint_Error is raised if the input is invalid.
  128.  
  129.    procedure Int32_To_Packed (V : Integer_32; P : System.Address; D : D32);
  130.    --  The argument V is a signed binary integer, which is converted to
  131.    --  packed decimal format and stored using P, the address of a packed
  132.    --  decimal item of D digits (D is in the range 1-9). Constraint_Error
  133.    --  is raised if V is out of range of this number of digits.
  134.  
  135.    procedure Int64_To_Packed (V : Integer_64; P : System.Address; D : D64);
  136.    --  The argument V is a signed binary integer, which is converted to
  137.    --  packed decimal format and stored using P, the address of a packed
  138.    --  decimal item of D digits (D is in the range 10-18). Constraint_Error
  139.    --  is raised if V is out of range of this number of digits.
  140.  
  141. end Interfaces.Packed_Decimal;
  142.