1/*
2 * Copyright (C) 2015 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(REMOTE_INSPECTOR)
29
30#include <wtf/TypeCasts.h>
31#include <wtf/text/WTFString.h>
32
33#if USE(CF)
34#include <CoreFoundation/CFRunLoop.h>
35#endif
36
37namespace Inspector {
38
39class FrontendChannel;
40
41using TargetID = unsigned;
42
43class JS_EXPORT_PRIVATE RemoteControllableTarget {
44public:
45 virtual ~RemoteControllableTarget();
46
47 void init();
48 void update();
49
50 virtual void connect(FrontendChannel&, bool isAutomaticConnection = false, bool immediatelyPause = false) = 0;
51 virtual void disconnect(FrontendChannel&) = 0;
52
53 TargetID targetIdentifier() const { return m_identifier; }
54 void setTargetIdentifier(TargetID identifier) { m_identifier = identifier; }
55
56 enum class Type { JavaScript, ServiceWorker, Web, Automation };
57 virtual Type type() const = 0;
58 virtual bool remoteControlAllowed() const = 0;
59 virtual void dispatchMessageFromRemote(const String& message) = 0;
60
61#if USE(CF)
62 // The dispatch block will be scheduled on a global run loop if null is returned.
63 virtual CFRunLoopRef targetRunLoop() const { return nullptr; }
64#endif
65
66private:
67 TargetID m_identifier { 0 };
68};
69
70} // namespace Inspector
71
72#define SPECIALIZE_TYPE_TRAITS_CONTROLLABLE_TARGET(ToClassName, ToClassType) \
73SPECIALIZE_TYPE_TRAITS_BEGIN(ToClassName) \
74 static bool isType(const Inspector::RemoteControllableTarget& target) { return target.type() == Inspector::RemoteControllableTarget::Type::ToClassType; } \
75SPECIALIZE_TYPE_TRAITS_END()
76
77#endif // ENABLE(REMOTE_INSPECTOR)
78