gcc/ada/s-imgrea.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                      S Y S T E M . I M G _ R E A L                       --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2007, 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 --  Image for fixed and float types (also used for Float_IO/Fixed_IO output)
  35
  36 package System.Img_Real is
  37    pragma Pure;
  38
  39    procedure Image_Ordinary_Fixed_Point
  40      (V   : Long_Long_Float;
  41       S   : in out String;
  42       P   : out Natural;
  43       Aft : Natural);
  44    --  Computes fixed_type'Image (V) and returns the result in S (1 .. P)
  45    --  updating P on return. The result is computed according to the rules for
  46    --  image for fixed-point types (RM 3.5(34)), where Aft is the value of the
  47    --  Aft attribute for the fixed-point type. This function is used only for
  48    --  ordinary fixed point (see package System.Img_Dec for handling of decimal
  49    --  fixed-point). The caller guarantees that S is long enough to hold the
  50    --  result and has a lower bound of 1.
  51
  52    procedure Image_Floating_Point
  53      (V    : Long_Long_Float;
  54       S    : in out String;
  55       P    : out Natural;
  56       Digs : Natural);
  57    --  Computes fixed_type'Image (V) and returns the result in S (1 .. P)
  58    --  updating P on return. The result is computed according to the rules for
  59    --  image for floating-point types (RM 3.5(33)), where Digs is the value of
  60    --  the Digits attribute for the floating-point type. The caller guarantees
  61    --  that S is long enough to hold the result and has a lower bound of 1.
  62
  63    procedure Set_Image_Real
  64      (V    : Long_Long_Float;
  65       S    : out String;
  66       P    : in out Natural;
  67       Fore : Natural;
  68       Aft  : Natural;
  69       Exp  : Natural);
  70    --  Sets the image of V starting at S (P + 1), updating P to point to the
  71    --  last character stored, the caller promises that the buffer is large
  72    --  enough and no check is made for this. Constraint_Error will not
  73    --  necessarily be raised if this is violated, since it is perfectly valid
  74    --  to compile this unit with checks off). The Fore, Aft and Exp values
  75    --  can be set to any valid values for the case of use from Text_IO. Note
  76    --  that no space is stored at the start for non-negative values.
  77
  78 end System.Img_Real;