mkfit::ConfigJsonPatcher Class Reference

#include <IterationConfig.h>

Classes
struct	PatchReport

Public Member Functions
void	cd (const std::string &path)
void	cd_top (const std::string &path="")
void	cd_up (const std::string &path="")
	ConfigJsonPatcher (bool verbose=false)
std::string	dump (int indent=2)
nlohmann::json &	get (const std::string &path)
template<class T >
void	load (const T &o)
template<typename T >
void	replace (const std::string &path, T val)
template<typename T >
void	replace (int first, int last, const std::string &path, T val)
int	replace (const nlohmann::json &j)
template<>
void	save (IterationsInfo &o)
template<class T >
void	save (T &o)
	~ConfigJsonPatcher ()

Private Member Functions
std::string	exc_hdr (const char *func=nullptr) const
std::string	get_abs_path () const

Private Attributes
nlohmann::json *	m_current = nullptr
std::unique_ptr< nlohmann::json >	m_json
std::vector< nlohmann::json * >	m_json_stack
std::vector< std::string >	m_path_stack
bool	m_verbose = false

Detailed Description

Definition at line 303 of file IterationConfig.h.

Constructor & Destructor Documentation

ConfigJsonPatcher()

mkfit::ConfigJsonPatcher::ConfigJsonPatcher

(

bool

verbose = false

)

Definition at line 224 of file IterationConfig.cc.

: m_verbose(verbose) {}

~ConfigJsonPatcher()

mkfit::ConfigJsonPatcher::~ConfigJsonPatcher ( )

default

Member Function Documentation

cd()

void mkfit::ConfigJsonPatcher::cd

(

const std::string &

path

)

Definition at line 275 of file IterationConfig.cc.

References m_current, m_json_stack, m_path_stack, and castor_dqm_sourceclient_file_cfg::path.

Referenced by cd_top(), cd_up(), dqm_interfaces.DQMcommunicator::get_root_objects_list_recursive(), dqm_interfaces.DQMcommunicator::get_root_objects_names_list_recursive(), dqm_interfaces.DQMcommunicator::get_root_objects_recursive(), replace(), mkfit::ConfigJson::test_Patcher(), and dqm_interfaces.DirWalkerFile::walk().

                                                  {
    nlohmann::json::json_pointer jp(path);
    m_json_stack.push_back(m_current);
    m_path_stack.push_back(path);
    m_current = &m_current->at(jp);
  }

cd_top()

void mkfit::ConfigJsonPatcher::cd_top

(

const std::string &

path = ""

)

Definition at line 293 of file IterationConfig.cc.

References cd(), m_current, m_json, m_json_stack, m_path_stack, and castor_dqm_sourceclient_file_cfg::path.

Referenced by load(), mkfit::ConfigJson::patch_Files(), mkfit::ConfigJson::patchLoad_File(), and mkfit::ConfigJson::test_Patcher().

                                                      {
    m_current = m_json.get();
    m_json_stack.clear();
    m_path_stack.clear();
    if (!path.empty())
      cd(path);
  }

cd_up()

void mkfit::ConfigJsonPatcher::cd_up

(

const std::string &

path = ""

)

Definition at line 282 of file IterationConfig.cc.

References cd(), m_current, m_json_stack, m_path_stack, and castor_dqm_sourceclient_file_cfg::path.

Referenced by replace().

                                                     {
    if (m_json_stack.empty())
      throw std::runtime_error("JSON stack empty on cd_up");

    m_current = m_json_stack.back();
    m_json_stack.pop_back();
    m_path_stack.pop_back();
    if (!path.empty())
      cd(path);
  }

dump()

std::string mkfit::ConfigJsonPatcher::dump

(

int

indent = 2

)

Definition at line 442 of file IterationConfig.cc.

References validateAlignments::indent, and m_json.

Referenced by mkfit::ConfigJson::test_Patcher().

{ return m_json->dump(indent); }

exc_hdr()

std::string mkfit::ConfigJsonPatcher::exc_hdr ( const char *  func = nullptr ) const

private

Definition at line 236 of file IterationConfig.cc.

References EcalMonitorTask_cff::func, get_abs_path(), alignCSCRings::s, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by replace().

                                                             {
    std::string s;
    s.reserve(128);
    s = "ConfigJsonPatcher";
    if (func) {
      s += "::";
      s += func;
    }
    s += " '";
    s += get_abs_path();
    s += "' ";
    return s;
  }

get()

nlohmann::json & mkfit::ConfigJsonPatcher::get

(

const std::string &

path

)

