Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / workers / WorkerInspectorProxy.h
1 /*
2  * Copyright (C) 2016 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 <wtf/URL.h>
29 #include "WorkerThread.h"
30 #include <wtf/HashSet.h>
31 #include <wtf/text/WTFString.h>
32
33 // All of these methods should be called on the Main Thread.
34 // Used to send messages to the WorkerInspector on the WorkerThread.
35
36 namespace WebCore {
37
38 class ScriptExecutionContext;
39 class WorkerThread;
40
41 class WorkerInspectorProxy {
42     WTF_MAKE_NONCOPYABLE(WorkerInspectorProxy);
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     WorkerInspectorProxy(const String& identifier);
46     ~WorkerInspectorProxy();
47
48     // A Worker's inspector messages come in and go out through the Page's WorkerAgent.
49     class PageChannel {
50     public:
51         virtual ~PageChannel() = default;
52         virtual void sendMessageFromWorkerToFrontend(WorkerInspectorProxy*, const String&) = 0;
53     };
54
55     static HashSet<WorkerInspectorProxy*>& allWorkerInspectorProxies();
56
57     const URL& url() const { return m_url; }
58     const String& identifier() const { return m_identifier; }
59     ScriptExecutionContext* scriptExecutionContext() const { return m_scriptExecutionContext.get(); }
60
61     WorkerThreadStartMode workerStartMode(ScriptExecutionContext&);
62     void workerStarted(ScriptExecutionContext*, WorkerThread*, const URL&);
63     void workerTerminated();
64
65     void resumeWorkerIfPaused();
66     void connectToWorkerInspectorController(PageChannel*);
67     void disconnectFromWorkerInspectorController();
68     void sendMessageToWorkerInspectorController(const String&);
69     void sendMessageFromWorkerToFrontend(const String&);
70
71 private:
72     RefPtr<ScriptExecutionContext> m_scriptExecutionContext;
73     RefPtr<WorkerThread> m_workerThread;
74     String m_identifier;
75     URL m_url;
76     PageChannel* m_pageChannel { nullptr };
77 };
78
79 } // namespace WebCore