Change ScrollView::scrollTo() to take a ScrollPosition
[WebKit-https.git] / Source / WebCore / platform / ios / ScrollViewIOS.mm
1 /*
2  * Copyright (C) 2004, 2006, 2007, 2008 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 #import "config.h"
27 #import "ScrollView.h"
28
29 #import "BlockExceptions.h"
30 #import "FloatRect.h"
31 #import "IntRect.h"
32 #import "Logging.h"
33 #import "NotImplemented.h"
34 #import "WAKAppKitStubs.h"
35 #import "WAKClipView.h"
36 #import "WAKScrollView.h"
37 #import "WAKViewInternal.h"
38 #import "WAKWindow.h"
39 #import "WKViewPrivate.h"
40 #import "WebCoreFrameView.h"
41 #import <wtf/CurrentTime.h>
42
43 using namespace std;
44
45 namespace WebCore {
46
47 inline NSScrollView<WebCoreFrameScrollView> *ScrollView::scrollView() const
48 {
49     ASSERT(!platformWidget() || [platformWidget() isKindOfClass:[NSScrollView class]]);
50     ASSERT(!platformWidget() || [platformWidget() conformsToProtocol:@protocol(WebCoreFrameScrollView)]);
51     return static_cast<NSScrollView<WebCoreFrameScrollView> *>(platformWidget());
52 }
53
54 NSView *ScrollView::documentView() const
55 {
56     BEGIN_BLOCK_OBJC_EXCEPTIONS;
57     return [scrollView() documentView];
58     END_BLOCK_OBJC_EXCEPTIONS;
59     return nil;
60 }
61
62 void ScrollView::platformAddChild(Widget* child)
63 {
64     ASSERT(child != this);
65
66     child->addToSuperview(documentView());
67 }
68
69 void ScrollView::platformRemoveChild(Widget* child)
70 {
71     child->removeFromSuperview();
72 }
73
74 void ScrollView::platformSetScrollbarModes()
75 {
76     BEGIN_BLOCK_OBJC_EXCEPTIONS;
77     [scrollView() setScrollingModes:m_horizontalScrollbarMode vertical:m_verticalScrollbarMode andLock:NO];
78     END_BLOCK_OBJC_EXCEPTIONS;
79 }
80
81 void ScrollView::platformScrollbarModes(ScrollbarMode& horizontal, ScrollbarMode& vertical) const
82 {
83     BEGIN_BLOCK_OBJC_EXCEPTIONS;
84     [scrollView() scrollingModes:&horizontal vertical:&vertical];
85     END_BLOCK_OBJC_EXCEPTIONS;
86 }
87
88 void ScrollView::platformSetCanBlitOnScroll(bool canBlitOnScroll)
89 {
90     BEGIN_BLOCK_OBJC_EXCEPTIONS;
91     [[scrollView() contentView] setCopiesOnScroll:canBlitOnScroll];
92     END_BLOCK_OBJC_EXCEPTIONS;
93 }
94
95 bool ScrollView::platformCanBlitOnScroll() const
96 {
97     return [[scrollView() contentView] copiesOnScroll];
98 }
99
100 IntRect ScrollView::unobscuredContentRect(VisibleContentRectIncludesScrollbars) const
101 {
102     if (WAKScrollView *view = static_cast<WAKScrollView *>(platformWidget())) {
103         CGRect r = CGRectZero;
104         BEGIN_BLOCK_OBJC_EXCEPTIONS;
105         r = [view unobscuredContentRect];
106         END_BLOCK_OBJC_EXCEPTIONS;
107         return enclosingIntRect(r);
108     }
109
110     if (!m_unobscuredContentSize.isEmpty()) {
111         // FIXME: This seems wrong but gives the right answer, probably because m_scrollPosition is wrong.
112         return IntRect(m_scrollPosition + scrollOrigin(), roundedIntSize(m_unobscuredContentSize));
113     }
114
115     return unobscuredContentRectInternal();
116 }
117
118 void ScrollView::setUnobscuredContentSize(const FloatSize& size)
119 {
120     ASSERT(!platformWidget());
121     m_unobscuredContentSize = size;
122 }
123
124 FloatRect ScrollView::exposedContentRect() const
125 {
126     if (NSScrollView *view = static_cast<NSScrollView *>(platformWidget())) {
127         CGRect r = CGRectZero;
128         BEGIN_BLOCK_OBJC_EXCEPTIONS;
129         if ([view isKindOfClass:[NSScrollView class]])
130             r = [view exposedContentRect];
131         else {
132             r.origin = [view visibleRect].origin;
133             r.size = [view bounds].size;
134         }
135
136         END_BLOCK_OBJC_EXCEPTIONS;
137         return r;
138     }
139
140     const ScrollView* parent = this->parent();
141     if (!parent)
142         return m_exposedContentRect;
143
144     IntRect parentViewExtentContentRect = enclosingIntRect(parent->exposedContentRect());
145     IntRect selfExtentContentRect = rootViewToContents(parentViewExtentContentRect);
146     selfExtentContentRect.intersect(boundsRect());
147     return selfExtentContentRect;
148 }
149
150 void ScrollView::setExposedContentRect(const FloatRect& rect)
151 {
152     ASSERT(!platformWidget());
153     m_exposedContentRect = rect;
154 }
155
156 void ScrollView::setActualScrollPosition(const IntPoint& position)
157 {
158     NSScrollView *view = static_cast<NSScrollView *>(platformWidget());
159
160     BEGIN_BLOCK_OBJC_EXCEPTIONS;
161     if ([view isKindOfClass:[NSScrollView class]])
162         [view setActualScrollPosition:position];
163     END_BLOCK_OBJC_EXCEPTIONS;
164 }
165
166 float ScrollView::platformTopContentInset() const
167 {
168     return 0;
169 }
170
171 void ScrollView::platformSetTopContentInset(float)
172 {
173 }
174
175 IntRect ScrollView::platformVisibleContentRect(bool includeScrollbars) const
176 {
177     BEGIN_BLOCK_OBJC_EXCEPTIONS;
178     if (includeScrollbars) {
179         if (NSView* documentView = this->documentView())
180             return enclosingIntRect([documentView visibleRect]);
181     }
182     return enclosingIntRect([scrollView() documentVisibleRect]);
183     END_BLOCK_OBJC_EXCEPTIONS;
184     return IntRect();
185 }
186
187 IntSize ScrollView::platformVisibleContentSize(bool includeScrollbars) const
188 {
189     BEGIN_BLOCK_OBJC_EXCEPTIONS;
190     if (includeScrollbars) {
191         if (NSView* documentView = this->documentView())
192             return IntSize([documentView visibleRect].size);
193     }
194
195     return expandedIntSize(FloatSize([scrollView() documentVisibleRect].size));
196     END_BLOCK_OBJC_EXCEPTIONS;
197     return IntSize();
198 }
199
200 IntRect ScrollView::platformVisibleContentRectIncludingObscuredArea(bool includeScrollbars) const
201 {
202     return platformVisibleContentRect(includeScrollbars);
203 }
204
205 IntSize ScrollView::platformVisibleContentSizeIncludingObscuredArea(bool includeScrollbars) const
206 {
207     return platformVisibleContentSize(includeScrollbars);
208 }
209
210 LegacyTileCache* ScrollView::legacyTileCache()
211 {
212     // Make tile cache pointer available via the main frame only. Tile cache interaction should be managed by
213     // the main frame and this avoids having to add parent checks to all call sites.
214     if (parent())
215         return 0;
216     BEGIN_BLOCK_OBJC_EXCEPTIONS;
217     WAKScrollView *view = static_cast<WAKScrollView *>(platformWidget());
218     return [[view window] tileCache];
219     END_BLOCK_OBJC_EXCEPTIONS;
220 }
221
222 void ScrollView::platformSetContentsSize()
223 {
224     BEGIN_BLOCK_OBJC_EXCEPTIONS;
225     int w = m_contentsSize.width();
226     int h = m_contentsSize.height();
227 #if !PLATFORM(IOS)
228     LOG(Frames, "%p %@ at w %d h %d\n", documentView(), [(id)[documentView() class] className], w, h);            
229 #else
230     LOG(Frames, "%p %@ at w %d h %d\n", documentView(), NSStringFromClass([documentView() class]), w, h);
231 #endif
232     NSSize tempSize = { static_cast<CGFloat>(max(0, w)), static_cast<CGFloat>(max(0, h)) }; // workaround for 4213314
233     [documentView() setBoundsSize:tempSize];
234     END_BLOCK_OBJC_EXCEPTIONS;
235 }
236
237 void ScrollView::platformSetScrollbarsSuppressed(bool repaintOnUnsuppress)
238 {
239     BEGIN_BLOCK_OBJC_EXCEPTIONS;
240     [scrollView() setScrollBarsSuppressed:m_scrollbarsSuppressed
241                       repaintOnUnsuppress:repaintOnUnsuppress];
242     END_BLOCK_OBJC_EXCEPTIONS;
243 }
244
245 void ScrollView::platformSetScrollPosition(const IntPoint& scrollPoint)
246 {
247     BEGIN_BLOCK_OBJC_EXCEPTIONS;
248     NSPoint floatPoint = scrollPoint;
249     NSPoint tempPoint = { max(-[scrollView() scrollOrigin].x, floatPoint.x), max(-[scrollView() scrollOrigin].y, floatPoint.y) };  // Don't use NSMakePoint to work around 4213314.
250     [documentView() scrollPoint:tempPoint];
251     END_BLOCK_OBJC_EXCEPTIONS;
252 }
253
254 bool ScrollView::platformScroll(ScrollDirection, ScrollGranularity)
255 {
256     // FIXME: It would be nice to implement this so that all of the code in WebFrameView could go away.
257     notImplemented();
258     return false;
259 }
260
261 void ScrollView::platformRepaintContentRectangle(const IntRect& rect)
262 {
263     BEGIN_BLOCK_OBJC_EXCEPTIONS;
264
265     NSView *view = documentView();
266
267     [view setNeedsDisplayInRect:rect];    
268
269     END_BLOCK_OBJC_EXCEPTIONS;
270 }
271
272 // "Containing Window" means the NSWindow's coord system, which is origin lower left
273
274 IntRect ScrollView::platformContentsToScreen(const IntRect& rect) const
275 {
276     BEGIN_BLOCK_OBJC_EXCEPTIONS;
277     if (NSView* documentView = this->documentView()) {
278         NSRect tempRect = rect;
279         tempRect = [documentView convertRect:tempRect toView:nil];
280         tempRect.origin = [[documentView window] convertBaseToScreen:tempRect.origin];
281         return enclosingIntRect(tempRect);
282     }
283     END_BLOCK_OBJC_EXCEPTIONS;
284     return IntRect();
285 }
286
287 IntPoint ScrollView::platformScreenToContents(const IntPoint& point) const
288 {
289     BEGIN_BLOCK_OBJC_EXCEPTIONS;
290     if (NSView* documentView = this->documentView()) {
291         NSPoint windowCoord = [[documentView window] convertScreenToBase: point];
292         return IntPoint([documentView convertPoint:windowCoord fromView:nil]);
293     }
294     END_BLOCK_OBJC_EXCEPTIONS;
295     return IntPoint();
296 }
297
298 bool ScrollView::platformIsOffscreen() const
299 {
300     // FIXME: DDK: ScrollViewMac.mm also checks: ![[platformWidget() window] isVisible]
301     // but -[WAKWindow isVisible] doesn't exist.
302     return ![platformWidget() window];
303 }
304
305 void ScrollView::platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle)
306 {
307 }
308
309 void ScrollView::platformSetScrollOrigin(const IntPoint& origin, bool updatePositionAll, bool updatePositionSynchronously)
310 {
311     BEGIN_BLOCK_OBJC_EXCEPTIONS;
312     [scrollView() setScrollOrigin:static_cast<CGPoint>(origin) updatePositionAtAll:updatePositionAll immediately:updatePositionSynchronously];
313     END_BLOCK_OBJC_EXCEPTIONS;
314 }
315
316 }