Skip to content

Commit 5bffdef

Browse files
authored
Use weak pointers to the accesibility bridge from objects vended to the UIKit accessibility framework. (flutter#4761)
1 parent 1d0da77 commit 5bffdef

3 files changed

Lines changed: 34 additions & 18 deletions

File tree

‎shell/platform/darwin/ios/framework/Source/accessibility_bridge.h‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
#import <UIKit/UIKit.h>
1414

15+
#include "flutter/fml/memory/weak_ptr.h"
1516
#include "flutter/fml/platform/darwin/scoped_nsobject.h"
1617
#include "flutter/lib/ui/semantics/semantics_node.h"
1718
#include "flutter/shell/platform/darwin/ios/framework/Headers/FlutterChannels.h"
@@ -43,9 +44,10 @@ class AccessibilityBridge;
4344

4445
/**
4546
* The accessibility bridge that this semantics object is attached to. This
46-
* object may use the bridge to access contextual application information.
47+
* object may use the bridge to access contextual application information. A weak pointer is used
48+
* because the platform view owns the accessibility bridge.
4749
*/
48-
@property(nonatomic, readonly) shell::AccessibilityBridge* bridge;
50+
@property(nonatomic, readonly) fml::WeakPtr<shell::AccessibilityBridge> bridge;
4951

5052
/**
5153
* The semantics node used to produce this semantics object.
@@ -73,7 +75,7 @@ class AccessibilityBridge;
7375
#pragma mark - Designated initializers
7476

7577
- (instancetype)init __attribute__((unavailable("Use initWithBridge instead")));
76-
- (instancetype)initWithBridge:(shell::AccessibilityBridge*)bridge
78+
- (instancetype)initWithBridge:(fml::WeakPtr<shell::AccessibilityBridge>)bridge
7779
uid:(int32_t)uid NS_DESIGNATED_INITIALIZER;
7880

7981
@end
@@ -106,6 +108,8 @@ class AccessibilityBridge final {
106108

107109
UIView* view() const { return view_; }
108110

111+
fml::WeakPtr<AccessibilityBridge> GetWeakPtr();
112+
109113
private:
110114
SemanticsObject* GetOrCreateObject(int32_t id, blink::SemanticsNodeUpdates& updates);
111115
void VisitObjectsRecursivelyAndRemove(SemanticsObject* object,
@@ -117,6 +121,7 @@ class AccessibilityBridge final {
117121
PlatformViewIOS* platform_view_;
118122
fml::scoped_nsobject<NSMutableDictionary<NSNumber*, SemanticsObject*>> objects_;
119123
fml::scoped_nsprotocol<FlutterBasicMessageChannel*> accessibility_channel_;
124+
fml::WeakPtrFactory<AccessibilityBridge> weak_factory_;
120125

121126
FXL_DISALLOW_COPY_AND_ASSIGN(AccessibilityBridge);
122127
};

‎shell/platform/darwin/ios/framework/Source/accessibility_bridge.mm‎

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ NSComparisonResult IntToComparisonResult(int32_t value) {
8888
@interface SemanticsObjectContainer : NSObject
8989
- (instancetype)init __attribute__((unavailable("Use initWithSemanticsObject instead")));
9090
- (instancetype)initWithSemanticsObject:(SemanticsObject*)semanticsObject
91-
bridge:(shell::AccessibilityBridge*)bridge
91+
bridge:(fml::WeakPtr<shell::AccessibilityBridge>)bridge
9292
NS_DESIGNATED_INITIALIZER;
9393
@end
9494

@@ -107,8 +107,8 @@ - (instancetype)init {
107107

108108
#pragma mark - Designated initializers
109109

110-
- (instancetype)initWithBridge:(shell::AccessibilityBridge*)bridge uid:(int32_t)uid {
111-
FXL_DCHECK(bridge != nil) << "bridge must be set";
110+
- (instancetype)initWithBridge:(fml::WeakPtr<shell::AccessibilityBridge>)bridge uid:(int32_t)uid {
111+
FXL_DCHECK(bridge) << "bridge must be set";
112112
FXL_DCHECK(uid >= kRootNodeId);
113113
self = [super init];
114114

@@ -122,7 +122,6 @@ - (instancetype)initWithBridge:(shell::AccessibilityBridge*)bridge uid:(int32_t)
122122
}
123123

124124
- (void)dealloc {
125-
_bridge = nullptr;
126125
for (SemanticsObject* child in _children) {
127126
child.parent = nil;
128127
}
@@ -294,7 +293,7 @@ - (instancetype)init {
294293

295294
#pragma mark - Designated initializers
296295

297-
- (instancetype)initWithBridge:(shell::AccessibilityBridge*)bridge uid:(int32_t)uid {
296+
- (instancetype)initWithBridge:(fml::WeakPtr<shell::AccessibilityBridge>)bridge uid:(int32_t)uid {
298297
self = [super initWithBridge:bridge uid:uid];
299298
return self;
300299
}
@@ -328,7 +327,7 @@ - (UIAccessibilityTraits)accessibilityTraits {
328327

329328
@implementation SemanticsObjectContainer {
330329
SemanticsObject* _semanticsObject;
331-
shell::AccessibilityBridge* _bridge;
330+
fml::WeakPtr<shell::AccessibilityBridge> _bridge;
332331
}
333332

334333
#pragma mark - initializers
@@ -341,7 +340,7 @@ - (instancetype)init {
341340
}
342341

343342
- (instancetype)initWithSemanticsObject:(SemanticsObject*)semanticsObject
344-
bridge:(shell::AccessibilityBridge*)bridge {
343+
bridge:(fml::WeakPtr<shell::AccessibilityBridge>)bridge {
345344
FXL_DCHECK(semanticsObject != nil) << "semanticsObject must be set";
346345
self = [super init];
347346

@@ -401,6 +400,9 @@ - (CGRect)accessibilityFrame {
401400
}
402401

403402
- (id)accessibilityContainer {
403+
if (!_bridge) {
404+
return nil;
405+
}
404406
return ([_semanticsObject uid] == kRootNodeId)
405407
? _bridge->view()
406408
: [[_semanticsObject parent] accessibilityContainer];
@@ -419,7 +421,10 @@ - (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
419421
namespace shell {
420422

421423
AccessibilityBridge::AccessibilityBridge(UIView* view, PlatformViewIOS* platform_view)
422-
: view_(view), platform_view_(platform_view), objects_([[NSMutableDictionary alloc] init]) {
424+
: view_(view),
425+
platform_view_(platform_view),
426+
objects_([[NSMutableDictionary alloc] init]),
427+
weak_factory_(this) {
423428
accessibility_channel_.reset([[FlutterBasicMessageChannel alloc]
424429
initWithName:@"flutter/accessibility"
425430
binaryMessenger:platform_view->binary_messenger()
@@ -525,9 +530,9 @@ - (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
525530
blink::SemanticsNode node = updates[uid];
526531
if (node.HasFlag(blink::SemanticsFlags::kIsTextField)) {
527532
// Text fields are backed by objects that implement UITextInput.
528-
object = [[[TextInputSemanticsObject alloc] initWithBridge:this uid:uid] autorelease];
533+
object = [[[TextInputSemanticsObject alloc] initWithBridge:GetWeakPtr() uid:uid] autorelease];
529534
} else {
530-
object = [[[FlutterSemanticsObject alloc] initWithBridge:this uid:uid] autorelease];
535+
object = [[[FlutterSemanticsObject alloc] initWithBridge:GetWeakPtr() uid:uid] autorelease];
531536
}
532537

533538
objects_.get()[@(uid)] = object;
@@ -547,9 +552,11 @@ - (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
547552
[objects_ removeObjectForKey:@(node.id)];
548553
if (isTextField) {
549554
// Text fields are backed by objects that implement UITextInput.
550-
object = [[[TextInputSemanticsObject alloc] initWithBridge:this uid:uid] autorelease];
555+
object =
556+
[[[TextInputSemanticsObject alloc] initWithBridge:GetWeakPtr() uid:uid] autorelease];
551557
} else {
552-
object = [[[FlutterSemanticsObject alloc] initWithBridge:this uid:uid] autorelease];
558+
object =
559+
[[[FlutterSemanticsObject alloc] initWithBridge:GetWeakPtr() uid:uid] autorelease];
553560
}
554561
[object.parent.children replaceObjectAtIndex:positionInChildlist withObject:object];
555562
objects_.get()[@(node.id)] = object;
@@ -576,4 +583,8 @@ - (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
576583
}
577584
}
578585

586+
fml::WeakPtr<AccessibilityBridge> AccessibilityBridge::GetWeakPtr() {
587+
return weak_factory_.GetWeakPtr();
588+
}
589+
579590
} // namespace shell

‎shell/platform/darwin/ios/framework/Source/accessibility_text_entry.mm‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ @implementation TextInputSemanticsObject {
173173
FlutterInactiveTextInput* _inactive_text_input;
174174
}
175175

176-
- (instancetype)initWithBridge:(shell::AccessibilityBridge*)bridge uid:(int32_t)uid {
176+
- (instancetype)initWithBridge:(fml::WeakPtr<shell::AccessibilityBridge>)bridge uid:(int32_t)uid {
177177
self = [super initWithBridge:bridge uid:uid];
178178

179179
if (self) {
@@ -196,7 +196,7 @@ - (void)setSemanticsNode:(const blink::SemanticsNode*)node {
196196
if ([self node].HasFlag(blink::SemanticsFlags::kIsFocused)) {
197197
// The text input view must have a non-trivial size for the accessibility
198198
// system to send text editing events.
199-
[self bridge]->textInputView().frame = CGRectMake(0.0, 0.0, 1.0, 1.0);
199+
[self bridge] -> textInputView().frame = CGRectMake(0.0, 0.0, 1.0, 1.0);
200200
}
201201
}
202202

@@ -212,7 +212,7 @@ - (void)setSemanticsNode:(const blink::SemanticsNode*)node {
212212
*/
213213
- (UIView<UITextInput>*)textInputSurrogate {
214214
if ([self node].HasFlag(blink::SemanticsFlags::kIsFocused)) {
215-
return [self bridge]->textInputView();
215+
return [self bridge] -> textInputView();
216216
} else {
217217
return _inactive_text_input;
218218
}

0 commit comments

Comments
 (0)