gcc/ada/s-imgdec.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME COMPONENTS                          --
   4 --                                                                          --
   5 --                       S Y S T E M . I M G _ D E C                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2000 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,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, 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 --  Image for decimal fixed types where the size of the corresponding integer
  35 --  type does not exceed Integer'Size (also used for Text_IO.Decimal_IO output)
  36
  37 package System.Img_Dec is
  38 pragma Preelaborate (Img_Dec);
  39
  40    function Image_Decimal
  41      (V     : Integer;
  42       Scale : Integer)
  43       return  String;
  44    --  Compute 'Image of V, the integer value (in units of delta) of a decimal
  45    --  type whose Scale is as given and return the result. THe image is given
  46    --  by the rules in RM 3.5(34) for fixed-point type image functions.
  47
  48    procedure Set_Image_Decimal
  49      (V     : Integer;
  50       S     : out String;
  51       P     : in out Natural;
  52       Scale : Integer;
  53       Fore  : Natural;
  54       Aft   : Natural;
  55       Exp   : Natural);
  56    --  Sets the image of V, where V is the integer value (in units of delta)
  57    --  of a decimal type with the given Scale, starting at S (P + 1), updating
  58    --  P to point to the last character stored, the caller promises that the
  59    --  buffer is large enough and no check is made for this. Constraint_Error
  60    --  will not necessarily be raised if this requirement is violated, since
  61    --  it is perfectly valid to compile this unit with checks off. The Fore,
  62    --  Aft and Exp values can be set to any valid values for the case of use
  63    --  by Text_IO.Decimal_IO.
  64
  65    procedure Set_Decimal_Digits
  66      (Digs  : in out String;
  67       NDigs : Natural;
  68       S     : out String;
  69       P     : in out Natural;
  70       Scale : Integer;
  71       Fore  : Natural;
  72       Aft   : Natural;
  73       Exp   : Natural);
  74    --  This procedure has the same semantics as Set_Image_Decimal, except that
  75    --  the value in Digs (1 .. NDigs) is given as a string of decimal digits
  76    --  preceded by either a minus sign or a space (i.e. the integer image of
  77    --  the value in units of delta). The call may destroy the value in Digs,
  78    --  which is why Digs is in-out (this happens if rounding is required).
  79    --  Set_Decimal_Digits is shared by all the decimal image routines.
  80
  81 end System.Img_Dec;