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 WebStorageArea_h 32 #define WebStorageArea_h 33 34 #include "WebCommon.h" 35 #include "WebString.h" 36 37 namespace blink { 38 39 class WebURL; 40 41 class WebStorageArea { 42 public: 43 virtual ~WebStorageArea() { } 44 45 enum Result { 46 ResultOK = 0, 47 ResultBlockedByQuota 48 }; 49 50 // The number of key/value pairs in the storage area. 51 virtual unsigned length() = 0; 52 53 // Get a value for a specific key. Valid key indices are 0 through length() - 1. 54 // Indexes may change on any set/removeItem call. Will return null if the index 55 // provided is out of range. 56 virtual WebString key(unsigned index) = 0; 57 58 // Get the value that corresponds to a specific key. This returns null if there is 59 // no entry for that key. 60 virtual WebString getItem(const WebString& key) = 0; 61 62 // Set the value that corresponds to a specific key. Result will either be ResultOK 63 // or some particular error. The value is NOT set when there's an error. |pageUrl| is the 64 // url that should be used if a storage event fires. 65 virtual void setItem(const WebString& key, const WebString& newValue, const WebURL& pageUrl, Result& result) 66 { 67 WebString unused; 68 setItem(key, newValue, pageUrl, result, unused); 69 } 70 71 72 // Remove the value associated with a particular key. |pageUrl| is the url that should be used 73 // if a storage event fires. 74 virtual void removeItem(const WebString& key, const WebURL& pageUrl) 75 { 76 WebString unused; 77 removeItem(key, pageUrl, unused); 78 } 79 80 // Clear all key/value pairs. |pageUrl| is the url that should be used if a storage event fires. 81 virtual void clear(const WebURL& pageUrl) 82 { 83 bool unused; 84 clear(pageUrl, unused); 85 } 86 87 // Returns amount of bytes occupied by the storage cache in physical memory. 88 virtual size_t memoryBytesUsedByCache() const { return 0; } 89 90 // DEPRECATED - being replaced by the async variants above which do not return oldValues or block until completion. 91 virtual void setItem(const WebString& key, const WebString& newValue, const WebURL&, Result&, WebString& oldValue) { } 92 virtual void removeItem(const WebString& key, const WebURL& pageUrl, WebString& oldValue) { } 93 virtual void clear(const WebURL& pageUrl, bool& somethingCleared) { } 94 }; 95 96 } // namespace blink 97 98 #endif // WebStorageArea_h 99
