2fe1b2e2feb6f2e054b8cecd2b56448c68817d9a
[WebKit-https.git] / WebCore / history / CachedPage.h
1 /*
2  * Copyright (C) 2006, 2007 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 CachedPage_h
27 #define CachedPage_h
28
29 #include "DocumentLoader.h"
30 #include <kjs/SymbolTable.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Forward.h>
33 #include <wtf/RefPtr.h>
34 #include <wtf/OwnPtr.h>
35
36 #if PLATFORM(MAC)
37 #include <wtf/RetainPtr.h>
38 typedef struct objc_object* id;
39 #endif
40
41 namespace KJS {
42     
43     class SavedBuiltins;
44     struct SavedProperties;
45 }
46
47 namespace WebCore {
48     
49     class CachedPagePlatformData;
50     class Document;
51     class FrameView;
52     class Node;
53     class Page;
54     class PausedTimeouts;
55
56 class CachedPage : public RefCounted<CachedPage> {
57 public:
58     static PassRefPtr<CachedPage> create(Page*);
59     ~CachedPage();
60     
61     void clear();
62     Document* document() const { return m_document.get(); }
63     FrameView* view() const { return m_view.get(); }
64     Node* mousePressNode() const { return m_mousePressNode.get(); }
65     const KURL& url() const { return m_URL; }
66     void restore(Page*);
67         
68     void setTimeStamp(double);
69     void setTimeStampToNow();
70     double timeStamp() const;
71     void setDocumentLoader(PassRefPtr<DocumentLoader>);
72     DocumentLoader* documentLoader();
73
74     void setCachedPagePlatformData(CachedPagePlatformData*);
75     CachedPagePlatformData* cachedPagePlatformData();
76 private:
77     CachedPage(Page*);
78     RefPtr<DocumentLoader> m_documentLoader;
79     double m_timeStamp;
80
81     RefPtr<Document> m_document;
82     RefPtr<FrameView> m_view;
83     RefPtr<Node> m_mousePressNode;
84     KURL m_URL;
85     OwnPtr<KJS::SavedProperties> m_windowProperties;
86     OwnPtr<KJS::SavedProperties> m_locationProperties;
87     OwnPtr<KJS::SavedProperties> m_windowLocalStorage;
88     KJS::SymbolTable m_windowSymbolTable;
89     OwnPtr<KJS::SavedBuiltins> m_windowBuiltins;
90     OwnPtr<PausedTimeouts> m_pausedTimeouts;
91     OwnPtr<CachedPagePlatformData> m_cachedPagePlatformData;
92 };
93
94 } // namespace WebCore
95
96 #endif // CachedPage_h
97