gcc/ada/s-valint.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . V A L _ I N T                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2006, 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 --  This package contains routines for scanning signed Integer values for use
  35 --  in Text_IO.Integer_IO, and the Value attribute.
  36
  37 package System.Val_Int is
  38    pragma Pure;
  39
  40    function Scan_Integer
  41      (Str : String;
  42       Ptr : not null access Integer;
  43       Max : Integer) return Integer;
  44    --  This function scans the string starting at Str (Ptr.all) for a valid
  45    --  integer according to the syntax described in (RM 3.5(43)). The substring
  46    --  scanned extends no further than Str (Max). There are three cases for the
  47    --  return:
  48    --
  49    --  If a valid integer is found after scanning past any initial spaces, then
  50    --  Ptr.all is updated past the last character of the integer (but trailing
  51    --  spaces are not scanned out).
  52    --
  53    --  If no valid integer is found, then Ptr.all points either to an initial
  54    --  non-digit character, or to Max + 1 if the field is all spaces and the
  55    --  exception Constraint_Error is raised.
  56    --
  57    --  If a syntactically valid integer is scanned, but the value is out of
  58    --  range, or, in the based case, the base value is out of range or there
  59    --  is an out of range digit, then Ptr.all points past the integer, and
  60    --  Constraint_Error is raised.
  61    --
  62    --  Note: these rules correspond to the requirements for leaving the pointer
  63    --  positioned in Text_Io.Get
  64    --
  65    --  Note: if Str is null, i.e. if Max is less than Ptr, then this is a
  66    --  special case of an all-blank string, and Ptr is unchanged, and hence
  67    --  is greater than Max as required in this case.
  68
  69    function Value_Integer (Str : String) return Integer;
  70    --  Used in computing X'Value (Str) where X is a signed integer type whose
  71    --  base range does not exceed the base range of Integer. Str is the string
  72    --  argument of the attribute. Constraint_Error is raised if the string is
  73    --  malformed, or if the value is out of range.
  74
  75 end System.Val_Int;