home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / adav313.zip / gnat-3_13p-os2-bin-20010916.zip / emx / gnatlib / s-valdec.ads < prev    next >
Text File  |  2000-07-19  |  5KB  |  85 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.3 $                              --
  10. --                                                                          --
  11. --   Copyright (C) 1992,1993,1994,1995,1996 Free Software Foundation, Inc.  --
  12. --                                                                          --
  13. -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14. -- terms of the  GNU General Public License as published  by the Free Soft- --
  15. -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16. -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17. -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18. -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19. -- for  more details.  You should have  received  a copy of the GNU General --
  20. -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21. -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22. -- MA 02111-1307, USA.                                                      --
  23. --                                                                          --
  24. -- As a special exception,  if other files  instantiate  generics from this --
  25. -- unit, or you link  this unit with other files  to produce an executable, --
  26. -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27. -- covered  by the  GNU  General  Public  License.  This exception does not --
  28. -- however invalidate  any other reasons why  the executable file  might be --
  29. -- covered by the  GNU Public License.                                      --
  30. --                                                                          --
  31. -- GNAT was originally developed  by the GNAT team at  New York University. --
  32. -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  33. --                                                                          --
  34. ------------------------------------------------------------------------------
  35.  
  36. --  This package contains routines for scanning decimal values where the size
  37. --  of the type is no greater than Standard.Integer'Size, for use in Text_IO.
  38. --  Decimal_IO, and the Value attribute for such decimal types.
  39.  
  40. package System.Val_Dec is
  41. pragma Pure (Val_Dec);
  42.  
  43.    function Scan_Decimal
  44.      (Str   : String;
  45.       Ptr   : access Integer;
  46.       Max   : Integer;
  47.       Scale : Integer)
  48.       return  Integer;
  49.    --  This function scans the string starting at Str (Ptr.all) for a valid
  50.    --  real literal according to the syntax described in (RM 3.5(43)). The
  51.    --  substring scanned extends no further than Str (Max). There are three
  52.    --  cases for the return:
  53.    --
  54.    --  If a valid real literal is found after scanning past any initial spaces,
  55.    --  then Ptr.all is updated past the last character of the literal (but
  56.    --  trailing spaces are not scanned out). The value returned is the value
  57.    --  Integer'Integer_Value (decimal-literal-value), using the given Scale
  58.    --  to determine this value.
  59.    --
  60.    --  If no valid real literal is found, then Ptr.all points either to an
  61.    --  initial non-digit character, or to Max + 1 if the field is all spaces
  62.    --  and the exception Constraint_Error is raised.
  63.    --
  64.    --  If a syntactically valid integer is scanned, but the value is out of
  65.    --  range, or, in the based case, the base value is out of range or there
  66.    --  is an out of range digit, then Ptr.all points past the integer, and
  67.    --  Constraint_Error is raised.
  68.    --
  69.    --  Note: these rules correspond to the requirements for leaving the
  70.    --  pointer positioned in Text_Io.Get
  71.    --
  72.    --  Note: if Str is null, i.e. if Max is less than Ptr, then this is a
  73.    --  special case of an all-blank string, and Ptr is unchanged, and hence
  74.    --  is greater than Max as required in this case.
  75.  
  76.    function Value_Decimal (Str : String; Scale : Integer) return Integer;
  77.    --  Used in computing X'Value (Str) where X is a decimal types whose size
  78.    --  does not exceed Standard.Integer'Size. Str is the string argument of
  79.    --  the attribute. Constraint_Error is raised if the string is malformed
  80.    --  or if the value is out of range, otherwise the value returned is the
  81.    --  value Integer'Integer_Value (decimal-literal-value), using the given
  82.    --  Scale to determine this value.
  83.  
  84. end System.Val_Dec;
  85.