GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing cplusplus.com — std::get_pointer_safety

Reference

C library:
- <cassert> (assert.h)
- <cctype> (ctype.h)
- <cerrno> (errno.h)
- C++11
  <cfenv> (fenv.h)
- <cfloat> (float.h)
- C++11
  <cinttypes> (inttypes.h)
- <ciso646> (iso646.h)
- <climits> (limits.h)
- <clocale> (locale.h)
- <cmath> (math.h)
- <csetjmp> (setjmp.h)
- <csignal> (signal.h)
- <cstdarg> (stdarg.h)
- C++11
  <cstdbool> (stdbool.h)
- <cstddef> (stddef.h)
- C++11
  <cstdint> (stdint.h)
- <cstdio> (stdio.h)
- <cstdlib> (stdlib.h)
- <cstring> (string.h)
- C++11
  <ctgmath> (tgmath.h)
- <ctime> (time.h)
- C++11
  <cuchar> (uchar.h)
- <cwchar> (wchar.h)
- <cwctype> (wctype.h)
Containers:
- C++11
  <array>
- <deque>
- C++11
  <forward_list>
- <list>
- <map>
- <queue>
- <set>
- <stack>
- C++11
  <unordered_map>
- C++11
  <unordered_set>
- <vector>
Input/Output:
- <fstream>
- <iomanip>
- <ios>
- <iosfwd>
- <iostream>
- <istream>
- <ostream>
- <sstream>
- <streambuf>
Multi-threading:
- C++11
  <atomic>
- C++11
  <condition_variable>
- C++11
  <future>
- C++11
  <mutex>
- C++11
  <thread>
Other:
- <algorithm>
- <bitset>
- C++11
  <chrono>
- C++11
  <codecvt>
- <complex>
- <exception>
- <functional>
- C++11
  <initializer_list>
- <iterator>
- <limits>
- <locale>
- <memory>
- <new>
- <numeric>
- C++11
  <random>
- C++11
  <ratio>
- C++11
  <regex>
- <stdexcept>
- <string>
- C++11
  <system_error>
- C++11
  <tuple>
- C++11
  <type_traits>
- C++11
  <typeindex>
- <typeinfo>
- <utility>
- <valarray>

<memory>

classes
- allocator
- C++11
  allocator_arg_t
- C++11
  allocator_traits
- auto_ptr
- auto_ptr_ref
- C++11
  bad_weak_ptr
- C++11
  default_delete
- C++11
  enable_shared_from_this
- C++11
  owner_less
- C++11
  pointer_traits
- raw_storage_iterator
- C++11
  shared_ptr
- C++11
  unique_ptr
- C++11
  uses_allocator
- C++11
  weak_ptr
enum classes
- C++11
  pointer_safety
functions
- C++11
  addressof
- C++11
  align
- C++11
  allocate_shared
- C++11
  const_pointer_cast
- C++11
  declare_no_pointers
- C++11
  declare_reachable
- C++11
  dynamic_pointer_cast
- C++11
  get_deleter
- C++11
  get_pointer_safety
- get_temporary_buffer
- C++11
  make_shared
- return_temporary_buffer
- C++11
  static_pointer_cast
- C++11
  undeclare_no_pointers
- C++11
  undeclare_reachable
- uninitialized_copy
- C++11
  uninitialized_copy_n
- uninitialized_fill
- uninitialized_fill_n
objects
- C++11
  allocator_arg

Reference
<memory>
get_pointer_safety

function

std::get_pointer_safety

pointer_safety get_pointer_safety() noexcept;

Get pointer safety

Returns the pointer safety setting used by the implementation, as a value of type pointer_safety, which can take any of the following values:

value	description
`relaxed`	The validity of a pointer value does not depend on whether it is a safely-derived pointer value.
`preferred`	The validity of a pointer value does not depend on whether it is a safely-derived pointer value. A leak detector may be running so that the program can avoid spurious leak reports.
`strict`	A pointer value that is not a safely-derived pointer value is an invalid pointer value unless the referenced complete object is of dynamic storage duration and has previously been declared reachable. A garbage collector may be running so that non-traceable object are automatically deleted.

A safely-derived pointer value is a pointer value returned by the default definition of operator new or a value derived from it by well-defined pointer arithmetic, pointer conversions or pointer reinterpretations (reinterpret_cast), including to and from other pointer types or integral types (at least as large as intptr_t), or from sequences of characters with the same size and alignment.

When an implementation uses strict pointer safety, any object dynamically allocated using the default definition of operator new which cannot be traced either by a safely-derived pointer or an equivalent integer representation may be automatically destroyed, invalidating any pointer values that may point to it.

Notice that his does not affect memory allocated dynamically by other means, such as using C-library's malloc or custom redefinitions of operator new.

Parameters

none

Return value

The pointer safety setting of the compiler.
pointer_safety is an enum class type defined in <memory>.

Example

// get_pointer_safety example
#include <iostream>
#include <memory>

int main() {
  std::cout << "Pointer safety: ";
  switch (std::get_pointer_safety()) {
    case std::pointer_safety::relaxed:   std::cout << "relaxed";   break;
    case std::pointer_safety::preferred: std::cout << "preferred"; break;
    case std::pointer_safety::strict:    std::cout << "strict";    break;
  }
  std::cout << '\n';
  return 0;
}

Possible output:

Pointer safety: relaxed

classes

enum classes

functions

objects

std::get_pointer_safety

Parameters

Return value

Example

See also