RefCountedPtr.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
/*
 * Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration.
 */
#ifndef CXXUTILS_REFCOUNTEDPTR_H
#define CXXUTILS_REFCOUNTEDPTR_H
 
 
#include "CxxUtils/concepts.h"
#include <memory>  // For unique_ptr
 
 
namespace CxxUtils {
 
 
template <CxxUtils::detail::RefCounted T>
class RefCountedPtr
{
public:
  using element_type = T;
 
  RefCountedPtr() = default;
 
  RefCountedPtr (T* p);
 
  template <CxxUtils::detail::RefCounted OTHER>
  requires std::convertible_to<OTHER*, T*>
  RefCountedPtr (std::unique_ptr<OTHER>&& other);
 
  RefCountedPtr (const RefCountedPtr& other);
 
  RefCountedPtr (RefCountedPtr&& other);
 
  template <CxxUtils::detail::RefCounted OTHER>
  requires std::convertible_to<OTHER*, T*>
  RefCountedPtr (const RefCountedPtr<OTHER>& other);
 
  template <CxxUtils::detail::RefCounted OTHER>
  requires std::convertible_to<OTHER*, T*>
  RefCountedPtr (RefCountedPtr<OTHER>&& other);
 
  RefCountedPtr& operator= (const RefCountedPtr& other);
 
  RefCountedPtr& operator= (RefCountedPtr&& other);
 
  RefCountedPtr& operator= (T* p);
 
  template <CxxUtils::detail::RefCounted OTHER>
  requires std::convertible_to<OTHER*, T*>
  RefCountedPtr& operator= (const RefCountedPtr<OTHER>& other);
 
  template <CxxUtils::detail::RefCounted OTHER>
  requires std::convertible_to<OTHER*, T*>
  RefCountedPtr& operator= (RefCountedPtr<OTHER>&& other);
 
  ~RefCountedPtr();
 
  void reset (T* ptr = nullptr);
 
  bool isValid() const;
 
  explicit operator bool() const;
 
  bool operator!() const;
 
  T* get();
  const T* get() const;
 
  operator T*();
  operator const T*() const;
 
  T* operator->();
  const T* operator->() const;
 
  T& operator*();
  const T& operator*() const;
 
 
private:
  template <CxxUtils::detail::RefCounted OTHER> friend class RefCountedPtr;
 
  // Return the pointer and give up ownership.
  T* release();
 
  T* m_ptr = nullptr;
};
 
 
} // namespace CxxUtils
 
 
#include "CxxUtils/RefCountedPtr.icc"
 
 
#endif // not CXXUTILS_REFCOUNTEDPTR_H