gcc/ada/libgnat/s-carun8.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                    GNAT RUN-TIME 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-2024, 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 3,  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.                                     --
  17 --                                                                          --
  18 -- As a special exception under Section 7 of GPL version 3, you are granted --
  19 -- additional permissions described in the GCC Runtime Library Exception,   --
  20 -- version 3.1, as published by the Free Software Foundation.               --
  21 --                                                                          --
  22 -- You should have received a copy of the GNU General Public License and    --
  23 -- a copy of the GCC Runtime Library Exception along with this program;     --
  24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  25 -- <http://www.gnu.org/licenses/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  32 --  This package contains functions for runtime comparisons on arrays whose
  33 --  elements are 8-bit discrete type values to be treated as unsigned.
  34
  35 package System.Compare_Array_Unsigned_8 is
  36
  37    --  Note: although the functions in this package are in a sense Pure, the
  38    --  package cannot be declared as Pure, since the arguments are addresses,
  39    --  not the data, and the result is not pure wrt the address values.
  40
  41    function Compare_Array_U8
  42      (Left      : System.Address;
  43       Right     : System.Address;
  44       Left_Len  : Natural;
  45       Right_Len : Natural) return Integer;
  46    --  Compare the array starting at address Left of length Left_Len with the
  47    --  array starting at address Right of length Right_Len. The comparison is
  48    --  in the normal Ada semantic sense of array comparison. The result is -1,
  49    --  0, +1 for Left < Right, Left = Right, Left > Right respectively. This
  50    --  function works with 4 byte words if the operands are aligned on 4-byte
  51    --  boundaries and long enough.
  52
  53    function Compare_Array_U8_Unaligned
  54      (Left      : System.Address;
  55       Right     : System.Address;
  56       Left_Len  : Natural;
  57       Right_Len : Natural) return Integer;
  58    --  Same functionality as Compare_Array_U8 but always proceeds by bytes.
  59    --  Used when the caller knows that the operands are unaligned, or short
  60    --  enough that it makes no sense to go by words.
  61
  62 end System.Compare_Array_Unsigned_8;