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
|
// 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_API_BINDINGS_SYSTEM_H_
#define EXTENSIONS_RENDERER_API_BINDINGS_SYSTEM_H_
#include <map>
#include <memory>
#include <string>
#include "base/callback.h"
#include "base/macros.h"
#include "extensions/renderer/api_binding.h"
#include "extensions/renderer/api_binding_types.h"
#include "extensions/renderer/api_event_handler.h"
#include "extensions/renderer/api_request_handler.h"
#include "extensions/renderer/argument_spec.h"
namespace base {
class DictionaryValue;
class ListValue;
}
namespace extensions {
class APIRequestHandler;
// A class encompassing the necessary pieces to construct the JS entry points
// for Extension APIs. Designed to be used on a single thread, but safe between
// multiple v8::Contexts.
class APIBindingsSystem {
public:
using GetAPISchemaMethod =
base::Callback<const base::DictionaryValue&(const std::string&)>;
APIBindingsSystem(const binding::RunJSFunction& call_js,
const binding::RunJSFunctionSync& call_js_sync,
const GetAPISchemaMethod& get_api_schema,
const APIBinding::SendRequestMethod& send_request,
const APIEventHandler::EventListenersChangedMethod&
event_listeners_changed);
~APIBindingsSystem();
// Returns a new v8::Object representing the api specified by |api_name|.
v8::Local<v8::Object> CreateAPIInstance(
const std::string& api_name,
v8::Local<v8::Context> context,
v8::Isolate* isolate,
const APIBinding::AvailabilityCallback& is_available,
v8::Local<v8::Object>* hooks_interface_out);
// Responds to the request with the given |request_id|, calling the callback
// with |response|.
void CompleteRequest(int request_id, const base::ListValue& response);
// Notifies the APIEventHandler to fire the corresponding event, notifying
// listeners.
void FireEventInContext(const std::string& event_name,
v8::Local<v8::Context> context,
const base::ListValue& response);
// Returns the APIBindingHooks object for the given api to allow for
// registering custom hooks. These must be registered *before* the
// binding is instantiated.
// TODO(devlin): It's a little weird that we don't just expose a
// RegisterHooks-type method. Depending on how complex the hook interface
// is, maybe we should rethink this. Downside would be that it's less
// efficient to register multiple hooks for the same API.
APIBindingHooks* GetHooksForAPI(const std::string& api_name);
private:
// Creates a new APIBinding for the given |api_name|.
std::unique_ptr<APIBinding> CreateNewAPIBinding(const std::string& api_name);
// The map of cached API reference types.
ArgumentSpec::RefMap type_reference_map_;
// The request handler associated with the system.
APIRequestHandler request_handler_;
// The event handler associated with the system.
APIEventHandler event_handler_;
// A map from api_name -> APIBinding for constructed APIs. APIBindings are
// created lazily.
std::map<std::string, std::unique_ptr<APIBinding>> api_bindings_;
// A map from api_name -> APIBindingHooks for registering custom hooks.
// TODO(devlin): This map is pretty pointer-y. Is that going to be a
// performance concern?
std::map<std::string, std::unique_ptr<APIBindingHooks>> binding_hooks_;
binding::RunJSFunction call_js_;
binding::RunJSFunctionSync call_js_sync_;
// The method to retrieve the DictionaryValue describing a given extension
// API. Curried in for testing purposes so we can use fake APIs.
GetAPISchemaMethod get_api_schema_;
// The method to call when a new API call is triggered. Curried in for testing
// purposes. Typically, this would send an IPC to the browser to begin the
// function work.
APIBinding::SendRequestMethod send_request_;
DISALLOW_COPY_AND_ASSIGN(APIBindingsSystem);
};
} // namespace
#endif // EXTENSIONS_RENDERER_API_BINDINGS_SYSTEM_H_
|
