conf.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <filesystem>  // for path
#include <functional>  // for function<>
#include <string>      // for string
#include <utility>     // for move
#include <vector>      // for vector<>
 
#include <fmt/format.h>  // for fmt::format
 
#include <fable/fable_fwd.hpp>  // for ConfError
#include <fable/json.hpp>       // for Json
 
namespace fable {
 
class Conf {
 public:
  Conf() = default;
  explicit Conf(Json data) : data_(std::move(data)) {}
  explicit Conf(std::string file);
  Conf(Json data, std::string file) : file_(std::move(file)), data_(std::move(data)) {}
  Conf(Json data, std::string file, std::string root)
      : file_(std::move(file)), root_(std::move(root)), data_(std::move(data)) {}
 
  [[nodiscard]] bool is_from_file() const { return !file_.empty(); }
 
  [[nodiscard]] const std::string& file() const { return file_; }
 
  [[nodiscard]] bool is_empty() const { return data_.is_null(); }
 
  const Json& operator*() const { return data_; }
 
  Json& operator*() { return data_; }
 
  const Json* operator->() const { return &data_; }
 
  Json* operator->() { return &data_; }
 
  [[nodiscard]] std::string root() const { return (root_.empty() ? "/" : root_); }
 
  [[nodiscard]] bool has(const std::string& key) const { return data_.count(key) != 0; }
 
  [[nodiscard]] bool has(const JsonPointer& ptr) const;
 
  [[nodiscard]] bool has_pointer(const std::string& ptr) const { return has(JsonPointer(ptr)); }
 
  [[nodiscard]] Conf at(const std::string& key) const;
 
  [[nodiscard]] Conf at(const JsonPointer& ptr) const;
 
  [[nodiscard]] Conf at_pointer(const std::string& ptr) const { return at(JsonPointer(ptr)); }
 
  size_t erase(const std::string& key);
 
  size_t erase(const JsonPointer& ptr, bool preserve_empty = false);
 
  size_t erase_pointer(const std::string& ptr, bool preserve_empty = false) {
    return erase(JsonPointer(ptr), preserve_empty);
  }
 
  [[nodiscard]] std::vector<Conf> to_array() const;
 
  template <typename T>
  [[nodiscard]] T get() const {
    try {
      return data_.get<T>();
    } catch (Json::type_error&) {
      throw_wrong_type();
    }
  }
 
  template <typename T>
  [[nodiscard]] T get(const std::string& key) const {
    try {
      return data_.at(key).get<T>();
    } catch (Json::out_of_range&) {
      throw_missing(key);
    } catch (Json::type_error&) {
      throw_wrong_type(key);
    }
  }
 
  template <typename T>
  [[nodiscard]] T get(const JsonPointer& ptr) const {
    try {
      return data_.at(ptr).get<T>();
    } catch (Json::out_of_range&) {
      throw_missing(ptr);
    } catch (Json::type_error&) {
      throw_wrong_type(ptr);
    }
  }
 
  template <typename T>
  [[nodiscard]] T get_pointer(const std::string& ptr) const {
    return get<T>(JsonPointer(ptr));
  }
 
  template <typename T>
  [[nodiscard]] T get_or(const std::string& key, T def) const {
    if (!data_.count(key)) {
      return def;
    }
    try {
      return data_.at(key).get<T>();
    } catch (Json::type_error&) {
      throw_wrong_type(key);
    }
  }
 
  template <typename T>
  [[nodiscard]] T get_or(const JsonPointer& ptr, T def) const {
    try {
      return data_.at(ptr).get<T>();
    } catch (Json::out_of_range&) {
      return def;
    } catch (Json::type_error&) {
      throw_wrong_type(ptr);
    }
  }
 
  template <typename T>
  [[nodiscard]] T get_pointer_or(const std::string& ptr, T def) const {
    return get_or(JsonPointer(ptr), def);
  }
 
  template <typename T>
  void with(const std::string& key, std::function<void(const T&)> fn) const {
    if (data_.count(key)) {
      fn(get<T>(key));
    }
  }
 
  template <typename T>
  void with(const JsonPointer& ptr, std::function<void(const T&)> fn) const {
    try {
      fn(get<T>(ptr));
    } catch (Json::out_of_range&) {
      return;
    }
  }
 
  template <typename T>
  void with_pointer(const std::string& ptr, std::function<void(const T&)> fn) const {
    with(JsonPointer(ptr), fn);
  }
 
  template <typename T>
  void try_from(const std::string& key, T& val) const {
    if (data_.count(key)) {
      val = get<T>(key);
    }
  }
 
  template <typename T>
  void try_from(const JsonPointer& ptr, T& val) const {
    try {
      val = data_.at(ptr).get<T>();
    } catch (Json::out_of_range& e) {
      return;
    } catch (Json::type_error& e) {
      throw_wrong_type(ptr);
    }
  }
 
  template <typename T>
  void try_from_pointer(const std::string& ptr, T& val) const {
    try_from(JsonPointer(ptr), val);
  }
 
  void assert_has(const std::string& key) const;
 
  void assert_has(const JsonPointer& ptr) const;
 
  void assert_has_pointer(const std::string& key) const { assert_has(JsonPointer(key)); }
 
  void assert_has_type(const std::string& key, JsonType t) const;
 
  void assert_has_type(const JsonPointer& ptr, JsonType t) const;
 
  void assert_has_pointer_type(const std::string& ptr, JsonType t) const {
    assert_has_type(JsonPointer(ptr), t);
  }
 
  void assert_has_not(const std::string& key, const std::string& msg = "") const;
 
  void assert_has_not(const JsonPointer& ptr, const std::string& msg = "") const;
 
  void assert_has_pointer_not(const std::string& ptr, const std::string& msg = "") const {
    assert_has_not(JsonPointer(ptr), msg);
  }
 
  [[nodiscard]] std::filesystem::path resolve_file(const std::filesystem::path& filename) const;
 
  [[nodiscard]] std::string resolve_file(const std::string& filename) const;
 
  template <typename... Args>
  [[noreturn]] void throw_error(std::string_view format, Args&&... args) const {
    throw_error(fmt::format(fmt::runtime(format), std::forward<Args>(args)...));
  }
 
  [[noreturn]] void throw_error(const std::string& msg) const;
 
  [[noreturn]] void throw_unexpected(const std::string& key, const std::string& msg = "") const;
 
  [[noreturn]] void throw_unexpected(const JsonPointer& ptr, const std::string& msg = "") const;
 
  [[noreturn]] void throw_missing(const std::string& key) const;
 
  [[noreturn]] void throw_missing(const JsonPointer& ptr) const;
 
  [[noreturn]] void throw_wrong_type(const std::string& key = "") const;
 
  [[noreturn]] void throw_wrong_type(const JsonPointer& ptr) const;
 
  [[noreturn]] void throw_wrong_type(const std::string& key, JsonType expected) const;
 
  [[noreturn]] void throw_wrong_type(const JsonPointer& ptr, JsonType expected) const;
 
  friend void to_json(Json& j, const Conf& c) { j = *c; }
 
  friend void from_json(const Json& j, Conf& c) { *c = j; }
 
 private:
  std::string file_;
  std::string root_;
  Json data_;
};
 
}  // namespace fable