PluginServiceV2.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 2013-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once

 
#include <Gaudi/Details/PluginServiceDetailsV2.h>
#include <sstream>
#include <string>
#include <string_view>
#include <utility>
 
#if __has_include( <source_location> ) && !defined (__CLING__)
#  include <source_location>
namespace Gaudi::PluginService::Details {
  using std::source_location;
}
 
#elif !defined( __clang__ ) && __GNUC__ >= 8
#  include <experimental/source_location>
namespace Gaudi::PluginService::Details {
  using std::experimental::source_location;
}
#else
namespace Gaudi::PluginService::Details {
 
  struct source_location {
 
    // 14.1.2, source_location creation
    static constexpr source_location current( const char* __file = __builtin_FILE(),
                                              const char* __func = __builtin_FUNCTION(), int __line = __builtin_LINE(),
                                              int __col = 0 ) noexcept {
      source_location __loc;
      __loc._M_file = __file;
      __loc._M_func = __func;
      __loc._M_line = __line;
      __loc._M_col  = __col;
      return __loc;
    }
 
    constexpr source_location() noexcept : _M_file( "unknown" ), _M_func( _M_file ), _M_line( 0 ), _M_col( 0 ) {}
 
    // 14.1.3, source_location field access
    constexpr uint_least32_t line() const noexcept { return _M_line; }
    constexpr uint_least32_t column() const noexcept { return _M_col; }
    constexpr const char*    file_name() const noexcept { return _M_file; }
    constexpr const char*    function_name() const noexcept { return _M_func; }
 
  private:
    const char*    _M_file;
    const char*    _M_func;
    uint_least32_t _M_line;
    uint_least32_t _M_col;
  };
 
} // namespace Gaudi::PluginService::Details
#endif
 
namespace Gaudi {
  namespace PluginService {
    GAUDI_PLUGIN_SERVICE_V2_INLINE namespace v2 {
      using Gaudi::PluginService::Details::source_location;

      template <typename>
      struct Factory;

      template <typename R, typename... Args>
      struct Factory<R( Args... )> {
        using Traits          = Details::Traits<R( Args... )>;
        using ReturnType      = typename Traits::ReturnType;
        using FactoryType     = typename Traits::FactoryType;
        using ReturnValueType = R;

        template <typename T>
        static ReturnType create( const T& id, Args... args ) {
          try {
            return Details::Registry::instance().get<FactoryType>( Details::stringify_id( id ) )(
                std::forward<Args>( args )... );
          } catch ( std::bad_any_cast& ) {
            Details::reportBadAnyCast( typeid( FactoryType ), Details::stringify_id( id ) );
            return nullptr;
          }
        }
      };

      template <typename T, typename F = typename T::Factory>
      struct DeclareFactory {
        using DefaultFactory = Details::DefaultFactory<T, F>;
 
        DeclareFactory( typename F::FactoryType f = DefaultFactory{}, Details::Registry::Properties props = {},
                        source_location src_loc = source_location::current() )
            : DeclareFactory( Details::demangle<T>(), std::move( f ), std::move( props ), src_loc ) {}
 
        DeclareFactory( const std::string& id, typename F::FactoryType f = DefaultFactory{},
                        Details::Registry::Properties    props   = {},
                        [[maybe_unused]] source_location src_loc = source_location::current() ) {
          using Details::Registry;
 
          if ( props.find( "ClassName" ) == end( props ) ) props.emplace( "ClassName", Details::demangle<T>() );
          // keep only the file name
          std::string_view fn  = src_loc.file_name();
          auto             pos = fn.rfind( '/' );
          if ( pos != std::string_view::npos ) { fn.remove_prefix( pos + 1 ); }
          std::stringstream s;
          s << fn << ':' << src_loc.line();
          props["declaration_location"] = s.str();
          Registry::instance().add( id, { libraryName(), std::move( f ), std::move( props ) } );
        }
 
        DeclareFactory( Details::Registry::Properties props, source_location src_loc = source_location::current() )
            : DeclareFactory( DefaultFactory{}, std::move( props ), src_loc ) {}
 
      private:
        static std::string libraryName() { return Details::getDSONameFor( reinterpret_cast<void*>( libraryName ) ); }
      };
    }
  } // namespace PluginService
} // namespace Gaudi
 
#define _PS_V2_DECLARE_COMPONENT( type )                                                                               \
  namespace {                                                                                                          \
    ::Gaudi::PluginService::v2::DeclareFactory<type> _PS_V2_INTERNAL_FACTORY_REGISTER_CNAME{};                         \
  }
 
#define _PS_V2_DECLARE_COMPONENT_WITH_ID( type, id )                                                                   \
  namespace {                                                                                                          \
    ::Gaudi::PluginService::v2::DeclareFactory<type> _PS_V2_INTERNAL_FACTORY_REGISTER_CNAME{                           \
        ::Gaudi::PluginService::v2::Details::stringify_id( id ) };                                                     \
  }
 
#define _PS_V2_DECLARE_FACTORY( type, factory )                                                                        \
  namespace {                                                                                                          \
    ::Gaudi::PluginService::v2::DeclareFactory<type, factory> _PS_V2_INTERNAL_FACTORY_REGISTER_CNAME{};                \
  }
 
#define _PS_V2_DECLARE_FACTORY_WITH_ID( type, id, factory )                                                            \
  namespace {                                                                                                          \
    ::Gaudi::PluginService::v2::DeclareFactory<type, factory> _PS_V2_INTERNAL_FACTORY_REGISTER_CNAME{                  \
        ::Gaudi::PluginService::v2::Details::stringify_id( id ) };                                                     \
  }
 
#define _PS_V2_DECLARE_COMPONENT_PROPERTY( id, name, value )                                                           \
  namespace {                                                                                                          \
    struct _PS_V2_INTERNAL_SET_PROPERTY {                                                                              \
      _PS_V2_INTERNAL_SET_PROPERTY() {                                                                                 \
        ::Gaudi::PluginService::v2::Details::Registry::instance().addProperty( #id, name, value );                     \
      }                                                                                                                \
    } _ps_v2_internal_set_property;                                                                                    \
  }
 
#if GAUDI_PLUGIN_SERVICE_USE_V2
#  define DECLARE_COMPONENT( type ) _PS_V2_DECLARE_COMPONENT( type )
#  define DECLARE_COMPONENT_WITH_ID( type, id ) _PS_V2_DECLARE_COMPONENT_WITH_ID( type, id )
#  define DECLARE_FACTORY( type, factory ) _PS_V2_DECLARE_FACTORY( type, factory )
#  define DECLARE_FACTORY_WITH_ID( type, id, factory ) _PS_V2_DECLARE_FACTORY_WITH_ID( type, id, factory )
#  define DECLARE_COMPONENT_PROPERTY( id, name, value ) _PS_V2_DECLARE_COMPONENT_PROPERTY( id, name, value )
#endif