summaryrefslogtreecommitdiffstats
path: root/third_party/WebKit/Source/web/InspectorOverlay.h
blob: bc2a614e28d096910c29ddb0e3db1a1b7c05b87b (plain)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
 * 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.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "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 OR ITS 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.
 */

#ifndef InspectorOverlay_h
#define InspectorOverlay_h

#include "core/inspector/InspectorDOMAgent.h"
#include "core/inspector/InspectorOverlayHost.h"
#include "core/inspector/InspectorProfilerAgent.h"
#include "platform/Timer.h"
#include "platform/geometry/FloatQuad.h"
#include "platform/geometry/LayoutRect.h"
#include "platform/graphics/Color.h"
#include "platform/heap/Handle.h"
#include "platform/inspector_protocol/TypeBuilder.h"
#include "public/web/WebInputEvent.h"
#include "wtf/OwnPtr.h"
#include "wtf/PassOwnPtr.h"
#include "wtf/RefPtr.h"
#include "wtf/text/WTFString.h"

namespace blink {

class Color;
class EmptyChromeClient;
class LocalFrame;
class GraphicsContext;
class GraphicsLayer;
class InspectorCSSAgent;
class InspectorDebuggerAgent;
class LayoutEditor;
class Node;
class Page;
class PageOverlay;
class WebViewImpl;

namespace protocol {
class Value;
}

class InspectorOverlay final
    : public NoBaseWillBeGarbageCollectedFinalized<InspectorOverlay>
    , public InspectorDOMAgent::Client
    , public InspectorProfilerAgent::Client
    , public InspectorOverlayHost::Listener {
    USING_FAST_MALLOC_WILL_BE_REMOVED(InspectorOverlay);
    WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(InspectorOverlay);
public:
    static PassOwnPtrWillBeRawPtr<InspectorOverlay> create(WebViewImpl* webViewImpl)
    {
        return adoptPtrWillBeNoop(new InspectorOverlay(webViewImpl));
    }

    ~InspectorOverlay() override;
    DECLARE_TRACE();

    void init(InspectorCSSAgent*, InspectorDebuggerAgent*, InspectorDOMAgent*);

    void clear();
    bool handleInputEvent(const WebInputEvent&);
    void pageLayoutInvalidated(bool resized);
    void setShowViewportSizeOnResize(bool);
    void setPausedInDebuggerMessage(const String&);

    // Does not yet include paint.
    void updateAllLifecyclePhases();

    PageOverlay* pageOverlay() { return m_pageOverlay.get(); };
    String evaluateInOverlayForTest(const String&);

private:
    explicit InspectorOverlay(WebViewImpl*);
    class InspectorOverlayChromeClient;
    class InspectorPageOverlayDelegate;

    // InspectorOverlayHost::Listener implementation.
    void overlayResumed() override;
    void overlaySteppedOver() override;
    void overlayStartedPropertyChange(const String&) override;
    void overlayPropertyChanged(float) override;
    void overlayEndedPropertyChange() override;
    void overlayClearSelection(bool) override;
    void overlayNextSelector() override;
    void overlayPreviousSelector() override;

    // InspectorProfilerAgent::Client implementation.
    void profilingStarted() override;
    void profilingStopped() override;

    // InspectorDOMAgent::Client implementation.
    void hideHighlight() override;
    void highlightNode(Node*, const InspectorHighlightConfig&, bool omitTooltip) override;
    void highlightQuad(PassOwnPtr<FloatQuad>, const InspectorHighlightConfig&) override;
    void setInspectMode(InspectorDOMAgent::SearchMode, PassOwnPtr<InspectorHighlightConfig>) override;
    void setInspectedNode(Node*) override;

    void highlightNode(Node*, Node* eventTarget, const InspectorHighlightConfig&, bool omitTooltip);
    bool isEmpty();
    void drawNodeHighlight();
    void drawQuadHighlight();
    void drawPausedInDebuggerMessage();
    void drawViewSize();

    Page* overlayPage();
    LocalFrame* overlayMainFrame();
    void reset(const IntSize& viewportSize, const IntPoint& documentScrollOffset);
    void evaluateInOverlay(const String& method, const String& argument);
    void evaluateInOverlay(const String& method, PassOwnPtr<protocol::Value> argument);
    void onTimer(Timer<InspectorOverlay>*);
    void rebuildOverlayPage();
    void invalidate();
    void scheduleUpdate();

    bool handleMousePress();
    bool handleGestureEvent(const PlatformGestureEvent&);
    bool handleTouchEvent(const PlatformTouchEvent&);
    bool handleMouseMove(const PlatformMouseEvent&);
    bool shouldSearchForNode();
    void inspect(Node*);
    void initializeLayoutEditorIfNeeded(Node*);

    WebViewImpl* m_webViewImpl;
    String m_pausedInDebuggerMessage;
    RefPtrWillBeMember<Node> m_highlightNode;
    RefPtrWillBeMember<Node> m_eventTargetNode;
    InspectorHighlightConfig m_nodeHighlightConfig;
    OwnPtr<FloatQuad> m_highlightQuad;
    OwnPtrWillBeMember<Page> m_overlayPage;
    OwnPtrWillBeMember<InspectorOverlayChromeClient> m_overlayChromeClient;
    RefPtrWillBeMember<InspectorOverlayHost> m_overlayHost;
    InspectorHighlightConfig m_quadHighlightConfig;
    bool m_drawViewSize;
    bool m_resizeTimerActive;
    bool m_omitTooltip;
    Timer<InspectorOverlay> m_timer;
    int m_suspendCount;
    bool m_inLayout;
    bool m_needsUpdate;
    RawPtrWillBeMember<InspectorDebuggerAgent> m_debuggerAgent;
    RawPtrWillBeMember<InspectorDOMAgent> m_domAgent;
    RawPtrWillBeMember<InspectorCSSAgent> m_cssAgent;
    OwnPtrWillBeMember<LayoutEditor> m_layoutEditor;
    OwnPtr<PageOverlay> m_pageOverlay;
    RefPtrWillBeMember<Node> m_hoveredNodeForInspectMode;
    InspectorDOMAgent::SearchMode m_inspectMode;
    OwnPtr<InspectorHighlightConfig> m_inspectModeHighlightConfig;
};

} // namespace blink


#endif // InspectorOverlay_h