df4acce16f9ec37152499622a20763de103deb7d
[WebKit-https.git] / WebKit2 / UIProcess / WebProcessProxy.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebProcessProxy_h
27 #define WebProcessProxy_h
28
29 #include "Connection.h"
30 #include "PlatformProcessIdentifier.h"
31 #include "PluginInfoStore.h"
32 #include "ProcessLauncher.h"
33 #include "ProcessModel.h"
34 #include "ResponsivenessTimer.h"
35 #include "ThreadLauncher.h"
36 #include "WebPageProxy.h"
37 #include <WebCore/LinkHash.h>
38 #include <wtf/Forward.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/PassRefPtr.h>
41 #include <wtf/RefCounted.h>
42
43 namespace WebCore {
44     class KURL;
45 };
46
47 namespace WebKit {
48
49 class WebBackForwardListItem;
50 class WebContext;
51 class WebPageGroup;
52 struct WebNavigationDataStore;
53
54 class WebProcessProxy : public RefCounted<WebProcessProxy>, CoreIPC::Connection::Client, ResponsivenessTimer::Client, ProcessLauncher::Client, ThreadLauncher::Client {
55 public:
56     typedef HashMap<uint64_t, RefPtr<WebPageProxy> > WebPageProxyMap;
57     typedef WebPageProxyMap::const_iterator::Values pages_const_iterator;
58     typedef HashMap<uint64_t, RefPtr<WebBackForwardListItem> > WebBackForwardListItemMap;
59
60     static PassRefPtr<WebProcessProxy> create(WebContext*);
61     ~WebProcessProxy();
62
63     void terminate();
64
65     template<typename E, typename T> bool send(E messageID, uint64_t destinationID, const T& arguments);
66     template<typename T> bool send(const T& message, uint64_t destinationID);
67     template<typename U> bool sendSync(const U& message, const typename U::Reply& reply, uint64_t destinationID, double timeout = 1);
68     
69     CoreIPC::Connection* connection() const
70     { 
71         ASSERT(m_connection);
72         
73         return m_connection.get(); 
74     }
75
76     WebContext* context() const { return m_context; }
77
78     PlatformProcessIdentifier processIdentifier() const { return m_processLauncher->processIdentifier(); }
79
80     WebPageProxy* webPage(uint64_t pageID) const;
81     WebPageProxy* createWebPage(WebContext*, WebPageGroup*);
82     void addExistingWebPage(WebPageProxy*, uint64_t pageID);
83     void removeWebPage(uint64_t pageID);
84
85     pages_const_iterator pages_begin();
86     pages_const_iterator pages_end();
87     size_t numberOfPages();
88
89     WebBackForwardListItem* webBackForwardItem(uint64_t itemID) const;
90
91     ResponsivenessTimer* responsivenessTimer() { return &m_responsivenessTimer; }
92
93     bool isValid() const { return m_connection; }
94     bool isLaunching() const;
95     bool canSendMessage() const { return isValid() || isLaunching(); }
96
97     WebFrameProxy* webFrame(uint64_t) const;
98     void frameCreated(uint64_t, WebFrameProxy*);
99     void didDestroyFrame(uint64_t);
100     void disconnectFramesFromPage(WebPageProxy*); // Including main frame.
101     size_t frameCountInPage(WebPageProxy*) const; // Including main frame.
102
103 private:
104     explicit WebProcessProxy(WebContext*);
105
106     void connect();
107
108     bool sendMessage(CoreIPC::MessageID, PassOwnPtr<CoreIPC::ArgumentEncoder>);
109
110     void addBackForwardItem(uint64_t itemID, const String& originalURLString, const String& urlString, const String& title);
111
112 #if ENABLE(PLUGIN_PROCESS)
113     void getPluginProcessConnection(const String& pluginPath, CoreIPC::ArgumentEncoder* reply);
114 #endif
115
116     // CoreIPC::Connection::Client
117     void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
118     CoreIPC::SyncReplyMode didReceiveSyncMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, CoreIPC::ArgumentEncoder*);
119     void didClose(CoreIPC::Connection*);
120     void didReceiveInvalidMessage(CoreIPC::Connection*, CoreIPC::MessageID);
121
122     // ResponsivenessTimer::Client
123     void didBecomeUnresponsive(ResponsivenessTimer*);
124     void didBecomeResponsive(ResponsivenessTimer*);
125
126     // ProcessLauncher::Client
127     virtual void didFinishLaunching(ProcessLauncher*, CoreIPC::Connection::Identifier);
128
129     // ThreadLauncher::Client
130     virtual void didFinishLaunching(ThreadLauncher*, CoreIPC::Connection::Identifier);
131
132     void didFinishLaunching(CoreIPC::Connection::Identifier);
133
134     // Implemented in generated WebProcessProxyMessageReceiver.cpp
135     void didReceiveWebProcessProxyMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
136
137     ResponsivenessTimer m_responsivenessTimer;
138     RefPtr<CoreIPC::Connection> m_connection;
139
140     Vector<CoreIPC::Connection::OutgoingMessage> m_pendingMessages;
141     RefPtr<ProcessLauncher> m_processLauncher;
142     RefPtr<ThreadLauncher> m_threadLauncher;
143
144     WebContext* m_context;
145
146     WebPageProxyMap m_pageMap;
147     WebBackForwardListItemMap m_backForwardListItemMap;
148
149     HashMap<uint64_t, RefPtr<WebFrameProxy> > m_frameMap;
150 };
151
152 template<typename E, typename T>
153 bool WebProcessProxy::send(E messageID, uint64_t destinationID, const T& arguments)
154 {
155     OwnPtr<CoreIPC::ArgumentEncoder> argumentEncoder = CoreIPC::ArgumentEncoder::create(destinationID);
156     argumentEncoder->encode(arguments);
157
158     return sendMessage(CoreIPC::MessageID(messageID), argumentEncoder.release());
159 }
160
161 template<typename T>
162 bool WebProcessProxy::send(const T& message, uint64_t destinationID)
163 {
164     OwnPtr<CoreIPC::ArgumentEncoder> argumentEncoder = CoreIPC::ArgumentEncoder::create(destinationID);
165     argumentEncoder->encode(message);
166
167     return sendMessage(CoreIPC::MessageID(T::messageID), argumentEncoder.release());
168 }
169
170 template<typename U> 
171 bool WebProcessProxy::sendSync(const U& message, const typename U::Reply& reply, uint64_t destinationID, double timeout)
172 {
173     return m_connection->sendSync(message, reply, destinationID, timeout);
174 }
175     
176 } // namespace WebKit
177
178 #endif // WebProcessProxy_h