Web Inspector: Remove InspectorState
[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 "InjectedScript.h"
35 #include "InjectedScriptManager.h"
36 #include "InspectorBaseAgent.h"
37 #include "InspectorFrontend.h"
38 #include "InspectorOverlay.h"
39 #include "InspectorValues.h"
40 #include "RenderLayer.h"
41 #include "Timer.h"
42
43 #include <wtf/Deque.h>
44 #include <wtf/ListHashSet.h>
45 #include <wtf/HashMap.h>
46 #include <wtf/HashSet.h>
47 #include <wtf/OwnPtr.h>
48 #include <wtf/PassOwnPtr.h>
49 #include <wtf/RefPtr.h>
50 #include <wtf/Vector.h>
51 #include <wtf/text/AtomicString.h>
52
53 namespace WebCore {
54 class ContainerNode;
55 class CharacterData;
56 class DOMEditor;
57 class Document;
58 class Element;
59 class Event;
60 class InspectorClient;
61 class InspectorFrontend;
62 class InspectorHistory;
63 class InspectorOverlay;
64 class InspectorPageAgent;
65 class HitTestResult;
66 class HTMLElement;
67 class InstrumentingAgents;
68 class NameNodeMap;
69 class Node;
70 class RevalidateStyleAttributeTask;
71 class ScriptValue;
72 class ShadowRoot;
73
74 struct HighlightConfig;
75
76 typedef String ErrorString;
77 typedef int BackendNodeId;
78
79 #if ENABLE(INSPECTOR)
80
81 struct EventListenerInfo {
82     EventListenerInfo(Node* node, const AtomicString& eventType, const EventListenerVector& eventListenerVector)
83         : node(node)
84         , eventType(eventType)
85         , eventListenerVector(eventListenerVector)
86     {
87     }
88
89     Node* node;
90     const AtomicString eventType;
91     const EventListenerVector eventListenerVector;
92 };
93
94 class InspectorDOMAgent : public InspectorBaseAgent<InspectorDOMAgent>, public InspectorBackendDispatcher::DOMCommandHandler {
95     WTF_MAKE_NONCOPYABLE(InspectorDOMAgent);
96 public:
97     struct DOMListener {
98         virtual ~DOMListener()
99         {
100         }
101         virtual void didRemoveDocument(Document*) = 0;
102         virtual void didRemoveDOMNode(Node*) = 0;
103         virtual void didModifyDOMAttr(Element*) = 0;
104     };
105
106     static PassOwnPtr<InspectorDOMAgent> create(InstrumentingAgents* instrumentingAgents, InspectorPageAgent* pageAgent, InjectedScriptManager* injectedScriptManager, InspectorOverlay* overlay, InspectorClient* client)
107     {
108         return adoptPtr(new InspectorDOMAgent(instrumentingAgents, pageAgent, injectedScriptManager, overlay, client));
109     }
110
111     static String toErrorString(const ExceptionCode&);
112
113     ~InspectorDOMAgent();
114
115     virtual void setFrontend(InspectorFrontend*);
116     virtual void clearFrontend();
117
118     Vector<Document*> documents();
119     void reset();
120
121     // Methods called from the frontend for DOM nodes inspection.
122     virtual void querySelector(ErrorString*, int nodeId, const String& selectors, int* elementId);
123     virtual void querySelectorAll(ErrorString*, int nodeId, const String& selectors, RefPtr<TypeBuilder::Array<int>>& result);
124     virtual void getDocument(ErrorString*, RefPtr<TypeBuilder::DOM::Node>& root);
125     virtual void requestChildNodes(ErrorString*, int nodeId, const int* depth);
126     virtual void setAttributeValue(ErrorString*, int elementId, const String& name, const String& value);
127     virtual void setAttributesAsText(ErrorString*, int elementId, const String& text, const String* name);
128     virtual void removeAttribute(ErrorString*, int elementId, const String& name);
129     virtual void removeNode(ErrorString*, int nodeId);
130     virtual void setNodeName(ErrorString*, int nodeId, const String& name, int* newId);
131     virtual void getOuterHTML(ErrorString*, int nodeId, WTF::String* outerHTML);
132     virtual void setOuterHTML(ErrorString*, int nodeId, const String& outerHTML);
133     virtual void setNodeValue(ErrorString*, int nodeId, const String& value);
134     virtual void getEventListenersForNode(ErrorString*, int nodeId, const WTF::String* objectGroup, RefPtr<TypeBuilder::Array<TypeBuilder::DOM::EventListener>>& listenersArray);
135     virtual void performSearch(ErrorString*, const String& whitespaceTrimmedQuery, String* searchId, int* resultCount);
136     virtual void getSearchResults(ErrorString*, const String& searchId, int fromIndex, int toIndex, RefPtr<TypeBuilder::Array<int>>&);
137     virtual void discardSearchResults(ErrorString*, const String& searchId);
138     virtual void resolveNode(ErrorString*, int nodeId, const String* objectGroup, RefPtr<TypeBuilder::Runtime::RemoteObject>& result);
139     virtual void getAttributes(ErrorString*, int nodeId, RefPtr<TypeBuilder::Array<String>>& result);
140     virtual void setInspectModeEnabled(ErrorString*, bool enabled, const RefPtr<InspectorObject>* highlightConfig);
141     virtual void requestNode(ErrorString*, const String& objectId, int* nodeId);
142     virtual void pushNodeByPathToFrontend(ErrorString*, const String& path, int* nodeId);
143     virtual void pushNodeByBackendIdToFrontend(ErrorString*, BackendNodeId, int* nodeId);
144     virtual void releaseBackendNodeIds(ErrorString*, const String& nodeGroup);
145     virtual void hideHighlight(ErrorString*);
146     virtual void highlightRect(ErrorString*, int x, int y, int width, int height, const RefPtr<InspectorObject>* color, const RefPtr<InspectorObject>* outlineColor, const bool* usePageCoordinates);
147     virtual void highlightQuad(ErrorString*, const RefPtr<InspectorArray>& quad, const RefPtr<InspectorObject>* color, const RefPtr<InspectorObject>* outlineColor, const bool* usePageCoordinates);
148     virtual void highlightNode(ErrorString*, const RefPtr<InspectorObject>& highlightConfig, const int* nodeId, const String* objectId);
149     virtual void highlightFrame(ErrorString*, const String& frameId, const RefPtr<InspectorObject>* color, const RefPtr<InspectorObject>* outlineColor);
150
151     virtual void moveTo(ErrorString*, int nodeId, int targetNodeId, const int* anchorNodeId, int* newNodeId);
152     virtual void undo(ErrorString*);
153     virtual void redo(ErrorString*);
154     virtual void markUndoableState(ErrorString*);
155     virtual void focus(ErrorString*, int nodeId);
156     virtual void setFileInputFiles(ErrorString*, int nodeId, const RefPtr<InspectorArray>& files);
157
158     void getEventListeners(Node*, Vector<EventListenerInfo>& listenersArray, bool includeAncestors);
159
160     // Methods called from the InspectorInstrumentation.
161     void setDocument(Document*);
162     void releaseDanglingNodes();
163
164     void mainFrameDOMContentLoaded();
165     void didCommitLoad(Document*);
166
167     void didInsertDOMNode(Node*);
168     void didRemoveDOMNode(Node*);
169     void willModifyDOMAttr(Element*, const AtomicString& oldValue, const AtomicString& newValue);
170     void didModifyDOMAttr(Element*, const AtomicString& name, const AtomicString& value);
171     void didRemoveDOMAttr(Element*, const AtomicString& name);
172     void styleAttributeInvalidated(const Vector<Element*>& elements);
173     void characterDataModified(CharacterData*);
174     void didInvalidateStyleAttr(Node*);
175     void didPushShadowRoot(Element* host, ShadowRoot*);
176     void willPopShadowRoot(Element* host, ShadowRoot*);
177     void frameDocumentUpdated(Frame*);
178
179     int pushNodeToFrontend(ErrorString*, int documentNodeId, Node*);
180     Node* nodeForId(int nodeId);
181     int boundNodeId(Node*);
182     void setDOMListener(DOMListener*);
183     BackendNodeId backendNodeIdForNode(Node*, const String& nodeGroup);
184
185     static String documentURLString(Document*);
186
187     PassRefPtr<TypeBuilder::Runtime::RemoteObject> resolveNode(Node*, const String& objectGroup);
188     bool handleMousePress();
189     bool handleTouchEvent(Node*);
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     // Methods called from other agents.
210     InspectorPageAgent* pageAgent() { return m_pageAgent; }
211
212 private:
213     InspectorDOMAgent(InstrumentingAgents*, InspectorPageAgent*, InjectedScriptManager*, InspectorOverlay*, InspectorClient*);
214
215     void setSearchingForNode(ErrorString*, bool enabled, InspectorObject* highlightConfig);
216     PassOwnPtr<HighlightConfig> highlightConfigFromInspectorObject(ErrorString*, InspectorObject* highlightInspectorObject);
217
218     // Node-related methods.
219     typedef HashMap<RefPtr<Node>, int> NodeToIdMap;
220     int bind(Node*, NodeToIdMap*);
221     void unbind(Node*, NodeToIdMap*);
222
223     Node* assertEditableNode(ErrorString*, int nodeId);
224     Element* assertEditableElement(ErrorString*, int nodeId);
225
226     int pushNodePathToFrontend(Node*);
227     void pushChildNodesToFrontend(int nodeId, int depth = 1);
228
229     bool hasBreakpoint(Node*, int type);
230     void updateSubtreeBreakpoints(Node* root, uint32_t rootMask, bool value);
231     void descriptionForDOMEvent(Node* target, int breakpointType, bool insertion, PassRefPtr<InspectorObject> description);
232
233     PassRefPtr<TypeBuilder::DOM::Node> buildObjectForNode(Node*, int depth, NodeToIdMap*);
234     PassRefPtr<TypeBuilder::Array<String>> buildArrayForElementAttributes(Element*);
235     PassRefPtr<TypeBuilder::Array<TypeBuilder::DOM::Node>> buildArrayForContainerChildren(Node* container, int depth, NodeToIdMap* nodesMap);
236     PassRefPtr<TypeBuilder::DOM::EventListener> buildObjectForEventListener(const RegisteredEventListener&, const AtomicString& eventType, Node*, const String* objectGroupId);
237
238     Node* nodeForPath(const String& path);
239
240     void discardBindings();
241
242     void innerHighlightQuad(PassOwnPtr<FloatQuad>, const RefPtr<InspectorObject>* color, const RefPtr<InspectorObject>* outlineColor, const bool* usePageCoordinates);
243
244     InspectorPageAgent* m_pageAgent;
245     InjectedScriptManager* m_injectedScriptManager;
246     InspectorOverlay* m_overlay;
247     InspectorClient* m_client;
248     InspectorFrontend::DOM* m_frontend;
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)