factory.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 <functional>   // for function<>
#include <limits>       // for numeric_limits<>
#include <map>          // for map<>
#include <memory>       // for shared_ptr<>
#include <string>       // for string
#include <type_traits>  // for enable_if_t<>, is_base_of<>
#include <utility>      // for move
#include <vector>       // for vector<>
 
#include <fable/schema/const.hpp>      // for Const
#include <fable/schema/interface.hpp>  // for Base<>, Box
#include <fable/schema/string.hpp>     // for String
#include <fable/schema/struct.hpp>     // for Struct
#include <fable/schema/variant.hpp>    // for Variant
 
namespace fable::schema {
 
template <typename T, typename CRTP>
class FactoryBase : public Base<CRTP> {
 public:  // Types
  using Type = T;
  using MakeFunc = std::function<T(const Conf& c)>;
 
  struct TypeFactory {
    TypeFactory(Box s, MakeFunc f) : schema(std::move(s)), func(std::move(f)) {
      schema.reset_ptr();
    }
 
    Box schema;     // NOLINT
    MakeFunc func;  // NOLINT
  };
 
  using TransformFunc = std::function<Box(Struct&&)>;
  using FactoryMap = std::map<std::string, TypeFactory>;
  using FactoryPairList = std::initializer_list<std::pair<std::string, TypeFactory>>;
 
 public:  // Constructors
  ~FactoryBase() noexcept override = default;
 
 protected:
  FactoryBase(const FactoryBase& other)
      : Base<CRTP>(other)
      , transform_func_(other.transform_func_)
      , available_(other.available_)
      , factory_key_(other.factory_key_)
      , args_key_(other.args_key_)
      , args_subset_(other.args_subset_) {
    reset_schema();
  }
 
  FactoryBase& operator=(const FactoryBase& other) {
    if (&other == this) {
      return *this;
    }
    Base<CRTP>::operator=(other);
    transform_func_ = other.transform_func_;
    available_ = other.available_;
    factory_key_ = other.factory_key_;
    args_key_ = other.args_key_;
    args_subset_ = other.args_subset_;
    reset_schema();
    return *this;
  }
 
  FactoryBase(FactoryBase&&) noexcept = default;
 
  FactoryBase& operator=(FactoryBase&&) noexcept = default;
 
 public:
  explicit FactoryBase(std::string desc = "") : Base<CRTP>(JsonType::object, std::move(desc)) {}
 
  FactoryBase(std::string desc, FactoryPairList fs)
      : Base<CRTP>(JsonType::object, std::move(desc)), available_(std::move(fs)) {
    reset_schema();
  }
 
  FactoryBase(std::string desc, FactoryMap&& fs)
      : Base<CRTP>(JsonType::object, std::move(desc)), available_(std::move(fs)) {
    reset_schema();
  }
 
  CRTP factory_key(const std::string& keyword) && {
    set_factory_key(keyword);
    return std::move(*dynamic_cast<CRTP*>(this));
  }
 
  CRTP args_key(const std::string& keyword) && {
    set_args_key(keyword);
    return std::move(*dynamic_cast<CRTP*>(this));
  }
 
  CRTP args_subset(bool value) && {
    set_args_subset(value);
    return std::move(*dynamic_cast<CRTP*>(this));
  }
 
  CRTP transform_schema(TransformFunc f) && {
    set_transform_schema(f);
    return std::move(*dynamic_cast<CRTP*>(this));
  }
 
 public:  // Special
  void set_factory_key(const std::string& keyword) {
    assert(!keyword.empty());
    factory_key_ = keyword;
    reset_schema();
  }
 
  void set_args_key(const std::string& keyword) {
    args_key_ = keyword;
    reset_schema();
  }
 
  void set_args_subset(bool value) { args_subset_ = value; }
 
  void set_transform_schema(TransformFunc f) { transform_func_ = std::move(f); }
 
  [[nodiscard]] const TypeFactory& get_factory(const std::string& key) const {
    return available_.at(key);
  }
 
  [[nodiscard]] std::vector<std::string> get_factory_keys() const {
    std::vector<std::string> keys;
    for (const auto& [key, value] : available_) {
      keys.emplace_back(key);
    }
    return keys;
  }
 
  [[nodiscard]] bool has_factory(const std::string& key) const { return available_.count(key); }
 
  bool add_factory(const std::string& key, Box&& s, MakeFunc f) {
    if (!available_.count(key)) {
      available_.insert(std::make_pair(key, TypeFactory{std::move(s), std::move(f)}));
      reset_schema();
      return true;
    }
    return false;
  }
 
  void set_factory(const std::string& key, Box&& s, MakeFunc f) {
    if (!available_.count(key)) {
      available_.erase(key);
    }
    available_.insert(std::make_pair(key, TypeFactory{std::move(s), std::move(f)}));
    reset_schema();
  }
 
  template <typename F,
            std::enable_if_t<(std::is_default_constructible_v<F> &&
                              std::is_convertible_v<std::unique_ptr<F>, T>),
                             int> = 0>
  void add_default_factory(const std::string& key) {
    add_factory(key, make_prototype<F>().get_confable_schema(), [](const Conf& c) -> T {
      auto ptr = std::make_unique<F>();
      ptr->from_conf(c);
      return ptr;
    });
  }
 
 public:  // Overrides
  [[nodiscard]] Json json_schema() const override {
    Json j;
    if (available_.empty()) {
      j["not"] = Json{
          {"description", "no variants available"},
      };
    } else {
      j["oneOf"] = factory_json_schemas();
    }
    this->augment_schema(j);
    return j;
  }
 
