Sourcemeta Core 0.0.0
Loading...
Searching...
No Matches
jsonschema.h
1#ifndef SOURCEMETA_CORE_JSONSCHEMA_H_
2#define SOURCEMETA_CORE_JSONSCHEMA_H_
3
4#ifndef SOURCEMETA_CORE_JSONSCHEMA_EXPORT
5#include <sourcemeta/core/jsonschema_export.h>
6#endif
7
8#include <sourcemeta/core/json.h>
9#include <sourcemeta/core/jsonpointer.h>
10
11// NOLINTBEGIN(misc-include-cleaner)
12#include <sourcemeta/core/jsonschema_dependencies.h>
13#include <sourcemeta/core/jsonschema_error.h>
14#include <sourcemeta/core/jsonschema_frame.h>
15#include <sourcemeta/core/jsonschema_types.h>
16// NOLINTEND(misc-include-cleaner)
17
18#include <cstdint> // std::uint8_t, std::uint64_t
19#include <functional> // std::function
20#include <limits> // std::numeric_limits
21#include <optional> // std::optional, std::nullopt
22#include <string_view> // std::string_view
23
43
44namespace sourcemeta::core {
45
50SOURCEMETA_CORE_JSONSCHEMA_EXPORT
51auto schema_resolver(const std::string_view identifier) -> SchemaResolverResult;
52
55SOURCEMETA_CORE_JSONSCHEMA_EXPORT
56auto schema_is_known(const std::string_view identifier) noexcept -> bool;
57
61SOURCEMETA_CORE_JSONSCHEMA_EXPORT
62auto schema_is_official(const std::string_view identifier) noexcept -> bool;
63
66SOURCEMETA_CORE_JSONSCHEMA_EXPORT
67auto schema_walker(const std::string_view keyword,
68 const SchemaVocabularies &vocabularies)
69 -> const SchemaWalkerResult &;
70
95SOURCEMETA_CORE_JSONSCHEMA_EXPORT
97 std::string_view new_identifier,
98 const SchemaWalker &walker,
99 const SchemaResolver &resolver,
100 std::string_view default_dialect = "") -> void;
101
116SOURCEMETA_CORE_JSONSCHEMA_EXPORT
118 -> std::string_view;
119
145SOURCEMETA_CORE_JSONSCHEMA_EXPORT
147 std::string_view new_identifier,
148 const SchemaBaseDialect base_dialect) -> void;
149
182SOURCEMETA_CORE_JSONSCHEMA_EXPORT
184 -> void;
185
196 using Callback = std::function<void(std::string_view,
198
200 enum class Mode : std::uint8_t {
204 NonOfficialMetaschemas,
207 References
208 };
209
213 std::optional<sourcemeta::core::Pointer> default_container{};
220 std::string_view default_base{};
229 std::uint64_t max_locations{std::numeric_limits<std::uint64_t>::max()};
234};
235
288SOURCEMETA_CORE_JSONSCHEMA_EXPORT
290 const SchemaResolver &resolver,
291 std::string_view default_dialect = "",
292 std::string_view default_id = "",
293 const SchemaBundleOptions &options = {}) -> std::uint64_t;
294
346SOURCEMETA_CORE_JSONSCHEMA_EXPORT
348 const SchemaWalker &walker, const SchemaResolver &resolver,
349 std::string_view default_dialect = "",
350 std::string_view default_id = "",
351 const SchemaBundleOptions &options = {})
353
354} // namespace sourcemeta::core
355
356#endif
Definition json_value.h:39
const WeakPointer EMPTY_WEAK_POINTER
Definition jsonpointer.h:56
GenericPointer< std::reference_wrapper< const std::string >, PropertyHashJSON< JSON::String > > WeakPointer
Definition jsonpointer.h:46
std::vector< sourcemeta::core::WeakPointer > Paths
A list of paths to frame within a schema wrapper.
Definition jsonschema_frame.h:164
Callback callback
Definition jsonschema.h:233
Mode
The strategies that the bundling process can follow.
Definition jsonschema.h:200
@ NonOfficialMetaschemas
Definition jsonschema.h:204
SchemaFrame::Paths paths
The paths to bundle within a schema wrapper.
Definition jsonschema.h:215
std::function< void(std::string_view, const sourcemeta::core::WeakPointer &)> Callback
Definition jsonschema.h:196
std::string_view default_base
Definition jsonschema.h:220
Mode mode
The strategy to follow.
Definition jsonschema.h:211
std::uint64_t max_locations
Definition jsonschema.h:229
std::optional< sourcemeta::core::Pointer > default_container
Where to embed what bundling pulls in.
Definition jsonschema.h:213
Definition jsonschema_frame.h:57
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_identifier_keyword(const SchemaBaseDialect base_dialect) -> std::string_view
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_resolver(const std::string_view identifier) -> SchemaResolverResult
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_format(sourcemeta::core::JSON &schema, const SchemaFrame &frame) -> void
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={}) -> std::uint64_t
sourcemeta::core::OwnedOrReference< sourcemeta::core::JSON > SchemaResolverResult
Definition jsonschema_types.h:24
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_walker(const std::string_view keyword, const SchemaVocabularies &vocabularies) -> const SchemaWalkerResult &
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_is_official(const std::string_view identifier) noexcept -> bool
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_is_known(const std::string_view identifier) noexcept -> bool
std::function< SchemaResolverResult(std::string_view)> SchemaResolver
Definition jsonschema_types.h:41
std::function< const SchemaWalkerResult &( std::string_view, const SchemaVocabularies &)> SchemaWalker
Definition jsonschema_types.h:254
SchemaBaseDialect
Definition jsonschema_types.h:54
SOURCEMETA_CORE_JSONSCHEMA_EXPORT auto schema_reidentify(sourcemeta::core::JSON &schema, std::string_view new_identifier, const SchemaWalker &walker, const SchemaResolver &resolver, std::string_view default_dialect="") -> void
Definition jsonschema.h:188
Definition jsonschema_vocabularies.h:31
Definition jsonschema_types.h:211