optional.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 <optional>     // for optional<>
#include <string>       // for string
#include <type_traits>  // for is_same_v<>, enable_if<>
#include <utility>      // for move
 
#include <fable/schema/interface.hpp>  // for Base<>, Box
#include <fable/utility/optional.hpp>  // for adl_serializer<>
 
namespace fable::schema {
 
template <typename T>
struct is_optional : std::false_type {};
 
template <typename T>
inline constexpr bool is_optional_v = is_optional<T>::value;
 
template <typename T>
struct is_optional<std::optional<T>> : std::true_type {};
 
template <typename T, typename P>
class Optional : public Base<Optional<T, P>> {
  static_assert(is_optional_v<T>);
 
 public:  // Types and Constructors
  using Type = T;
  using ValueType = typename Type::value_type;
  using PrototypeSchema = std::remove_cv_t<std::remove_reference_t<P>>;
 
  Optional(Type* ptr, std::string desc)
      : Optional(ptr, make_prototype<typename T::value_type>(), std::move(desc)) {}
 
  Optional(Type* ptr, PrototypeSchema prototype, std::string desc)
      : Base<Optional<T, P>>(prototype.type(), std::move(desc)), prototype_(std::move(prototype)), ptr_(ptr) {
    prototype_.reset_ptr();
  }
 
 public:  // Overrides
  [[nodiscard]] std::string type_string() const override { return prototype_.type_string() + "?"; }
  [[nodiscard]] bool is_variant() const override { return true; }
 
  [[nodiscard]] Json json_schema() const override {
    Json j{{
        "oneOf",
        {
            Json{
                {"type", "null"},
            },
            prototype_.json_schema(),
        },
    }};
    this->augment_schema(j);
    return j;
  }
 
  bool validate(const Conf& c, std::optional<SchemaError>& err) const override {
    if (c->type() == JsonType::null) {
      return true;
    }
    if (!this->validate_type(c, err)) {
      return false;
    }
    return prototype_.validate(c, err);
  }
 
  using Interface::to_json;
  void to_json(Json& j) const override {
    assert(ptr_ != nullptr);
    j = serialize(*ptr_);
  }
 
  void from_conf(const Conf& c) override {
    assert(ptr_ != nullptr);
    *ptr_ = deserialize(c);
  }
 
  [[nodiscard]] Json serialize(const Type& x) const {
    if (!x) {
      return nullptr;
    }
    return prototype_.serialize(x.value());
  }
 
  [[nodiscard]] Type deserialize(const Conf& c) const {
    if (c->type() == JsonType::null) {
      return Type{};
    }
    return prototype_.deserialize(c);
  }
 
  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 reset_ptr() override { ptr_ = nullptr; }
 
 private:
  PrototypeSchema prototype_;
  Type* ptr_{nullptr};
};
 
// Define make_schema only for std::optional and boost::optional.
template <typename T, typename P, typename S, std::enable_if_t<is_optional_v<T>, bool> = true>
Optional<T, P> make_schema(T* ptr, P&& prototype, S&& desc) {
  return {ptr, std::forward<P>(prototype), std::forward<S>(desc)};
}
 
template <typename T, typename S, std::enable_if_t<is_optional_v<T>, bool> = true>
Optional<T, decltype(make_prototype<typename T::value_type>())> make_schema(T* ptr, S&& desc) {
  return {ptr, std::forward<S>(desc)};
}
 
}  // namespace fable::schema