Have DOMWindowProperty get is frame from its associated DOMWindow
[WebKit-https.git] / Source / WebCore / page / VisualViewport.cpp
1 /*
2  * Copyright (C) 2017 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  * 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 "VisualViewport.h"
28
29 #include "ContextDestructionObserver.h"
30 #include "DOMWindow.h"
31 #include "Document.h"
32 #include "DocumentEventQueue.h"
33 #include "Event.h"
34 #include "EventNames.h"
35 #include "Frame.h"
36 #include "FrameView.h"
37 #include "Page.h"
38
39 namespace WebCore {
40
41 VisualViewport::VisualViewport(DOMWindow& window)
42     : DOMWindowProperty(&window)
43 {
44 }
45
46 EventTargetInterface VisualViewport::eventTargetInterface() const
47 {
48     return VisualViewportEventTargetInterfaceType;
49 }
50
51 ScriptExecutionContext* VisualViewport::scriptExecutionContext() const
52 {
53     if (!m_window)
54         return nullptr;
55     return static_cast<ContextDestructionObserver*>(m_window)->scriptExecutionContext();
56 }
57
58 bool VisualViewport::addEventListener(const AtomicString& eventType, Ref<EventListener>&& listener, const AddEventListenerOptions& options)
59 {
60     if (!EventTarget::addEventListener(eventType, WTFMove(listener), options))
61         return false;
62
63     if (auto* frame = this->frame())
64         frame->document()->addListenerTypeIfNeeded(eventType);
65     return true;
66 }
67
68 void VisualViewport::updateFrameLayout() const
69 {
70     ASSERT(frame());
71     frame()->document()->updateLayoutIgnorePendingStylesheets(Document::RunPostLayoutTasks::Synchronously);
72 }
73
74 double VisualViewport::offsetLeft() const
75 {
76     if (!frame())
77         return 0;
78
79     updateFrameLayout();
80     return m_offsetLeft;
81 }
82
83 double VisualViewport::offsetTop() const
84 {
85     if (!frame())
86         return 0;
87
88     updateFrameLayout();
89     return m_offsetTop;
90 }
91
92 double VisualViewport::pageLeft() const
93 {
94     if (!frame())
95         return 0;
96
97     updateFrameLayout();
98     return m_pageLeft;
99 }
100
101 double VisualViewport::pageTop() const
102 {
103     if (!frame())
104         return 0;
105
106     updateFrameLayout();
107     return m_pageTop;
108 }
109
110 double VisualViewport::width() const
111 {
112     if (!frame())
113         return 0;
114
115     updateFrameLayout();
116     return m_width;
117 }
118
119 double VisualViewport::height() const
120 {
121     if (!frame())
122         return 0;
123
124     updateFrameLayout();
125     return m_height;
126 }
127
128 double VisualViewport::scale() const
129 {
130     // Subframes always have scale 1 since they aren't scaled relative to their parent frame.
131     auto* frame = this->frame();
132     if (!frame || !frame->isMainFrame())
133         return 1;
134
135     updateFrameLayout();
136     return m_scale;
137 }
138
139 void VisualViewport::update()
140 {
141     double offsetLeft = 0;
142     double offsetTop = 0;
143     m_pageLeft = 0;
144     m_pageTop = 0;
145     double width = 0;
146     double height = 0;
147     double scale = 1;
148
149     if (auto* frame = this->frame()) {
150         if (auto* view = frame->view()) {
151             auto visualViewportRect = view->visualViewportRect();
152             auto layoutViewportRect = view->layoutViewportRect();
153             auto pageZoomFactor = frame->pageZoomFactor();
154             ASSERT(pageZoomFactor);
155             offsetLeft = (visualViewportRect.x() - layoutViewportRect.x()) / pageZoomFactor;
156             offsetTop = (visualViewportRect.y() - layoutViewportRect.y()) / pageZoomFactor;
157             m_pageLeft = visualViewportRect.x() / pageZoomFactor;
158             m_pageTop = visualViewportRect.y() / pageZoomFactor;
159             width = visualViewportRect.width() / pageZoomFactor;
160             height = visualViewportRect.height() / pageZoomFactor;
161         }
162         if (auto* page = frame->page())
163             scale = page->pageScaleFactor();
164     }
165
166     if (m_offsetLeft != offsetLeft || m_offsetTop != offsetTop) {
167         enqueueScrollEvent();
168         m_offsetLeft = offsetLeft;
169         m_offsetTop = offsetTop;
170     }
171     if (m_width != width || m_height != height || m_scale != scale) {
172         enqueueResizeEvent();
173         m_width = width;
174         m_height = height;
175         m_scale = scale;
176     }
177 }
178
179 void VisualViewport::enqueueResizeEvent()
180 {
181     auto* frame = this->frame();
182     if (!frame)
183         return;
184
185     frame->document()->eventQueue().enqueueResizeEvent(*this, Event::CanBubble::No, Event::IsCancelable::No);
186 }
187
188 void VisualViewport::enqueueScrollEvent()
189 {
190     auto* frame = this->frame();
191     if (!frame)
192         return;
193
194     frame->document()->eventQueue().enqueueScrollEvent(*this, Event::CanBubble::No, Event::IsCancelable::No);
195 }
196
197 } // namespace WebCore