2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/accessibility/bridge/bridge-accessible.h>
25 //comment out 2 lines below to get more logs
27 #define LOG() _LoggerEmpty()
29 using namespace Dali::Accessibility;
31 #define GET_NAVIGABLE_AT_POINT_MAX_RECURSION_DEPTH 10000
36 bool SortVertically(Component* lhs, Component* rhs)
38 auto leftRect = lhs->GetExtents(CoordinateType::WINDOW);
39 auto rightRect = rhs->GetExtents(CoordinateType::WINDOW);
41 return leftRect.y < rightRect.y;
44 bool SortHorizontally(Component* lhs, Component* rhs)
46 auto leftRect = lhs->GetExtents(CoordinateType::WINDOW);
47 auto rightRect = rhs->GetExtents(CoordinateType::WINDOW);
49 return leftRect.x < rightRect.x;
52 std::vector<std::vector<Component*>> SplitLines(const std::vector<Component*>& children)
54 // Find first with non-zero area
55 auto first = std::find_if(children.begin(), children.end(), [](Component* child) -> bool {
56 auto extents = child->GetExtents(CoordinateType::WINDOW);
57 return extents.height != 0.0f && extents.width != 0.0f;
60 if(first == children.end())
65 std::vector<std::vector<Component*>> lines(1);
66 Dali::Rect<> lineRect = (*first)->GetExtents(CoordinateType::WINDOW);
70 for(auto it = first; it != children.end(); ++it)
74 rect = child->GetExtents(CoordinateType::WINDOW);
75 if(rect.height == 0.0f || rect.width == 0.0f)
81 if(lineRect.y + (0.5 * lineRect.height) >= rect.y + (0.5 * rect.height))
84 lines.back().push_back(child);
91 lines.back().push_back(child);
98 static bool AcceptObjectCheckRelations(Component* obj)
100 auto relations = obj->GetRelationSet();
102 for(const auto& it : relations)
104 if(it.relationType == RelationType::CONTROLLED_BY)
112 static Component* GetScrollableParent(Accessible* obj)
116 obj = obj->GetParent();
117 auto comp = dynamic_cast<Component*>(obj);
118 if(comp && comp->IsScrollable())
126 static bool IsObjectItem(Component* obj)
132 auto role = obj->GetRole();
133 return role == Role::LIST_ITEM || role == Role::MENU_ITEM;
136 static bool IsObjectCollapsed(Component* obj)
142 const auto states = obj->GetStates();
143 return states[State::EXPANDABLE] && !states[State::EXPANDED];
146 static bool IsObjectZeroSize(Component* obj)
152 auto extents = obj->GetExtents(CoordinateType::WINDOW);
153 return extents.height == 0 || extents.width == 0;
156 static bool IsObjectAcceptable(Component* obj)
163 const auto states = obj->GetStates();
164 if(!states[State::VISIBLE])
168 if(!AcceptObjectCheckRelations(obj))
172 if(!states[State::HIGHLIGHTABLE])
177 if(GetScrollableParent(obj) != nullptr)
179 auto parent = dynamic_cast<Component*>(obj->GetParent());
183 return !IsObjectItem(obj) || !IsObjectCollapsed(parent);
188 if(IsObjectZeroSize(obj))
192 if(!states[State::SHOWING])
200 static bool IsObjectAcceptable(Accessible* obj)
202 auto component = dynamic_cast<Component*>(obj);
203 return IsObjectAcceptable(component);
206 static int32_t GetItemCountOfContainer(Accessible* obj, Dali::Accessibility::Role containerRole, Dali::Accessibility::Role itemRole, bool isDirectChild)
208 int32_t itemCount = 0;
209 if(obj && (!isDirectChild || obj->GetRole() == containerRole))
211 for(auto i = 0u; i < static_cast<size_t>(obj->GetChildCount()); ++i)
213 auto child = obj->GetChildAtIndex(i);
214 if(child && child->GetRole() == itemRole)
223 static int32_t GetItemCountOfFirstDescendantContainer(Accessible* obj, Dali::Accessibility::Role containerRole, Dali::Accessibility::Role itemRole, bool isDirectChild)
225 int32_t itemCount = 0;
226 itemCount = GetItemCountOfContainer(obj, containerRole, itemRole, isDirectChild);
227 if(itemCount > 0 || !obj)
232 for(auto i = 0u; i < static_cast<size_t>(obj->GetChildCount()); ++i)
234 auto child = obj->GetChildAtIndex(i);
235 itemCount = GetItemCountOfFirstDescendantContainer(child, containerRole, itemRole, isDirectChild);
244 static std::string GetComponentInfo(Component* obj)
251 std::ostringstream object;
252 auto extent = obj->GetExtents(CoordinateType::SCREEN);
253 object << "name: " << obj->GetName() << " extent: (" << extent.x << ", "
254 << extent.y << "), [" << extent.width << ", " << extent.height << "]";
258 static std::string MakeIndent(unsigned int maxRecursionDepth)
260 return std::string(GET_NAVIGABLE_AT_POINT_MAX_RECURSION_DEPTH - maxRecursionDepth, ' ');
263 static bool IsDeputy(Accessible* obj)
269 static Accessible* GetProxyInParent(Accessible* obj)
276 auto children = obj->GetChildren();
277 for(auto& child : children)
287 static bool IsRoleAcceptableWhenNavigatingNextPrev(Accessible* obj)
293 auto role = obj->GetRole();
294 return role != Role::POPUP_MENU && role != Role::DIALOG;
297 static Accessible* FindNonDefunctChild(const std::vector<Component*>& children, unsigned int currentIndex, unsigned char forward)
299 unsigned int childrenCount = children.size();
300 for(; currentIndex < childrenCount; forward ? ++currentIndex : --currentIndex)
302 Accessible* object = children[currentIndex];
303 if(object && !object->GetStates()[State::DEFUNCT])
311 // The auxiliary method for Depth-First Search (DFS) algorithm to find non defunct child directionally
312 static Accessible* FindNonDefunctChildWithDepthFirstSearch(Accessible* node, const std::vector<Component*>& children, unsigned char forward)
319 auto childrenCount = children.size();
320 if(childrenCount > 0)
322 const bool isShowing = GetScrollableParent(node) == nullptr ? node->GetStates()[State::SHOWING] : true;
325 return FindNonDefunctChild(children, forward ? 0 : childrenCount - 1, forward);
331 static bool CheckChainEndWithAttribute(Accessible* obj, unsigned char forward)
338 auto attrs = obj->GetAttributes();
339 for(auto& attr : attrs)
341 if(attr.first == "relation_chain_end")
343 if((attr.second == "prev,end" && forward == 0) || (attr.second == "next,end" && forward == 1) || attr.second == "prev,next,end")
352 static Accessible* GetDeputyOfProxyInParent(Accessible* obj)
357 static std::vector<Component*> GetScrollableParents(Accessible *accessible)
359 std::vector<Component*> scrollableParents;
363 accessible = accessible->GetParent();
364 auto component = dynamic_cast<Component*>(accessible);
365 if(component && component->IsScrollable())
367 scrollableParents.push_back(component);
370 return scrollableParents;
373 static std::vector<Component*> GetNonDuplicatedScrollableParents(Accessible *child, Accessible *start)
375 auto scrollableParentsOfChild = GetScrollableParents(child);
376 auto scrollableParentsOfStart = GetScrollableParents(start);
378 // find the first different scrollable parent by comparing from top to bottom.
379 // since it can not be the same after that, there is no need to compare.
380 while(!scrollableParentsOfChild.empty() && !scrollableParentsOfStart.empty() && scrollableParentsOfChild.back() == scrollableParentsOfStart.back())
382 scrollableParentsOfChild.pop_back();
383 scrollableParentsOfStart.pop_back();
386 return scrollableParentsOfChild;
389 } // anonymous namespace
392 BridgeAccessible::BridgeAccessible()
396 void BridgeAccessible::RegisterInterfaces()
398 DBus::DBusInterfaceDescription desc{AtspiDbusInterfaceAccessible};
399 AddGetPropertyToInterface(desc, "ChildCount", &BridgeAccessible::GetChildCount);
400 AddGetPropertyToInterface(desc, "Name", &BridgeAccessible::GetName);
401 AddGetPropertyToInterface(desc, "Description", &BridgeAccessible::GetDescription);
402 AddGetPropertyToInterface(desc, "Parent", &BridgeAccessible::GetParent);
403 AddFunctionToInterface(desc, "GetRole", &BridgeAccessible::GetRole);
404 AddFunctionToInterface(desc, "GetRoleName", &BridgeAccessible::GetRoleName);
405 AddFunctionToInterface(desc, "GetLocalizedRoleName", &BridgeAccessible::GetLocalizedRoleName);
406 AddFunctionToInterface(desc, "GetState", &BridgeAccessible::GetStates);
407 AddFunctionToInterface(desc, "GetAttributes", &BridgeAccessible::GetAttributes);
408 AddFunctionToInterface(desc, "GetInterfaces", &BridgeAccessible::GetInterfaces);
409 AddFunctionToInterface(desc, "GetChildAtIndex", &BridgeAccessible::GetChildAtIndex);
410 AddFunctionToInterface(desc, "GetChildren", &BridgeAccessible::GetChildren);
411 AddFunctionToInterface(desc, "GetIndexInParent", &BridgeAccessible::GetIndexInParent);
412 AddFunctionToInterface(desc, "GetNavigableAtPoint", &BridgeAccessible::GetNavigableAtPoint);
413 AddFunctionToInterface(desc, "GetNeighbor", &BridgeAccessible::GetNeighbor);
414 AddFunctionToInterface(desc, "GetDefaultLabelInfo", &BridgeAccessible::GetDefaultLabelInfo);
415 AddFunctionToInterface(desc, "DoGesture", &BridgeAccessible::DoGesture);
416 AddFunctionToInterface(desc, "GetReadingMaterial", &BridgeAccessible::GetReadingMaterial);
417 AddFunctionToInterface(desc, "GetRelationSet", &BridgeAccessible::GetRelationSet);
418 mDbusServer.addInterface("/", desc, true);
421 Component* BridgeAccessible::GetObjectInRelation(Accessible* obj, RelationType relationType)
428 for(auto& relation : obj->GetRelationSet())
430 if(relation.relationType == relationType)
432 for(auto& address : relation.targets)
434 auto component = dynamic_cast<Component*>(Find(address));
445 Component* BridgeAccessible::CalculateNavigableAccessibleAtPoint(Accessible* root, Point point, CoordinateType type, unsigned int maxRecursionDepth)
447 if(!root || maxRecursionDepth == 0)
452 auto rootComponent = dynamic_cast<Component*>(root);
453 LOG() << "CalculateNavigableAccessibleAtPoint: checking: " << MakeIndent(maxRecursionDepth) << GetComponentInfo(rootComponent);
455 if(rootComponent && !rootComponent->IsAccessibleContainingPoint(point, type))
460 auto children = root->GetChildren();
461 for(auto childIt = children.rbegin(); childIt != children.rend(); childIt++)
463 //check recursively all children first
464 auto result = CalculateNavigableAccessibleAtPoint(*childIt, point, type, maxRecursionDepth - 1);
473 //Found a candidate, all its children are already checked
474 auto controledBy = GetObjectInRelation(rootComponent, RelationType::CONTROLLED_BY);
477 controledBy = rootComponent;
480 if(controledBy->IsProxy() || IsObjectAcceptable(controledBy))
482 LOG() << "CalculateNavigableAccessibleAtPoint: found: " << MakeIndent(maxRecursionDepth) << GetComponentInfo(rootComponent);
489 BridgeAccessible::ReadingMaterialType BridgeAccessible::GetReadingMaterial()
491 auto self = FindSelf();
492 auto findObjectByRelationType = [this, &self](RelationType relationType) {
493 auto relations = self->GetRelationSet();
494 auto relation = std::find_if(relations.begin(),
496 [relationType](const Dali::Accessibility::Relation& relation) -> bool {
497 return relation.relationType == relationType;
499 return relations.end() != relation && !relation->targets.empty() ? Find(relation->targets.back()) : nullptr;
502 auto labellingObject = findObjectByRelationType(RelationType::LABELLED_BY);
503 std::string labeledByName = labellingObject ? labellingObject->GetName() : "";
505 auto describedByObject = findObjectByRelationType(RelationType::DESCRIBED_BY);
507 double currentValue = 0.0;
508 double minimumIncrement = 0.0;
509 double maximumValue = 0.0;
510 double minimumValue = 0.0;
511 auto* valueInterface = dynamic_cast<Dali::Accessibility::Value*>(self);
514 currentValue = valueInterface->GetCurrent();
515 minimumIncrement = valueInterface->GetMinimumIncrement();
516 maximumValue = valueInterface->GetMaximum();
517 minimumValue = valueInterface->GetMinimum();
520 int32_t firstSelectedChildIndex = -1;
521 int32_t selectedChildCount = 0;
522 auto* selfSelectionInterface = dynamic_cast<Dali::Accessibility::Selection*>(self);
523 if(selfSelectionInterface)
525 selectedChildCount = selfSelectionInterface->GetSelectedChildrenCount();
526 auto firstSelectedChild = selfSelectionInterface->GetSelectedChild(0);
527 if(firstSelectedChild)
529 firstSelectedChildIndex = firstSelectedChild->GetIndexInParent();
533 auto childCount = static_cast<int32_t>(self->GetChildCount());
534 bool hasCheckBoxChild = false;
535 for(auto i = 0u; i < static_cast<size_t>(childCount); ++i)
537 auto child = self->GetChildAtIndex(i);
538 if(child->GetRole() == Role::CHECK_BOX)
540 hasCheckBoxChild = true;
545 auto atspiRole = self->GetRole();
546 int32_t listChildrenCount = 0;
547 if(atspiRole == Role::DIALOG)
549 listChildrenCount = GetItemCountOfFirstDescendantContainer(self, Role::LIST, Role::LIST_ITEM, true);
551 else if(atspiRole == Role::POPUP_MENU)
553 listChildrenCount = GetItemCountOfFirstDescendantContainer(self, Role::POPUP_MENU, Role::MENU_ITEM, false);
556 auto* textInterface = dynamic_cast<Dali::Accessibility::Text*>(self);
557 std::string nameFromTextInterface = "";
560 nameFromTextInterface = textInterface->GetText(0, textInterface->GetCharacterCount());
563 auto attributes = self->GetAttributes();
564 auto name = self->GetName();
565 auto role = static_cast<uint32_t>(atspiRole);
566 auto states = self->GetStates();
567 auto localizedRoleName = self->GetLocalizedRoleName();
568 auto description = self->GetDescription();
569 auto indexInParent = static_cast<int32_t>(self->GetIndexInParent());
571 auto parent = self->GetParent();
572 auto parentRole = static_cast<uint32_t>(parent ? parent->GetRole() : Role{});
573 auto parentChildCount = parent ? static_cast<int32_t>(parent->GetChildCount()) : 0;
574 auto parentStateSet = parent ? parent->GetStates() : States{};
575 bool isSelectedInParent = false;
576 auto* parentSelectionInterface = dynamic_cast<Dali::Accessibility::Selection*>(parent);
577 if(parentSelectionInterface)
579 isSelectedInParent = parentSelectionInterface->IsChildSelected(indexInParent);
586 nameFromTextInterface,
600 firstSelectedChildIndex,
609 void BridgeAccessible::SuppressScreenReader(bool suppress)
611 mIsScreenReaderSuppressed = suppress;
614 DBus::ValueOrError<bool> BridgeAccessible::DoGesture(Dali::Accessibility::Gesture type, int32_t startPositionX, int32_t startPositionY, int32_t endPositionX, int32_t endPositionY, Dali::Accessibility::GestureState state, uint32_t eventTime)
616 // Please be aware of sending GestureInfo point in the different order with parameters
617 return FindSelf()->DoGesture(Dali::Accessibility::GestureInfo{type, startPositionX, endPositionX, startPositionY, endPositionY, state, eventTime});
620 DBus::ValueOrError<Accessible*, uint8_t, Accessible*> BridgeAccessible::GetNavigableAtPoint(int32_t x, int32_t y, uint32_t coordinateType)
622 Accessible* deputy = nullptr;
623 auto accessible = FindSelf();
624 auto cType = static_cast<CoordinateType>(coordinateType);
625 LOG() << "GetNavigableAtPoint: " << x << ", " << y << " type: " << coordinateType;
626 auto component = CalculateNavigableAccessibleAtPoint(accessible, {x, y}, cType, GET_NAVIGABLE_AT_POINT_MAX_RECURSION_DEPTH);
627 bool recurse = false;
630 recurse = component->IsProxy();
633 return {component, recurse, deputy};
636 Accessible* BridgeAccessible::GetCurrentlyHighlighted()
638 //TODO: add currently highlighted object
642 std::vector<Component*> BridgeAccessible::GetValidChildren(const std::vector<Accessible*>& children, Accessible* start)
649 std::vector<Component*> vec;
651 Dali::Rect<> scrollableParentExtents;
652 auto nonDuplicatedScrollableParents = GetNonDuplicatedScrollableParents(children.front(), start);
653 if (!nonDuplicatedScrollableParents.empty())
655 scrollableParentExtents = nonDuplicatedScrollableParents.front()->GetExtents(CoordinateType::WINDOW);
658 for(auto child : children)
660 auto* component = dynamic_cast<Component*>(child);
663 if(nonDuplicatedScrollableParents.empty() || scrollableParentExtents.Intersects(component->GetExtents(CoordinateType::WINDOW)))
665 vec.push_back(component);
673 void BridgeAccessible::SortChildrenFromTopLeft(std::vector<Dali::Accessibility::Component*>& children)
680 std::vector<Component*> sortedChildren;
682 std::sort(children.begin(), children.end(), &SortVertically);
684 for(auto& line : SplitLines(children))
686 std::sort(line.begin(), line.end(), &SortHorizontally);
687 sortedChildren.insert(sortedChildren.end(), line.begin(), line.end());
690 children = sortedChildren;
695 struct CycleDetection
697 CycleDetection(const T value)
699 mCurrentSearchSize(1),
704 bool Check(const T value)
713 mCurrentSearchSize <<= 1;
714 if(mCurrentSearchSize == 0)
716 return true; // UNDEFINED BEHAVIOR
718 mCounter = mCurrentSearchSize;
725 unsigned int mCurrentSearchSize;
726 unsigned int mCounter;
729 Accessible* BridgeAccessible::GetNextNonDefunctSibling(Accessible* obj, Accessible* start, unsigned char forward)
736 auto parent = obj->GetParent();
742 auto children = GetValidChildren(parent->GetChildren(), start);
743 SortChildrenFromTopLeft(children);
745 unsigned int childrenCount = children.size();
746 if(childrenCount == 0)
751 unsigned int current = 0;
752 for(; current < childrenCount && children[current] != obj; ++current)
756 if(current >= childrenCount)
761 forward ? ++current : --current;
762 auto ret = FindNonDefunctChild(children, current, forward);
766 Accessible* BridgeAccessible::FindNonDefunctSibling(bool& areAllChildrenVisited, Accessible* node, Accessible* start, Accessible* root, unsigned char forward)
770 Accessible* sibling = GetNextNonDefunctSibling(node, start, forward);
774 areAllChildrenVisited = false; // Note that this is passed by non-const reference, so it is the caller that can determine whether this search exhausted all children.
778 node = node->GetParent();
779 if(node == nullptr || node == root)
784 // in backward traversing stop the walk up on parent
794 Accessible* BridgeAccessible::CalculateNeighbor(Accessible* root, Accessible* start, unsigned char forward, BridgeAccessible::NeighborSearchMode searchMode)
796 if(start && CheckChainEndWithAttribute(start, forward))
800 if(root && root->GetStates()[State::DEFUNCT])
804 if(start && start->GetStates()[State::DEFUNCT])
810 if(searchMode == BridgeAccessible::NeighborSearchMode::RECURSE_TO_OUTSIDE)
812 // This only works if we navigate backward, and it is not possible to
813 // find in embedded process. In this case the deputy should be used */
814 return GetDeputyOfProxyInParent(start);
817 Accessible* node = start ? start : root;
823 // initialization of all-children-visited flag for start node - we assume
824 // that when we begin at start node and we navigate backward, then all children
825 // are visited, so navigation will ignore start's children and go to
826 // previous sibling available.
827 // Regarding condtion (start != root):
828 // The last object can be found only if areAllChildrenVisited is false.
829 // The start is same with root, when looking for the last object.
830 bool areAllChildrenVisited = (start != root) && (searchMode != BridgeAccessible::NeighborSearchMode::RECURSE_FROM_ROOT && !forward);
832 // true, if starting element should be ignored. this is only used in rare case of
833 // recursive search failing to find an object.
834 // consider tree, where element A on bus BUS_A has child B on bus BUS_B. when going "next" from
835 // element A algorithm has to descend into BUS_B and search element B and its children. this is done
836 // by returning to our caller object B with special flag set (meaning - continue the search from B on bus BUS_B).
837 // if next object will be found there (on BUS_B), then search ends. but if not, then our caller will find it out
838 // and will call us again with object A and flag searchMode set to NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING.
839 // this flag means, that object A was already checked previously and we should skip it and its children.
840 bool forceNext = (searchMode == BridgeAccessible::NeighborSearchMode::CONTINUE_AFTER_FAILED_RECURSION);
842 CycleDetection<Accessible*> cycleDetection(node);
845 if(node->GetStates()[State::DEFUNCT])
850 // always accept proxy object from different world
851 if(!forceNext && node->IsProxy())
856 auto children = GetValidChildren(node->GetChildren(), start);
857 SortChildrenFromTopLeft(children);
861 // 2. parent after all children in backward traversing
862 // 3. Nodes with roles: ATSPI_ROLE_PAGE_TAB, ATSPI_ROLE_POPUP_MENU and ATSPI_ROLE_DIALOG, only when looking for first or last element.
863 // Objects with those roles shouldnt be reachable, when navigating next / prev.
864 bool areAllChildrenVisitedOrMovingForward= (children.size() == 0 || forward || areAllChildrenVisited);
866 if(!forceNext && node != start && areAllChildrenVisitedOrMovingForward && IsObjectAcceptable(node))
868 if(start == NULL || IsRoleAcceptableWhenNavigatingNextPrev(node))
874 Accessible* nextRelatedInDirection = !forceNext ? GetObjectInRelation(node, forward ? RelationType::FLOWS_TO : RelationType::FLOWS_FROM) : nullptr;
875 // forceNext means that the searchMode is NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING
876 // in this case the node is elm_layout which is parent of proxy object.
877 // There is an access object working for the proxy object, and the access
878 // object could have relation information. This relation information should
879 // be checked first before using the elm_layout as a node.
880 if(forceNext && forward)
882 auto deputy = GetDeputyOfProxyInParent(node);
883 nextRelatedInDirection = GetObjectInRelation(deputy, RelationType::FLOWS_TO);
886 if(nextRelatedInDirection && start && start->GetStates()[State::DEFUNCT])
888 nextRelatedInDirection = NULL;
891 unsigned char wantCycleDetection = 0;
892 if(nextRelatedInDirection)
894 // Check whether nextRelatedInDirection is deputy object or not
898 // If the prev object is deputy, then go to inside of its proxy first
899 if(IsDeputy(nextRelatedInDirection))
901 parent = nextRelatedInDirection->GetParent();
902 nextRelatedInDirection = GetProxyInParent(parent);
907 // If current object is deputy, and it has relation next object,
908 // then do not use the relation next object, and use proxy first
911 parent = node->GetParent();
912 nextRelatedInDirection = GetProxyInParent(parent);
915 node = nextRelatedInDirection;
916 wantCycleDetection = 1;
920 auto child = !forceNext && !areAllChildrenVisited ? FindNonDefunctChildWithDepthFirstSearch(node, children, forward) : nullptr;
923 wantCycleDetection = 1;
927 if(!forceNext && node == root)
931 areAllChildrenVisited = true;
932 child = FindNonDefunctSibling(areAllChildrenVisited, node, start, root, forward);
938 if(wantCycleDetection && cycleDetection.Check(node))
946 DBus::ValueOrError<Accessible*, uint8_t> BridgeAccessible::GetNeighbor(std::string rootPath, int32_t direction, int32_t searchMode)
948 auto start = FindSelf();
949 rootPath = StripPrefix(rootPath);
950 auto root = !rootPath.empty() ? Find(rootPath) : nullptr;
951 auto accessible = CalculateNeighbor(root, start, direction == 1, static_cast<NeighborSearchMode>(searchMode));
952 unsigned char recurse = 0;
955 recurse = accessible->IsProxy();
957 return {accessible, recurse};
960 Accessible* BridgeAccessible::GetParent()
962 // NOTE: currently bridge supports single application root element.
963 // only element set as application root might return nullptr from GetParent
964 // if you want more, then you need to change setApplicationRoot to
965 // add/remove ApplicationRoot and make roots a vector.
966 auto parent = FindSelf()->GetParent();
971 DBus::ValueOrError<std::vector<Accessible*>> BridgeAccessible::GetChildren()
973 return FindSelf()->GetChildren();
976 std::string BridgeAccessible::GetDescription()
978 return FindSelf()->GetDescription();
981 DBus::ValueOrError<uint32_t> BridgeAccessible::GetRole()
983 return static_cast<unsigned int>(FindSelf()->GetRole());
986 DBus::ValueOrError<std::string> BridgeAccessible::GetRoleName()
988 return FindSelf()->GetRoleName();
991 DBus::ValueOrError<std::string> BridgeAccessible::GetLocalizedRoleName()
993 return FindSelf()->GetLocalizedRoleName();
996 DBus::ValueOrError<int32_t> BridgeAccessible::GetIndexInParent()
998 return FindSelf()->GetIndexInParent();
1001 DBus::ValueOrError<std::array<uint32_t, 2>> BridgeAccessible::GetStates()
1003 return FindSelf()->GetStates().GetRawData();
1006 DBus::ValueOrError<std::unordered_map<std::string, std::string>> BridgeAccessible::GetAttributes()
1008 std::unordered_map<std::string, std::string> attributes = FindSelf()->GetAttributes();
1010 if(mIsScreenReaderSuppressed)
1012 attributes.insert({"suppress-screen-reader", "true"});
1018 DBus::ValueOrError<std::vector<std::string>> BridgeAccessible::GetInterfaces()
1020 return FindSelf()->GetInterfaces();
1023 int BridgeAccessible::GetChildCount()
1025 return FindSelf()->GetChildCount();
1028 DBus::ValueOrError<Accessible*> BridgeAccessible::GetChildAtIndex(int index)
1032 throw std::domain_error{"negative index (" + std::to_string(index) + ")"};
1034 return FindSelf()->GetChildAtIndex(static_cast<size_t>(index));
1037 std::string BridgeAccessible::GetName()
1039 return FindSelf()->GetName();
1042 DBus::ValueOrError<Accessible*, uint32_t, std::unordered_map<std::string, std::string>> BridgeAccessible::GetDefaultLabelInfo()
1044 auto defaultLabel = FindSelf()->GetDefaultLabel();
1045 // By default, the text is taken from navigation context root's accessibility properties name and description.
1046 return {defaultLabel, static_cast<uint32_t>(defaultLabel->GetRole()), defaultLabel->GetAttributes()};
1049 DBus::ValueOrError<std::vector<BridgeAccessible::Relation>> BridgeAccessible::GetRelationSet()
1051 auto relations = FindSelf()->GetRelationSet();
1052 std::vector<BridgeAccessible::Relation> ret;
1054 for(auto& it : relations)
1056 ret.emplace_back(Relation{static_cast<uint32_t>(it.relationType), it.targets});