common.dart 7.18 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
// ignore_for_file: avoid_dynamic_calls

7 8 9
import 'dart:convert';

import 'package:meta/meta.dart';
10

11 12 13 14 15 16 17 18 19 20 21 22 23
import 'constants.dart';

/// A semantics node created from Android accessibility information.
///
/// This object represents Android accessibility information derived from an
/// [AccessibilityNodeInfo](https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo)
/// object. The purpose is to verify in integration
/// tests that our semantics framework produces the correct accessibility info
/// on Android.
///
/// See also:
///
///   * [AccessibilityNodeInfo](https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo)
24
class AndroidSemanticsNode {
25 26 27 28 29 30 31 32 33 34 35 36 37 38
  AndroidSemanticsNode._(this._values);

  /// Deserializes a new [AndroidSemanticsNode] from a json map.
  ///
  /// The structure of the JSON:
  ///
  ///     {
  ///       "flags": {
  ///         "isChecked": bool,
  ///         "isCheckable": bool,
  ///         "isEditable": bool,
  ///         "isEnabled": bool,
  ///         "isFocusable": bool,
  ///         "isFocused": bool,
39
  ///         "isHeading": bool,
40 41 42 43
  ///         "isPassword": bool,
  ///         "isLongClickable": bool,
  ///       },
  ///       "text": String,
44
  ///       "contentDescription": String,
45 46 47 48 49 50 51 52 53 54 55 56 57
  ///       "className": String,
  ///       "id": int,
  ///       "rect": {
  ///         left: int,
  ///         top: int,
  ///         right: int,
  ///         bottom: int,
  ///       },
  ///       actions: [
  ///         int,
  ///       ]
  ///     }
  factory AndroidSemanticsNode.deserialize(String value) {
58
    return AndroidSemanticsNode._(json.decode(value));
59 60
  }

61
  final dynamic _values;
62 63
  final List<AndroidSemanticsNode> _children = <AndroidSemanticsNode>[];

64
  dynamic get _flags => _values['flags'];
65 66 67 68 69

  /// The text value of the semantics node.
  ///
  /// This is produced by combining the value, label, and hint fields from
  /// the Flutter [SemanticsNode].
70
  String? get text => _values['text'] as String?;
71

72 73 74 75 76 77 78 79
  /// The contentDescription of the semantics node.
  ///
  /// This field is used for the Switch, Radio, and Checkbox widgets
  /// instead of [text]. If the text property is used for these, TalkBack
  /// will not read out the "checked" or "not checked" label by default.
  ///
  /// This is produced by combining the value, label, and hint fields from
  /// the Flutter [SemanticsNode].
80
  String? get contentDescription => _values['contentDescription'] as String?;
81

82 83 84 85 86 87 88
  /// The className of the semantics node.
  ///
  /// Certain kinds of Flutter semantics are mapped to Android classes to
  /// use their default semantic behavior, such as checkboxes and images.
  ///
  /// If a more specific value isn't provided, it defaults to
  /// "android.view.View".
89
  String? get className => _values['className'] as String?;
90 91

  /// The identifier for this semantics node.
92
  int? get id => _values['id'] as int?;
93 94 95 96 97 98 99

  /// The children of this semantics node.
  List<AndroidSemanticsNode> get children => _children;

  /// Whether the node is currently in a checked state.
  ///
  /// Equivalent to [SemanticsFlag.isChecked].
100
  bool? get isChecked => _flags['isChecked'] as bool?;
101 102 103 104

  /// Whether the node can be in a checked state.
  ///
  /// Equivalent to [SemanticsFlag.hasCheckedState]
105
  bool? get isCheckable => _flags['isCheckable'] as bool?;
106 107 108 109 110

  /// Whether the node is editable.
  ///
  /// This is usually only applied to text fields, which map
  /// to "android.widget.EditText".
111
  bool? get isEditable => _flags['isEditable'] as bool?;
112 113

  /// Whether the node is enabled.
114
  bool? get isEnabled => _flags['isEnabled'] as bool?;
115 116

