RefDeclarations.h

Aller à la documentation de ce fichier.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2025 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-2025 */
/*                                                                           */
/* 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/BaseTypes.h"
 
#include <type_traits>
#include <memory>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// La classe ExternalReferenceCounterAccessor doit rester dans le namespace
// Arccore pour compatiblité avec l'existant et la macro
// ARCCORE_DEFINE_REFERENCE_COUNTED_CLASS.
namespace Arccore
{
template <class T>
class ExternalReferenceCounterAccessor
{
 public:
 
  static ARCCORE_EXPORT void addReference(T* t);
  static ARCCORE_EXPORT void removeReference(T* t);
};
} // namespace Arccore
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
using Arccore::ExternalReferenceCounterAccessor;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
struct ReferenceCounterTag {};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
constexpr int REF_TAG_SHARED_PTR = 0;
constexpr int REF_TAG_REFERENCE_COUNTER = 1;

template<typename InstanceType,class T>
struct RefTraits
{
  static constexpr int TagId = REF_TAG_SHARED_PTR;
};

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
{
template <typename T, typename = int>
struct HasInternalRemoveReference
: std::false_type
{
};
template <typename T>
struct HasInternalRemoveReference<T, decltype(&T::_internalRemoveReference, 0)>
: std::true_type
{
};

template <typename T, typename = int>
struct HasInternalAddReference
: std::false_type
{
};
template <typename T>
struct HasInternalAddReference<T, decltype(&T::_internalAddReference, 0)>
: std::true_type
{
};
 
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
template<class T>
class ReferenceCounterAccessor
{
 public:
  static void addReference(T* t)
  {
    if constexpr(Arcane::impl::HasInternalAddReference<T>::value)
      t->_internalAddReference();
    else
      t->addReference();
  }
  static void removeReference(T* t)
  {
    if constexpr(Arcane::impl::HasInternalRemoveReference<T>::value){
      bool need_destroy = t->_internalRemoveReference();
      if (need_destroy)
        delete t;
    }
    else
      t->removeReference();
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#define ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS() \
 private: \
\
  template <typename T> friend class ::Arccore::ExternalReferenceCounterAccessor; \
  template <typename T> friend class Arcane::ReferenceCounterAccessor; \
\
 public: \
\
  using ReferenceCounterTagType = ::Arcane::ReferenceCounterTag; \
  virtual ::Arcane::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.
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#define ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(class_name) \
  namespace Arcane \
  { \
    template <> \
    struct RefTraits<class_name> \
    { \
      static constexpr int TagId = ::Arcane::REF_TAG_REFERENCE_COUNTER; \
    }; \
    template<>\
class ReferenceCounterAccessor<class_name>\
: public ExternalReferenceCounterAccessor<class_name>\
{};                                                  \
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore
{
using Arcane::ReferenceCounterTag;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif