Show ancestor hierarchy in accessibility panel

third_party/WebKit/Source/modules/accessibility/InspectorAccessibilityAgent.cpp

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "modules/accessibility/InspectorAccessibilityAgent.h"
 
 #include "core/HTMLNames.h"
 #include "core/dom/AXObjectCache.h"
 #include "core/dom/DOMNodeIds.h"
 #include "core/dom/Element.h"
+#include "core/inspector/IdentifiersFactory.h"
 #include "core/inspector/InspectorDOMAgent.h"
 #include "core/inspector/InspectorStyleSheet.h"
 #include "core/page/Page.h"
 #include "modules/accessibility/AXObject.h"
 #include "modules/accessibility/AXObjectCacheImpl.h"
 #include "modules/accessibility/InspectorTypeBuilderHelper.h"
 #include <memory>
 
 namespace blink {
 
@@ skipping 272 matching lines @@
     AtomicString roleName = AXObject::roleName(role);
     std::unique_ptr<AXValue> roleNameValue;
     if (!roleName.isNull()) {
         roleNameValue = createValue(roleName, AXValueTypeEnum::Role);
     } else {
         roleNameValue = createValue(AXObject::internalRoleName(role), AXValueTypeEnum::InternalRole);
     }
     return roleNameValue;
 }
 
-std::unique_ptr<AXNode> buildObjectForIgnoredNode(Node* node, AXObject* axObject, AXObjectCacheImpl* cacheImpl)
+std::unique_ptr<AXNode> buildObjectForIgnoredNode(Node* node, const AXObject* axObject, AXObjectCacheImpl* cacheImpl)
 {
     AXObject::IgnoredReasons ignoredReasons;
 
     AXID axID = 0;
     std::unique_ptr<AXNode> ignoredNodeObject = AXNode::create().setNodeId(String::number(axID)).setIgnored(true).build();
     if (axObject) {
         axObject->computeAccessibilityIsIgnored(&ignoredReasons);
         axID = axObject->axObjectID();
         AccessibilityRole role = axObject->roleValue();
         ignoredNodeObject->setRole(createRoleNameValue(role));
-    } else if (!node->layoutObject()) {
+    } else if (node && !node->layoutObject()) {
         ignoredReasons.append(IgnoredReason(AXNotRendered));
     }
 
     std::unique_ptr<protocol::Array<AXProperty>> ignoredReasonProperties = protocol::Array<AXProperty>::create();
     for (size_t i = 0; i < ignoredReasons.size(); i++)
         ignoredReasonProperties->addItem(createProperty(ignoredReasons[i]));
     ignoredNodeObject->setIgnoredReasons(std::move(ignoredReasonProperties));
 
     return ignoredNodeObject;
 }
 
