8908292c8f660b7c912cd8853814fa986462725b
[WebKit-https.git] / Source / WebCore / inspector / InspectorOverlay.h
1 /*
2  * Copyright (C) 2011 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef InspectorOverlay_h
30 #define InspectorOverlay_h
31
32 #include "Color.h"
33 #include "FloatQuad.h"
34 #include "LayoutRect.h"
35 #include "Timer.h"
36 #include <wtf/Deque.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace Inspector {
42 class InspectorObject;
43 class InspectorValue;
44 }
45
46 namespace WebCore {
47
48 class Color;
49 class GraphicsContext;
50 class InspectorClient;
51 class IntRect;
52 class Node;
53 class Page;
54
55 struct HighlightConfig {
56     WTF_MAKE_FAST_ALLOCATED;
57 public:
58     Color content;
59     Color contentOutline;
60     Color padding;
61     Color border;
62     Color margin;
63     bool showInfo;
64     bool usePageCoordinates;
65 };
66
67 enum HighlightType {
68     HighlightTypeNode,
69     HighlightTypeRects,
70 };
71
72 struct Highlight {
73     Highlight()
74         : type(HighlightTypeNode)
75         , usePageCoordinates(true)
76     {
77     }
78
79     void setDataFromConfig(const HighlightConfig& highlightConfig)
80     {
81         contentColor = highlightConfig.content;
82         contentOutlineColor = highlightConfig.contentOutline;
83         paddingColor = highlightConfig.padding;
84         borderColor = highlightConfig.border;
85         marginColor = highlightConfig.margin;
86         usePageCoordinates = highlightConfig.usePageCoordinates;
87     }
88
89     Color contentColor;
90     Color contentOutlineColor;
91     Color paddingColor;
92     Color borderColor;
93     Color marginColor;
94
95     // When the type is Node, there are 4 quads (margin, border, padding, content).
96     // When the type is Rects, this is just a list of quads.
97     HighlightType type;
98     Vector<FloatQuad> quads;
99     bool usePageCoordinates;
100 };
101
102 class InspectorOverlay {
103     WTF_MAKE_FAST_ALLOCATED;
104 public:
105     InspectorOverlay(Page&, InspectorClient*);
106     ~InspectorOverlay();
107
108     enum class CoordinateSystem {
109         View, // Adjusts for the main frame's scroll offset.
110         Document, // Does not adjust for the main frame's scroll offset.
111     };
112
113     void update();
114     void paint(GraphicsContext&);
115     void getHighlight(Highlight*, CoordinateSystem) const;
116
117     void setPausedInDebuggerMessage(const String*);
118
119     void hideHighlight();
120     void highlightNode(Node*, const HighlightConfig&);
121     void highlightQuad(std::unique_ptr<FloatQuad>, const HighlightConfig&);
122     
123     void setShowingPaintRects(bool);
124     void showPaintRect(const FloatRect&);
125     
126     Node* highlightedNode() const;
127
128     void didSetSearchingForNode(bool enabled);
129
130     void setIndicating(bool indicating);
131
132     PassRefPtr<Inspector::InspectorObject> buildObjectForHighlightedNode() const;
133
134     void freePage();
135 private:
136     bool shouldShowOverlay() const;
137     void drawGutter();
138     void drawNodeHighlight();
139     void drawQuadHighlight();
140     void drawPausedInDebuggerMessage();
141     void drawPaintRects();
142     void updatePaintRectsTimerFired(Timer&);
143
144     Page* overlayPage();
145
146     void forcePaint();
147     void reset(const IntSize& viewportSize, const IntSize& frameViewFullSize);
148     void evaluateInOverlay(const String& method);
149     void evaluateInOverlay(const String& method, const String& argument);
150     void evaluateInOverlay(const String& method, PassRefPtr<Inspector::InspectorValue> argument);
151
152     Page& m_page;
153     InspectorClient* m_client;
154     String m_pausedInDebuggerMessage;
155     RefPtr<Node> m_highlightNode;
156     HighlightConfig m_nodeHighlightConfig;
157     std::unique_ptr<FloatQuad> m_highlightQuad;
158     std::unique_ptr<Page> m_overlayPage;
159     HighlightConfig m_quadHighlightConfig;
160     
161     typedef std::pair<std::chrono::steady_clock::time_point, FloatRect> TimeRectPair;
162     Deque<TimeRectPair> m_paintRects;
163     Timer m_paintRectUpdateTimer;
164     bool m_indicating;
165     bool m_showingPaintRects;
166 };
167
168 } // namespace WebCore
169
170
171 #endif // InspectorOverlay_h