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

Side by Side Diff: chrome/renderer/extensions/module_system.h

Issue 11571014: Lazy load chrome.* APIs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: apitest.js Created 7 years, 10 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 unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef CHROME_RENDERER_EXTENSIONS_MODULE_SYSTEM_H_ 5 #ifndef CHROME_RENDERER_EXTENSIONS_MODULE_SYSTEM_H_
6 #define CHROME_RENDERER_EXTENSIONS_MODULE_SYSTEM_H_ 6 #define CHROME_RENDERER_EXTENSIONS_MODULE_SYSTEM_H_
7 7
8 #include "base/compiler_specific.h" 8 #include "base/compiler_specific.h"
9 #include "base/memory/linked_ptr.h" 9 #include "base/memory/linked_ptr.h"
10 #include "base/memory/scoped_ptr.h" 10 #include "base/memory/scoped_ptr.h"
11 #include "chrome/renderer/extensions/native_handler.h" 11 #include "chrome/renderer/extensions/object_backed_native_handler.h"
12 #include "v8/include/v8.h" 12 #include "v8/include/v8.h"
13 13
14 #include <map> 14 #include <map>
15 #include <set> 15 #include <set>
16 #include <string> 16 #include <string>
17 #include <vector> 17 #include <vector>
18 18
19 namespace extensions { 19 namespace extensions {
20 class ChromeV8Context;
20 21
21 // A module system for JS similar to node.js' require() function. 22 // A module system for JS similar to node.js' require() function.
22 // Each module has three variables in the global scope: 23 // Each module has three variables in the global scope:
23 // - exports, an object returned to dependencies who require() this 24 // - exports, an object returned to dependencies who require() this
24 // module. 25 // module.
25 // - require, a function that takes a module name as an argument and returns 26 // - require, a function that takes a module name as an argument and returns
26 // that module's exports object. 27 // that module's exports object.
27 // - requireNative, a function that takes the name of a registered 28 // - requireNative, a function that takes the name of a registered
28 // NativeHandler and returns an object that contains the functions the 29 // NativeHandler and returns an object that contains the functions the
29 // NativeHandler defines. 30 // NativeHandler defines.
30 // 31 //
31 // Each module in a ModuleSystem is executed at most once and its exports 32 // Each module in a ModuleSystem is executed at most once and its exports
32 // object cached. 33 // object cached.
33 // 34 //
34 // Note that a ModuleSystem must be used only in conjunction with a single 35 // Note that a ModuleSystem must be used only in conjunction with a single
35 // v8::Context. 36 // v8::Context.
36 // TODO(koz): Rename this to JavaScriptModuleSystem. 37 // TODO(koz): Rename this to JavaScriptModuleSystem.
37 class ModuleSystem : public NativeHandler { 38 class ModuleSystem : public ObjectBackedNativeHandler {
38 public: 39 public:
39 class SourceMap { 40 class SourceMap {
40 public: 41 public:
41 virtual ~SourceMap() {} 42 virtual ~SourceMap() {}
42 virtual v8::Handle<v8::Value> GetSource(const std::string& name) = 0; 43 virtual v8::Handle<v8::Value> GetSource(const std::string& name) = 0;
43 virtual bool Contains(const std::string& name) = 0; 44 virtual bool Contains(const std::string& name) = 0;
44 }; 45 };
45 46
46 class ExceptionHandler { 47 class ExceptionHandler {
47 public: 48 public:
48 virtual ~ExceptionHandler() {} 49 virtual ~ExceptionHandler() {}
49 virtual void HandleUncaughtException() = 0; 50 virtual void HandleUncaughtException() = 0;
50 }; 51 };
51 52
52 // Enables native bindings for the duration of its lifetime. 53 // Enables native bindings for the duration of its lifetime.
53 class NativesEnabledScope { 54 class NativesEnabledScope {
54 public: 55 public:
55 explicit NativesEnabledScope(ModuleSystem* module_system); 56 explicit NativesEnabledScope(ModuleSystem* module_system);
56 ~NativesEnabledScope(); 57 ~NativesEnabledScope();
57 58
58 private: 59 private:
59 ModuleSystem* module_system_; 60 ModuleSystem* module_system_;
60 DISALLOW_COPY_AND_ASSIGN(NativesEnabledScope); 61 DISALLOW_COPY_AND_ASSIGN(NativesEnabledScope);
61 }; 62 };
62 63
63 // |source_map| is a weak pointer. 64 // |source_map| is a weak pointer.
64 explicit ModuleSystem(v8::Handle<v8::Context> context, SourceMap* source_map); 65 explicit ModuleSystem(ChromeV8Context* context, SourceMap* source_map);
65 virtual ~ModuleSystem(); 66 virtual ~ModuleSystem();
66 67
67 // Returns true if the current context has a ModuleSystem installed in it. 68 // Returns true if the current context has a ModuleSystem installed in it.
68 static bool IsPresentInCurrentContext(); 69 static bool IsPresentInCurrentContext();
69 70
70 // Dumps the debug info from |try_catch| to LOG(ERROR). 71 // Dumps the debug info from |try_catch| to LOG(ERROR).
71 static void DumpException(const v8::TryCatch& try_catch); 72 static void DumpException(const v8::TryCatch& try_catch);
73 void LogExceptionToConsole(const v8::TryCatch& try_catch);
not at google - send to devlin 2013/02/13 01:45:49 I think dumping to console also puts to warning. L
cduvall 2013/02/15 00:40:28 Switched this back to how it was since the logging
72 74
73 // Require the specified module. This is the equivalent of calling 75 // Require the specified module. This is the equivalent of calling
74 // require('module_name') from the loaded JS files. 76 // require('module_name') from the loaded JS files.
75 void Require(const std::string& module_name); 77 v8::Handle<v8::Value> Require(const std::string& module_name);
76 v8::Handle<v8::Value> Require(const v8::Arguments& args); 78 v8::Handle<v8::Value> Require(const v8::Arguments& args);
77 v8::Handle<v8::Value> RequireForJs(const v8::Arguments& args);
78 v8::Handle<v8::Value> RequireForJsInner(v8::Handle<v8::String> module_name);
79 79
80 // Calls the specified method exported by the specified module. This is 80 // Calls the specified method exported by the specified module. This is
81 // equivalent to calling require('module_name').method_name() from JS. 81 // equivalent to calling require('module_name').method_name() from JS.
82 void CallModuleMethod(const std::string& module_name, 82 v8::Local<v8::Value> CallModuleMethod(const std::string& module_name,
83 const std::string& method_name); 83 const std::string& method_name);
84 84
85 // Calls the specified method exported by the specified module. This is 85 // Calls the specified method exported by the specified module. This is
86 // equivalent to calling require('module_name').method_name(args) from JS. 86 // equivalent to calling require('module_name').method_name(args) from JS.
87 v8::Local<v8::Value> CallModuleMethod( 87 v8::Local<v8::Value> CallModuleMethod(
88 const std::string& module_name, 88 const std::string& module_name,
89 const std::string& method_name, 89 const std::string& method_name,
90 std::vector<v8::Handle<v8::Value> >* args); 90 std::vector<v8::Handle<v8::Value> >* args);
91 91
92 // Register |native_handler| as a potential target for requireNative(), so 92 // Register |native_handler| as a potential target for requireNative(), so
93 // calls to requireNative(|name|) from JS will return a new object created by 93 // calls to requireNative(|name|) from JS will return a new object created by
94 // |native_handler|. 94 // |native_handler|.
95 void RegisterNativeHandler(const std::string& name, 95 void RegisterNativeHandler(const std::string& name,
96 scoped_ptr<NativeHandler> native_handler); 96 scoped_ptr<NativeHandler> native_handler);
97 // Check if a native handler has been registered for this |name|.
98 bool HasNativeHandler(const std::string& name);
97 99
98 // Causes requireNative(|name|) to look for its module in |source_map_| 100 // Causes requireNative(|name|) to look for its module in |source_map_|
99 // instead of using a registered native handler. This can be used in unit 101 // instead of using a registered native handler. This can be used in unit
100 // tests to mock out native modules. 102 // tests to mock out native modules.
101 void OverrideNativeHandler(const std::string& name); 103 void OverrideNativeHandler(const std::string& name);
102 104
103 // Executes |code| in the current context with |name| as the filename. 105 // Executes |code| in the current context with |name| as the filename.
104 void RunString(const std::string& code, const std::string& name); 106 void RunString(const std::string& code, const std::string& name);
105 107
106 // Retrieves the lazily defined field specified by |property|. 108 // Retrieves the lazily defined field specified by |property|.
107 static v8::Handle<v8::Value> LazyFieldGetter(v8::Local<v8::String> property, 109 static v8::Handle<v8::Value> LazyFieldGetter(v8::Local<v8::String> property,
108 const v8::AccessorInfo& info); 110 const v8::AccessorInfo& info);
111 // Retrieves the lazily defined field specified by |property| on a native
112 // object.
113 static v8::Handle<v8::Value> NativeLazyFieldGetter(
114 v8::Local<v8::String> property,
115 const v8::AccessorInfo& info);
109 116
110 // Make |object|.|field| lazily evaluate to the result of 117 // Make |object|.|field| lazily evaluate to the result of
111 // require(|module_name|)[|module_field|]. 118 // require(|module_name|)[|module_field|].
112 void SetLazyField(v8::Handle<v8::Object> object, 119 void SetLazyField(v8::Handle<v8::Object> object,
113 const std::string& field, 120 const std::string& field,
114 const std::string& module_name, 121 const std::string& module_name,
115 const std::string& module_field); 122 const std::string& module_field);
116 123
124 // Make |object|.|field| lazily evaluate to the result of
125 // requireNative(|module_name|)[|module_field|].
126 void SetNativeLazyField(v8::Handle<v8::Object> object,
127 const std::string& field,
128 const std::string& module_name,
129 const std::string& module_field);
130
117 void set_exception_handler(scoped_ptr<ExceptionHandler> handler) { 131 void set_exception_handler(scoped_ptr<ExceptionHandler> handler) {
118 exception_handler_ = handler.Pass(); 132 exception_handler_ = handler.Pass();
119 } 133 }
120 134
121 private: 135 private:
122 typedef std::map<std::string, linked_ptr<NativeHandler> > NativeHandlerMap; 136 typedef std::map<std::string, linked_ptr<NativeHandler> > NativeHandlerMap;
123 137
124 // Called when an exception is thrown but not caught. 138 // Called when an exception is thrown but not caught.
125 void HandleException(const v8::TryCatch& try_catch); 139 void HandleException(const v8::TryCatch& try_catch);
126 140
141 static std::string CreateExceptionString(const v8::TryCatch& try_catch);
142
127 // Ensure that require_ has been evaluated from require.js. 143 // Ensure that require_ has been evaluated from require.js.
128 void EnsureRequireLoaded(); 144 void EnsureRequireLoaded();
129 145
130 // Run |code| in the current context with the name |name| used for stack 146 // Run |code| in the current context with the name |name| used for stack
131 // traces. 147 // traces.
132 v8::Handle<v8::Value> RunString(v8::Handle<v8::String> code, 148 v8::Handle<v8::Value> RunString(v8::Handle<v8::String> code,
133 v8::Handle<v8::String> name); 149 v8::Handle<v8::String> name);
134 150
151 v8::Handle<v8::Value> RequireForJs(const v8::Arguments& args);
152 v8::Handle<v8::Value> RequireForJsInner(v8::Handle<v8::String> module_name);
153
154 // Sets a lazy field using the specified |getter|.
155 void SetLazyField(v8::Handle<v8::Object> object,
156 const std::string& field,
157 const std::string& module_name,
158 const std::string& module_field,
159 v8::AccessorGetter getter);
160
161 typedef v8::Handle<v8::Value> (ModuleSystem::*GetModuleFunc)(
162 const std::string&);
163 // Base implementation of a LazyFieldGetter that can be customized by passing
164 // in a |get_module| function.
165 static v8::Handle<v8::Value> LazyFieldGetterInner(
166 v8::Local<v8::String> property,
167 const v8::AccessorInfo& info,
168 GetModuleFunc get_module);
169
135 // Return the named source file stored in the source map. 170 // Return the named source file stored in the source map.
136 // |args[0]| - the name of a source file in source_map_. 171 // |args[0]| - the name of a source file in source_map_.
137 v8::Handle<v8::Value> GetSource(v8::Handle<v8::String> source_name); 172 v8::Handle<v8::Value> GetSource(v8::Handle<v8::String> source_name);
138 173
139 // Return an object that contains the native methods defined by the named 174 // Return an object that contains the native methods defined by the named
140 // NativeHandler. 175 // NativeHandler.
141 // |args[0]| - the name of a native handler object. 176 // |args[0]| - the name of a native handler object.
177 v8::Handle<v8::Value> GetNativeFromString(const std::string& native_name);
142 v8::Handle<v8::Value> GetNative(const v8::Arguments& args); 178 v8::Handle<v8::Value> GetNative(const v8::Arguments& args);
143 179
144 // Wraps |source| in a (function(require, requireNative, exports) {...}). 180 // Wraps |source| in a (function(require, requireNative, exports) {...}).
145 v8::Handle<v8::String> WrapSource(v8::Handle<v8::String> source); 181 v8::Handle<v8::String> WrapSource(v8::Handle<v8::String> source);
146 182
147 // Throws an exception in the calling JS context. 183 // Throws an exception in the calling JS context.
148 v8::Handle<v8::Value> ThrowException(const std::string& message); 184 v8::Handle<v8::Value> ThrowException(const std::string& message);
149 185
150 // The context that this ModuleSystem is for. 186 // The context that this ModuleSystem is for.
151 v8::Persistent<v8::Context> context_; 187 ChromeV8Context* context_;
152 188
153 // A map from module names to the JS source for that module. GetSource() 189 // A map from module names to the JS source for that module. GetSource()
154 // performs a lookup on this map. 190 // performs a lookup on this map.
155 SourceMap* source_map_; 191 SourceMap* source_map_;
156 192
157 // A map from native handler names to native handlers. 193 // A map from native handler names to native handlers.
158 NativeHandlerMap native_handler_map_; 194 NativeHandlerMap native_handler_map_;
159 195
160 // When 0, natives are disabled, otherwise indicates how many callers have 196 // When 0, natives are disabled, otherwise indicates how many callers have
161 // pinned natives as enabled. 197 // pinned natives as enabled.
162 int natives_enabled_; 198 int natives_enabled_;
163 199
164 // Called when an exception is thrown but not caught in JS. 200 // Called when an exception is thrown but not caught in JS.
165 scoped_ptr<ExceptionHandler> exception_handler_; 201 scoped_ptr<ExceptionHandler> exception_handler_;
166 202
167 std::set<std::string> overridden_native_handlers_; 203 std::set<std::string> overridden_native_handlers_;
168 204
169 DISALLOW_COPY_AND_ASSIGN(ModuleSystem); 205 DISALLOW_COPY_AND_ASSIGN(ModuleSystem);
170 }; 206 };
171 207
172 } // extensions 208 } // extensions
173 209
174 #endif // CHROME_RENDERER_EXTENSIONS_MODULE_SYSTEM_H_ 210 #endif // CHROME_RENDERER_EXTENSIONS_MODULE_SYSTEM_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698