src/third_party/WebKit/Source/core/storage/StorageArea.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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GOOGLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef StorageArea_h
  27 #define StorageArea_h
  28
  29 #include "heap/Handle.h"
  30 #include "wtf/OwnPtr.h"
  31 #include "wtf/PassOwnPtr.h"
  32 #include "wtf/text/WTFString.h"
  33
  34 namespace blink {
  35 class WebStorageArea;
  36 class WebStorageNamespace;
  37 }
  38
  39 namespace WebCore {
  40
  41 class ExceptionState;
  42 class Frame;
  43 class KURL;
  44 class Page;
  45 class SecurityOrigin;
  46 class Storage;
  47
  48 enum StorageType {
  49     LocalStorage,
  50     SessionStorage
  51 };
  52
  53 class StorageArea : public NoBaseWillBeGarbageCollectedFinalized<StorageArea> {
  54     DECLARE_GC_INFO;
  55 public:
  56     StorageArea(PassOwnPtr<blink::WebStorageArea>, StorageType);
  57     virtual ~StorageArea();
  58
  59     // The HTML5 DOM Storage API
  60     unsigned length(ExceptionState&, Frame* sourceFrame);
  61     String key(unsigned index, ExceptionState&, Frame* sourceFrame);
  62     String getItem(const String& key, ExceptionState&, Frame* sourceFrame);
  63     void setItem(const String& key, const String& value, ExceptionState&, Frame* sourceFrame);
  64     void removeItem(const String& key, ExceptionState&, Frame* sourceFrame);
  65     void clear(ExceptionState&, Frame* sourceFrame);
  66     bool contains(const String& key, ExceptionState&, Frame* sourceFrame);
  67
  68     bool canAccessStorage(Frame*);
  69     size_t memoryBytesUsedByCache();
  70
  71     static void dispatchLocalStorageEvent(const String& key, const String& oldValue, const String& newValue,
  72         SecurityOrigin*, const KURL& pageURL, blink::WebStorageArea* sourceAreaInstance, bool originatedInProcess);
  73     static void dispatchSessionStorageEvent(const String& key, const String& oldValue, const String& newValue,
  74         SecurityOrigin*, const KURL& pageURL, const blink::WebStorageNamespace&,
  75         blink::WebStorageArea* sourceAreaInstance, bool originatedInProcess);
  76
  77     void trace(Visitor*) { }
  78
  79 private:
  80     static bool isEventSource(Storage*, blink::WebStorageArea* sourceAreaInstance);
  81
  82     OwnPtr<blink::WebStorageArea> m_storageArea;
  83     StorageType m_storageType;
  84     mutable bool m_canAccessStorageCachedResult;
  85     mutable Frame* m_canAccessStorageCachedFrame;
  86 };
  87
  88 } // namespace WebCore
  89
  90 #endif // StorageArea_h