• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 StorageAreaImpl_h
27 #define StorageAreaImpl_h
28 
29 #if ENABLE(DOM_STORAGE)
30 
31 #include "StorageArea.h"
32 
33 #include <wtf/RefPtr.h>
34 
35 namespace WebCore {
36 
37     class SecurityOrigin;
38     class StorageMap;
39     class StorageAreaSync;
40 
41     class StorageAreaImpl : public StorageArea {
42     public:
43         StorageAreaImpl(StorageType, PassRefPtr<SecurityOrigin>, PassRefPtr<StorageSyncManager>);
44         virtual ~StorageAreaImpl();
45 
46         // The HTML5 DOM Storage API (and contains)
47         virtual unsigned length() const;
48         virtual String key(unsigned index) const;
49         virtual String getItem(const String& key) const;
50         virtual void setItem(const String& key, const String& value, ExceptionCode& ec, Frame* sourceFrame);
51         virtual void removeItem(const String& key, Frame* sourceFrame);
52         virtual void clear(Frame* sourceFrame);
53         virtual bool contains(const String& key) const;
54 
55         PassRefPtr<StorageAreaImpl> copy();
56         void close();
57 
58         // Could be called from a background thread.
59         void importItem(const String& key, const String& value);
60         SecurityOrigin* securityOrigin();
61 
62     private:
63         StorageAreaImpl(StorageAreaImpl*);
64 
65         void blockUntilImportComplete() const;
66 
67         void dispatchStorageEvent(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame);
68 
69         StorageType m_storageType;
70         RefPtr<SecurityOrigin> m_securityOrigin;
71         RefPtr<StorageMap> m_storageMap;
72 
73         RefPtr<StorageAreaSync> m_storageAreaSync;
74         RefPtr<StorageSyncManager> m_storageSyncManager;
75 
76 #ifndef NDEBUG
77         bool m_isShutdown;
78 #endif
79     };
80 
81 } // namespace WebCore
82 
83 #endif // ENABLE(DOM_STORAGE)
84 
85 #endif // StorageAreaImpl_h
86