michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "AccIterator.h"
michael@0: 
michael@0: #include "AccGroupInfo.h"
michael@0: #ifdef MOZ_XUL
michael@0: #include "XULTreeAccessible.h"
michael@0: #endif
michael@0: 
michael@0: #include "mozilla/dom/Element.h"
michael@0: 
michael@0: using namespace mozilla;
michael@0: using namespace mozilla::a11y;
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // AccIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: AccIterator::AccIterator(Accessible* aAccessible,
michael@0:                          filters::FilterFuncPtr aFilterFunc) :
michael@0:   mFilterFunc(aFilterFunc)
michael@0: {
michael@0:   mState = new IteratorState(aAccessible);
michael@0: }
michael@0: 
michael@0: AccIterator::~AccIterator()
michael@0: {
michael@0:   while (mState) {
michael@0:     IteratorState *tmp = mState;
michael@0:     mState = tmp->mParentState;
michael@0:     delete tmp;
michael@0:   }
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: AccIterator::Next()
michael@0: {
michael@0:   while (mState) {
michael@0:     Accessible* child = mState->mParent->GetChildAt(mState->mIndex++);
michael@0:     if (!child) {
michael@0:       IteratorState* tmp = mState;
michael@0:       mState = mState->mParentState;
michael@0:       delete tmp;
michael@0: 
michael@0:       continue;
michael@0:     }
michael@0: 
michael@0:     uint32_t result = mFilterFunc(child);
michael@0:     if (result & filters::eMatch)
michael@0:       return child;
michael@0: 
michael@0:     if (!(result & filters::eSkipSubtree)) {
michael@0:       IteratorState* childState = new IteratorState(child, mState);
michael@0:       mState = childState;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // nsAccIterator::IteratorState
michael@0: 
michael@0: AccIterator::IteratorState::IteratorState(Accessible* aParent,
michael@0:                                           IteratorState *mParentState) :
michael@0:   mParent(aParent), mIndex(0), mParentState(mParentState)
michael@0: {
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // RelatedAccIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: RelatedAccIterator::
michael@0:   RelatedAccIterator(DocAccessible* aDocument, nsIContent* aDependentContent,
michael@0:                      nsIAtom* aRelAttr) :
michael@0:   mDocument(aDocument), mRelAttr(aRelAttr), mProviders(nullptr),
michael@0:   mBindingParent(nullptr), mIndex(0)
michael@0: {
michael@0:   mBindingParent = aDependentContent->GetBindingParent();
michael@0:   nsIAtom* IDAttr = mBindingParent ?
michael@0:     nsGkAtoms::anonid : aDependentContent->GetIDAttributeName();
michael@0: 
michael@0:   nsAutoString id;
michael@0:   if (aDependentContent->GetAttr(kNameSpaceID_None, IDAttr, id))
michael@0:     mProviders = mDocument->mDependentIDsHash.Get(id);
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: RelatedAccIterator::Next()
michael@0: {
michael@0:   if (!mProviders)
michael@0:     return nullptr;
michael@0: 
michael@0:   while (mIndex < mProviders->Length()) {
michael@0:     DocAccessible::AttrRelProvider* provider = (*mProviders)[mIndex++];
michael@0: 
michael@0:     // Return related accessible for the given attribute and if the provider
michael@0:     // content is in the same binding in the case of XBL usage.
michael@0:     if (provider->mRelAttr == mRelAttr) {
michael@0:       nsIContent* bindingParent = provider->mContent->GetBindingParent();
michael@0:       bool inScope = mBindingParent == bindingParent ||
michael@0:         mBindingParent == provider->mContent;
michael@0: 
michael@0:       if (inScope) {
michael@0:         Accessible* related = mDocument->GetAccessible(provider->mContent);
michael@0:         if (related)
michael@0:           return related;
michael@0: 
michael@0:         // If the document content is pointed by relation then return the document
michael@0:         // itself.
michael@0:         if (provider->mContent == mDocument->GetContent())
michael@0:           return mDocument;
michael@0:       }
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // HTMLLabelIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: HTMLLabelIterator::
michael@0:   HTMLLabelIterator(DocAccessible* aDocument, const Accessible* aAccessible,
michael@0:                     LabelFilter aFilter) :
michael@0:   mRelIter(aDocument, aAccessible->GetContent(), nsGkAtoms::_for),
michael@0:   mAcc(aAccessible), mLabelFilter(aFilter)
michael@0: {
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: HTMLLabelIterator::Next()
michael@0: {
michael@0:   // Get either <label for="[id]"> element which explicitly points to given
michael@0:   // element, or <label> ancestor which implicitly point to it.
michael@0:   Accessible* label = nullptr;
michael@0:   while ((label = mRelIter.Next())) {
michael@0:     if (label->GetContent()->Tag() == nsGkAtoms::label)
michael@0:       return label;
michael@0:   }
michael@0: 
michael@0:   // Ignore ancestor label on not widget accessible.
michael@0:   if (mLabelFilter == eSkipAncestorLabel || !mAcc->IsWidget())
michael@0:     return nullptr;
michael@0: 
michael@0:   // Go up tree to get a name of ancestor label if there is one (an ancestor
michael@0:   // <label> implicitly points to us). Don't go up farther than form or
michael@0:   // document.
michael@0:   Accessible* walkUp = mAcc->Parent();
michael@0:   while (walkUp && !walkUp->IsDoc()) {
michael@0:     nsIContent* walkUpElm = walkUp->GetContent();
michael@0:     if (walkUpElm->IsHTML()) {
michael@0:       if (walkUpElm->Tag() == nsGkAtoms::label &&
michael@0:           !walkUpElm->HasAttr(kNameSpaceID_None, nsGkAtoms::_for)) {
michael@0:         mLabelFilter = eSkipAncestorLabel; // prevent infinite loop
michael@0:         return walkUp;
michael@0:       }
michael@0: 
michael@0:       if (walkUpElm->Tag() == nsGkAtoms::form)
michael@0:         break;
michael@0:     }
michael@0: 
michael@0:     walkUp = walkUp->Parent();
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // HTMLOutputIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: HTMLOutputIterator::
michael@0: HTMLOutputIterator(DocAccessible* aDocument, nsIContent* aElement) :
michael@0:   mRelIter(aDocument, aElement, nsGkAtoms::_for)
michael@0: {
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: HTMLOutputIterator::Next()
michael@0: {
michael@0:   Accessible* output = nullptr;
michael@0:   while ((output = mRelIter.Next())) {
michael@0:     if (output->GetContent()->Tag() == nsGkAtoms::output)
michael@0:       return output;
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // XULLabelIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: XULLabelIterator::
michael@0:   XULLabelIterator(DocAccessible* aDocument, nsIContent* aElement) :
michael@0:   mRelIter(aDocument, aElement, nsGkAtoms::control)
michael@0: {
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: XULLabelIterator::Next()
michael@0: {
michael@0:   Accessible* label = nullptr;
michael@0:   while ((label = mRelIter.Next())) {
michael@0:     if (label->GetContent()->Tag() == nsGkAtoms::label)
michael@0:       return label;
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // XULDescriptionIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: XULDescriptionIterator::
michael@0:   XULDescriptionIterator(DocAccessible* aDocument, nsIContent* aElement) :
michael@0:   mRelIter(aDocument, aElement, nsGkAtoms::control)
michael@0: {
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: XULDescriptionIterator::Next()
michael@0: {
michael@0:   Accessible* descr = nullptr;
michael@0:   while ((descr = mRelIter.Next())) {
michael@0:     if (descr->GetContent()->Tag() == nsGkAtoms::description)
michael@0:       return descr;
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // IDRefsIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: IDRefsIterator::
michael@0:   IDRefsIterator(DocAccessible* aDoc, nsIContent* aContent,
michael@0:                  nsIAtom* aIDRefsAttr) :
michael@0:   mContent(aContent), mDoc(aDoc), mCurrIdx(0)
michael@0: {
michael@0:   if (mContent->IsInDoc())
michael@0:     mContent->GetAttr(kNameSpaceID_None, aIDRefsAttr, mIDs);
michael@0: }
michael@0: 
michael@0: const nsDependentSubstring
michael@0: IDRefsIterator::NextID()
michael@0: {
michael@0:   for (; mCurrIdx < mIDs.Length(); mCurrIdx++) {
michael@0:     if (!NS_IsAsciiWhitespace(mIDs[mCurrIdx]))
michael@0:       break;
michael@0:   }
michael@0: 
michael@0:   if (mCurrIdx >= mIDs.Length())
michael@0:     return nsDependentSubstring();
michael@0: 
michael@0:   nsAString::index_type idStartIdx = mCurrIdx;
michael@0:   while (++mCurrIdx < mIDs.Length()) {
michael@0:     if (NS_IsAsciiWhitespace(mIDs[mCurrIdx]))
michael@0:       break;
michael@0:   }
michael@0: 
michael@0:   return Substring(mIDs, idStartIdx, mCurrIdx++ - idStartIdx);
michael@0: }
michael@0: 
michael@0: nsIContent*
michael@0: IDRefsIterator::NextElem()
michael@0: {
michael@0:   while (true) {
michael@0:     const nsDependentSubstring id = NextID();
michael@0:     if (id.IsEmpty())
michael@0:       break;
michael@0: 
michael@0:     nsIContent* refContent = GetElem(id);
michael@0:     if (refContent)
michael@0:       return refContent;
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: nsIContent*
michael@0: IDRefsIterator::GetElem(const nsDependentSubstring& aID)
michael@0: {
michael@0:   // Get elements in DOM tree by ID attribute if this is an explicit content.
michael@0:   // In case of bound element check its anonymous subtree.
michael@0:   if (!mContent->IsInAnonymousSubtree()) {
michael@0:     dom::Element* refElm = mContent->OwnerDoc()->GetElementById(aID);
michael@0:     if (refElm || !mContent->GetXBLBinding())
michael@0:       return refElm;
michael@0:   }
michael@0: 
michael@0:   // If content is in anonymous subtree or an element having anonymous subtree
michael@0:   // then use "anonid" attribute to get elements in anonymous subtree.
michael@0: 
michael@0:   // Check inside the binding the element is contained in.
michael@0:   nsIContent* bindingParent = mContent->GetBindingParent();
michael@0:   if (bindingParent) {
michael@0:     nsIContent* refElm = bindingParent->OwnerDoc()->
michael@0:       GetAnonymousElementByAttribute(bindingParent, nsGkAtoms::anonid, aID);
michael@0: 
michael@0:     if (refElm)
michael@0:       return refElm;
michael@0:   }
michael@0: 
michael@0:   // Check inside the binding of the element.
michael@0:   if (mContent->GetXBLBinding()) {
michael@0:     return mContent->OwnerDoc()->
michael@0:       GetAnonymousElementByAttribute(mContent, nsGkAtoms::anonid, aID);
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: IDRefsIterator::Next()
michael@0: {
michael@0:   nsIContent* nextElm = NextElem();
michael@0:   return nextElm ? mDoc->GetAccessible(nextElm) : nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // SingleAccIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: Accessible*
michael@0: SingleAccIterator::Next()
michael@0: {
michael@0:   nsRefPtr<Accessible> nextAcc;
michael@0:   mAcc.swap(nextAcc);
michael@0:   return (nextAcc && !nextAcc->IsDefunct()) ? nextAcc : nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // ItemIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: Accessible*
michael@0: ItemIterator::Next()
michael@0: {
michael@0:   if (mContainer) {
michael@0:     mAnchor = AccGroupInfo::FirstItemOf(mContainer);
michael@0:     mContainer = nullptr;
michael@0:     return mAnchor;
michael@0:   }
michael@0: 
michael@0:   return mAnchor ? (mAnchor = AccGroupInfo::NextItemTo(mAnchor)) : nullptr;
michael@0: }
michael@0: 
michael@0: 
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: // XULTreeItemIterator
michael@0: ////////////////////////////////////////////////////////////////////////////////
michael@0: 
michael@0: XULTreeItemIterator::XULTreeItemIterator(XULTreeAccessible* aXULTree,
michael@0:                                          nsITreeView* aTreeView,
michael@0:                                          int32_t aRowIdx) :
michael@0:   mXULTree(aXULTree), mTreeView(aTreeView), mRowCount(-1),
michael@0:   mContainerLevel(-1), mCurrRowIdx(aRowIdx + 1)
michael@0: {
michael@0:   mTreeView->GetRowCount(&mRowCount);
michael@0:   if (aRowIdx != -1)
michael@0:     mTreeView->GetLevel(aRowIdx, &mContainerLevel);
michael@0: }
michael@0: 
michael@0: Accessible*
michael@0: XULTreeItemIterator::Next()
michael@0: {
michael@0:   while (mCurrRowIdx < mRowCount) {
michael@0:     int32_t level = 0;
michael@0:     mTreeView->GetLevel(mCurrRowIdx, &level);
michael@0: 
michael@0:     if (level == mContainerLevel + 1)
michael@0:       return mXULTree->GetTreeItemAccessible(mCurrRowIdx++);
michael@0: 
michael@0:     if (level <= mContainerLevel) { // got level up
michael@0:       mCurrRowIdx = mRowCount;
michael@0:       break;
michael@0:     }
michael@0: 
michael@0:     mCurrRowIdx++;
michael@0:   }
michael@0: 
michael@0:   return nullptr;
michael@0: }