9 #include "flutter/fml/logging.h"
15 #include "flutter/common/constants.h"
17 #pragma GCC diagnostic error "-Wundeclared-selector"
24 class DefaultIosDelegate :
public AccessibilityBridge::IosDelegate {
26 bool IsFlutterViewControllerPresentingModalViewController(
28 if (view_controller) {
29 return view_controller.isPresentingViewController;
35 void PostAccessibilityNotification(UIAccessibilityNotifications notification,
36 id argument)
override {
37 UIAccessibilityPostNotification(notification, argument);
46 std::unique_ptr<IosDelegate> ios_delegate)
47 : view_controller_(view_controller),
48 accessibility_element_init_container_([[UIView alloc]
initWithFrame:CGRectZero]),
50 platform_views_controller_(platform_views_controller),
51 objects_([[NSMutableDictionary alloc] init]),
53 ios_delegate_(ios_delegate ? std::move(ios_delegate)
54 : std::make_unique<DefaultIosDelegate>()),
57 initWithName:
@"flutter/accessibility"
58 binaryMessenger:
platform_view->GetOwnerViewController().engine.binaryMessenger
60 fml::WeakPtr<AccessibilityBridge> weak_self = GetWeakPtr();
61 [accessibility_channel_ setMessageHandler:^(
id message,
FlutterReply reply) {
63 weak_self->HandleEvent((NSDictionary*)message);
68 AccessibilityBridge::~AccessibilityBridge() {
69 [accessibility_channel_ setMessageHandler:nil];
76 FML_DCHECK(
viewController.platformViewsController == platform_views_controller_)
77 <<
"A reattached FlutterViewController must belong to the same FlutterEngine.";
80 UIView* currentView = ViewIfLoaded();
81 if (previousView != currentView) {
82 ClearAccessibilityElementsIfOwnedByBridge(previousView);
84 UpdateAccessibilityElementsForCurrentView();
85 NotifySemanticsObjectsViewChanged();
88 UIView<UITextInput>* AccessibilityBridge::textInputView() {
89 return [[platform_view_->GetOwnerViewController().engine
textInputPlugin] textInputView];
92 bool AccessibilityBridge::HasSemantics()
const {
96 void AccessibilityBridge::AccessibilityObjectDidBecomeFocused(int32_t
id) {
97 last_focused_semantics_object_id_ = id;
98 [accessibility_channel_ sendMessage:@{
@"type" :
@"didGainFocus",
@"nodeId" : @(id)}];
101 void AccessibilityBridge::AccessibilityObjectDidLoseFocus(int32_t
id) {
102 if (last_focused_semantics_object_id_ ==
id) {
103 last_focused_semantics_object_id_ = kSemanticObjectIdInvalid;
107 void AccessibilityBridge::UpdateSemantics(
108 flutter::SemanticsNodeUpdates nodes,
109 const flutter::CustomAccessibilityActionUpdates& actions) {
110 BOOL layoutChanged = NO;
111 BOOL scrollOccured = NO;
112 BOOL needsAnnouncement = NO;
113 for (
const auto& entry : actions) {
114 const flutter::CustomAccessibilityAction& action = entry.second;
115 actions_[action.id] = action;
120 BOOL shouldPostAccessibilityNotifications =
121 view_controller_ && ViewIfLoaded() &&
122 !ios_delegate_->IsFlutterViewControllerPresentingModalViewController(view_controller_);
123 for (
const auto& entry : nodes) {
124 const flutter::SemanticsNode& node = entry.second;
126 layoutChanged = layoutChanged || [
object nodeWillCauseLayoutChange:&node];
127 scrollOccured = scrollOccured || [
object nodeWillCauseScroll:&node];
128 needsAnnouncement = [
object nodeShouldTriggerAnnouncement:&node];
129 [
object setSemanticsNode:&node];
130 NSUInteger newChildCountInTraversalOrder = node.childrenInTraversalOrder.size();
131 NSMutableArray* newChildren =
132 [[NSMutableArray alloc] initWithCapacity:newChildCountInTraversalOrder];
133 for (NSUInteger i = 0; i < newChildCountInTraversalOrder; ++i) {
134 SemanticsObject* child = GetOrCreateObject(node.childrenInTraversalOrder[i], nodes);
135 [newChildren addObject:child];
137 NSUInteger newChildCountInHitTestOrder = node.childrenInHitTestOrder.size();
138 NSMutableArray* newChildrenInHitTestOrder =
139 [[NSMutableArray alloc] initWithCapacity:newChildCountInHitTestOrder];
140 for (NSUInteger i = 0; i < newChildCountInHitTestOrder; ++i) {
141 SemanticsObject* child = GetOrCreateObject(node.childrenInHitTestOrder[i], nodes);
142 [newChildrenInHitTestOrder addObject:child];
144 object.children = newChildren;
145 object.childrenInHitTestOrder = newChildrenInHitTestOrder;
146 if (!node.customAccessibilityActions.empty()) {
147 NSMutableArray<FlutterCustomAccessibilityAction*>* accessibilityCustomActions =
148 [[NSMutableArray alloc] init];
149 for (int32_t action_id : node.customAccessibilityActions) {
150 flutter::CustomAccessibilityAction& action = actions_[action_id];
151 if (action.overrideId != -1) {
156 NSString* label = @(action.label.data());
157 SEL selector =
@selector(onCustomAccessibilityAction:);
162 customAction.
uid = action_id;
163 [accessibilityCustomActions addObject:customAction];
165 object.accessibilityCustomActions = accessibilityCustomActions;
168 if (needsAnnouncement && shouldPostAccessibilityNotifications) {
174 NSString* announcement = [[NSString alloc] initWithUTF8String:
object.node.label.c_str()];
175 UIAccessibilityPostNotification(
176 UIAccessibilityAnnouncementNotification,
177 [[NSAttributedString alloc] initWithString:announcement
179 UIAccessibilitySpeechAttributeQueueAnnouncement : @YES
186 bool routeChanged =
false;
190 UpdateAccessibilityElementsForCurrentView();
191 NSMutableArray<SemanticsObject*>* newRoutes = [[NSMutableArray alloc] init];
192 [root collectRoutes:newRoutes];
195 if (std::find(previous_routes_.begin(), previous_routes_.end(), [route uid]) ==
196 previous_routes_.end()) {
201 if (lastAdded == nil && [newRoutes count] > 0) {
202 int index = [newRoutes count] - 1;
203 lastAdded = [newRoutes objectAtIndex:index];
212 if (lastAdded != nil &&
213 ([lastAdded uid] != previous_route_id_ || [newRoutes count] != previous_routes_.size())) {
214 previous_route_id_ = [lastAdded uid];
217 previous_routes_.clear();
219 previous_routes_.push_back([route uid]);
222 UIView* view = ViewIfLoaded();
223 ClearAccessibilityElementsIfOwnedByBridge(view);
226 NSMutableArray<NSNumber*>* doomed_uids = [NSMutableArray arrayWithArray:objects_.allKeys];
228 VisitObjectsRecursivelyAndRemove(root, doomed_uids);
230 [objects_ removeObjectsForKeys:doomed_uids];
233 [
object accessibilityBridgeDidFinishUpdate];
236 if (!shouldPostAccessibilityNotifications) {
240 layoutChanged = layoutChanged || [doomed_uids count] > 0;
243 NSString* routeName = [lastAdded routeName];
244 ios_delegate_->PostAccessibilityNotification(UIAccessibilityScreenChangedNotification,
250 SemanticsObject* lastFocused = [objects_ objectForKey:@(last_focused_semantics_object_id_)];
254 ios_delegate_->PostAccessibilityNotification(
255 UIAccessibilityLayoutChangedNotification,
257 }
else if (scrollOccured) {
261 ios_delegate_->PostAccessibilityNotification(
262 UIAccessibilityPageScrolledNotification,
263 FindNextFocusableIfNecessary().nativeAccessibility);
267 void AccessibilityBridge::DispatchSemanticsAction(int32_t node_uid,
268 flutter::SemanticsAction action) {
271 platform_view_->DispatchSemanticsAction(kFlutterImplicitViewId, node_uid, action, {});
274 void AccessibilityBridge::DispatchSemanticsAction(int32_t node_uid,
275 flutter::SemanticsAction action,
276 fml::MallocMapping args) {
279 platform_view_->DispatchSemanticsAction(kFlutterImplicitViewId, node_uid, action,
285 NSMutableDictionary<NSNumber*, SemanticsObject*>* objects) {
287 FML_DCHECK(oldObject.
node.id == newObject.
uid);
288 NSNumber* nodeId = @(oldObject.
node.id);
289 NSUInteger positionInChildlist = [oldObject.
parent.
children indexOfObject:oldObject];
291 [oldObject.
parent replaceChildAtIndex:positionInChildlist withChild:newObject];
292 [objects removeObjectForKey:nodeId];
293 objects[nodeId] = newObject;
296 static SemanticsObject* CreateObject(
const flutter::SemanticsNode& node,
297 const fml::WeakPtr<AccessibilityBridge>& weak_ptr) {
298 if (node.flags.isTextField && !node.flags.isReadOnly) {
301 }
else if (!node.flags.isInMutuallyExclusiveGroup &&
302 (node.flags.isToggled != flutter::SemanticsTristate::kNone ||
303 node.flags.isChecked != flutter::SemanticsCheckState::kNone)) {
305 }
else if (node.flags.hasImplicitScrolling) {
307 }
else if (node.IsPlatformViewNode()) {
309 weak_ptr->GetPlatformViewsController();
311 [platformViewsController flutterTouchInterceptingViewForId:node.platformViewId];
314 platformView:touchInterceptingView];
321 flutter::SemanticsNodeUpdates& updates) {
324 object = CreateObject(updates[uid], GetWeakPtr());
325 objects_[@(uid)] =
object;
328 auto nodeEntry = updates.find(
object.node.id);
329 if (nodeEntry != updates.end()) {
331 flutter::SemanticsNode node = nodeEntry->second;
332 if (
object.node.flags.isTextField != node.flags.isTextField ||
333 object.node.flags.isReadOnly != node.flags.isReadOnly ||
334 (
object.node.flags.isChecked == flutter::SemanticsCheckState::kNone) !=
335 (node.flags.isChecked == flutter::SemanticsCheckState::kNone) ||
336 ((
object.node.flags.isToggled == flutter::SemanticsTristate::kNone) !=
337 (node.flags.isToggled == flutter::SemanticsTristate::kNone)) ||
338 object.node.flags.hasImplicitScrolling != node.flags.hasImplicitScrolling
344 SemanticsObject* newSemanticsObject = CreateObject(node, GetWeakPtr());
345 ReplaceSemanticsObject(
object, newSemanticsObject, objects_);
346 object = newSemanticsObject;
353 void AccessibilityBridge::VisitObjectsRecursivelyAndRemove(
SemanticsObject*
object,
354 NSMutableArray<NSNumber*>* doomed_uids) {
355 [doomed_uids removeObject:@(
object.uid)];
357 VisitObjectsRecursivelyAndRemove(child, doomed_uids);
363 if (last_focused_semantics_object_id_ == kSemanticObjectIdInvalid) {
368 return FindFirstFocusable(objects_[@(last_focused_semantics_object_id_)]);
373 if (!currentObject) {
376 if (currentObject.isAccessibilityElement) {
377 return currentObject;
389 void AccessibilityBridge::HandleEvent(NSDictionary<NSString*, id>* annotatedEvent) {
390 NSString* type = annotatedEvent[
@"type"];
391 if ([type isEqualToString:
@"announce"]) {
392 NSString* message = annotatedEvent[
@"data"][
@"message"];
393 ios_delegate_->PostAccessibilityNotification(UIAccessibilityAnnouncementNotification, message);
395 if ([type isEqualToString:
@"focus"]) {
397 ios_delegate_->PostAccessibilityNotification(UIAccessibilityLayoutChangedNotification, node);
401 fml::WeakPtr<AccessibilityBridge> AccessibilityBridge::GetWeakPtr() {
402 return weak_factory_.GetWeakPtr();
405 bool AccessibilityBridge::AccessibilityElementsWereInstalledByBridge(NSArray* elements)
const {
406 if (elements.count != 1) {
409 id element = elements.firstObject;
414 return semanticsObject && semanticsObject.
bridge ==
this;
417 void AccessibilityBridge::ClearAccessibilityElementsIfOwnedByBridge(UIView* view) {
421 if (AccessibilityElementsWereInstalledByBridge(view.accessibilityElements)) {
422 view.accessibilityElements = nil;
426 void AccessibilityBridge::UpdateAccessibilityElementsForCurrentView() {
427 UIView* view = ViewIfLoaded();
433 view.accessibilityElements = nil;
436 id accessibilityContainer = [root accessibilityContainer];
437 if (!accessibilityContainer) {
438 view.accessibilityElements = nil;
441 view.accessibilityElements = @[ accessibilityContainer ];
444 void AccessibilityBridge::NotifySemanticsObjectsViewChanged() {
446 [
object accessibilityBridgeDidChangeView];
450 void AccessibilityBridge::clearState() {
451 [objects_ removeAllObjects];
452 previous_route_id_ = 0;
453 previous_routes_.clear();
454 view_controller_.viewIfLoaded.accessibilityElements = nil;
NS_ASSUME_NONNULL_BEGIN typedef void(^ FlutterReply)(id _Nullable reply)
instancetype initWithFrame
FlutterViewController * viewController
FlutterTextInputPlugin * textInputPlugin
constexpr NS_ASSUME_NONNULL_BEGIN int32_t kRootNodeId
AccessibilityBridge()
Creates a new instance of a accessibility bridge.
NSArray< SemanticsObject * > * children
nullable flutter::AccessibilityBridgeIos * bridge()
flutter::SemanticsNode node