blob: 76ebac179479202bf87f12df6381ab1bfcb1c89a [file] [log] [blame]
// Copyright 2017 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <cstddef>
#include <functional>
#include <type_traits>
#include <utility>
// UnownedPtr is a smart pointer class that behaves very much like a
// standard C-style pointer. The advantages of using it over raw
// pointers are:
// 1. It documents the nature of the pointer with no need to add a comment
// explaining that is it // Not owned. Additionally, an attempt to delete
// an unowned ptr will fail to compile rather than silently succeeding,
// since it is a class and not a raw pointer.
// 2. When built using the memory tool ASAN, the class provides a destructor
// which checks that the object being pointed to is still alive.
// Hence, when using UnownedPtr, no dangling pointers are ever permitted,
// even if they are not de-referenced after becoming dangling. The style of
// programming required is that the lifetime an object containing an
// UnownedPtr must be strictly less than the object to which it points.
// The same checks are also performed at assignment time to prove that the
// old value was not a dangling pointer, either.
// The array indexing operation [] is not supported on an unowned ptr,
// because an unowned ptr expresses a one to one relationship with some
// other heap object. Use pdfium::span<> for the cases where indexing
// into an unowned array is desired, which performs the same checks.
namespace pdfium {
template <typename T>
class span;
} // namespace pdfium
namespace fxcrt {
template <class T>
class UnownedPtr {
constexpr UnownedPtr() noexcept = default;
constexpr UnownedPtr(const UnownedPtr& that) noexcept = default;
// Move-construct an UnownedPtr. After construction, |that| will be NULL.
constexpr UnownedPtr(UnownedPtr&& that) noexcept : m_pObj(that.Release()) {}
template <typename U>
explicit constexpr UnownedPtr(U* pObj) noexcept : m_pObj(pObj) {}
// Deliberately implicit to allow returning nullptrs.
// NOLINTNEXTLINE(runtime/explicit)
constexpr UnownedPtr(std::nullptr_t ptr) noexcept {}
~UnownedPtr() {
m_pObj = nullptr;
void Reset(T* obj = nullptr) {
m_pObj = obj;
UnownedPtr& operator=(T* that) noexcept {
return *this;
UnownedPtr& operator=(const UnownedPtr& that) noexcept {
if (*this != that)
return *this;
// Move-assign an UnownedPtr. After assignment, |that| will be NULL.
UnownedPtr& operator=(UnownedPtr&& that) noexcept {
if (*this != that)
return *this;
bool operator==(std::nullptr_t ptr) const { return Get() == nullptr; }
bool operator==(const UnownedPtr& that) const { return Get() == that.Get(); }
bool operator<(const UnownedPtr& that) const {
return std::less<T*>()(Get(), that.Get());
operator T*() const noexcept { return Get(); }
T* Get() const noexcept { return m_pObj; }
T* Release() {
T* pTemp = nullptr;
std::swap(pTemp, m_pObj);
return pTemp;
explicit operator bool() const { return !!m_pObj; }
T& operator*() const { return *m_pObj; }
T* operator->() const { return m_pObj; }
friend class pdfium::span<T>;
inline void ProbeForLowSeverityLifetimeIssue() {
if (m_pObj)
reinterpret_cast<const volatile uint8_t*>(m_pObj)[0];
inline void ReleaseBadPointer() {
m_pObj = nullptr;
T* m_pObj = nullptr;
} // namespace fxcrt
using fxcrt::UnownedPtr;