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 <wtf/Forward.h>
30#include <wtf/PassRefPtr.h>
31#include <wtf/RefCounted.h>
32#include <wtf/text/WTFString.h>
33
34namespace WebCore {
35
36class Frame;
37class StorageSyncManager;
38typedef int ExceptionCode;
39enum StorageType { LocalStorage, SessionStorage };
40
41class StorageArea : public RefCounted<StorageArea> {
42public:
43    virtual ~StorageArea() { }
44
45    virtual unsigned length() = 0;
46    virtual String key(unsigned index) = 0;
47    virtual String item(const String& key) = 0;
48    virtual void setItem(Frame* sourceFrame, const String& key, const String& value, bool& quotaException) = 0;
49    virtual void removeItem(Frame* sourceFrame, const String& key) = 0;
50    virtual void clear(Frame* sourceFrame) = 0;
51    virtual bool contains(const String& key) = 0;
52
53    virtual bool canAccessStorage(Frame*) = 0;
54    virtual StorageType storageType() const = 0;
55
56    virtual size_t memoryBytesUsedByCache() = 0;
57
58    virtual void incrementAccessCount() { }
59    virtual void decrementAccessCount() { }
60    virtual void closeDatabaseIfIdle() { }
61};
62
63} // namespace WebCore
64
65#endif // StorageArea_h
66