paragraph.dart 33.8 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
import 'dart:collection';
6
import 'dart:math' as math;
7
import 'dart:ui' as ui show Gradient, Shader, TextBox, PlaceholderAlignment, TextHeightBehavior;
8

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

15
import 'package:vector_math/vector_math_64.dart';
16

17
import 'box.dart';
18
import 'debug.dart';
19
import 'object.dart';
20

21
/// How overflowing text should be handled.
22 23 24
///
/// A [TextOverflow] can be passed to [Text] and [RichText] via their
/// [Text.overflow] and [RichText.overflow] properties respectively.
25 26 27 28 29 30 31 32 33
enum TextOverflow {
  /// Clip the overflowing text to fix its container.
  clip,

  /// Fade the overflowing text to transparent.
  fade,

  /// Use an ellipsis to indicate that the text has overflowed.
  ellipsis,
34 35 36

  /// Render overflowing text outside of its container.
  visible,
37 38
}

39 40
const String _kEllipsis = '\u2026';

41 42 43 44 45 46 47
/// Parent data for use with [RenderParagraph].
class TextParentData extends ContainerBoxParentData<RenderBox> {
  /// The scaling of the text.
  double scale;

  @override
  String toString() {
48 49 50 51 52
    final List<String> values = <String>[
      if (offset != null) 'offset=$offset',
      if (scale != null) 'scale=$scale',
      super.toString(),
    ];
53 54 55 56 57 58 59
    return values.join('; ');
  }
}

/// A render object that displays a paragraph of text.
class RenderParagraph extends RenderBox
    with ContainerRenderObjectMixin<RenderBox, TextParentData>,
