IOptionsSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 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 "COPYING".                                            *
*                                                                                   *
* 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 <GaudiKernel/IInterface.h>
#include <GaudiKernel/TaggedBool.h>
#include <regex>
#include <string>
#include <tuple>
#include <vector>
 
namespace Gaudi {
  namespace Details {
    class PropertyBase;
  }
  namespace Interfaces {
    struct IOptionsSvc : virtual public IInterface {
      DeclareInterfaceID( IOptionsSvc, 1, 0 );

      virtual void set( const std::string& key, const std::string& value ) = 0;
      virtual std::string get( const std::string& key, const std::string& default_ = {} ) const = 0;
      virtual std::string pop( const std::string& key, const std::string& default_ = {} ) = 0;
      virtual bool has( const std::string& key ) const = 0;
      virtual bool isSet( const std::string& key ) const = 0;


      virtual std::vector<std::tuple<std::string, std::string>> items() const = 0;
      template <class UnaryPredicate>
      std::vector<std::tuple<std::string, std::string>> items( UnaryPredicate predicate ) const {
        auto v = this->items();
        v.erase( std::remove_if( begin( v ), end( v ),
                                 [&predicate]( const auto& element ) { return !predicate( element ); } ),
                 v.end() );
        return v;
      }

      std::vector<std::tuple<std::string, std::string>> items( const std::regex& filter ) const {
        std::smatch match;
        return items(
            [&filter, &match]( const auto& element ) { return regex_match( std::get<0>( element ), match, filter ); } );
      }


      virtual void bind( const std::string& prefix, Gaudi::Details::PropertyBase* property ) = 0;
 
      using OnlyDefaults = Gaudi::tagged_bool<class OnlyDefaults_tag>;

      virtual void broadcast( const std::regex& filter, const std::string& value,
                              OnlyDefaults defaults = OnlyDefaults{ true } ) = 0;

      virtual StatusCode readOptions( std::string_view file, std::string_view path = "" ) = 0;
 
    protected:
      virtual ~IOptionsSvc() = default;
    };
  } // namespace Interfaces
} // namespace Gaudi