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-valdec.ads < prev    next >
Text File  |  1996-09-28  |  4KB  |  75 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                       S Y S T E M . V A L _ D E C                        --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.1 $                              --
  10. --                                                                          --
  11. --        Copyright (c) 1992,1993,1994,1995 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 contains routines for scanning decimal values where the size
  27. --  of the type is no greater than Standard.Integer'Size, for use in Text_IO.
  28. --  Decimal_IO, and the Value attribute for such decimal types.
  29.  
  30. package System.Val_Dec is
  31. pragma Pure (Val_Dec);
  32.  
  33.    function Scan_Decimal
  34.      (Str   : String;
  35.       Ptr   : access Positive'Base;
  36.       Max   : Positive'Base;
  37.       Scale : Integer)
  38.       return  Integer;
  39.    --  This function scans the string starting at Str (Ptr.all) for a valid
  40.    --  real literal according to the syntax described in (RM 3.5(43)). The
  41.    --  substring scanned extends no further than Str (Max). There are three
  42.    --  cases for the return:
  43.    --
  44.    --  If a valid real literal is found after scanning past any initial spaces,
  45.    --  then Ptr.all is updated past the last character of the literal (but
  46.    --  trailing spaces are not scanned out). The value returned is the value
  47.    --  Integer'Integer_Value (decimal-literal-value), using the given Scale
  48.    --  to determine this value.
  49.    --
  50.    --  If no valid real literal is found, then Ptr.all points either to an
  51.    --  initial non-digit character, or to Max + 1 if the field is all spaces
  52.    --  and the exception Constraint_Error is raised.
  53.    --
  54.    --  If a syntactically valid integer is scanned, but the value is out of
  55.    --  range, or, in the based case, the base value is out of range or there
  56.    --  is an out of range digit, then Ptr.all points past the integer, and
  57.    --  Constraint_Error is raised.
  58.    --
  59.    --  Note: these rules correspond to the requirements for leaving the
  60.    --  pointer positioned in Text_Io.Get
  61.    --
  62.    --  Note: if Str is null, i.e. if Max is less than Ptr, then this is a
  63.    --  special case of an all-blank string, and Ptr is unchanged, and hence
  64.    --  is greater than Max as required in this case.
  65.  
  66.    function Value_Decimal (Str : String; Scale : Integer) return Integer;
  67.    --  Used in computing X'Value (Str) where X is a decimal types whose size
  68.    --  does not exceed Standard.Integer'Size. Str is the string argument of
  69.    --  the attribute. Constraint_Error is raised if the string is malformed
  70.    --  or if the value is out of range, otherwise the value returned is the
  71.    --  value Integer'Integer_Value (decimal-literal-value), using the given
  72.    --  Scale to determine this value.
  73.  
  74. end System.Val_Dec;
  75.