Use WeakPtrs to avoid using deallocated Widgets and ScrollableAreas
[WebKit.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 #if PLATFORM(EFL)
65 typedef Evas_Object* PlatformWidget;
66 #endif
67
68 typedef PlatformWidget PlatformPageClient;
69
70 namespace WebCore {
71
72 class Cursor;
73 class Event;
74 class FontCascade;
75 class FrameView;
76 class GraphicsContext;
77 class PlatformMouseEvent;
78 class ScrollView;
79
80 enum WidgetNotification { WillPaintFlattened, DidPaintFlattened };
81
82 // The Widget class serves as a base class for three kinds of objects:
83 // (1) Scrollable areas (ScrollView)
84 // (2) Scrollbars (Scrollbar)
85 // (3) Plugins (PluginView)
86 //
87 // A widget may or may not be backed by a platform-specific object (e.g., HWND on Windows, NSView on Mac, QWidget on Qt).
88 //
89 // Widgets are connected in a hierarchy, with the restriction that plugins and scrollbars are always leaves of the
90 // tree.  Only ScrollViews can have children (and therefore the Widget class has no concept of children).
91 //
92 // The rules right now for which widgets get platform-specific objects are as follows:
93 // ScrollView - Mac
94 // Scrollbar - Mac, Gtk
95 // Plugin - Mac, Windows (windowed only), Qt (windowed only, widget is an HWND on windows), Gtk (windowed only)
96 //
97 class Widget : public RefCounted<Widget> {
98 public:
99     WEBCORE_EXPORT explicit Widget(PlatformWidget = nullptr);
100     WEBCORE_EXPORT virtual ~Widget();
101
102     WEBCORE_EXPORT PlatformWidget platformWidget() const;
103     WEBCORE_EXPORT void setPlatformWidget(PlatformWidget);
104
105     int x() const { return frameRect().x(); }
106     int y() const { return frameRect().y(); }
107     int width() const { return frameRect().width(); }
108     int height() const { return frameRect().height(); }
109     IntSize size() const { return frameRect().size(); }
110     IntPoint location() const { return frameRect().location(); }
111
112     WEBCORE_EXPORT virtual void setFrameRect(const IntRect&);
113     WEBCORE_EXPORT IntRect frameRect() const;
114     IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
115
116     void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
117     void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
118     void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
119     void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
120
121     WEBCORE_EXPORT virtual void paint(GraphicsContext&, const IntRect&);
122     void invalidate() { invalidateRect(boundsRect()); }
123     virtual void invalidateRect(const IntRect&) = 0;
124
125     WEBCORE_EXPORT virtual void setFocus(bool);
126
127     void setCursor(const Cursor&);
128
129     WEBCORE_EXPORT virtual void show();
130     WEBCORE_EXPORT virtual void hide();
131     bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
132     bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
133     bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
134     virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
135     void setSelfVisible(bool v) { m_selfVisible = v; }
136
137     void setIsSelected(bool);
138
139     virtual bool isFrameView() const { return false; }
140     virtual bool isPluginView() const { return false; }
141     // FIXME: The Mac plug-in code should inherit from PluginView. When this happens PluginViewBase and PluginView can become one class.
142     virtual bool isPluginViewBase() const { return false; }
143     virtual bool isScrollbar() const { return false; }
144     virtual bool isScrollView() const { return false; }
145
146     WEBCORE_EXPORT void removeFromParent();
147     WEBCORE_EXPORT virtual void setParent(ScrollView* view);
148     ScrollView* parent() const { return m_parent; }
149     FrameView* root() const;
150
151     virtual void handleEvent(Event*) { }
152
153     virtual void notifyWidget(WidgetNotification) { }
154
155     WEBCORE_EXPORT IntRect convertToRootView(const IntRect&) const;
156     IntRect convertFromRootView(const IntRect&) const;
157
158     IntPoint convertToRootView(const IntPoint&) const;
159     IntPoint convertFromRootView(const IntPoint&) const;
160
161     // It is important for cross-platform code to realize that Mac has flipped coordinates.  Therefore any code
162     // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
163     // up with an inaccurate rect.  Always make sure to use the rect-based convertFromContainingWindow method
164     // when converting window rects.
165     WEBCORE_EXPORT IntRect convertToContainingWindow(const IntRect&) const;
166     IntRect convertFromContainingWindow(const IntRect&) const;
167
168     WEBCORE_EXPORT IntPoint convertToContainingWindow(const IntPoint&) const;
169     IntPoint convertFromContainingWindow(const IntPoint&) const;
170
171     virtual void frameRectsChanged() { }
172
173     // Notifies this widget that its clip rect changed.
174     virtual void clipRectChanged() { }
175
176     // Whether transforms affect the frame rect. FIXME: We get rid of this and have
177     // the frame rects be the same no matter what transforms are applied.
178     virtual bool transformsAffectFrameRect() { return true; }
179
180 #if PLATFORM(COCOA)
181     NSView* getOuterView() const;
182
183     void removeFromSuperview();
184 #endif
185 #if PLATFORM(IOS)
186     void addToSuperview(NSView*);
187 #endif
188
189     // Virtual methods to convert points to/from the containing ScrollView
190     WEBCORE_EXPORT virtual IntRect convertToContainingView(const IntRect&) const;
191     WEBCORE_EXPORT virtual IntRect convertFromContainingView(const IntRect&) const;
192     WEBCORE_EXPORT virtual IntPoint convertToContainingView(const IntPoint&) const;
193     WEBCORE_EXPORT virtual IntPoint convertFromContainingView(const IntPoint&) const;
194
195     WeakPtr<Widget> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(); }
196
197 private:
198     void init(PlatformWidget); // Must be called by all Widget constructors to initialize cross-platform data.
199
200     void releasePlatformWidget();
201     void retainPlatformWidget();
202
203     // These methods are used to convert from the root widget to the containing window,
204     // which has behavior that may differ between platforms (e.g. Mac uses flipped window coordinates).
205     static IntRect convertFromRootToContainingWindow(const Widget* rootWidget, const IntRect&);
206     static IntRect convertFromContainingWindowToRoot(const Widget* rootWidget, const IntRect&);
207
208     static IntPoint convertFromRootToContainingWindow(const Widget* rootWidget, const IntPoint&);
209     static IntPoint convertFromContainingWindowToRoot(const Widget* rootWidget, const IntPoint&);
210
211 private:
212     ScrollView* m_parent;
213 #if !PLATFORM(COCOA)
214     PlatformWidget m_widget;
215 #else
216     RetainPtr<NSView> m_widget;
217 #endif
218     WeakPtrFactory<Widget> m_weakPtrFactory { this };
219     bool m_selfVisible;
220     bool m_parentVisible;
221
222     IntRect m_frame; // Not used when a native widget exists.
223 };
224
225 #if !PLATFORM(COCOA)
226
227 inline PlatformWidget Widget::platformWidget() const
228 {
229     return m_widget;
230 }
231
232 inline void Widget::setPlatformWidget(PlatformWidget widget)
233 {
234     if (widget != m_widget) {
235         releasePlatformWidget();
236         m_widget = widget;
237         retainPlatformWidget();
238     }
239 }
240
241 #endif
242
243 #if !PLATFORM(GTK)
244
245 inline void Widget::releasePlatformWidget()
246 {
247 }
248
249 inline void Widget::retainPlatformWidget()
250 {
251 }
252
253 #endif
254
255 } // namespace WebCore
256
257 #define SPECIALIZE_TYPE_TRAITS_WIDGET(ToValueTypeName, predicate) \
258 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
259     static bool isType(const WebCore::Widget& widget) { return widget.predicate; } \
260 SPECIALIZE_TYPE_TRAITS_END()
261
262 #endif // Widget_h