1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/*
* Copyright (C) 2009, 2015-2016 Apple Inc. All rights reserved.
* Copyright (C) 2011 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Apple Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "EventTarget.h"
#include "InspectorWebAgentBase.h"
#include <inspector/InspectorBackendDispatchers.h>
#include <inspector/InspectorFrontendDispatchers.h>
#include <wtf/HashMap.h>
#include <wtf/HashSet.h>
#include <wtf/JSONValues.h>
#include <wtf/RefPtr.h>
#include <wtf/Vector.h>
#include <wtf/text/AtomicString.h>
namespace Inspector {
class InjectedScriptManager;
}
namespace JSC {
class ExecState;
class JSValue;
}
namespace WebCore {
class AccessibilityObject;
class CharacterData;
class DOMEditor;
class Document;
class Element;
class Event;
class Exception;
class FloatQuad;
class Frame;
class InspectorHistory;
class InspectorOverlay;
class InspectorPageAgent;
class HitTestResult;
class Node;
class PseudoElement;
class RevalidateStyleAttributeTask;
class ShadowRoot;
struct HighlightConfig;
typedef String ErrorString;
typedef int BackendNodeId;
struct EventListenerInfo {
EventListenerInfo(Node* node, const AtomicString& eventType, EventListenerVector&& eventListenerVector)
: node(node)
, eventType(eventType)
, eventListenerVector(WTFMove(eventListenerVector))
{
}
Node* node;
const AtomicString eventType;
const EventListenerVector eventListenerVector;
};
class InspectorDOMAgent final : public InspectorAgentBase, public Inspector::DOMBackendDispatcherHandler {
WTF_MAKE_NONCOPYABLE(InspectorDOMAgent);
WTF_MAKE_FAST_ALLOCATED;
public:
struct DOMListener {
virtual ~DOMListener() { }
virtual void didRemoveDOMNode(Node&, int nodeId) = 0;
virtual void didModifyDOMAttr(Element&) = 0;
};
InspectorDOMAgent(WebAgentContext&, InspectorPageAgent*, InspectorOverlay*);
virtual ~InspectorDOMAgent();
static String toErrorString(ExceptionCode);
static String toErrorString(Exception&&);
void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
Vector<Document*> documents();
void reset();
// Methods called from the frontend for DOM nodes inspection.
void querySelector(ErrorString&, int nodeId, const String& selectors, int* elementId) override;
void querySelectorAll(ErrorString&, int nodeId, const String& selectors, RefPtr<Inspector::Protocol::Array<int>>& result) override;
void getDocument(ErrorString&, RefPtr<Inspector::Protocol::DOM::Node>& root) override;
void requestChildNodes(ErrorString&, int nodeId, const int* const depth) override;
void setAttributeValue(ErrorString&, int elementId, const String& name, const String& value) override;
void setAttributesAsText(ErrorString&, int elementId, const String& text, const String* const name) override;
void removeAttribute(ErrorString&, int elementId, const String& name) override;
void removeNode(ErrorString&, int nodeId) override;
void setNodeName(ErrorString&, int nodeId, const String& name, int* newId) override;
void getOuterHTML(ErrorString&, int nodeId, WTF::String* outerHTML) override;
void setOuterHTML(ErrorString&, int nodeId, const String& outerHTML) override;
void setNodeValue(ErrorString&, int nodeId, const String& value) override;
void getEventListenersForNode(ErrorString&, int nodeId, const WTF::String* const objectGroup, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::DOM::EventListener>>& listenersArray) override;
void getAccessibilityPropertiesForNode(ErrorString&, int nodeId, RefPtr<Inspector::Protocol::DOM::AccessibilityProperties>& axProperties) override;
void performSearch(ErrorString&, const String& whitespaceTrimmedQuery, const JSON::Array* nodeIds, String* searchId, int* resultCount) override;
void getSearchResults(ErrorString&, const String& searchId, int fromIndex, int toIndex, RefPtr<Inspector::Protocol::Array<int>>&) override;
void discardSearchResults(ErrorString&, const String& searchId) override;
void resolveNode(ErrorString&, int nodeId, const String* const objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result) override;
void getAttributes(ErrorString&, int nodeId, RefPtr<Inspector::Protocol::Array<String>>& result) override;
void setInspectModeEnabled(ErrorString&, bool enabled, const JSON::Object* highlightConfig) override;
void requestNode(ErrorString&, const String& objectId, int* nodeId) override;
void pushNodeByPathToFrontend(ErrorString&, const String& path, int* nodeId) override;
void pushNodeByBackendIdToFrontend(ErrorString&, BackendNodeId, int* nodeId) override;
void releaseBackendNodeIds(ErrorString&, const String& nodeGroup) override;
void hideHighlight(ErrorString&) override;
void highlightRect(ErrorString&, int x, int y, int width, int height, const JSON::Object* color, const JSON::Object* outlineColor, const bool* const usePageCoordinates) override;
void highlightQuad(ErrorString&, const JSON::Array& quad, const JSON::Object* color, const JSON::Object* outlineColor, const bool* const usePageCoordinates) override;
void highlightSelector(ErrorString&, const JSON::Object& highlightConfig, const String& selectorString, const String* const frameId) override;
void highlightNode(ErrorString&, const JSON::Object& highlightConfig, const int* const nodeId, const String* const objectId) override;
void highlightNodeList(ErrorString&, const JSON::Array& nodeIds, const JSON::Object& highlightConfig) override;
void highlightFrame(ErrorString&, const String& frameId, const JSON::Object* color, const JSON::Object* outlineColor) override;
void moveTo(ErrorString&, int nodeId, int targetNodeId, const int* const anchorNodeId, int* newNodeId) override;
void undo(ErrorString&) override;
void redo(ErrorString&) override;
void markUndoableState(ErrorString&) override;
void focus(ErrorString&, int nodeId) override;
void getEventListeners(Node*, Vector<EventListenerInfo>& listenersArray, bool includeAncestors);
// InspectorInstrumentation
void didInsertDOMNode(Node&);
void didRemoveDOMNode(Node&);
void willModifyDOMAttr(Element&, const AtomicString& oldValue, const AtomicString& newValue);
void didModifyDOMAttr(Element&, const AtomicString& name, const AtomicString& value);
void didRemoveDOMAttr(Element&, const AtomicString& name);
void characterDataModified(CharacterData&);
void didInvalidateStyleAttr(Node&);
void didPushShadowRoot(Element& host, ShadowRoot&);
void willPopShadowRoot(Element& host, ShadowRoot&);
void didChangeCustomElementState(Element&);
bool handleTouchEvent(Node&);
void didCommitLoad(Document*);
void frameDocumentUpdated(Frame&);
void pseudoElementCreated(PseudoElement&);
void pseudoElementDestroyed(PseudoElement&);
// Callbacks that don't directly correspond to an instrumentation entry point.
void setDocument(Document*);
void releaseDanglingNodes();
void mainFrameDOMContentLoaded();
void styleAttributeInvalidated(const Vector<Element*>& elements);
int pushNodeToFrontend(ErrorString&, int documentNodeId, Node*);
Node* nodeForId(int nodeId);
int boundNodeId(const Node*);
void setDOMListener(DOMListener*);
BackendNodeId backendNodeIdForNode(Node*, const String& nodeGroup);
static String documentURLString(Document*);
RefPtr<Inspector::Protocol::Runtime::RemoteObject> resolveNode(Node*, const String& objectGroup);
bool handleMousePress();
void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
void inspect(Node*);
void focusNode();
InspectorHistory* history() { return m_history.get(); }
// We represent embedded doms as a part of the same hierarchy. Hence we treat children of frame owners differently.
// We also skip whitespace text nodes conditionally. Following methods encapsulate these specifics.
static Node* innerFirstChild(Node*);
static Node* innerNextSibling(Node*);
static Node* innerPreviousSibling(Node*);
static unsigned innerChildNodeCount(Node*);
static Node* innerParentNode(Node*);
static bool isWhitespace(Node*);
Node* assertNode(ErrorString&, int nodeId);
Element* assertElement(ErrorString&, int nodeId);
Document* assertDocument(ErrorString&, int nodeId);
static Node* scriptValueAsNode(JSC::JSValue);
static JSC::JSValue nodeAsScriptValue(JSC::ExecState&, Node*);
// Methods called from other agents.
InspectorPageAgent* pageAgent() { return m_pageAgent; }
private:
void highlightMousedOverNode();
void setSearchingForNode(ErrorString&, bool enabled, const JSON::Object* highlightConfig);
std::unique_ptr<HighlightConfig> highlightConfigFromInspectorObject(ErrorString&, const JSON::Object* highlightInspectorObject);
// Node-related methods.
typedef HashMap<RefPtr<Node>, int> NodeToIdMap;
int bind(Node*, NodeToIdMap*);
void unbind(Node*, NodeToIdMap*);
Node* assertEditableNode(ErrorString&, int nodeId);
Element* assertEditableElement(ErrorString&, int nodeId);
int pushNodePathToFrontend(Node*);
void pushChildNodesToFrontend(int nodeId, int depth = 1);
Ref<Inspector::Protocol::DOM::Node> buildObjectForNode(Node*, int depth, NodeToIdMap*);
Ref<Inspector::Protocol::Array<String>> buildArrayForElementAttributes(Element*);
Ref<Inspector::Protocol::Array<Inspector::Protocol::DOM::Node>> buildArrayForContainerChildren(Node* container, int depth, NodeToIdMap* nodesMap);
RefPtr<Inspector::Protocol::Array<Inspector::Protocol::DOM::Node>> buildArrayForPseudoElements(const Element&, NodeToIdMap* nodesMap);
Ref<Inspector::Protocol::DOM::EventListener> buildObjectForEventListener(const RegisteredEventListener&, const AtomicString& eventType, Node*, const String* objectGroupId);
RefPtr<Inspector::Protocol::DOM::AccessibilityProperties> buildObjectForAccessibilityProperties(Node*);
void processAccessibilityChildren(RefPtr<AccessibilityObject>&&, RefPtr<Inspector::Protocol::Array<int>>&&);
Node* nodeForPath(const String& path);
Node* nodeForObjectId(const String& objectId);
void discardBindings();
void innerHighlightQuad(std::unique_ptr<FloatQuad>, const JSON::Object* color, const JSON::Object* outlineColor, const bool* usePageCoordinates);
Inspector::InjectedScriptManager& m_injectedScriptManager;
std::unique_ptr<Inspector::DOMFrontendDispatcher> m_frontendDispatcher;
RefPtr<Inspector::DOMBackendDispatcher> m_backendDispatcher;
InspectorPageAgent* m_pageAgent { nullptr };
InspectorOverlay* m_overlay { nullptr };
DOMListener* m_domListener { nullptr };
NodeToIdMap m_documentNodeToIdMap;
typedef HashMap<RefPtr<Node>, BackendNodeId> NodeToBackendIdMap;
HashMap<String, NodeToBackendIdMap> m_nodeGroupToBackendIdMap;
// Owns node mappings for dangling nodes.
Vector<std::unique_ptr<NodeToIdMap>> m_danglingNodeToIdMaps;
HashMap<int, Node*> m_idToNode;
HashMap<int, NodeToIdMap*> m_idToNodesMap;
HashSet<int> m_childrenRequested;
HashMap<BackendNodeId, std::pair<Node*, String>> m_backendIdToNode;
int m_lastNodeId { 1 };
BackendNodeId m_lastBackendNodeId { -1 };
RefPtr<Document> m_document;
typedef HashMap<String, Vector<RefPtr<Node>>> SearchResults;
SearchResults m_searchResults;
std::unique_ptr<RevalidateStyleAttributeTask> m_revalidateStyleAttrTask;
RefPtr<Node> m_nodeToFocus;
RefPtr<Node> m_mousedOverNode;
std::unique_ptr<HighlightConfig> m_inspectModeHighlightConfig;
std::unique_ptr<InspectorHistory> m_history;
std::unique_ptr<DOMEditor> m_domEditor;
bool m_searchingForNode { false };
bool m_suppressAttributeModifiedEvent { false };
bool m_documentRequested { false };
};
} // namespace WebCore
|
