1/*
2 * Copyright (C) 2009 Google 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 are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef WebCache_h
32#define WebCache_h
33
34#include "../platform/WebCommon.h"
35
36namespace blink {
37
38// An interface to query and configure WebKit's resource cache.
39class WebCache {
40public:
41    struct UsageStats {
42        // Capacities.
43        size_t minDeadCapacity;
44        size_t maxDeadCapacity;
45        size_t capacity;
46        // Utilization.
47        size_t liveSize;
48        size_t deadSize;
49    };
50
51    // A struct mirroring blink::MemoryCache::TypeStatistic.
52    struct ResourceTypeStat {
53        size_t count;
54        size_t size;
55        size_t liveSize;
56        size_t decodedSize;
57    };
58
59    // A struct mirroring blink::MemoryCache::Statistics.
60    struct ResourceTypeStats {
61        ResourceTypeStat images;
62        ResourceTypeStat cssStyleSheets;
63        ResourceTypeStat scripts;
64        ResourceTypeStat xslStyleSheets;
65        ResourceTypeStat fonts;
66        ResourceTypeStat other;
67    };
68
69    // Sets the capacities of the resource cache, evicting objects as necessary.
70    BLINK_EXPORT static void setCapacities(size_t minDeadCapacity,
71                                            size_t maxDeadCapacity,
72                                            size_t capacity);
73
74    // Clears the cache (as much as possible; some resources may not be
75    // cleared if they are actively referenced). Note that this method
76    // only removes resources from live list, w/o releasing cache memory.
77    BLINK_EXPORT static void clear();
78
79    // Gets the usage statistics from the resource cache.
80    BLINK_EXPORT static void getUsageStats(UsageStats*);
81
82    // Get usage stats about the resource cache.
83    BLINK_EXPORT static void getResourceTypeStats(ResourceTypeStats*);
84
85private:
86    WebCache();  // Not intended to be instanced.
87};
88
89}  // namespace blink
90
91#endif
92