PageCache.h 3.16 KB
Newer Older
darin's avatar
darin committed
1
/*
ggaren's avatar
ggaren committed
2
 * Copyright (C) 2007 Apple Inc.  All rights reserved.
darin's avatar
darin committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */
beidson's avatar
beidson committed
25

ggaren's avatar
ggaren committed
26 27 28 29 30 31 32
#ifndef PageCache_h
#define PageCache_h

#include "Timer.h"
#include <wtf/Forward.h>
#include <wtf/HashSet.h>
#include <wtf/Noncopyable.h>
darin's avatar
darin committed
33

darin's avatar
darin committed
34
namespace WebCore {
beidson's avatar
beidson committed
35

ggaren's avatar
ggaren committed
36
    class CachedPage;
37
    class Frame;
ggaren's avatar
ggaren committed
38
    class HistoryItem;
39
    class Page;
ggaren's avatar
ggaren committed
40
    
41 42
    class PageCache {
        WTF_MAKE_NONCOPYABLE(PageCache); WTF_MAKE_FAST_ALLOCATED;
ggaren's avatar
ggaren committed
43
    public:
ggaren's avatar
ggaren committed
44
        friend PageCache* pageCache();
45 46
        
        static bool canCache(Page*);
ggaren's avatar
ggaren committed
47 48 49 50

        void setCapacity(int); // number of pages to cache
        int capacity() { return m_capacity; }
        
51
        void add(PassRefPtr<HistoryItem>, Page*); // Prunes if capacity() is exceeded.
ggaren's avatar
ggaren committed
52
        void remove(HistoryItem*);
53
        CachedPage* get(HistoryItem* item);
ggaren's avatar
ggaren committed
54 55

        void releaseAutoreleasedPagesNow();
beidson@apple.com's avatar
beidson@apple.com committed
56 57 58 59
        
        int pageCount() const { return m_size; }
        int frameCount() const;
        int autoreleasedPageCount() const;
beidson's avatar
beidson committed
60

61 62
        void markPagesForVistedLinkStyleRecalc();

ggaren's avatar
ggaren committed
63 64
    private:
        typedef HashSet<RefPtr<CachedPage> > CachedPageSet;
mjs's avatar
mjs committed
65

ggaren's avatar
ggaren committed
66
        PageCache(); // Use pageCache() instead.
ggaren's avatar
ggaren committed
67
        ~PageCache(); // Not implemented to make sure nobody accidentally calls delete -- WebCore does not delete singletons.
68 69
        
        static bool canCachePageContainingThisFrame(Frame*);
beidson's avatar
beidson committed
70

ggaren's avatar
ggaren committed
71 72 73
        void addToLRUList(HistoryItem*); // Adds to the head of the list.
        void removeFromLRUList(HistoryItem*);

ggaren's avatar
ggaren committed
74 75 76 77
        void prune();

        void autorelease(PassRefPtr<CachedPage>);
        void releaseAutoreleasedPagesNowOrReschedule(Timer<PageCache>*);
beidson's avatar
beidson committed
78

ggaren's avatar
ggaren committed
79
        int m_capacity;
ggaren's avatar
ggaren committed
80 81 82 83 84
        int m_size;

        // LRU List
        HistoryItem* m_head;
        HistoryItem* m_tail;
ggaren's avatar
ggaren committed
85
        
ggaren's avatar
ggaren committed
86 87 88
        Timer<PageCache> m_autoreleaseTimer;
        CachedPageSet m_autoreleaseSet;
     };
beidson's avatar
beidson committed
89

ggaren's avatar
ggaren committed
90 91
    // Function to obtain the global page cache.
    PageCache* pageCache();
beidson's avatar
beidson committed
92 93 94

} // namespace WebCore

ggaren's avatar
ggaren committed
95
#endif // PageCache_h