libstdc++-v3/include/std/string

   1 // Components for manipulating sequences of characters -*- C++ -*-
   2
   3 // Copyright (C) 1997-2020 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 3, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 /** @file include/string
  26  *  This is a Standard C++ Library header.
  27  */
  28
  29 //
  30 // ISO C++ 14882: 21  Strings library
  31 //
  32
  33 #ifndef _GLIBCXX_STRING
  34 #define _GLIBCXX_STRING 1
  35
  36 #pragma GCC system_header
  37
  38 #include <bits/c++config.h>
  39 #include <bits/stringfwd.h>
  40 #include <bits/char_traits.h>  // NB: In turn includes stl_algobase.h
  41 #include <bits/allocator.h>
  42 #include <bits/cpp_type_traits.h>
  43 #include <bits/localefwd.h>    // For operators >>, <<, and getline.
  44 #include <bits/ostream_insert.h>
  45 #include <bits/stl_iterator_base_types.h>
  46 #include <bits/stl_iterator_base_funcs.h>
  47 #include <bits/stl_iterator.h>
  48 #include <bits/stl_function.h> // For less
  49 #include <ext/numeric_traits.h>
  50 #include <bits/stl_algobase.h>
  51 #if __cplusplus > 201703L
  52 #  include <bits/stl_algo.h> // For remove and remove_if
  53 #endif // C++20
  54 #include <bits/range_access.h>
  55 #include <bits/basic_string.h>
  56 #include <bits/basic_string.tcc>
  57
  58 #if __cplusplus >= 201703L && _GLIBCXX_USE_CXX11_ABI
  59 namespace std _GLIBCXX_VISIBILITY(default)
  60 {
  61 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  62   namespace pmr {
  63     template<typename _Tp> class polymorphic_allocator;
  64     template<typename _CharT, typename _Traits = char_traits<_CharT>>
  65       using basic_string = std::basic_string<_CharT, _Traits,
  66                                              polymorphic_allocator<_CharT>>;
  67     using string    = basic_string<char>;
  68 #ifdef _GLIBCXX_USE_CHAR8_T
  69     using u8string  = basic_string<char8_t>;
  70 #endif
  71     using u16string = basic_string<char16_t>;
  72     using u32string = basic_string<char32_t>;
  73 #ifdef _GLIBCXX_USE_WCHAR_T
  74     using wstring   = basic_string<wchar_t>;
  75 #endif
  76   } // namespace pmr
  77
  78   template<typename _Str>
  79     struct __hash_string_base
  80     : public __hash_base<size_t, _Str>
  81     {
  82       size_t
  83       operator()(const _Str& __s) const noexcept
  84       { return hash<basic_string_view<typename _Str::value_type>>{}(__s); }
  85     };
  86
  87   template<>
  88     struct hash<pmr::string>
  89     : public __hash_string_base<pmr::string>
  90     { };
  91 #ifdef _GLIBCXX_USE_CHAR8_T
  92   template<>
  93     struct hash<pmr::u8string>
  94     : public __hash_string_base<pmr::u8string>
  95     { };
  96 #endif
  97   template<>
  98     struct hash<pmr::u16string>
  99     : public __hash_string_base<pmr::u16string>
 100     { };
 101   template<>
 102     struct hash<pmr::u32string>
 103     : public __hash_string_base<pmr::u32string>
 104     { };
 105 #ifdef _GLIBCXX_USE_WCHAR_T
 106   template<>
 107     struct hash<pmr::wstring>
 108     : public __hash_string_base<pmr::wstring>
 109     { };
 110 #endif
 111
 112 _GLIBCXX_END_NAMESPACE_VERSION
 113 } // namespace std
 114 #endif // C++17
 115
 116 #if __cplusplus > 201703L
 117 namespace std _GLIBCXX_VISIBILITY(default)
 118 {
 119 _GLIBCXX_BEGIN_NAMESPACE_VERSION
 120
 121 #define __cpp_lib_erase_if 201900L
 122
 123   template<typename _CharT, typename _Traits, typename _Alloc,
 124            typename _Predicate>
 125     inline typename basic_string<_CharT, _Traits, _Alloc>::size_type
 126     erase_if(basic_string<_CharT, _Traits, _Alloc>& __cont, _Predicate __pred)
 127     {
 128       const auto __osz = __cont.size();
 129       __cont.erase(std::remove_if(__cont.begin(), __cont.end(), __pred),
 130                    __cont.end());
 131       return __osz - __cont.size();
 132     }
 133
 134   template<typename _CharT, typename _Traits, typename _Alloc, typename _Up>
 135     inline typename basic_string<_CharT, _Traits, _Alloc>::size_type
 136     erase(basic_string<_CharT, _Traits, _Alloc>& __cont, const _Up& __value)
 137     {
 138       const auto __osz = __cont.size();
 139       __cont.erase(std::remove(__cont.begin(), __cont.end(), __value),
 140                    __cont.end());
 141       return __osz - __cont.size();
 142     }
 143 _GLIBCXX_END_NAMESPACE_VERSION
 144 } // namespace std
 145 #endif // C++20
 146
 147 #endif /* _GLIBCXX_STRING */