Revert "build: Fix missing variable quotes"
[official-gcc.git] / libstdc++-v3 / include / std / memory
blobc984436f625379e18984ae32009a6e919b4e7dd3
1 // <memory> -*- C++ -*-
3 // Copyright (C) 2001-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/>.
26  * Copyright (c) 1997-1999
27  * Silicon Graphics Computer Systems, Inc.
28  *
29  * Permission to use, copy, modify, distribute and sell this software
30  * and its documentation for any purpose is hereby granted without fee,
31  * provided that the above copyright notice appear in all copies and
32  * that both that copyright notice and this permission notice appear
33  * in supporting documentation.  Silicon Graphics makes no
34  * representations about the suitability of this software for any
35  * purpose.  It is provided "as is" without express or implied warranty.
36  *
37  */
39 /** @file include/memory
40  *  This is a Standard C++ Library header.
41  *  @ingroup memory
42  */
44 #ifndef _GLIBCXX_MEMORY
45 #define _GLIBCXX_MEMORY 1
47 #pragma GCC system_header
49 /**
50  * @defgroup memory Memory
51  * @ingroup utilities
52  *
53  * Components for memory allocation, deallocation, and management.
54  */
56 /**
57  * @defgroup pointer_abstractions Pointer Abstractions
58  * @ingroup memory
59  *
60  * Smart pointers, etc.
61  */
63 #include <bits/memoryfwd.h>
64 #if _GLIBCXX_HOSTED
65 # include <bits/allocator.h>
66 # include <bits/stl_tempbuf.h>
67 #endif
68 #include <bits/stl_construct.h>
69 #include <bits/stl_uninitialized.h>
70 #include <bits/stl_raw_storage_iter.h>
72 #if __cplusplus >= 201103L
73 #  include <type_traits>
74 #  include <bits/align.h>
75 #  include <bits/uses_allocator.h>
76 #  include <bits/alloc_traits.h>
77 #  include <debug/debug.h>
78 #  include <bits/unique_ptr.h>
79 # if _GLIBCXX_HOSTED
80 #  include <bits/shared_ptr.h>
81 #  include <bits/shared_ptr_atomic.h>
82 # endif
83 #endif
85 #if __cplusplus < 201103L || _GLIBCXX_USE_DEPRECATED
86 #  include <backward/auto_ptr.h>
87 #endif
89 #if __cplusplus > 201703L
90 #  include <bits/ranges_uninitialized.h>
91 #  include <bits/uses_allocator_args.h>
92 #endif
94 #if __cplusplus > 202002L
95 #  include <bits/out_ptr.h>
96 #endif
98 #define __glibcxx_want_allocator_traits_is_always_equal
99 #define __glibcxx_want_assume_aligned
100 #define __glibcxx_want_atomic_shared_ptr
101 #define __glibcxx_want_atomic_value_initialization
102 #define __glibcxx_want_constexpr_dynamic_alloc
103 #define __glibcxx_want_constexpr_memory
104 #define __glibcxx_want_enable_shared_from_this
105 #define __glibcxx_want_make_unique
106 #define __glibcxx_want_out_ptr
107 #define __glibcxx_want_parallel_algorithm
108 #define __glibcxx_want_ranges
109 #define __glibcxx_want_raw_memory_algorithms
110 #define __glibcxx_want_shared_ptr_arrays
111 #define __glibcxx_want_shared_ptr_weak_type
112 #define __glibcxx_want_smart_ptr_for_overwrite
113 #define __glibcxx_want_to_address
114 #define __glibcxx_want_transparent_operators
115 #include <bits/version.h>
117 #if __cplusplus >= 201103L && __cplusplus <= 202002L && _GLIBCXX_HOSTED
118 namespace std _GLIBCXX_VISIBILITY(default)
120 _GLIBCXX_BEGIN_NAMESPACE_VERSION
122 /** @defgroup ptr_safety Pointer Safety and Garbage Collection
123  *  @ingroup memory
125  * Utilities to assist with garbage collection in an implementation
126  * that supports <em>strict pointer safety</em>.
127  * This implementation only supports <em>relaxed pointer safety</em>
128  * and so these functions have no effect.
130  * C++11 20.6.4 [util.dynamic.safety], Pointer safety
132  * @{
133  */
135 /// Constants representing the different types of pointer safety.
136 enum class pointer_safety { relaxed, preferred, strict };
138 /// Inform a garbage collector that an object is still in use.
139 inline void
140 declare_reachable(void*) { }
142 /// Unregister an object previously registered with declare_reachable.
143 template <typename _Tp>
144   inline _Tp*
145   undeclare_reachable(_Tp* __p) { return __p; }
147 /// Inform a garbage collector that a region of memory need not be traced.
148 inline void
149 declare_no_pointers(char*, size_t) { }
151 /// Unregister a range previously registered with declare_no_pointers.
152 inline void
153 undeclare_no_pointers(char*, size_t) { }
155 /// The type of pointer safety supported by the implementation.
156 inline pointer_safety
157 get_pointer_safety() noexcept { return pointer_safety::relaxed; }
158 /// @}
160 _GLIBCXX_END_NAMESPACE_VERSION
161 } // namespace
162 #endif // C++11 to C++20
164 #ifdef __cpp_lib_parallel_algorithm // C++ >= 17 && HOSTED
165 // Parallel STL algorithms
166 # if _PSTL_EXECUTION_POLICIES_DEFINED
167 // If <execution> has already been included, pull in implementations
168 #  include <pstl/glue_memory_impl.h>
169 # else
170 // Otherwise just pull in forward declarations
171 #  include <pstl/glue_memory_defs.h>
172 # endif
173 #endif // __cpp_lib_parallel_algorithm
175 #endif /* _GLIBCXX_MEMORY */