jsonschema.h

#ifndef SOURCEMETA_CORE_JSONSCHEMA_H_
#define SOURCEMETA_CORE_JSONSCHEMA_H_
 
#ifndef SOURCEMETA_CORE_JSONSCHEMA_EXPORT
#include <sourcemeta/core/jsonschema_export.h>
#endif
 
#include <sourcemeta/core/json.h>
#include <sourcemeta/core/jsonpointer.h>
 
// NOLINTBEGIN(misc-include-cleaner)
#include <sourcemeta/core/jsonschema_error.h>
#include <sourcemeta/core/jsonschema_frame.h>
#include <sourcemeta/core/jsonschema_types.h>
// NOLINTEND(misc-include-cleaner)
 
#include <cstdint>     // std::uint8_t, std::uint64_t
#include <functional>  // std::function
#include <limits>      // std::numeric_limits
#include <optional>    // std::optional, std::nullopt
#include <string_view> // std::string_view

 
namespace sourcemeta::core {

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_resolver(const std::string_view identifier) -> SchemaResolverResult;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_is_known(const std::string_view identifier) noexcept -> bool;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_is_official(const std::string_view identifier) noexcept -> bool;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_walker(const std::string_view keyword,
                   const SchemaVocabularies &vocabularies)
    -> const SchemaWalkerResult &;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_reidentify(sourcemeta::core::JSON &schema,
                       std::string_view new_identifier,
                       const SchemaResolver &resolver,
                       std::string_view default_dialect = "") -> void;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_identifier_keyword(const SchemaBaseDialect base_dialect)
    -> std::string_view;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_reidentify(sourcemeta::core::JSON &schema,
                       std::string_view new_identifier,
                       const SchemaBaseDialect base_dialect) -> void;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_format(sourcemeta::core::JSON &schema, const SchemaFrame &frame)
    -> void;

struct SchemaBundleOptions {
  using Callback = std::function<void(std::string_view,
                                      const sourcemeta::core::WeakPointer &)>;

  enum class Mode : std::uint8_t {
    NonOfficialMetaschemas,
    References
  };

  Mode mode{Mode::NonOfficialMetaschemas};
  std::optional<sourcemeta::core::Pointer> default_container;
  SchemaFrame::Paths paths{sourcemeta::core::EMPTY_WEAK_POINTER};
  std::string_view default_base;
  std::uint64_t max_locations{std::numeric_limits<std::uint64_t>::max()};
  Callback callback;
};

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_bundle(sourcemeta::core::JSON &schema, const SchemaWalker &walker,
                   const SchemaResolver &resolver,
                   std::string_view default_dialect = "",
                   std::string_view default_id = "",
                   const SchemaBundleOptions &options = {}) -> void;

SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto schema_bundle(const sourcemeta::core::JSON &schema,
                   const SchemaWalker &walker, const SchemaResolver &resolver,
                   std::string_view default_dialect = "",
                   std::string_view default_id = "",
                   const SchemaBundleOptions &options = {})
    -> sourcemeta::core::JSON;
 
} // namespace sourcemeta::core
 
#endif