AutoRef.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* AutoRef.h                                                   (C) 2000-2024 */
/*                                                                           */
/* Encapsulation d'un pointeur avec compteur de référence.                   */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_UTILS_AUTOREF_H
#define ARCANE_UTILS_AUTOREF_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/Ptr.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Encapsulation d'un pointeur avec compteur de référence.
 *
 * Cette classe renferme un pointeur d'un type qui implémente les méthodes
 * de la classe abstraite ISharedReference (le paramètre template n'a pas
 * besoin de dériver de cette classe) et incrémente (_addRef()) ou décrémente
 * (_removeRef()) le compteur de référence de l'élément pointé lors des
 * affectations succéssives. Cette classe n'effectue aucune action basée
 * sur la valeur de compteur de référence; la destruction éventuelle de l'objet
 * lorsque le compteur de référence arrive à zéro est gérée par l'objet lui même.
 */
template <class T>
class AutoRefT
: public PtrT<T>
{
 public:
 
  //! Type de la classe de base
  using BaseClass = PtrT<T>;
 
  using BaseClass::m_value;
 
 public:
 
  //! Construit une instance sans référence
  AutoRefT() = default;
  //! Construit une instance référant \a t
  explicit AutoRefT(T* t)
  : BaseClass()
  {
    _changeValue(t);
  }
  //! Construit une référence référant \a from
  AutoRefT(const AutoRefT<T>& from)
  : BaseClass()
  {
    _changeValue(from.m_value);
  }
 
  //! Opérateur de copie
  AutoRefT<T>& operator=(const AutoRefT<T>& from)
  {
    _changeValue(from.m_value);
    return (*this);
  }
 
  //! Affecte à l'instance la value \a new_value
  AutoRefT<T>& operator=(T* new_value)
  {
    _changeValue(new_value);
    return (*this);
  }
 
  //! Destructeur. Décrément le compteur de référence de l'objet pointé
  ~AutoRefT() { _removeRef(); }
 
 private:
 
  //! Ajoute une référence à l'objet encapsulé si non nul
  void _addRef()
  {
    if (m_value)
      m_value->addRef();
  }
  //! Supprimer une référence à l'objet encapsulé si non nul
  void _removeRef()
  {
    if (m_value)
      m_value->removeRef();
  }
  //! Change l'objet référencé en \a new_value
  void _changeValue(T* new_value)
  {
    if (m_value == new_value)
      return;
    _removeRef();
    m_value = new_value;
    _addRef();
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Encapsulation d'un pointeur avec compteur de référence.
 *
 * Cette classe renferme un pointeur d'un type qui implémente les méthodes
 * de la classe abstraite ISharedReference (le paramètre template n'a pas
 * besoin de dériver de cette classe) et incrémente (_addRef()) ou décrémente
 * (_removeRef()) le compteur de référence de l'élément pointé lors des
 * affectations succéssives. Cette classe n'effectue aucune action basée
 * sur la valeur de compteur de référence; la destruction éventuelle de l'objet
 * lorsque le compteur de référence arrive à zéro est gérée par l'objet lui même.
 */
template <class T>
class AutoRef2
{
 public:
 
  using ThatClass = AutoRef2<T>;
 
 public:
 
  //! Construit une instance sans référence
  AutoRef2() = default;
  //! Construit une instance référant \a t
  explicit AutoRef2(T* t)
  {
    _changeValue(t);
  }
  //! Construit une référence référant \a from
  AutoRef2(const ThatClass& from)
  {
    _changeValue(from.m_value);
  }
  //! Construit une référence référant \a from
  AutoRef2(ThatClass&& from) noexcept
  : m_value(from.m_value)
  {
    from.m_value = nullptr;
  }
 
  //! Opérateur de copie
  ThatClass& operator=(const ThatClass& from)
  {
    _changeValue(from.m_value);
    return (*this);
  }
  //! Opérateur de déplacement
  ThatClass& operator=(ThatClass&& from) noexcept
  {
    _removeRef();
    m_value = from.m_value;
    from.m_value = nullptr;
    return (*this);
  }
 
  //! Affecte à l'instance la value \a new_value
  ThatClass& operator=(T* new_value)
  {
    _changeValue(new_value);
    return (*this);
  }
 
  //! Destructeur. Décrément le compteur de référence de l'objet pointé
  ~AutoRef2() { _removeRef(); }
 
  //! Retourne l'objet référé par l'instance
  T* operator->() const
  {
    ARCANE_CHECK_PTR(m_value);
    return m_value;
  }
 
  //! Retourne l'objet référé par l'instance
  inline T& operator*() const
  {
    ARCANE_CHECK_PTR(m_value);
    return *m_value;
  }
 
  //! Retourne l'objet référé par l'instance
  T* get() const { return m_value; }
 
  bool isNull() const { return !m_value; }
  operator bool() const { return m_value; }
 
  friend bool operator==(const ThatClass& a, const ThatClass& b)
  {
    return a.get() == b.get();
  }
  friend bool operator!=(const ThatClass& a, const ThatClass& b)
  {
    return a.get() != b.get();
  }
 
 private:
 
  //! Ajoute une référence à l'objet encapsulé si non nul
  void _addRef()
  {
    if (m_value)
      m_value->addRef();
  }
  //! Supprimer une référence à l'objet encapsulé si non nul
  void _removeRef()
  {
    if (m_value)
      m_value->removeRef();
  }
  //! Change l'objet référencé en \a new_value
  void _changeValue(T* new_value)
  {
    if (m_value == new_value)
      return;
    _removeRef();
    m_value = new_value;
    _addRef();
  }
 
 private:
 
  T* m_value = nullptr; //!< Pointeur sur l'objet référencé
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif