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
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef TOOLS_JSON_SCHEMA_COMPILER_MANIFEST_PARSE_UTIL_H_
#define TOOLS_JSON_SCHEMA_COMPILER_MANIFEST_PARSE_UTIL_H_
#include <string>
#include <vector>
#include "base/check.h"
#include "base/strings/string_piece.h"
#include "base/strings/string_piece_forward.h"
#include "base/values.h"
#include "tools/json_schema_compiler/util.h"
namespace json_schema_compiler {
namespace manifest_parse_util {
// This file contains helpers used by auto-generated manifest parsing code.
// Populates |error| and |error_path_reversed| denoting the given invalid enum
// |value| at the given |key|.
void PopulateInvalidEnumValueError(
base::StringPiece key,
base::StringPiece value,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// Returns array parse error for `item_error` at index `error_index`
std::u16string GetArrayParseError(size_t error_index,
const std::u16string& item_error);
// Populates manifest parse |error| for the given path in |error_path_reversed|.
void PopulateFinalError(std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// Returns the value at the given |key| in |dict|, ensuring that it's of the
// |expected_type|. On failure, returns false and populates |error| and
// |error_path_reversed|.
const base::Value* FindKeyOfType(
const base::Value::Dict& dict,
base::StringPiece key,
base::Value::Type expected_type,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// Parses |out| from |dict| at the given |key|. On failure, returns false and
// populates |error| and |error_path_reversed|.
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
int& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
bool& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
double& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
std::string& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// This overload is used for lists/arrays.
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
std::vector<T>& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// This overload is used for optional types wrapped as unique_ptr<T>.
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
std::unique_ptr<T>& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// This overload is used for optional types wrapped as absl::optional<T>.
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
absl::optional<T>& out_opt,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed);
// This overload is used for generated types.
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
T& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
return T::ParseFromDictionary(dict, key, out, error, error_path_reversed);
}
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
std::vector<T>& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
const base::Value* value = FindKeyOfType(dict, key, base::Value::Type::LIST,
error, error_path_reversed);
if (!value)
return false;
bool result = json_schema_compiler::util::PopulateArrayFromList(
value->GetList(), out, error);
if (!result) {
DCHECK(error_path_reversed.empty());
error_path_reversed.push_back(key);
}
return result;
}
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
std::unique_ptr<T>& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
// Ignore optional keys if they are not present without raising an error.
if (!dict.Find(key))
return true;
// Parse errors for optional keys which are specified should still cause a
// failure.
auto result = std::make_unique<T>();
if (!ParseFromDictionary(dict, key, *result, error, error_path_reversed)) {
return false;
}
out = std::move(result);
return true;
}
template <typename T>
bool ParseFromDictionary(const base::Value::Dict& dict,
base::StringPiece key,
absl::optional<T>& out_opt,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
// Ignore optional keys if they are not present without raising an error.
if (!dict.Find(key))
return true;
// Parse errors for optional keys which are specified should still cause a
// failure.
T result{};
if (!ParseFromDictionary(dict, key, result, error, error_path_reversed)) {
return false;
}
out_opt = std::move(result);
return true;
}
// Alias for pointer to a function which converts a string to an enum of type T.
template <typename T>
using StringToEnumConverter = T (*)(base::StringPiece);
// Parses enum |out| from |dict| at the given |key|. On failure, returns false
// and populates |error| and |error_path_reversed|.
template <typename T>
bool ParseEnumFromDictionary(
const base::Value::Dict& dict,
base::StringPiece key,
StringToEnumConverter<T> converter,
bool is_optional_property,
T none_value,
T& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
DCHECK_EQ(none_value, out);
// Ignore optional keys if they are not present without raising an error.
if (is_optional_property && !dict.Find(key))
return true;
// Parse errors for optional keys which are specified should still cause a
// failure.
const base::Value* value = FindKeyOfType(dict, key, base::Value::Type::STRING,
error, error_path_reversed);
if (!value)
return false;
const std::string& str = value->GetString();
T enum_value = converter(str);
if (enum_value == none_value) {
PopulateInvalidEnumValueError(key, str, error, error_path_reversed);
return false;
}
out = enum_value;
return true;
}
// Parses non-optional enum array `out` from `dict` at the given `key`. On
// failure, returns false and populates `error` and `error_path_reversed`.
template <typename T>
bool ParseEnumArrayFromDictionary(
const base::Value::Dict& dict,
base::StringPiece key,
StringToEnumConverter<T> converter,
T none_value,
std::vector<T>& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
std::vector<std::string> str_array;
if (!ParseFromDictionary(dict, key, str_array, error, error_path_reversed)) {
return false;
}
std::vector<T> result;
result.reserve(str_array.size());
for (size_t i = 0; i < str_array.size(); ++i) {
T enum_value = converter(str_array[i]);
if (enum_value == none_value) {
std::u16string item_error;
PopulateInvalidEnumValueError(key, str_array[i], item_error,
error_path_reversed);
error = GetArrayParseError(i, item_error);
return false;
}
result.push_back(enum_value);
}
out = std::move(result);
return true;
}
// Overload for optional enum arrays.
template <typename T>
bool ParseEnumArrayFromDictionary(
const base::Value::Dict& dict,
base::StringPiece key,
StringToEnumConverter<T> converter,
T none_value,
absl::optional<std::vector<T>>& out,
std::u16string& error,
std::vector<base::StringPiece>& error_path_reversed) {
// Ignore optional keys if they are not present without raising an error.
if (!dict.Find(key))
return true;
// Parse errors for optional keys which are specified should still cause a
// failure.
std::vector<T> result;
if (!ParseEnumArrayFromDictionary(dict, key, converter, none_value, result,
error, error_path_reversed)) {
return false;
}
out = std::move(result);
return true;
}
} // namespace manifest_parse_util
} // namespace json_schema_compiler
#endif // TOOLS_JSON_SCHEMA_COMPILER_MANIFEST_PARSE_UTIL_H_
|