ReferenceCounter.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ReferenceCounter.h                                          (C) 2000-2025 */
/*                                                                           */
/* Encapsulation of a pointer with a reference counter.                      */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_BASE_REFERENCECOUNTER_H
#define ARCCORE_BASE_REFERENCECOUNTER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/CheckedPointer.h"
#include "arccore/base/RefDeclarations.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class T>
class ReferenceCounter
: public CheckedPointer<T>
{
 public:

  typedef CheckedPointer<T> BaseClass;
 
  using BaseClass::m_value;
 
 public:

  ReferenceCounter()
  : BaseClass(nullptr)
  {}

  explicit ReferenceCounter(T* t)
  : BaseClass(nullptr)
  {
    _changeValue(t);
  }

  ReferenceCounter(const ReferenceCounter<T>& from)
  : BaseClass(nullptr)
  {
    _changeValue(from.m_value);
  }

  ReferenceCounter<T>& operator=(const ReferenceCounter<T>& from)
  {
    _changeValue(from.m_value);
    return (*this);
  }

  ReferenceCounter<T>& operator=(T* new_value)
  {
    _changeValue(new_value);
    return (*this);
  }

  ~ReferenceCounter() { _removeRef(); }
 
 private:

  void _removeRef()
  {
    if (m_value)
      ReferenceCounterAccessor<T>::removeReference(m_value);
  }

  void _changeValue(T* new_value)
  {
    if (m_value == new_value)
      return;
    // Always add first in case the new value
    // and the old value are from the same instance.
    if (new_value)
      ReferenceCounterAccessor<T>::addReference(new_value);
    _removeRef();
    m_value = new_value;
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif