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