const.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 <string>   // for string
#include <utility>  // for move
 
#include <fable/schema/interface.hpp>  // for Base<>, Box
#include <fable/schema/string.hpp>     // for String
 
namespace fable::schema {
 
template <typename T, typename P>
class Const : public Base<Const<T, P>> {
 public:  // Types and Constructors
  using Type = std::remove_cv_t<std::remove_reference_t<T>>;
  using PrototypeSchema = std::remove_cv_t<std::remove_reference_t<P>>;
 
  Const(Type constant, std::string desc)
      : Const(std::move(constant), make_prototype<Type>(), std::move(desc)) {}
 
  Const(Type constant, PrototypeSchema prototype, std::string desc)
      : Base<Const<T, P>>(prototype.type(), std::move(desc))
      , prototype_(std::move(prototype))
      , constant_(std::move(constant)) {
    prototype_.reset_ptr();
  }
 
 public:  // Overrides
  [[nodiscard]] Json json_schema() const override {
    Json j{
        {"const", constant_},
    };
    this->augment_schema(j);
    return j;
  }
 
  bool validate(const Conf& c, std::optional<SchemaError>& err) const override {
    Type tmp = prototype_.deserialize(c);
    if (tmp != constant_) {
      return this->set_error(err, c, "expected const value {}, got {}", constant_, tmp);
    }
    return true;
  }
 
  using Interface::to_json;
  void to_json(Json& j) const override { j = serialize(constant_); }
 
  void from_conf(const Conf& c) override { this->validate_or_throw(c); }
 
  [[nodiscard]] Json serialize(const Type& x) const { return prototype_.serialize(x); }
 
  [[nodiscard]] Type deserialize(const Conf& c) const {
    this->validate_or_throw(c);
    return constant_;
  }
 
  void serialize_into(Json& j, const Type& x) const { prototype_.serialize_into(j, x); }
 
  void deserialize_into(const Conf& c, Type& x) const {
    this->validate_or_throw(c);
    x = constant_;
  }
 
  void reset_ptr() override {}
 
 private:
  PrototypeSchema prototype_;
  Type constant_;
};
 
template <typename T, typename P, typename S>
Const<T, P> make_const_schema(T&& constant, P&& prototype, S&& desc) {
  return {std::forward<T>(constant), std::forward<P>(prototype), std::forward<S>(desc)};
}
 
template <typename T, typename S>
Const<T, decltype(make_prototype<std::remove_cv_t<std::remove_reference_t<T>>>())> make_const_schema(T&& constant, S&& desc) {
  return {std::forward<T>(constant), std::forward<S>(desc)};
}
 
}  // namespace fable::schema