gcc/ada/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-2005 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 functions for runtime comparisons on strings
  35
  36 package System.String_Compare is
  37
  38    function Str_Compare
  39      (Left      : System.Address;
  40       Right     : System.Address;
  41       Left_Len  : Natural;
  42       Right_Len : Natural)
  43       return      Integer;
  44    --  Compare the string starting at address Left of length Left_Len
  45    --  with the string starting at address Right of length Right_Len.
  46    --  The comparison is in the normal Ada semantic sense of string
  47    --  comparison. The result is -1,0,+1 for Left<Right, Left=Right,
  48    --  Left>Right respectively. This function works with 4 byte words
  49    --  if the operands are aligned on 4-byte boundaries and long enough.
  50
  51    function Str_Compare_Bytes
  52      (Left      : System.Address;
  53       Right     : System.Address;
  54       Left_Len  : Natural;
  55       Right_Len : Natural)
  56       return      Integer;
  57    --  Same functionality as Str_Compare but always proceeds by bytes.
  58    --  Used when the caller knows that the operands are unaligned, or
  59    --  short enough that it makes no sense to go by words.
  60
  61 end System.String_Compare;