• 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 StorageArea_h
27 #define StorageArea_h
28 
29 #if ENABLE(DOM_STORAGE)
30 
31 #include "PlatformString.h"
32 
33 #include <wtf/PassRefPtr.h>
34 #include <wtf/RefCounted.h>
35 
36 namespace WebCore {
37 
38     class Frame;
39     class SecurityOrigin;
40     class StorageSyncManager;
41     typedef int ExceptionCode;
42     enum StorageType { LocalStorage, SessionStorage };
43 
44     // This interface is required for Chromium since these actions need to be proxied between processes.
45     class StorageArea : public RefCounted<StorageArea> {
46     public:
~StorageArea()47         virtual ~StorageArea() { }
48 
49         // The HTML5 DOM Storage API
50         virtual unsigned length() const = 0;
51         virtual String key(unsigned index) const = 0;
52         virtual String getItem(const String& key) const = 0;
53         virtual String setItem(const String& key, const String& value, ExceptionCode& ec, Frame* sourceFrame) = 0;
54         virtual String removeItem(const String& key, Frame* sourceFrame) = 0;
55         virtual bool clear(Frame* sourceFrame) = 0;
56         virtual bool contains(const String& key) const = 0;
57     };
58 
59 } // namespace WebCore
60 
61 #endif // ENABLE(DOM_STORAGE)
62 
63 #endif // StorageArea_h
64