Definition at line 321 of file IterationConfig.cc.

References m_current, and castor_dqm_sourceclient_file_cfg::path.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), and mkfit::ConfigJson::test_Patcher().

                                                            {
    nlohmann::json::json_pointer jp(path);
    return m_current->at(jp);
  }

get_abs_path()

std::string mkfit::ConfigJsonPatcher::get_abs_path ( ) const

private

Definition at line 228 of file IterationConfig.cc.

References m_path_stack, AlCaHLTBitMon_ParallelJobs::p, alignCSCRings::s, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by exc_hdr(), and replace().

                                                  {
    std::string s;
    s.reserve(64);
    for (auto &p : m_path_stack)
      s += p;
    return s;
  }

load()

template<class T >

template void mkfit::ConfigJsonPatcher::load< IterationConfig >

(

const T &

o

)

Definition at line 251 of file IterationConfig.cc.

References cd_top(), m_json, and EcalTangentSkim_cfg::o.

Referenced by mkfit::ConfigJson::patch_Files(), mkfit::ConfigJson::patchLoad_File(), and mkfit::ConfigJson::test_Patcher().

                                         {
    m_json = std::make_unique<nlohmann::json>();
    *m_json = o;
    cd_top();
  }

replace() [1/3]

template<typename T >

void mkfit::ConfigJsonPatcher::replace	(	const std::string &	path,
		T	val
	)

Definition at line 302 of file IterationConfig.cc.

References m_current, castor_dqm_sourceclient_file_cfg::path, and heppy_batch::val.

Referenced by mkfit::ConfigJson::patch_Files(), mkfit::ConfigJson::patchLoad_File(), replace(), and mkfit::ConfigJson::test_Patcher().

                                                              {
    nlohmann::json::json_pointer jp(path);
    m_current->at(jp) = val;
  }

replace() [2/3]

template<typename T >

void mkfit::ConfigJsonPatcher::replace	(	int	first,
		int	last,
		const std::string &	path,
		T	val
	)

Definition at line 311 of file IterationConfig.cc.

References dqmdumpme::first, mps_fire::i, dqmdumpme::last, m_current, castor_dqm_sourceclient_file_cfg::path, and heppy_batch::val.

                                                                                   {
    nlohmann::json::json_pointer jp(path);
    for (int i = first; i <= last; ++i) {
      m_current->at(i).at(jp) = val;
    }
  }

replace() [3/3]

int mkfit::ConfigJsonPatcher::replace

(

const nlohmann::json &

j

)

Definition at line 326 of file IterationConfig.cc.

