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