StorageArea.h   [plain text]

/*
 * Copyright (C) 2008 Apple Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */

#ifndef StorageArea_h
#define StorageArea_h

#include "PlatformString.h"

#include <wtf/Forward.h>
#include <wtf/PassRefPtr.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>

namespace WebCore {

    class Frame;
    class SecurityOrigin;
    class StorageMap;
    typedef int ExceptionCode;

    class StorageArea : public RefCounted<StorageArea> {
    public:
        virtual ~StorageArea();
        
        virtual unsigned length() const { return internalLength(); }
        virtual String key(unsigned index, ExceptionCode& ec) const { return internalKey(index, ec); }
        virtual String getItem(const String& key) const { return internalGetItem(key); }
        virtual void setItem(const String& key, const String& value, ExceptionCode& ec, Frame* sourceFrame) { internalSetItem(key, value, ec, sourceFrame); }
        virtual void removeItem(const String& key, Frame* sourceFrame) { internalRemoveItem(key, sourceFrame); }
        virtual void clear(Frame* sourceFrame) { internalClear(sourceFrame); }
        virtual bool contains(const String& key) const { return internalContains(key); }
        
        SecurityOrigin* securityOrigin() { return m_securityOrigin.get(); }

    protected:
        StorageArea(SecurityOrigin*);
        StorageArea(SecurityOrigin*, StorageArea*);
                
        unsigned internalLength() const;
        String internalKey(unsigned index, ExceptionCode&) const;
        String internalGetItem(const String&) const;
        void internalSetItem(const String& key, const String& value, ExceptionCode&, Frame* sourceFrame);
        void internalRemoveItem(const String&, Frame* sourceFrame);
        void internalClear(Frame* sourceFrame);
        bool internalContains(const String& key) const;
        
        // This is meant to be called from a background thread for LocalStorageArea's background thread import procedure.
        void importItem(const String& key, const String& value);

    private:
        virtual void itemChanged(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame) = 0;
        virtual void itemRemoved(const String& key, const String& oldValue, Frame* sourceFrame) = 0;
        virtual void areaCleared(Frame* sourceFrame) = 0;

        RefPtr<SecurityOrigin> m_securityOrigin;
        RefPtr<StorageMap> m_storageMap;
    };

} // namespace WebCore

#endif // StorageArea_h