2010-12-29 Martin Robinson <mrobinson@igalia.com>
[WebKit-https.git] / WebCore / inspector / InspectorDOMStorageAgent.h
1 /*
2  * Copyright (C) 2010 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef InspectorDOMStorageAgent_h
30 #define InspectorDOMStorageAgent_h
31
32 #include "PlatformString.h"
33 #include "wtf/HashMap.h"
34 #include "wtf/PassRefPtr.h"
35
36 namespace WebCore {
37
38 class InspectorArray;
39 class InspectorController;
40 class InspectorDOMStorageResource;
41 class InspectorFrontend;
42 class Storage;
43
44 class InspectorDOMStorageAgent : public RefCounted<InspectorDOMStorageAgent> {
45 public:
46     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
47
48     static PassRefPtr<InspectorDOMStorageAgent> create(DOMStorageResourcesMap* domStorageResources, InspectorFrontend* frontend)
49     {
50         return adoptRef(new InspectorDOMStorageAgent(domStorageResources, frontend));
51     }
52
53     virtual ~InspectorDOMStorageAgent();
54
55     // Called from the front-end.
56     void getDOMStorageEntries(long storageId, RefPtr<InspectorArray>* entries);
57     void setDOMStorageItem(long storageId, const String& key, const String& value, bool* success);
58     void removeDOMStorageItem(long storageId, const String& key, bool* success);
59
60     // Called from the injected script.
61     void selectDOMStorage(Storage* storage);
62
63     InspectorFrontend* frontend() { return m_frontend; }
64
65 private:
66     InspectorDOMStorageAgent(DOMStorageResourcesMap*, InspectorFrontend*);
67
68     InspectorDOMStorageResource* getDOMStorageResourceForId(long storageId);
69
70     DOMStorageResourcesMap* m_domStorageResources;
71     InspectorFrontend* m_frontend;
72 };
73
74 } // namespace WebCore
75
76 #endif // !defined(InspectorDOMStorageAgent_h)