Out-of-process plug-ins should support asynchronous initialization
[WebKit-https.git] / Source / WebKit2 / PluginProcess / PluginProcess.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 PluginProcess_h
27 #define PluginProcess_h
28
29 #if ENABLE(PLUGIN_PROCESS)
30
31 #include "ChildProcess.h"
32 #include <wtf/Forward.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace WebCore {
36 class RunLoop;
37 }
38
39 namespace WebKit {
40
41 class NetscapePluginModule;
42 class WebProcessConnection;
43 struct PluginProcessCreationParameters;
44         
45 class PluginProcess : ChildProcess {
46     WTF_MAKE_NONCOPYABLE(PluginProcess);
47 public:
48     static PluginProcess& shared();
49
50     void initialize(CoreIPC::Connection::Identifier, WebCore::RunLoop*);
51     void removeWebProcessConnection(WebProcessConnection* webProcessConnection);
52
53     NetscapePluginModule* netscapePluginModule();
54
55     const String& pluginPath() const { return m_pluginPath; }
56
57 #if PLATFORM(MAC)
58     void initializeShim();
59
60     void setModalWindowIsShowing(bool);
61     void setFullscreenWindowIsShowing(bool);
62
63 #if USE(ACCELERATED_COMPOSITING)
64     mach_port_t compositingRenderServerPort() const { return m_compositingRenderServerPort; }
65 #endif
66 #endif
67
68 private:
69     PluginProcess();
70     ~PluginProcess();
71
72     // ChildProcess
73     virtual bool shouldTerminate();
74
75     // CoreIPC::Connection::Client
76     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
77     virtual void didClose(CoreIPC::Connection*);
78     virtual void didReceiveInvalidMessage(CoreIPC::Connection*, CoreIPC::MessageID);
79     virtual void syncMessageSendTimedOut(CoreIPC::Connection*);
80
81     // Message handlers.
82     void didReceivePluginProcessMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
83     void initializePluginProcess(const PluginProcessCreationParameters&);
84     void createWebProcessConnection();
85     void getSitesWithData(uint64_t callbackID);
86     void clearSiteData(const Vector<String>& sites, uint64_t flags, uint64_t maxAgeInSeconds, uint64_t callbackID);
87
88     void platformInitialize(const PluginProcessCreationParameters&);
89
90     // The connection to the UI process.
91     RefPtr<CoreIPC::Connection> m_connection;
92
93     // Our web process connections.
94     Vector<RefPtr<WebProcessConnection> > m_webProcessConnections;
95
96     // The plug-in path.
97     String m_pluginPath;
98
99     // The plug-in module.
100     RefPtr<NetscapePluginModule> m_pluginModule;
101     
102     bool m_supportsAsynchronousPluginInitialization;
103     
104 #if USE(ACCELERATED_COMPOSITING) && PLATFORM(MAC)
105     // The Mach port used for accelerated compositing.
106     mach_port_t m_compositingRenderServerPort;
107 #endif
108     
109 };
110
111 } // namespace WebKit
112
113 #endif // ENABLE(PLUGIN_PROCESS)
114
115 #endif // PluginProcess_h