Remove some iOS #ifdefs by adding SQLiteDatabaseTracker to all the builds
[WebKit-https.git] / Source / WebCore / platform / ScrollableArea.h
1 /*
2  * Copyright (C) 2008, 2011 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ScrollableArea_h
27 #define ScrollableArea_h
28
29 #include "Scrollbar.h"
30 #include <wtf/Vector.h>
31
32 namespace WebCore {
33
34 class FloatPoint;
35 class GraphicsContext;
36 class PlatformTouchEvent;
37 class PlatformWheelEvent;
38 class ScrollAnimator;
39 #if USE(ACCELERATED_COMPOSITING)
40 class GraphicsLayer;
41 class TiledBacking;
42 #endif
43
44 class ScrollableArea {
45 public:
46     bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1);
47     void scrollToOffsetWithoutAnimation(const FloatPoint&);
48     void scrollToOffsetWithoutAnimation(ScrollbarOrientation, float offset);
49
50     // Should be called when the scroll position changes externally, for example if the scroll layer position
51     // is updated on the scrolling thread and we need to notify the main thread.
52     void notifyScrollPositionChanged(const IntPoint&);
53
54     // Allows subclasses to handle scroll position updates themselves. If this member function
55     // returns true, the scrollable area won't actually update the scroll position and instead
56     // expect it to happen sometime in the future.
57     virtual bool requestScrollPositionUpdate(const IntPoint&) { return false; }
58
59     bool handleWheelEvent(const PlatformWheelEvent&);
60
61 #if ENABLE(TOUCH_EVENTS)
62     virtual bool isTouchScrollable() const { return false; }
63     virtual bool handleTouchEvent(const PlatformTouchEvent&);
64 #endif
65
66 #if PLATFORM(IOS)
67     virtual bool isOverflowScroll() const { return false; }
68     virtual void didStartScroll() { }
69     virtual void didEndScroll() { }
70     virtual void didUpdateScroll() { }
71     virtual void setIsUserScroll(bool) { }
72 #endif
73
74     // Functions for controlling if you can scroll past the end of the document.
75     bool constrainsScrollingToContentEdge() const { return m_constrainsScrollingToContentEdge; }
76     void setConstrainsScrollingToContentEdge(bool constrainsScrollingToContentEdge) { m_constrainsScrollingToContentEdge = constrainsScrollingToContentEdge; }
77
78     void setVerticalScrollElasticity(ScrollElasticity scrollElasticity) { m_verticalScrollElasticity = scrollElasticity; }
79     ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
80
81     void setHorizontalScrollElasticity(ScrollElasticity scrollElasticity) { m_horizontalScrollElasticity = scrollElasticity; }
82     ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
83
84     bool inLiveResize() const { return m_inLiveResize; }
85     virtual void willStartLiveResize();
86     virtual void willEndLiveResize();
87
88     void contentAreaWillPaint() const;
89     void mouseEnteredContentArea() const;
90     void mouseExitedContentArea() const;
91     void mouseMovedInContentArea() const;
92     void mouseEnteredScrollbar(Scrollbar*) const;
93     void mouseExitedScrollbar(Scrollbar*) const;
94     void contentAreaDidShow() const;
95     void contentAreaDidHide() const;
96
97     void lockOverlayScrollbarStateToHidden(bool shouldLockState) const;
98     bool scrollbarsCanBeActive() const;
99
100     virtual void didAddScrollbar(Scrollbar*, ScrollbarOrientation);
101     virtual void willRemoveScrollbar(Scrollbar*, ScrollbarOrientation);
102
103     virtual void contentsResized();
104
105     bool hasOverlayScrollbars() const;
106     virtual void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
107     ScrollbarOverlayStyle scrollbarOverlayStyle() const { return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle); }
108
109     // This getter will create a ScrollAnimator if it doesn't already exist.
110     ScrollAnimator* scrollAnimator() const;
111
112     // This getter will return null if the ScrollAnimator hasn't been created yet.
113     ScrollAnimator* existingScrollAnimator() const { return m_scrollAnimator.get(); }
114
115     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
116     bool scrollOriginChanged() const { return m_scrollOriginChanged; }
117
118     virtual bool isActive() const = 0;
119     virtual int scrollSize(ScrollbarOrientation) const = 0;
120     virtual int scrollPosition(Scrollbar*) const = 0;
121     virtual void invalidateScrollbar(Scrollbar*, const IntRect&);
122     virtual bool isScrollCornerVisible() const = 0;
123     virtual IntRect scrollCornerRect() const = 0;
124     virtual void invalidateScrollCorner(const IntRect&);
125
126     virtual bool updatesScrollLayerPositionOnMainThread() const = 0;
127
128     // Convert points and rects between the scrollbar and its containing view.
129     // The client needs to implement these in order to be aware of layout effects
130     // like CSS transforms.
131     virtual IntRect convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntRect& scrollbarRect) const
132     {
133         return scrollbar->Widget::convertToContainingView(scrollbarRect);
134     }
135     virtual IntRect convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntRect& parentRect) const
136     {
137         return scrollbar->Widget::convertFromContainingView(parentRect);
138     }
139     virtual IntPoint convertFromScrollbarToContainingView(const Scrollbar* scrollbar, const IntPoint& scrollbarPoint) const
140     {
141         return scrollbar->Widget::convertToContainingView(scrollbarPoint);
142     }
143     virtual IntPoint convertFromContainingViewToScrollbar(const Scrollbar* scrollbar, const IntPoint& parentPoint) const
144     {
145         return scrollbar->Widget::convertFromContainingView(parentPoint);
146     }
147
148     virtual Scrollbar* horizontalScrollbar() const { return 0; }
149     virtual Scrollbar* verticalScrollbar() const { return 0; }
150
151     virtual IntPoint scrollPosition() const;
152     virtual IntPoint minimumScrollPosition() const;
153     virtual IntPoint maximumScrollPosition() const;
154
155     enum VisibleContentRectIncludesScrollbars { ExcludeScrollbars, IncludeScrollbars };
156     enum VisibleContentRectBehavior {
157         ContentsVisibleRect,
158 #if PLATFORM(IOS)
159         LegacyIOSDocumentViewRect,
160         LegacyIOSDocumentVisibleRect = LegacyIOSDocumentViewRect
161 #else
162         LegacyIOSDocumentVisibleRect = ContentsVisibleRect
163 #endif
164     };
165
166     IntRect visibleContentRect(VisibleContentRectBehavior = ContentsVisibleRect) const;
167     IntRect visibleContentRectIncludingScrollbars(VisibleContentRectBehavior = ContentsVisibleRect) const;
168
169     int visibleWidth() const { return visibleSize().width(); }
170     int visibleHeight() const { return visibleSize().height(); }
171     virtual IntSize visibleSize() const = 0;
172
173     virtual IntSize contentsSize() const = 0;
174     virtual IntSize overhangAmount() const { return IntSize(); }
175     virtual IntPoint lastKnownMousePosition() const { return IntPoint(); }
176     virtual bool isHandlingWheelEvent() const { return false; }
177
178     virtual int headerHeight() const { return 0; }
179     virtual int footerHeight() const { return 0; }
180
181     // The totalContentsSize() is equivalent to the contentsSize() plus the header and footer heights.
182     IntSize totalContentsSize() const;
183
184     virtual bool shouldSuspendScrollAnimations() const { return true; }
185     virtual void scrollbarStyleChanged(int /*newStyle*/, bool /*forceUpdate*/) { }
186     virtual void setVisibleScrollerThumbRect(const IntRect&) { }
187     
188     // Note that this only returns scrollable areas that can actually be scrolled.
189     virtual ScrollableArea* enclosingScrollableArea() const = 0;
190
191     // Returns the bounding box of this scrollable area, in the coordinate system of the enclosing scroll view.
192     virtual IntRect scrollableAreaBoundingBox() const = 0;
193
194     virtual bool isRubberBandInProgress() const { return false; }
195
196     virtual bool scrollAnimatorEnabled() const { return false; }
197
198     // NOTE: Only called from Internals for testing.
199     void setScrollOffsetFromInternals(const IntPoint&);
200
201     static IntPoint constrainScrollPositionForOverhang(const IntRect& visibleContentRect, const IntSize& totalContentsSize, const IntPoint& scrollPosition, const IntPoint& scrollOrigin, int headerHeight, int footetHeight);
202     IntPoint constrainScrollPositionForOverhang(const IntPoint& scrollPosition);
203
204     // Computes the double value for the scrollbar's current position and the current overhang amount.
205     // This function is static so that it can be called from the main thread or the scrolling thread.
206     static void computeScrollbarValueAndOverhang(float currentPosition, float totalSize, float visibleSize, float& doubleValue, float& overhangAmount);
207
208     // Let subclasses provide a way of asking for and servicing scroll
209     // animations.
210     virtual bool scheduleAnimation() { return false; }
211     void serviceScrollAnimations();
212
213 #if PLATFORM(IOS)
214     bool isHorizontalScrollerPinnedToMinimumPosition() const { return !horizontalScrollbar() || scrollPosition(horizontalScrollbar()) <= minimumScrollPosition().x(); }
215     bool isHorizontalScrollerPinnedToMaximumPosition() const { return !horizontalScrollbar() || scrollPosition(horizontalScrollbar()) >= maximumScrollPosition().x(); }
216     bool isVerticalScrollerPinnedToMinimumPosition() const { return !verticalScrollbar() || scrollPosition(verticalScrollbar()) <= minimumScrollPosition().y(); }
217     bool isVerticalScrollerPinnedToMaximumPosition() const { return !verticalScrollbar() || scrollPosition(verticalScrollbar()) >= maximumScrollPosition().y(); } 
218
219     bool isPinnedInBothDirections(const IntSize&) const; 
220     bool isPinnedHorizontallyInDirection(int horizontalScrollDelta) const; 
221     bool isPinnedVerticallyInDirection(int verticalScrollDelta) const;
222 #endif
223
224 #if USE(ACCELERATED_COMPOSITING)
225     virtual TiledBacking* tiledBacking() const { return 0; }
226     virtual bool usesCompositedScrolling() const { return false; }
227
228     virtual GraphicsLayer* layerForHorizontalScrollbar() const { return 0; }
229     virtual GraphicsLayer* layerForVerticalScrollbar() const { return 0; }
230
231     void verticalScrollbarLayerDidChange();
232     void horizontalScrollbarLayerDidChange();
233 #endif
234
235 protected:
236     ScrollableArea();
237     virtual ~ScrollableArea();
238
239     void setScrollOrigin(const IntPoint&);
240     void resetScrollOriginChanged() { m_scrollOriginChanged = false; }
241
242     virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&) = 0;
243     virtual void invalidateScrollCornerRect(const IntRect&) = 0;
244
245 #if USE(ACCELERATED_COMPOSITING)
246     friend class ScrollingCoordinator;
247     virtual GraphicsLayer* layerForScrolling() const { return 0; }
248     virtual GraphicsLayer* layerForScrollCorner() const { return 0; }
249 #if ENABLE(RUBBER_BANDING)
250     virtual GraphicsLayer* layerForOverhangAreas() const { return 0; }
251 #endif
252 #endif
253     bool hasLayerForHorizontalScrollbar() const;
254     bool hasLayerForVerticalScrollbar() const;
255     bool hasLayerForScrollCorner() const;
256
257     virtual void sendWillRevealEdgeEventsIfNeeded(const IntPoint&, const IntPoint&) { }
258
259 private:
260     virtual IntRect visibleContentRectInternal(VisibleContentRectIncludesScrollbars, VisibleContentRectBehavior) const;
261     void scrollPositionChanged(const IntPoint&);
262     
263     // NOTE: Only called from the ScrollAnimator.
264     friend class ScrollAnimator;
265     void setScrollOffsetFromAnimation(const IntPoint&);
266
267     // This function should be overriden by subclasses to perform the actual
268     // scroll of the content.
269     virtual void setScrollOffset(const IntPoint&) = 0;
270
271     mutable OwnPtr<ScrollAnimator> m_scrollAnimator;
272
273     // There are 8 possible combinations of writing mode and direction. Scroll origin will be non-zero in the x or y axis
274     // if there is any reversed direction or writing-mode. The combinations are:
275     // writing-mode / direction     scrollOrigin.x() set    scrollOrigin.y() set
276     // horizontal-tb / ltr          NO                      NO
277     // horizontal-tb / rtl          YES                     NO
278     // horizontal-bt / ltr          NO                      YES
279     // horizontal-bt / rtl          YES                     YES
280     // vertical-lr / ltr            NO                      NO
281     // vertical-lr / rtl            NO                      YES
282     // vertical-rl / ltr            YES                     NO
283     // vertical-rl / rtl            YES                     YES
284     IntPoint m_scrollOrigin;
285
286     unsigned m_constrainsScrollingToContentEdge : 1;
287
288     unsigned m_inLiveResize : 1;
289
290     unsigned m_verticalScrollElasticity : 2; // ScrollElasticity
291     unsigned m_horizontalScrollElasticity : 2; // ScrollElasticity
292
293     unsigned m_scrollbarOverlayStyle : 2; // ScrollbarOverlayStyle
294
295     unsigned m_scrollOriginChanged : 1;
296 };
297
298 } // namespace WebCore
299
300 #endif // ScrollableArea_h