  /// Whether the node is focusable.
117
  bool? get isFocusable => _flags['isFocusable'] as bool?;
118 119

  /// Whether the node is focused.
120
  bool? get isFocused => _flags['isFocused'] as bool?;
121

122
  /// Whether the node is considered a heading.
123
  bool? get isHeading => _flags['isHeading'] as bool?;
124

125 126 127
  /// Whether the node represents a password field.
  ///
  /// Equivalent to [SemanticsFlag.isObscured].
128
  bool? get isPassword => _flags['isPassword'] as bool?;
129 130 131 132

  /// Whether the node is long clickable.
  ///
  /// Equivalent to having [SemanticsAction.longPress].
133
  bool? get isLongClickable => _flags['isLongClickable'] as bool?;
134 135 136

  /// Gets a [Rect] which defines the position and size of the semantics node.
  Rect getRect() {
137 138 139 140
    final dynamic rawRect = _values['rect'];
    if (rawRect == null) {
      return const Rect.fromLTRB(0.0, 0.0, 0.0, 0.0);
    }
141
    return Rect.fromLTRB(
142 143 144 145
      (rawRect['left']! as int).toDouble(),
      (rawRect['top']! as int).toDouble(),
      (rawRect['right']! as int).toDouble(),
      (rawRect['bottom']! as int).toDouble(),
146 147 148 149 150 151
    );
  }

  /// Gets a [Size] which defines the size of the semantics node.
  Size getSize() {
    final Rect rect = getRect();
152
    return Size(rect.bottom - rect.top, rect.right - rect.left);
153 154 155
  }

  /// Gets a list of [AndroidSemanticsActions] which are defined for the node.
156 157 158 159 160 161 162 163 164 165 166 167 168 169
  List<AndroidSemanticsAction> getActions() {
    final List<int>? actions = (_values['actions'] as List<dynamic>?)?.cast<int>();
    if (actions == null) {
      return const <AndroidSemanticsAction>[];
    }
    final List<AndroidSemanticsAction> convertedActions = <AndroidSemanticsAction>[];
    for (final int id in actions) {
      final AndroidSemanticsAction? action = AndroidSemanticsAction.deserialize(id);
      if (action != null) {
        convertedActions.add(action);
      }
    }
    return convertedActions;
  }
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

  @override
  String toString() {
    return _values.toString();
  }
}


/// A Dart VM implementation of a rectangle.
///
/// Created to mirror the implementation of [ui.Rect].
@immutable
class Rect {
  /// Creates a new rectangle.
  ///
  /// All values are required.
  const Rect.fromLTRB(this.left, this.top, this.right, this.bottom);

  /// The top side of the rectangle.
  final double top;

  /// The left side of the rectangle.
  final double left;

  /// The right side of the rectangle.
  final double right;

  /// The bottom side of the rectangle.
  final double bottom;

  @override
201
  int get hashCode => Object.hash(top, left, right, bottom);
202 203 204

  @override
  bool operator ==(Object other) {
205
    if (other.runtimeType != runtimeType) {
206
      return false;
207
    }
208 209 210 211 212
    return other is Rect
        && other.top == top
        && other.left == left
        && other.right == right
        && other.bottom == bottom;
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
  }

  @override
  String toString() => 'Rect.fromLTRB($left, $top, $right, $bottom)';
}

/// A Dart VM implementation of a Size.
///
/// Created to mirror the implementation [ui.Size].
@immutable
class Size {
  /// Creates a new [Size] object.
  const Size(this.width, this.height);

  /// The width of some object.
  final double width;

  /// The height of some object.
  final double height;

  @override
234
  int get hashCode => Object.hash(width, height);
235 236 237

  @override
  bool operator ==(Object other) {
238
    if (other.runtimeType != runtimeType) {
239
      return false;
240
    }
241 242 243
    return other is Size
        && other.width == width
        && other.height == height;
244 245 246 247 248
  }

  @override
  String toString() => 'Size{$width, $height}';
}