References cd(), cd_up(), gather_cfg::cout, exc_hdr(), dqmdumpme::first, get_abs_path(), mps_fire::i, createfilelist::int, dqmiolumiharvest::j, crabWrapper::key, dqmdumpme::last, visualization-live-secondInstance_cfg::m, m_current, m_verbose, replace(), alignCSCRings::s, AlCaHLTBitMon_QueryRunRegistry::string, cond::impl::to_string(), and relativeConstraints::value.

                                                      {
    if (j.is_null())
      throw std::runtime_error(exc_hdr(__func__) + "null not expected");

    if (j.is_boolean() || j.is_number() || j.is_string()) {
      throw std::runtime_error(exc_hdr(__func__) + "value not expected on this parsing level");
    }

    int n_replaced = 0;

    if (j.is_object()) {
      static const std::regex index_range_re("^\\[(\\d+)..(\\d+)\\]$", std::regex::optimize);

      for (auto &[key, value] : j.items()) {
        std::smatch m;
        std::regex_search(key, m, index_range_re);

        if (m.size() == 3) {
          if (!m_current->is_array())
            throw std::runtime_error(exc_hdr(__func__) + "array range encountered when current json is not an array");
          int first = std::stoi(m.str(1));
          int last = std::stoi(m.str(2));
          for (int i = first; i <= last; ++i) {
            std::string s("/");
            s += std::to_string(i);
            cd(s);
            if (value.is_array()) {
              for (auto &el : value)
                n_replaced += replace(el);
            } else {
              n_replaced += replace(value);
            }
            cd_up();
          }
        } else if (value.is_array() || value.is_object()) {
          std::string s("/");
          s += key;
          cd(s);
          n_replaced += replace(value);
          cd_up();
        } else if (value.is_number() || value.is_boolean() || value.is_string()) {
          std::string s("/");
          s += key;
          nlohmann::json::json_pointer jp(s);
          if (m_current->at(jp) != value) {
            if (m_verbose)
              std::cout << "  " << get_abs_path() << s << ": " << m_current->at(jp) << " -> " << value << "\n";

            m_current->at(jp) = value;
            ++n_replaced;
          }
        } else {
          throw std::runtime_error(exc_hdr(__func__) + "unexpected value type");
        }
      }
    } else if (j.is_array() && j.empty()) {
    } else if (j.is_array()) {
      // Arrays are somewhat tricky.
      // At the moment all elements are expected to be objects.
      //    This means arrays of basic types are not supported (like layer index arrays).
      //    Should not be too hard to add support for this.
      // Now, the objects in the array can be of two kinds:
      // a) Their keys can be json_pointer strings starting with numbers or ranges [i_low..i_high].
      // b) They can be actual elements of the array. In this case we require the length of
      //    the array to be equal to existing length in the configuration.
      // It is not allowed for these two kinds to mix.

      // Determine the kind of array: json_ptr or object

      static const std::regex index_re("^(?:\\[\\d+..\\d+\\]|\\d+(?:/.*)?)$", std::regex::optimize);

      bool has_index = false, has_plain = false;
      for (int i = 0; i < (int)j.size(); ++i) {
        const nlohmann::json &el = j[i];

        if (!el.is_object())
          throw std::runtime_error(exc_hdr(__func__) + "array elements expected to be objects");

        for (nlohmann::json::const_iterator it = el.begin(); it != el.end(); ++it) {
          if (std::regex_search(it.key(), index_re)) {
            has_index = true;
            if (has_plain)
              throw std::runtime_error(exc_hdr(__func__) + "indexed array entry following plain one");
          } else {
            has_plain = true;
            if (has_index)
              throw std::runtime_error(exc_hdr(__func__) + "plain array entry following indexed one");
          }
        }
      }
      if (has_index) {
        for (auto &element : j) {
          n_replaced += replace(element);
        }
      } else {
        if (m_current && !m_current->is_array())
          throw std::runtime_error(exc_hdr(__func__) + "plain array detected when current is not an array");
        if (m_current->size() != j.size())
          throw std::runtime_error(exc_hdr(__func__) + "plain array of different size than at current pos");

        std::string s;
        for (int i = 0; i < (int)j.size(); ++i) {
          s = "/";
          s += std::to_string(i);
          cd(s);
          n_replaced += replace(j[i]);
          cd_up();
        }
      }
    } else {
      throw std::runtime_error(exc_hdr(__func__) + "unexpected json type");
    }

    return n_replaced;
  }

save() [1/2]

template<>

void mkfit::ConfigJsonPatcher::save

(

IterationsInfo &

o

)

Definition at line 268 of file IterationConfig.cc.

References mkfit::from_json(), mps_fire::i, and EcalTangentSkim_cfg::o.

                                                                {
    auto &itc_arr = m_json->at("m_iterations");
    for (int i = 0; i < o.size(); ++i) {
      from_json(itc_arr[i], o[i]);
    }
  }

save() [2/2]

template<class T >

template void mkfit::ConfigJsonPatcher::save< IterationConfig >

(

T &

o

)

Definition at line 260 of file IterationConfig.cc.

References mkfit::from_json(), m_json, and EcalTangentSkim_cfg::o.

Referenced by mkfit::ConfigJson::patch_Files(), mkfit::ConfigJson::patchLoad_File(), and mkfit::ConfigJson::test_Patcher().

                                   {
    from_json(*m_json, o);
  }

Member Data Documentation

m_current

nlohmann::json* mkfit::ConfigJsonPatcher::m_current = nullptr

private

Definition at line 325 of file IterationConfig.h.

Referenced by cd(), cd_top(), cd_up(), get(), and replace().

m_json

std::unique_ptr<nlohmann::json> mkfit::ConfigJsonPatcher::m_json

private

Definition at line 324 of file IterationConfig.h.

Referenced by cd_top(), dump(), load(), and save().

m_json_stack

std::vector<nlohmann::json *> mkfit::ConfigJsonPatcher::m_json_stack

private

Definition at line 328 of file IterationConfig.h.

Referenced by cd(), cd_top(), and cd_up().

m_path_stack

std::vector<std::string> mkfit::ConfigJsonPatcher::m_path_stack

private

Definition at line 329 of file IterationConfig.h.

Referenced by cd(), cd_top(), cd_up(), and get_abs_path().

m_verbose

bool mkfit::ConfigJsonPatcher::m_verbose = false

private

Definition at line 331 of file IterationConfig.h.

Referenced by replace().