RefDeclarations.h

Aller à la documentation de ce fichier.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* RefDeclarations.h                                           (C) 2000-2023 */
/*                                                                           */
/* Déclarations liées à la gestion des références sur une instance.          */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_BASE_REFDECLARATIONS_H
#define ARCCORE_BASE_REFDECLARATIONS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ArccoreGlobal.h"
 
#include <type_traits>
#include <memory>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \file RefDeclarations.h
 *
 * Ce fichier contient les déclarations et macros pour gérer classes
 * utilisant les compteurs de référence. Pour l'implémentation il faut utiliser
 * le fichier 'ReferenceCounterImpl.h'
 */
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore
{
class ReferenceCounterImpl;
 
namespace impl
{
template <typename InstanceType>
class ReferenceCounterWrapper;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Structure servant à tagger les interfaces/classes qui utilisent
 * un compteur de référence interne.
 *
 * Ce tag s'utilise via un typedef comme suit:
 *
 * \code
 * class MyClass
 * {
 *   public:
 *    using ReferenceCounterTagType = ReferenceCounterTag;
 *   public:
 *    void addReference();
 *    void removeReference();
 * };
 * \endcode
 */
struct ReferenceCounterTag {};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
constexpr int REF_TAG_SHARED_PTR = 0;
constexpr int REF_TAG_REFERENCE_COUNTER = 1;
 
/*!
 * \brief Caractéristiques pour gérer les compteurs de référence.
 *
 * Par défaut, on utilise comme implémentation la classe std::shared_ptr.
 */
template<typename InstanceType,class T = void>
struct RefTraits
{
  static constexpr int TagId = REF_TAG_SHARED_PTR;
};
 
/*!
 * \brief Spécialisation de la classe gérant un compteur de référence
 * si la classe utilise le tag 'ReferenceCounterTag'.
 *
 * Dans ce cas, on utilise 'ReferenceCounter' comme implémentation.
 */
template<typename InstanceType>
struct RefTraits<InstanceType,std::enable_if_t<std::is_same_v<typename InstanceType::ReferenceCounterTagType,ReferenceCounterTag>>>
{
  static constexpr int TagId = REF_TAG_REFERENCE_COUNTER;
};
 
template<typename InstanceType,
         int ImplTagId = RefTraits<InstanceType>::TagId>
class Ref;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template<typename InstanceType,int TagType>
struct RefTraitsTagId;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace impl
{
//! Classe template pour vérifier si T a la méthode _internalRemoveReference()
template <typename T, typename = int>
struct HasInternalRemoveReference
: std::false_type
{
};
template <typename T>
struct HasInternalRemoveReference<T, decltype(&T::_internalRemoveReference, 0)>
: std::true_type
{
};
 
//! Classe template pour vérifier si T a la méthode _internalAddReference()
template <typename T, typename = int>
struct HasInternalAddReference
: std::false_type
{
};
template <typename T>
struct HasInternalAddReference<T, decltype(&T::_internalAddReference, 0)>
: std::true_type
{
};
 
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Accesseur des méthodes de gestion de compteurs de référence.
 *
 * Le classe T doit définir deux méthodes addReference() et removeReference()
 * pour gérer les compteurs de références. removeReference() doit détruire
 * l'instance si le compteur arrive à zéro.
 */
template<class T>
class ReferenceCounterAccessor
{
 public:
  static void addReference(T* t)
  {
    if constexpr(impl::HasInternalAddReference<T>::value)
      t->_internalAddReference();
    else
      t->addReference();
  }
  static void removeReference(T* t)
  {
    if constexpr(impl::HasInternalRemoveReference<T>::value){
      bool need_destroy = t->_internalRemoveReference();
      if (need_destroy)
        delete t;
    }
    else
      t->removeReference();
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template<class T>
class ExternalReferenceCounterAccessor
{
 public:
  static ARCCORE_EXPORT void addReference(T* t);
  static ARCCORE_EXPORT void removeReference(T* t);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Macro pour déclarer les méthodes virtuelles gérant les compteurs
 * de référence.
 *
 * Cette macro s'utilise de la même manière que les déclarations
 * de méthodes d'une interface. Elle permet de définir des méthodes virtuelles
 * pure pour accèder aux informations des compteurs de référence.
 *
 * La classe implémentant l'interface doit utiliser la macro
 * ARCCORE_DEFINE_REFERENCE_COUNTED_INCLASS_METHODS() pour définir les
 * méthodes virtuelles utilisées.
 *
 * \code
 * class IMyInterface
 * {
 *   ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 *  public:
 *   virtual ~IMyInterface() = default;
 *  public:
 *   virtual void myMethod1() = 0;
 * };
 * \endcode
 */
#define ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS() \
 private:\
  template<typename T> friend class Arccore::ExternalReferenceCounterAccessor; \
  template<typename T> friend class Arccore::ReferenceCounterAccessor;\
 public:                                                          \
  using ReferenceCounterTagType = Arccore::ReferenceCounterTag ;  \
  virtual ::Arccore::ReferenceCounterImpl* _internalReferenceCounter() =0; \
  virtual void _internalAddReference() =0;\
  [[nodiscard]] virtual bool _internalRemoveReference() =0
  // NOTE: les classes 'friend' sont nécessaires pour l'accès au destructeur.
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Macro pour déclarer qu'une classe utilise un compteur de
 * référence.
 *
 * La macro doit être utilisée en dehors de tout namespace. Par exemple:
 *
 * \code
 * namespace MyNamespace
 * {
 *   class MyClass;
 * }
 *
 * ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(MyNamespace::MyClass);
 * \endcode
 *
 * Il faudra ensuite utiliser la macro
 * ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS() dans le fichier source pour
 * définir les méthodes et types nécessaires
 */
#define ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(class_name) \
namespace Arccore {\
template<>                   \
struct RefTraits<class_name> \
{\
  static constexpr int TagId = Arccore::REF_TAG_REFERENCE_COUNTER;\
};\
template<>\
class ReferenceCounterAccessor<class_name>\
: public ExternalReferenceCounterAccessor<class_name>\
{};                                                  \
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arccore
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif