Changeset 147428 in webkit

Timestamp:

Apr 2, 2013 7:28:48 AM (11 years ago)

Author:

commit-queue@webkit.org

Message:

Web Inspector: allow referencing of nodes that have not been pushed to the front-end
​https://bugs.webkit.org/show_bug.cgi?id=110921

Patch by Dmitry Gozman <​dgozman@chromium.org> on 2013-04-02
Reviewed by Pavel Feldman.

Nodes not yet pushed to front-end are referenced by BackendNodeId and retained.
One can group nodes when generating BackendNodeIds to release them all together later.

To resolve node references by BackendNodeId, frontend should use new pushNodeByBackendIdToFrontend method.
This will invalidate the generated BackendNodeId.

• inspector/Inspector.json:
• inspector/InspectorDOMAgent.cpp:

(WebCore::InspectorDOMAgent::discardBindings):
(WebCore::InspectorDOMAgent::backendNodeIdForNode):
(WebCore::InspectorDOMAgent::releaseBackendNodeIds):
(WebCore::InspectorDOMAgent::pushNodeByBackendIdToFrontend):

• inspector/InspectorDOMAgent.h:

(WebCore):
(InspectorDOMAgent):

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• inspector/Inspector.json (modified) (2 diffs)
• inspector/InspectorDOMAgent.cpp (modified) (4 diffs)
• inspector/InspectorDOMAgent.h (modified) (5 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2013-04-02  Dmitry Gozman  <dgozman@chromium.org>
+
+        Web Inspector: allow referencing of nodes that have not been pushed to the front-end
+        https://bugs.webkit.org/show_bug.cgi?id=110921
+
+        Reviewed by Pavel Feldman.
+
+        Nodes not yet pushed to front-end are referenced by BackendNodeId and retained.
+        One can group nodes when generating BackendNodeIds to release them all together later.
+
+        To resolve node references by BackendNodeId, frontend should use new pushNodeByBackendIdToFrontend method.
+        This will invalidate the generated BackendNodeId.
+
+        * inspector/Inspector.json:
+        * inspector/InspectorDOMAgent.cpp:
+        (WebCore::InspectorDOMAgent::discardBindings):
+        (WebCore::InspectorDOMAgent::backendNodeIdForNode):
+        (WebCore::InspectorDOMAgent::releaseBackendNodeIds):
+        (WebCore::InspectorDOMAgent::pushNodeByBackendIdToFrontend):
+        * inspector/InspectorDOMAgent.h:
+        (WebCore):
+        (InspectorDOMAgent):
+
 2013-04-02  Andrei Bucur  <abucur@adobe.com>
 

trunk/Source/WebCore/inspector/Inspector.json

@@ -1714 +1714 @@
                 "type": "integer",
                 "description": "Unique DOM node identifier."
+            },
+            {
+                "id": "BackendNodeId",
+                "type": "integer",
+                "description": "Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.",
+                "hidden": true
             },
             {
@@ -2015 +2021 @@
                 ],
                 "description": "Requests that the node is sent to the caller given its path. // FIXME, use XPath",
+                "hidden": true
+            },
+            {
+                "name": "pushNodeByBackendIdToFrontend",
+                "parameters": [
+                    { "name": "backendNodeId", "$ref": "BackendNodeId", "description": "The backend node id of the node." }
+                ],
+                "returns": [
+                    { "name": "nodeId", "$ref": "NodeId", "description": "The pushed node's id." }
+                ],
+                "description": "Requests that the node is sent to the caller given its backend node id.",
+                "hidden": true
+            },
+            {
+                "name": "releaseBackendNodeIds",
+                "parameters": [
+                    { "name": "nodeGroup", "type": "string", "description": "The backend node ids group name." }
+                ],
+                "description": "Requests that group of <code>BackendNodeIds</code> is released.",
                 "hidden": true
             },

trunk/Source/WebCore/inspector/InspectorDOMAgent.cpp

@@ -228 +228 @@
     , m_domListener(0)
     , m_lastNodeId(1)
+    , m_lastBackendNodeId(-1)
     , m_searchingForNode(false)
     , m_suppressAttributeModifiedEvent(false)
@@ -492 +493 @@
     releaseDanglingNodes();
     m_childrenRequested.clear();
+    m_backendIdToNode.clear();
+    m_nodeGroupToBackendIdMap.clear();
 }
 
