Restrict SVG filters to accessible security origins
[WebKit-https.git] / Source / WebCore / platform / Widget.h
1 /*
2  * Copyright (C) 2004-2016 Apple Inc.  All rights reserved.
3  * Copyright (C) 2008 Collabora Ltd.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef Widget_h
28 #define Widget_h
29
30 #if PLATFORM(IOS)
31 #ifndef NSView
32 #define NSView WAKView
33 #endif
34 #endif
35
36 #include "IntRect.h"
37 #include "PlatformScreen.h"
38 #include <wtf/Forward.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/TypeCasts.h>
41 #include <wtf/WeakPtr.h>
42
43 #if PLATFORM(COCOA)
44 #include <wtf/RetainPtr.h>
45 #endif
46
47 #if PLATFORM(COCOA)
48 OBJC_CLASS NSView;
49 OBJC_CLASS NSWindow;
50 typedef NSView *PlatformWidget;
51 #endif
52
53 #if PLATFORM(WIN)
54 typedef struct HWND__* HWND;
55 typedef HWND PlatformWidget;
56 #endif
57
58 #if PLATFORM(GTK)
59 typedef struct _GtkWidget GtkWidget;
60 typedef struct _GtkContainer GtkContainer;
61 typedef GtkWidget* PlatformWidget;
62 #endif
63
64 typedef PlatformWidget PlatformPageClient;
65
66 namespace WebCore {
67
68 class Cursor;
69 class Event;
70 class FontCascade;
71 class FrameView;
72 class GraphicsContext;
73 class PlatformMouseEvent;
74 class ScrollView;
75
76 enum WidgetNotification { WillPaintFlattened, DidPaintFlattened };
77
78 // The Widget class serves as a base class for three kinds of objects:
79 // (1) Scrollable areas (ScrollView)
80 // (2) Scrollbars (Scrollbar)
81 // (3) Plugins (PluginView)
82 //
83 // A widget may or may not be backed by a platform-specific object (e.g., HWND on Windows, NSView on Mac, QWidget on Qt).
84 //
85 // Widgets are connected in a hierarchy, with the restriction that plugins and scrollbars are always leaves of the
86 // tree.  Only ScrollViews can have children (and therefore the Widget class has no concept of children).
87 //
88 // The rules right now for which widgets get platform-specific objects are as follows:
89 // ScrollView - Mac
90 // Scrollbar - Mac, Gtk
91 // Plugin - Mac, Windows (windowed only), Qt (windowed only, widget is an HWND on windows), Gtk (windowed only)
92 //
93 class Widget : public RefCounted<Widget> {
94 public:
95     WEBCORE_EXPORT explicit Widget(PlatformWidget = nullptr);
96     WEBCORE_EXPORT virtual ~Widget();
97
98     WEBCORE_EXPORT PlatformWidget platformWidget() const;
99     WEBCORE_EXPORT void setPlatformWidget(PlatformWidget);
100
101     int x() const { return frameRect().x(); }
102     int y() const { return frameRect().y(); }
103     int width() const { return frameRect().width(); }
104     int height() const { return frameRect().height(); }
105     IntSize size() const { return frameRect().size(); }
106     IntPoint location() const { return frameRect().location(); }
107
108     WEBCORE_EXPORT virtual void setFrameRect(const IntRect&);
109     WEBCORE_EXPORT IntRect frameRect() const;
110     IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
111
112     void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
113     void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
114     void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
115     void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
116
117     enum class SecurityOriginPaintPolicy { AnyOrigin, AccessibleOriginOnly };
118
119     WEBCORE_EXPORT virtual void paint(GraphicsContext&, const IntRect&, SecurityOriginPaintPolicy = SecurityOriginPaintPolicy::AnyOrigin);
120     void invalidate() { invalidateRect(boundsRect()); }
121     virtual void invalidateRect(const IntRect&) = 0;
122
123     WEBCORE_EXPORT virtual void setFocus(bool);
124
125     void setCursor(const Cursor&);
126
127     WEBCORE_EXPORT virtual void show();
128     WEBCORE_EXPORT virtual void hide();
129     bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
130     bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
131     bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
132     virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
133     void setSelfVisible(bool v) { m_selfVisible = v; }
134
135     void setIsSelected(bool);
136
137     virtual bool isFrameView() const { return false; }
138     virtual bool isPluginView() const { return false; }
139     // FIXME: The Mac plug-in code should inherit from PluginView. When this happens PluginViewBase and PluginView can become one class.
140     virtual bool isPluginViewBase() const { return false; }
141     virtual bool isScrollbar() const { return false; }
142     virtual bool isScrollView() const { return false; }
143
144     WEBCORE_EXPORT void removeFromParent();
145     WEBCORE_EXPORT virtual void setParent(ScrollView* view);
146     ScrollView* parent() const { return m_parent; }
147     FrameView* root() const;
148
149     virtual void handleEvent(Event*) { }
150
151     virtual void notifyWidget(WidgetNotification) { }
152
153     WEBCORE_EXPORT IntRect convertToRootView(const IntRect&) const;
154     IntRect convertFromRootView(const IntRect&) const;
155
156     IntPoint convertToRootView(const IntPoint&) const;
157     IntPoint convertFromRootView(const IntPoint&) const;
158
159     // It is important for cross-platform code to realize that Mac has flipped coordinates.  Therefore any code
160     // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
161     // up with an inaccurate rect.  Always make sure to use the rect-based convertFromContainingWindow method
162     // when converting window rects.
163     WEBCORE_EXPORT IntRect convertToContainingWindow(const IntRect&) const;
164     IntRect convertFromContainingWindow(const IntRect&) const;
165
166     WEBCORE_EXPORT IntPoint convertToContainingWindow(const IntPoint&) const;
167     IntPoint convertFromContainingWindow(const IntPoint&) const;
168
169     virtual void frameRectsChanged() { }
170
171     // Notifies this widget that its clip rect changed.
172     virtual void clipRectChanged() { }
173
174     // Whether transforms affect the frame rect. FIXME: We get rid of this and have
175     // the frame rects be the same no matter what transforms are applied.
176     virtual bool transformsAffectFrameRect() { return true; }
177
178 #if PLATFORM(COCOA)
179     NSView* getOuterView() const;
180
181     void removeFromSuperview();
182 #endif
183 #if PLATFORM(IOS)
184     void addToSuperview(NSView*);
185 #endif
186
187     // Virtual methods to convert points to/from the containing ScrollView
188     WEBCORE_EXPORT virtual IntRect convertToContainingView(const IntRect&) const;
189     WEBCORE_EXPORT virtual IntRect convertFromContainingView(const IntRect&) const;
190     WEBCORE_EXPORT virtual IntPoint convertToContainingView(const IntPoint&) const;
191     WEBCORE_EXPORT virtual IntPoint convertFromContainingView(const IntPoint&) const;
192
193     WeakPtr<Widget> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(); }
194
195 private:
196     void init(PlatformWidget); // Must be called by all Widget constructors to initialize cross-platform data.
197
198     void releasePlatformWidget();
199     void retainPlatformWidget();
200
201     // These methods are used to convert from the root widget to the containing window,
202     // which has behavior that may differ between platforms (e.g. Mac uses flipped window coordinates).
203     static IntRect convertFromRootToContainingWindow(const Widget* rootWidget, const IntRect&);
204     static IntRect convertFromContainingWindowToRoot(const Widget* rootWidget, const IntRect&);
205
206     static IntPoint convertFromRootToContainingWindow(const Widget* rootWidget, const IntPoint&);
207     static IntPoint convertFromContainingWindowToRoot(const Widget* rootWidget, const IntPoint&);
208
209 private:
210     ScrollView* m_parent;
211 #if !PLATFORM(COCOA)
212     PlatformWidget m_widget;
213 #else
214     RetainPtr<NSView> m_widget;
215 #endif
216     WeakPtrFactory<Widget> m_weakPtrFactory { this };
217     bool m_selfVisible;
218     bool m_parentVisible;
219
220     IntRect m_frame; // Not used when a native widget exists.
221 };
222
223 #if !PLATFORM(COCOA)
224
225 inline PlatformWidget Widget::platformWidget() const
226 {
227     return m_widget;
228 }
229
230 inline void Widget::setPlatformWidget(PlatformWidget widget)
231 {
232     if (widget != m_widget) {
233         releasePlatformWidget();
234         m_widget = widget;
235         retainPlatformWidget();
236     }
237 }
238
239 #endif
240
241 #if !PLATFORM(GTK)
242
243 inline void Widget::releasePlatformWidget()
244 {
245 }
246
247 inline void Widget::retainPlatformWidget()
248 {
249 }
250
251 #endif
252
253 } // namespace WebCore
254
255 #define SPECIALIZE_TYPE_TRAITS_WIDGET(ToValueTypeName, predicate) \
256 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
257     static bool isType(const WebCore::Widget& widget) { return widget.predicate; } \
258 SPECIALIZE_TYPE_TRAITS_END()
259
260 #endif // Widget_h