When blocking localStorage, Firefox throws a security exception on access, and maybe...
[WebKit.git] / Source / WebCore / 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 "DOMWindowProperty.h"
30 #include "StorageArea.h"
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37     class Frame;
38     typedef int ExceptionCode;
39
40     class Storage : public RefCounted<Storage>, public DOMWindowProperty {
41     public:
42         static PassRefPtr<Storage> create(Frame*, PassRefPtr<StorageArea>);
43         ~Storage();
44
45         unsigned length(ExceptionCode& ec) const { return m_storageArea->length(ec, m_frame); }
46         String key(unsigned index, ExceptionCode& ec) const { return m_storageArea->key(index, ec, m_frame); }
47         String getItem(const String& key, ExceptionCode& ec) const { return m_storageArea->getItem(key, ec, m_frame); }
48         void setItem(const String& key, const String& value, ExceptionCode& ec) { m_storageArea->setItem(key, value, ec, m_frame); }
49         void removeItem(const String& key, ExceptionCode& ec) { m_storageArea->removeItem(key, ec, m_frame); }
50         void clear(ExceptionCode& ec) { m_storageArea->clear(ec, m_frame); }
51         bool contains(const String& key, ExceptionCode& ec) const { return m_storageArea->contains(key, ec, m_frame); }
52
53         StorageArea* area() const { return m_storageArea.get(); }
54
55     private:
56         Storage(Frame*, PassRefPtr<StorageArea>);
57
58         RefPtr<StorageArea> m_storageArea;
59     };
60
61 } // namespace WebCore
62
63 #endif // Storage_h