CachedFrame construction should begin with a Frame&.
[WebKit-https.git] / Source / WebCore / history / CachedFrame.h
1 /*
2  * Copyright (C) 2009, 2010, 2013 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 COMPUTER, 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 COMPUTER, 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 #ifndef CachedFrame_h
27 #define CachedFrame_h
28
29 #include "DOMWindow.h"
30 #include "KURL.h"
31 #include "ScriptCachedFrameData.h"
32 #include <wtf/PassOwnPtr.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37 class CachedFrame;
38 class CachedFramePlatformData;
39 class Document;
40 class DocumentLoader;
41 class FrameView;
42 class Node;
43
44 class CachedFrameBase {
45 public:
46     void restore();
47
48     Document* document() const { return m_document.get(); }
49     FrameView* view() const { return m_view.get(); }
50     const KURL& url() const { return m_url; }
51     bool isMainFrame() { return m_isMainFrame; }
52
53 protected:
54     CachedFrameBase(Frame&);
55     ~CachedFrameBase();
56     
57     RefPtr<Document> m_document;
58     RefPtr<DocumentLoader> m_documentLoader;
59     RefPtr<FrameView> m_view;
60     RefPtr<Node> m_mousePressNode;
61     KURL m_url;
62     OwnPtr<ScriptCachedFrameData> m_cachedFrameScriptData;
63     OwnPtr<CachedFramePlatformData> m_cachedFramePlatformData;
64     bool m_isMainFrame;
65 #if USE(ACCELERATED_COMPOSITING)
66     bool m_isComposited;
67 #endif
68     
69     Vector<OwnPtr<CachedFrame>> m_childFrames;
70 };
71
72 class CachedFrame : private CachedFrameBase {
73 public:
74     static PassOwnPtr<CachedFrame> create(Frame& frame) { return adoptPtr(new CachedFrame(frame)); }
75
76     void open();
77     void clear();
78     void destroy();
79
80     void setCachedFramePlatformData(PassOwnPtr<CachedFramePlatformData>);
81     CachedFramePlatformData* cachedFramePlatformData();
82
83     using CachedFrameBase::document;
84     using CachedFrameBase::view;
85     using CachedFrameBase::url;
86     DocumentLoader* documentLoader() const { return m_documentLoader.get(); }
87     Node* mousePressNode() const { return m_mousePressNode.get(); }
88
89     int descendantFrameCount() const;
90
91 private:
92     explicit CachedFrame(Frame&);
93 };
94
95 } // namespace WebCore
96
97 #endif // CachedFrame_h