/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=2 et sw=2 tw=80: */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this file, * You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "Accessible-inl.h" #include "mozilla/a11y/DocAccessibleParent.h" #include "nsAccUtils.h" #include "nsIAccessibleRelation.h" #include "nsIAccessibleRole.h" #include "nsAccessibleRelation.h" #include "Relation.h" #include "Role.h" #include "RootAccessible.h" #include "xpcAccessibleDocument.h" #include "nsIMutableArray.h" #include "nsIPersistentProperties2.h" using namespace mozilla::a11y; NS_IMETHODIMP xpcAccessible::GetParent(nsIAccessible** aParent) { NS_ENSURE_ARG_POINTER(aParent); *aParent = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; AccessibleOrProxy parent = IntlGeneric().Parent(); NS_IF_ADDREF(*aParent = ToXPC(parent)); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetNextSibling(nsIAccessible** aNextSibling) { NS_ENSURE_ARG_POINTER(aNextSibling); *aNextSibling = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (IntlGeneric().IsAccessible()) { nsresult rv = NS_OK; NS_IF_ADDREF(*aNextSibling = ToXPC(Intl()->GetSiblingAtOffset(1, &rv))); return rv; } ProxyAccessible* proxy = IntlGeneric().AsProxy(); NS_ENSURE_STATE(proxy); NS_IF_ADDREF(*aNextSibling = ToXPC(proxy->NextSibling())); return *aNextSibling ? NS_OK : NS_ERROR_FAILURE; } NS_IMETHODIMP xpcAccessible::GetPreviousSibling(nsIAccessible** aPreviousSibling) { NS_ENSURE_ARG_POINTER(aPreviousSibling); *aPreviousSibling = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (IntlGeneric().IsAccessible()) { nsresult rv = NS_OK; NS_IF_ADDREF(*aPreviousSibling = ToXPC(Intl()->GetSiblingAtOffset(-1, &rv))); return rv; } ProxyAccessible* proxy = IntlGeneric().AsProxy(); NS_ENSURE_STATE(proxy); NS_IF_ADDREF(*aPreviousSibling = ToXPC(proxy->PrevSibling())); return *aPreviousSibling ? NS_OK : NS_ERROR_FAILURE; } NS_IMETHODIMP xpcAccessible::GetFirstChild(nsIAccessible** aFirstChild) { NS_ENSURE_ARG_POINTER(aFirstChild); *aFirstChild = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; NS_IF_ADDREF(*aFirstChild = ToXPC(IntlGeneric().FirstChild())); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetLastChild(nsIAccessible** aLastChild) { NS_ENSURE_ARG_POINTER(aLastChild); *aLastChild = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; NS_IF_ADDREF(*aLastChild = ToXPC(IntlGeneric().LastChild())); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetChildCount(int32_t* aChildCount) { NS_ENSURE_ARG_POINTER(aChildCount); if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; *aChildCount = IntlGeneric().ChildCount(); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetChildAt(int32_t aChildIndex, nsIAccessible** aChild) { NS_ENSURE_ARG_POINTER(aChild); *aChild = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; // If child index is negative, then return last child. // XXX: do we really need this? if (aChildIndex < 0) aChildIndex = IntlGeneric().ChildCount() - 1; AccessibleOrProxy child = IntlGeneric().ChildAt(aChildIndex); if (child.IsNull()) return NS_ERROR_INVALID_ARG; NS_ADDREF(*aChild = ToXPC(child)); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetChildren(nsIArray** aChildren) { NS_ENSURE_ARG_POINTER(aChildren); *aChildren = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsresult rv = NS_OK; nsCOMPtr<nsIMutableArray> children = do_CreateInstance(NS_ARRAY_CONTRACTID, &rv); NS_ENSURE_SUCCESS(rv, rv); uint32_t childCount = IntlGeneric().ChildCount(); for (uint32_t childIdx = 0; childIdx < childCount; childIdx++) { AccessibleOrProxy child = IntlGeneric().ChildAt(childIdx); children->AppendElement(static_cast<nsIAccessible*>(ToXPC(child)), false); } children.forget(aChildren); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetIndexInParent(int32_t* aIndexInParent) { NS_ENSURE_ARG_POINTER(aIndexInParent); *aIndexInParent = -1; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (IntlGeneric().IsAccessible()) { *aIndexInParent = Intl()->IndexInParent(); } else if (IntlGeneric().IsProxy()) { *aIndexInParent = IntlGeneric().AsProxy()->IndexInParent(); } return *aIndexInParent != -1 ? NS_OK : NS_ERROR_FAILURE; } NS_IMETHODIMP xpcAccessible::GetDOMNode(nsIDOMNode** aDOMNode) { NS_ENSURE_ARG_POINTER(aDOMNode); *aDOMNode = nullptr; if (!Intl()) return NS_ERROR_FAILURE; nsINode* node = Intl()->GetNode(); if (node) CallQueryInterface(node, aDOMNode); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetId(nsAString& aID) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else ProxyAccessible* proxy = IntlGeneric().AsProxy(); if (!proxy) { return NS_ERROR_FAILURE; } nsString id; proxy->DOMNodeID(id); aID.Assign(id); return NS_OK; #endif } NS_IMETHODIMP xpcAccessible::GetDocument(nsIAccessibleDocument** aDocument) { NS_ENSURE_ARG_POINTER(aDocument); *aDocument = nullptr; if (!Intl()) return NS_ERROR_FAILURE; NS_IF_ADDREF(*aDocument = ToXPCDocument(Intl()->Document())); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetRootDocument(nsIAccessibleDocument** aRootDocument) { NS_ENSURE_ARG_POINTER(aRootDocument); *aRootDocument = nullptr; if (!Intl()) return NS_ERROR_FAILURE; NS_IF_ADDREF(*aRootDocument = ToXPCDocument(Intl()->RootAccessible())); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetRole(uint32_t* aRole) { NS_ENSURE_ARG_POINTER(aRole); *aRole = nsIAccessibleRole::ROLE_NOTHING; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; *aRole = IntlGeneric().Role(); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetState(uint32_t* aState, uint32_t* aExtraState) { NS_ENSURE_ARG_POINTER(aState); if (IntlGeneric().IsNull()) nsAccUtils::To32States(states::DEFUNCT, aState, aExtraState); else if (Intl()) nsAccUtils::To32States(Intl()->State(), aState, aExtraState); else nsAccUtils::To32States(IntlGeneric().AsProxy()->State(), aState, aExtraState); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetName(nsAString& aName) { aName.Truncate(); if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsAutoString name; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { proxy->Name(name); } else { Intl()->Name(name); } aName.Assign(name); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetDescription(nsAString& aDescription) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsAutoString desc; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { proxy->Description(desc); } else { Intl()->Description(desc); } aDescription.Assign(desc); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetLanguage(nsAString& aLanguage) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsAutoString lang; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { proxy->Language(lang); } else { Intl()->Language(lang); } aLanguage.Assign(lang); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetValue(nsAString& aValue) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsAutoString value; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { proxy->Value(value); } else { Intl()->Value(value); } aValue.Assign(value); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetHelp(nsAString& aHelp) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsAutoString help; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->Help(help); #endif } else { Intl()->Help(help); } aHelp.Assign(help); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetAccessKey(nsAString& aAccessKey) { aAccessKey.Truncate(); if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->AccessKey().ToString(aAccessKey); #endif } else { Intl()->AccessKey().ToString(aAccessKey); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetKeyboardShortcut(nsAString& aKeyBinding) { aKeyBinding.Truncate(); if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->KeyboardShortcut().ToString(aKeyBinding); #endif } else { Intl()->KeyboardShortcut().ToString(aKeyBinding); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetAttributes(nsIPersistentProperties** aAttributes) { NS_ENSURE_ARG_POINTER(aAttributes); *aAttributes = nullptr; if (IntlGeneric().IsNull()) { return NS_ERROR_FAILURE; } if (Accessible* acc = Intl()) { nsCOMPtr<nsIPersistentProperties> attributes = acc->Attributes(); attributes.swap(*aAttributes); return NS_OK; } ProxyAccessible* proxy = IntlGeneric().AsProxy(); AutoTArray<Attribute, 10> attrs; proxy->Attributes(&attrs); nsCOMPtr<nsIPersistentProperties> props = do_CreateInstance(NS_PERSISTENTPROPERTIES_CONTRACTID); uint32_t attrCount = attrs.Length(); nsAutoString unused; for (uint32_t i = 0; i < attrCount; i++) { props->SetStringProperty(attrs[i].Name(), attrs[i].Value(), unused); } props.forget(aAttributes); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetBounds(int32_t* aX, int32_t* aY, int32_t* aWidth, int32_t* aHeight) { NS_ENSURE_ARG_POINTER(aX); *aX = 0; NS_ENSURE_ARG_POINTER(aY); *aY = 0; NS_ENSURE_ARG_POINTER(aWidth); *aWidth = 0; NS_ENSURE_ARG_POINTER(aHeight); *aHeight = 0; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsIntRect rect; if (Accessible* acc = IntlGeneric().AsAccessible()) { rect = acc->Bounds(); } else { rect = IntlGeneric().AsProxy()->Bounds(); } *aX = rect.x; *aY = rect.y; *aWidth = rect.width; *aHeight = rect.height; return NS_OK; } NS_IMETHODIMP xpcAccessible::GroupPosition(int32_t* aGroupLevel, int32_t* aSimilarItemsInGroup, int32_t* aPositionInGroup) { NS_ENSURE_ARG_POINTER(aGroupLevel); *aGroupLevel = 0; NS_ENSURE_ARG_POINTER(aSimilarItemsInGroup); *aSimilarItemsInGroup = 0; NS_ENSURE_ARG_POINTER(aPositionInGroup); *aPositionInGroup = 0; if (!Intl()) return NS_ERROR_FAILURE; GroupPos groupPos = Intl()->GroupPosition(); *aGroupLevel = groupPos.level; *aSimilarItemsInGroup = groupPos.setSize; *aPositionInGroup = groupPos.posInSet; return NS_OK; } NS_IMETHODIMP xpcAccessible::GetRelationByType(uint32_t aType, nsIAccessibleRelation** aRelation) { NS_ENSURE_ARG_POINTER(aRelation); *aRelation = nullptr; NS_ENSURE_ARG(aType <= static_cast<uint32_t>(RelationType::LAST)); if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (IntlGeneric().IsAccessible()) { Relation rel = Intl()->RelationByType(static_cast<RelationType>(aType)); NS_ADDREF(*aRelation = new nsAccessibleRelation(aType, &rel)); return NS_OK; } #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else ProxyAccessible* proxy = IntlGeneric().AsProxy(); nsTArray<ProxyAccessible*> targets = proxy->RelationByType(static_cast<RelationType>(aType)); NS_ADDREF(*aRelation = new nsAccessibleRelation(aType, &targets)); return NS_OK; #endif } NS_IMETHODIMP xpcAccessible::GetRelations(nsIArray** aRelations) { NS_ENSURE_ARG_POINTER(aRelations); *aRelations = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; nsCOMPtr<nsIMutableArray> relations = do_CreateInstance(NS_ARRAY_CONTRACTID); NS_ENSURE_TRUE(relations, NS_ERROR_OUT_OF_MEMORY); static const uint32_t relationTypes[] = { nsIAccessibleRelation::RELATION_LABELLED_BY, nsIAccessibleRelation::RELATION_LABEL_FOR, nsIAccessibleRelation::RELATION_DESCRIBED_BY, nsIAccessibleRelation::RELATION_DESCRIPTION_FOR, nsIAccessibleRelation::RELATION_NODE_CHILD_OF, nsIAccessibleRelation::RELATION_NODE_PARENT_OF, nsIAccessibleRelation::RELATION_CONTROLLED_BY, nsIAccessibleRelation::RELATION_CONTROLLER_FOR, nsIAccessibleRelation::RELATION_FLOWS_TO, nsIAccessibleRelation::RELATION_FLOWS_FROM, nsIAccessibleRelation::RELATION_MEMBER_OF, nsIAccessibleRelation::RELATION_SUBWINDOW_OF, nsIAccessibleRelation::RELATION_EMBEDS, nsIAccessibleRelation::RELATION_EMBEDDED_BY, nsIAccessibleRelation::RELATION_POPUP_FOR, nsIAccessibleRelation::RELATION_PARENT_WINDOW_OF, nsIAccessibleRelation::RELATION_DEFAULT_BUTTON, nsIAccessibleRelation::RELATION_CONTAINING_DOCUMENT, nsIAccessibleRelation::RELATION_CONTAINING_TAB_PANE, nsIAccessibleRelation::RELATION_CONTAINING_APPLICATION }; for (uint32_t idx = 0; idx < ArrayLength(relationTypes); idx++) { nsCOMPtr<nsIAccessibleRelation> relation; nsresult rv = GetRelationByType(relationTypes[idx], getter_AddRefs(relation)); if (NS_SUCCEEDED(rv) && relation) { uint32_t targets = 0; relation->GetTargetsCount(&targets); if (targets) relations->AppendElement(relation, false); } } NS_ADDREF(*aRelations = relations); return NS_OK; } NS_IMETHODIMP xpcAccessible::GetFocusedChild(nsIAccessible** aChild) { NS_ENSURE_ARG_POINTER(aChild); *aChild = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else NS_IF_ADDREF(*aChild = ToXPC(proxy->FocusedChild())); #endif } else { NS_IF_ADDREF(*aChild = ToXPC(Intl()->FocusedChild())); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetChildAtPoint(int32_t aX, int32_t aY, nsIAccessible** aAccessible) { NS_ENSURE_ARG_POINTER(aAccessible); *aAccessible = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else NS_IF_ADDREF(*aAccessible = ToXPC(proxy->ChildAtPoint(aX, aY, Accessible::eDirectChild))); #endif } else { NS_IF_ADDREF(*aAccessible = ToXPC(Intl()->ChildAtPoint(aX, aY, Accessible::eDirectChild))); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetDeepestChildAtPoint(int32_t aX, int32_t aY, nsIAccessible** aAccessible) { NS_ENSURE_ARG_POINTER(aAccessible); *aAccessible = nullptr; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else NS_IF_ADDREF(*aAccessible = ToXPC(proxy->ChildAtPoint(aX, aY, Accessible::eDeepestChild))); #endif } else { NS_IF_ADDREF(*aAccessible = ToXPC(Intl()->ChildAtPoint(aX, aY, Accessible::eDeepestChild))); } return NS_OK; } NS_IMETHODIMP xpcAccessible::SetSelected(bool aSelect) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->SetSelected(aSelect); #endif } else { Intl()->SetSelected(aSelect); } return NS_OK; } NS_IMETHODIMP xpcAccessible::TakeSelection() { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->TakeSelection(); #endif } else { Intl()->TakeSelection(); } return NS_OK; } NS_IMETHODIMP xpcAccessible::TakeFocus() { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->TakeFocus(); #endif } else { Intl()->TakeFocus(); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetActionCount(uint8_t* aActionCount) { NS_ENSURE_ARG_POINTER(aActionCount); *aActionCount = 0; if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else *aActionCount = proxy->ActionCount(); #endif } else { *aActionCount = Intl()->ActionCount(); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetActionName(uint8_t aIndex, nsAString& aName) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else nsString name; proxy->ActionNameAt(aIndex, name); aName.Assign(name); #endif } else { if (aIndex >= Intl()->ActionCount()) return NS_ERROR_INVALID_ARG; Intl()->ActionNameAt(aIndex, aName); } return NS_OK; } NS_IMETHODIMP xpcAccessible::GetActionDescription(uint8_t aIndex, nsAString& aDescription) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else nsString description; proxy->ActionDescriptionAt(aIndex, description); aDescription.Assign(description); #endif } else { if (aIndex >= Intl()->ActionCount()) return NS_ERROR_INVALID_ARG; Intl()->ActionDescriptionAt(aIndex, aDescription); } return NS_OK; } NS_IMETHODIMP xpcAccessible::DoAction(uint8_t aIndex) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else return proxy->DoAction(aIndex) ? NS_OK : NS_ERROR_INVALID_ARG; #endif } else { return Intl()->DoAction(aIndex) ? NS_OK : NS_ERROR_INVALID_ARG; } } NS_IMETHODIMP xpcAccessible::ScrollTo(uint32_t aHow) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->ScrollTo(aHow); #endif } else { Intl()->ScrollTo(aHow); } return NS_OK; } NS_IMETHODIMP xpcAccessible::ScrollToPoint(uint32_t aCoordinateType, int32_t aX, int32_t aY) { if (IntlGeneric().IsNull()) return NS_ERROR_FAILURE; if (ProxyAccessible* proxy = IntlGeneric().AsProxy()) { #if defined(XP_WIN) return NS_ERROR_NOT_IMPLEMENTED; #else proxy->ScrollToPoint(aCoordinateType, aX, aY); #endif } else { Intl()->ScrollToPoint(aCoordinateType, aX, aY); } return NS_OK; }