json-validator/include/jvalidate/forward.h

#pragma once

#include <concepts>
#include <functional>
#include <iosfwd>
#include <string>
#include <string_view>
#include <type_traits>
#include <variant>

#include <jvalidate/compat/expected.h>

#define DISCARD1_IMPL(_, ...) __VA_ARGS__
#define DISCARD1(...) DISCARD1_IMPL(__VA_ARGS__)

#define FORWARD_DECLARE_STRUCT(TYPE) struct TYPE;

#define COMMA_NAME(X) , X

namespace jvalidate::detail {
}
namespace jvalidate::adapter::detail {
using namespace jvalidate::detail;
}
namespace jvalidate::format::detail {
using namespace jvalidate::detail;
}

namespace jvalidate {
class Schema;
class Status;
class URI;
struct ValidationConfig;
class ValidationResult;
}

namespace jvalidate::adapter {
enum class Type : int8_t;
class Adapter;
class Const;

using AdapterCallback = std::function<Status(adapter::Adapter const &)>;
using ObjectAdapterCallback = std::function<Status(std::string const &, adapter::Adapter const &)>;

template <typename> struct AdapterTraits;
template <typename V> struct AdapterTraits<V const> : AdapterTraits<V> {};

template <typename JSON> using AdapterFor = typename AdapterTraits<JSON>::template Adapter<JSON>;
template <typename JSON>
auto load_stream(std::istream & in, JSON & out) noexcept -> detail::expected<void, std::string>;
}

namespace jvalidate::schema {
enum class Version : int;
class Node;
}

namespace jvalidate::constraint {
#define CONSTRAINT_IMPLEMENTATION_LIST(X)                                                          \
  /* General Constraints - See jvalidate/constraint/general_constraint.h */                        \
  X(TypeConstraint)                                                                                \
  X(ConstConstraint)                                                                               \
  X(EnumConstraint)                                                                                \
  X(AllOfConstraint)                                                                               \
  X(AnyOfConstraint)                                                                               \
  X(OneOfConstraint)                                                                               \
  X(NotConstraint)                                                                                 \
  X(ConditionalConstraint)                                                                         \
  /* Number Constraints - See jvalidate/constraint/number_constraint.h */                          \
  X(MaximumConstraint)                                                                             \
  X(MinimumConstraint)                                                                             \
  X(MultipleOfConstraint)                                                                          \
  /* String Constraints - See jvalidate/constraint/string_constraint.h */                          \
  X(MaxLengthConstraint)                                                                           \
  X(MinLengthConstraint)                                                                           \
  X(PatternConstraint)                                                                             \
  X(FormatConstraint)                                                                              \
  /* Array Constraints - See jvalidate/constraint/array_constraint.h */                            \
  X(AdditionalItemsConstraint)                                                                     \
  X(ContainsConstraint)                                                                            \
  X(MaxItemsConstraint)                                                                            \
  X(MinItemsConstraint)                                                                            \
  X(TupleConstraint)                                                                               \
  X(UnevaluatedItemsConstraint)                                                                    \
  X(UniqueItemsConstraint)                                                                         \
  /* Object Constraints - See jvalidate/constraint/object_constraint.h */                          \
  X(AdditionalPropertiesConstraint)                                                                \
  X(DependenciesConstraint)                                                                        \
  X(MaxPropertiesConstraint)                                                                       \
  X(MinPropertiesConstraint)                                                                       \
  X(PatternPropertiesConstraint)                                                                   \
  X(PropertiesConstraint)                                                                          \
  X(PropertyNamesConstraint)                                                                       \
  X(RequiredConstraint)                                                                            \
  X(UnevaluatedPropertiesConstraint)                                                               \
  /* ExtensionConstraint - A special constraint for all user-defined constraints */                \
  X(ExtensionConstraint)

CONSTRAINT_IMPLEMENTATION_LIST(FORWARD_DECLARE_STRUCT);

using Constraint = std::variant<DISCARD1(CONSTRAINT_IMPLEMENTATION_LIST(COMMA_NAME))>;
using SubConstraint = std::variant<schema::Node const *, std::unique_ptr<Constraint>>;
}