60 61
             RenderBoxContainerDefaultsMixin<RenderBox, TextParentData>,
                  RelayoutWhenSystemFontsChangeMixin {
62 63
  /// Creates a paragraph render object.
  ///
Ian Hickson's avatar
Ian Hickson committed
64 65
  /// The [text], [textAlign], [textDirection], [overflow], [softWrap], and
  /// [textScaleFactor] arguments must not be null.
66 67 68
  ///
  /// The [maxLines] property may be null (and indeed defaults to null), but if
  /// it is not null, it must be greater than zero.
69
  RenderParagraph(InlineSpan text, {
70
    TextAlign textAlign = TextAlign.start,
Ian Hickson's avatar
Ian Hickson committed
71
    @required TextDirection textDirection,
72 73 74
    bool softWrap = true,
    TextOverflow overflow = TextOverflow.clip,
    double textScaleFactor = 1.0,
75
    int maxLines,
76
    Locale locale,
77
    StrutStyle strutStyle,
78 79
    TextWidthBasis textWidthBasis = TextWidthBasis.parent,
    ui.TextHeightBehavior textHeightBehavior,
80
    List<RenderBox> children,
81 82
  }) : assert(text != null),
       assert(text.debugAssertIsValid()),
Ian Hickson's avatar
Ian Hickson committed
83 84
       assert(textAlign != null),
       assert(textDirection != null),
85 86 87
       assert(softWrap != null),
       assert(overflow != null),
       assert(textScaleFactor != null),
88
       assert(maxLines == null || maxLines > 0),
89
       assert(textWidthBasis != null),
90
       _softWrap = softWrap,
91
       _overflow = overflow,
92
       _textPainter = TextPainter(
93 94
         text: text,
         textAlign: textAlign,
Ian Hickson's avatar
Ian Hickson committed
95
         textDirection: textDirection,
96 97 98
         textScaleFactor: textScaleFactor,
         maxLines: maxLines,
         ellipsis: overflow == TextOverflow.ellipsis ? _kEllipsis : null,
99
         locale: locale,
100
         strutStyle: strutStyle,
101
         textWidthBasis: textWidthBasis,
102
         textHeightBehavior: textHeightBehavior
103 104 105 106 107 108 109 110 111 112
       ) {
    addAll(children);
    _extractPlaceholderSpans(text);
  }

  @override
  void setupParentData(RenderBox child) {
    if (child.parentData is! TextParentData)
      child.parentData = TextParentData();
  }
113

114
  final TextPainter _textPainter;
115

116
  /// The text to display.
117 118
  InlineSpan get text => _textPainter.text;
  set text(InlineSpan value) {
119
    assert(value != null);
120 121 122 123 124 125
    switch (_textPainter.text.compareTo(value)) {
      case RenderComparison.identical:
      case RenderComparison.metadata:
        return;
      case RenderComparison.paint:
        _textPainter.text = value;
126
        _extractPlaceholderSpans(value);
127
        markNeedsPaint();
128
        markNeedsSemanticsUpdate();
129 130 131 132
        break;
      case RenderComparison.layout:
        _textPainter.text = value;
        _overflowShader = null;
133
        _extractPlaceholderSpans(value);
134 135 136
        markNeedsLayout();
        break;
    }
137 138
  }

139 140 141 142 143 144 145 146 147 148 149 150
  List<PlaceholderSpan> _placeholderSpans;
  void _extractPlaceholderSpans(InlineSpan span) {
    _placeholderSpans = <PlaceholderSpan>[];
    span.visitChildren((InlineSpan span) {
      if (span is PlaceholderSpan) {
        final PlaceholderSpan placeholderSpan = span;
        _placeholderSpans.add(placeholderSpan);
      }
      return true;
    });
  }

151 152
  /// How the text should be aligned horizontally.
  TextAlign get textAlign => _textPainter.textAlign;
153
  set textAlign(TextAlign value) {
Ian Hickson's avatar
Ian Hickson committed
154
    assert(value != null);
155 156 157 158 159 160
    if (_textPainter.textAlign == value)
      return;
    _textPainter.textAlign = value;
    markNeedsPaint();
  }

Ian Hickson's avatar
Ian Hickson committed
161 162 163 164 165 166 167 168 169
  /// The directionality of the text.
  ///
  /// This decides how the [TextAlign.start], [TextAlign.end], and
  /// [TextAlign.justify] values of [textAlign] are interpreted.
  ///
  /// This is also used to disambiguate how to render bidirectional text. For
  /// example, if the [text] is an English phrase followed by a Hebrew phrase,
  /// in a [TextDirection.ltr] context the English phrase will be on the left
  /// and the Hebrew phrase to its right, while in a [TextDirection.rtl]
170
  /// context, the English phrase will be on the right and the Hebrew phrase on
Ian Hickson's avatar
Ian Hickson committed
171 172 173 174 175 176 177 178 179 180 181 182
  /// its left.
  ///
  /// This must not be null.
  TextDirection get textDirection => _textPainter.textDirection;
  set textDirection(TextDirection value) {
    assert(value != null);
    if (_textPainter.textDirection == value)
      return;
    _textPainter.textDirection = value;
    markNeedsLayout();
  }

183 184
  /// Whether the text should break at soft line breaks.
  ///
185 186 187 188 189
  /// If false, the glyphs in the text will be positioned as if there was
  /// unlimited horizontal space.
  ///
  /// If [softWrap] is false, [overflow] and [textAlign] may have unexpected
  /// effects.
190 191
  bool get softWrap => _softWrap;
  bool _softWrap;
192
  set softWrap(bool value) {
193 194 195 196 197 198 199 200 201 202
    assert(value != null);
    if (_softWrap == value)
      return;
    _softWrap = value;
    markNeedsLayout();
  }

  /// How visual overflow should be handled.
  TextOverflow get overflow => _overflow;
  TextOverflow _overflow;
203
  set overflow(TextOverflow value) {
204 205 206 207
    assert(value != null);
    if (_overflow == value)
      return;
    _overflow = value;
208
    _textPainter.ellipsis = value == TextOverflow.ellipsis ? _kEllipsis : null;
209
    markNeedsLayout();
210 211
  }

212 213 214 215 216 217 218 219 220 221 222 223 224 225
  /// The number of font pixels for each logical pixel.
  ///
  /// For example, if the text scale factor is 1.5, text will be 50% larger than
  /// the specified font size.
  double get textScaleFactor => _textPainter.textScaleFactor;
  set textScaleFactor(double value) {
    assert(value != null);
    if (_textPainter.textScaleFactor == value)
      return;
    _textPainter.textScaleFactor = value;
    _overflowShader = null;
    markNeedsLayout();
  }

226 227 228
  /// An optional maximum number of lines for the text to span, wrapping if
  /// necessary. If the text exceeds the given number of lines, it will be
  /// truncated according to [overflow] and [softWrap].
229
  int get maxLines => _textPainter.maxLines;
230 231
  /// The value may be null. If it is not null, then it must be greater than
  /// zero.
232
  set maxLines(int value) {
233
    assert(value == null || value > 0);
234 235 236 237 238 239 240
    if (_textPainter.maxLines == value)
      return;
    _textPainter.maxLines = value;
    _overflowShader = null;
    markNeedsLayout();
  }

241 242
  /// Used by this paragraph's internal [TextPainter] to select a
  /// locale-specific font.
243
  ///
244 245
  /// In some cases the same Unicode character may be rendered differently
  /// depending
246 247 248 249 250 251
  /// on the locale. For example the '骨' character is rendered differently in
  /// the Chinese and Japanese locales. In these cases the [locale] may be used
  /// to select a locale-specific font.
  Locale get locale => _textPainter.locale;
  /// The value may be null.
  set locale(Locale value) {
252 253
    if (_textPainter.locale == value)
      return;
254
    _textPainter.locale = value;
255 256 257 258
    _overflowShader = null;
    markNeedsLayout();
  }

259 260 261 262 263 264 265 266 267 268 269
  /// {@macro flutter.painting.textPainter.strutStyle}
  StrutStyle get strutStyle => _textPainter.strutStyle;
  /// The value may be null.
  set strutStyle(StrutStyle value) {
    if (_textPainter.strutStyle == value)
      return;
    _textPainter.strutStyle = value;
    _overflowShader = null;
    markNeedsLayout();
  }

270 271 272 273 274 275 276 277 278 279 280
  /// {@macro flutter.widgets.basic.TextWidthBasis}
  TextWidthBasis get textWidthBasis => _textPainter.textWidthBasis;
  set textWidthBasis(TextWidthBasis value) {
    assert(value != null);
    if (_textPainter.textWidthBasis == value)
      return;
    _textPainter.textWidthBasis = value;
    _overflowShader = null;
    markNeedsLayout();
  }

281 282 283 284 285 286 287 288 289 290
  /// {@macro flutter.dart:ui.textHeightBehavior}
  ui.TextHeightBehavior get textHeightBehavior => _textPainter.textHeightBehavior;
  set textHeightBehavior(ui.TextHeightBehavior value) {
    if (_textPainter.textHeightBehavior == value)
      return;
    _textPainter.textHeightBehavior = value;
    _overflowShader = null;
    markNeedsLayout();
  }

291
  @override
292
  double computeMinIntrinsicWidth(double height) {
293 294 295 296 297
    if (!_canComputeIntrinsics()) {
      return 0.0;
    }
    _computeChildrenWidthWithMinIntrinsics(height);
    _layoutText(); // layout with infinite width.
298
    return _textPainter.minIntrinsicWidth;
299 300
  }

301
  @override
302
  double computeMaxIntrinsicWidth(double height) {
303 304 305 306 307
    if (!_canComputeIntrinsics()) {
      return 0.0;
    }
    _computeChildrenWidthWithMaxIntrinsics(height);
    _layoutText(); // layout with infinite width.
308
    return _textPainter.maxIntrinsicWidth;
309 310
  }

311
  double _computeIntrinsicHeight(double width) {
312 313 314 315
    if (!_canComputeIntrinsics()) {
      return 0.0;
    }
    _computeChildrenHeightWithMinIntrinsics(width);
316 317
    _layoutText(minWidth: width, maxWidth: width);
    return _textPainter.height;
318 319
  }

320
  @override
321 322
  double computeMinIntrinsicHeight(double width) {
    return _computeIntrinsicHeight(width);
323 324
  }

325
  @override
326 327
  double computeMaxIntrinsicHeight(double width) {
    return _computeIntrinsicHeight(width);
328 329
  }

330
  @override
331
  double computeDistanceToActualBaseline(TextBaseline baseline) {
332
    assert(!debugNeedsLayout);
333 334
    assert(constraints != null);
    assert(constraints.debugAssertIsValid());
335
    _layoutTextWithConstraints(constraints);
336 337 338 339 340 341
    // TODO(garyq): Since our metric for ideographic baseline is currently
    // inaccurate and the non-alphabetic baselines are based off of the
    // alphabetic baseline, we use the alphabetic for now to produce correct
    // layouts. We should eventually change this back to pass the `baseline`
    // property when the ideographic baseline is properly implemented
    // (https://github.com/flutter/flutter/issues/22625).
342
    return _textPainter.computeDistanceToActualBaseline(TextBaseline.alphabetic);
343 344
  }

345 346 347 348
  // Intrinsics cannot be calculated without a full layout for
  // alignments that require the baseline (baseline, aboveBaseline,
  // belowBaseline).
  bool _canComputeIntrinsics() {
349
    for (final PlaceholderSpan span in _placeholderSpans) {
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
      switch (span.alignment) {
        case ui.PlaceholderAlignment.baseline:
        case ui.PlaceholderAlignment.aboveBaseline:
        case ui.PlaceholderAlignment.belowBaseline: {
          assert(RenderObject.debugCheckingIntrinsics,
            'Intrinsics are not available for PlaceholderAlignment.baseline, '
            'PlaceholderAlignment.aboveBaseline, or PlaceholderAlignment.belowBaseline,');
          return false;
        }
        case ui.PlaceholderAlignment.top:
        case ui.PlaceholderAlignment.middle:
        case ui.PlaceholderAlignment.bottom: {
          continue;
        }
      }
    }
    return true;
  }

  void _computeChildrenWidthWithMaxIntrinsics(double height) {
    RenderBox child = firstChild;
    final List<PlaceholderDimensions> placeholderDimensions = List<PlaceholderDimensions>(childCount);
    int childIndex = 0;
    while (child != null) {
      // Height and baseline is irrelevant as all text will be laid
      // out in a single line.
      placeholderDimensions[childIndex] = PlaceholderDimensions(
        size: Size(child.getMaxIntrinsicWidth(height), height),
        alignment: _placeholderSpans[childIndex].alignment,
        baseline: _placeholderSpans[childIndex].baseline,
      );
      child = childAfter(child);
      childIndex += 1;
    }
    _textPainter.setPlaceholderDimensions(placeholderDimensions);
  }

  void _computeChildrenWidthWithMinIntrinsics(double height) {
    RenderBox child = firstChild;
    final List<PlaceholderDimensions> placeholderDimensions = List<PlaceholderDimensions>(childCount);
    int childIndex = 0;
    while (child != null) {
      final double intrinsicWidth = child.getMinIntrinsicWidth(height);
      final double intrinsicHeight = child.getMinIntrinsicHeight(intrinsicWidth);
      placeholderDimensions[childIndex] = PlaceholderDimensions(
        size: Size(intrinsicWidth, intrinsicHeight),
        alignment: _placeholderSpans[childIndex].alignment,
        baseline: _placeholderSpans[childIndex].baseline,
      );
      child = childAfter(child);
      childIndex += 1;
    }
    _textPainter.setPlaceholderDimensions(placeholderDimensions);
  }

  void _computeChildrenHeightWithMinIntrinsics(double width) {
    RenderBox child = firstChild;
    final List<PlaceholderDimensions> placeholderDimensions = List<PlaceholderDimensions>(childCount);
    int childIndex = 0;
    while (child != null) {
      final double intrinsicHeight = child.getMinIntrinsicHeight(width);
      final double intrinsicWidth = child.getMinIntrinsicWidth(intrinsicHeight);
      placeholderDimensions[childIndex] = PlaceholderDimensions(
        size: Size(intrinsicWidth, intrinsicHeight),
        alignment: _placeholderSpans[childIndex].alignment,
        baseline: _placeholderSpans[childIndex].baseline,
      );
      child = childAfter(child);
      childIndex += 1;
    }
    _textPainter.setPlaceholderDimensions(placeholderDimensions);
  }

423
  @override
424
  bool hitTestSelf(Offset position) => true;
Adam Barth's avatar
Adam Barth committed
425

426 427 428 429
  @override
  bool hitTestChildren(BoxHitTestResult result, { Offset position }) {
    RenderBox child = firstChild;
    while (child != null) {
430
      final TextParentData textParentData = child.parentData as TextParentData;
431 432 433 434 435 436 437 438 439
      final Matrix4 transform = Matrix4.translationValues(
        textParentData.offset.dx,
        textParentData.offset.dy,
        0.0,
      )..scale(
        textParentData.scale,
        textParentData.scale,
        textParentData.scale,
      );
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
      final bool isHit = result.addWithPaintTransform(
        transform: transform,
        position: position,
        hitTest: (BoxHitTestResult result, Offset transformed) {
          assert(() {
            final Offset manualPosition = (position - textParentData.offset) / textParentData.scale;
            return (transformed.dx - manualPosition.dx).abs() < precisionErrorTolerance
              && (transformed.dy - manualPosition.dy).abs() < precisionErrorTolerance;
          }());
          return child.hitTest(result, position: transformed);
        },
      );
      if (isHit) {
        return true;
      }
      child = childAfter(child);
    }
    return false;
  }

460
  @override
461
  void handleEvent(PointerEvent event, BoxHitTestEntry entry) {
462
    assert(debugHandleEvent(event, entry));
463 464
    if (event is! PointerDownEvent)
      return;
465
    _layoutTextWithConstraints(constraints);
466
    final Offset offset = entry.localPosition;
467
    final TextPosition position = _textPainter.getPositionForOffset(offset);
468 469 470 471 472 473
    final InlineSpan span = _textPainter.text.getSpanForPosition(position);
    if (span == null) {
      return;
    }
    if (span is TextSpan) {
      final TextSpan textSpan = span;
474
      textSpan.recognizer?.addPointer(event as PointerDownEvent);
475
    }
476 477
  }

478
  bool _needsClipping = false;
479 480
  ui.Shader _overflowShader;

481
  /// Whether this paragraph currently has a [dart:ui.Shader] for its overflow
Ian Hickson's avatar
Ian Hickson committed
482
  /// effect.
483 484
  ///
  /// Used to test this object. Not for use in production.
485 486 487
  @visibleForTesting
  bool get debugHasOverflowShader => _overflowShader != null;

488 489
  void _layoutText({ double minWidth = 0.0, double maxWidth = double.infinity }) {
    final bool widthMatters = softWrap || overflow == TextOverflow.ellipsis;
490 491 492 493 494 495
    _textPainter.layout(
      minWidth: minWidth,
      maxWidth: widthMatters ?
        maxWidth :
        double.infinity,
    );
496 497
  }

498 499 500 501 502 503
  @override
  void systemFontsDidChange() {
    super.systemFontsDidChange();
    _textPainter.markNeedsLayout();
  }

504 505 506 507 508 509 510
  // Placeholder dimensions representing the sizes of child inline widgets.
  //
  // These need to be cached because the text painter's placeholder dimensions
  // will be overwritten during intrinsic width/height calculations and must be
  // restored to the original values before final layout and painting.
  List<PlaceholderDimensions> _placeholderDimensions;

511
  void _layoutTextWithConstraints(BoxConstraints constraints) {
512
    _textPainter.setPlaceholderDimensions(_placeholderDimensions);
513 514 515 516 517 518 519 520 521 522 523 524
    _layoutText(minWidth: constraints.minWidth, maxWidth: constraints.maxWidth);
  }

  // Layout the child inline widgets. We then pass the dimensions of the
  // children to _textPainter so that appropriate placeholders can be inserted
  // into the LibTxt layout. This does not do anything if no inline widgets were
  // specified.
  void _layoutChildren(BoxConstraints constraints) {
    if (childCount == 0) {
      return;
    }
    RenderBox child = firstChild;
525
    _placeholderDimensions = List<PlaceholderDimensions>(childCount);
526 527 528 529 530 531 532 533
    int childIndex = 0;
    while (child != null) {
      // Only constrain the width to the maximum width of the paragraph.
      // Leave height unconstrained, which will overflow if expanded past.
      child.layout(
        BoxConstraints(
          maxWidth: constraints.maxWidth,
        ),
534
        parentUsesSize: true,
535 536 537 538
      );
      double baselineOffset;
      switch (_placeholderSpans[childIndex].alignment) {
        case ui.PlaceholderAlignment.baseline: {
539 540 541
          baselineOffset = child.getDistanceToBaseline(
            _placeholderSpans[childIndex].baseline
          );
542 543 544 545 546 547 548
          break;
        }
        default: {
          baselineOffset = null;
          break;
        }
      }
549
      _placeholderDimensions[childIndex] = PlaceholderDimensions(
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
        size: child.size,
        alignment: _placeholderSpans[childIndex].alignment,
        baseline: _placeholderSpans[childIndex].baseline,
        baselineOffset: baselineOffset,
      );
      child = childAfter(child);
      childIndex += 1;
    }
  }

  // Iterate through the laid-out children and set the parentData offsets based
  // off of the placeholders inserted for each child.
  void _setParentData() {
    RenderBox child = firstChild;
    int childIndex = 0;
565
    while (child != null && childIndex < _textPainter.inlinePlaceholderBoxes.length) {
566
      final TextParentData textParentData = child.parentData as TextParentData;
567 568
      textParentData.offset = Offset(
        _textPainter.inlinePlaceholderBoxes[childIndex].left,
569
        _textPainter.inlinePlaceholderBoxes[childIndex].top,
570 571 572 573 574 575 576
      );
      textParentData.scale = _textPainter.inlinePlaceholderScales[childIndex];
      child = childAfter(child);
      childIndex += 1;
    }
  }

577
  @override
578
  void performLayout() {
579
    final BoxConstraints constraints = this.constraints;
580
    _layoutChildren(constraints);
581
    _layoutTextWithConstraints(constraints);
582 583
    _setParentData();

584 585 586 587 588
    // We grab _textPainter.size and _textPainter.didExceedMaxLines here because
    // assigning to `size` will trigger us to validate our intrinsic sizes,
    // which will change _textPainter's layout because the intrinsic size
    // calculations are destructive. Other _textPainter state will also be
    // affected. See also RenderEditable which has a similar issue.
589
    final Size textSize = _textPainter.size;
590
    final bool textDidExceedMaxLines = _textPainter.didExceedMaxLines;
591
    size = constraints.constrain(textSize);
592

593
    final bool didOverflowHeight = size.height < textSize.height || textDidExceedMaxLines;
594
    final bool didOverflowWidth = size.width < textSize.width;
595 596 597 598 599
    // TODO(abarth): We're only measuring the sizes of the line boxes here. If
    // the glyphs draw outside the line boxes, we might think that there isn't
    // visual overflow when there actually is visual overflow. This can become
    // a problem if we start having horizontal overflow and introduce a clip
    // that affects the actual (but undetected) vertical overflow.
600 601
    final bool hasVisualOverflow = didOverflowWidth || didOverflowHeight;
    if (hasVisualOverflow) {
602
      switch (_overflow) {
603 604 605 606
        case TextOverflow.visible:
          _needsClipping = false;
          _overflowShader = null;
          break;
607
        case TextOverflow.clip:
608
        case TextOverflow.ellipsis:
609
          _needsClipping = true;
610 611 612
          _overflowShader = null;
          break;
        case TextOverflow.fade:
Ian Hickson's avatar
Ian Hickson committed
613
          assert(textDirection != null);
614
          _needsClipping = true;
615 616
          final TextPainter fadeSizePainter = TextPainter(
            text: TextSpan(style: _textPainter.text.style, text: '\u2026'),
Ian Hickson's avatar
Ian Hickson committed
617 618
            textDirection: textDirection,
            textScaleFactor: textScaleFactor,
619
            locale: locale,
620
          )..layout();
621
          if (didOverflowWidth) {
Ian Hickson's avatar
Ian Hickson committed
622 623 624 625 626 627 628 629 630 631 632
            double fadeEnd, fadeStart;
            switch (textDirection) {
              case TextDirection.rtl:
                fadeEnd = 0.0;
                fadeStart = fadeSizePainter.width;
                break;
              case TextDirection.ltr:
                fadeEnd = size.width;
                fadeStart = fadeEnd - fadeSizePainter.width;
                break;
            }
633 634 635
            _overflowShader = ui.Gradient.linear(
              Offset(fadeStart, 0.0),
              Offset(fadeEnd, 0.0),
636
              <Color>[const Color(0xFFFFFFFF), const Color(0x00FFFFFF)],
637 638 639 640
            );
          } else {
            final double fadeEnd = size.height;
            final double fadeStart = fadeEnd - fadeSizePainter.height / 2.0;
641 642 643
            _overflowShader = ui.Gradient.linear(
              Offset(0.0, fadeStart),
              Offset(0.0, fadeEnd),
644
              <Color>[const Color(0xFFFFFFFF), const Color(0x00FFFFFF)],
645 646
            );
          }
647 648 649
          break;
      }
    } else {
650
      _needsClipping = false;
651 652
      _overflowShader = null;
    }
653 654
  }

655
  @override
656
  void paint(PaintingContext context, Offset offset) {
657 658
    // Ideally we could compute the min/max intrinsic width/height with a
    // non-destructive operation. However, currently, computing these values
659 660
    // will destroy state inside the painter. If that happens, we need to get
    // back the correct state by calling _layout again.
661
    //
662 663
    // TODO(abarth): Make computing the min/max intrinsic width/height a
    //  non-destructive operation.
664 665 666
    //
    // If you remove this call, make sure that changing the textAlign still
    // works properly.
667
    _layoutTextWithConstraints(constraints);
668 669 670

    assert(() {
      if (debugRepaintTextRainbowEnabled) {
671
        final Paint paint = Paint()
672
          ..color = debugCurrentRepaintColor.toColor();
673
        context.canvas.drawRect(offset & size, paint);
674 675
      }
      return true;
676
    }());
677

678
    if (_needsClipping) {
679
      final Rect bounds = offset & size;
680
      if (_overflowShader != null) {
681 682
        // This layer limits what the shader below blends with to be just the
        // text (as opposed to the text and its background).
683
        context.canvas.saveLayer(bounds, Paint());
684
      } else {
685
        context.canvas.save();
686
      }
687 688 689 690 691 692
      context.canvas.clipRect(bounds);
    }
    _textPainter.paint(context.canvas, offset);

    RenderBox child = firstChild;
    int childIndex = 0;
693 694 695 696 697
    // childIndex might be out of index of placeholder boxes. This can happen
    // if engine truncates children due to ellipsis. Sadly, we would not know
    // it until we finish layout, and RenderObject is in immutable state at
    // this point.
    while (child != null && childIndex < _textPainter.inlinePlaceholderBoxes.length) {
698
      final TextParentData textParentData = child.parentData as TextParentData;
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713

      final double scale = textParentData.scale;
      context.pushTransform(
        needsCompositing,
        offset + textParentData.offset,
        Matrix4.diagonal3Values(scale, scale, scale),
        (PaintingContext context, Offset offset) {
          context.paintChild(
            child,
            offset,
          );
        },
      );
      child = childAfter(child);
      childIndex += 1;
714
    }
715
    if (_needsClipping) {
716
      if (_overflowShader != null) {
717
        context.canvas.translate(offset.dx, offset.dy);
718
        final Paint paint = Paint()
719
          ..blendMode = BlendMode.modulate
720
          ..shader = _overflowShader;
721
        context.canvas.drawRect(Offset.zero & size, paint);
722
      }
723
      context.canvas.restore();
724
    }
725 726
  }

727 728 729 730
  /// Returns the offset at which to paint the caret.
  ///
  /// Valid only after [layout].
  Offset getOffsetForCaret(TextPosition position, Rect caretPrototype) {
731
    assert(!debugNeedsLayout);
732 733 734 735 736 737 738 739 740 741 742 743
    _layoutTextWithConstraints(constraints);
    return _textPainter.getOffsetForCaret(position, caretPrototype);
  }

  /// Returns a list of rects that bound the given selection.
  ///
  /// A given selection might have more than one rect if this text painter
  /// contains bidirectional text because logically contiguous text might not be
  /// visually contiguous.
  ///
  /// Valid only after [layout].
  List<ui.TextBox> getBoxesForSelection(TextSelection selection) {
744
    assert(!debugNeedsLayout);
745 746 747 748 749 750 751 752
    _layoutTextWithConstraints(constraints);
    return _textPainter.getBoxesForSelection(selection);
  }

  /// Returns the position within the text for the given pixel offset.
  ///
  /// Valid only after [layout].
  TextPosition getPositionForOffset(Offset offset) {
753
    assert(!debugNeedsLayout);
754 755 756 757 758 759 760 761 762 763 764 765 766 767
    _layoutTextWithConstraints(constraints);
    return _textPainter.getPositionForOffset(offset);
  }

  /// Returns the text range of the word at the given offset. Characters not
  /// part of a word, such as spaces, symbols, and punctuation, have word breaks
  /// on both sides. In such cases, this method will return a text range that
  /// contains the given text position.
  ///
  /// Word boundaries are defined more precisely in Unicode Standard Annex #29
  /// <http://www.unicode.org/reports/tr29/#Word_Boundaries>.
  ///
  /// Valid only after [layout].
  TextRange getWordBoundary(TextPosition position) {
768
    assert(!debugNeedsLayout);
769 770 771 772
    _layoutTextWithConstraints(constraints);
    return _textPainter.getWordBoundary(position);
  }

773 774 775 776 777 778 779 780 781 782 783 784 785 786
  /// Returns the size of the text as laid out.
  ///
  /// This can differ from [size] if the text overflowed or if the [constraints]
  /// provided by the parent [RenderObject] forced the layout to be bigger than
  /// necessary for the given [text].
  ///
  /// This returns the [TextPainter.size] of the underlying [TextPainter].
  ///
  /// Valid only after [layout].
  Size get textSize {
    assert(!debugNeedsLayout);
    return _textPainter.size;
  }

787 788 789 790 791 792 793 794 795 796 797
  /// Collected during [describeSemanticsConfiguration], used by
  /// [assembleSemanticsNode] and [_combineSemanticsInfo].
  List<InlineSpanSemanticsInformation> _semanticsInfo;

  /// Combines _semanticsInfo entries where permissible, determined by
  /// [InlineSpanSemanticsInformation.requiresOwnNode].
  List<InlineSpanSemanticsInformation> _combineSemanticsInfo() {
    assert(_semanticsInfo != null);
    final List<InlineSpanSemanticsInformation> combined = <InlineSpanSemanticsInformation>[];
    String workingText = '';
    String workingLabel;
798
    for (final InlineSpanSemanticsInformation info in _semanticsInfo) {
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
      if (info.requiresOwnNode) {
        if (workingText != null) {
          combined.add(InlineSpanSemanticsInformation(
            workingText,
            semanticsLabel: workingLabel ?? workingText,
          ));
          workingText = '';
          workingLabel = null;
        }
        combined.add(info);
      } else {
        workingText += info.text;
        workingLabel ??= '';
        if (info.semanticsLabel != null) {
          workingLabel += info.semanticsLabel;
        } else {
          workingLabel += info.text;
        }
      }
    }
    if (workingText != null) {
      combined.add(InlineSpanSemanticsInformation(
        workingText,
        semanticsLabel: workingLabel,
      ));
    } else {
      assert(workingLabel != null);
    }
    return combined;
  }
829

830
  @override
831 832
  void describeSemanticsConfiguration(SemanticsConfiguration config) {
    super.describeSemanticsConfiguration(config);
833 834 835
    _semanticsInfo = text.getSemanticsInformation();

    if (_semanticsInfo.any((InlineSpanSemanticsInformation info) => info.recognizer != null)) {
836 837 838
      config.explicitChildNodes = true;
      config.isSemanticBoundary = true;
    } else {
839
      final StringBuffer buffer = StringBuffer();
840
      for (final InlineSpanSemanticsInformation info in _semanticsInfo) {
841 842 843
        buffer.write(info.semanticsLabel ?? info.text);
      }
      config.label = buffer.toString();
844 845 846 847
      config.textDirection = textDirection;
    }
  }

848 849 850 851 852 853
  // Caches [SemanticsNode]s created during [assembleSemanticsNode] so they
  // can be re-used when [assembleSemanticsNode] is called again. This ensures
  // stable ids for the [SemanticsNode]s of [TextSpan]s across
  // [assembleSemanticsNode] invocations.
  Queue<SemanticsNode> _cachedChildNodes;

854 855
  @override
  void assembleSemanticsNode(SemanticsNode node, SemanticsConfiguration config, Iterable<SemanticsNode> children) {
856
    assert(_semanticsInfo != null && _semanticsInfo.isNotEmpty);
857 858 859
    final List<SemanticsNode> newChildren = <SemanticsNode>[];
    TextDirection currentDirection = textDirection;
    Rect currentRect;
860 861 862 863
    double ordinal = 0.0;
    int start = 0;
    int placeholderIndex = 0;
    RenderBox child = firstChild;
864
    final Queue<SemanticsNode> newChildCache = Queue<SemanticsNode>();
865
    for (final InlineSpanSemanticsInformation info in _combineSemanticsInfo()) {
866
      final TextDirection initialDirection = currentDirection;
867 868 869 870
      final TextSelection selection = TextSelection(
        baseOffset: start,
        extentOffset: start + info.text.length,
      );
871
      final List<ui.TextBox> rects = getBoxesForSelection(selection);
872
      if (rects.isEmpty) {
873
        continue;
874 875 876
      }
      Rect rect = rects.first.toRect();
      currentDirection = rects.first.direction;
877
      for (final ui.TextBox textBox in rects.skip(1)) {
878 879 880
        rect = rect.expandToInclude(textBox.toRect());
        currentDirection = textBox.direction;
      }
881 882 883 884 885 886 887 888
      // Any of the text boxes may have had infinite dimensions.
      // We shouldn't pass infinite dimensions up to the bridges.
      rect = Rect.fromLTWH(
        math.max(0.0, rect.left),
        math.max(0.0, rect.top),
        math.min(rect.width, constraints.maxWidth),
        math.min(rect.height, constraints.maxHeight),
      );
889 890
      // round the current rectangle to make this API testable and add some
      // padding so that the accessibility rects do not overlap with the text.
891
      currentRect = Rect.fromLTRB(
892 893 894 895 896 897
        rect.left.floorToDouble() - 4.0,
        rect.top.floorToDouble() - 4.0,
        rect.right.ceilToDouble() + 4.0,
        rect.bottom.ceilToDouble() + 4.0,
      );

898 899
      if (info.isPlaceholder) {
        final SemanticsNode childNode = children.elementAt(placeholderIndex++);
900
        final TextParentData parentData = child.parentData as TextParentData;
901 902 903 904 905 906
        childNode.rect = Rect.fromLTWH(
          childNode.rect.left,
          childNode.rect.top,
          childNode.rect.width * parentData.scale,
          childNode.rect.height * parentData.scale,
        );
907
        newChildren.add(childNode);
908
        child = childAfter(child);
909 910 911 912 913
      } else {
        final SemanticsConfiguration configuration = SemanticsConfiguration()
          ..sortKey = OrdinalSortKey(ordinal++)
          ..textDirection = initialDirection
          ..label = info.semanticsLabel ?? info.text;
914 915 916
        final GestureRecognizer recognizer = info.recognizer;
        if (recognizer != null) {
          if (recognizer is TapGestureRecognizer) {
917
            configuration.onTap = recognizer.onTap;
918
            configuration.isLink = true;
919
          } else if (recognizer is LongPressGestureRecognizer) {
920 921 922 923 924
            configuration.onLongPress = recognizer.onLongPress;
          } else {
            assert(false);
          }
        }
925 926 927 928 929 930 931 932
        final SemanticsNode newChild = (_cachedChildNodes?.isNotEmpty == true)
            ? _cachedChildNodes.removeFirst()
            : SemanticsNode();
        newChild
          ..updateWith(config: configuration)
          ..rect = currentRect;
        newChildCache.addLast(newChild);
        newChildren.add(newChild);
933
      }
934
      start += info.text.length;
935
    }
936
    _cachedChildNodes = newChildCache;
937
    node.updateWith(config: config, childrenInInversePaintOrder: newChildren);
Hixie's avatar
Hixie committed
938
  }
939

940 941 942 943 944 945
  @override
  void clearSemantics() {
    super.clearSemantics();
    _cachedChildNodes = null;
  }

946
  @override
947
  List<DiagnosticsNode> debugDescribeChildren() {
948 949 950 951 952 953
    return <DiagnosticsNode>[
      text.toDiagnosticsNode(
        name: 'text',
        style: DiagnosticsTreeStyle.transition,
      )
    ];
954
  }
Ian Hickson's avatar
Ian Hickson committed
955 956

  @override
957 958
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
959 960
    properties.add(EnumProperty<TextAlign>('textAlign', textAlign));
    properties.add(EnumProperty<TextDirection>('textDirection', textDirection));
961 962 963 964 965 966 967 968 969
    properties.add(
      FlagProperty(
        'softWrap',
        value: softWrap,
        ifTrue: 'wrapping at box width',
        ifFalse: 'no wrapping except at line break characters',
        showName: true,
      )
    );
970
    properties.add(EnumProperty<TextOverflow>('overflow', overflow));
971 972 973 974 975 976 977 978 979 980 981 982 983 984
    properties.add(
      DoubleProperty(
        'textScaleFactor',
        textScaleFactor,
        defaultValue: 1.0,
      )
    );
    properties.add(
      DiagnosticsProperty<Locale>(
        'locale',
        locale,
        defaultValue: null,
      )
    );
985
    properties.add(IntProperty('maxLines', maxLines, ifNull: 'unlimited'));
Ian Hickson's avatar
Ian Hickson committed
986
  }
987
}