Misc Inspector backend cleanup
[WebKit-https.git] / Source / WebCore / inspector / InspectorDOMAgent.h
1 /*
2  * Copyright (C) 2009, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google 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 "EventTarget.h"
33 #include "InspectorWebAgentBase.h"
34 #include <inspector/InspectorBackendDispatchers.h>
35 #include <inspector/InspectorFrontendDispatchers.h>
36 #include <inspector/InspectorValues.h>
37 #include <wtf/HashMap.h>
38 #include <wtf/HashSet.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/AtomicString.h>
42
43 namespace Inspector {
44 class InjectedScriptManager;
45 }
46
47 namespace JSC {
48 class ExecState;
49 class JSValue;
50 }
51
52 namespace WebCore {
53     
54 class AccessibilityObject;
55 class CharacterData;
56 class DOMEditor;
57 class Document;
58 class Element;
59 class Event;
60 class Exception;
61 class FloatQuad;
62 class Frame;
63 class InspectorHistory;
64 class InspectorOverlay;
65 class InspectorPageAgent;
66 class HitTestResult;
67 class Node;
68 class PseudoElement;
69 class RevalidateStyleAttributeTask;
70 class ShadowRoot;
71
72 struct HighlightConfig;
73
74 typedef String ErrorString;
75 typedef int BackendNodeId;
76
77 struct EventListenerInfo {
78     EventListenerInfo(Node* node, const AtomicString& eventType, EventListenerVector&& eventListenerVector)
79         : node(node)
80         , eventType(eventType)
81         , eventListenerVector(WTFMove(eventListenerVector))
82     {
83     }
84
85     Node* node;
86     const AtomicString eventType;
87     const EventListenerVector eventListenerVector;
88 };
89
90 class InspectorDOMAgent final : public InspectorAgentBase, public Inspector::DOMBackendDispatcherHandler {
91     WTF_MAKE_NONCOPYABLE(InspectorDOMAgent);
92     WTF_MAKE_FAST_ALLOCATED;
93 public:
94     struct DOMListener {
95         virtual ~DOMListener()
96         {
97         }
98         virtual void didRemoveDocument(Document*) = 0;
99         virtual void didRemoveDOMNode(Node*) = 0;
100         virtual void didModifyDOMAttr(Element*) = 0;
101     };
102
103     InspectorDOMAgent(WebAgentContext&, InspectorPageAgent*, InspectorOverlay*);
104     virtual ~InspectorDOMAgent();
105
106     static String toErrorString(ExceptionCode);
107     static String toErrorString(Exception&&);
108
109     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
110     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
111
112     Vector<Document*> documents();
113     void reset();
114
115     // Methods called from the frontend for DOM nodes inspection.
116     void querySelector(ErrorString&, int nodeId, const String& selectors, int* elementId) override;
117     void querySelectorAll(ErrorString&, int nodeId, const String& selectors, RefPtr<Inspector::Protocol::Array<int>>& result) override;
118     void getDocument(ErrorString&, RefPtr<Inspector::Protocol::DOM::Node>& root) override;
119     void requestChildNodes(ErrorString&, int nodeId, const int* depth) override;
120     void setAttributeValue(ErrorString&, int elementId, const String& name, const String& value) override;
121     void setAttributesAsText(ErrorString&, int elementId, const String& text, const String* name) override;
122     void removeAttribute(ErrorString&, int elementId, const String& name) override;
123     void removeNode(ErrorString&, int nodeId) override;
124     void setNodeName(ErrorString&, int nodeId, const String& name, int* newId) override;
125     void getOuterHTML(ErrorString&, int nodeId, WTF::String* outerHTML) override;
126     void setOuterHTML(ErrorString&, int nodeId, const String& outerHTML) override;
127     void setNodeValue(ErrorString&, int nodeId, const String& value) override;
128     void getEventListenersForNode(ErrorString&, int nodeId, const WTF::String* objectGroup, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::DOM::EventListener>>& listenersArray) override;
129     void getAccessibilityPropertiesForNode(ErrorString&, int nodeId, RefPtr<Inspector::Protocol::DOM::AccessibilityProperties>& axProperties) override;
130     void performSearch(ErrorString&, const String& whitespaceTrimmedQuery, const Inspector::InspectorArray* nodeIds, String* searchId, int* resultCount) override;
131     void getSearchResults(ErrorString&, const String& searchId, int fromIndex, int toIndex, RefPtr<Inspector::Protocol::Array<int>>&) override;
132     void discardSearchResults(ErrorString&, const String& searchId) override;
133     void resolveNode(ErrorString&, int nodeId, const String* objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result) override;
134     void getAttributes(ErrorString&, int nodeId, RefPtr<Inspector::Protocol::Array<String>>& result) override;
135     void setInspectModeEnabled(ErrorString&, bool enabled, const Inspector::InspectorObject* highlightConfig) override;
136     void requestNode(ErrorString&, const String& objectId, int* nodeId) override;
137     void pushNodeByPathToFrontend(ErrorString&, const String& path, int* nodeId) override;
138     void pushNodeByBackendIdToFrontend(ErrorString&, BackendNodeId, int* nodeId) override;
139     void releaseBackendNodeIds(ErrorString&, const String& nodeGroup) override;
140     void hideHighlight(ErrorString&) override;
141     void highlightRect(ErrorString&, int x, int y, int width, int height, const Inspector::InspectorObject* color, const Inspector::InspectorObject* outlineColor, const bool* usePageCoordinates) override;
142     void highlightQuad(ErrorString&, const Inspector::InspectorArray& quad, const Inspector::InspectorObject* color, const Inspector::InspectorObject* outlineColor, const bool* usePageCoordinates) override;
143     void highlightSelector(ErrorString&, const Inspector::InspectorObject& highlightConfig, const String& selectorString, const String* frameId) override;
144     void highlightNode(ErrorString&, const Inspector::InspectorObject& highlightConfig, const int* nodeId, const String* objectId) override;
145     void highlightFrame(ErrorString&, const String& frameId, const Inspector::InspectorObject* color, const Inspector::InspectorObject* outlineColor) override;
146
147     void moveTo(ErrorString&, int nodeId, int targetNodeId, const int* anchorNodeId, int* newNodeId) override;
148     void undo(ErrorString&) override;
149     void redo(ErrorString&) override;
150     void markUndoableState(ErrorString&) override;
151     void focus(ErrorString&, int nodeId) override;
152
153     void getEventListeners(Node*, Vector<EventListenerInfo>& listenersArray, bool includeAncestors);
154
155
156     // InspectorInstrumentation
157     void didInsertDOMNode(Node&);
158     void didRemoveDOMNode(Node&);
159     void willModifyDOMAttr(Element&, const AtomicString& oldValue, const AtomicString& newValue);
160     void didModifyDOMAttr(Element&, const AtomicString& name, const AtomicString& value);
161     void didRemoveDOMAttr(Element&, const AtomicString& name);
162     void characterDataModified(CharacterData&);
163     void didInvalidateStyleAttr(Node&);
164     void didPushShadowRoot(Element& host, ShadowRoot&);
165     void willPopShadowRoot(Element& host, ShadowRoot&);
166     void didChangeCustomElementState(Element&);
167     bool handleTouchEvent(Node&);
168     void didCommitLoad(Document*);
169     void frameDocumentUpdated(Frame&);
170     void pseudoElementCreated(PseudoElement&);
171     void pseudoElementDestroyed(PseudoElement&);
172
173     // Callbacks that don't directly correspond to an instrumentation entry point.
174     void setDocument(Document*);
175     void releaseDanglingNodes();
176     void mainFrameDOMContentLoaded();
177
178     void styleAttributeInvalidated(const Vector<Element*>& elements);
179
180     int pushNodeToFrontend(ErrorString&, int documentNodeId, Node*);
181     Node* nodeForId(int nodeId);
182     int boundNodeId(const Node*);
183     void setDOMListener(DOMListener*);
184     BackendNodeId backendNodeIdForNode(Node*, const String& nodeGroup);
185
186     static String documentURLString(Document*);
187
188     RefPtr<Inspector::Protocol::Runtime::RemoteObject> resolveNode(Node*, const String& objectGroup);
189     bool handleMousePress();
190     void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
191     void inspect(Node*);
192     void focusNode();
193
194     InspectorHistory* history() { return m_history.get(); }
195
196     // We represent embedded doms as a part of the same hierarchy. Hence we treat children of frame owners differently.
197     // We also skip whitespace text nodes conditionally. Following methods encapsulate these specifics.
198     static Node* innerFirstChild(Node*);
199     static Node* innerNextSibling(Node*);
200     static Node* innerPreviousSibling(Node*);
201     static unsigned innerChildNodeCount(Node*);
202     static Node* innerParentNode(Node*);
203     static bool isWhitespace(Node*);
204
205     Node* assertNode(ErrorString&, int nodeId);
206     Element* assertElement(ErrorString&, int nodeId);
207     Document* assertDocument(ErrorString&, int nodeId);
208
209     static Node* scriptValueAsNode(JSC::JSValue);
210     static JSC::JSValue nodeAsScriptValue(JSC::ExecState&, Node*);
211
212     // Methods called from other agents.
213     InspectorPageAgent* pageAgent() { return m_pageAgent; }
214
215 private:
216     void highlightMousedOverNode();
217     void setSearchingForNode(ErrorString&, bool enabled, const Inspector::InspectorObject* highlightConfig);
218     std::unique_ptr<HighlightConfig> highlightConfigFromInspectorObject(ErrorString&, const Inspector::InspectorObject* highlightInspectorObject);
219
220     // Node-related methods.
221     typedef HashMap<RefPtr<Node>, int> NodeToIdMap;
222     int bind(Node*, NodeToIdMap*);
223     void unbind(Node*, NodeToIdMap*);
224
225     Node* assertEditableNode(ErrorString&, int nodeId);
226     Element* assertEditableElement(ErrorString&, int nodeId);
227
228     int pushNodePathToFrontend(Node*);
229     void pushChildNodesToFrontend(int nodeId, int depth = 1);
230
231     bool hasBreakpoint(Node*, int type);
232     void updateSubtreeBreakpoints(Node* root, uint32_t rootMask, bool value);
233
234     Ref<Inspector::Protocol::DOM::Node> buildObjectForNode(Node*, int depth, NodeToIdMap*);
235     Ref<Inspector::Protocol::Array<String>> buildArrayForElementAttributes(Element*);
236     Ref<Inspector::Protocol::Array<Inspector::Protocol::DOM::Node>> buildArrayForContainerChildren(Node* container, int depth, NodeToIdMap* nodesMap);
237     RefPtr<Inspector::Protocol::Array<Inspector::Protocol::DOM::Node>> buildArrayForPseudoElements(const Element&, NodeToIdMap* nodesMap);
238     Ref<Inspector::Protocol::DOM::EventListener> buildObjectForEventListener(const RegisteredEventListener&, const AtomicString& eventType, Node*, const String* objectGroupId);
239     RefPtr<Inspector::Protocol::DOM::AccessibilityProperties> buildObjectForAccessibilityProperties(Node*);
240     void processAccessibilityChildren(RefPtr<AccessibilityObject>&&, RefPtr<Inspector::Protocol::Array<int>>&&);
241     
242     Node* nodeForPath(const String& path);
243     Node* nodeForObjectId(const String& objectId);
244
245     void discardBindings();
246
247     void innerHighlightQuad(std::unique_ptr<FloatQuad>, const Inspector::InspectorObject* color, const Inspector::InspectorObject* outlineColor, const bool* usePageCoordinates);
248
249     Inspector::InjectedScriptManager& m_injectedScriptManager;
250     std::unique_ptr<Inspector::DOMFrontendDispatcher> m_frontendDispatcher;
251     RefPtr<Inspector::DOMBackendDispatcher> m_backendDispatcher;
252     InspectorPageAgent* m_pageAgent { nullptr };
253
254     InspectorOverlay* m_overlay { nullptr };
255     DOMListener* m_domListener { nullptr };
256     NodeToIdMap m_documentNodeToIdMap;
257     typedef HashMap<RefPtr<Node>, BackendNodeId> NodeToBackendIdMap;
258     HashMap<String, NodeToBackendIdMap> m_nodeGroupToBackendIdMap;
259     // Owns node mappings for dangling nodes.
260     Vector<std::unique_ptr<NodeToIdMap>> m_danglingNodeToIdMaps;
261     HashMap<int, Node*> m_idToNode;
262     HashMap<int, NodeToIdMap*> m_idToNodesMap;
263     HashSet<int> m_childrenRequested;
264     HashMap<BackendNodeId, std::pair<Node*, String>> m_backendIdToNode;
265     int m_lastNodeId { 1 };
266     BackendNodeId m_lastBackendNodeId { -1 };
267     RefPtr<Document> m_document;
268     typedef HashMap<String, Vector<RefPtr<Node>>> SearchResults;
269     SearchResults m_searchResults;
270     std::unique_ptr<RevalidateStyleAttributeTask> m_revalidateStyleAttrTask;
271     RefPtr<Node> m_nodeToFocus;
272     RefPtr<Node> m_mousedOverNode;
273     std::unique_ptr<HighlightConfig> m_inspectModeHighlightConfig;
274     std::unique_ptr<InspectorHistory> m_history;
275     std::unique_ptr<DOMEditor> m_domEditor;
276     bool m_searchingForNode { false };
277     bool m_suppressAttributeModifiedEvent { false };
278     bool m_documentRequested { false };
279 };
280
281 } // namespace WebCore