2008-04-23 Brady Eidson <beidson@apple.com>
[WebKit-https.git] / WebCore / storage / StorageArea.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 StorageArea_h
27 #define StorageArea_h
28
29 #include "PlatformString.h"
30
31 #include <wtf/Forward.h>
32 #include <wtf/PassRefPtr.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35
36 namespace WebCore {
37
38     class Frame;
39     class SecurityOrigin;
40     class StorageMap;
41     typedef int ExceptionCode;
42
43     class StorageArea : public RefCounted<StorageArea> {
44     public:
45         virtual ~StorageArea();
46         
47         virtual unsigned length() const { return internalLength(); }
48         virtual String key(unsigned index, ExceptionCode& ec) const { return internalKey(index, ec); }
49         virtual String getItem(const String& key) const { return internalGetItem(key); }
50         virtual void setItem(const String& key, const String& value, ExceptionCode& ec, Frame* sourceFrame) { internalSetItem(key, value, ec, sourceFrame); }
51         virtual void removeItem(const String& key, Frame* sourceFrame) { internalRemoveItem(key, sourceFrame); }
52         virtual bool contains(const String& key) const { return internalContains(key); }
53         
54         SecurityOrigin* securityOrigin() { return m_securityOrigin.get(); }
55
56     protected:
57         StorageArea(SecurityOrigin*);
58         StorageArea(SecurityOrigin*, StorageArea*);
59                 
60         unsigned internalLength() const;
61         String internalKey(unsigned index, ExceptionCode&) const;
62         String internalGetItem(const String&) const;
63         void internalSetItem(const String& key, const String& value, ExceptionCode&, Frame* sourceFrame);
64         void internalRemoveItem(const String&, Frame* sourceFrame);
65         bool internalContains(const String& key) const;
66
67     private:
68         virtual void itemChanged(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame) = 0;
69         virtual void itemRemoved(const String& key, const String& oldValue, Frame* sourceFrame) = 0;
70
71         RefPtr<SecurityOrigin> m_securityOrigin;
72         RefPtr<StorageMap> m_storageMap;
73     };
74
75 } // namespace WebCore
76
77 #endif // StorageArea_h