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/PassOwnPtr.h>
35 
36 namespace WebCore {
37 
38 class Frame;
39 class InspectorArray;
40 class InspectorDOMStorageResource;
41 class InspectorFrontend;
42 class InspectorState;
43 class InstrumentingAgents;
44 class Storage;
45 class StorageArea;
46 
47 typedef String ErrorString;
48 
49 class InspectorDOMStorageAgent {
50 public:
create(InstrumentingAgents * instrumentingAgents,InspectorState * state)51     static PassOwnPtr<InspectorDOMStorageAgent> create(InstrumentingAgents* instrumentingAgents, InspectorState* state)
52     {
53         return adoptPtr(new InspectorDOMStorageAgent(instrumentingAgents, state));
54     }
55     ~InspectorDOMStorageAgent();
56 
57     void setFrontend(InspectorFrontend*);
58     void clearFrontend();
59 
60     void clearResources();
61     void restore();
62 
63     // Called from the front-end.
64     void enable(ErrorString*);
65     void disable(ErrorString*);
66     void getDOMStorageEntries(ErrorString*, int storageId, RefPtr<InspectorArray>* entries);
67     void setDOMStorageItem(ErrorString*, int storageId, const String& key, const String& value, bool* success);
68     void removeDOMStorageItem(ErrorString*, int storageId, const String& key, bool* success);
69 
70     // Called from the injected script.
71     int storageId(Storage*);
72 
73     // Called from InspectorInstrumentation
74     void didUseDOMStorage(StorageArea*, bool isLocalStorage, Frame*);
75 
76 private:
77     InspectorDOMStorageAgent(InstrumentingAgents*, InspectorState*);
78 
79     InspectorDOMStorageResource* getDOMStorageResourceForId(int storageId);
80 
81     InstrumentingAgents* m_instrumentingAgents;
82     InspectorState* m_inspectorState;
83     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
84     DOMStorageResourcesMap m_resources;
85     InspectorFrontend* m_frontend;
86     bool m_enabled;
87 };
88 
89 } // namespace WebCore
90 
91 #endif // !defined(InspectorDOMStorageAgent_h)
92