  bool validate(const Conf& c, std::optional<SchemaError>& err) const override {
    assert(schema_ != nullptr);
    auto factory = c.get<std::string>(factory_key_);
    if (!available_.count(factory)) {
      return this->set_error(err, c, "unknown factory: {}", factory);
    }
 
    return schema_->validate(c, err);
  }
 
  [[nodiscard]] Type make(const Conf& c) const { return deserialize(c); }
 
  [[nodiscard]] Type deserialize(const Conf& c) const {
    assert(schema_ != nullptr);
    auto factory = c.get<std::string>(factory_key_);
    if (!available_.count(factory)) {
      throw this->error(c, "unknown factory: {}", factory);
    }
 
    Conf args;
    if (args_subset_) {
      if (!args_key_.empty()) {
        if (c.has(args_key_)) {
          args = c.at(args_key_);
        }
      } else {
        args = c;
        args.erase(factory_key_);
      }
    } else {
      args = c;
    }
 
    return available_.at(factory).func(args);
  }
 
  [[nodiscard]] Json serialize(const Type& x) const { return x; }
 
  void serialize_into(Json& j, const Type& x) const { j = serialize(x); }
 
  void deserialize_into(const Conf& c, Type& x) const { x = deserialize(c); }
 
  void from_conf(const Conf& /* unused */) override {
    throw std::logic_error("FactoryBase::from_conf() should not be used");
  }
 
  using Interface::to_json;
  void to_json(Json& /* unused */) const override {
    throw std::logic_error("FactoryBase::to_json() should not be used");
  }
 
  void reset_ptr() override {
    // No pointer, so nothing to do here.
  }
 
 protected:
  void reset_schema() {
    if (available_.size() == 0) {
      return;
    }
    schema_ = std::make_unique<Variant>(factory_schemas());
  }
 
  [[nodiscard]] std::vector<Box> factory_schemas() const {
    std::vector<Box> out;
    out.reserve(available_.size());
    for (auto& kv : available_) {
      Struct base{
          {factory_key_, make_const_schema(kv.first, "name of factory").require()},
      };
      if (args_key_.empty()) {
        base.set_properties_from(kv.second.schema);
      } else {
        base.set_property(args_key_, kv.second.schema.clone());
      }
      base.reset_ptr();
 
      if (transform_func_) {
        out.emplace_back(transform_func_(std::move(base)));
      } else {
        out.emplace_back(std::move(base));
      }
    }
    return out;
  }
 
  [[nodiscard]] std::vector<Json> factory_json_schemas() const {
    auto schemas = factory_schemas();
    std::vector<Json> out;
    out.reserve(schemas.size());
    for (auto& s : schemas) {
      out.emplace_back(s.json_schema());
    }
    return out;
  }
 
 protected:
  std::unique_ptr<Variant> schema_;
  TransformFunc transform_func_;
  FactoryMap available_;
  std::string factory_key_{"factory"};
  std::string args_key_{"args"};
  bool args_subset_{true};
};
 
template <typename T>
class FactoryPointerless : public FactoryBase<T, FactoryPointerless<T>> {
 public:
  using FactoryBase<T, FactoryPointerless<T>>::FactoryBase;
  FactoryPointerless() = default;
  FactoryPointerless(const FactoryPointerless<T>& other) = default;
  FactoryPointerless(FactoryPointerless<T>&& other) noexcept = default;
  FactoryPointerless<T>& operator=(const FactoryPointerless<T>& other) = default;
  FactoryPointerless<T>& operator=(FactoryPointerless<T>&& other) noexcept = default;
  ~FactoryPointerless() override = default;
};
 
template <typename T>
class Factory : public FactoryBase<T, Factory<T>> {
 public:  // Types
  using Type = typename FactoryBase<T, Factory<T>>::Type;
  using MakeFunc = typename FactoryBase<T, Factory<T>>::MakeFunc;
  using TypeFactory = typename FactoryBase<T, Factory<T>>::TypeFactory;
  using FactoryMap = typename FactoryBase<T, Factory<T>>::FactoryMap;
  using FactoryPairList = typename FactoryBase<T, Factory<T>>::FactoryPairList;
 
 public:  // Constructors
  using FactoryBase<T, Factory<T>>::FactoryBase;
  Factory(const Factory<T>& other) = default;
  Factory(Factory<T>&& other) noexcept = default;
  Factory<T>& operator=(const Factory<T>& other) = default;
  Factory<T>& operator=(Factory<T>&& other) noexcept = default;
  ~Factory() override = default;
 
  Factory(Type* ptr, std::string desc) : FactoryBase<T, Factory<T>>(std::move(desc)), ptr_(ptr) {}
 
  Factory(Type* ptr, std::string desc, FactoryMap&& fs)
      : FactoryBase<T, Factory<T>>(std::move(desc)), ptr_(ptr) {
    for (auto&& f : fs) {
      this->available_.insert(f);
    }
    this->reset_schema();
  }
 
  Factory(Type* ptr, std::string desc, FactoryPairList fs)
      : FactoryBase<T, Factory<T>>(std::move(desc)), ptr_(ptr) {
    for (auto&& f : fs) {
      this->available_.insert(f);
    }
    this->reset_schema();
  }
 
 public:  // Overrides
  void from_conf(const Conf& c) override {
    assert(ptr_ != nullptr);
    *ptr_ = this->deserialize(c);
  }
 
  void to_json(Json& j) const override {
    assert(ptr_ != nullptr);
    j = this->serialize(*ptr_);
  }
 
  void reset_ptr() override { ptr_ = nullptr; }
 
 private:
  Type* ptr_{nullptr};
};
 
}  // namespace fable::schema