Web Inspector: Provide $event in the console when paused on an event listener
[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 Inspector {
42 class InjectedScriptManager;
43 }
44
45 namespace WebCore {
46
47 class Element;
48 class Event;
49 class Frame;
50 class InspectorDOMAgent;
51 class Node;
52 class RegisteredEventListener;
53
54 typedef String ErrorString;
55
56 class InspectorDOMDebuggerAgent final : public InspectorAgentBase, public Inspector::InspectorDebuggerAgent::Listener, public Inspector::DOMDebuggerBackendDispatcherHandler {
57     WTF_MAKE_NONCOPYABLE(InspectorDOMDebuggerAgent);
58     WTF_MAKE_FAST_ALLOCATED;
59 public:
60     InspectorDOMDebuggerAgent(WebAgentContext&, InspectorDOMAgent*, Inspector::InspectorDebuggerAgent*);
61     virtual ~InspectorDOMDebuggerAgent();
62
63     // DOMDebugger API
64     void setURLBreakpoint(ErrorString&, const String& url, const bool* optionalIsRegex) final;
65     void removeURLBreakpoint(ErrorString&, const String& url) final;
66     void setEventBreakpoint(ErrorString&, const String& breakpointType, const String& eventName) final;
67     void removeEventBreakpoint(ErrorString&, const String& breakpointType, const String& eventName) final;
68     void setDOMBreakpoint(ErrorString&, int nodeId, const String& type) final;
69     void removeDOMBreakpoint(ErrorString&, int nodeId, const String& type) final;
70
71     // InspectorInstrumentation
72     void willInsertDOMNode(Node& parent);
73     void didInvalidateStyleAttr(Node&);
74     void didInsertDOMNode(Node&);
75     void willRemoveDOMNode(Node&);
76     void didRemoveDOMNode(Node&);
77     void willModifyDOMAttr(Element&);
78     void willSendXMLHttpRequest(const String& url);
79     void willFetch(const String& url);
80     void frameDocumentUpdated(Frame&);
81     void willHandleEvent(Event&, const RegisteredEventListener&);
82     void didHandleEvent();
83     void willFireTimer(bool oneShot);
84     void willFireAnimationFrame();
85     void mainFrameDOMContentLoaded();
86
87     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) final;
88     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) final;
89     void discardAgent() final;
90
91 private:
92     // Inspector::InspectorDebuggerAgent::Listener implementation.
93     void debuggerWasEnabled() final;
94     void debuggerWasDisabled() final;
95     void disable();
96
97     enum class URLBreakpointSource { Fetch, XHR };
98     void breakOnURLIfNeeded(const String& url, URLBreakpointSource);
99
100     void descriptionForDOMEvent(Node& target, int breakpointType, bool insertion, JSON::Object& description);
101     void updateSubtreeBreakpoints(Node*, uint32_t rootMask, bool set);
102     bool hasBreakpoint(Node*, int type);
103     void discardBindings();
104
105     RefPtr<Inspector::DOMDebuggerBackendDispatcher> m_backendDispatcher;
106     Inspector::InjectedScriptManager& m_injectedScriptManager;
107     InspectorDOMAgent* m_domAgent { nullptr };
108     Inspector::InspectorDebuggerAgent* m_debuggerAgent { nullptr };
109
110     HashMap<Node*, uint32_t> m_domBreakpoints;
111
112     using EventBreakpointType = Inspector::Protocol::DOMDebugger::EventBreakpointType;
113     HashSet<std::pair<EventBreakpointType, String>,
114         WTF::PairHash<EventBreakpointType, String>,
115         WTF::PairHashTraits<WTF::StrongEnumHashTraits<EventBreakpointType>, WTF::HashTraits<String>>
116     > m_eventBreakpoints;
117
118     enum class URLBreakpointType { RegularExpression, Text };
119     HashMap<String, URLBreakpointType> m_urlBreakpoints;
120     bool m_pauseOnAllURLsEnabled { false };
121 };
122
123 } // namespace WebCore