1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <algorithm>
#include <functional>
#include <iostream>
#include <iterator>
#include <map>
#include <string>
#include <type_traits>
#include <utility>
#include <vector>
#include <cm/optional>
#include <cm/string_view>
#include <cm3p/json/value.h>
#include "cmJSONState.h"
#include "cmStringAlgorithms.h"
template <typename T>
using cmJSONHelper =
std::function<bool(T& out, Json::Value const* value, cmJSONState* state)>;
using ErrorGenerator = std::function<void(Json::Value const*, cmJSONState*)>;
namespace JsonErrors {
enum ObjectError
{
RequiredMissing,
InvalidObject,
ExtraField,
MissingRequired
};
using ErrorGenerator = std::function<void(Json::Value const*, cmJSONState*)>;
using ObjectErrorGenerator =
std::function<ErrorGenerator(ObjectError, Json::Value::Members const&)>;
ErrorGenerator EXPECTED_TYPE(std::string const& type);
void INVALID_STRING(Json::Value const* value, cmJSONState* state);
void INVALID_BOOL(Json::Value const* value, cmJSONState* state);
void INVALID_INT(Json::Value const* value, cmJSONState* state);
void INVALID_UINT(Json::Value const* value, cmJSONState* state);
ObjectErrorGenerator INVALID_NAMED_OBJECT(
std::function<std::string(Json::Value const*, cmJSONState*)> const&
nameGenerator);
ErrorGenerator INVALID_OBJECT(ObjectError errorType,
Json::Value::Members const& extraFields);
ErrorGenerator INVALID_NAMED_OBJECT_KEY(
ObjectError errorType, Json::Value::Members const& extraFields);
}
#if __cplusplus >= 201703L
namespace details {
// A meta-function to check if a given callable type
// can be called with the only string ref arg.
template <typename F, typename Enable = void>
struct is_bool_filter
{
static constexpr bool value = false;
};
template <typename F>
struct is_bool_filter<F,
std::enable_if_t<std::is_same_v<
std::invoke_result_t<F, std::string const&>, bool>>>
{
static constexpr bool value = true;
};
}
#endif
struct cmJSONHelperBuilder
{
template <typename T>
class Object
{
public:
Object(JsonErrors::ObjectErrorGenerator error = JsonErrors::INVALID_OBJECT,
bool allowExtra = true)
: Error(std::move(error))
, AllowExtra(allowExtra)
{
}
template <typename U, typename M, typename F>
Object& Bind(cm::string_view const& name, M U::*member, F func,
bool required = true)
{
return this->BindPrivate(
name,
[func, member](T& out, Json::Value const* value, cmJSONState* state)
-> bool { return func(out.*member, value, state); },
required);
}
template <typename M, typename F>
Object& Bind(cm::string_view const& name, std::nullptr_t, F func,
bool required = true)
{
return this->BindPrivate(
name,
[func](T& /*out*/, Json::Value const* value,
cmJSONState* state) -> bool {
M dummy;
return func(dummy, value, state);
},
required);
}
template <typename F>
Object& Bind(cm::string_view const& name, F func, bool required = true)
{
return this->BindPrivate(name, MemberFunction(func), required);
}
bool operator()(T& out, Json::Value const* value, cmJSONState* state) const
{
Json::Value::Members extraFields;
if (!value && this->AnyRequired) {
Error(JsonErrors::ObjectError::RequiredMissing, extraFields)(value,
state);
return false;
}
if (value && !value->isObject()) {
Error(JsonErrors::ObjectError::InvalidObject, extraFields)(value,
state);
return false;
}
if (value) {
extraFields = value->getMemberNames();
}
if (state->allowComments) {
extraFields.erase(
std::remove(extraFields.begin(), extraFields.end(), "$comment"),
extraFields.end());
}
bool success = true;
for (auto const& m : this->Members) {
std::string name(m.Name.data(), m.Name.size());
state->push_stack(name, value);
if (value && value->isMember(name)) {
if (!m.Function(out, &(*value)[name], state)) {
success = false;
}
extraFields.erase(
std::find(extraFields.begin(), extraFields.end(), name));
} else if (!m.Required) {
if (!m.Function(out, nullptr, state)) {
success = false;
}
} else {
Error(JsonErrors::ObjectError::MissingRequired, extraFields)(value,
state);
success = false;
}
state->pop_stack();
}
if (!this->AllowExtra && !extraFields.empty()) {
Error(JsonErrors::ObjectError::ExtraField, extraFields)(value, state);
success = false;
}
return success;
}
private:
// Not a true cmJSONHelper, it just happens to match the signature
using MemberFunction = std::function<bool(T& out, Json::Value const* value,
cmJSONState* state)>;
struct Member
{
Member(cm::string_view name, MemberFunction func, bool required)
: Name{ name }
, Function{ std::move(func) }
, Required{ required }
{
}
cm::string_view Name;
MemberFunction Function;
bool Required;
};
std::vector<Member> Members;
bool AnyRequired = false;
JsonErrors::ObjectErrorGenerator Error;
bool AllowExtra;
Object& BindPrivate(cm::string_view const& name, MemberFunction&& func,
bool required)
{
this->Members.emplace_back(name, std::move(func), required);
this->AnyRequired = this->AnyRequired || required;
return *this;
}
};
static cmJSONHelper<std::string> String(
JsonErrors::ErrorGenerator const& error = JsonErrors::INVALID_STRING,
std::string const& defval = "")
{
return [error, defval](std::string& out, Json::Value const* value,
cmJSONState* state) -> bool {
if (!value) {
out = defval;
return true;
}
if (!value->isString()) {
error(value, state);
return false;
}
out = value->asString();
return true;
};
};
static cmJSONHelper<std::string> String(std::string const& defval)
{
return String(JsonErrors::INVALID_STRING, defval);
};
static cmJSONHelper<int> Int(
JsonErrors::ErrorGenerator const& error = JsonErrors::INVALID_INT,
int defval = 0)
{
return [error, defval](int& out, Json::Value const* value,
cmJSONState* state) -> bool {
if (!value) {
out = defval;
return true;
}
if (!value->isInt()) {
error(value, state);
return false;
}
out = value->asInt();
return true;
};
}
static cmJSONHelper<int> Int(int defval)
{
return Int(JsonErrors::INVALID_INT, defval);
};
static cmJSONHelper<unsigned int> UInt(
JsonErrors::ErrorGenerator const& error = JsonErrors::INVALID_UINT,
unsigned int defval = 0)
{
return [error, defval](unsigned int& out, Json::Value const* value,
cmJSONState* state) -> bool {
if (!value) {
out = defval;
return true;
}
if (!value->isUInt()) {
error(value, state);
return false;
}
out = value->asUInt();
return true;
};
}
static cmJSONHelper<unsigned int> UInt(unsigned int defval)
{
return UInt(JsonErrors::INVALID_UINT, defval);
}
static cmJSONHelper<bool> Bool(
JsonErrors::ErrorGenerator const& error = JsonErrors::INVALID_BOOL,
bool defval = false)
{
return [error, defval](bool& out, Json::Value const* value,
cmJSONState* state) -> bool {
if (!value) {
out = defval;
return true;
}
if (!value->isBool()) {
error(value, state);
return false;
}
out = value->asBool();
return true;
};
}
static cmJSONHelper<bool> Bool(bool defval)
{
return Bool(JsonErrors::INVALID_BOOL, defval);
}
template <typename T, typename F, typename Filter>
static cmJSONHelper<std::vector<T>> VectorFilter(
JsonErrors::ErrorGenerator const& error, F func, Filter filter)
{
return [error, func, filter](std::vector<T>& out, Json::Value const* value,
cmJSONState* state) -> bool {
bool success = true;
if (!value) {
out.clear();
return true;
}
if (!value->isArray()) {
error(value, state);
return false;
}
out.clear();
int index = 0;
for (auto const& item : *value) {
state->push_stack(cmStrCat("$vector_item_", index++), &item);
T t;
if (!func(t, &item, state)) {
success = false;
}
if (!filter(t)) {
state->pop_stack();
continue;
}
out.push_back(std::move(t));
state->pop_stack();
}
return success;
};
}
template <typename T, typename F>
static cmJSONHelper<std::vector<T>> Vector(JsonErrors::ErrorGenerator error,
F func)
{
return VectorFilter<T, F>(std::move(error), func,
[](T const&) { return true; });
}
enum class FilterResult
{
Continue, ///< A filter has accepted a given key (and value)
Skip, ///< A filter has rejected a given key (or value)
Error ///< A filter has found and reported an error
};
/// Iterate over the object's members and call a filter callable to
/// decide what to do with the current key/value.
/// A filter returns one of the `FilterResult` values.
/// A container type is an associative or a sequence
/// container of pairs (key, value).
template <typename Container, typename F, typename Filter>
static cmJSONHelper<Container> FilteredObject(
JsonErrors::ErrorGenerator const& error, F func, Filter filter)
{
return [error, func, filter](Container& out, Json::Value const* value,
cmJSONState* state) -> bool {
// NOTE Some compile-time code path don't use `filter` at all.
// So, suppress "unused lambda capture" warning is needed.
static_cast<void>(filter);
if (!value) {
out.clear();
return true;
}
if (!value->isObject()) {
error(value, state);
return false;
}
out.clear();
auto outIt = std::inserter(out, out.end());
bool success = true;
for (auto const& key : value->getMemberNames()) {
state->push_stack(key, &(*value)[key]);
#if __cplusplus >= 201703L
if constexpr (std::is_same_v<Filter, std::true_type>) {
// Filtering functionality isn't needed at all...
} else if constexpr (details::is_bool_filter<Filter>::value) {
// A given `Filter` is `bool(const std::string&)` callable.
if (!filter(key)) {
state->pop_stack();
continue;
}
} else {
#endif
// A full-featured `Filter` has been given
auto res = filter(key, &(*value)[key], state);
if (res == FilterResult::Skip) {
state->pop_stack();
continue;
}
if (res == FilterResult::Error) {
state->pop_stack();
success = false;
break;
}
#if __cplusplus >= 201703L
}
#endif
typename Container::value_type::second_type t;
// ATTENTION Call the function first (for it's side-effects),
// then accumulate the result!
success = func(t, &(*value)[key], state) && success;
outIt = typename Container::value_type{ key, std::move(t) };
state->pop_stack();
}
return success;
};
}
template <typename T, typename F, typename Filter>
static cmJSONHelper<std::map<std::string, T>> MapFilter(
JsonErrors::ErrorGenerator const& error, F func, Filter filter)
{
// clang-format off
return FilteredObject<std::map<std::string, T>>(
error, func,
#if __cplusplus >= 201703L
// In C++ 17 a filter callable can be passed as is.
// Depending on its type `FilteredObject()` will call
// it with a key only (backward compatible behavior)
// or with 3 args supported by the full-featured
// filtering feature.
filter
#else
// For C++14 and below, to keep backward compatibility
// with CMake Presets code, `MapFilter()` can accept only
// `bool(const std::string&)` callables.
[filter](const std::string &key, const Json::Value * /*value*/,
cmJSONState * /*state*/) -> FilterResult {
// Simple adaptor to translate `bool` to `FilterResult`
return filter(key) ? FilterResult::Continue : FilterResult::Skip;
}
#endif
);
// clang-format on
}
template <typename T, typename F>
static cmJSONHelper<std::map<std::string, T>> Map(
JsonErrors::ErrorGenerator const& error, F func)
{
// clang-format off
return FilteredObject<std::map<std::string, T>>(
error, func,
#if __cplusplus >= 201703L
// With C++ 17 and above, pass a marker type, that no
// filtering is needed at all.
std::true_type()
#else
// In C++ 14 and below, pass an always-true dummy functor.
[](const std::string& /*key*/, const Json::Value* /*value*/,
cmJSONState* /*state*/) -> FilterResult {
return FilterResult::Continue;
}
#endif
);
// clang-format on
}
template <typename T, typename F>
static cmJSONHelper<cm::optional<T>> Optional(F func)
{
return [func](cm::optional<T>& out, Json::Value const* value,
cmJSONState* state) -> bool {
if (!value) {
out.reset();
return true;
}
out.emplace();
return func(*out, value, state);
};
}
template <typename T, typename F>
static cmJSONHelper<T> Required(JsonErrors::ErrorGenerator const& error,
F func)
{
return [error, func](T& out, Json::Value const* value,
cmJSONState* state) -> bool {
if (!value) {
error(value, state);
return false;
}
return func(out, value, state);
};
}
template <typename T, typename F, typename P>
static cmJSONHelper<T> Checked(JsonErrors::ErrorGenerator const& error,
F func, P predicate)
{
return [error, func, predicate](T& out, Json::Value const* value,
cmJSONState* state) -> bool {
bool result = func(out, value, state);
if (result && !predicate(out)) {
error(value, state);
result = false;
}
return result;
};
}
};
|