acafb22d842276f8f8ff5ef89abb56fe185a2965
[WebKit-https.git] / 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 #if ENABLE(DOM_STORAGE)
30
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebCore {
36
37     class Frame;
38     class StorageArea;
39     class String;
40     typedef int ExceptionCode;
41
42     class Storage : public RefCounted<Storage> {
43     public:
44         static PassRefPtr<Storage> create(Frame*, PassRefPtr<StorageArea>);
45         
46         unsigned length() const;
47         String key(unsigned index, ExceptionCode&) const;
48         String getItem(const String&) const;
49         void setItem(const String& key, const String& value, ExceptionCode&);
50         void removeItem(const String&);
51         void clear();
52
53         bool contains(const String& key) const;
54
55         void disconnectFrame() { m_frame = 0; }
56
57     private:
58         friend class RefCounted<Storage>;
59         ~Storage();
60
61         Storage(Frame*, PassRefPtr<StorageArea>);
62             
63         Frame* m_frame;
64         RefPtr<StorageArea> m_storageArea;
65     };
66
67 } // namespace WebCore
68
69 #endif // ENABLE(DOM_STORAGE)
70
71 #endif // Storage_h