bff0c882041f6a9aa8332166fd7b377ec3f1b583
[WebKit-https.git] / Source / WebKit / Shared / WebBackForwardListItem.h
1 /*
2  * Copyright (C) 2010-2011, 2016 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "APIObject.h"
29 #include "SessionState.h"
30 #include <wtf/Ref.h>
31 #include <wtf/WeakPtr.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace API {
35 class Data;
36 }
37
38 namespace IPC {
39 class Decoder;
40 class Encoder;
41 }
42
43 namespace WebKit {
44
45 class SuspendedPageProxy;
46
47 class WebBackForwardListItem : public API::ObjectImpl<API::Object::Type::BackForwardListItem> {
48 public:
49     static Ref<WebBackForwardListItem> create(BackForwardListItemState&&, uint64_t pageID);
50     virtual ~WebBackForwardListItem();
51
52     static WebBackForwardListItem* itemForID(const WebCore::BackForwardItemIdentifier&);
53     static HashMap<WebCore::BackForwardItemIdentifier, WebBackForwardListItem*>& allItems();
54
55     const WebCore::BackForwardItemIdentifier& itemID() const { return m_itemState.identifier; }
56     const BackForwardListItemState& itemState() { return m_itemState; }
57     uint64_t pageID() const { return m_pageID; }
58
59     void setPageState(PageState pageState) { m_itemState.pageState = WTFMove(pageState); }
60     const PageState& pageState() const { return m_itemState.pageState; }
61
62     const String& originalURL() const { return m_itemState.pageState.mainFrameState.originalURLString; }
63     const String& url() const { return m_itemState.pageState.mainFrameState.urlString; }
64     const String& title() const { return m_itemState.pageState.title; }
65
66     bool itemIsInSameDocument(const WebBackForwardListItem&) const;
67     bool itemIsClone(const WebBackForwardListItem&);
68
69 #if PLATFORM(COCOA) || PLATFORM(GTK)
70     ViewSnapshot* snapshot() const { return m_itemState.snapshot.get(); }
71     void setSnapshot(RefPtr<ViewSnapshot>&& snapshot) { m_itemState.snapshot = WTFMove(snapshot); }
72 #endif
73     void setSuspendedPage(SuspendedPageProxy*);
74     SuspendedPageProxy* suspendedPage() const { return m_suspendedPage.get(); }
75
76 #if !LOG_DISABLED
77     const char* loggingString();
78 #endif
79
80 private:
81     explicit WebBackForwardListItem(BackForwardListItemState&&, uint64_t pageID);
82
83     void removeSuspendedPageFromProcessPool();
84
85     BackForwardListItemState m_itemState;
86     uint64_t m_pageID;
87     WeakPtr<SuspendedPageProxy> m_suspendedPage;
88 };
89
90 typedef Vector<Ref<WebBackForwardListItem>> BackForwardListItemVector;
91
92 } // namespace WebKit