libcxx/include/string.h

   1 // -*- C++ -*-
   2 //===----------------------------------------------------------------------===//
   3 //
   4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   5 // See https://llvm.org/LICENSE.txt for license information.
   6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef _LIBCPP_STRING_H
  11 #define _LIBCPP_STRING_H
  12
  13 /*
  14     string.h synopsis
  15
  16 Macros:
  17
  18     NULL
  19
  20 Types:
  21
  22     size_t
  23
  24 void* memcpy(void* restrict s1, const void* restrict s2, size_t n);
  25 void* memmove(void* s1, const void* s2, size_t n);
  26 char* strcpy (char* restrict s1, const char* restrict s2);
  27 char* strncpy(char* restrict s1, const char* restrict s2, size_t n);
  28 char* strcat (char* restrict s1, const char* restrict s2);
  29 char* strncat(char* restrict s1, const char* restrict s2, size_t n);
  30 int memcmp(const void* s1, const void* s2, size_t n);
  31 int strcmp (const char* s1, const char* s2);
  32 int strncmp(const char* s1, const char* s2, size_t n);
  33 int strcoll(const char* s1, const char* s2);
  34 size_t strxfrm(char* restrict s1, const char* restrict s2, size_t n);
  35 const void* memchr(const void* s, int c, size_t n);
  36       void* memchr(      void* s, int c, size_t n);
  37 const char* strchr(const char* s, int c);
  38       char* strchr(      char* s, int c);
  39 size_t strcspn(const char* s1, const char* s2);
  40 const char* strpbrk(const char* s1, const char* s2);
  41       char* strpbrk(      char* s1, const char* s2);
  42 const char* strrchr(const char* s, int c);
  43       char* strrchr(      char* s, int c);
  44 size_t strspn(const char* s1, const char* s2);
  45 const char* strstr(const char* s1, const char* s2);
  46       char* strstr(      char* s1, const char* s2);
  47 char* strtok(char* restrict s1, const char* restrict s2);
  48 void* memset(void* s, int c, size_t n);
  49 char* strerror(int errnum);
  50 size_t strlen(const char* s);
  51
  52 */
  53
  54 #if defined(__cplusplus) && __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
  55 #  include <__cxx03/string.h>
  56 #else
  57 #  include <__config>
  58
  59 #  if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  60 #    pragma GCC system_header
  61 #  endif
  62
  63 #  if __has_include_next(<string.h>)
  64 #    include_next <string.h>
  65 #  endif
  66
  67 // MSVCRT, GNU libc and its derivates may already have the correct prototype in
  68 // <string.h>. This macro can be defined by users if their C library provides
  69 // the right signature.
  70 #  if defined(__CORRECT_ISO_CPP_STRING_H_PROTO) || defined(_LIBCPP_MSVCRT) ||                                          \
  71       defined(_STRING_H_CPLUSPLUS_98_CONFORMANCE_)
  72 #    define _LIBCPP_STRING_H_HAS_CONST_OVERLOADS
  73 #  endif
  74
  75 #  if defined(__cplusplus) && !defined(_LIBCPP_STRING_H_HAS_CONST_OVERLOADS) && defined(_LIBCPP_PREFERRED_OVERLOAD)
  76 extern "C++" {
  77 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD const char* strchr(const char* __s, int __c) {
  78   return __builtin_strchr(__s, __c);
  79 }
  80 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD char* strchr(char* __s, int __c) {
  81   return __builtin_strchr(__s, __c);
  82 }
  83
  84 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD const char* strpbrk(const char* __s1, const char* __s2) {
  85   return __builtin_strpbrk(__s1, __s2);
  86 }
  87 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD char* strpbrk(char* __s1, const char* __s2) {
  88   return __builtin_strpbrk(__s1, __s2);
  89 }
  90
  91 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD const char* strrchr(const char* __s, int __c) {
  92   return __builtin_strrchr(__s, __c);
  93 }
  94 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD char* strrchr(char* __s, int __c) {
  95   return __builtin_strrchr(__s, __c);
  96 }
  97
  98 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD const void* memchr(const void* __s, int __c, size_t __n) {
  99   return __builtin_memchr(__s, __c, __n);
 100 }
 101 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD void* memchr(void* __s, int __c, size_t __n) {
 102   return __builtin_memchr(__s, __c, __n);
 103 }
 104
 105 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD const char* strstr(const char* __s1, const char* __s2) {
 106   return __builtin_strstr(__s1, __s2);
 107 }
 108 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_PREFERRED_OVERLOAD char* strstr(char* __s1, const char* __s2) {
 109   return __builtin_strstr(__s1, __s2);
 110 }
 111 } // extern "C++"
 112 #  endif
 113 #endif // defined(__cplusplus) && __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
 114
 115 #endif // _LIBCPP_STRING_H