WebCore/storage/Storage.h

   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 Storage_h
  27 #define Storage_h
  28
  29 #if ENABLE(DOM_STORAGE)
  30
  31 #include "StorageArea.h"
  32
  33 #include <wtf/Forward.h>
  34 #include <wtf/RefCounted.h>
  35 #include <wtf/RefPtr.h>
  36
  37 namespace WebCore {
  38
  39     class Frame;
  40     class String;
  41     typedef int ExceptionCode;
  42
  43     class Storage : public RefCounted<Storage> {
  44     public:
  45         static PassRefPtr<Storage> create(Frame*, PassRefPtr<StorageArea>);
  46
  47         unsigned length() const;
  48         String key(unsigned index, ExceptionCode&) const;
  49         String getItem(const String&) const;
  50         void setItem(const String& key, const String& value, ExceptionCode&);
  51         void removeItem(const String&);
  52         void clear();
  53
  54         bool contains(const String& key) const;
  55
  56         void disconnectFrame() { m_frame = 0; }
  57
  58     private:
  59         Storage(Frame*, PassRefPtr<StorageArea>);
  60
  61         Frame* m_frame;
  62         RefPtr<StorageArea> m_storageArea;
  63     };
  64
  65 } // namespace WebCore
  66
  67 #endif // ENABLE(DOM_STORAGE)
  68
  69 #endif // Storage_h