string/strings.h

   1 /* Copyright (C) 1991,1992,1996,1997,1999,2000,2001,2009,2010
   2    Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _STRINGS_H
  21 #define _STRINGS_H      1
  22
  23 /* We don't need and should not read this file if <string.h> was already
  24    read. The one exception being that if __USE_BSD isn't defined, then
  25    these aren't defined in string.h, so we need to define them here.  */
  26 #if !defined _STRING_H || !defined __USE_BSD
  27
  28 # include <features.h>
  29 # define __need_size_t
  30 # include <stddef.h>
  31
  32 /* Tell the caller that we provide correct C++ prototypes.  */
  33 # if defined __cplusplus && __GNUC_PREREQ (4, 4)
  34 #  define __CORRECT_ISO_CPP_STRINGS_H_PROTO
  35 # endif
  36
  37 __BEGIN_DECLS
  38
  39 # if defined __USE_MISC || !defined __USE_XOPEN2K8
  40 /* Compare N bytes of S1 and S2 (same as memcmp).  */
  41 extern int bcmp (__const void *__s1, __const void *__s2, size_t __n)
  42      __THROW __attribute_pure__;
  43
  44 /* Copy N bytes of SRC to DEST (like memmove, but args reversed).  */
  45 extern void bcopy (__const void *__src, void *__dest, size_t __n) __THROW;
  46
  47 /* Set N bytes of S to 0.  */
  48 extern void bzero (void *__s, size_t __n) __THROW;
  49
  50 /* Find the first occurrence of C in S (same as strchr).  */
  51 #  ifdef __CORRECT_ISO_CPP_STRINGS_H_PROTO
  52 extern "C++"
  53 {
  54 extern char *index (char *__s, int __c)
  55      __THROW __asm ("index") __attribute_pure__ __nonnull ((1));
  56 extern __const char *index (__const char *__s, int __c)
  57      __THROW __asm ("index") __attribute_pure__ __nonnull ((1));
  58
  59 #   if defined __OPTIMIZE__ && !defined __CORRECT_ISO_CPP_STRING_H_PROTO
  60 __extern_always_inline char *
  61 index (char *__s, int __c) __THROW
  62 {
  63   return __builtin_index (__s, __c);
  64 }
  65
  66 __extern_always_inline __const char *
  67 index (__const char *__s, int __c) __THROW
  68 {
  69   return __builtin_index (__s, __c);
  70 }
  71 #   endif
  72 }
  73 #  else
  74 extern char *index (__const char *__s, int __c)
  75      __THROW __attribute_pure__ __nonnull ((1));
  76 #  endif
  77
  78 /* Find the last occurrence of C in S (same as strrchr).  */
  79 #  ifdef __CORRECT_ISO_CPP_STRINGS_H_PROTO
  80 extern "C++"
  81 {
  82 extern char *rindex (char *__s, int __c)
  83      __THROW __asm ("rindex") __attribute_pure__ __nonnull ((1));
  84 extern __const char *rindex (__const char *__s, int __c)
  85      __THROW __asm ("rindex") __attribute_pure__ __nonnull ((1));
  86
  87 #   if defined __OPTIMIZE__ && !defined __CORRECT_ISO_CPP_STRING_H_PROTO
  88 __extern_always_inline char *
  89 rindex (char *__s, int __c) __THROW
  90 {
  91   return __builtin_rindex (__s, __c);
  92 }
  93
  94 __extern_always_inline __const char *
  95 rindex (__const char *__s, int __c) __THROW
  96 {
  97   return __builtin_rindex (__s, __c);
  98 }
  99 #   endif
 100 }
 101 #  else
 102 extern char *rindex (__const char *__s, int __c)
 103      __THROW __attribute_pure__ __nonnull ((1));
 104 #  endif
 105 # endif
 106
 107 #if defined __USE_MISC || !defined __USE_XOPEN2K8 || defined __USE_XOPEN2K8XSI
 108 /* Return the position of the first bit set in I, or 0 if none are set.
 109    The least-significant bit is position 1, the most-significant 32.  */
 110 extern int ffs (int __i) __THROW __attribute__ ((const));
 111 #endif
 112
 113 /* Compare S1 and S2, ignoring case.  */
 114 extern int strcasecmp (__const char *__s1, __const char *__s2)
 115      __THROW __attribute_pure__;
 116
 117 /* Compare no more than N chars of S1 and S2, ignoring case.  */
 118 extern int strncasecmp (__const char *__s1, __const char *__s2, size_t __n)
 119      __THROW __attribute_pure__;
 120
 121 #ifdef  __USE_XOPEN2K8
 122 /* The following functions are equivalent to the both above but they
 123    take the locale they use for the collation as an extra argument.
 124    This is not standardsized but something like will come.  */
 125 # include <xlocale.h>
 126
 127 /* Again versions of a few functions which use the given locale instead
 128    of the global one.  */
 129 extern int strcasecmp_l (__const char *__s1, __const char *__s2,
 130                          __locale_t __loc)
 131      __THROW __attribute_pure__ __nonnull ((1, 2, 3));
 132
 133 extern int strncasecmp_l (__const char *__s1, __const char *__s2,
 134                           size_t __n, __locale_t __loc)
 135      __THROW __attribute_pure__ __nonnull ((1, 2, 4));
 136 #endif
 137
 138 __END_DECLS
 139
 140 #endif  /* string.h  */
 141
 142 #endif  /* strings.h  */