30bebf3ddaba53b9bfeb7f93feb6381cf5df53f8
[WebKit-https.git] / Source / WebKit / UIProcess / Launcher / ProcessLauncher.h
1 /*
2  * Copyright (C) 2010, 2012 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 #pragma once
27
28 #include "Connection.h"
29 #include <WebCore/Process.h>
30 #include <wtf/HashMap.h>
31 #include <wtf/ProcessID.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/Threading.h>
34 #include <wtf/WeakPtr.h>
35 #include <wtf/text/StringHash.h>
36 #include <wtf/text/WTFString.h>
37
38 namespace WebKit {
39
40 class ProcessLauncher : public ThreadSafeRefCounted<ProcessLauncher> {
41 public:
42     class Client {
43     public:
44         virtual ~Client() { }
45         
46         virtual void didFinishLaunching(ProcessLauncher*, IPC::Connection::Identifier) = 0;
47     };
48     
49     enum class ProcessType {
50         Web,
51 #if ENABLE(NETSCAPE_PLUGIN_API)
52         Plugin32,
53         Plugin64,
54 #endif
55         Network,
56         Storage,
57     };
58
59     struct LaunchOptions {
60         ProcessType processType;
61         WebCore::ProcessIdentifier processIdentifier;
62         HashMap<String, String> extraInitializationData;
63
64 #if ENABLE(DEVELOPER_MODE) && (PLATFORM(GTK) || PLATFORM(WPE))
65         String processCmdPrefix;
66 #endif
67     };
68
69     static Ref<ProcessLauncher> create(Client* client, const LaunchOptions& launchOptions)
70     {
71         return adoptRef(*new ProcessLauncher(client, launchOptions));
72     }
73
74     bool isLaunching() const { return m_isLaunching; }
75     ProcessID processIdentifier() const { return m_processIdentifier; }
76
77     void terminateProcess();
78     void invalidate();
79
80 private:
81     ProcessLauncher(Client*, const LaunchOptions& launchOptions);
82
83     void launchProcess();
84     void didFinishLaunchingProcess(ProcessID, IPC::Connection::Identifier);
85
86     void platformInvalidate();
87
88     Client* m_client;
89
90 #if PLATFORM(COCOA)
91     OSObjectPtr<xpc_connection_t> m_xpcConnection;
92 #endif
93
94     WeakPtrFactory<ProcessLauncher> m_weakPtrFactory;
95     const LaunchOptions m_launchOptions;
96     bool m_isLaunching;
97     ProcessID m_processIdentifier;
98 };
99
100 } // namespace WebKit