Add globally-unique HistoryItem identifiers (and have WebKit2 adopt them).
[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/text/WTFString.h>
32
33 namespace API {
34 class Data;
35 }
36
37 namespace IPC {
38 class Decoder;
39 class Encoder;
40 }
41
42 namespace WebKit {
43
44 class SuspendedPageProxy;
45
46 class WebBackForwardListItem : public API::ObjectImpl<API::Object::Type::BackForwardListItem> {
47 public:
48     static Ref<WebBackForwardListItem> create(BackForwardListItemState&&, uint64_t pageID);
49     virtual ~WebBackForwardListItem();
50
51     static WebBackForwardListItem* itemForID(const WebCore::BackForwardItemIdentifier&);
52     static HashMap<WebCore::BackForwardItemIdentifier, WebBackForwardListItem*>& allItems();
53
54     const WebCore::BackForwardItemIdentifier& itemID() const { return m_itemState.identifier; }
55     const BackForwardListItemState& itemState() { return m_itemState; }
56     uint64_t pageID() const { return m_pageID; }
57
58     void setPageState(PageState pageState) { m_itemState.pageState = WTFMove(pageState); }
59     const PageState& pageState() const { return m_itemState.pageState; }
60
61     const String& originalURL() const { return m_itemState.pageState.mainFrameState.originalURLString; }
62     const String& url() const { return m_itemState.pageState.mainFrameState.urlString; }
63     const String& title() const { return m_itemState.pageState.title; }
64
65     bool itemIsInSameDocument(const WebBackForwardListItem&) const;
66
67 #if PLATFORM(COCOA)
68     ViewSnapshot* snapshot() const { return m_itemState.snapshot.get(); }
69     void setSnapshot(RefPtr<ViewSnapshot>&& snapshot) { m_itemState.snapshot = WTFMove(snapshot); }
70 #endif
71     void setSuspendedPage(SuspendedPageProxy&);
72
73 private:
74     explicit WebBackForwardListItem(BackForwardListItemState&&, uint64_t pageID);
75
76     BackForwardListItemState m_itemState;
77     uint64_t m_pageID;
78     SuspendedPageProxy* m_suspendedPage { nullptr };
79 };
80
81 typedef Vector<Ref<WebBackForwardListItem>> BackForwardListItemVector;
82
83 } // namespace WebKit