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