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