text_span.dart 15 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
// @dart = 2.8

7 8 9
import 'dart:ui' as ui show ParagraphBuilder;

import 'package:flutter/foundation.dart';
10 11
import 'package:flutter/gestures.dart';
import 'package:flutter/services.dart';
12 13

import 'basic_types.dart';
14 15
import 'inline_span.dart';
import 'text_painter.dart';
16 17 18 19
import 'text_style.dart';

/// An immutable span of text.
///
20 21
/// A [TextSpan] object can be styled using its [style] property. The style will
/// be applied to the [text] and the [children].
22
///
23 24 25 26 27 28 29
/// A [TextSpan] object can just have plain text, or it can have children
/// [TextSpan] objects with their own styles that (possibly only partially)
/// override the [style] of this object. If a [TextSpan] has both [text] and
/// [children], then the [text] is treated as if it was an un-styled [TextSpan]
/// at the start of the [children] list. Leaving the [TextSpan.text] field null
/// results in the [TextSpan] acting as an empty node in the [InlineSpan] tree
/// with a list of children.
30 31
///
/// To paint a [TextSpan] on a [Canvas], use a [TextPainter]. To display a text
32 33
/// span in a widget, use a [RichText]. For text with a single style, consider
/// using the [Text] widget.
34
///
35
/// {@tool snippet}
36 37 38 39
///
/// The text "Hello world!", in black:
///
/// ```dart
40
/// TextSpan(
41
///   text: 'Hello world!',
42
///   style: TextStyle(color: Colors.black),
43 44
/// )
/// ```
45
/// {@end-tool}
46 47 48 49
///
/// _There is some more detailed sample code in the documentation for the
/// [recognizer] property._
///
50
/// The [TextSpan.text] will be used as the semantics label unless overridden
51
/// by the [TextSpan.semanticsLabel] property. Any [PlaceholderSpan]s in the
52 53
/// [TextSpan.children] list will separate the text before and after it into two
/// semantics nodes.
54
///
55 56
/// See also:
///
57 58 59 60
///  * [WidgetSpan], a leaf node that represents an embedded inline widget in an
///    [InlineSpan] tree. Specify a widget within the [children] list by
///    wrapping the widget with a [WidgetSpan]. The widget will be laid out
///    inline within the paragraph.
61 62
///  * [Text], a widget for showing uniformly-styled text.
///  * [RichText], a widget for finer control of text rendering.
63
///  * [TextPainter], a class for painting [TextSpan] objects on a [Canvas].
64
@immutable
65
class TextSpan extends InlineSpan {
66 67 68 69 70 71 72
  /// Creates a [TextSpan] with the given values.
  ///
  /// For the object to be useful, at least one of [text] or
  /// [children] should be set.
  const TextSpan({
    this.text,
    this.children,
73
    TextStyle style,
74
    this.recognizer,
75
    this.semanticsLabel,
76
  }) : super(style: style,);
77

78
  /// The text contained in this span.
79
  ///
80
  /// If both [text] and [children] are non-null, the text will precede the
81
  /// children.
82 83 84
  ///
  /// This getter does not include the contents of its children.
  @override
85 86
  final String text;

87

88 89
  /// Additional spans to include as children.
  ///
90
  /// If both [text] and [children] are non-null, the text will precede the
91 92
  /// children.
  ///
93 94
  /// Modifying the list after the [TextSpan] has been created is not supported
  /// and may have unexpected results.
95 96
  ///
  /// The list must not contain any nulls.
97 98
  @override
  final List<InlineSpan> children;
99

100
  /// A gesture recognizer that will receive events that hit this span.
101
  ///
102 103
  /// [InlineSpan] itself does not implement hit testing or event dispatch. The
  /// object that manages the [InlineSpan] painting is also responsible for
104 105
  /// dispatching events. In the rendering library, that is the
  /// [RenderParagraph] object, which corresponds to the [RichText] widget in
106 107 108
  /// the widgets layer; these objects do not bubble events in [InlineSpan]s,
  /// so a [recognizer] is only effective for events that directly hit the
  /// [text] of that [InlineSpan], not any of its [children].
109
  ///
110
  /// [InlineSpan] also does not manage the lifetime of the gesture recognizer.
111
  /// The code that owns the [GestureRecognizer] object must call
112 113
  /// [GestureRecognizer.dispose] when the [InlineSpan] object is no longer
  /// used.
114
  ///
115
  /// {@tool snippet}
116 117
  ///
  /// This example shows how to manage the lifetime of a gesture recognizer
118 119
  /// provided to an [InlineSpan] object. It defines a `BuzzingText` widget
  /// which uses the [HapticFeedback] class to vibrate the device when the user
120
  /// long-presses the "find the" span, which is underlined in wavy green. The
121
  /// hit-testing is handled by the [RichText] widget.
122 123 124 125
  ///
  /// ```dart
  /// class BuzzingText extends StatefulWidget {
  ///   @override
126
  ///   _BuzzingTextState createState() => _BuzzingTextState();
127 128 129 130 131 132 133 134
  /// }
  ///
  /// class _BuzzingTextState extends State<BuzzingText> {
  ///   LongPressGestureRecognizer _longPressRecognizer;
  ///
  ///   @override
  ///   void initState() {
  ///     super.initState();
135
  ///     _longPressRecognizer = LongPressGestureRecognizer()
136 137 138 139 140 141 142 143
  ///       ..onLongPress = _handlePress;
  ///   }
  ///
  ///   @override
  ///   void dispose() {
  ///     _longPressRecognizer.dispose();
  ///     super.dispose();
  ///   }
144
  ///
145 146 147 148 149 150
  ///   void _handlePress() {
  ///     HapticFeedback.vibrate();
  ///   }
  ///
  ///   @override
  ///   Widget build(BuildContext context) {
151 152
  ///     return Text.rich(
  ///       TextSpan(
153
  ///         text: 'Can you ',
154
  ///         style: TextStyle(color: Colors.black),
155
  ///         children: <InlineSpan>[
156
  ///           TextSpan(
157
  ///             text: 'find the',
158
  ///             style: TextStyle(
159 160 161 162 163 164
  ///               color: Colors.green,
  ///               decoration: TextDecoration.underline,
  ///               decorationStyle: TextDecorationStyle.wavy,
  ///             ),
  ///             recognizer: _longPressRecognizer,
  ///           ),
165
  ///           TextSpan(
166 167 168 169 170 171 172 173
  ///             text: ' secret?',
  ///           ),
  ///         ],
  ///       ),
  ///     );
  ///   }
  /// }
  /// ```
174
  /// {@end-tool}
175
  @override
176 177
  final GestureRecognizer recognizer;

178
  /// An alternative semantics label for this [TextSpan].
179 180 181 182 183 184 185 186 187 188 189 190
  ///
  /// If present, the semantics of this span will contain this value instead
  /// of the actual text.
  ///
  /// This is useful for replacing abbreviations or shorthands with the full
  /// text value:
  ///
  /// ```dart
  /// TextSpan(text: r'$$', semanticsLabel: 'Double dollars')
  /// ```
  final String semanticsLabel;

191 192 193 194 195 196 197
  /// Apply the [style], [text], and [children] of this object to the
  /// given [ParagraphBuilder], from which a [Paragraph] can be obtained.
  /// [Paragraph] objects can be drawn on [Canvas] objects.
  ///
  /// Rather than using this directly, it's simpler to use the
  /// [TextPainter] class to paint [TextSpan] objects onto [Canvas]
  /// objects.
198
  @override
199 200 201 202 203
  void build(
    ui.ParagraphBuilder builder, {
    double textScaleFactor = 1.0,
    List<PlaceholderDimensions> dimensions,
  }) {
204
    assert(debugAssertIsValid());
205 206
    final bool hasStyle = style != null;
    if (hasStyle)
207
      builder.pushStyle(style.getTextStyle(textScaleFactor: textScaleFactor));
208 209 210
    if (text != null)
      builder.addText(text);
    if (children != null) {
211
      for (final InlineSpan child in children) {
212
        assert(child != null);
213 214 215 216 217
        child.build(
          builder,
          textScaleFactor: textScaleFactor,
          dimensions: dimensions,
        );
218 219 220 221 222 223
      }
    }
    if (hasStyle)
      builder.pop();
  }

224
  /// Walks this [TextSpan] and its descendants in pre-order and calls [visitor]
225
  /// for each span that has text.
226
  ///
227 228
  /// When `visitor` returns true, the walk will continue. When `visitor`
  /// returns false, then the walk will end.
229 230 231 232 233 234 235
  @override
  bool visitChildren(InlineSpanVisitor visitor) {
    if (text != null) {
      if (!visitor(this))
        return false;
    }
    if (children != null) {
236
      for (final InlineSpan child in children) {
237 238 239 240 241 242 243 244 245 246 247
        if (!child.visitChildren(visitor))
          return false;
      }
    }
    return true;
  }

