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 WebKit { 38 39 class WebURL; 40 41 // In WebCore, there's one distinct StorageArea per origin per StorageNamespace. This 42 // class wraps a StorageArea. All the methods have obvious connections to the spec: 43 // http://dev.w3.org/html5/webstorage/ 44 class WebStorageArea { 45 public: 46 virtual ~WebStorageArea() { } 47 48 enum Result { 49 ResultOK = 0, 50 ResultBlockedByQuota, 51 ResultBlockedByPolicy 52 }; 53 54 // The number of key/value pairs in the storage area. 55 virtual unsigned length() = 0; 56 57 // Get a value for a specific key. Valid key indices are 0 through length() - 1. 58 // Indexes may change on any set/removeItem call. Will return null if the index 59 // provided is out of range. 60 virtual WebString key(unsigned index) = 0; 61 62 // Get the value that corresponds to a specific key. This returns null if there is 63 // no entry for that key. 64 virtual WebString getItem(const WebString& key) = 0; 65 66 // Set the value that corresponds to a specific key. Result will either be ResultOK 67 // or some particular error. The value is NOT set when there's an error. url is the 68 // url that should be used if a storage event fires. 69 virtual void setItem(const WebString& key, const WebString& newValue, const WebURL& url, Result& result, WebString& oldValue) 70 { 71 bool quotaException = false; 72 setItem(key, newValue, url, quotaException, oldValue); 73 result = quotaException ? ResultBlockedByQuota : ResultOK; 74 } 75 // FIXME: Remove soon (once Chrome has rolled past this revision). 76 virtual void setItem(const WebString& key, const WebString& newValue, const WebURL& url, bool& quotaException, WebString& oldValue) 77 { 78 Result result; 79 setItem(key, newValue, url, result, oldValue); 80 quotaException = result != ResultOK; 81 } 82 83 // Remove the value associated with a particular key. url is the url that should be used 84 // if a storage event fires. 85 virtual void removeItem(const WebString& key, const WebURL& url, WebString& oldValue) = 0; 86 87 // Clear all key/value pairs. url is the url that should be used if a storage event fires. 88 virtual void clear(const WebURL& url, bool& somethingCleared) = 0; 89 }; 90 91 } // namespace WebKit 92 93 #endif // WebStorageArea_h 94
