gcc/ada/s-carun8.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                   GNU ADA RUNTIME LIBRARY COMPONENTS                     --
   4 --                                                                          --
   5 --       S Y S T E M . C O M P A R E _ A R R A Y _ U N S I G N E D _ 8      --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2002-2004 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,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, 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 functions for runtime comparisons on arrays whose
  35 --  elements are 8-bit discrete type values to be treated as unsigned.
  36
  37 package System.Compare_Array_Unsigned_8 is
  38
  39    --  Note: although the functions in this package are in a sense Pure, the
  40    --  package cannot be declared as Pure, since the arguments are addresses,
  41    --  not the data, and the result is not pure wrt the address values.
  42
  43    function Compare_Array_U8
  44      (Left      : System.Address;
  45       Right     : System.Address;
  46       Left_Len  : Natural;
  47       Right_Len : Natural) return Integer;
  48    --  Compare the array starting at address Left of length Left_Len
  49    --  with the array starting at address Right of length Right_Len.
  50    --  The comparison is in the normal Ada semantic sense of array
  51    --  comparison. The result is -1,0,+1 for Left<Right, Left=Right,
  52    --  Left>Right respectively. This function works with 4 byte words
  53    --  if the operands are aligned on 4-byte boundaries and long enough.
  54
  55    function Compare_Array_U8_Unaligned
  56      (Left      : System.Address;
  57       Right     : System.Address;
  58       Left_Len  : Natural;
  59       Right_Len : Natural) return Integer;
  60    --  Same functionality as Compare_Array_U8 but always proceeds by
  61    --  bytes. Used when the caller knows that the operands are unaligned,
  62    --  or short enough that it makes no sense to go by words.
  63
  64 end System.Compare_Array_Unsigned_8;