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-valuns.ads < prev    next >
Text File  |  2000-07-19  |  5KB  |  84 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --                       S Y S T E M . V A L _ U N S                        --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.9 $                              --
  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 modular Unsigned
  37. --  values for use in Text_IO.Modular, and the Value attribute.
  38.  
  39. with System.Unsigned_Types;
  40.  
  41. package System.Val_Uns is
  42. pragma Pure (Val_Uns);
  43.  
  44.    function Scan_Unsigned
  45.      (Str  : String;
  46.       Ptr  : access Integer;
  47.       Max  : Integer)
  48.       return System.Unsigned_Types.Unsigned;
  49.    --  This function scans the string starting at Str (Ptr.all) for a valid
  50.    --  integer according to the syntax described in (RM 3.5(43)). The substring
  51.    --  scanned extends no further than Str (Max). There are three cases for the
  52.    --  return:
  53.    --
  54.    --  If a valid integer is found after scanning past any initial spaces, then
  55.    --  Ptr.all is updated past the last character of the integer (but trailing
  56.    --  spaces are not scanned out).
  57.    --
  58.    --  If no valid integer is found, then Ptr.all points either to an initial
  59.    --  non-digit character, or to Max + 1 if the field is all spaces and the
  60.    --  exception Constraint_Error is raised.
  61.    --
  62.    --  If a syntactically valid integer is scanned, but the value is out of
  63.    --  range, or, in the based case, the base value is out of range or there
  64.    --  is an out of range digit, then Ptr.all points past the integer, and
  65.    --  Constraint_Error is raised. Note that if a minus sign is present, and
  66.    --  the integer value is non-zero, then constraint error will be raised.
  67.    --
  68.    --  Note: these rules correspond to the requirements for leaving the pointer
  69.    --  positioned in Text_Io.Get
  70.    --
  71.    --  Note: if Str is null, i.e. if Max is less than Ptr, then this is a
  72.    --  special case of an all-blank string, and Ptr is unchanged, and hence
  73.    --  is greater than Max as required in this case.
  74.  
  75.    function Value_Unsigned
  76.      (Str : String)
  77.      return System.Unsigned_Types.Unsigned;
  78.    --  Used in computing X'Value (Str) where X is a modular integer type whose
  79.    --  modulus does not exceed the range of System.Unsigned_Types.Unsigned. Str
  80.    --  is the string argument of the attribute. Constraint_Error is raised if
  81.    --  the string is malformed, or if the value is out of range.
  82.  
  83. end System.Val_Uns;
  84.