@@ -623 +626 @@
 {
     return m_documentNodeToIdMap.get(node);
+}
+
+BackendNodeId InspectorDOMAgent::backendNodeIdForNode(Node* node, const String& nodeGroup)
+{
+    if (!node)
+        return 0;
+
+    if (!m_nodeGroupToBackendIdMap.contains(nodeGroup))
+        m_nodeGroupToBackendIdMap.set(nodeGroup, NodeToBackendIdMap());
+
+    NodeToBackendIdMap& map = m_nodeGroupToBackendIdMap.find(nodeGroup)->value;
+    BackendNodeId id = map.get(node);
+    if (!id) {
+        id = --m_lastBackendNodeId;
+        map.set(node, id);
+        m_backendIdToNode.set(id, std::make_pair(node, nodeGroup));
+    }
+
+    return id;
+}
+
+void InspectorDOMAgent::releaseBackendNodeIds(ErrorString* errorString, const String& nodeGroup)
+{
+    if (m_nodeGroupToBackendIdMap.contains(nodeGroup)) {
+        NodeToBackendIdMap& map = m_nodeGroupToBackendIdMap.find(nodeGroup)->value;
+        for (NodeToBackendIdMap::iterator it = map.begin(); it != map.end(); ++it)
+            m_backendIdToNode.remove(it->value);
+        m_nodeGroupToBackendIdMap.remove(nodeGroup);
+        return;
+    }
+    *errorString = "Group name not found";
 }
 
@@ -1768 +1802 @@
 }
 
+void InspectorDOMAgent::pushNodeByBackendIdToFrontend(ErrorString* errorString, BackendNodeId backendNodeId, int* nodeId)
+{
+    if (!m_backendIdToNode.contains(backendNodeId)) {
+        *errorString = "No node with given backend id found";
+        return;
+    }
+
+    Node* node = m_backendIdToNode.get(backendNodeId).first;
+    String nodeGroup = m_backendIdToNode.get(backendNodeId).second;
+    *nodeId = pushNodePathToFrontend(node);
+
+    if (nodeGroup == "") {
+        m_backendIdToNode.remove(backendNodeId);
+        m_nodeGroupToBackendIdMap.find(nodeGroup)->value.remove(node);
+    }
+}
+
 PassRefPtr<TypeBuilder::Runtime::RemoteObject> InspectorDOMAgent::resolveNode(Node* node, const String& objectGroup)
 {

trunk/Source/WebCore/inspector/InspectorDOMAgent.h

@@ -76 +76 @@
 
 typedef String ErrorString;
+typedef int BackendNodeId;
 
 #if ENABLE(INSPECTOR)
@@ -142 +143 @@
     virtual void requestNode(ErrorString*, const String& objectId, int* nodeId);
     virtual void pushNodeByPathToFrontend(ErrorString*, const String& path, int* nodeId);
+    virtual void pushNodeByBackendIdToFrontend(ErrorString*, BackendNodeId, int* nodeId);
+    virtual void releaseBackendNodeIds(ErrorString*, const String& nodeGroup);
     virtual void hideHighlight(ErrorString*);
     virtual void highlightRect(ErrorString*, int x, int y, int width, int height, const RefPtr<InspectorObject>* color, const RefPtr<InspectorObject>* outlineColor);
@@ -180 +183 @@
     int boundNodeId(Node*);
     void setDOMListener(DOMListener*);
+    BackendNodeId backendNodeIdForNode(Node*, const String& nodeGroup);
 
     static String documentURLString(Document*);
@@ -247 +251 @@
     DOMListener* m_domListener;
     NodeToIdMap m_documentNodeToIdMap;
+    typedef HashMap<RefPtr<Node>, BackendNodeId> NodeToBackendIdMap;
+    HashMap<String, NodeToBackendIdMap> m_nodeGroupToBackendIdMap;
     // Owns node mappings for dangling nodes.
     Vector<OwnPtr<NodeToIdMap> > m_danglingNodeToIdMaps;
@@ -252 +258 @@
     HashMap<int, NodeToIdMap*> m_idToNodesMap;
     HashSet<int> m_childrenRequested;
+    HashMap<BackendNodeId, std::pair<Node*, String> > m_backendIdToNode;
     int m_lastNodeId;
+    BackendNodeId m_lastBackendNodeId;
     RefPtr<Document> m_document;
     typedef HashMap<String, Vector<RefPtr<Node> > > SearchResults;