ISvcLocator.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 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.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_ISVCLOCATOR_H
#define GAUDIKERNEL_ISVCLOCATOR_H 1
 
// Include files
#include <GaudiKernel/IInterface.h>
#include <GaudiKernel/ISvcManager.h>
#include <GaudiKernel/SmartIF.h>
#include <GaudiKernel/TypeNameString.h>
 
#include <list>
#include <string>
 
// Forward class declaration
class IService;
namespace Gaudi::Monitoring {
  struct Hub;
}
 
namespace Gaudi {
  namespace Interfaces {
    struct IOptionsSvc;
  }
} // namespace Gaudi
#define GAUDI_HAS_IOPTIONS_SVC
 
class GAUDI_API ISvcLocator : virtual public IInterface {
public:
  DeclareInterfaceID( ISvcLocator, 3, 0 );
 
#if !defined( GAUDI_V22_API ) || defined( G22_NEW_SVCLOCATOR )
 
  [[deprecated( "use ISvcLocator::service<T>(type_name, createIf) -> SmartIF<T>" )]] virtual StatusCode
  getService( const Gaudi::Utils::TypeNameString& typeName, IService*& svc, const bool createIf = true ) {
    SmartIF<IService>& s = service( typeName, createIf );
    svc                  = s.get();
    if ( svc ) {
      svc->addRef(); // Needed to maintain the correct reference counting.
      return StatusCode::SUCCESS;
    }
    return StatusCode::FAILURE;
  }
 
  [[deprecated( "use ISvcLocator::service<T>(type_name, createIf) -> SmartIF<T>" )]] virtual StatusCode
  getService( const Gaudi::Utils::TypeNameString& typeName, const InterfaceID& iid, IInterface*& pinterface ) {
    auto svc = service( typeName, false );
    return svc ? svc->queryInterface( iid, (void**)&pinterface ) : StatusCode::FAILURE;
  }
 
// virtual StatusCode getService( const Gaudi::Utils::TypeNameString& name,
//                               IService*& svc,
//                               bool createIf ) = 0;
#endif
 
  virtual const std::list<IService*>& getServices() const = 0;
 
  virtual bool existsService( std::string_view name ) const = 0;
 
#if !defined( GAUDI_V22_API ) || defined( G22_NEW_SVCLOCATOR )
  template <class T>
  [[deprecated( "use ISvcLocator::service<T>(type_name, createIf) -> SmartIF<T>" )]] StatusCode
  service( const Gaudi::Utils::TypeNameString& name, T*& svc, bool createIf = true ) {
    if ( createIf ) {
      IService*  s;
      StatusCode sc = getService( name, s, true );
      if ( !sc.isSuccess() ) return sc; // Must check if initialization was OK!
    }
    return getService( name, T::interfaceID(), (IInterface*&)svc );
  }
 
  template <class T>
  [[deprecated( "use ISvcLocator::service<T>(type_name, createIf) -> SmartIF<T>" )]] StatusCode
  service( std::string_view type, std::string_view name, T*& svc, bool createIf = true ) {
    return service( std::string{ type }.append( "/" ).append( name ), svc, createIf );
  }
#endif
 
  virtual SmartIF<IService>& service( const Gaudi::Utils::TypeNameString& typeName, const bool createIf = true ) = 0;
 
  template <typename T>
  inline SmartIF<T> service( const Gaudi::Utils::TypeNameString& typeName, const bool createIf = true ) {
    return SmartIF<T>{ service( typeName, createIf ) };
  }
 
  // try to access a different interface of  the _current_ serviceLocator...
  template <typename IFace>
  SmartIF<IFace> as() {
    return SmartIF<IFace>{ this };
  }
 
  Gaudi::Interfaces::IOptionsSvc& getOptsSvc();
 
  Gaudi::Monitoring::Hub& monitoringHub();
};
 
#endif // GAUDI_ISVCLOCATOR_H