Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(9)

Unified Diff: extensions/renderer/argument_spec.h

Issue 2947463002: [Extensions Bindings] Add a bindings/ subdirectory under renderer (Closed)
Patch Set: . Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « extensions/renderer/api_type_reference_map.cc ('k') | extensions/renderer/argument_spec.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: extensions/renderer/argument_spec.h
diff --git a/extensions/renderer/argument_spec.h b/extensions/renderer/argument_spec.h
deleted file mode 100644
index 0d517731342668a2d2e960cb61cc491aa527bc62..0000000000000000000000000000000000000000
--- a/extensions/renderer/argument_spec.h
+++ /dev/null
@@ -1,182 +0,0 @@
-// 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 "base/strings/string_piece.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();
-
- // 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;
-
- // 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_ = name.as_string(); }
- void set_optional(bool optional) { optional_ = optional; }
- void set_ref(base::StringPiece ref) { ref_ = ref.as_string(); }
- 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);
- }
-
- 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;
-
- // 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;
-
- // 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_;
-
- // 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.
- base::Optional<std::string> instance_of_;
-
- // A minimum and maximum for integer and double values, if any.
- base::Optional<int> minimum_;
- base::Optional<int> maximum_;
-
- // A minimium length for strings or arrays.
- base::Optional<size_t> min_length_;
-
- // A maximum length for strings or arrays.
- base::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_;
-
- DISALLOW_COPY_AND_ASSIGN(ArgumentSpec);
-};
-
-} // namespace extensions
-
-#endif // EXTENSIONS_RENDERER_ARGUMENT_SPEC_H_
« no previous file with comments | « extensions/renderer/api_type_reference_map.cc ('k') | extensions/renderer/argument_spec.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698