Clearing Website data for a given session should not shut down cached processes for...
[WebKit.git] / Source / WebKit / UIProcess / WebBackForwardCache.h
1 /*
2  * Copyright (C) 2019 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 <pal/SessionID.h>
29 #include <wtf/Forward.h>
30 #include <wtf/ListHashSet.h>
31
32 namespace WebKit {
33
34 class SuspendedPageProxy;
35 class WebBackForwardListItem;
36 class WebPageProxy;
37 class WebProcessProxy;
38
39 class WebBackForwardCache {
40     WTF_MAKE_FAST_ALLOCATED;
41 public:
42     WebBackForwardCache();
43     ~WebBackForwardCache();
44
45     void setCapacity(unsigned);
46     unsigned capacity() const { return m_capacity; }
47     unsigned size() const { return m_itemsWithCachedPage.size(); }
48
49     void clear();
50     void removeEntriesForProcess(WebProcessProxy&);
51     void removeEntriesForPage(WebPageProxy&);
52     void removeEntriesForSession(PAL::SessionID);
53
54     void addEntry(WebBackForwardListItem&, std::unique_ptr<SuspendedPageProxy>&&);
55     void removeEntry(WebBackForwardListItem&);
56     std::unique_ptr<SuspendedPageProxy> takeEntry(WebBackForwardListItem&);
57
58 private:
59     void removeOldestEntry();
60     void removeEntriesMatching(const Function<bool(WebBackForwardListItem&)>&);
61
62     unsigned m_capacity { 0 };
63     ListHashSet<WebBackForwardListItem*> m_itemsWithCachedPage;
64 };
65
66 } // namespace WebKit