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