Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebCore / page / DebugPageOverlays.cpp
1 /*
2  * Copyright (C) 2014-2017 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 #include "config.h"
27 #include "DebugPageOverlays.h"
28
29 #include "ElementIterator.h"
30 #include "FrameView.h"
31 #include "GraphicsContext.h"
32 #include "MainFrame.h"
33 #include "Page.h"
34 #include "PageOverlay.h"
35 #include "PageOverlayController.h"
36 #include "Region.h"
37 #include "ScrollingCoordinator.h"
38 #include "Settings.h"
39
40 namespace WebCore {
41
42 DebugPageOverlays* DebugPageOverlays::sharedDebugOverlays;
43
44 class RegionOverlay : public RefCounted<RegionOverlay>, public PageOverlay::Client {
45 public:
46     static Ref<RegionOverlay> create(MainFrame&, DebugPageOverlays::RegionType);
47     virtual ~RegionOverlay();
48
49     void recomputeRegion();
50     PageOverlay& overlay() { return *m_overlay; }
51
52 protected:
53     RegionOverlay(MainFrame&, Color);
54
55 private:
56     void willMoveToPage(PageOverlay&, Page*) final;
57     void didMoveToPage(PageOverlay&, Page*) final;
58     void drawRect(PageOverlay&, GraphicsContext&, const IntRect& dirtyRect) override;
59     bool mouseEvent(PageOverlay&, const PlatformMouseEvent&) final;
60     void didScrollFrame(PageOverlay&, Frame&) final;
61
62 protected:
63     // Returns true if the region changed.
64     virtual bool updateRegion() = 0;
65     void drawRegion(GraphicsContext&, const Region&, const Color&, const IntRect& dirtyRect);
66     
67     MainFrame& m_frame;
68     RefPtr<PageOverlay> m_overlay;
69     std::unique_ptr<Region> m_region;
70     Color m_color;
71 };
72
73 class MouseWheelRegionOverlay final : public RegionOverlay {
74 public:
75     static Ref<MouseWheelRegionOverlay> create(MainFrame& frame)
76     {
77         return adoptRef(*new MouseWheelRegionOverlay(frame));
78     }
79
80 private:
81     explicit MouseWheelRegionOverlay(MainFrame& frame)
82         : RegionOverlay(frame, Color(0.5f, 0.0f, 0.0f, 0.4f))
83     {
84     }
85
86     bool updateRegion() override;
87 };
88
89 bool MouseWheelRegionOverlay::updateRegion()
90 {
91     auto region = std::make_unique<Region>();
92     
93     for (const Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext()) {
94         if (!frame->view() || !frame->document())
95             continue;
96
97         auto frameRegion = frame->document()->absoluteRegionForEventTargets(frame->document()->wheelEventTargets());
98         frameRegion.first.translate(toIntSize(frame->view()->contentsToRootView(IntPoint())));
99         region->unite(frameRegion.first);
100     }
101     
102     region->translate(m_overlay->viewToOverlayOffset());
103
104     bool regionChanged = !m_region || !(*m_region == *region);
105     m_region = WTFMove(region);
106     return regionChanged;
107 }
108
109 class NonFastScrollableRegionOverlay final : public RegionOverlay {
110 public:
111     static Ref<NonFastScrollableRegionOverlay> create(MainFrame& frame)
112     {
113         return adoptRef(*new NonFastScrollableRegionOverlay(frame));
114     }
115
116 private:
117     explicit NonFastScrollableRegionOverlay(MainFrame& frame)
118         : RegionOverlay(frame, Color(1.0f, 0.5f, 0.0f, 0.4f))
119     {
120     }
121
122     bool updateRegion() override;
123     void drawRect(PageOverlay&, GraphicsContext&, const IntRect& dirtyRect) final;
124     
125     EventTrackingRegions m_eventTrackingRegions;
126 };
127
128 bool NonFastScrollableRegionOverlay::updateRegion()
129 {
130     bool regionChanged = false;
131
132     if (Page* page = m_frame.page()) {
133         if (ScrollingCoordinator* scrollingCoordinator = page->scrollingCoordinator()) {
134             EventTrackingRegions eventTrackingRegions = scrollingCoordinator->absoluteEventTrackingRegions();
135
136             if (eventTrackingRegions != m_eventTrackingRegions) {
137                 m_eventTrackingRegions = eventTrackingRegions;
138                 regionChanged = true;
139             }
140         }
141     }
142
143     return regionChanged;
144 }
145
146 static const HashMap<String, Color>& touchEventRegionColors()
147 {
148     static const auto regionColors = makeNeverDestroyed([] {
149         struct MapEntry {
150             const char* name;
151             int r;
152             int g;
153             int b;
154         };
155         static const MapEntry entries[] = {
156             { "touchstart", 191, 191, 63 },
157             { "touchmove", 63, 191, 191 },
158             { "touchend", 191, 63, 127 },
159             { "touchforcechange", 63, 63, 191 },
160             { "wheel", 255, 128, 0 },
161         };
162         HashMap<String, Color> map;
163         for (auto& entry : entries)
164             map.add(ASCIILiteral { entry.name }, Color { entry.r, entry.g, entry.b, 80 });
165         return map;
166     }());
167     return regionColors;
168 }
169
170 static void drawRightAlignedText(const String& text, GraphicsContext& context, const FontCascade& font, const FloatPoint& boxLocation)
171 {
172     float textGap = 10;
173     float textBaselineFromTop = 14;
174
175     TextRun textRun = TextRun(StringView(text));
176     context.setFillColor(Color::transparent);
177     float textWidth = context.drawText(font, textRun, { });
178     context.setFillColor(Color::black);
179     context.drawText(font, textRun, boxLocation + FloatSize(-(textWidth + textGap), textBaselineFromTop));
180 }
181
182 void NonFastScrollableRegionOverlay::drawRect(PageOverlay& pageOverlay, GraphicsContext& context, const IntRect&)
183 {
184     IntRect bounds = pageOverlay.bounds();
185     
186     context.clearRect(bounds);
187     
188     FloatRect legendRect = { bounds.maxX() - 30.0f, 10, 20, 20 };
189     
190     FontCascadeDescription fontDescription;
191     fontDescription.setOneFamily("Helvetica");
192     fontDescription.setSpecifiedSize(12);
193     fontDescription.setComputedSize(12);
194     fontDescription.setWeight(FontSelectionValue(500));
195     FontCascade font(fontDescription, 0, 0);
196     font.update(nullptr);
197
198 #if ENABLE(TOUCH_EVENTS)
199     context.setFillColor(touchEventRegionColors().get("touchstart"));
200     context.fillRect(legendRect);
201     drawRightAlignedText("touchstart", context, font, legendRect.location());
202
203     legendRect.move(0, 30);
204     context.setFillColor(touchEventRegionColors().get("touchmove"));
205     context.fillRect(legendRect);
206     drawRightAlignedText("touchmove", context, font, legendRect.location());
207
208     legendRect.move(0, 30);
209     context.setFillColor(touchEventRegionColors().get("touchend"));
210     context.fillRect(legendRect);
211     drawRightAlignedText("touchend", context, font, legendRect.location());
212
213     legendRect.move(0, 30);
214     context.setFillColor(touchEventRegionColors().get("touchforcechange"));
215     context.fillRect(legendRect);
216     drawRightAlignedText("touchforcechange", context, font, legendRect.location());
217
218     legendRect.move(0, 30);
219     context.setFillColor(m_color);
220     context.fillRect(legendRect);
221     drawRightAlignedText("passive listeners", context, font, legendRect.location());
222 #else
223     // On desktop platforms, the "wheel" region includes the non-fast scrollable region.
224     context.setFillColor(touchEventRegionColors().get("wheel"));
225     context.fillRect(legendRect);
226     drawRightAlignedText("non-fast region", context, font, legendRect.location());
227 #endif
228
229     for (const auto& synchronousEventRegion : m_eventTrackingRegions.eventSpecificSynchronousDispatchRegions) {
230         Color regionColor = touchEventRegionColors().get(synchronousEventRegion.key);
231         drawRegion(context, synchronousEventRegion.value, regionColor, bounds);
232     }
233
234     drawRegion(context, m_eventTrackingRegions.asynchronousDispatchRegion, m_color, bounds);
235 }
236
237 Ref<RegionOverlay> RegionOverlay::create(MainFrame& frame, DebugPageOverlays::RegionType regionType)
238 {
239     switch (regionType) {
240     case DebugPageOverlays::RegionType::WheelEventHandlers:
241         return MouseWheelRegionOverlay::create(frame);
242     case DebugPageOverlays::RegionType::NonFastScrollableRegion:
243         return NonFastScrollableRegionOverlay::create(frame);
244     }
245     ASSERT_NOT_REACHED();
246     return MouseWheelRegionOverlay::create(frame);
247 }
248
249 RegionOverlay::RegionOverlay(MainFrame& frame, Color regionColor)
250     : m_frame(frame)
251     , m_overlay(PageOverlay::create(*this, PageOverlay::OverlayType::Document))
252     , m_color(regionColor)
253 {
254 }
255
256 RegionOverlay::~RegionOverlay()
257 {
258     if (m_overlay)
259         m_frame.pageOverlayController().uninstallPageOverlay(*m_overlay, PageOverlay::FadeMode::DoNotFade);
260 }
261
262 void RegionOverlay::willMoveToPage(PageOverlay&, Page* page)
263 {
264     if (!page)
265         m_overlay = nullptr;
266 }
267
268 void RegionOverlay::didMoveToPage(PageOverlay&, Page* page)
269 {
270     if (page)
271         recomputeRegion();
272 }
273
274 void RegionOverlay::drawRect(PageOverlay&, GraphicsContext& context, const IntRect& dirtyRect)
275 {
276     context.clearRect(dirtyRect);
277
278     if (!m_region)
279         return;
280
281     drawRegion(context, *m_region, m_color, dirtyRect);
282 }
283
284 void RegionOverlay::drawRegion(GraphicsContext& context, const Region& region, const Color& color, const IntRect& dirtyRect)
285 {
286     GraphicsContextStateSaver saver(context);
287     context.setFillColor(color);
288     for (auto rect : region.rects()) {
289         if (rect.intersects(dirtyRect))
290             context.fillRect(rect);
291     }
292 }
293
294 bool RegionOverlay::mouseEvent(PageOverlay&, const PlatformMouseEvent&)
295 {
296     return false;
297 }
298
299 void RegionOverlay::didScrollFrame(PageOverlay&, Frame&)
300 {
301 }
302
303 void RegionOverlay::recomputeRegion()
304 {
305     if (updateRegion())
306         m_overlay->setNeedsDisplay();
307 }
308
309 DebugPageOverlays& DebugPageOverlays::singleton()
310 {
311     if (!sharedDebugOverlays)
312         sharedDebugOverlays = new DebugPageOverlays;
313
314     return *sharedDebugOverlays;
315 }
316
317 static inline size_t indexOf(DebugPageOverlays::RegionType regionType)
318 {
319     return static_cast<size_t>(regionType);
320 }
321
322 RegionOverlay& DebugPageOverlays::ensureRegionOverlayForFrame(MainFrame& frame, RegionType regionType)
323 {
324     auto it = m_frameRegionOverlays.find(&frame);
325     if (it != m_frameRegionOverlays.end()) {
326         auto& visualizer = it->value[indexOf(regionType)];
327         if (!visualizer)
328             visualizer = RegionOverlay::create(frame, regionType);
329         return *visualizer;
330     }
331
332     Vector<RefPtr<RegionOverlay>> visualizers(NumberOfRegionTypes);
333     auto visualizer = RegionOverlay::create(frame, regionType);
334     visualizers[indexOf(regionType)] = visualizer.copyRef();
335     m_frameRegionOverlays.add(&frame, WTFMove(visualizers));
336     return visualizer;
337 }
338
339 void DebugPageOverlays::showRegionOverlay(MainFrame& frame, RegionType regionType)
340 {
341     auto& visualizer = ensureRegionOverlayForFrame(frame, regionType);
342     frame.pageOverlayController().installPageOverlay(visualizer.overlay(), PageOverlay::FadeMode::DoNotFade);
343 }
344
345 void DebugPageOverlays::hideRegionOverlay(MainFrame& frame, RegionType regionType)
346 {
347     auto it = m_frameRegionOverlays.find(&frame);
348     if (it == m_frameRegionOverlays.end())
349         return;
350     auto& visualizer = it->value[indexOf(regionType)];
351     if (!visualizer)
352         return;
353     frame.pageOverlayController().uninstallPageOverlay(visualizer->overlay(), PageOverlay::FadeMode::DoNotFade);
354     visualizer = nullptr;
355 }
356
357 void DebugPageOverlays::regionChanged(Frame& frame, RegionType regionType)
358 {
359     if (auto* visualizer = regionOverlayForFrame(frame.mainFrame(), regionType))
360         visualizer->recomputeRegion();
361 }
362
363 RegionOverlay* DebugPageOverlays::regionOverlayForFrame(MainFrame& frame, RegionType regionType) const
364 {
365     auto it = m_frameRegionOverlays.find(&frame);
366     if (it == m_frameRegionOverlays.end())
367         return nullptr;
368     return it->value.at(indexOf(regionType)).get();
369 }
370
371 void DebugPageOverlays::updateOverlayRegionVisibility(MainFrame& frame, DebugOverlayRegions visibleRegions)
372 {
373     if (visibleRegions & NonFastScrollableRegion)
374         showRegionOverlay(frame, RegionType::NonFastScrollableRegion);
375     else
376         hideRegionOverlay(frame, RegionType::NonFastScrollableRegion);
377
378     if (visibleRegions & WheelEventHandlerRegion)
379         showRegionOverlay(frame, RegionType::WheelEventHandlers);
380     else
381         hideRegionOverlay(frame, RegionType::WheelEventHandlers);
382 }
383
384 void DebugPageOverlays::settingsChanged(MainFrame& frame)
385 {
386     DebugOverlayRegions activeOverlayRegions = frame.settings().visibleDebugOverlayRegions();
387     if (!activeOverlayRegions && !hasOverlays(frame))
388         return;
389
390     DebugPageOverlays::singleton().updateOverlayRegionVisibility(frame, activeOverlayRegions);
391 }
392
393 }