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 StorageMap_h
27#define StorageMap_h
28
29#include <wtf/HashMap.h>
30#include <wtf/PassRefPtr.h>
31#include <wtf/RefCounted.h>
32#include <wtf/text/StringHash.h>
33#include <wtf/text/WTFString.h>
34
35namespace WebCore {
36
37class StorageMap : public RefCounted<StorageMap> {
38public:
39    // Quota size measured in bytes.
40    static PassRefPtr<StorageMap> create(unsigned quotaSize);
41
42    unsigned length() const;
43    String key(unsigned index);
44    String getItem(const String&) const;
45    PassRefPtr<StorageMap> setItem(const String& key, const String& value, String& oldValue, bool& quotaException);
46    PassRefPtr<StorageMap> setItemIgnoringQuota(const String& key, const String& value);
47    PassRefPtr<StorageMap> removeItem(const String&, String& oldValue);
48
49    bool contains(const String& key) const;
50
51    void importItems(const HashMap<String, String>&);
52    const HashMap<String, String>& items() const { return m_map; }
53
54    unsigned quota() const { return m_quotaSize; }
55
56    static const unsigned noQuota = UINT_MAX;
57
58private:
59    explicit StorageMap(unsigned quota);
60    PassRefPtr<StorageMap> copy();
61    void invalidateIterator();
62    void setIteratorToIndex(unsigned);
63
64    HashMap<String, String> m_map;
65    HashMap<String, String>::iterator m_iterator;
66    unsigned m_iteratorIndex;
67
68    unsigned m_quotaSize; // Measured in bytes.
69    unsigned m_currentLength; // Measured in UChars.
70};
71
72} // namespace WebCore
73
74#endif // StorageMap_h
75