home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / lib / gcc-lib / m68k-amigaos / 2.7.2.1 / adainclude / s-valint.ads < prev    next >
Encoding:
Text File  |  1995-10-17  |  3.7 KB  |  69 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                       S Y S T E M . V A L _ I N T                        --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.7 $                              --
  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 signed Integer values for use
  27. --  in Text_IO.Integer_IO, and the Value attribute.
  28.  
  29. package System.Val_Int is
  30. pragma Pure (Val_Int);
  31.  
  32.    function Scan_Integer
  33.      (Str  : String;
  34.       Ptr  : access Positive'Base;
  35.       Max  : Positive'Base)
  36.       return Integer;
  37.    --  This function scans the string starting at Str (Ptr.all) for a valid
  38.    --  integer according to the syntax described in (RM 3.5(43)). The substring
  39.    --  scanned extends no further than Str (Max). There are three cases for the
  40.    --  return:
  41.    --
  42.    --  If a valid integer is found after scanning past any initial spaces, then
  43.    --  Ptr.all is updated past the last character of the integer (but trailing
  44.    --  spaces are not scanned out).
  45.    --
  46.    --  If no valid integer is found, then Ptr.all points either to an initial
  47.    --  non-digit character, or to Max + 1 if the field is all spaces and the
  48.    --  exception Constraint_Error is raised.
  49.    --
  50.    --  If a syntactically valid integer is scanned, but the value is out of
  51.    --  range, or, in the based case, the base value is out of range or there
  52.    --  is an out of range digit, then Ptr.all points past the integer, and
  53.    --  Constraint_Error is raised.
  54.    --
  55.    --  Note: these rules correspond to the requirements for leaving the pointer
  56.    --  positioned in Text_Io.Get
  57.    --
  58.    --  Note: if Str is null, i.e. if Max is less than Ptr, then this is a
  59.    --  special case of an all-blank string, and Ptr is unchanged, and hence
  60.    --  is greater than Max as required in this case.
  61.  
  62.    function Value_Integer (Str : String) return Integer;
  63.    --  Used in computing X'Value (Str) where X is a signed integer type whose
  64.    --  base range does not exceed the base range of Integer. Str is the string
  65.    --  argument of the attribute. Constraint_Error is raised if the string is
  66.    --  malformed, or if the value is out of range.
  67.  
  68. end System.Val_Int;
  69.