lib/mbmemcasecoll.h

   1 /* Locale-specific case-ignoring memory comparison.
   2    Copyright (C) 2001, 2009-2014 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify it
   5    under the terms of the GNU Lesser General Public License as published
   6    by the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 /* Written by Bruno Haible <bruno@clisp.org>, 2001.  */
  18
  19 #ifndef MBMEMCASECOLL_H
  20 #define MBMEMCASECOLL_H
  21
  22 #include <stdbool.h>
  23 #include <stddef.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29
  30 /* Compare the memory regions S1 = [s1..s1+s1len-1], S2 = [s2..s2+s2len-1],
  31    that contain character sequences, using the rules of the current locale,
  32    ignoring case.
  33    HARD_LC_COLLATE is false if the LC_COLLATE category of the current locale
  34    is equivalent to the "C" locale.
  35
  36    This function's result is locale dependent.  Unlike memcasecmp(), it works
  37    correctly in multibyte locales and also handles Turkish i / dotless i.
  38    Unlike ulc_casecmp(), it does not handle the German sharp s and the Greek
  39    final sigma.  Like memcoll() and ulc_casecoll(), it uses collation order.
  40
  41    Return a negative number if S1 < S2, a positive number if S1 > S2, 0 if
  42    S1 and S2 have the same contents, or an unspecified value if there is an
  43    error.
  44    Set errno to an error number if there is an error, and to zero otherwise.
  45
  46    Note: This function may, in multibyte locales, return 0 for strings of
  47    different lengths!  */
  48
  49 extern int mbmemcasecoll (const char *s1, size_t s1len,
  50                           const char *s2, size_t s2len,
  51                           bool hard_LC_COLLATE);
  52
  53
  54 #ifdef __cplusplus
  55 }
  56 #endif
  57
  58 #endif /* MBMEMCASECOLL_H */