libstdc++-v3/include/std/string

   1 // Components for manipulating sequences of characters -*- C++ -*-
   2
   3 // Copyright (C) 1997-2025 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 #ifdef _GLIBCXX_SYSHDR
  37 #pragma GCC system_header
  38 #endif
  39
  40 #include <bits/requires_hosted.h> // containers
  41
  42 #include <bits/c++config.h>
  43 #include <bits/stringfwd.h>
  44 #include <bits/char_traits.h>
  45 #include <bits/allocator.h>
  46 #include <bits/cpp_type_traits.h>
  47 #include <bits/localefwd.h>    // For operators >>, <<, and getline.
  48 #include <bits/ostream_insert.h>
  49 #include <bits/stl_iterator_base_funcs.h>
  50 #include <bits/stl_iterator.h>
  51 #include <bits/stl_function.h> // For less
  52 #include <ext/numeric_traits.h>
  53 #include <bits/stl_algobase.h>
  54 #include <bits/refwrap.h>
  55 #include <bits/range_access.h>
  56 #include <bits/basic_string.h>
  57 #include <bits/basic_string.tcc>
  58
  59 #define __glibcxx_want_algorithm_default_value_type
  60 #define __glibcxx_want_allocator_traits_is_always_equal
  61 #define __glibcxx_want_constexpr_char_traits
  62 #define __glibcxx_want_constexpr_string
  63 #define __glibcxx_want_containers_ranges
  64 #define __glibcxx_want_erase_if
  65 #define __glibcxx_want_nonmember_container_access
  66 #define __glibcxx_want_string_resize_and_overwrite
  67 #define __glibcxx_want_string_udls
  68 #define __glibcxx_want_to_string
  69 #include <bits/version.h>
  70
  71 #if __cplusplus >= 201703L && _GLIBCXX_USE_CXX11_ABI
  72 #include <bits/memory_resource.h>
  73 namespace std _GLIBCXX_VISIBILITY(default)
  74 {
  75 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  76   namespace pmr {
  77     template<typename _CharT, typename _Traits = char_traits<_CharT>>
  78       using basic_string = std::basic_string<_CharT, _Traits,
  79                                              polymorphic_allocator<_CharT>>;
  80     using string    = basic_string<char>;
  81 #ifdef _GLIBCXX_USE_CHAR8_T
  82     using u8string  = basic_string<char8_t>;
  83 #endif
  84     using u16string = basic_string<char16_t>;
  85     using u32string = basic_string<char32_t>;
  86     using wstring   = basic_string<wchar_t>;
  87   } // namespace pmr
  88 _GLIBCXX_END_NAMESPACE_VERSION
  89 } // namespace std
  90 #endif // C++17
  91
  92 #ifdef __cpp_lib_erase_if // C++ >= 20 && HOSTED
  93 namespace std _GLIBCXX_VISIBILITY(default)
  94 {
  95 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  96
  97   template<typename _CharT, typename _Traits, typename _Alloc,
  98            typename _Predicate>
  99     _GLIBCXX20_CONSTEXPR
 100     inline typename basic_string<_CharT, _Traits, _Alloc>::size_type
 101     erase_if(basic_string<_CharT, _Traits, _Alloc>& __cont, _Predicate __pred)
 102     {
 103       using namespace __gnu_cxx;
 104       const auto __osz = __cont.size();
 105       const auto __end = __cont.end();
 106       auto __removed = std::__remove_if(__cont.begin(), __end,
 107                                         __ops::__pred_iter(std::ref(__pred)));
 108       __cont.erase(__removed, __end);
 109       return __osz - __cont.size();
 110     }
 111
 112   template<typename _CharT, typename _Traits, typename _Alloc,
 113            typename _Up _GLIBCXX26_DEF_VAL_T(_CharT)>
 114     _GLIBCXX20_CONSTEXPR
 115     inline typename basic_string<_CharT, _Traits, _Alloc>::size_type
 116     erase(basic_string<_CharT, _Traits, _Alloc>& __cont, const _Up& __value)
 117     {
 118       using namespace __gnu_cxx;
 119       const auto __osz = __cont.size();
 120       const auto __end = __cont.end();
 121       auto __removed = std::__remove_if(__cont.begin(), __end,
 122                                         __ops::__iter_equals_val(__value));
 123       __cont.erase(__removed, __end);
 124       return __osz - __cont.size();
 125     }
 126 _GLIBCXX_END_NAMESPACE_VERSION
 127 } // namespace std
 128 #endif // __cpp_lib_erase_if
 129
 130 #endif /* _GLIBCXX_STRING */