posinset and setsize for input type, radio, exposed in AX tree

third_party/WebKit/Source/core/html/forms/RadioButtonGroupScope.cpp

 /*
  * Copyright (C) 2007, 2008, 2009 Apple Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  *
  */
 
 #include "core/html/forms/RadioButtonGroupScope.h"
 
 #include "core/InputTypeNames.h"
+#include "core/dom/NodeTraversal.h"
 #include "core/html/HTMLInputElement.h"
 #include "wtf/HashMap.h"
 
 namespace blink {
 
 class RadioButtonGroup : public NoBaseWillBeGarbageCollected<RadioButtonGroup> {
     USING_FAST_MALLOC_WILL_BE_REMOVED(RadioButtonGroup);
 public:
     static PassOwnPtrWillBeRawPtr<RadioButtonGroup> create();
     bool isEmpty() const { return m_members.isEmpty(); }
     bool isRequired() const { return m_requiredCount; }
     HTMLInputElement* checkedButton() const { return m_checkedButton; }
     void add(HTMLInputElement*);
     void updateCheckedState(HTMLInputElement*);
     void requiredAttributeChanged(HTMLInputElement*);
     void remove(HTMLInputElement*);
     bool contains(HTMLInputElement*) const;
+    void setNeedToUpdate(bool);
+    void updateAXPosition();
+    unsigned sizeOfMembers() const;
 
     DECLARE_TRACE();
 
 private:
     RadioButtonGroup();
     void setNeedsValidityCheckForAllButtons();
     bool isValid() const;
     void setCheckedButton(HTMLInputElement*);
+    bool isNextPosition(HTMLInputElement* list, HTMLInputElement* current) const;
 
     // The map records the 'required' state of each (button) element.
     using Members = WillBeHeapHashMap<RawPtrWillBeMember<HTMLInputElement>, bool>;
 
 #if ENABLE(OILPAN)
     using MemberKeyValue = WTF::KeyValuePair<Member<HTMLInputElement>, bool>;
 #else
     using MemberKeyValue = WTF::KeyValuePair<HTMLInputElement*, bool>;
 #endif
 
     void updateRequiredButton(MemberKeyValue&, bool isRequired);
 
     Members m_members;
     RawPtrWillBeMember<HTMLInputElement> m_checkedButton;
     size_t m_requiredCount;
+    bool m_needToUpdateAXPosition;
 };
 
 RadioButtonGroup::RadioButtonGroup()
     : m_checkedButton(nullptr)
     , m_requiredCount(0)
+    , m_needToUpdateAXPosition(false)
 {
 }
 
 PassOwnPtrWillBeRawPtr<RadioButtonGroup> RadioButtonGroup::create()
 {
     return adoptPtrWillBeNoop(new RadioButtonGroup);
 }
 
 inline bool RadioButtonGroup::isValid() const
 {
     return !isRequired() || m_checkedButton;
 }
 
 void RadioButtonGroup::setCheckedButton(HTMLInputElement* button)
 {
     HTMLInputElement* oldCheckedButton = m_checkedButton;
     if (oldCheckedButton == button)
         return;
     m_checkedButton = button;
     if (oldCheckedButton)
         oldCheckedButton->setChecked(false);
 }
 
+bool RadioButtonGroup::isNextPosition(HTMLInputElement* listItem, HTMLInputElement* current) const
+{
+    Node* commonAncestor = NodeTraversal::commonAncestor(*listItem, *current);
+    for (Node* node = commonAncestor; node; node = NodeTraversal::next(*node)) {
+        if (!node->isHTMLElement() || !isHTMLInputElement(node) || !toHTMLInputElement(node)->isRadioButton())
+            continue;
+        if (node == listItem)
+            return true;
+        if (node == current)
+            return false;
+    }
+    return true;
+}
+
 void RadioButtonGroup::updateRequiredButton(MemberKeyValue& it, bool isRequired)
 {
     if (it.value == isRequired)
         return;
 
     it.value = isRequired;
     if (isRequired) {
         m_requiredCount++;
     } else {
         ASSERT(m_requiredCount);
         m_requiredCount--;
     }
 }
 
 void RadioButtonGroup::add(HTMLInputElement* button)
 {
     ASSERT(button->type() == InputTypeNames::radio);
     auto addResult = m_members.add(button, false);
     if (!addResult.isNewEntry)
         return;
+
+    setNeedToUpdate(true);
     bool groupWasValid = isValid();
     updateRequiredButton(*addResult.storedValue, button->isRequired());
     if (button->checked())
         setCheckedButton(button);
 
     bool groupIsValid = isValid();
     if (groupWasValid != groupIsValid) {
         setNeedsValidityCheckForAllButtons();
     } else if (!groupIsValid) {
         // A radio button not in a group is always valid. We need to make it
@@ skipping 33 matching lines @@
     if (wasValid != isValid())
         setNeedsValidityCheckForAllButtons();
 }
 
 void RadioButtonGroup::remove(HTMLInputElement* button)
 {
     ASSERT(button->type() == InputTypeNames::radio);
     auto it = m_members.find(button);
     if (it == m_members.end())
         return;
+
+    setNeedToUpdate(true);
     bool wasValid = isValid();
     ASSERT(it->value == button->isRequired());
     updateRequiredButton(*it, false);
     m_members.remove(it);
     if (m_checkedButton == button)
         m_checkedButton = nullptr;
 
     if (m_members.isEmpty()) {
         ASSERT(!m_requiredCount);
         ASSERT(!m_checkedButton);
@@ skipping 14 matching lines @@
         ASSERT(button->type() == InputTypeNames::radio);
         button->setNeedsValidityCheck();
     }
 }
 
 bool RadioButtonGroup::contains(HTMLInputElement* button) const
 {
     return m_members.contains(button);
 }
 
+void RadioButtonGroup::setNeedToUpdate(bool set)
+{
+    m_needToUpdateAXPosition = set;
+}
+
+void RadioButtonGroup::updateAXPosition()
+{
+    if (!m_needToUpdateAXPosition)
+        return;
+
+    WillBeHeapVector<RawPtrWillBeMember<HTMLInputElement>> orderdList;
+    for (auto& element : m_members) {
+        HTMLInputElement* const current = element.key;
+        if (orderdList.isEmpty()) {
+            orderdList.append(current);
+        } else {
+            unsigned position = 0;
+            for (auto& item : orderdList) {
+                if (!isNextPosition(item, current))

[keishi, 2016/02/23 09:43:00]

This reordering is like O(N^3). Could we use
RadioInputType::findNextFocusableRadioButtonInGroup to make it O(N).

[je_julie(Not used), 2016/02/27 14:01:08]

I moved handling position for AX to AXRadioInput and it checked with the way
like findNextFocusableRadioButtonInGroup.

+                    break;
+                position++;
+            }
+            orderdList.insert(position, current);
+        }
+    }
+
+    unsigned index = 0;
+    for (auto& orderedNode : orderdList) {
+        index++;
+        if (AXObjectCache* cache = orderedNode->document().existingAXObjectCache())
+            cache->radiobuttonPositionChanged(orderedNode, index);
+    }
+    setNeedToUpdate(false);
+}
+
+unsigned RadioButtonGroup::sizeOfMembers() const
+{
+    return m_members.size();
+}
+
 DEFINE_TRACE(RadioButtonGroup)
 {
 #if ENABLE(OILPAN)
     visitor->trace(m_members);
     visitor->trace(m_checkedButton);
 #endif
 }
 
 // ----------------------------------------------------------------
 
@@ skipping 61 matching lines @@
 {
     ASSERT(element->type() == InputTypeNames::radio);
     if (element->name().isEmpty())
         return false;
     if (!m_nameToGroupMap)
         return false;
     RadioButtonGroup* group = m_nameToGroupMap->get(element->name());
     return group && group->isRequired() && group->contains(element);
 }
 
+unsigned RadioButtonGroupScope::sizeOfGroup(const HTMLInputElement* element) const
+{
+    if (!m_nameToGroupMap)
+        return 0;
+
+    RadioButtonGroup* group = m_nameToGroupMap->get(element->name());
+    if (!group)
+        return 0;
+    return group->sizeOfMembers();
+}
+
+void RadioButtonGroupScope::updateAXPositionInGroup(const HTMLInputElement* element) const
+{
+    if (!m_nameToGroupMap)
+        return;
+
+    RadioButtonGroup* group = m_nameToGroupMap->get(element->name());
+    if (!group)
+        return;
+    group->updateAXPosition();
+}
+
+void RadioButtonGroupScope::setNeedToUpdateAXPositionInGroup(const HTMLInputElement* element, bool set) const
+{
+    if (!m_nameToGroupMap)
+        return;
+
+    RadioButtonGroup* group = m_nameToGroupMap->get(element->name());
+    if (!group)
+        return;
+    group->setNeedToUpdate(set);

[keishi, 2016/02/23 09:43:00]

If we do something like RadioInputType::findNextFocusableRadioButtonInGroup to
find all the radio buttons I think you won't need access to the
RadioButtonGroupScope. RadioButtonGroup::add/remove could call something like
AXObjectCache::handleRadioButtonGroupChange and it could invalidate the cached
posinset/setsize values. The posinset/setsize can be recalculated from the
accessibility module, and we won't need to add all of these *AXPosition* APIs.

[je_julie(Not used), 2016/02/27 14:01:08]

I removed almost all handling to AXRadioInput as you recommended.

+}
+
 void RadioButtonGroupScope::removeButton(HTMLInputElement* element)
 {
     ASSERT(element->type() == InputTypeNames::radio);
     if (element->name().isEmpty())
         return;
     if (!m_nameToGroupMap)
         return;
 
     RadioButtonGroup* group = m_nameToGroupMap->get(element->name());
     if (!group)
         return;
     group->remove(element);
     if (group->isEmpty()) {
         // We don't remove an empty RadioButtonGroup from m_nameToGroupMap for
         // better performance.
         ASSERT(!group->isRequired());
         ASSERT_WITH_SECURITY_IMPLICATION(!group->checkedButton());
     }
 }
 
 DEFINE_TRACE(RadioButtonGroupScope)
 {
 #if ENABLE(OILPAN)
     visitor->trace(m_nameToGroupMap);
 #endif
 }
 
 } // namespace blink