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