-std::unique_ptr<AXNode> buildObjectForNode(Node* node, AXObject* axObject, AXObjectCacheImpl* cacheImpl, std::unique_ptr<protocol::Array<AXProperty>> properties)
+std::unique_ptr<AXNode> buildProtocolAXObject(AXObject* axObject, AXObjectCacheImpl* cacheImpl)
 {
     AccessibilityRole role = axObject->roleValue();
     std::unique_ptr<AXNode> nodeObject = AXNode::create().setNodeId(String::number(axObject->axObjectID())).setIgnored(false).build();
     nodeObject->setRole(createRoleNameValue(role));
 
+    std::unique_ptr<protocol::Array<AXProperty>> properties = protocol::Array<AXProperty>::create();
+    fillLiveRegionProperties(axObject, properties.get());
+    fillGlobalStates(axObject, properties.get());
+    fillWidgetProperties(axObject, properties.get());
+    fillWidgetStates(axObject, properties.get());
+    fillRelationships(axObject, properties.get());
+
     AXObject::NameSources nameSources;
     String computedName = axObject->name(&nameSources);
     if (!nameSources.isEmpty()) {
         std::unique_ptr<AXValue> name = createValue(computedName, AXValueTypeEnum::ComputedString);
         if (!nameSources.isEmpty()) {
             std::unique_ptr<protocol::Array<AXValueSource>> nameSourceProperties = protocol::Array<AXValueSource>::create();
             for (size_t i = 0; i < nameSources.size(); ++i) {
                 NameSource& nameSource = nameSources[i];
                 nameSourceProperties->addItem(createValueSource(nameSource));
                 if (nameSource.text.isNull() || nameSource.superseded)
@@ skipping 15 matching lines @@
 }
 
 } // namespace
 
 InspectorAccessibilityAgent::InspectorAccessibilityAgent(Page* page, InspectorDOMAgent* domAgent)
     : m_page(page)
     , m_domAgent(domAgent)
 {
 }
 
-void InspectorAccessibilityAgent::getAXNode(ErrorString* errorString, int nodeId, Maybe<AXNode>* accessibilityNode)
+void InspectorAccessibilityAgent::getAXNodeForDOMNode(ErrorString* errorString, int domNodeId, bool fetchAncestors, Maybe<protocol::Array<protocol::Accessibility::AXNode>>* nodes)
 {
-    Frame* mainFrame = m_page->mainFrame();
-    if (!mainFrame->isLocalFrame()) {
-        *errorString = "Can't inspect out of process frames yet";
-        return;
-    }
+    discardFrontendBindings();

[dgozman, 2016/09/15 17:45:44]

If the cache is not used in subsequent protocol calls, let's clean it up at the
end of this method? Then it makes sense to turn it into a local variable instead
of a member. Pretty much like it was before.

[aboxhall, 2016/09/15 20:30:08]

It will be used in later changes, once I add getChildNodes to allow expanding
siblings and children of the inspected node.

 
     if (!m_domAgent->enabled()) {
         *errorString = "DOM agent must be enabled";
         return;
     }
-    Node* node = m_domAgent->assertNode(errorString, nodeId);
+    Node* node = m_domAgent->assertNode(errorString, domNodeId);
     if (!node)
         return;
 
     Document& document = node->document();
     document.updateStyleAndLayoutIgnorePendingStylesheets();
     DocumentLifecycle::DisallowTransitionScope disallowTransition(document.lifecycle());
-    std::unique_ptr<ScopedAXObjectCache> cache = ScopedAXObjectCache::create(document);
-    AXObjectCacheImpl* cacheImpl = toAXObjectCacheImpl(cache->get());
-    AXObject* axObject = cacheImpl->getOrCreate(node);
-    if (!axObject || axObject->accessibilityIsIgnored()) {
-        *accessibilityNode = buildObjectForIgnoredNode(node, axObject, cacheImpl);
+    LocalFrame* localFrame = document.frame();
+    if (!localFrame) {
+        *errorString = "Can't inspect out of process frames yet";

[dgozman, 2016/09/15 17:45:44]

This actually means frame is detached. Out of process will not even have a
document.

[aboxhall, 2016/09/15 20:30:08]

Ah ok, changed error string.

         return;
     }
+    AXObjectCache* cache = nullptr;
+    String frameId = IdentifiersFactory::frameId(localFrame);
+    CacheMap::iterator it = m_frameToAXObjectCacheMap.find(frameId);
+    if (it != m_frameToAXObjectCacheMap.end()) {
+        cache = it->value;
+    } else {
+        cache = AXObjectCache::create(document);
+        m_frameToAXObjectCacheMap.set(frameId, cache);
+    }
 
-    std::unique_ptr<protocol::Array<AXProperty>> properties = protocol::Array<AXProperty>::create();
-    fillLiveRegionProperties(axObject, properties.get());
-    fillGlobalStates(axObject, properties.get());
-    fillWidgetProperties(axObject, properties.get());
-    fillWidgetStates(axObject, properties.get());
-    fillRelationships(axObject, properties.get());
+    AXObjectCacheImpl* cacheImpl = toAXObjectCacheImpl(cache);

[dgozman, 2016/09/15 17:45:44]

If we actually need an AXObjectCacheImpl, let's replace AXObjectCache with impl
everywhere. There is no need to trick ourselves pretending it's not an impl.

[aboxhall, 2016/09/15 20:30:08]

Done.

+    AXObject* axObject = cacheImpl->getOrCreate(node);
+    *nodes = protocol::Array<protocol::Accessibility::AXNode>::create();

[dgozman, 2016/09/15 17:45:44]

Let's not create nodes if there was no axObject.

[aboxhall, 2016/09/15 20:30:08]

I don't follow - either way an object gets added to this array, it's never
empty.

[dgozman, 2016/09/17 00:36:23]

Then it should not be optional in protocol.

[aboxhall, 2016/09/17 01:12:34]

Done.

+    if (!axObject || axObject->accessibilityIsIgnored()) {
+        nodes->fromJust()->addItem(buildObjectForIgnoredNode(node, axObject, cacheImpl));
+    } else {
+        nodes->fromJust()->addItem(buildProtocolAXObject(axObject, cacheImpl));
+    }
 
-    *accessibilityNode = buildObjectForNode(node, axObject, cacheImpl, std::move(properties));
+    if (fetchAncestors && axObject) {
+        AXObject* parent = axObject->parentObjectUnignored();
+        while (parent) {
+            nodes->fromJust()->addItem(buildProtocolAXObject(parent, cacheImpl));
+            parent = parent->parentObjectUnignored();
+        }
+    }
+}
+
+void InspectorAccessibilityAgent::discardFrontendBindings()
+{
+    m_frameToAXObjectCacheMap.clear();
 }
 
 DEFINE_TRACE(InspectorAccessibilityAgent)
 {
     visitor->trace(m_page);
+    visitor->trace(m_frameToAXObjectCacheMap);
     visitor->trace(m_domAgent);
     InspectorBaseAgent::trace(visitor);
 }
 
 } // namespace blink