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 "core/frame/FrameDestructionObserver.h"
  30 #include "platform/heap/Handle.h"
  31 #include "wtf/OwnPtr.h"
  32 #include "wtf/PassOwnPtr.h"
  33 #include "wtf/text/WTFString.h"
  34
  35 namespace blink {
  36
  37 class ExceptionState;
  38 class LocalFrame;
  39 class KURL;
  40 class Page;
  41 class SecurityOrigin;
  42 class Storage;
  43 class WebStorageArea;
  44 class WebStorageNamespace;
  45
  46 enum StorageType {
  47     LocalStorage,
  48     SessionStorage
  49 };
  50
  51 class StorageArea FINAL : public NoBaseWillBeGarbageCollectedFinalized<StorageArea>, public FrameDestructionObserver {
  52     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(StorageArea);
  53 public:
  54     static PassOwnPtrWillBeRawPtr<StorageArea> create(PassOwnPtr<WebStorageArea>, StorageType);
  55
  56     virtual ~StorageArea();
  57
  58     // The HTML5 DOM Storage API
  59     unsigned length(ExceptionState&, LocalFrame* sourceFrame);
  60     String key(unsigned index, ExceptionState&, LocalFrame* sourceFrame);
  61     String getItem(const String& key, ExceptionState&, LocalFrame* sourceFrame);
  62     void setItem(const String& key, const String& value, ExceptionState&, LocalFrame* sourceFrame);
  63     void removeItem(const String& key, ExceptionState&, LocalFrame* sourceFrame);
  64     void clear(ExceptionState&, LocalFrame* sourceFrame);
  65     bool contains(const String& key, ExceptionState&, LocalFrame* sourceFrame);
  66
  67     bool canAccessStorage(LocalFrame*);
  68     size_t memoryBytesUsedByCache();
  69
  70     static void dispatchLocalStorageEvent(const String& key, const String& oldValue, const String& newValue,
  71         SecurityOrigin*, const KURL& pageURL, WebStorageArea* sourceAreaInstance, bool originatedInProcess);
  72     static void dispatchSessionStorageEvent(const String& key, const String& oldValue, const String& newValue,
  73         SecurityOrigin*, const KURL& pageURL, const WebStorageNamespace&,
  74         WebStorageArea* sourceAreaInstance, bool originatedInProcess);
  75
  76     void trace(Visitor*);
  77
  78 private:
  79     StorageArea(PassOwnPtr<WebStorageArea>, StorageType);
  80
  81     static bool isEventSource(Storage*, WebStorageArea* sourceAreaInstance);
  82
  83     OwnPtr<WebStorageArea> m_storageArea;
  84     StorageType m_storageType;
  85     bool m_canAccessStorageCachedResult;
  86 };
  87
  88 } // namespace blink
  89
  90 #endif // StorageArea_h