1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef EXTENSIONS_RENDERER_EXTENSION_HELPER_H_
6 #define EXTENSIONS_RENDERER_EXTENSION_HELPER_H_
10 #include "content/public/common/console_message_level.h"
11 #include "content/public/renderer/render_view_observer.h"
12 #include "content/public/renderer/render_view_observer_tracker.h"
13 #include "extensions/common/view_type.h"
17 struct ExtensionMsg_ExecuteCode_Params;
18 struct ExtensionMsg_ExternalConnectionInfo;
21 class DictionaryValue;
25 namespace extensions {
29 // RenderView-level plumbing for extension features.
31 : public content::RenderViewObserver,
32 public content::RenderViewObserverTracker<ExtensionHelper> {
34 // Returns a list of extension RenderViews that match the given filter
35 // criteria. If |browser_window_id| is not extension_misc::kUnknownWindowId,
36 // the list is restricted to views in that browser window.
37 static std::vector<content::RenderView*> GetExtensionViews(
38 const std::string& extension_id,
39 int browser_window_id,
42 // Returns the given extension's background page, or NULL if none.
43 static content::RenderView* GetBackgroundPage(
44 const std::string& extension_id);
46 ExtensionHelper(content::RenderView* render_view, Dispatcher* dispatcher);
47 virtual ~ExtensionHelper();
49 int tab_id() const { return tab_id_; }
50 int browser_window_id() const { return browser_window_id_; }
51 ViewType view_type() const { return view_type_; }
52 Dispatcher* dispatcher() const { return dispatcher_; }
55 // RenderViewObserver implementation.
56 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
57 virtual void DidFinishDocumentLoad(blink::WebLocalFrame* frame) OVERRIDE;
58 virtual void DidFinishLoad(blink::WebLocalFrame* frame) OVERRIDE;
59 virtual void DidCreateDocumentElement(blink::WebLocalFrame* frame) OVERRIDE;
60 virtual void DidStartProvisionalLoad(blink::WebLocalFrame* frame) OVERRIDE;
61 virtual void FrameDetached(blink::WebFrame* frame) OVERRIDE;
62 virtual void DidMatchCSS(
63 blink::WebLocalFrame* frame,
64 const blink::WebVector<blink::WebString>& newly_matching_selectors,
65 const blink::WebVector<blink::WebString>& stopped_matching_selectors)
67 virtual void DidCreateDataSource(blink::WebLocalFrame* frame,
68 blink::WebDataSource* ds) OVERRIDE;
69 virtual void DraggableRegionsChanged(blink::WebFrame* frame) OVERRIDE;
71 void OnExtensionResponse(int request_id, bool success,
72 const base::ListValue& response,
73 const std::string& error);
74 void OnExtensionMessageInvoke(const std::string& extension_id,
75 const std::string& module_name,
76 const std::string& function_name,
77 const base::ListValue& args,
79 void OnExtensionDispatchOnConnect(
81 const std::string& channel_name,
82 const base::DictionaryValue& source_tab,
83 const ExtensionMsg_ExternalConnectionInfo& info,
84 const std::string& tls_channel_id);
85 void OnExtensionDeliverMessage(int target_port_id,
86 const Message& message);
87 void OnExtensionDispatchOnDisconnect(int port_id,
88 const std::string& error_message);
89 void OnExecuteCode(const ExtensionMsg_ExecuteCode_Params& params);
90 void OnNotifyRendererViewType(ViewType view_type);
91 void OnSetTabId(int tab_id);
92 void OnUpdateBrowserWindowId(int window_id);
93 void OnAddMessageToConsole(content::ConsoleMessageLevel level,
94 const std::string& message);
95 void OnAppWindowClosed();
97 Dispatcher* dispatcher_;
99 // Type of view attached with RenderView.
102 // Id of the tab which the RenderView is attached to.
105 // Id number of browser window which RenderView is attached to.
106 int browser_window_id_;
108 DISALLOW_COPY_AND_ASSIGN(ExtensionHelper);
111 } // namespace extensions
113 #endif // EXTENSIONS_RENDERER_EXTENSION_HELPER_H_