summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebCache.h
blob: 71b45fd5dec35052b8eba752fbac6df229e3afb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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.
 */

#ifndef WebCache_h
#define WebCache_h

#include "WebCommon.h"

namespace WebKit {

    // An interface to query and configure WebKit's resource cache.
    class WebCache {
    public:
        struct UsageStats {
            // Capacities.
            size_t minDeadCapacity;
            size_t maxDeadCapacity;
            size_t capacity;
            // Utilization.
            size_t liveSize;
            size_t deadSize;
        };

        // A struct mirroring WebCore::Cache::TypeStatistic.
        struct ResourceTypeStat {
            size_t count;
            size_t size;
            size_t liveSize;
            size_t decodedSize;
        };

        // A struct mirroring WebCore::Cache::Statistics.
        struct ResourceTypeStats {
            ResourceTypeStat images;
            ResourceTypeStat cssStyleSheets;
            ResourceTypeStat scripts;
            ResourceTypeStat xslStyleSheets;
            ResourceTypeStat fonts;
        };

        // Sets the capacities of the resource cache, evicting objects as necessary.
        WEBKIT_API static void setCapacities(size_t minDeadCapacity,
                                             size_t maxDeadCapacity,
                                             size_t capacity);

        // Gets the usage statistics from the resource cache.
        WEBKIT_API static void getUsageStats(UsageStats*);

        // Get usage stats about the resource cache.
        WEBKIT_API static void getResourceTypeStats(ResourceTypeStats*);

    private:
        WebCache();  // Not intended to be instanced.
    };

}  // namespace WebKit

#endif