Source/WebKit/chromium/public/WebCache.h

/*
 * 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::MemoryCache::TypeStatistic.
    struct ResourceTypeStat {
        size_t count;
        size_t size;
        size_t liveSize;
        size_t decodedSize;
    };

    // A struct mirroring WebCore::MemoryCache::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);

    // Clears the cache (as much as possible; some resources may not be
    // cleared if they are actively referenced).
    WEBKIT_API static void clear();

    // 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