  // TODO(garyq): Remove this after next stable release.
  /// Walks this [TextSpan] and any descendants in pre-order and calls `visitor`
  /// for each span that has content.
  ///
248 249
  /// When `visitor` returns true, the walk will continue. When `visitor`
  /// returns false, then the walk will end.
250
  @override
251 252 253 254
  @Deprecated(
    'Use to visitChildren instead. '
    'This feature was deprecated after v1.7.3.'
  )
255
  bool visitTextSpan(bool visitor(TextSpan span)) {
256 257 258 259 260
    if (text != null) {
      if (!visitor(this))
        return false;
    }
    if (children != null) {
261
      for (final InlineSpan child in children) {
262 263 264 265
        assert(
          child is TextSpan,
          'visitTextSpan is deprecated. Use visitChildren to support InlineSpans',
        );
266
        final TextSpan textSpanChild = child as TextSpan;
267
        if (!textSpanChild.visitTextSpan(visitor))
268 269 270 271 272 273 274
          return false;
      }
    }
    return true;
  }

  /// Returns the text span that contains the given position in the text.
275 276 277 278 279
  @override
  InlineSpan getSpanForPositionVisitor(TextPosition position, Accumulator offset) {
    if (text == null) {
      return null;
    }
280 281
    final TextAffinity affinity = position.affinity;
    final int targetOffset = position.offset;
282 283 284 285 286 287 288 289
    final int endOffset = offset.value + text.length;
    if (offset.value == targetOffset && affinity == TextAffinity.downstream ||
        offset.value < targetOffset && targetOffset < endOffset ||
        endOffset == targetOffset && affinity == TextAffinity.upstream) {
      return this;
    }
    offset.increment(text.length);
    return null;
290 291
  }

292
  @override
293 294 295 296 297
  void computeToPlainText(
    StringBuffer buffer, {
    bool includeSemanticsLabels = true,
    bool includePlaceholders = true
  }) {
298
    assert(debugAssertIsValid());
299 300 301 302 303 304
    if (semanticsLabel != null && includeSemanticsLabels) {
      buffer.write(semanticsLabel);
    } else if (text != null) {
      buffer.write(text);
    }
    if (children != null) {
305
      for (final InlineSpan child in children) {
306 307 308 309
        child.computeToPlainText(buffer,
          includeSemanticsLabels: includeSemanticsLabels,
          includePlaceholders: includePlaceholders,
        );
310
      }
311
    }
312 313
  }

314 315 316 317 318 319 320 321 322 323 324
  @override
  void computeSemanticsInformation(List<InlineSpanSemanticsInformation> collector) {
    assert(debugAssertIsValid());
    if (text != null || semanticsLabel != null) {
      collector.add(InlineSpanSemanticsInformation(
        text,
        semanticsLabel: semanticsLabel,
        recognizer: recognizer,
      ));
    }
    if (children != null) {
325
      for (final InlineSpan child in children) {
326 327 328 329 330
        child.computeSemanticsInformation(collector);
      }
    }
  }

331 332 333
  @override
  int codeUnitAtVisitor(int index, Accumulator offset) {
    if (text == null) {
334
      return null;
335 336 337 338 339 340 341 342 343 344
    }
    if (index - offset.value < text.length) {
      return text.codeUnitAt(index - offset.value);
    }
    offset.increment(text.length);
    return null;
  }

