confable.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 unique_ptr<>
#include <optional>  // for optional<>
 
#include <fable/conf.hpp>       // for Conf, Json
#include <fable/fable_fwd.hpp>  // for Schema, SchemaError
 
#define CONFABLE_FRIENDS(xType)                                           \
  using ::fable::Confable::to_json;                                       \
  friend void to_json(::fable::Json& j, const xType& t) { t.to_json(j); } \
  friend void from_json(const ::fable::Json& j, xType& t) { t.from_conf(::fable::Conf{j}); }
 
#define CONFABLE_SCHEMA(xType) \
  CONFABLE_FRIENDS(xType)      \
  ::fable::Schema schema_impl() override
 
namespace fable {
 
class Confable {
 public:
  Confable() noexcept = default;
  Confable(const Confable& /*unused*/) noexcept;
  Confable(Confable&&) noexcept = default;
  Confable& operator=(const Confable& other) noexcept;
  Confable& operator=(Confable&& other) noexcept;
 
  virtual ~Confable() noexcept = default;
 
  virtual void reset_schema();
 
  [[nodiscard]] Schema& schema();
 
  [[nodiscard]] const Schema& schema() const;
 
  virtual void validate_or_throw(const Conf& c) const;
 
  virtual bool validate(const Conf& c, std::optional<SchemaError>& err) const;
 
  virtual void from_conf(const Conf& c);
 
  virtual void to_json(Json& j) const;
 
  [[nodiscard]] Json to_json() const;
 
 protected:
  [[nodiscard]] virtual Schema schema_impl();
 
 private:
  mutable std::unique_ptr<Schema> schema_;
};
 
}  // namespace fable
 
namespace nlohmann {
 
template <>
struct adl_serializer<fable::Confable> {
  static void to_json(json& j, const fable::Confable& c);
  static void from_json(const json& j, fable::Confable& c);
};
 
}  // namespace nlohmann