fee231707b18dae82e51ea17ac7809a86a47f6a9
[WebKit-https.git] / Source / WebKit2 / UIProcess / DrawingAreaProxy.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  * Portions Copyright (c) 2010 Motorola Mobility, Inc.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef DrawingAreaProxy_h
28 #define DrawingAreaProxy_h
29
30 #include "BackingStore.h"
31 #include "DrawingAreaInfo.h"
32 #include "MessageReceiver.h"
33 #include <WebCore/FloatPoint.h>
34 #include <WebCore/IntRect.h>
35 #include <WebCore/IntSize.h>
36 #include <stdint.h>
37 #include <wtf/Noncopyable.h>
38
39 namespace WebKit {
40
41 class LayerTreeContext;
42 class CoordinatedLayerTreeHostProxy;
43 class UpdateInfo;
44 class WebPageProxy;
45
46 class DrawingAreaProxy : public CoreIPC::MessageReceiver {
47     WTF_MAKE_NONCOPYABLE(DrawingAreaProxy);
48
49 public:
50     virtual ~DrawingAreaProxy();
51
52     DrawingAreaType type() const { return m_type; }
53
54     virtual void deviceScaleFactorDidChange() = 0;
55
56     // FIXME: These should be pure virtual.
57     virtual void visibilityDidChange() { }
58     virtual void layerHostingModeDidChange() { }
59
60     virtual void setBackingStoreIsDiscardable(bool) { }
61
62     virtual void waitForBackingStoreUpdateOnNextPaint() { }
63
64     const WebCore::IntSize& size() const { return m_size; }
65     void setSize(const WebCore::IntSize&, const WebCore::IntSize&, const WebCore::IntSize& scrollOffset);
66
67     // The timeout, in seconds, we use when waiting for a DidUpdateGeometry message.
68     static const double didUpdateBackingStoreStateTimeout;
69
70     virtual void pageCustomRepresentationChanged() { }
71     virtual void waitForPossibleGeometryUpdate(double = didUpdateBackingStoreStateTimeout) { }
72
73     virtual void colorSpaceDidChange() { }
74     virtual void minimumLayoutWidthDidChange() { }
75
76 #if USE(COORDINATED_GRAPHICS)
77     virtual void updateViewport();
78     virtual WebCore::IntRect viewportVisibleRect() const { return contentsRect(); }
79     virtual WebCore::IntRect contentsRect() const;
80     CoordinatedLayerTreeHostProxy* coordinatedLayerTreeHostProxy() const { return m_coordinatedLayerTreeHostProxy.get(); }
81     virtual void setVisibleContentsRect(const WebCore::FloatRect& /* visibleContentsRect */, const WebCore::FloatPoint& /* trajectoryVector */) { }
82
83     WebPageProxy* page() { return m_webPageProxy; }
84 #endif
85 protected:
86     explicit DrawingAreaProxy(DrawingAreaType, WebPageProxy*);
87
88     DrawingAreaType m_type;
89     WebPageProxy* m_webPageProxy;
90
91     WebCore::IntSize m_size;
92     WebCore::IntSize m_layerPosition;
93     WebCore::IntSize m_scrollOffset;
94
95 #if USE(COORDINATED_GRAPHICS)
96     OwnPtr<CoordinatedLayerTreeHostProxy> m_coordinatedLayerTreeHostProxy;
97 #endif
98
99 private:
100     virtual void sizeDidChange() = 0;
101
102     // CoreIPC::MessageReceiver
103     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&) OVERRIDE;
104
105     // CoreIPC message handlers.
106     // FIXME: These should be pure virtual.
107     virtual void update(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
108     virtual void didUpdateBackingStoreState(uint64_t /* backingStoreStateID */, const UpdateInfo&, const LayerTreeContext&) { }
109 #if USE(ACCELERATED_COMPOSITING)
110     virtual void enterAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
111     virtual void exitAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const UpdateInfo&) { }
112     virtual void updateAcceleratedCompositingMode(uint64_t /* backingStoreStateID */, const LayerTreeContext&) { }
113 #endif
114 #if PLATFORM(MAC)
115     virtual void didUpdateGeometry(const WebCore::IntSize& newIntrinsicContentSize) { }
116     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& newIntrinsicContentSize) { }
117 #endif
118 };
119
120 } // namespace WebKit
121
122 #endif // DrawingAreaProxy_h