Disable outdated WritableStream API
[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 HashMap<String, Color>& touchEventRegionColors()
147 {
148     static NeverDestroyed<HashMap<String, Color>> regionColors;
149
150     if (regionColors.get().isEmpty()) {
151         regionColors.get().add("touchstart", Color(191, 191, 63, 80));
152         regionColors.get().add("touchmove", Color(63, 191, 191, 80));
153         regionColors.get().add("touchend", Color(191, 63, 127, 80));
154         regionColors.get().add("touchforcechange", Color(63, 63, 191, 80));
155         regionColors.get().add("wheel", Color(255, 128, 0, 80));
156     }
157     
158     return regionColors;
159 }
160
161 static void drawRightAlignedText(const String& text, GraphicsContext& context, const FontCascade& font, const FloatPoint& boxLocation)
162 {
163     float textGap = 10;
164     float textBaselineFromTop = 14;
165
166     TextRun textRun = TextRun(StringView(text));
167     context.setFillColor(Color::transparent);
168     float textWidth = context.drawText(font, textRun, { });
169     context.setFillColor(Color::black);
170     context.drawText(font, textRun, boxLocation + FloatSize(-(textWidth + textGap), textBaselineFromTop));
171 }
172
173 void NonFastScrollableRegionOverlay::drawRect(PageOverlay& pageOverlay, GraphicsContext& context, const IntRect&)
174 {
175     IntRect bounds = pageOverlay.bounds();
176     
177     context.clearRect(bounds);
178     
179     FloatRect legendRect = { bounds.maxX() - 30.0f, 10, 20, 20 };
180     
181     FontCascadeDescription fontDescription;
182     fontDescription.setOneFamily("Helvetica");
183     fontDescription.setSpecifiedSize(12);
184     fontDescription.setComputedSize(12);
185     fontDescription.setWeight(FontSelectionValue(500));
186     FontCascade font(fontDescription, 0, 0);
187     font.update(nullptr);
188
189 #if ENABLE(TOUCH_EVENTS)
190     context.setFillColor(touchEventRegionColors().get("touchstart"));
191     context.fillRect(legendRect);
192     drawRightAlignedText("touchstart", context, font, legendRect.location());
193
194     legendRect.move(0, 30);
195     context.setFillColor(touchEventRegionColors().get("touchmove"));
196     context.fillRect(legendRect);
197     drawRightAlignedText("touchmove", context, font, legendRect.location());
198
199     legendRect.move(0, 30);
200     context.setFillColor(touchEventRegionColors().get("touchend"));
201     context.fillRect(legendRect);
202     drawRightAlignedText("touchend", context, font, legendRect.location());
203
204     legendRect.move(0, 30);
205     context.setFillColor(touchEventRegionColors().get("touchforcechange"));
206     context.fillRect(legendRect);
207     drawRightAlignedText("touchforcechange", context, font, legendRect.location());
208
209     legendRect.move(0, 30);
210     context.setFillColor(m_color);
211     context.fillRect(legendRect);
212     drawRightAlignedText("passive listeners", context, font, legendRect.location());
213 #else
214     // On desktop platforms, the "wheel" region includes the non-fast scrollable region.
215     context.setFillColor(touchEventRegionColors().get("wheel"));
216     context.fillRect(legendRect);
217     drawRightAlignedText("non-fast region", context, font, legendRect.location());
218 #endif
219
220     for (const auto& synchronousEventRegion : m_eventTrackingRegions.eventSpecificSynchronousDispatchRegions) {
221         Color regionColor = touchEventRegionColors().get(synchronousEventRegion.key);
222         drawRegion(context, synchronousEventRegion.value, regionColor, bounds);
223     }
224
225     drawRegion(context, m_eventTrackingRegions.asynchronousDispatchRegion, m_color, bounds);
226 }
227
228 Ref<RegionOverlay> RegionOverlay::create(MainFrame& frame, DebugPageOverlays::RegionType regionType)
229 {
230     switch (regionType) {
231     case DebugPageOverlays::RegionType::WheelEventHandlers:
232         return MouseWheelRegionOverlay::create(frame);
233     case DebugPageOverlays::RegionType::NonFastScrollableRegion:
234         return NonFastScrollableRegionOverlay::create(frame);
235     }
236     ASSERT_NOT_REACHED();
237     return MouseWheelRegionOverlay::create(frame);
238 }
239
240 RegionOverlay::RegionOverlay(MainFrame& frame, Color regionColor)
241     : m_frame(frame)
242     , m_overlay(PageOverlay::create(*this, PageOverlay::OverlayType::Document))
243     , m_color(regionColor)
244 {
245 }
246
247 RegionOverlay::~RegionOverlay()
248 {
249     if (m_overlay)
250         m_frame.pageOverlayController().uninstallPageOverlay(*m_overlay, PageOverlay::FadeMode::DoNotFade);
251 }
252
253 void RegionOverlay::willMoveToPage(PageOverlay&, Page* page)
254 {
255     if (!page)
256         m_overlay = nullptr;
257 }
258
259 void RegionOverlay::didMoveToPage(PageOverlay&, Page* page)
260 {
261     if (page)
262         recomputeRegion();
263 }
264
265 void RegionOverlay::drawRect(PageOverlay&, GraphicsContext& context, const IntRect& dirtyRect)
266 {
267     context.clearRect(dirtyRect);
268
269     if (!m_region)
270         return;
271
272     drawRegion(context, *m_region, m_color, dirtyRect);
273 }
274
275 void RegionOverlay::drawRegion(GraphicsContext& context, const Region& region, const Color& color, const IntRect& dirtyRect)
276 {
277     GraphicsContextStateSaver saver(context);
278     context.setFillColor(color);
279     for (auto rect : region.rects()) {
280         if (rect.intersects(dirtyRect))
281             context.fillRect(rect);
282     }
283 }
284
285 bool RegionOverlay::mouseEvent(PageOverlay&, const PlatformMouseEvent&)
286 {
287     return false;
288 }
289
290 void RegionOverlay::didScrollFrame(PageOverlay&, Frame&)
291 {
292 }
293
294 void RegionOverlay::recomputeRegion()
295 {
296     if (updateRegion())
297         m_overlay->setNeedsDisplay();
298 }
299
300 DebugPageOverlays& DebugPageOverlays::singleton()
301 {
302     if (!sharedDebugOverlays)
303         sharedDebugOverlays = new DebugPageOverlays;
304
305     return *sharedDebugOverlays;
306 }
307
308 static inline size_t indexOf(DebugPageOverlays::RegionType regionType)
309 {
310     return static_cast<size_t>(regionType);
311 }
312
313 RegionOverlay& DebugPageOverlays::ensureRegionOverlayForFrame(MainFrame& frame, RegionType regionType)
314 {
315     auto it = m_frameRegionOverlays.find(&frame);
316     if (it != m_frameRegionOverlays.end()) {
317         auto& visualizer = it->value[indexOf(regionType)];
318         if (!visualizer)
319             visualizer = RegionOverlay::create(frame, regionType);
320         return *visualizer;
321     }
322
323     Vector<RefPtr<RegionOverlay>> visualizers(NumberOfRegionTypes);
324     auto visualizer = RegionOverlay::create(frame, regionType);
325     visualizers[indexOf(regionType)] = visualizer.copyRef();
326     m_frameRegionOverlays.add(&frame, WTFMove(visualizers));
327     return visualizer;
328 }
329
330 void DebugPageOverlays::showRegionOverlay(MainFrame& frame, RegionType regionType)
331 {
332     auto& visualizer = ensureRegionOverlayForFrame(frame, regionType);
333     frame.pageOverlayController().installPageOverlay(visualizer.overlay(), PageOverlay::FadeMode::DoNotFade);
334 }
335
336 void DebugPageOverlays::hideRegionOverlay(MainFrame& frame, RegionType regionType)
337 {
338     auto it = m_frameRegionOverlays.find(&frame);
339     if (it == m_frameRegionOverlays.end())
340         return;
341     auto& visualizer = it->value[indexOf(regionType)];
342     if (!visualizer)
343         return;
344     frame.pageOverlayController().uninstallPageOverlay(visualizer->overlay(), PageOverlay::FadeMode::DoNotFade);
345     visualizer = nullptr;
346 }
347
348 void DebugPageOverlays::regionChanged(Frame& frame, RegionType regionType)
349 {
350     if (auto* visualizer = regionOverlayForFrame(frame.mainFrame(), regionType))
351         visualizer->recomputeRegion();
352 }
353
354 RegionOverlay* DebugPageOverlays::regionOverlayForFrame(MainFrame& frame, RegionType regionType) const
355 {
356     auto it = m_frameRegionOverlays.find(&frame);
357     if (it == m_frameRegionOverlays.end())
358         return nullptr;
359     return it->value.at(indexOf(regionType)).get();
360 }
361
362 void DebugPageOverlays::updateOverlayRegionVisibility(MainFrame& frame, DebugOverlayRegions visibleRegions)
363 {
364     if (visibleRegions & NonFastScrollableRegion)
365         showRegionOverlay(frame, RegionType::NonFastScrollableRegion);
366     else
367         hideRegionOverlay(frame, RegionType::NonFastScrollableRegion);
368
369     if (visibleRegions & WheelEventHandlerRegion)
370         showRegionOverlay(frame, RegionType::WheelEventHandlers);
371     else
372         hideRegionOverlay(frame, RegionType::WheelEventHandlers);
373 }
374
375 void DebugPageOverlays::settingsChanged(MainFrame& frame)
376 {
377     DebugOverlayRegions activeOverlayRegions = frame.settings().visibleDebugOverlayRegions();
378     if (!activeOverlayRegions && !hasOverlays(frame))
379         return;
380
381     DebugPageOverlays::singleton().updateOverlayRegionVisibility(frame, activeOverlayRegions);
382 }
383
384 }