third_party/WebKit/public/web/WebCache.h

   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
  36 namespace blink {
  37
  38 // An interface to query and configure WebKit's resource cache.
  39 class WebCache {
  40 public:
  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         size_t purgedSize;
  58         size_t purgeableSize;
  59     };
  60
  61     // A struct mirroring blink::MemoryCache::Statistics.
  62     struct ResourceTypeStats {
  63         ResourceTypeStat images;
  64         ResourceTypeStat cssStyleSheets;
  65         ResourceTypeStat scripts;
  66         ResourceTypeStat xslStyleSheets;
  67         ResourceTypeStat fonts;
  68         ResourceTypeStat other;
  69     };
  70
  71     // Sets the capacities of the resource cache, evicting objects as necessary.
  72     BLINK_EXPORT static void setCapacities(size_t minDeadCapacity,
  73                                             size_t maxDeadCapacity,
  74                                             size_t capacity);
  75
  76     // Clears the cache (as much as possible; some resources may not be
  77     // cleared if they are actively referenced). Note that this method
  78     // only removes resources from live list, w/o releasing cache memory.
  79     BLINK_EXPORT static void clear();
  80
  81     // Gets the usage statistics from the resource cache.
  82     BLINK_EXPORT static void getUsageStats(UsageStats*);
  83
  84     // Get usage stats about the resource cache.
  85     BLINK_EXPORT static void getResourceTypeStats(ResourceTypeStats*);
  86
  87     // Prunes all resources (as much as possible; some resources may not be
  88     // cleared if they are actively referenced). And releases cache memory.
  89     BLINK_EXPORT static void pruneAll();
  90
  91 private:
  92     WebCache();  // Not intended to be instanced.
  93 };
  94
  95 }  // namespace blink
  96
  97 #endif