459cb36943c4240b9f7d48ac340c8e471143debb
[WebKit-https.git] / Source / WebCore / inspector / agents / InspectorDOMDebuggerAgent.h
1 /*
2  * Copyright (C) 2011 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "InspectorWebAgentBase.h"
35 #include <JavaScriptCore/InspectorBackendDispatchers.h>
36 #include <JavaScriptCore/InspectorDebuggerAgent.h>
37 #include <wtf/HashMap.h>
38 #include <wtf/JSONValues.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace WebCore {
42
43 class Element;
44 class Event;
45 class Frame;
46 class InspectorDOMAgent;
47 class Node;
48 class RegisteredEventListener;
49
50 typedef String ErrorString;
51
52 class InspectorDOMDebuggerAgent final : public InspectorAgentBase, public Inspector::InspectorDebuggerAgent::Listener, public Inspector::DOMDebuggerBackendDispatcherHandler {
53     WTF_MAKE_NONCOPYABLE(InspectorDOMDebuggerAgent);
54     WTF_MAKE_FAST_ALLOCATED;
55 public:
56     InspectorDOMDebuggerAgent(WebAgentContext&, InspectorDOMAgent*, Inspector::InspectorDebuggerAgent*);
57     virtual ~InspectorDOMDebuggerAgent();
58
59     // DOMDebugger API
60     void setURLBreakpoint(ErrorString&, const String& url, const bool* optionalIsRegex) final;
61     void removeURLBreakpoint(ErrorString&, const String& url) final;
62     void setEventBreakpoint(ErrorString&, const String& breakpointType, const String& eventName) final;
63     void removeEventBreakpoint(ErrorString&, const String& breakpointType, const String& eventName) final;
64     void setDOMBreakpoint(ErrorString&, int nodeId, const String& type) final;
65     void removeDOMBreakpoint(ErrorString&, int nodeId, const String& type) final;
66
67     // InspectorInstrumentation
68     void willInsertDOMNode(Node& parent);
69     void didInvalidateStyleAttr(Node&);
70     void didInsertDOMNode(Node&);
71     void willRemoveDOMNode(Node&);
72     void didRemoveDOMNode(Node&);
73     void willModifyDOMAttr(Element&);
74     void willSendXMLHttpRequest(const String& url);
75     void willFetch(const String& url);
76     void frameDocumentUpdated(Frame&);
77     void willHandleEvent(const Event&, const RegisteredEventListener&);
78     void willFireTimer(bool oneShot);
79     void willFireAnimationFrame();
80     void mainFrameDOMContentLoaded();
81
82     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) final;
83     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) final;
84     void discardAgent() final;
85
86 private:
87     // Inspector::InspectorDebuggerAgent::Listener implementation.
88     void debuggerWasEnabled() final;
89     void debuggerWasDisabled() final;
90     void disable();
91
92     enum class URLBreakpointSource { Fetch, XHR };
93     void breakOnURLIfNeeded(const String& url, URLBreakpointSource);
94
95     void descriptionForDOMEvent(Node& target, int breakpointType, bool insertion, JSON::Object& description);
96     void updateSubtreeBreakpoints(Node*, uint32_t rootMask, bool set);
97     bool hasBreakpoint(Node*, int type);
98     void discardBindings();
99
100     RefPtr<Inspector::DOMDebuggerBackendDispatcher> m_backendDispatcher;
101     InspectorDOMAgent* m_domAgent { nullptr };
102     Inspector::InspectorDebuggerAgent* m_debuggerAgent { nullptr };
103
104     HashMap<Node*, uint32_t> m_domBreakpoints;
105
106     using EventBreakpointType = Inspector::Protocol::DOMDebugger::EventBreakpointType;
107     HashSet<std::pair<EventBreakpointType, String>,
108         WTF::PairHash<EventBreakpointType, String>,
109         WTF::PairHashTraits<WTF::StrongEnumHashTraits<EventBreakpointType>, WTF::HashTraits<String>>
110     > m_eventBreakpoints;
111
112     enum class URLBreakpointType { RegularExpression, Text };
113     HashMap<String, URLBreakpointType> m_urlBreakpoints;
114     bool m_pauseOnAllURLsEnabled { false };
115 };
116
117 } // namespace WebCore