blob: 75db06fed0378b1fc62564a2896fde32b80e32e3 (
plain)
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
112
113
114
115
116
117
118
119
120
|
// Copyright 2013 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 CHROME_BROWSER_GUESTVIEW_GUESTVIEW_H_
#define CHROME_BROWSER_GUESTVIEW_GUESTVIEW_H_
#include <queue>
#include "base/values.h"
#include "content/public/browser/browser_plugin_guest_delegate.h"
#include "content/public/browser/web_contents.h"
class AdViewGuest;
class WebViewGuest;
// A GuestView is the base class browser-side API implementation for a <*view>
// tag. GuestView maintains an association between a guest WebContents and an
// embedder WebContents. It receives events issued from the guest and relays
// them to the embedder.
class GuestView : public content::BrowserPluginGuestDelegate {
public:
enum Type {
WEBVIEW,
ADVIEW,
UNKNOWN
};
class Event {
public:
Event(const std::string& event_name, scoped_ptr<DictionaryValue> args);
~Event();
const std::string& event_name() const { return event_name_; }
scoped_ptr<DictionaryValue> GetArguments();
private:
const std::string event_name_;
scoped_ptr<DictionaryValue> args_;
};
static Type GetViewTypeFromString(const std::string& api_type);
static GuestView* Create(content::WebContents* guest_web_contents,
Type view_type);
static GuestView* FromWebContents(content::WebContents* web_contents);
static GuestView* From(int embedder_process_id, int instance_id);
virtual void Attach(content::WebContents* embedder_web_contents,
const std::string& extension_id,
const base::DictionaryValue& args);
content::WebContents* embedder_web_contents() const {
return embedder_web_contents_;
}
// Returns the guest WebContents.
content::WebContents* guest_web_contents() const {
return guest_web_contents_;
}
virtual Type GetViewType() const;
// Returns a WebViewGuest if this GuestView belongs to a <webview>.
virtual WebViewGuest* AsWebView() = 0;
// Returns an AdViewGuest if the GuestView belongs to an <adview>.
virtual AdViewGuest* AsAdView() = 0;
// Returns whether this guest has an associated embedder.
bool attached() const { return !!embedder_web_contents_; }
// Returns the instance ID of the <*view> element.
int view_instance_id() const { return view_instance_id_; }
// Returns the instance ID of the guest WebContents.
int guest_instance_id() const { return guest_instance_id_; }
// Returns the extension ID of the embedder.
const std::string& extension_id() const { return extension_id_; }
// Returns the user browser context of the embedder.
content::BrowserContext* browser_context() const { return browser_context_; }
// Returns the embedder's process ID.
int embedder_render_process_id() const { return embedder_render_process_id_; }
protected:
explicit GuestView(content::WebContents* guest_web_contents);
virtual ~GuestView();
// Dispatches an event |event_name| to the embedder with the |event| fields.
void DispatchEvent(Event* event);
private:
void SendQueuedEvents();
content::WebContents* guest_web_contents_;
content::WebContents* embedder_web_contents_;
std::string extension_id_;
int embedder_render_process_id_;
content::BrowserContext* browser_context_;
// |guest_instance_id_| is a profile-wide unique identifier for a guest
// WebContents.
const int guest_instance_id_;
// |view_instance_id_| is an identifier that's unique within a particular
// embedder RenderViewHost for a particular <*view> instance.
int view_instance_id_;
// This is a queue of Events that are destined to be sent to the embedder once
// the guest is attached to a particular embedder.
std::queue<Event*> pending_events_;
DISALLOW_COPY_AND_ASSIGN(GuestView);
};
#endif // CHROME_BROWSER_GUESTVIEW_GUESTVIEW_H_
|