Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / inspector / InspectorDOMStorageAgent.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2015 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef InspectorDOMStorageAgent_h
31 #define InspectorDOMStorageAgent_h
32
33 #include "InspectorWebAgentBase.h"
34 #include "StorageArea.h"
35 #include <inspector/InspectorBackendDispatchers.h>
36 #include <wtf/HashMap.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace Inspector {
40 class DOMStorageFrontendDispatcher;
41 class InspectorArray;
42 }
43
44 namespace WebCore {
45
46 class Frame;
47 class InspectorPageAgent;
48 class Page;
49 class SecurityOrigin;
50 class Storage;
51
52 typedef String ErrorString;
53
54 class InspectorDOMStorageAgent final : public InspectorAgentBase, public Inspector::DOMStorageBackendDispatcherHandler {
55     WTF_MAKE_FAST_ALLOCATED;
56 public:
57     InspectorDOMStorageAgent(WebAgentContext&, InspectorPageAgent*);
58     virtual ~InspectorDOMStorageAgent();
59
60     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
61     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
62
63     // Called from the front-end.
64     void enable(ErrorString&) override;
65     void disable(ErrorString&) override;
66     void getDOMStorageItems(ErrorString&, const Inspector::InspectorObject& storageId, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Array<String>>>& items) override;
67     void setDOMStorageItem(ErrorString&, const Inspector::InspectorObject& storageId, const String& key, const String& value) override;
68     void removeDOMStorageItem(ErrorString&, const Inspector::InspectorObject& storageId, const String& key) override;
69
70     // Called from the injected script.
71     String storageId(Storage*);
72     RefPtr<Inspector::Protocol::DOMStorage::StorageId> storageId(SecurityOrigin*, bool isLocalStorage);
73
74     // Called from InspectorInstrumentation
75     void didDispatchDOMStorageEvent(const String& key, const String& oldValue, const String& newValue, StorageType, SecurityOrigin*, Page*);
76
77 private:
78     RefPtr<StorageArea> findStorageArea(ErrorString&, const Inspector::InspectorObject&, Frame*&);
79
80     std::unique_ptr<Inspector::DOMStorageFrontendDispatcher> m_frontendDispatcher;
81     RefPtr<Inspector::DOMStorageBackendDispatcher> m_backendDispatcher;
82     InspectorPageAgent* m_pageAgent { nullptr };
83
84     bool m_enabled { false };
85 };
86
87 } // namespace WebCore
88
89 #endif // !defined(InspectorDOMStorageAgent_h)