  @override
  void describeSemantics(Accumulator offset, List<int> semanticsOffsets, List<dynamic> semanticsElements) {
345 346 347 348
    if (
      recognizer != null &&
      (recognizer is TapGestureRecognizer || recognizer is LongPressGestureRecognizer)
    ) {
349 350 351 352 353 354
      final int length = semanticsLabel?.length ?? text.length;
      semanticsOffsets.add(offset.value);
      semanticsOffsets.add(offset.value + length);
      semanticsElements.add(recognizer);
    }
    offset.increment(text != null ? text.length : 0);
355 356
  }

357 358
  /// In checked mode, throws an exception if the object is not in a valid
  /// configuration. Otherwise, returns true.
359 360
  ///
  /// This is intended to be used as follows:
361
  ///
362
  /// ```dart
363
  /// assert(myTextSpan.debugAssertIsValid());
364
  /// ```
365
  @override
366
  bool debugAssertIsValid() {
367
    assert(() {
368
      if (children != null) {
369
        for (final InlineSpan child in children) {
370 371 372 373 374 375 376 377 378
          if (child == null) {
            throw FlutterError.fromParts(<DiagnosticsNode>[
              ErrorSummary('TextSpan contains a null child.'),
              ErrorDescription(
                  'A TextSpan object with a non-null child list should not have any nulls in its child list.'),
              toDiagnosticsNode(name: 'The full text in question was',
                  style: DiagnosticsTreeStyle.errorProperty),
            ]);
          }
379
          assert(child.debugAssertIsValid());
380 381 382
        }
      }
      return true;
383
    }());
384
    return super.debugAssertIsValid();
385 386
  }

387 388
  @override
  RenderComparison compareTo(InlineSpan other) {
389 390
    if (identical(this, other))
      return RenderComparison.identical;
391
    if (other.runtimeType != runtimeType)
392
      return RenderComparison.layout;
393
    final TextSpan textSpan = other as TextSpan;
394 395 396 397
    if (textSpan.text != text ||
        children?.length != textSpan.children?.length ||
        (style == null) != (textSpan.style == null))
      return RenderComparison.layout;
398 399 400
    RenderComparison result = recognizer == textSpan.recognizer ?
      RenderComparison.identical :
      RenderComparison.metadata;
401
    if (style != null) {
402
      final RenderComparison candidate = style.compareTo(textSpan.style);
403 404 405 406 407 408 409
      if (candidate.index > result.index)
        result = candidate;
      if (result == RenderComparison.layout)
        return result;
    }
    if (children != null) {
      for (int index = 0; index < children.length; index += 1) {
410
        final RenderComparison candidate = children[index].compareTo(textSpan.children[index]);
411 412 413 414 415 416 417 418 419
        if (candidate.index > result.index)
          result = candidate;
        if (result == RenderComparison.layout)
          return result;
      }
    }
    return result;
  }

420
  @override
421
  bool operator ==(Object other) {
422 423
    if (identical(this, other))
      return true;
424
    if (other.runtimeType != runtimeType)
425
      return false;
426 427
    if (super != other)
      return false;
428 429 430 431 432
    return other is TextSpan
        && other.text == text
        && other.recognizer == recognizer
        && other.semanticsLabel == semanticsLabel
        && listEquals<InlineSpan>(other.children, children);
433 434 435
  }

