Rename pageCache() to PageCache::shared() and return a reference
[WebKit-https.git] / Source / WebCore / history / PageCache.h
1 /*
2  * Copyright (C) 2007 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef PageCache_h
27 #define PageCache_h
28
29 #include "Timer.h"
30 #include <wtf/Forward.h>
31 #include <wtf/HashSet.h>
32 #include <wtf/Noncopyable.h>
33
34 namespace WebCore {
35
36     class CachedPage;
37     class Frame;
38     class HistoryItem;
39     class Page;
40
41     enum class PruningReason { None, ProcessSuspended, MemoryPressure, ReachedCapacity };
42     
43     class PageCache {
44         WTF_MAKE_NONCOPYABLE(PageCache); WTF_MAKE_FAST_ALLOCATED;
45     public:
46         friend class NeverDestroyed<PageCache>;
47
48         // Function to obtain the global page cache.
49         WEBCORE_EXPORT static PageCache& shared();
50         
51         bool canCache(Page*) const;
52
53         WEBCORE_EXPORT void setCapacity(int); // number of pages to cache
54         int capacity() { return m_capacity; }
55         
56         void add(PassRefPtr<HistoryItem>, Page&); // Prunes if capacity() is exceeded.
57         WEBCORE_EXPORT void remove(HistoryItem*);
58         CachedPage* get(HistoryItem*, Page*);
59         std::unique_ptr<CachedPage> take(HistoryItem*, Page*);
60
61         int pageCount() const { return m_size; }
62         WEBCORE_EXPORT int frameCount() const;
63
64         WEBCORE_EXPORT void markPagesForVistedLinkStyleRecalc();
65
66         // Will mark all cached pages associated with the given page as needing style recalc.
67         void markPagesForFullStyleRecalc(Page*);
68
69         // Used when memory is low to prune some cached pages.
70         WEBCORE_EXPORT void pruneToCapacityNow(int capacity, PruningReason);
71
72 #if ENABLE(VIDEO_TRACK)
73         void markPagesForCaptionPreferencesChanged();
74 #endif
75
76         bool shouldClearBackingStores() const { return m_shouldClearBackingStores; }
77         void setShouldClearBackingStores(bool flag) { m_shouldClearBackingStores = flag; }
78         void markPagesForDeviceScaleChanged(Page*);
79
80     private:
81         PageCache(); // Use shared() instead.
82         ~PageCache(); // Not implemented to make sure nobody accidentally calls delete -- WebCore does not delete singletons.
83         
84         static bool canCachePageContainingThisFrame(Frame*);
85
86         void addToLRUList(HistoryItem*); // Adds to the head of the list.
87         void removeFromLRUList(HistoryItem*);
88
89         void prune(PruningReason);
90
91         int m_capacity;
92         int m_size;
93
94         // LRU List
95         HistoryItem* m_head;
96         HistoryItem* m_tail;
97         
98         bool m_shouldClearBackingStores;
99      };
100
101 } // namespace WebCore
102
103 #endif // PageCache_h