src/third_party/WebKit/Source/core/storage/Storage.h

   1 /*
   2  * Copyright (C) 2008 Apple 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 APPLE 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 APPLE 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 Storage_h
  27 #define Storage_h
  28
  29 #include "bindings/core/v8/ScriptWrappable.h"
  30 #include "bindings/core/v8/V8Binding.h"
  31 #include "core/frame/DOMWindowProperty.h"
  32 #include "core/storage/StorageArea.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/Forward.h"
  35 #include "wtf/RefCounted.h"
  36 #include "wtf/RefPtr.h"
  37
  38 namespace blink {
  39
  40 class ExceptionState;
  41 class LocalFrame;
  42
  43 class Storage FINAL : public RefCountedWillBeGarbageCollected<Storage>, public ScriptWrappable, public DOMWindowProperty {
  44     DEFINE_WRAPPERTYPEINFO();
  45     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(Storage);
  46     DECLARE_EMPTY_VIRTUAL_DESTRUCTOR_WILL_BE_REMOVED(Storage);
  47 public:
  48     static PassRefPtrWillBeRawPtr<Storage> create(LocalFrame*, PassOwnPtrWillBeRawPtr<StorageArea>);
  49
  50     unsigned length(ExceptionState& ec) const { return m_storageArea->length(ec, m_frame); }
  51     String key(unsigned index, ExceptionState& ec) const { return m_storageArea->key(index, ec, m_frame); }
  52     String getItem(const String& key, ExceptionState& ec) const { return m_storageArea->getItem(key, ec, m_frame); }
  53     void setItem(const String& key, const String& value, ExceptionState& ec) { m_storageArea->setItem(key, value, ec, m_frame); }
  54     void removeItem(const String& key, ExceptionState& ec) { m_storageArea->removeItem(key, ec, m_frame); }
  55     void clear(ExceptionState& ec) { m_storageArea->clear(ec, m_frame); }
  56     bool contains(const String& key, ExceptionState& ec) const { return m_storageArea->contains(key, ec, m_frame); }
  57
  58     StorageArea* area() const { return m_storageArea.get(); }
  59
  60     String anonymousIndexedGetter(unsigned, ExceptionState&);
  61     String anonymousNamedGetter(const AtomicString&, ExceptionState&);
  62     bool anonymousNamedSetter(const AtomicString& name, const AtomicString& value, ExceptionState&);
  63     bool anonymousIndexedSetter(unsigned, const AtomicString&, ExceptionState&);
  64     DeleteResult anonymousNamedDeleter(const AtomicString&, ExceptionState&);
  65     DeleteResult anonymousIndexedDeleter(unsigned, ExceptionState&);
  66     void namedPropertyEnumerator(Vector<String>&, ExceptionState&);
  67     bool namedPropertyQuery(const AtomicString&, ExceptionState&);
  68
  69     virtual void trace(Visitor*) OVERRIDE;
  70
  71 private:
  72     Storage(LocalFrame*, PassOwnPtrWillBeRawPtr<StorageArea>);
  73
  74     OwnPtrWillBeMember<StorageArea> m_storageArea;
  75 };
  76
  77 } // namespace blink
  78
  79 #endif // Storage_h