Web Inspector: use more C++ keywords for defining agents
[WebKit-https.git] / Source / WebCore / inspector / agents / 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 #pragma once
31
32 #include "InspectorWebAgentBase.h"
33 #include "StorageArea.h"
34 #include <JavaScriptCore/InspectorBackendDispatchers.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace Inspector {
38 class DOMStorageFrontendDispatcher;
39 }
40
41 namespace WebCore {
42
43 class Frame;
44 class Page;
45 class SecurityOrigin;
46 class Storage;
47
48 typedef String ErrorString;
49
50 class InspectorDOMStorageAgent final : public InspectorAgentBase, public Inspector::DOMStorageBackendDispatcherHandler {
51     WTF_MAKE_NONCOPYABLE(InspectorDOMStorageAgent);
52     WTF_MAKE_FAST_ALLOCATED;
53 public:
54     InspectorDOMStorageAgent(PageAgentContext&);
55     ~InspectorDOMStorageAgent() override;
56
57     // InspectorAgentBase
58     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
59     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
60
61     // DOMStorageBackendDispatcherHandler
62     void enable(ErrorString&) override;
63     void disable(ErrorString&) override;
64     void getDOMStorageItems(ErrorString&, const JSON::Object& storageId, RefPtr<JSON::ArrayOf<JSON::ArrayOf<String>>>& items) override;
65     void setDOMStorageItem(ErrorString&, const JSON::Object& storageId, const String& key, const String& value) override;
66     void removeDOMStorageItem(ErrorString&, const JSON::Object& storageId, const String& key) override;
67
68     // InspectorInstrumentation
69     void didDispatchDOMStorageEvent(const String& key, const String& oldValue, const String& newValue, StorageType, SecurityOrigin*);
70
71     // CommandLineAPI
72     static String storageId(Storage&);
73     static RefPtr<Inspector::Protocol::DOMStorage::StorageId> storageId(SecurityOrigin*, bool isLocalStorage);
74
75 private:
76     RefPtr<StorageArea> findStorageArea(ErrorString&, const JSON::Object&, Frame*&);
77
78     std::unique_ptr<Inspector::DOMStorageFrontendDispatcher> m_frontendDispatcher;
79     RefPtr<Inspector::DOMStorageBackendDispatcher> m_backendDispatcher;
80
81     Page& m_inspectedPage;
82 };
83
84 } // namespace WebCore