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