namespace jvalidate {
template <typename It>
concept ArrayIterator =
    std::forward_iterator<It> and std::is_default_constructible_v<It> and requires(It const it) {
      { *it } -> std::convertible_to<adapter::Adapter const &>;
    };

template <typename It>
concept ObjectIterator =
    std::forward_iterator<It> and std::is_default_constructible_v<It> and requires(It const it) {
      { it->first } -> std::convertible_to<std::string_view>;
      { it->second } -> std::convertible_to<adapter::Adapter const &>;
    };

template <typename A, typename Reentrant>
concept ArrayAdapter = requires(A const a) {
  { a.size() } -> std::convertible_to<std::size_t>;
  { a[0UL] } -> std::same_as<Reentrant>;
  { a.begin() } -> ArrayIterator;
  { a.end() } -> ArrayIterator;
};

template <typename A, typename Reentrant>
concept ObjectAdapter = requires(A const a) {
  { a.size() } -> std::convertible_to<std::size_t>;
  { a.contains("") } -> std::same_as<bool>;
  { a[""] } -> std::same_as<Reentrant>;
  { a.begin() } -> ObjectIterator;
  { a.end() } -> ObjectIterator;
};

/**
 * @brief A concept representing the actual adapter form. Used in most code
 * that actually cares to interact with JSON, instead of having to define a
 * template like AdapterInterface<ArrayAdapter, ObjectAdapter> for the basic
 * adapter, or return pointers-to-interfaces in order to access array/object
 * data.
 *
 * This concept functionally defines an Adapter being an AdapterInterface with
 * an as_array and as_object method added on.
 */
template <typename A>
concept Adapter = std::is_base_of_v<adapter::Adapter, A> && requires(A const a) {
  typename A::value_type;
  { a.type() } -> std::same_as<adapter::Type>;
  { a.as_boolean() } -> std::same_as<bool>;
  { a.as_integer() } -> std::convertible_to<int64_t>;
  { a.as_number() } -> std::convertible_to<double>;
  { a.as_number() } -> std::floating_point;
  { a.as_object() } -> ObjectAdapter<A>;
  { a.as_array() } -> ArrayAdapter<A>;

  { a.array_size() } -> std::convertible_to<size_t>;
  { a.object_size() } -> std::convertible_to<size_t>;
};

template <typename A, typename Reentrant>
concept MutableObject = ObjectAdapter<A, Reentrant> && requires(A const a) {
  { a.assign("", std::declval<adapter::Const>()) };
};

template <typename A>
concept HasMutableObject = MutableObject<decltype(std::declval<A>().as_object()), A>;

/**
 * @brief An extension of Adapter that is capable of altering the underlying
 * JSON node. In general, that means that a non-const ref is captured when
 * building an Adapter.
 *
 * Requires that we can assign both to "this", and to values at a key (in the
 * case of object type).
 * Implies that as_array is also a wrapper for mutable JSON.
 */
template <typename A>
concept MutableAdapter = Adapter<A> && requires(A const a) {
  { a.assign(std::declval<adapter::Const>()) };
  { a.assign(std::declval<adapter::Adapter>()) };
  { a.as_object() } -> MutableObject<A>;
};

template <typename R>
concept RegexEngine = requires(R & engine) {
  { R::engine_name() } -> std::convertible_to<std::string_view>;
  { R::is_regex("") } -> std::same_as<bool>;
  { engine.search("" /* pattern */, "" /* text */) } -> std::same_as<bool>;
};

template <typename E, typename A, typename B, typename V>
concept Visitable = Adapter<A> && requires(V & v, E const & c, A const & doc, B const & base) {
  { v.visit(c, doc, base) } -> std::same_as<Status>;
};

template <typename T, typename S>
concept Not = not std::is_same_v<std::decay_t<T>, std::decay_t<S>>;
}

namespace jvalidate {
template <Adapter A> class ConstraintFactory;
template <Adapter A> class DocumentCache;

template <Adapter Root, RegexEngine RE, typename ExtensionVisitor> class ValidationVisitor;

template <RegexEngine RE, typename ExtensionVisitor> class Validator;

template <Adapter A>
using URIResolver = auto (*)(URI const &, typename A::value_type &) noexcept
    -> detail::expected<void, std::string>;
}

namespace jvalidate::extension {
struct VisitorBase;
template <typename CRTP, typename... Es> class Visitor;
}

#undef FORWARD_DECLARE_STRUCT
#undef COMMA_NAME
#undef DISCARD1_IMPL
#undef DISCARD1