c6fe4378c7eb94cef884b986eed4fd38f1592a50
[WebKit-https.git] / Source / WebKit / WebProcess / WebPage / WebBackForwardListProxy.h
1 /*
2  * Copyright (C) 2010, 2011 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 #ifndef WebBackForwardListProxy_h
27 #define WebBackForwardListProxy_h
28
29 #include <WebCore/BackForwardClient.h>
30 #include <wtf/HashSet.h>
31
32 namespace WebCore {
33 struct BackForwardItemIdentifier;
34 }
35
36 namespace WebKit {
37
38 class WebPage;
39
40 class WebBackForwardListProxy : public WebCore::BackForwardClient {
41 public: 
42     static Ref<WebBackForwardListProxy> create(WebPage* page) { return adoptRef(*new WebBackForwardListProxy(page)); }
43
44     static WebCore::HistoryItem* itemForID(const WebCore::BackForwardItemIdentifier&);
45     static void removeItem(const WebCore::BackForwardItemIdentifier&);
46
47     enum class OverwriteExistingItem {
48         Yes,
49         No
50     };
51     void addItemFromUIProcess(const WebCore::BackForwardItemIdentifier&, Ref<WebCore::HistoryItem>&&, uint64_t pageID, OverwriteExistingItem);
52
53     void clear();
54
55 private:
56     WebBackForwardListProxy(WebPage*);
57
58     void addItem(Ref<WebCore::HistoryItem>&&) override;
59
60     void goToItem(WebCore::HistoryItem*) override;
61         
62     WebCore::HistoryItem* itemAtIndex(int) override;
63     int backListCount() override;
64     int forwardListCount() override;
65
66     void close() override;
67
68     WebPage* m_page;
69 };
70
71 } // namespace WebKit
72
73 #endif // WebBackForwardListProxy_h