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