123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215 |
- // 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_BINDINGS_ARGUMENT_SPEC_H_
- #define EXTENSIONS_RENDERER_BINDINGS_ARGUMENT_SPEC_H_
- #include <map>
- #include <memory>
- #include <set>
- #include <string>
- #include <vector>
- #include "base/strings/string_piece.h"
- #include "third_party/abseil-cpp/absl/types/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:
- using PropertiesMap = std::map<std::string, std::unique_ptr<ArgumentSpec>>;
- // 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);
- explicit ArgumentSpec(ArgumentType type);
- ArgumentSpec(const ArgumentSpec&) = delete;
- ArgumentSpec& operator=(const ArgumentSpec&) = delete;
- ~ArgumentSpec();
- // Returns true if the given |value| is of the correct type to match this
- // spec. If it is not, populates |error|.
- bool IsCorrectType(v8::Local<v8::Value> value,
- const APITypeReferenceMap& refs,
- std::string* error) const;
- // 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|. Similarly, if |v8_out_value| is non-null, this will populate
- // |v8_out_value| with the parsed value. The advantage to duplicating the
- // parsed value into |v8_out_value| is that for defined objects, the result
- // will be a data object with no getters/setters, so clients don't need to
- // worry about re-checking the arguments. Note that this will *not* apply in
- // the case of ArgumentType::ANY, ArgumentType::BINARY, or
- // ArgumentType::FUNCTION, where we do not copy the (arbitrary) contents.
- // If both |out_value| and |v8_out_value| are null, 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,
- v8::Local<v8::Value>* v8_out_value,
- std::string* error) const;
- // Returns a type name for this argument. Note: This should only be used to
- // surface errors to developers.
- const std::string& GetTypeName() 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_; }
- void set_name(base::StringPiece name) { name_ = std::string(name); }
- void set_optional(bool optional) { optional_ = optional; }
- void set_ref(base::StringPiece ref) { ref_ = std::string(ref); }
- void set_minimum(int minimum) { minimum_ = minimum; }
- void set_properties(PropertiesMap properties) {
- properties_ = std::move(properties);
- }
- void set_list_element_type(std::unique_ptr<ArgumentSpec> list_element_type) {
- list_element_type_ = std::move(list_element_type);
- }
- void set_choices(std::vector<std::unique_ptr<ArgumentSpec>> choices) {
- choices_ = std::move(choices);
- }
- void set_enum_values(std::set<std::string> enum_values) {
- enum_values_ = std::move(enum_values);
- }
- void set_additional_properties(
- std::unique_ptr<ArgumentSpec> additional_properties) {
- additional_properties_ = std::move(additional_properties);
- }
- void set_instance_of(std::string instance_of) {
- instance_of_ = std::move(instance_of);
- }
- void set_preserve_null(bool preserve_null) { preserve_null_ = preserve_null; }
- void set_serialize_function(bool serialize_function) {
- serialize_function_ = serialize_function;
- }
- private:
- // Initializes this object according to |type_string| and |dict|.
- void InitializeType(const base::DictionaryValue* dict);
- // 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,
- v8::Local<v8::Value>* v8_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,
- v8::Local<v8::Value>* v8_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,
- v8::Local<v8::Value>* v8_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,
- v8::Local<v8::Value>* v8_out_value,
- std::string* error) const;
- bool ParseArgumentToFunction(v8::Local<v8::Context> context,
- v8::Local<v8::Value> value,
- std::unique_ptr<base::Value>* out_value,
- v8::Local<v8::Value>* v8_out_value,
- std::string* error) const;
- // Returns an error message indicating the type of |value| does not match the
- // expected type.
- std::string GetInvalidTypeError(v8::Local<v8::Value> value) const;
- // The name of the argument.
- std::string name_;
- // The type of the argument.
- ArgumentType type_ = ArgumentType::INTEGER;
- // A readable type name for this argument, lazily initialized.
- mutable std::string type_name_;
- // Whether or not the argument is required.
- bool optional_ = false;
- // Whether to preserve null properties found in objects.
- bool preserve_null_ = false;
- // Whether to serialize (by stringifying) a function argument. Only valid for
- // arguments of type FUNCTION.
- bool serialize_function_ = false;
- // The reference the argument points to, if any. Note that if this is set,
- // none of the following fields describing the argument will be.
- absl::optional<std::string> ref_;
- // The type of instance an object should be, if any. Only applicable for
- // ArgumentType::OBJECT. If specified, the argument must contain the instance
- // type in its prototype chain.
- absl::optional<std::string> instance_of_;
- // A minimum and maximum for integer and double values, if any.
- absl::optional<int> minimum_;
- absl::optional<int> maximum_;
- // A minimium length for strings or arrays.
- absl::optional<size_t> min_length_;
- // A maximum length for strings or arrays.
- absl::optional<size_t> max_length_;
- // 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_;
- };
- } // namespace extensions
- #endif // EXTENSIONS_RENDERER_BINDINGS_ARGUMENT_SPEC_H_
|