gcc/ada/libgnat/s-strcom.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                    GNAT RUN-TIME LIBRARY COMPONENTS                      --
   4 --                                                                          --
   5 --                S Y S T E M . S T R I N G _ C O M P A R E                 --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2002-2023, 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 strings
  33
  34 package System.String_Compare is
  35
  36    function Str_Compare
  37      (Left      : System.Address;
  38       Right     : System.Address;
  39       Left_Len  : Natural;
  40       Right_Len : Natural) return Integer;
  41    --  Compare the string starting at address Left of length Left_Len
  42    --  with the string starting at address Right of length Right_Len.
  43    --  The comparison is in the normal Ada semantic sense of string
  44    --  comparison. The result is -1,0,+1 for Left<Right, Left=Right,
  45    --  Left>Right respectively. This function works with 4 byte words
  46    --  if the operands are aligned on 4-byte boundaries and long enough.
  47
  48    function Str_Compare_Bytes
  49      (Left      : System.Address;
  50       Right     : System.Address;
  51       Left_Len  : Natural;
  52       Right_Len : Natural) return Integer;
  53    --  Same functionality as Str_Compare but always proceeds by bytes.
  54    --  Used when the caller knows that the operands are unaligned, or
  55    --  short enough that it makes no sense to go by words.
  56
  57 end System.String_Compare;