YAMLreader.hh

Go to the documentation of this file.

 
#pragma once
 
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
#include "yaml-cpp/yaml.h"
 
#include "fastjet/JetDefinition.hh"
 
#include "HEJ/Config.hh"
#include "HEJ/Fraction.hh"
#include "HEJ/PDG_codes.hh"
#include "HEJ/exceptions.hh"
#include "HEJ/utility.hh"
 
namespace HEJ {
  struct OutputFile;
 
  Config load_config(std::string const & config_file);
 
 
  Config to_Config(YAML::Node const & yaml);
 
 
  template<typename T, typename... YamlNames>
  void set_from_yaml(
      T & setting,
      YAML::Node const & yaml, YamlNames const & ... names
  );
 
 
  template<typename T, typename... YamlNames>
  void set_from_yaml_if_defined(
      T & setting,
      YAML::Node const & yaml, YamlNames const & ... names
  );
 
  JetParameters get_jet_parameters(
      YAML::Node const & node, std::string const & entry
  );
 
  HiggsCouplingSettings get_Higgs_coupling(
      YAML::Node const & node, std::string const & entry
  );
 
  EWConstants get_ew_parameters(YAML::Node const & node);
 
  ScaleConfig to_ScaleConfig(YAML::Node const & yaml);
 
  RNGConfig to_RNGConfig(YAML::Node const & node, std::string const & entry);
 
  NLOConfig to_NLOConfig(YAML::Node const & node, std::string const & entry);
 
 
  void assert_all_options_known(
      YAML::Node const & conf, YAML::Node const & supported
  );
 
  namespace detail{
    void set_from_yaml(fastjet::JetAlgorithm & setting, YAML::Node const & yaml);
    void set_from_yaml(EventTreatment & setting, YAML::Node const & yaml);
    void set_from_yaml(ParticleID & setting, YAML::Node const & yaml);
    void set_from_yaml(OutputFile & setting, YAML::Node const & yaml);
    void set_from_yaml(WeightType & setting, YAML::Node const & yaml);
 
    inline
    void set_from_yaml(YAML::Node & setting, YAML::Node const & yaml){
      setting = yaml;
    }
 
    template<typename Scalar>
    void set_from_yaml(Scalar & setting, YAML::Node const & yaml){
      assert(yaml);
      if(!yaml.IsScalar()){
        throw invalid_type{"value is not a scalar"};
      }
      try{
        setting = yaml.as<Scalar>();
      }
      catch(...){
        throw invalid_type{
          "value " + yaml.as<std::string>()
          + " cannot be converted to a " + type_string(setting)
        };
      }
    }
 
    template<typename T>
    void set_from_yaml(std::optional<T> & setting, YAML::Node const & yaml){
      T tmp{};
      set_from_yaml(tmp, yaml);
      setting = tmp;
    }
 
    template<typename T>
    void set_from_yaml(std::vector<T> & setting, YAML::Node const & yaml){
      assert(yaml);
      // special case: treat a single value like a vector with one element
      if(yaml.IsScalar()){
        setting.resize(1);
        return set_from_yaml(setting.front(), yaml);
      }
      if(yaml.IsSequence()){
        setting.resize(yaml.size());
        for(size_t i = 0; i < setting.size(); ++i){
          set_from_yaml(setting[i], yaml[i]);
        }
        return;
      }
      throw invalid_type{""};
    }
 
    template<typename T, typename FirstName, typename... YamlNames>
    void set_from_yaml(
        T & setting,
        YAML::Node const & yaml, FirstName const & name,
        YamlNames && ... names
    ){
      if(!yaml[name]) throw missing_option{""};
      set_from_yaml(
          setting,
          yaml[name], std::forward<YamlNames>(names)...
      );
    }
 
    template<typename T>
    void set_from_yaml_if_defined(T & setting, YAML::Node const & yaml){
      return set_from_yaml(setting, yaml);
    }
 
    template<typename T, typename FirstName, typename... YamlNames>
    void set_from_yaml_if_defined(
        T & setting,
        YAML::Node const & yaml, FirstName const & name,
        YamlNames && ... names
    ){
      if(!yaml[name]) return;
      set_from_yaml_if_defined(
          setting,
          yaml[name], std::forward<YamlNames>(names)...
      );
    }
  } // namespace detail
 
  template<typename T, typename... YamlNames>
  void set_from_yaml(
      T & setting,
      YAML::Node const & yaml, YamlNames const & ... names
  ){
    try{
      detail::set_from_yaml(setting, yaml, names...);
    }
    catch(invalid_type const & ex){
      throw invalid_type{
        "In option " + join(": ", names...) + ": " + ex.what()
      };
    }
    catch(missing_option const &){
      throw missing_option{
        "No entry for mandatory option " + join(": ", names...)
      };
    }
    catch(std::invalid_argument const & ex){
      throw missing_option{
        "In option " + join(": ", names...) + ":"
          " invalid value " + ex.what()
      };
    }
  }
 
  template<typename T, typename... YamlNames>
  void set_from_yaml_if_defined(
      T & setting,
      YAML::Node const & yaml, YamlNames const & ... names
  ){
    try{
      detail::set_from_yaml_if_defined(setting, yaml, names...);
    }
    catch(invalid_type const & ex){
      throw invalid_type{
        "In option " + join(": ", names...) + ": " + ex.what()
      };
    }
    catch(std::invalid_argument const & ex){
      throw missing_option{
        "In option " + join(": ", names...) + ":"
          " invalid value " + ex.what()
      };
    }
  }
 
  std::string to_string(YAML::Node const & yaml);
} // namespace HEJ
 
namespace YAML {
 
  template<>
  struct convert<HEJ::OutputFile> {
    static Node encode(HEJ::OutputFile const & outfile);
    static bool decode(Node const & node, HEJ::OutputFile & out);
  };
 
  template<class Real>
  struct convert<HEJ::Fraction<Real>> {
    static Node encode(HEJ::Fraction<Real> const & f) {
      return convert<Real>::encode(Real{f});
    }
    static bool decode(Node const & node, HEJ::Fraction<Real> & f) {
      Real r;
      if(!convert<Real>::decode(node, r)) return false;
      f = r;
      return true;
    }
  };
} // namespace YAML