  @override
436 437 438 439 440 441 442
  int get hashCode => hashValues(
    super.hashCode,
    text,
    recognizer,
    semanticsLabel,
    hashList(children),
  );
443 444

  @override
445
  String toStringShort() => objectRuntimeType(this, 'TextSpan');
446

447
  @override
448 449
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
450

451 452 453 454 455 456 457 458
    properties.add(
      StringProperty(
        'text',
        text,
        showName: false,
        defaultValue: null,
      )
    );
459 460
    if (style == null && text == null && children == null)
      properties.add(DiagnosticsNode.message('(empty)'));
461

462
    properties.add(DiagnosticsProperty<GestureRecognizer>(
463 464 465 466
      'recognizer', recognizer,
      description: recognizer?.runtimeType?.toString(),
      defaultValue: null,
    ));
467

468 469 470
    if (semanticsLabel != null) {
      properties.add(StringProperty('semanticsLabel', semanticsLabel));
    }
471 472 473 474
  }

  @override
  List<DiagnosticsNode> debugDescribeChildren() {
475 476
    if (children == null)
      return const <DiagnosticsNode>[];
477
    return children.map<DiagnosticsNode>((InlineSpan child) {
478 479 480
      if (child != null) {
        return child.toDiagnosticsNode();
      } else {
481
        return DiagnosticsNode.message('<null child>');
482 483
      }
    }).toList();
484
  }
485
}