Remove PLATFORM(IOS) from WebCore/editing (Part 3).
[WebKit.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 "WAKViewPrivate.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         return IntRect(IntPoint(m_scrollOffset), roundedIntSize(m_unobscuredContentSize));
112
113     return unobscuredContentRectInternal();
114 }
115
116 void ScrollView::setUnobscuredContentSize(const FloatSize& size)
117 {
118     ASSERT(!platformWidget());
119     m_unobscuredContentSize = size;
120 }
121
122 FloatRect ScrollView::exposedContentRect() const
123 {
124     if (NSScrollView *view = static_cast<NSScrollView *>(platformWidget())) {
125         CGRect r = CGRectZero;
126         BEGIN_BLOCK_OBJC_EXCEPTIONS;
127         if ([view isKindOfClass:[NSScrollView class]])
128             r = [view exposedContentRect];
129         else {
130             r.origin = [view visibleRect].origin;
131             r.size = [view bounds].size;
132         }
133
134         END_BLOCK_OBJC_EXCEPTIONS;
135         return r;
136     }
137
138     const ScrollView* parent = this->parent();
139     if (!parent)
140         return m_exposedContentRect;
141
142     IntRect parentViewExtentContentRect = enclosingIntRect(parent->exposedContentRect());
143     IntRect selfExtentContentRect = rootViewToContents(parentViewExtentContentRect);
144     selfExtentContentRect.intersect(boundsRect());
145     return selfExtentContentRect;
146 }
147
148 void ScrollView::setExposedContentRect(const FloatRect& rect)
149 {
150     ASSERT(!platformWidget());
151     m_exposedContentRect = rect;
152 }
153
154 void ScrollView::setActualScrollPosition(const IntPoint& position)
155 {
156     NSScrollView *view = static_cast<NSScrollView *>(platformWidget());
157
158     BEGIN_BLOCK_OBJC_EXCEPTIONS;
159     if ([view isKindOfClass:[NSScrollView class]])
160         [view setActualScrollPosition:position];
161     END_BLOCK_OBJC_EXCEPTIONS;
162 }
163
164 float ScrollView::platformTopContentInset() const
165 {
166     return 0;
167 }
168
169 void ScrollView::platformSetTopContentInset(float)
170 {
171 }
172
173 IntRect ScrollView::platformVisibleContentRect(bool includeScrollbars) const
174 {
175     BEGIN_BLOCK_OBJC_EXCEPTIONS;
176     if (includeScrollbars) {
177         if (NSView* documentView = this->documentView())
178             return enclosingIntRect([documentView visibleRect]);
179     }
180     return enclosingIntRect([scrollView() documentVisibleRect]);
181     END_BLOCK_OBJC_EXCEPTIONS;
182     return IntRect();
183 }
184
185 IntSize ScrollView::platformVisibleContentSize(bool includeScrollbars) const
186 {
187     BEGIN_BLOCK_OBJC_EXCEPTIONS;
188     if (includeScrollbars) {
189         if (NSView* documentView = this->documentView())
190             return IntSize([documentView visibleRect].size);
191     }
192
193     return expandedIntSize(FloatSize([scrollView() documentVisibleRect].size));
194     END_BLOCK_OBJC_EXCEPTIONS;
195     return IntSize();
196 }
197
198 IntRect ScrollView::platformVisibleContentRectIncludingObscuredArea(bool includeScrollbars) const
199 {
200     return platformVisibleContentRect(includeScrollbars);
201 }
202
203 IntSize ScrollView::platformVisibleContentSizeIncludingObscuredArea(bool includeScrollbars) const
204 {
205     return platformVisibleContentSize(includeScrollbars);
206 }
207
208 LegacyTileCache* ScrollView::legacyTileCache()
209 {
210     // Make tile cache pointer available via the main frame only. Tile cache interaction should be managed by
211     // the main frame and this avoids having to add parent checks to all call sites.
212     if (parent())
213         return 0;
214     BEGIN_BLOCK_OBJC_EXCEPTIONS;
215     WAKScrollView *view = static_cast<WAKScrollView *>(platformWidget());
216     return [[view window] tileCache];
217     END_BLOCK_OBJC_EXCEPTIONS;
218 }
219
220 void ScrollView::platformSetContentsSize()
221 {
222     BEGIN_BLOCK_OBJC_EXCEPTIONS;
223     int w = m_contentsSize.width();
224     int h = m_contentsSize.height();
225 #if !PLATFORM(IOS)
226     LOG(Frames, "%p %@ at w %d h %d\n", documentView(), [(id)[documentView() class] className], w, h);            
227 #else
228     LOG(Frames, "%p %@ at w %d h %d\n", documentView(), NSStringFromClass([documentView() class]), w, h);
229 #endif
230     NSSize tempSize = { static_cast<CGFloat>(max(0, w)), static_cast<CGFloat>(max(0, h)) }; // workaround for 4213314
231     [documentView() setBoundsSize:tempSize];
232     END_BLOCK_OBJC_EXCEPTIONS;
233 }
234
235 void ScrollView::platformSetScrollbarsSuppressed(bool repaintOnUnsuppress)
236 {
237     BEGIN_BLOCK_OBJC_EXCEPTIONS;
238     [scrollView() setScrollBarsSuppressed:m_scrollbarsSuppressed
239                       repaintOnUnsuppress:repaintOnUnsuppress];
240     END_BLOCK_OBJC_EXCEPTIONS;
241 }
242
243 void ScrollView::platformSetScrollPosition(const IntPoint& scrollPoint)
244 {
245     BEGIN_BLOCK_OBJC_EXCEPTIONS;
246     [documentView() scrollPoint:NSMakePoint(fmax(-[scrollView() scrollOrigin].x(), scrollPoint.x()), fmax(-[scrollView() scrollOrigin].y(), scrollPoint.y()))];
247     END_BLOCK_OBJC_EXCEPTIONS;
248 }
249
250 bool ScrollView::platformScroll(ScrollDirection, ScrollGranularity)
251 {
252     // FIXME: It would be nice to implement this so that all of the code in WebFrameView could go away.
253     notImplemented();
254     return false;
255 }
256
257 void ScrollView::platformRepaintContentRectangle(const IntRect& rect)
258 {
259     BEGIN_BLOCK_OBJC_EXCEPTIONS;
260
261     NSView *view = documentView();
262
263     [view setNeedsDisplayInRect:rect];    
264
265     END_BLOCK_OBJC_EXCEPTIONS;
266 }
267
268 // "Containing Window" means the NSWindow's coord system, which is origin lower left
269
270 IntRect ScrollView::platformContentsToScreen(const IntRect& rect) const
271 {
272     BEGIN_BLOCK_OBJC_EXCEPTIONS;
273     if (NSView* documentView = this->documentView()) {
274         NSRect tempRect = rect;
275         tempRect = [documentView convertRect:tempRect toView:nil];
276         tempRect.origin = [[documentView window] convertBaseToScreen:tempRect.origin];
277         return enclosingIntRect(tempRect);
278     }
279     END_BLOCK_OBJC_EXCEPTIONS;
280     return IntRect();
281 }
282
283 IntPoint ScrollView::platformScreenToContents(const IntPoint& point) const
284 {
285     BEGIN_BLOCK_OBJC_EXCEPTIONS;
286     if (NSView* documentView = this->documentView()) {
287         NSPoint windowCoord = [[documentView window] convertScreenToBase: point];
288         return IntPoint([documentView convertPoint:windowCoord fromView:nil]);
289     }
290     END_BLOCK_OBJC_EXCEPTIONS;
291     return IntPoint();
292 }
293
294 bool ScrollView::platformIsOffscreen() const
295 {
296     // FIXME: DDK: ScrollViewMac.mm also checks: ![[platformWidget() window] isVisible]
297     // but -[WAKWindow isVisible] doesn't exist.
298     return ![platformWidget() window];
299 }
300
301 void ScrollView::platformSetScrollbarOverlayStyle(ScrollbarOverlayStyle)
302 {
303 }
304
305 void ScrollView::platformSetScrollOrigin(const IntPoint& origin, bool updatePositionAll, bool updatePositionSynchronously)
306 {
307     BEGIN_BLOCK_OBJC_EXCEPTIONS;
308     [scrollView() setScrollOrigin:static_cast<CGPoint>(origin) updatePositionAtAll:updatePositionAll immediately:updatePositionSynchronously];
309     END_BLOCK_OBJC_EXCEPTIONS;
310 }
311
312 }