[Cocoa] Inspector Extensions: Add _WKInspectorExtension and related plumbing
[WebKit-https.git] / Source / WebKit / WebProcess / Inspector / WebInspectorUIExtensionController.h
1 /*
2  * Copyright (C) 2020 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 #if ENABLE(INSPECTOR_EXTENSIONS)
29
30 #include "Connection.h"
31 #include "InspectorExtensionTypes.h"
32 #include "MessageReceiver.h"
33 #include <wtf/Forward.h>
34 #include <wtf/Noncopyable.h>
35 #include <wtf/URL.h>
36 #include <wtf/WeakPtr.h>
37
38 namespace JSC {
39 class JSValue;
40 }
41
42 namespace WebCore {
43 class InspectorFrontendClient;
44 }
45
46 namespace WebKit {
47
48 class WebInspectorUI;
49
50 class WebInspectorUIExtensionController
51     : public IPC::MessageReceiver
52     , public CanMakeWeakPtr<WebInspectorUIExtensionController> {
53     WTF_MAKE_FAST_ALLOCATED;
54     WTF_MAKE_NONCOPYABLE(WebInspectorUIExtensionController);
55 public:
56     explicit WebInspectorUIExtensionController(WebCore::InspectorFrontendClient&);
57     ~WebInspectorUIExtensionController();
58
59     // Implemented in generated WebInspectorUIExtensionControllerMessageReceiver.cpp
60     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
61
62     // WebInspectorUIExtensionController IPC messages.
63     void registerExtension(const String& extensionID, const String& displayName, CompletionHandler<void(Expected<bool, InspectorExtensionError>)>&&);
64     void unregisterExtension(const String& extensionID, CompletionHandler<void(Expected<bool, InspectorExtensionError>)>&&);
65
66 private:
67     Optional<InspectorExtensionError> parseInspectorExtensionErrorFromResult(JSC::JSValue result);
68
69     WeakPtr<WebCore::InspectorFrontendClient> m_frontendClient;
70 };
71
72 } // namespace WebKit
73
74 #endif // ENABLE(INSPECTOR_EXTENSIONS)