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