Repository navigation
Expand file tree
/
Copy pathbinding.dart
More file actions
279 lines (249 loc) · 10.5 KB
/
Copy pathbinding.dart
File metadata and controls
279 lines (249 loc) · 10.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/// @docImport 'package:flutter/widgets.dart';
///
/// @docImport 'semantics.dart';
library;
import 'dart:ui'
as ui
show AccessibilityFeatures, Rect, SemanticsActionEvent, SemanticsUpdateBuilder;
import 'package:flutter/foundation.dart';
import 'package:flutter/scheduler.dart';
import 'package:flutter/services.dart';
import 'debug.dart';
export 'dart:ui' show AccessibilityFeatures, SemanticsActionEvent, SemanticsUpdateBuilder;
/// The glue between the semantics layer and the Flutter engine.
mixin SemanticsBinding on BindingBase {
@override
void initInstances() {
super.initInstances();
_instance = this;
_accessibilityFeatures = platformDispatcher.accessibilityFeatures;
platformDispatcher
..onSemanticsEnabledChanged = _handleSemanticsEnabledChanged
..onSemanticsActionEvent = _handleSemanticsActionEvent
..onAccessibilityFeaturesChanged = () {
// TODO(chunhtai): Web should not notify accessibility feature changes during updateSemantics
// https://github.com/flutter/flutter/issues/158399
if (SchedulerBinding.instance.schedulerPhase == SchedulerPhase.persistentCallbacks) {
SchedulerBinding.instance.addPostFrameCallback((Duration duration) {
handleAccessibilityFeaturesChanged();
}, debugLabel: 'SemanticsBinding.handleAccessibilityFeaturesChanged');
} else {
handleAccessibilityFeaturesChanged();
}
};
_handleSemanticsEnabledChanged();
addSemanticsEnabledListener(_handleFrameworkSemanticsEnabledChanged);
// Ensure the initial value is set.
if (semanticsEnabled) {
_handleFrameworkSemanticsEnabledChanged();
}
}
/// The current [SemanticsBinding], if one has been created.
///
/// Provides access to the features exposed by this mixin. The binding must
/// be initialized before using this getter; this is typically done by calling
/// [runApp] or [WidgetsFlutterBinding.ensureInitialized].
static SemanticsBinding get instance => BindingBase.checkInstance(_instance);
static SemanticsBinding? _instance;
/// Whether semantics information must be collected.
///
/// Returns true if either the platform has requested semantics information
/// to be generated or if [ensureSemantics] has been called otherwise.
///
/// To get notified when this value changes register a listener with
/// [addSemanticsEnabledListener].
bool get semanticsEnabled {
assert(_semanticsEnabled.value == (_outstandingHandles > 0));
return _semanticsEnabled.value;
}
late final ValueNotifier<bool> _semanticsEnabled = ValueNotifier<bool>(
platformDispatcher.semanticsEnabled,
);
/// Adds a `listener` to be called when [semanticsEnabled] changes.
///
/// See also:
///
/// * [removeSemanticsEnabledListener] to remove the listener again.
/// * [ValueNotifier.addListener], which documents how and when listeners are
/// called.
void addSemanticsEnabledListener(VoidCallback listener) {
_semanticsEnabled.addListener(listener);
}
/// Removes a `listener` added by [addSemanticsEnabledListener].
///
/// See also:
///
/// * [ValueNotifier.removeListener], which documents how listeners are
/// removed.
void removeSemanticsEnabledListener(VoidCallback listener) {
_semanticsEnabled.removeListener(listener);
}
final ObserverList<ValueSetter<ui.SemanticsActionEvent>> _semanticsActionListeners =
ObserverList<ValueSetter<ui.SemanticsActionEvent>>();
/// Adds a listener that is called for every [ui.SemanticsActionEvent] received.
///
/// The listeners are called before [performSemanticsAction] is invoked.
///
/// To remove the listener, call [removeSemanticsActionListener].
void addSemanticsActionListener(ValueSetter<ui.SemanticsActionEvent> listener) {
_semanticsActionListeners.add(listener);
}
/// Removes a listener previously added with [addSemanticsActionListener].
void removeSemanticsActionListener(ValueSetter<ui.SemanticsActionEvent> listener) {
_semanticsActionListeners.remove(listener);
}
/// Returns the global rect for the semantics node with the given [nodeId] in
/// the view with the given [viewId].
///
/// The rect is in the global coordinate space of the view's render tree, in
/// logical pixels. This is useful for widgets that react to semantics actions
/// and need the on-screen position of the semantics node that received the
/// action.
///
/// Asserts in non-release builds and returns null if the view is unknown,
/// the view has no semantics owner, or the node cannot be found. Callers
/// should only invoke this in response to a semantics action, in which case
/// all three lookups are expected to succeed.
ui.Rect? getRectOfSemanticsNodeInViewCoordinates(int viewId, int nodeId) => null;
/// The number of clients registered to listen for semantics.
///
/// The number is increased whenever [ensureSemantics] is called and decreased
/// when [SemanticsHandle.dispose] is called.
int get debugOutstandingSemanticsHandles => _outstandingHandles;
int _outstandingHandles = 0;
/// Creates a new [SemanticsHandle] and requests the collection of semantics
/// information.
///
/// Semantics information are only collected when there are clients interested
/// in them. These clients express their interest by holding a
/// [SemanticsHandle].
///
/// Clients can close their [SemanticsHandle] by calling
/// [SemanticsHandle.dispose]. Once all outstanding [SemanticsHandle] objects
/// are closed, semantics information are no longer collected.
SemanticsHandle ensureSemantics() {
assert(_outstandingHandles >= 0);
_outstandingHandles++;
assert(_outstandingHandles > 0);
_semanticsEnabled.value = true;
return SemanticsHandle._(_didDisposeSemanticsHandle);
}
void _didDisposeSemanticsHandle() {
assert(_outstandingHandles > 0);
_outstandingHandles--;
assert(_outstandingHandles >= 0);
_semanticsEnabled.value = _outstandingHandles > 0;
}
// Handle for semantics request from the platform.
SemanticsHandle? _semanticsHandle;
void _handleSemanticsEnabledChanged() {
if (platformDispatcher.semanticsEnabled) {
_semanticsHandle ??= ensureSemantics();
} else {
_semanticsHandle?.dispose();
_semanticsHandle = null;
}
}
void _handleSemanticsActionEvent(ui.SemanticsActionEvent action) {
final Object? arguments = action.arguments;
final ui.SemanticsActionEvent decodedAction = arguments is ByteData
? action.copyWith(arguments: const StandardMessageCodec().decodeMessage(arguments))
: action;
// Listeners may get added/removed while the iteration is in progress. Since the list cannot
// be modified while iterating, we are creating a local copy for the iteration.
final List<ValueSetter<ui.SemanticsActionEvent>> localListeners = _semanticsActionListeners
.toList(growable: false);
for (final listener in localListeners) {
if (_semanticsActionListeners.contains(listener)) {
listener(decodedAction);
}
}
performSemanticsAction(decodedAction);
}
void _handleFrameworkSemanticsEnabledChanged() {
platformDispatcher.setSemanticsTreeEnabled(semanticsEnabled);
}
/// Called whenever the platform requests an action to be performed on a
/// [SemanticsNode].
///
/// This callback is invoked when a user interacts with the app via an
/// accessibility service (e.g. TalkBack and VoiceOver) and initiates an
/// action on the focused node.
///
/// Bindings that mixin the [SemanticsBinding] must implement this method and
/// perform the given `action` on the [SemanticsNode] specified by
/// [ui.SemanticsActionEvent.nodeId].
///
/// See [dart:ui.PlatformDispatcher.onSemanticsActionEvent].
@protected
void performSemanticsAction(ui.SemanticsActionEvent action);
/// The currently active set of [ui.AccessibilityFeatures].
///
/// This is set when the binding is first initialized and updated whenever a
/// flag is changed.
///
/// To listen to changes to accessibility features, create a
/// [WidgetsBindingObserver] and listen to
/// [WidgetsBindingObserver.didChangeAccessibilityFeatures].
ui.AccessibilityFeatures get accessibilityFeatures => _accessibilityFeatures;
late ui.AccessibilityFeatures _accessibilityFeatures;
/// Called when the platform accessibility features change.
///
/// See [dart:ui.PlatformDispatcher.onAccessibilityFeaturesChanged].
@protected
@mustCallSuper
void handleAccessibilityFeaturesChanged() {
_accessibilityFeatures = platformDispatcher.accessibilityFeatures;
}
/// Creates an empty semantics update builder.
///
/// The caller is responsible for filling out the semantics node updates.
///
/// This method is used by the [SemanticsOwner] to create builder for all its
/// semantics updates.
ui.SemanticsUpdateBuilder createSemanticsUpdateBuilder() {
return ui.SemanticsUpdateBuilder();
}
/// The platform is requesting that animations be disabled or simplified.
///
/// This setting can be overridden for testing or debugging by setting
/// [debugSemanticsDisableAnimations].
bool get disableAnimations {
bool value = _accessibilityFeatures.disableAnimations;
assert(() {
if (debugSemanticsDisableAnimations != null) {
value = debugSemanticsDisableAnimations!;
}
return true;
}());
return value;
}
}
/// A reference to the semantics information generated by the framework.
///
/// Semantics information are only collected when there are clients interested
/// in them. These clients express their interest by holding a
/// [SemanticsHandle]. When the client no longer needs the
/// semantics information, it must call [dispose] on the [SemanticsHandle] to
/// close it. When all open [SemanticsHandle]s are disposed, the framework will
/// stop updating the semantics information.
///
/// To obtain a [SemanticsHandle], call [SemanticsBinding.ensureSemantics].
class SemanticsHandle {
SemanticsHandle._(this._onDispose) {
assert(debugMaybeDispatchCreated('semantics', 'SemanticsHandle', this));
}
final VoidCallback _onDispose;
/// Closes the semantics handle.
///
/// When all the outstanding [SemanticsHandle] objects are closed, the
/// framework will stop generating semantics information.
@mustCallSuper
void dispose() {
assert(debugMaybeDispatchDisposed(this));
_onDispose();
}
}