iBooks: text can disappear/flash during finger drag highlight
[WebKit-https.git] / Source / WebCore / platform / ios / LegacyTileLayer.mm
1 /*
2  * Copyright (C) 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "LegacyTileLayer.h"
28
29 #if PLATFORM(IOS)
30
31 #include "LegacyTileCache.h"
32 #include "LegacyTileGrid.h"
33 #include "WebCoreThread.h"
34 #include <wtf/SetForScope.h>
35
36 using WebCore::LegacyTileCache;
37 @implementation LegacyTileHostLayer
38
39 - (id)initWithTileGrid:(WebCore::LegacyTileGrid*)tileGrid
40 {
41     self = [super init];
42     if (!self)
43         return nil;
44     _tileGrid = tileGrid;
45     [self setAnchorPoint:CGPointZero];
46     return self;
47 }
48
49 - (id<CAAction>)actionForKey:(NSString *)key
50 {
51     UNUSED_PARAM(key);
52     // Disable all default actions
53     return nil;
54 }
55
56 - (void)renderInContext:(CGContextRef)context
57 {
58     if (pthread_main_np())
59         WebThreadLock();
60
61     CGRect dirtyRect = CGContextGetClipBoundingBox(context);
62     auto useExistingTiles = _tileGrid->tileCache().setOverrideVisibleRect(WebCore::FloatRect(dirtyRect));
63     if (!useExistingTiles)
64         _tileGrid->tileCache().doLayoutTiles();
65
66     [super renderInContext:context];
67
68     _tileGrid->tileCache().clearOverrideVisibleRect();
69     if (!useExistingTiles)
70         _tileGrid->tileCache().doLayoutTiles();
71 }
72 @end
73
74 @implementation LegacyTileLayer
75 @synthesize paintCount = _paintCount;
76 @synthesize tileGrid = _tileGrid;
77 @synthesize isRenderingInContext = _isRenderingInContext;
78
79 - (void)setNeedsDisplayInRect:(CGRect)rect
80 {
81     // We need to do WebKit layout before painting. Layout may generate new repaint rects and
82     // invalidate more tiles, something that is not allowed in drawInContext.
83     // Calling setNeedsLayout ensures that layoutSublayers will get called before drawInContext and
84     // we do WebKit layout there.
85     [self setNeedsLayout];
86     [super setNeedsDisplayInRect:rect];
87 }
88
89 - (void)layoutSublayers
90 {
91     if (pthread_main_np())
92         WebThreadLock();
93     // This may trigger WebKit layout and generate more repaint rects.
94     if (_tileGrid)
95         _tileGrid->tileCache().prepareToDraw();
96 }
97
98 - (void)renderInContext:(CGContextRef)context
99 {
100     SetForScope<BOOL> change(_isRenderingInContext, YES);
101     [super renderInContext:context];
102 }
103
104 - (void)drawInContext:(CGContextRef)context
105 {
106     // Bugs in clients or other frameworks may cause tile invalidation from within a CA commit.
107     // In that case we maybe left with dirty tiles that have display still pending. Some future
108     // commit will flush such tiles and they will get painted without holding the web lock.
109     // rdar://problem/21149759
110     // Still assert as the condition is not normal and may cause graphical glitches.
111     ASSERT(WebThreadIsLockedOrDisabled());
112     if (pthread_main_np())
113         WebThreadLock();
114
115     if (_tileGrid)
116         _tileGrid->tileCache().drawLayer(self, context, self.isRenderingInContext ? LegacyTileCache::DrawingFlags::Snapshotting : LegacyTileCache::DrawingFlags::None);
117 }
118
119 - (id<CAAction>)actionForKey:(NSString *)key
120 {
121     UNUSED_PARAM(key);
122     // Disable all default actions
123     return nil;
124 }
125
126 @end
127
128 #endif // PLATFORM(IOS)