schema.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 <memory>       // for shared_ptr<>
#include <string>       // for string
#include <type_traits>  // for enable_if_t<>, is_arithmetic<>, is_enum<>, ...
#include <utility>      // for move
#include <vector>       // for vector<>
 
#include <fable/fable_fwd.hpp>
#include <fable/schema/array.hpp>      // for Array<>
#include <fable/schema/boolean.hpp>    // for Boolean
#include <fable/schema/confable.hpp>   // for FromConfable
#include <fable/schema/const.hpp>      // for Const<>
#include <fable/schema/duration.hpp>   // for Duration<>
#include <fable/schema/enum.hpp>       // for Enum<>
#include <fable/schema/ignore.hpp>     // for Ignore
#include <fable/schema/interface.hpp>  // for Interface, Box
#include <fable/schema/json.hpp>       // for FromJson<>
#include <fable/schema/map.hpp>        // for Map<>
#include <fable/schema/number.hpp>     // for Number<>
#include <fable/schema/optional.hpp>   // for Optional<>
#include <fable/schema/passthru.hpp>   // for Passthru
#include <fable/schema/path.hpp>       // for Path
#include <fable/schema/string.hpp>     // for String
#include <fable/schema/struct.hpp>     // for Struct
#include <fable/schema/variant.hpp>    // for Variant
#include <fable/schema/vector.hpp>     // for Vector<>
 
// It is important that this include comes after all the other ones,
// so that it has access to ALL the previous definitions.
#include <fable/schema/xmagic.hpp>  // for make_prototype
 
namespace fable {
 
// Bring all make_* functions into the fable namespace.
using schema::make_const_schema;
using schema::make_prototype;
using schema::make_schema;
 
template <typename T>
struct schema_type {
  using type = decltype(make_schema(static_cast<T*>(nullptr), ""));
};
 
class Schema : public schema::Interface {
 public:
  // Operators
  ~Schema() noexcept override = default;
  Schema(const Schema&) = default;
  Schema(Schema&&) = default;
  Schema& operator=(const Schema&) = default;
  Schema& operator=(Schema&&) = default;
 
  // Struct
  Schema(std::string desc, schema::PropertyList<> props)
      : impl_(new schema::Struct(std::move(desc), props)) {}
 
  Schema(schema::PropertyList<> props) : Schema("", props) {}
 
  Schema(std::string desc, const Schema& base, schema::PropertyList<> props)
      : impl_(new schema::Struct(std::move(desc), base, props)) {}
 
  Schema(const Schema& base, schema::PropertyList<> props) : Schema("", base, props) {}
 
  // Variant
  Schema(const std::vector<Schema>& xs);  // NOLINT(runtime/explicit)
  Schema(std::string desc, const std::vector<Schema>& xs);
 
  Schema(schema::BoxList props);  // NOLINT(runtime/explicit)
  Schema(std::string desc, schema::BoxList props);
 
  Schema(schema::BoxVec&& props);  // NOLINT(runtime/explicit)
  Schema(std::string desc, schema::BoxVec&& props);
 
  // Interface
  template <typename T, std::enable_if_t<std::is_base_of_v<schema::Interface, T>, int> = 0>
  Schema(const T& value) : impl_(value.clone()) {}
  Schema(std::unique_ptr<schema::Interface> ptr) : impl_(std::move(ptr)) { assert(impl_); }
  Schema(std::shared_ptr<schema::Interface> ptr) : impl_(std::move(ptr)) { assert(impl_); }
 
  // Ignore
  Schema() : impl_(new schema::Ignore("")) {}
  explicit Schema(std::string desc, JsonType t = JsonType::object)
      : impl_(new schema::Ignore(std::move(desc), t)) {}
 
  // Primitives
  template <typename T>
  Schema(T* ptr, std::string desc) : impl_(make_schema(ptr, std::move(desc)).clone()) {}
  template <typename T>
  Schema(T* ptr, const schema::Box& prototype, std::string desc)
      : impl_(make_schema(ptr, prototype, std::move(desc)).clone()) {}
 
  // FromJson
  template <typename T>
  Schema(T* ptr, JsonType t, std::string desc)
      : impl_(new schema::FromJson<T>(ptr, t, std::move(desc))) {}
 
 public:  // Special
  Schema reset_pointer() && {
    reset_ptr();
    return std::move(*this);
  }
 
  [[nodiscard]] Json json_schema_qualified() const {
    Json j = impl_->json_schema();
    j["$schema"] = "http://json-schema.org/draft-07/schema#";
    return j;
  }
 
  [[nodiscard]] Json json_schema_qualified(const std::string& id) const {
    Json j = json_schema_qualified();
    j["$id"] = id;
    return j;
  }
 
 public:  // Overrides
  using Interface::to_json;
  [[nodiscard]] operator schema::Box() const { return schema::Box{impl_}; }
  [[nodiscard]] std::unique_ptr<Interface> clone() const override { return impl_->clone(); }
  [[nodiscard]] JsonType type() const override { return impl_->type(); }
  [[nodiscard]] std::string type_string() const override { return impl_->type_string(); }
  [[nodiscard]] bool is_required() const override { return impl_->is_required(); }
  [[nodiscard]] const std::string& description() const override { return impl_->description(); }
  void set_description(std::string s) override { return impl_->set_description(std::move(s)); }
  [[nodiscard]] Json usage() const override { return impl_->usage(); }
  [[nodiscard]] Json json_schema() const override { return impl_->json_schema(); }
  bool validate(const Conf& c, std::optional<SchemaError>& err) const override {
    return impl_->validate(c, err);
  }
  void to_json(Json& j) const override { impl_->to_json(j); }
  void from_conf(const Conf& c) override { impl_->from_conf(c); }
  void reset_ptr() override { impl_->reset_ptr(); }
 
  friend void to_json(Json& j, const Schema& s) { s.impl_->to_json(j); }
 
 private:
  std::shared_ptr<schema::Interface> impl_{nullptr};
};
 
}  // namespace fable