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
|
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EXTENSIONS_RENDERER_ARGUMENT_SPEC_H_
#define EXTENSIONS_RENDERER_ARGUMENT_SPEC_H_
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include "base/macros.h"
#include "base/optional.h"
#include "v8/include/v8.h"
namespace base {
class DictionaryValue;
class Value;
}
namespace extensions {
class APITypeReferenceMap;
enum class ArgumentType {
INTEGER,
DOUBLE,
BOOLEAN,
STRING,
OBJECT,
LIST,
BINARY,
FUNCTION,
ANY,
REF,
CHOICES,
};
// A description of a given Argument to an Extension.
class ArgumentSpec {
public:
// Reads the description from |value| and sets associated fields.
// TODO(devlin): We should strongly think about generating these instead of
// populating them at runtime.
explicit ArgumentSpec(const base::Value& value);
~ArgumentSpec();
// Returns true if the passed |value| matches this specification. If
// |out_value| is non-null, converts the value to a base::Value and populates
// |out_value|. Otherwise, no conversion is performed.
bool ParseArgument(v8::Local<v8::Context> context,
v8::Local<v8::Value> value,
const APITypeReferenceMap& refs,
std::unique_ptr<base::Value>* out_value,
std::string* error) const;
const std::string& name() const { return name_; }
bool optional() const { return optional_; }
ArgumentType type() const { return type_; }
const std::set<std::string>& enum_values() const { return enum_values_; }
private:
// Initializes this object according to |type_string| and |dict|.
void InitializeType(const base::DictionaryValue* dict);
// Returns true if this argument refers to a fundamental type.
bool IsFundamentalType() const;
// Conversion functions. These should only be used if the spec is of the given
// type (otherwise, they will DCHECK).
bool ParseArgumentToFundamental(v8::Local<v8::Context> context,
v8::Local<v8::Value> value,
std::unique_ptr<base::Value>* out_value,
std::string* error) const;
bool ParseArgumentToObject(v8::Local<v8::Context> context,
v8::Local<v8::Object> object,
const APITypeReferenceMap& refs,
std::unique_ptr<base::Value>* out_value,
std::string* error) const;
bool ParseArgumentToArray(v8::Local<v8::Context> context,
v8::Local<v8::Array> value,
const APITypeReferenceMap& refs,
std::unique_ptr<base::Value>* out_value,
std::string* error) const;
bool ParseArgumentToAny(v8::Local<v8::Context> context,
v8::Local<v8::Value> value,
std::unique_ptr<base::Value>* out_value,
std::string* error) const;
// The name of the argument.
std::string name_;
// The type of the argument.
ArgumentType type_;
// Whether or not the argument is required.
bool optional_;
// The reference the argument points to, if any. Note that if this is set,
// none of the following fields describing the argument will be.
base::Optional<std::string> ref_;
// A minimum, if any.
base::Optional<int> minimum_;
// A map of required properties; present only for objects. Note that any
// properties *not* defined in this map will be dropped during conversion.
std::map<std::string, std::unique_ptr<ArgumentSpec>> properties_;
// The type of item that should be in the list; present only for lists.
std::unique_ptr<ArgumentSpec> list_element_type_;
// The different possible specs this argument can map to. Only populated for
// arguments of type CHOICES.
std::vector<std::unique_ptr<ArgumentSpec>> choices_;
// The possible enum values, if defined for this argument.
std::set<std::string> enum_values_;
// The specification for 'additional properties'. This is used when we want
// to allow the API to pass an object with arbitrary properties. Only
// applicable for ArgumentType::OBJECT.
std::unique_ptr<ArgumentSpec> additional_properties_;
DISALLOW_COPY_AND_ASSIGN(ArgumentSpec);
};
} // namespace extensions
#endif // EXTENSIONS_RENDERER_ARGUMENT_SPEC_H_
|
