File: InspectorClient.h

package info (click to toggle)
webkit2gtk 2.42.2-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 362,432 kB
  • sloc: cpp: 2,881,947; javascript: 282,447; ansic: 134,088; python: 43,789; ruby: 18,308; perl: 15,872; asm: 14,389; xml: 4,395; yacc: 2,350; sh: 2,074; java: 1,734; lex: 1,323; makefile: 296; pascal: 60
file content (97 lines) | stat: -rw-r--r-- 3,517 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*
 * Copyright (C) 2007-2021 Apple Inc. All rights reserved.
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <optional>
#include <wtf/Forward.h>

namespace Inspector {
class FrontendChannel;
}

namespace WebCore {

class FloatRect;
class InspectorController;
class LocalFrame;
class Page;

class InspectorClient {
public:
    virtual ~InspectorClient() = default;

    virtual void inspectedPageDestroyed() = 0;
    virtual void frontendCountChanged(unsigned) { }

    virtual Inspector::FrontendChannel* openLocalFrontend(InspectorController*) = 0;
    virtual void bringFrontendToFront() = 0;
    virtual void didResizeMainFrame(LocalFrame*) { }

    virtual void highlight() = 0;
    virtual void hideHighlight() = 0;

    virtual void showInspectorIndication() { }
    virtual void hideInspectorIndication() { }

    virtual bool overridesShowPaintRects() const { return false; }
    virtual void setShowPaintRects(bool) { }
    virtual void showPaintRect(const FloatRect&) { }
    virtual unsigned paintRectCount() const { return 0; }
    virtual void didSetSearchingForNode(bool) { }
    virtual void elementSelectionChanged(bool) { }
    virtual void timelineRecordingChanged(bool) { }

    enum class DeveloperPreference {
        PrivateClickMeasurementDebugModeEnabled,
        ITPDebugModeEnabled,
        MockCaptureDevicesEnabled,
    };
    virtual void setDeveloperPreferenceOverride(DeveloperPreference, std::optional<bool>) { }

#if ENABLE(INSPECTOR_NETWORK_THROTTLING)
    virtual bool setEmulatedConditions(std::optional<int64_t>&& /* bytesPerSecondLimit */) { return false; }
#endif

#if ENABLE(REMOTE_INSPECTOR)
    virtual bool allowRemoteInspectionToPageDirectly() const { return false; }
#endif
};

} // namespace WebCore

namespace WTF {

template<> struct EnumTraits<WebCore::InspectorClient::DeveloperPreference> {
    using values = EnumValues<
        WebCore::InspectorClient::DeveloperPreference,
        WebCore::InspectorClient::DeveloperPreference::PrivateClickMeasurementDebugModeEnabled,
        WebCore::InspectorClient::DeveloperPreference::ITPDebugModeEnabled,
        WebCore::InspectorClient::DeveloperPreference::MockCaptureDevicesEnabled
    >;
};

} // namespace WTF