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 StorageArea_h
     27 #define StorageArea_h
     28 
     29 #include <wtf/Forward.h>
     30 #include <wtf/text/WTFString.h>
     31 
     32 namespace WebCore {
     33 
     34 class ExceptionState;
     35 class Frame;
     36 class SecurityOrigin;
     37 class StorageSyncManager;
     38 enum StorageType { LocalStorage, SessionStorage };
     39 
     40 class StorageArea {
     41 public:
     42     virtual ~StorageArea() { }
     43 
     44     // The HTML5 DOM Storage API
     45     // FIXME: We should pass Document instead of Frame. Also, that parameter should go first.
     46     virtual unsigned length(ExceptionState&, Frame* sourceFrame) = 0;
     47     virtual String key(unsigned index, ExceptionState&, Frame* sourceFrame) = 0;
     48     virtual String getItem(const String& key, ExceptionState&, Frame* sourceFrame) = 0;
     49     virtual void setItem(const String& key, const String& value, ExceptionState&, Frame* sourceFrame) = 0;
     50     virtual void removeItem(const String& key, ExceptionState&, Frame* sourceFrame) = 0;
     51     virtual void clear(ExceptionState&, Frame* sourceFrame) = 0;
     52     virtual bool contains(const String& key, ExceptionState&, Frame* sourceFrame) = 0;
     53 
     54     virtual bool canAccessStorage(Frame*) = 0;
     55 
     56     virtual size_t memoryBytesUsedByCache() = 0;
     57 };
     58 
     59 } // namespace WebCore
     60 
     61 #endif // StorageArea_h
     62