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
35 bool SortVertically(Component* lhs, Component* rhs)
37 auto leftRect = lhs->GetExtents(CoordinateType::WINDOW);
38 auto rightRect = rhs->GetExtents(CoordinateType::WINDOW);
40 return leftRect.y < rightRect.y;
43 bool SortHorizontally(Component* lhs, Component* rhs)
45 auto leftRect = lhs->GetExtents(CoordinateType::WINDOW);
46 auto rightRect = rhs->GetExtents(CoordinateType::WINDOW);
48 return leftRect.x < rightRect.x;
51 std::vector<std::vector<Component*>> SplitLines(const std::vector<Component*>& children)
53 // Find first with non-zero area
54 auto first = std::find_if(children.begin(), children.end(), [](Component* component) -> bool {
55 auto extents = component->GetExtents(CoordinateType::WINDOW);
56 return extents.height != 0.0f && extents.width != 0.0f;
59 if(first == children.end())
64 std::vector<std::vector<Component*>> lines(1);
65 Dali::Rect<> lineRect = (*first)->GetExtents(CoordinateType::WINDOW);
69 for(auto it = first; it != children.end(); ++it)
73 rect = child->GetExtents(CoordinateType::WINDOW);
74 if(rect.height == 0.0f || rect.width == 0.0f)
80 if(lineRect.y + (0.25 * lineRect.height) >= rect.y)
83 lines.back().push_back(child);
90 lines.back().push_back(child);
97 } // anonymous namespace
99 BridgeAccessible::BridgeAccessible()
103 void BridgeAccessible::RegisterInterfaces()
105 DBus::DBusInterfaceDescription desc{AtspiDbusInterfaceAccessible};
106 AddGetPropertyToInterface(desc, "ChildCount", &BridgeAccessible::GetChildCount);
107 AddGetPropertyToInterface(desc, "Name", &BridgeAccessible::GetName);
108 AddGetPropertyToInterface(desc, "Description", &BridgeAccessible::GetDescription);
109 AddGetPropertyToInterface(desc, "Parent", &BridgeAccessible::GetParent);
110 AddFunctionToInterface(desc, "GetRole", &BridgeAccessible::GetRole);
111 AddFunctionToInterface(desc, "GetRoleName", &BridgeAccessible::GetRoleName);
112 AddFunctionToInterface(desc, "GetLocalizedRoleName", &BridgeAccessible::GetLocalizedRoleName);
113 AddFunctionToInterface(desc, "GetState", &BridgeAccessible::GetStates);
114 AddFunctionToInterface(desc, "GetAttributes", &BridgeAccessible::GetAttributes);
115 AddFunctionToInterface(desc, "GetInterfaces", &BridgeAccessible::GetInterfaces);
116 AddFunctionToInterface(desc, "GetChildAtIndex", &BridgeAccessible::GetChildAtIndex);
117 AddFunctionToInterface(desc, "GetChildren", &BridgeAccessible::GetChildren);
118 AddFunctionToInterface(desc, "GetIndexInParent", &BridgeAccessible::GetIndexInParent);
119 AddFunctionToInterface(desc, "GetNavigableAtPoint", &BridgeAccessible::GetNavigableAtPoint);
120 AddFunctionToInterface(desc, "GetNeighbor", &BridgeAccessible::GetNeighbor);
121 AddFunctionToInterface(desc, "GetDefaultLabelInfo", &BridgeAccessible::GetDefaultLabelInfo);
122 AddFunctionToInterface(desc, "DoGesture", &BridgeAccessible::DoGesture);
123 AddFunctionToInterface(desc, "GetReadingMaterial", &BridgeAccessible::GetReadingMaterial);
124 AddFunctionToInterface(desc, "GetRelationSet", &BridgeAccessible::GetRelationSet);
125 dbusServer.addInterface("/", desc, true);
128 static bool AcceptObjectCheckRelations(Component* obj)
130 auto r = obj->GetRelationSet();
132 for(const auto& it : r)
133 if(it.relationType == RelationType::CONTROLLED_BY)
139 static Component* GetScrollableParent(Accessible* obj)
143 obj = obj->GetParent();
144 auto comp = dynamic_cast<Component*>(obj);
145 if(comp && comp->IsScrollable())
151 static bool ObjectIsItem(Component* obj)
155 auto role = obj->GetRole();
156 return role == Role::LIST_ITEM || role == Role::MENU_ITEM;
159 static bool ObjectIsCollapsed(Component* obj)
163 const auto states = obj->GetStates();
164 return states[State::EXPANDABLE] && !states[State::EXPANDED];
167 static bool ObjectIsZeroSize(Component* obj)
171 auto extents = obj->GetExtents(CoordinateType::WINDOW);
172 return extents.height == 0 || extents.width == 0;
175 static bool AcceptObject(Component* obj)
179 const auto states = obj->GetStates();
180 if(!states[State::VISIBLE])
182 if(!AcceptObjectCheckRelations(obj))
184 if(!states[State::HIGHLIGHTABLE])
187 if(GetScrollableParent(obj) != nullptr)
189 auto parent = dynamic_cast<Component*>(obj->GetParent());
193 return !ObjectIsItem(obj) || !ObjectIsCollapsed(parent);
198 if(ObjectIsZeroSize(obj))
202 if(!states[State::SHOWING])
210 static bool AcceptObject(Accessible* obj)
212 auto c = dynamic_cast<Component*>(obj);
213 return AcceptObject(c);
216 static std::string objDump(Component* obj)
220 std::ostringstream o;
221 auto e = obj->GetExtents(CoordinateType::SCREEN);
222 o << "name: " << obj->GetName() << " extent: (" << e.x << ", "
223 << e.y << "), [" << e.width << ", " << e.height << "]";
227 Component* BridgeAccessible::GetObjectInRelation(Accessible* obj, RelationType ralationType)
231 for(auto& relation : obj->GetRelationSet())
233 if(relation.relationType == ralationType)
235 for(auto& address : relation.targets)
237 auto component = dynamic_cast<Component*>(Find(address));
246 static std::string makeIndent(unsigned int maxRecursionDepth)
248 return std::string(GET_NAVIGABLE_AT_POINT_MAX_RECURSION_DEPTH - maxRecursionDepth, ' ');
251 Component* BridgeAccessible::CalculateNavigableAccessibleAtPoint(Accessible* root, Point p, CoordinateType type, unsigned int maxRecursionDepth)
253 if(!root || maxRecursionDepth == 0)
258 auto root_component = dynamic_cast<Component*>(root);
259 LOG() << "CalculateNavigableAccessibleAtPoint: checking: " << makeIndent(maxRecursionDepth) << objDump(root_component);
261 if(root_component && !root_component->IsAccessibleContainedAtPoint(p, type))
266 auto children = root->GetChildren();
267 for(auto childIt = children.rbegin(); childIt != children.rend(); childIt++)
269 //check recursively all children first
270 auto result = CalculateNavigableAccessibleAtPoint(*childIt, p, type, maxRecursionDepth - 1);
279 //Found a candidate, all its children are already checked
280 auto controledBy = GetObjectInRelation(root_component, RelationType::CONTROLLED_BY);
283 controledBy = root_component;
286 if(controledBy->IsProxy() || AcceptObject(controledBy))
288 LOG() << "CalculateNavigableAccessibleAtPoint: found: " << makeIndent(maxRecursionDepth) << objDump(root_component);
295 BridgeAccessible::ReadingMaterialType BridgeAccessible::GetReadingMaterial()
297 auto self = FindSelf();
298 auto attributes = self->GetAttributes();
299 auto name = self->GetName();
300 std::string labeledByName = "";
301 std::string textIfceName = "";
302 auto role = static_cast<uint32_t>(self->GetRole());
303 auto states = self->GetStates();
304 auto localizedName = self->GetLocalizedRoleName();
305 auto childCount = static_cast<int32_t>(self->GetChildCount());
307 double currentValue = 0.0;
308 double minimumIncrement = 0.0;
309 double maximumValue = 0.0;
310 double minimumValue = 0.0;
312 auto* value = dynamic_cast<Dali::Accessibility::Value*>(self);
315 currentValue = value->GetCurrent();
316 minimumIncrement = value->GetMinimumIncrement();
317 maximumValue = value->GetMaximum();
318 minimumValue = value->GetMinimum();
321 auto description = self->GetDescription();
322 auto indexInParent = static_cast<int32_t>(self->GetIndexInParent());
323 bool isSelectedInParent = false;
324 bool hasCheckBoxChild = false;
325 int32_t firstSelectedChildIndex = -1;
326 int32_t selectedChildCount = 0;
328 for(auto i = 0u; i < static_cast<size_t>(childCount); ++i)
330 auto q = self->GetChildAtIndex(i);
331 auto s = q->GetStates();
332 if(s[State::SELECTABLE])
334 if(s[State::SELECTED])
336 ++selectedChildCount;
337 if(firstSelectedChildIndex < 0)
338 firstSelectedChildIndex = static_cast<int32_t>(i);
341 if(q->GetRole() == Role::CHECK_BOX)
342 hasCheckBoxChild = true;
345 int32_t listChildrenCount = 0;
346 Accessible* parent = self->GetParent();
347 auto parentStateSet = parent ? parent->GetStates() : States{};
348 auto parentChildCount = parent ? static_cast<int32_t>(parent->GetChildCount()) : 0;
349 auto parentRole = static_cast<uint32_t>(parent ? parent->GetRole() : Role{});
350 Accessible* describedByObject = nullptr;
370 firstSelectedChildIndex,
379 void BridgeAccessible::SuppressScreenReader(bool suppress)
381 suppressScreenReader = suppress;
384 DBus::ValueOrError<bool> BridgeAccessible::DoGesture(Dali::Accessibility::Gesture type, int32_t xBeg, int32_t yBeg, int32_t xEnd, int32_t yEnd, Dali::Accessibility::GestureState state, uint32_t eventTime)
386 return FindSelf()->DoGesture(Dali::Accessibility::GestureInfo{type, xBeg, xEnd, yBeg, yEnd, state, eventTime});
389 DBus::ValueOrError<Accessible*, uint8_t, Accessible*> BridgeAccessible::GetNavigableAtPoint(int32_t x, int32_t y, uint32_t coordinateType)
391 Accessible* deputy = nullptr;
392 auto accessible = FindSelf();
393 auto cType = static_cast<CoordinateType>(coordinateType);
394 LOG() << "GetNavigableAtPoint: " << x << ", " << y << " type: " << coordinateType;
395 auto component = CalculateNavigableAccessibleAtPoint(accessible, {x, y}, cType, GET_NAVIGABLE_AT_POINT_MAX_RECURSION_DEPTH);
396 bool recurse = false;
399 recurse = component->IsProxy();
402 return {component, recurse, deputy};
405 static bool CheckChainEndWithAttribute(Accessible* obj, unsigned char forward)
409 auto attrs = obj->GetAttributes();
410 for(auto& attr : attrs)
412 if(attr.first == "relation_chain_end")
414 if((attr.second == "prev,end" && forward == 0) || (attr.second == "next,end" && forward == 1) || attr.second == "prev,next,end")
423 static Accessible* DeputyOfProxyInParentGet(Accessible* obj)
428 Accessible* BridgeAccessible::GetCurrentlyHighlighted()
430 //TODO: add currently highlighted object
434 std::vector<Accessible*> BridgeAccessible::ValidChildrenGet(const std::vector<Accessible*>& children, Accessible* start, Accessible* root)
436 std::vector<Component*> vec;
437 std::vector<Accessible*> ret;
439 for(auto child : children)
441 if(auto* component = dynamic_cast<Component*>(child); component)
443 vec.push_back(component);
447 std::sort(vec.begin(), vec.end(), &SortVertically);
449 for(auto& line : SplitLines(vec))
451 std::sort(line.begin(), line.end(), &SortHorizontally);
452 ret.insert(ret.end(), line.begin(), line.end());
458 static bool DeputyIs(Accessible* obj)
464 static Accessible* ProxyInParentGet(Accessible* obj)
468 auto children = obj->GetChildren();
469 for(auto& child : children)
477 static bool ObjectRoleIsAcceptableWhenNavigatingNextPrev(Accessible* obj)
481 auto role = obj->GetRole();
482 return role != Role::POPUP_MENU && role != Role::DIALOG;
486 struct CycleDetection
488 CycleDetection(const T value)
490 currentSearchSize(1),
494 bool check(const T value)
500 currentSearchSize <<= 1;
501 if(currentSearchSize == 0)
502 return true; // UNDEFINED BEHAVIOR
503 counter = currentSearchSize;
509 unsigned int currentSearchSize;
510 unsigned int counter;
513 static Accessible* FindNonDefunctChild(const std::vector<Accessible*>& children, unsigned int currentIndex, unsigned char forward)
515 unsigned int childrenCount = children.size();
516 for(; currentIndex < childrenCount; forward ? ++currentIndex : --currentIndex)
518 Accessible* n = children[currentIndex];
519 if(n && !n->GetStates()[State::DEFUNCT])
525 static Accessible* DirectionalDepthFirstSearchTryNonDefunctChild(Accessible* node, const std::vector<Accessible*>& children, unsigned char forward)
529 auto childrenCount = children.size();
530 if(childrenCount > 0)
532 const bool isShowing = GetScrollableParent(node) == nullptr ? node->GetStates()[State::SHOWING] : true;
535 return FindNonDefunctChild(children, forward ? 0 : childrenCount - 1, forward);
541 Accessible* BridgeAccessible::GetNextNonDefunctSibling(Accessible* obj, Accessible* start, Accessible* root, unsigned char forward)
545 auto parent = obj->GetParent();
549 auto children = ValidChildrenGet(parent->GetChildren(), start, root);
551 unsigned int children_count = children.size();
552 if(children_count == 0)
556 unsigned int current = 0;
557 for(; current < children_count && children[current] != obj; ++current)
559 if(current >= children_count)
563 forward ? ++current : --current;
564 auto ret = FindNonDefunctChild(children, current, forward);
568 Accessible* BridgeAccessible::DirectionalDepthFirstSearchTryNonDefunctSibling(bool& all_children_visited, Accessible* node, Accessible* start, Accessible* root, unsigned char forward)
572 Accessible* sibling = GetNextNonDefunctSibling(node, start, root, forward);
576 all_children_visited = false;
580 node = node->GetParent();
581 if(node == nullptr || node == root)
584 // in backward traversing stop the walk up on parent
591 Accessible* BridgeAccessible::CalculateNeighbor(Accessible* root, Accessible* start, unsigned char forward, BridgeAccessible::GetNeighborSearchMode search_mode)
593 if(start && CheckChainEndWithAttribute(start, forward))
595 if(root && root->GetStates()[State::DEFUNCT])
597 if(start && start->GetStates()[State::DEFUNCT])
603 if(search_mode == BridgeAccessible::GetNeighborSearchMode::recurseToOutside)
605 // This only works if we navigate backward, and it is not possible to
606 // find in embedded process. In this case the deputy should be used */
607 return DeputyOfProxyInParentGet(start);
610 Accessible* node = start ? start : root;
614 // initialization of all-children-visited flag for start node - we assume
615 // that when we begin at start node and we navigate backward, then all children
616 // are visited, so navigation will ignore start's children and go to
617 // previous sibling available.
618 // Regarding condtion (start != root):
619 // The last object can be found only if all_children_visited is false.
620 // The start is same with root, when looking for the last object.
621 bool all_children_visited = (start != root) && (search_mode != BridgeAccessible::GetNeighborSearchMode::recurseFromRoot && !forward);
622 // true, if starting element should be ignored. this is only used in rare case of
623 // recursive search failing to find an object.
624 // consider tree, where element A on bus BUS_A has child B on bus BUS_B. when going "next" from
625 // element A algorithm has to descend into BUS_B and search element B and its children. this is done
626 // by returning to our caller object B with special flag set (meaning - continue the search from B on bus BUS_B).
627 // if next object will be found there (on BUS_B), then search ends. but if not, then our caller will find it out
628 // and will call us again with object A and flag search_mode set to NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING.
629 // this flag means, that object A was already checked previously and we should skip it and its children.
630 bool force_next = (search_mode == BridgeAccessible::GetNeighborSearchMode::continueAfterFailedRecursion);
632 CycleDetection<Accessible*> cycleDetection(node);
635 if(node->GetStates()[State::DEFUNCT])
638 // always accept proxy object from different world
639 if(!force_next && node->IsProxy())
642 auto children = node->GetChildren();
643 children = ValidChildrenGet(children, start, root);
647 // 2. parent after all children in backward traversing
648 // 3. Nodes with roles: ATSPI_ROLE_PAGE_TAB, ATSPI_ROLE_POPUP_MENU and ATSPI_ROLE_DIALOG, only when looking for first or last element.
649 // Objects with those roles shouldnt be reachable, when navigating next / prev.
650 bool all_children_visited_or_moving_forward = (children.size() == 0 || forward || all_children_visited);
651 if(!force_next && node != start && all_children_visited_or_moving_forward && AcceptObject(node))
653 if(start == NULL || ObjectRoleIsAcceptableWhenNavigatingNextPrev(node))
657 Accessible* next_related_in_direction = !force_next ? GetObjectInRelation(node, forward ? RelationType::FLOWS_TO : RelationType::FLOWS_FROM) : nullptr;
658 // force_next means that the search_mode is NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING
659 // in this case the node is elm_layout which is parent of proxy object.
660 // There is an access object working for the proxy object, and the access
661 // object could have relation information. This relation information should
662 // be checked first before using the elm_layout as a node.
663 if(force_next && forward)
665 auto deputy = DeputyOfProxyInParentGet(node);
666 next_related_in_direction =
667 GetObjectInRelation(deputy, RelationType::FLOWS_TO);
670 if(next_related_in_direction && start && start->GetStates()[State::DEFUNCT])
672 next_related_in_direction = NULL;
675 unsigned char want_cycle_detection = 0;
676 if(next_related_in_direction)
678 // Check next_related_in_direction is deputy object
682 // If the prev object is deputy, then go to inside of its proxy first
683 if(DeputyIs(next_related_in_direction))
685 parent = next_related_in_direction->GetParent();
686 next_related_in_direction = ProxyInParentGet(parent);
691 // If current object is deputy, and it has relation next object,
692 // then do not use the relation next object, and use proxy first
695 parent = node->GetParent();
696 next_related_in_direction = ProxyInParentGet(parent);
699 node = next_related_in_direction;
700 want_cycle_detection = 1;
704 auto child = !force_next && !all_children_visited ? DirectionalDepthFirstSearchTryNonDefunctChild(node, children, forward) : nullptr;
707 want_cycle_detection = 1;
711 if(!force_next && node == root)
713 all_children_visited = true;
714 child = DirectionalDepthFirstSearchTryNonDefunctSibling(all_children_visited, node, start, root, forward);
719 if(want_cycle_detection && cycleDetection.check(node))
727 DBus::ValueOrError<Accessible*, uint8_t> BridgeAccessible::GetNeighbor(std::string rootPath, int32_t direction, int32_t search_mode)
729 auto start = FindSelf();
730 rootPath = StripPrefix(rootPath);
731 auto root = !rootPath.empty() ? Find(rootPath) : nullptr;
732 auto accessible = CalculateNeighbor(root, start, direction == 1, static_cast<GetNeighborSearchMode>(search_mode));
733 unsigned char recurse = 0;
736 recurse = accessible->IsProxy();
738 return {accessible, recurse};
741 Accessible* BridgeAccessible::GetParent()
743 // NOTE: currently bridge supports single application root element.
744 // only element set as application root might return nullptr from GetParent
745 // if you want more, then you need to change setApplicationRoot to
746 // add/remove ApplicationRoot and make roots a vector.
747 auto p = FindSelf()->GetParent();
751 DBus::ValueOrError<std::vector<Accessible*>> BridgeAccessible::GetChildren()
753 return FindSelf()->GetChildren();
755 std::string BridgeAccessible::GetDescription()
757 return FindSelf()->GetDescription();
759 DBus::ValueOrError<uint32_t> BridgeAccessible::GetRole()
761 return static_cast<unsigned int>(FindSelf()->GetRole());
763 DBus::ValueOrError<std::string> BridgeAccessible::GetRoleName()
765 return FindSelf()->GetRoleName();
767 DBus::ValueOrError<std::string> BridgeAccessible::GetLocalizedRoleName()
769 return FindSelf()->GetLocalizedRoleName();
771 DBus::ValueOrError<int32_t> BridgeAccessible::GetIndexInParent()
773 return FindSelf()->GetIndexInParent();
775 DBus::ValueOrError<std::array<uint32_t, 2>> BridgeAccessible::GetStates()
777 return FindSelf()->GetStates().GetRawData();
779 DBus::ValueOrError<std::unordered_map<std::string, std::string>> BridgeAccessible::GetAttributes()
781 std::unordered_map<std::string, std::string> attributes = FindSelf()->GetAttributes();
782 if(suppressScreenReader)
784 attributes.insert({"suppress-screen-reader", "true"});
789 DBus::ValueOrError<std::vector<std::string>> BridgeAccessible::GetInterfaces()
791 return FindSelf()->GetInterfaces();
793 int BridgeAccessible::GetChildCount()
795 return FindSelf()->GetChildCount();
797 DBus::ValueOrError<Accessible*> BridgeAccessible::GetChildAtIndex(int index)
800 throw std::domain_error{"negative index (" + std::to_string(index) + ")"};
801 return FindSelf()->GetChildAtIndex(static_cast<size_t>(index));
804 std::string BridgeAccessible::GetName()
806 return FindSelf()->GetName();
809 DBus::ValueOrError<Accessible*, uint32_t, std::unordered_map<std::string, std::string>> BridgeAccessible::GetDefaultLabelInfo()
811 auto defaultLabel = FindSelf()->GetDefaultLabel();
812 return {defaultLabel, static_cast<uint32_t>(defaultLabel->GetRole()), defaultLabel->GetAttributes()};
815 DBus::ValueOrError<std::vector<BridgeAccessible::Relation>> BridgeAccessible::GetRelationSet()
817 auto relations = FindSelf()->GetRelationSet();
818 std::vector<BridgeAccessible::Relation> ret;
820 for(auto& it : relations)
821 ret.emplace_back(Relation{static_cast<uint32_t>(it.relationType), it.targets});