[BlackBerry] Replace disappearing fillBuffer() API with graphics context drawing
[WebKit-https.git] / Source / WebKit / blackberry / Api / BackingStore_p.h
1 /*
2  * Copyright (C) 2009, 2010, 2011, 2012 Research In Motion Limited. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18
19 #ifndef BackingStore_p_h
20 #define BackingStore_p_h
21
22 #include "BackingStore.h"
23 #include "Color.h"
24 #include "RenderQueue.h"
25 #include "TileIndex.h"
26 #include "TileIndexHash.h"
27 #include "Timer.h"
28 #include <BlackBerryPlatformGraphics.h>
29 #include <BlackBerryPlatformGuardedPointer.h>
30 #include <pthread.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35 class IntRect;
36 class FloatPoint;
37 class FloatRect;
38 class LayerRenderer;
39 class TransformationMatrix;
40 }
41
42 namespace BlackBerry {
43
44 namespace Platform {
45 class ViewportAccessor;
46 }
47
48 namespace WebKit {
49
50 class TileBuffer;
51 class WebPage;
52 class BackingStoreClient;
53
54 typedef WTF::HashMap<TileIndex, TileBuffer*> TileMap;
55
56 class BackingStoreGeometry {
57 public:
58     BackingStoreGeometry()
59         : m_numberOfTilesWide(0)
60         , m_numberOfTilesHigh(0)
61         , m_scale(0.0)
62     {
63     }
64
65     Platform::IntRect backingStoreRect() const;
66     Platform::IntSize backingStoreSize() const;
67
68     int numberOfTilesWide() const { return m_numberOfTilesWide; }
69     void setNumberOfTilesWide(int numberOfTilesWide) { m_numberOfTilesWide = numberOfTilesWide; }
70     int numberOfTilesHigh() const { return m_numberOfTilesHigh; }
71     void setNumberOfTilesHigh(int numberOfTilesHigh) { m_numberOfTilesHigh = numberOfTilesHigh; }
72     Platform::IntPoint backingStoreOffset() const { return m_backingStoreOffset; }
73     void setBackingStoreOffset(const Platform::IntPoint& offset) { m_backingStoreOffset = offset; }
74     Platform::IntPoint originOfTile(const TileIndex&) const;
75     TileBuffer* tileBufferAt(const TileIndex& index) const { return m_tileMap.get(index); }
76     const TileMap& tileMap() const { return m_tileMap; }
77     void setTileMap(const TileMap& tileMap) { m_tileMap = tileMap; }
78
79     double scale() const { return m_scale; }
80     void setScale(double scale) { m_scale = scale; }
81
82     bool isTileCorrespondingToBuffer(TileIndex, TileBuffer*) const;
83
84   private:
85     int m_numberOfTilesWide;
86     int m_numberOfTilesHigh;
87     double m_scale;
88     Platform::IntPoint m_backingStoreOffset;
89     TileMap m_tileMap;
90 };
91
92 class BackingStorePrivate : public BlackBerry::Platform::GuardedPointerBase {
93 public:
94     enum TileMatrixDirection { Horizontal, Vertical };
95     BackingStorePrivate();
96
97     void instrumentBeginFrame();
98     void instrumentCancelFrame();
99
100     // Returns whether we're using the OpenGL code path for compositing the
101     // backing store tiles. This can be due to the main window using
102     // BlackBerry::Platform::Graphics::Window::GLES2Usage.
103     bool isOpenGLCompositing() const;
104
105     // Suspends all backingstore updates so that rendering to the backingstore is disabled.
106     void suspendBackingStoreUpdates();
107
108     // Resumes all backingstore updates so that rendering to the backingstore is enabled.
109     void resumeBackingStoreUpdates();
110
111     // Suspends all backingstore geometry updates.
112     void suspendGeometryUpdates();
113
114     // Resumes all backingstore geometry updates.
115     void resumeGeometryUpdates();
116
117     // Suspends all screen updates so that 'blitVisibleContents' is disabled.
118     void suspendScreenUpdates();
119
120     // Resumes all screen updates so that 'blitVisibleContents' is enabled.
121     void resumeScreenUpdates(BackingStore::ResumeUpdateOperation);
122
123     // Update m_suspendScreenUpdates*Thread based on a number of conditions.
124     void updateSuspendScreenUpdateState(bool* hasSyncedToUserInterfaceThread = 0);
125
126     // The functions repaint(), slowScroll(), scroll(), scrollingStartedHelper() are
127     // called from outside WebKit and within WebKit via ChromeClientBlackBerry.
128     void repaint(const Platform::IntRect& windowRect, bool contentChanged, bool immediate);
129
130     void slowScroll(const Platform::IntSize& delta, const Platform::IntRect& windowRect, bool immediate);
131
132     void scroll(const Platform::IntSize& delta, const Platform::IntRect& scrollViewRect, const Platform::IntRect& clipRect);
133     void scrollingStartedHelper(const Platform::IntSize& delta);
134
135     bool shouldSuppressNonVisibleRegularRenderJobs() const;
136     bool shouldPerformRenderJobs() const;
137     bool shouldPerformRegularRenderJobs() const;
138     void dispatchRenderJob();
139     void renderJob();
140
141     // Set of helper methods for the scrollBackingStore() method.
142     Platform::IntRect contentsRect() const;
143     Platform::IntRect expandedContentsRect() const;
144     Platform::IntRect visibleContentsRect() const;
145     Platform::IntRect unclippedVisibleContentsRect() const;
146     bool shouldMoveLeft(const Platform::IntRect&) const;
147     bool shouldMoveRight(const Platform::IntRect&) const;
148     bool shouldMoveUp(const Platform::IntRect&) const;
149     bool shouldMoveDown(const Platform::IntRect&) const;
150     bool canMoveX(const Platform::IntRect&) const;
151     bool canMoveY(const Platform::IntRect&) const;
152     bool canMoveLeft(const Platform::IntRect&) const;
153     bool canMoveRight(const Platform::IntRect&) const;
154     bool canMoveUp(const Platform::IntRect&) const;
155     bool canMoveDown(const Platform::IntRect&) const;
156
157     Platform::IntRect backingStoreRectForScroll(int deltaX, int deltaY, const Platform::IntRect&) const;
158     void setBackingStoreRect(const Platform::IntRect&, double scale);
159     void updateTilesAfterBackingStoreRectChange();
160
161     TileIndexList indexesForBackingStoreRect(const Platform::IntRect&) const;
162     TileIndexList indexesForVisibleContentsRect(BackingStoreGeometry*) const;
163
164     TileIndex indexOfTile(const Platform::IntPoint& origin, const Platform::IntRect& backingStoreRect) const;
165     void clearAndUpdateTileOfNotRenderedRegion(const TileIndex&, TileBuffer*, const Platform::IntRectRegion&, BackingStoreGeometry*, bool update = true);
166     bool isCurrentVisibleJob(const TileIndex&, BackingStoreGeometry*) const;
167
168     // Not thread safe. Call only when threads are in sync.
169     void clearRenderedRegion(TileBuffer*, const Platform::IntRectRegion&);
170
171     // Responsible for scrolling the backing store and updating the
172     // tile matrix geometry.
173     void scrollBackingStore(int deltaX, int deltaY);
174
175     // Render the given tiles if enough back buffers are available.
176     // Return the actual set of rendered tiles.
177     // NOTE: This should only be called by RenderQueue and resumeScreenUpdates().
178     //   If you want to render to get contents to the screen, you should call
179     //   renderAndBlitImmediately() or renderAndBlitVisibleContentsImmediately().
180     TileIndexList render(const TileIndexList&);
181
182     // Called by the render queue to ensure that the queue is in a
183     // constant state before performing a render job.
184     void requestLayoutIfNeeded() const;
185
186     // Helper render methods.
187     void renderAndBlitVisibleContentsImmediately();
188     void renderAndBlitImmediately(const Platform::IntRect&);
189     void blitVisibleContents(bool force = false);
190     void blitOnIdle();
191
192     Platform::IntRect blitTileRect(TileBuffer*, const Platform::IntRect&, const Platform::IntPoint&, const WebCore::TransformationMatrix&, BackingStoreGeometry*);
193
194 #if USE(ACCELERATED_COMPOSITING)
195     // Use instead of blitVisibleContents() if you need more control over
196     // OpenGL state. Note that contents is expressed in untransformed
197     // content coordinates.
198     // Preconditions: You have to call prepareFrame and setViewport on the LayerRenderer before
199     //                calling this.
200     void compositeContents(WebCore::LayerRenderer*, const WebCore::TransformationMatrix&, const WebCore::FloatRect& contents, bool contentsOpaque);
201
202     bool drawLayersOnCommitIfNeeded();
203     // WebPage will call this when drawing layers to tell us we don't need to
204     void willDrawLayersOnCommit() { m_needsDrawLayersOnCommit = false; }
205 #endif
206
207     void blitHorizontalScrollbar();
208     void blitVerticalScrollbar();
209
210     // Returns whether the tile index is currently visible or not.
211     bool isTileVisible(const TileIndex&, BackingStoreGeometry*) const;
212     bool isTileVisible(const Platform::IntPoint&) const;
213
214     // Returns a rect that is the union of all tiles that are visible.
215     TileIndexList visibleTileIndexes(BackingStoreGeometry*) const;
216
217     // Used to clip to the visible content for instance.
218     Platform::IntRect tileVisibleContentsRect(const TileIndex&, BackingStoreGeometry*) const;
219
220     // Used to clip to the contents for instance.
221     Platform::IntRect tileContentsRect(const TileIndex&, const Platform::IntRect&, BackingStoreGeometry*) const;
222
223     // This is called by WebPage once load is committed to reset the render queue.
224     void resetRenderQueue();
225
226     // This is called by WebPage once load is committed to reset all the tiles.
227     void resetTiles();
228
229     // This is called by WebPage after load is complete to update all the tiles.
230     void updateTiles(bool updateVisible, bool immediate);
231
232     // This is called during scroll and by the render queue.
233     void updateTilesForScrollOrNotRenderedRegion(bool checkLoading = true);
234
235     // Update an individual tile.
236     void updateTile(const Platform::IntPoint& tileOrigin, bool immediate);
237
238     typedef std::pair<TileIndex, Platform::IntRect> TileRect;
239     typedef WTF::Vector<TileRect> TileRectList;
240     TileRectList mapFromPixelContentsToTiles(const Platform::IntRect&, BackingStoreGeometry*) const;
241
242     void setTileMatrixNeedsUpdate() { m_tileMatrixNeedsUpdate = true; }
243     void updateTileMatrixIfNeeded();
244
245     // Called by WebPagePrivate::notifyTransformedContentsSizeChanged.
246     void contentsSizeChanged(const Platform::IntSize&);
247
248     // Called by WebPagePrivate::notifyTransformedScrollChanged.
249     void scrollChanged(const Platform::IntPoint&);
250
251     // Called by WebpagePrivate::notifyTransformChanged.
252     void transformChanged();
253
254     // Called by WebpagePrivate::actualVisibleSizeChanged.
255     void actualVisibleSizeChanged(const Platform::IntSize&);
256
257     // Called by WebPagePrivate::setScreenRotated.
258     void orientationChanged();
259
260     // Sets the geometry of the tile matrix.
261     void setGeometryOfTileMatrix(int numberOfTilesWide, int numberOfTilesHigh);
262
263     // Create the surfaces of the backing store.
264     void createSurfaces();
265
266     // Various calculations of quantities relevant to backing store.
267     int minimumNumberOfTilesWide() const;
268     int minimumNumberOfTilesHigh() const;
269     Platform::IntSize expandedContentsSize() const;
270
271     // The tile geometry methods are all static function.
272     static int tileWidth();
273     static int tileHeight();
274     static Platform::IntSize tileSize();
275
276     // This takes transformed contents coordinates.
277     enum LayersToRender { RenderRootLayer, RenderAllLayers };
278     bool renderContents(BlackBerry::Platform::Graphics::Buffer*, const BlackBerry::Platform::IntRect& dstRect, double scale, const BlackBerry::Platform::FloatPoint& documentScrollPosition, LayersToRender) const;
279
280     void blitToWindow(const Platform::IntRect& dstRect, const BlackBerry::Platform::Graphics::Buffer* srcBuffer, const Platform::IntRect& srcRect, BlackBerry::Platform::Graphics::BlendMode, unsigned char globalAlpha);
281
282     WebCore::Color webPageBackgroundColorUserInterfaceThread() const; // use WebSettings::backgroundColor() for the WebKit thread
283     void setWebPageBackgroundColor(const WebCore::Color&);
284
285     bool isScrollingOrZooming() const;
286     void setScrollingOrZooming(bool scrollingOrZooming, bool shouldBlit = true);
287
288     BackingStoreGeometry* frontState() const;
289     void adoptAsFrontState(BackingStoreGeometry* newFrontState);
290
291     static void setCurrentBackingStoreOwner(WebPage*);
292     static WebPage* currentBackingStoreOwner() { return BackingStorePrivate::s_currentBackingStoreOwner; }
293     bool isActive() const;
294
295     // Surface abstraction, maybe BlackBerry::Platform::Graphics::Buffer could be made public instead.
296     BlackBerry::Platform::IntSize surfaceSize() const;
297     BlackBerry::Platform::Graphics::Buffer* buffer() const;
298
299     void didRenderContent(const Platform::IntRectRegion& renderedRegion);
300
301     static WebPage* s_currentBackingStoreOwner;
302
303     unsigned m_suspendScreenUpdateCounterWebKitThread;
304     unsigned m_suspendBackingStoreUpdates;
305     unsigned m_suspendGeometryUpdates;
306     BackingStore::ResumeUpdateOperation m_resumeOperation;
307
308     bool m_suspendScreenUpdatesWebKitThread;
309     bool m_suspendScreenUpdatesUserInterfaceThread;
310     bool m_suspendRenderJobs;
311     bool m_suspendRegularRenderJobs;
312     bool m_tileMatrixContainsUsefulContent;
313     bool m_tileMatrixNeedsUpdate;
314     bool m_isScrollingOrZooming;
315     WebPage* m_webPage;
316     BackingStoreClient* m_client;
317     OwnPtr<RenderQueue> m_renderQueue;
318     mutable Platform::IntSize m_previousDelta;
319
320     bool m_hasBlitJobs;
321
322     WebCore::Color m_webPageBackgroundColor; // for user interface thread operations such as blitting
323
324     mutable unsigned m_frontState;
325
326     TileMatrixDirection m_preferredTileMatrixDimension;
327
328     Platform::IntRect m_visibleTileBufferRect;
329
330 #if USE(ACCELERATED_COMPOSITING)
331     mutable bool m_needsDrawLayersOnCommit; // Not thread safe, WebKit thread only
332 #endif
333
334 protected:
335     virtual ~BackingStorePrivate();
336 };
337 } // namespace WebKit
338 } // namespace BlackBerry
339
340 #endif // BackingStore_p_h