gcc: docs: Fix documentation of two hooks
[official-gcc.git] / libstdc++-v3 / include / std / string
blob55144409cca28d99cc6ec6a0aa4967d096ac2dd6
1 // Components for manipulating sequences of characters -*- C++ -*-
3 // Copyright (C) 1997-2024 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.
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.
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.
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/>.
25 /** @file include/string
26  *  This is a Standard C++ Library header.
27  */
30 // ISO C++ 14882: 21  Strings library
33 #ifndef _GLIBCXX_STRING
34 #define _GLIBCXX_STRING 1
36 #pragma GCC system_header
38 #include <bits/requires_hosted.h> // containers
40 #include <bits/c++config.h>
41 #include <bits/stringfwd.h>
42 #include <bits/char_traits.h>
43 #include <bits/allocator.h>
44 #include <bits/cpp_type_traits.h>
45 #include <bits/localefwd.h>    // For operators >>, <<, and getline.
46 #include <bits/ostream_insert.h>
47 #include <bits/stl_iterator_base_funcs.h>
48 #include <bits/stl_iterator.h>
49 #include <bits/stl_function.h> // For less
50 #include <ext/numeric_traits.h>
51 #include <bits/stl_algobase.h>
52 #include <bits/refwrap.h>
53 #include <bits/range_access.h>
54 #include <bits/basic_string.h>
55 #include <bits/basic_string.tcc>
57 #define __glibcxx_want_constexpr_char_traits
58 #define __glibcxx_want_constexpr_string
59 #define __glibcxx_want_erase_if
60 #define __glibcxx_want_nonmember_container_access
61 #define __glibcxx_want_string_resize_and_overwrite
62 #define __glibcxx_want_string_udls
63 #define __glibcxx_want_to_string
64 #include <bits/version.h>
66 #if __cplusplus >= 201703L && _GLIBCXX_USE_CXX11_ABI
67 #include <bits/memory_resource.h>
68 namespace std _GLIBCXX_VISIBILITY(default)
70 _GLIBCXX_BEGIN_NAMESPACE_VERSION
71   namespace pmr {
72     template<typename _CharT, typename _Traits = char_traits<_CharT>>
73       using basic_string = std::basic_string<_CharT, _Traits,
74                                              polymorphic_allocator<_CharT>>;
75     using string    = basic_string<char>;
76 #ifdef _GLIBCXX_USE_CHAR8_T
77     using u8string  = basic_string<char8_t>;
78 #endif
79     using u16string = basic_string<char16_t>;
80     using u32string = basic_string<char32_t>;
81     using wstring   = basic_string<wchar_t>;
82   } // namespace pmr
83 _GLIBCXX_END_NAMESPACE_VERSION
84 } // namespace std
85 #endif // C++17
87 #ifdef __cpp_lib_erase_if // C++ >= 20 && HOSTED
88 namespace std _GLIBCXX_VISIBILITY(default)
90 _GLIBCXX_BEGIN_NAMESPACE_VERSION
92   template<typename _CharT, typename _Traits, typename _Alloc,
93            typename _Predicate>
94     _GLIBCXX20_CONSTEXPR
95     inline typename basic_string<_CharT, _Traits, _Alloc>::size_type
96     erase_if(basic_string<_CharT, _Traits, _Alloc>& __cont, _Predicate __pred)
97     {
98       using namespace __gnu_cxx;
99       const auto __osz = __cont.size();
100       const auto __end = __cont.end();
101       auto __removed = std::__remove_if(__cont.begin(), __end,
102                                         __ops::__pred_iter(std::ref(__pred)));
103       __cont.erase(__removed, __end);
104       return __osz - __cont.size();
105     }
107   template<typename _CharT, typename _Traits, typename _Alloc, typename _Up>
108     _GLIBCXX20_CONSTEXPR
109     inline typename basic_string<_CharT, _Traits, _Alloc>::size_type
110     erase(basic_string<_CharT, _Traits, _Alloc>& __cont, const _Up& __value)
111     {
112       using namespace __gnu_cxx;
113       const auto __osz = __cont.size();
114       const auto __end = __cont.end();
115       auto __removed = std::__remove_if(__cont.begin(), __end,
116                                         __ops::__iter_equals_val(__value));
117       __cont.erase(__removed, __end);
118       return __osz - __cont.size();
119     }
120 _GLIBCXX_END_NAMESPACE_VERSION
121 } // namespace std
122 #endif // __cpp_lib_erase_if
124 #endif /* _GLIBCXX_STRING */