edge_insets.dart 29.3 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
import 'dart:ui' as ui show lerpDouble, WindowPadding;
7

8 9
import 'package:flutter/foundation.dart';

10
import 'basic_types.dart';
11

12 13 14 15
/// Base class for [EdgeInsets] that allows for text-direction aware
/// resolution.
///
/// A property or argument of this type accepts classes created either with [new
16 17
/// EdgeInsets.fromLTRB] and its variants, or [new
/// EdgeInsetsDirectional.fromSTEB] and its variants.
18
///
19
/// To convert an [EdgeInsetsGeometry] object of indeterminate type into a
20 21 22 23 24
/// [EdgeInsets] object, call the [resolve] method.
///
/// See also:
///
///  * [Padding], a widget that describes margins using [EdgeInsetsGeometry].
25
@immutable
26 27 28 29 30 31 32 33 34 35 36 37
abstract class EdgeInsetsGeometry {
  /// Abstract const constructor. This constructor enables subclasses to provide
  /// const constructors so that they can be used in const expressions.
  const EdgeInsetsGeometry();

  double get _bottom;
  double get _end;
  double get _left;
  double get _right;
  double get _start;
  double get _top;

38 39 40 41 42 43 44 45 46 47 48 49
  /// An [EdgeInsetsGeometry] with infinite offsets in each direction.
  ///
  /// Can be used as an infinite upper bound for [clamp].
  static const EdgeInsetsGeometry infinity = _MixedEdgeInsets.fromLRSETB(
    double.infinity,
    double.infinity,
    double.infinity,
    double.infinity,
    double.infinity,
    double.infinity,
  );

50 51 52 53 54 55 56 57 58 59
  /// Whether every dimension is non-negative.
  bool get isNonNegative {
    return _left >= 0.0
        && _right >= 0.0
        && _start >= 0.0
        && _end >= 0.0
        && _top >= 0.0
        && _bottom >= 0.0;
  }

60
  /// The total offset in the horizontal direction.
61
  double get horizontal => _left + _right + _start + _end;
62

63
  /// The total offset in the vertical direction.
64 65 66 67 68 69 70 71 72 73 74 75 76 77
  double get vertical => _top + _bottom;

  /// The total offset in the given direction.
  double along(Axis axis) {
    assert(axis != null);
    switch (axis) {
      case Axis.horizontal:
        return horizontal;
      case Axis.vertical:
        return vertical;
    }
  }

  /// The size that this [EdgeInsets] would occupy with an empty interior.
78
  Size get collapsedSize => Size(horizontal, vertical);
79 80

  /// An [EdgeInsetsGeometry] with top and bottom, left and right, and start and end flipped.
81
  EdgeInsetsGeometry get flipped => _MixedEdgeInsets.fromLRSETB(_right, _left, _end, _start, _bottom, _top);
82 83 84 85 86 87 88 89

  /// Returns a new size that is bigger than the given size by the amount of
  /// inset in the horizontal and vertical directions.
  ///
  /// See also:
  ///
  ///  * [EdgeInsets.inflateRect], to inflate a [Rect] rather than a [Size] (for
  ///    [EdgeInsetsDirectional], requires first calling [resolve] to establish
90
  ///    how the start and end map to the left or right).
91 92
  ///  * [deflateSize], to deflate a [Size] rather than inflating it.
  Size inflateSize(Size size) {
93
    return Size(size.width + horizontal, size.height + vertical);
94 95 96 97 98 99 100 101 102 103 104 105
  }

  /// Returns a new size that is smaller than the given size by the amount of
  /// inset in the horizontal and vertical directions.
  ///
  /// If the argument is smaller than [collapsedSize], then the resulting size
  /// will have negative dimensions.
  ///
  /// See also:
  ///
  ///  * [EdgeInsets.deflateRect], to deflate a [Rect] rather than a [Size]. (for
  ///    [EdgeInsetsDirectional], requires first calling [resolve] to establish
106
  ///    how the start and end map to the left or right).
107 108
  ///  * [inflateSize], to inflate a [Size] rather than deflating it.
  Size deflateSize(Size size) {
109
    return Size(size.width - horizontal, size.height - vertical);
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
  }

  /// Returns the difference between two [EdgeInsetsGeometry] objects.
  ///
  /// If you know you are applying this to two [EdgeInsets] or two
  /// [EdgeInsetsDirectional] objects, consider using the binary infix `-`
  /// operator instead, which always returns an object of the same type as the
  /// operands, and is typed accordingly.
  ///
  /// If [subtract] is applied to two objects of the same type ([EdgeInsets] or
  /// [EdgeInsetsDirectional]), an object of that type will be returned (though
  /// this is not reflected in the type system). Otherwise, an object
  /// representing a combination of both is returned. That object can be turned
  /// into a concrete [EdgeInsets] using [resolve].
  ///
  /// This method returns the same result as [add] applied to the result of
  /// negating the argument (using the prefix unary `-` operator or multiplying
  /// the argument by -1.0 using the `*` operator).
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
129
    return _MixedEdgeInsets.fromLRSETB(
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
      _left - other._left,
      _right - other._right,
      _start - other._start,
      _end - other._end,
      _top - other._top,
      _bottom - other._bottom,
    );
  }

  /// Returns the sum of two [EdgeInsetsGeometry] objects.
  ///
  /// If you know you are adding two [EdgeInsets] or two [EdgeInsetsDirectional]
  /// objects, consider using the `+` operator instead, which always returns an
  /// object of the same type as the operands, and is typed accordingly.
  ///
  /// If [add] is applied to two objects of the same type ([EdgeInsets] or
  /// [EdgeInsetsDirectional]), an object of that type will be returned (though
  /// this is not reflected in the type system). Otherwise, an object
  /// representing a combination of both is returned. That object can be turned
  /// into a concrete [EdgeInsets] using [resolve].
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
151
    return _MixedEdgeInsets.fromLRSETB(
152 153 154 155 156 157 158 159 160
      _left + other._left,
      _right + other._right,
      _start + other._start,
      _end + other._end,
      _top + other._top,
      _bottom + other._bottom,
    );
  }

161 162 163 164
  /// Returns the a new [EdgeInsetsGeometry] object with all values greater than
  /// or equal to `min`, and less than or equal to `max`.
  EdgeInsetsGeometry clamp(EdgeInsetsGeometry min, EdgeInsetsGeometry max) {
    return _MixedEdgeInsets.fromLRSETB(
165 166 167 168 169 170
      _left.clamp(min._left, max._left),
      _right.clamp(min._right, max._right),
      _start.clamp(min._start, max._start),
      _end.clamp(min._end, max._end),
      _top.clamp(min._top, max._top),
      _bottom.clamp(min._bottom, max._bottom),
171 172 173
    );
  }

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
  /// Returns the [EdgeInsetsGeometry] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  ///
  /// This operator returns an object of the same type as the operand.
  EdgeInsetsGeometry operator -();

  /// Scales the [EdgeInsetsGeometry] object in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
  EdgeInsetsGeometry operator *(double other);

  /// Divides the [EdgeInsetsGeometry] object in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
  EdgeInsetsGeometry operator /(double other);

  /// Integer divides the [EdgeInsetsGeometry] object in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
194 195 196
  ///
  /// This operator may have unexpected results when applied to a mixture of
  /// [EdgeInsets] and [EdgeInsetsDirectional] objects.
197 198 199 200 201
  EdgeInsetsGeometry operator ~/(double other);

  /// Computes the remainder in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
202 203 204
  ///
  /// This operator may have unexpected results when applied to a mixture of
  /// [EdgeInsets] and [EdgeInsetsDirectional] objects.
205 206 207 208 209 210 211 212 213 214 215 216
  EdgeInsetsGeometry operator %(double other);

  /// Linearly interpolate between two [EdgeInsetsGeometry] objects.
  ///
  /// If either is null, this function interpolates from [EdgeInsets.zero], and
  /// the result is an object of the same type as the non-null argument.
  ///
  /// If [lerp] is applied to two objects of the same type ([EdgeInsets] or
  /// [EdgeInsetsDirectional]), an object of that type will be returned (though
  /// this is not reflected in the type system). Otherwise, an object
  /// representing a combination of both is returned. That object can be turned
  /// into a concrete [EdgeInsets] using [resolve].
217
  ///
218
  /// {@macro dart.ui.shadow.lerp}
219
  static EdgeInsetsGeometry? lerp(EdgeInsetsGeometry? a, EdgeInsetsGeometry? b, double t) {
220
    assert(t != null);
221 222 223
    if (a == null && b == null)
      return null;
    if (a == null)
224
      return b! * t;
225 226 227 228 229 230
    if (b == null)
      return a * (1.0 - t);
    if (a is EdgeInsets && b is EdgeInsets)
      return EdgeInsets.lerp(a, b, t);
    if (a is EdgeInsetsDirectional && b is EdgeInsetsDirectional)
      return EdgeInsetsDirectional.lerp(a, b, t);
231
    return _MixedEdgeInsets.fromLRSETB(
232 233 234 235 236 237
      ui.lerpDouble(a._left, b._left, t)!,
      ui.lerpDouble(a._right, b._right, t)!,
      ui.lerpDouble(a._start, b._start, t)!,
      ui.lerpDouble(a._end, b._end, t)!,
      ui.lerpDouble(a._top, b._top, t)!,
      ui.lerpDouble(a._bottom, b._bottom, t)!,
238 239 240
    );
  }

241
  /// Convert this instance into an [EdgeInsets], which uses literal coordinates
242 243 244 245 246 247 248 249
  /// (i.e. the `left` coordinate being explicitly a distance from the left, and
  /// the `right` coordinate being explicitly a distance from the right).
  ///
  /// See also:
  ///
  ///  * [EdgeInsets], for which this is a no-op (returns itself).
  ///  * [EdgeInsetsDirectional], which flips the horizontal direction
  ///    based on the `direction` argument.
250
  EdgeInsets resolve(TextDirection? direction);
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 280 281

  @override
  String toString() {
    if (_start == 0.0 && _end == 0.0) {
      if (_left == 0.0 && _right == 0.0 && _top == 0.0 && _bottom == 0.0)
        return 'EdgeInsets.zero';
      if (_left == _right && _right == _top && _top == _bottom)
        return 'EdgeInsets.all(${_left.toStringAsFixed(1)})';
      return 'EdgeInsets(${_left.toStringAsFixed(1)}, '
                        '${_top.toStringAsFixed(1)}, '
                        '${_right.toStringAsFixed(1)}, '
                        '${_bottom.toStringAsFixed(1)})';
    }
    if (_left == 0.0 && _right == 0.0) {
      return 'EdgeInsetsDirectional(${_start.toStringAsFixed(1)}, '
                                   '${_top.toStringAsFixed(1)}, '
                                   '${_end.toStringAsFixed(1)}, '
                                   '${_bottom.toStringAsFixed(1)})';
    }
    return 'EdgeInsets(${_left.toStringAsFixed(1)}, '
                      '${_top.toStringAsFixed(1)}, '
                      '${_right.toStringAsFixed(1)}, '
                      '${_bottom.toStringAsFixed(1)})'
           ' + '
           'EdgeInsetsDirectional(${_start.toStringAsFixed(1)}, '
                                 '0.0, '
                                 '${_end.toStringAsFixed(1)}, '
                                 '0.0)';
  }

  @override
282
  bool operator ==(Object other) {
283 284 285 286 287 288 289
    return other is EdgeInsetsGeometry
        && other._left == _left
        && other._right == _right
        && other._start == _start
        && other._end == _end
        && other._top == _top
        && other._bottom == _bottom;
290 291 292 293
  }

  @override
  int get hashCode => hashValues(_left, _right, _start, _end, _top, _bottom);
294 295
}

296 297 298 299
/// An immutable set of offsets in each of the four cardinal directions.
///
/// Typically used for an offset from each of the four sides of a box. For
/// example, the padding inside a box can be represented using this class.
300
///
301 302 303 304 305 306 307
/// The [EdgeInsets] class specifies offsets in terms of visual edges, left,
/// top, right, and bottom. These values are not affected by the
/// [TextDirection]. To support both left-to-right and right-to-left layouts,
/// consider using [EdgeInsetsDirectional], which is expressed in terms of
/// _start_, top, _end_, and bottom, where start and end are resolved in terms
/// of a [TextDirection] (typically obtained from the ambient [Directionality]).
///
308
/// {@tool snippet}
309 310 311
///
/// Here are some examples of how to create [EdgeInsets] instances:
///
312 313
/// Typical eight-pixel margin on all sides:
///
314 315
/// ```dart
/// const EdgeInsets.all(8.0)
316
/// ```
317
/// {@end-tool}
318
/// {@tool snippet}
319 320
///
/// Eight pixel margin above and below, no horizontal margins:
321
///
322
/// ```dart
323
/// const EdgeInsets.symmetric(vertical: 8.0)
324
/// ```
325
/// {@end-tool}
326
/// {@tool snippet}
327
///
328 329 330
/// Left margin indent of 40 pixels:
///
/// ```dart
331 332
/// const EdgeInsets.only(left: 40.0)
/// ```
333
/// {@end-tool}
334 335 336
///
/// See also:
///
337 338 339 340 341
///  * [Padding], a widget that accepts [EdgeInsets] to describe its margins.
///  * [EdgeInsetsDirectional], which (for properties and arguments that accept
///    the type [EdgeInsetsGeometry]) allows the horizontal insets to be
///    specified in a [TextDirection]-aware manner.
class EdgeInsets extends EdgeInsetsGeometry {
342
  /// Creates insets from offsets from the left, top, right, and bottom.
343 344
  const EdgeInsets.fromLTRB(this.left, this.top, this.right, this.bottom);

345
  /// Creates insets where all the offsets are `value`.
346
  ///
347
  /// {@tool snippet}
348
  ///
349 350
  /// Typical eight-pixel margin on all sides:
  ///
351 352 353
  /// ```dart
  /// const EdgeInsets.all(8.0)
  /// ```
354
  /// {@end-tool}
355
  const EdgeInsets.all(double value)
356 357 358 359
    : left = value,
      top = value,
      right = value,
      bottom = value;
360

361
  /// Creates insets with only the given values non-zero.
362
  ///
363
  /// {@tool snippet}
364
  ///
365 366
  /// Left margin indent of 40 pixels:
  ///
367 368 369
  /// ```dart
  /// const EdgeInsets.only(left: 40.0)
  /// ```
370
  /// {@end-tool}
371
  const EdgeInsets.only({
372 373 374
    this.left = 0.0,
    this.top = 0.0,
    this.right = 0.0,
375
    this.bottom = 0.0,
376
  });
377

378
  /// Creates insets with symmetrical vertical and horizontal offsets.
379
  ///
380
  /// {@tool snippet}
381
  ///
382 383
  /// Eight pixel margin above and below, no horizontal margins:
  ///
384 385 386
  /// ```dart
  /// const EdgeInsets.symmetric(vertical: 8.0)
  /// ```
387
  /// {@end-tool}
388 389 390 391 392 393 394
  const EdgeInsets.symmetric({
    double vertical = 0.0,
    double horizontal = 0.0,
  }) : left = horizontal,
       top = vertical,
       right = horizontal,
       bottom = vertical;
395

396
  /// Creates insets that match the given window padding.
397
  ///
398 399 400
  /// If you need the current system padding or view insets in the context of a
  /// widget, consider using [MediaQuery.of] to obtain these values rather than
  /// using the value from [dart:ui.window], so that you get notified of
401
  /// changes.
402 403 404 405 406
  EdgeInsets.fromWindowPadding(ui.WindowPadding padding, double devicePixelRatio)
    : left = padding.left / devicePixelRatio,
      top = padding.top / devicePixelRatio,
      right = padding.right / devicePixelRatio,
      bottom = padding.bottom / devicePixelRatio;
407

408
  /// An [EdgeInsets] with zero offsets in each direction.
409
  static const EdgeInsets zero = EdgeInsets.only();
410

411 412
  /// The offset from the left.
  final double left;
413

414 415 416
  @override
  double get _left => left;

417 418 419
  /// The offset from the top.
  final double top;

420 421 422
  @override
  double get _top => top;

423 424 425
  /// The offset from the right.
  final double right;

426 427 428
  @override
  double get _right => right;

429 430 431
  /// The offset from the bottom.
  final double bottom;

432 433 434 435 436 437 438 439 440
  @override
  double get _bottom => bottom;

  @override
  double get _start => 0.0;

  @override
  double get _end => 0.0;

441 442
  /// An Offset describing the vector from the top left of a rectangle to the
  /// top left of that rectangle inset by this object.
443
  Offset get topLeft => Offset(left, top);
444 445 446

  /// An Offset describing the vector from the top right of a rectangle to the
  /// top right of that rectangle inset by this object.
447
  Offset get topRight => Offset(-right, top);
448 449 450

  /// An Offset describing the vector from the bottom left of a rectangle to the
  /// bottom left of that rectangle inset by this object.
451
  Offset get bottomLeft => Offset(left, -bottom);
452 453 454

  /// An Offset describing the vector from the bottom right of a rectangle to the
  /// bottom right of that rectangle inset by this object.
455
  Offset get bottomRight => Offset(-right, -bottom);
456

457 458
  /// An [EdgeInsets] with top and bottom as well as left and right flipped.
  @override
459
  EdgeInsets get flipped => EdgeInsets.fromLTRB(right, bottom, left, top);
460

461 462 463 464 465
  /// Returns a new rect that is bigger than the given rect in each direction by
  /// the amount of inset in each direction. Specifically, the left edge of the
  /// rect is moved left by [left], the top edge of the rect is moved up by
  /// [top], the right edge of the rect is moved right by [right], and the
  /// bottom edge of the rect is moved down by [bottom].
466 467 468 469 470
  ///
  /// See also:
  ///
  ///  * [inflateSize], to inflate a [Size] rather than a [Rect].
  ///  * [deflateRect], to deflate a [Rect] rather than inflating it.
471
  Rect inflateRect(Rect rect) {
472
    return Rect.fromLTRB(rect.left - left, rect.top - top, rect.right + right, rect.bottom + bottom);
473 474
  }

475 476 477 478 479 480 481 482 483 484 485 486 487 488
  /// Returns a new rect that is smaller than the given rect in each direction by
  /// the amount of inset in each direction. Specifically, the left edge of the
  /// rect is moved right by [left], the top edge of the rect is moved down by
  /// [top], the right edge of the rect is moved left by [right], and the
  /// bottom edge of the rect is moved up by [bottom].
  ///
  /// If the argument's [Rect.size] is smaller than [collapsedSize], then the
  /// resulting rectangle will have negative dimensions.
  ///
  /// See also:
  ///
  ///  * [deflateSize], to deflate a [Size] rather than a [Rect].
  ///  * [inflateRect], to inflate a [Rect] rather than deflating it.
  Rect deflateRect(Rect rect) {
489
    return Rect.fromLTRB(rect.left + left, rect.top + top, rect.right - right, rect.bottom - bottom);
490 491
  }

492 493 494 495 496
  @override
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
    if (other is EdgeInsets)
      return this - other;
    return super.subtract(other);
497 498
  }

499 500 501 502 503
  @override
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
    if (other is EdgeInsets)
      return this + other;
    return super.add(other);
504 505
  }

506 507 508
  @override
  EdgeInsetsGeometry clamp(EdgeInsetsGeometry min, EdgeInsetsGeometry max) {
    return EdgeInsets.fromLTRB(
509 510 511 512
      _left.clamp(min._left, max._left),
      _top.clamp(min._top, max._top),
      _right.clamp(min._right, max._right),
      _bottom.clamp(min._bottom, max._bottom),
513 514 515
    );
  }

516
  /// Returns the difference between two [EdgeInsets].
517
  EdgeInsets operator -(EdgeInsets other) {
518
    return EdgeInsets.fromLTRB(
519
      left - other.left,
520 521
      top - other.top,
      right - other.right,
522
      bottom - other.bottom,
523 524 525
    );
  }

526
  /// Returns the sum of two [EdgeInsets].
527
  EdgeInsets operator +(EdgeInsets other) {
528
    return EdgeInsets.fromLTRB(
529
      left + other.left,
530 531
      top + other.top,
      right + other.right,
532
      bottom + other.bottom,
533 534 535
    );
  }

536 537 538 539 540
  /// Returns the [EdgeInsets] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  @override
  EdgeInsets operator -() {
541
    return EdgeInsets.fromLTRB(
542 543 544 545 546 547 548 549 550
      -left,
      -top,
      -right,
      -bottom,
    );
  }

  /// Scales the [EdgeInsets] in each dimension by the given factor.
  @override
551
  EdgeInsets operator *(double other) {
552
    return EdgeInsets.fromLTRB(
553
      left * other,
554 555
      top * other,
      right * other,
556
      bottom * other,
557 558 559
    );
  }

560 561
  /// Divides the [EdgeInsets] in each dimension by the given factor.
  @override
562
  EdgeInsets operator /(double other) {
563
    return EdgeInsets.fromLTRB(
564
      left / other,
565 566
      top / other,
      right / other,
567
      bottom / other,
568 569 570
    );
  }

571 572
  /// Integer divides the [EdgeInsets] in each dimension by the given factor.
  @override
573
  EdgeInsets operator ~/(double other) {
574
    return EdgeInsets.fromLTRB(
575
      (left ~/ other).toDouble(),
576 577
      (top ~/ other).toDouble(),
      (right ~/ other).toDouble(),
578
      (bottom ~/ other).toDouble(),
579 580 581
    );
  }

582
  /// Computes the remainder in each dimension by the given factor.
583
  @override
584
  EdgeInsets operator %(double other) {
585
    return EdgeInsets.fromLTRB(
586
      left % other,
587 588
      top % other,
      right % other,
589
      bottom % other,
590 591 592
    );
  }

593
  /// Linearly interpolate between two [EdgeInsets].
594
  ///
595
  /// If either is null, this function interpolates from [EdgeInsets.zero].
596
  ///
597
  /// {@macro dart.ui.shadow.lerp}
598
  static EdgeInsets? lerp(EdgeInsets? a, EdgeInsets? b, double t) {
599
    assert(t != null);
600 601 602
    if (a == null && b == null)
      return null;
    if (a == null)
603
      return b! * t;
604 605
    if (b == null)
      return a * (1.0 - t);
606
    return EdgeInsets.fromLTRB(
607 608 609 610
      ui.lerpDouble(a.left, b.left, t)!,
      ui.lerpDouble(a.top, b.top, t)!,
      ui.lerpDouble(a.right, b.right, t)!,
      ui.lerpDouble(a.bottom, b.bottom, t)!,
611 612 613
    );
  }

614
  @override
615
  EdgeInsets resolve(TextDirection? direction) => this;
616 617 618 619

  /// Creates a copy of this EdgeInsets but with the given fields replaced
  /// with the new values.
  EdgeInsets copyWith({
620 621 622 623
    double? left,
    double? top,
    double? right,
    double? bottom,
624
  }) {
625
    return EdgeInsets.only(
626 627 628 629 630 631
      left: left ?? this.left,
      top: top ?? this.top,
      right: right ?? this.right,
      bottom: bottom ?? this.bottom,
    );
  }
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
}

/// An immutable set of offsets in each of the four cardinal directions, but
/// whose horizontal components are dependent on the writing direction.
///
/// This can be used to indicate padding from the left in [TextDirection.ltr]
/// text and padding from the right in [TextDirection.rtl] text without having
/// to be aware of the current text direction.
///
/// See also:
///
///  * [EdgeInsets], a variant that uses physical labels (left and right instead
///    of start and end).
class EdgeInsetsDirectional extends EdgeInsetsGeometry {
  /// Creates insets from offsets from the start, top, end, and bottom.
  const EdgeInsetsDirectional.fromSTEB(this.start, this.top, this.end, this.bottom);

  /// Creates insets with only the given values non-zero.
  ///
651
  /// {@tool snippet}
652 653 654 655 656 657
  ///
  /// A margin indent of 40 pixels on the leading side:
  ///
  /// ```dart
  /// const EdgeInsetsDirectional.only(start: 40.0)
  /// ```
658
  /// {@end-tool}
659
  const EdgeInsetsDirectional.only({
660 661 662
    this.start = 0.0,
    this.top = 0.0,
    this.end = 0.0,
663
    this.bottom = 0.0,
664 665
  });

666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
  /// Creates insets where all the offsets are `value`.
  ///
  /// {@tool snippet}
  ///
  /// Typical eight-pixel margin on all sides:
  ///
  /// ```dart
  /// const EdgeInsetsDirectional.all(8.0)
  /// ```
  /// {@end-tool}
  const EdgeInsetsDirectional.all(double value)
    : start = value,
      top = value,
      end = value,
      bottom = value;

682 683 684 685
  /// An [EdgeInsetsDirectional] with zero offsets in each direction.
  ///
  /// Consider using [EdgeInsets.zero] instead, since that object has the same
  /// effect, but will be cheaper to [resolve].
686
  static const EdgeInsetsDirectional zero = EdgeInsetsDirectional.only();
687

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
  /// The offset from the start side, the side from which the user will start
  /// reading text.
  ///
  /// This value is normalized into an [EdgeInsets.left] or [EdgeInsets.right]
  /// value by the [resolve] method.
  final double start;

  @override
  double get _start => start;

  /// The offset from the top.
  ///
  /// This value is passed through to [EdgeInsets.top] unmodified by the
  /// [resolve] method.
  final double top;

  @override
  double get _top => top;

  /// The offset from the end side, the side on which the user ends reading
  /// text.
  ///
  /// This value is normalized into an [EdgeInsets.left] or [EdgeInsets.right]
  /// value by the [resolve] method.
  final double end;

  @override
  double get _end => end;

  /// The offset from the bottom.
  ///
  /// This value is passed through to [EdgeInsets.bottom] unmodified by the
  /// [resolve] method.
  final double bottom;

  @override
  double get _bottom => bottom;

  @override
  double get _left => 0.0;

  @override
  double get _right => 0.0;

  @override
  bool get isNonNegative => start >= 0.0 && top >= 0.0 && end >= 0.0 && bottom >= 0.0;

  /// An [EdgeInsetsDirectional] with [top] and [bottom] as well as [start] and [end] flipped.
  @override
737
  EdgeInsetsDirectional get flipped => EdgeInsetsDirectional.fromSTEB(end, bottom, start, top);
738 739 740 741 742 743

  @override
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
    if (other is EdgeInsetsDirectional)
      return this - other;
    return super.subtract(other);
744 745
  }

746
  @override
747 748 749 750 751 752 753 754
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
    if (other is EdgeInsetsDirectional)
      return this + other;
    return super.add(other);
  }

  /// Returns the difference between two [EdgeInsetsDirectional] objects.
  EdgeInsetsDirectional operator -(EdgeInsetsDirectional other) {
755
    return EdgeInsetsDirectional.fromSTEB(
756 757 758 759 760 761 762 763 764
      start - other.start,
      top - other.top,
      end - other.end,
      bottom - other.bottom,
    );
  }

  /// Returns the sum of two [EdgeInsetsDirectional] objects.
  EdgeInsetsDirectional operator +(EdgeInsetsDirectional other) {
765
    return EdgeInsetsDirectional.fromSTEB(
766 767 768 769 770 771
      start + other.start,
      top + other.top,
      end + other.end,
      bottom + other.bottom,
    );
  }
772

773 774 775 776 777
  /// Returns the [EdgeInsetsDirectional] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  @override
  EdgeInsetsDirectional operator -() {
778
    return EdgeInsetsDirectional.fromSTEB(
779 780 781 782 783 784 785 786
      -start,
      -top,
      -end,
      -bottom,
    );
  }

  /// Scales the [EdgeInsetsDirectional] object in each dimension by the given factor.
787
  @override
788
  EdgeInsetsDirectional operator *(double other) {
789
    return EdgeInsetsDirectional.fromSTEB(
790 791 792 793 794 795 796 797 798 799
      start * other,
      top * other,
      end * other,
      bottom * other,
    );
  }

  /// Divides the [EdgeInsetsDirectional] object in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator /(double other) {
800
    return EdgeInsetsDirectional.fromSTEB(
801 802 803 804 805 806 807 808 809 810
      start / other,
      top / other,
      end / other,
      bottom / other,
    );
  }

  /// Integer divides the [EdgeInsetsDirectional] object in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator ~/(double other) {
811
    return EdgeInsetsDirectional.fromSTEB(
812 813 814 815 816 817 818 819 820 821
      (start ~/ other).toDouble(),
      (top ~/ other).toDouble(),
      (end ~/ other).toDouble(),
      (bottom ~/ other).toDouble(),
    );
  }

  /// Computes the remainder in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator %(double other) {
822
    return EdgeInsetsDirectional.fromSTEB(
823 824 825 826 827 828 829 830 831 832 833 834 835 836
      start % other,
      top % other,
      end % other,
      bottom % other,
    );
  }

  /// Linearly interpolate between two [EdgeInsetsDirectional].
  ///
  /// If either is null, this function interpolates from [EdgeInsetsDirectional.zero].
  ///
  /// To interpolate between two [EdgeInsetsGeometry] objects of arbitrary type
  /// (either [EdgeInsets] or [EdgeInsetsDirectional]), consider the
  /// [EdgeInsetsGeometry.lerp] static method.
837
  ///
838
  /// {@macro dart.ui.shadow.lerp}
839
  static EdgeInsetsDirectional? lerp(EdgeInsetsDirectional? a, EdgeInsetsDirectional? b, double t) {
840
    assert(t != null);
841 842 843
    if (a == null && b == null)
      return null;
    if (a == null)
844
      return b! * t;
845 846
    if (b == null)
      return a * (1.0 - t);
847
    return EdgeInsetsDirectional.fromSTEB(
848 849 850 851
      ui.lerpDouble(a.start, b.start, t)!,
      ui.lerpDouble(a.top, b.top, t)!,
      ui.lerpDouble(a.end, b.end, t)!,
      ui.lerpDouble(a.bottom, b.bottom, t)!,
852 853 854 855
    );
  }

  @override
856
  EdgeInsets resolve(TextDirection? direction) {
857
    assert(direction != null);
858
    switch (direction!) {
859
      case TextDirection.rtl:
860
        return EdgeInsets.fromLTRB(end, top, start, bottom);
861
      case TextDirection.ltr:
862
        return EdgeInsets.fromLTRB(start, top, end, bottom);
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
    }
  }
}

class _MixedEdgeInsets extends EdgeInsetsGeometry {
  const _MixedEdgeInsets.fromLRSETB(this._left, this._right, this._start, this._end, this._top, this._bottom);

  @override
  final double _left;

  @override
  final double _right;

  @override
  final double _start;

  @override
  final double _end;

  @override
  final double _top;

  @override
  final double _bottom;

  @override
  bool get isNonNegative {
    return _left >= 0.0
        && _right >= 0.0
        && _start >= 0.0
        && _end >= 0.0
        && _top >= 0.0
        && _bottom >= 0.0;
  }

  @override
  _MixedEdgeInsets operator -() {
900
    return _MixedEdgeInsets.fromLRSETB(
901 902 903 904 905 906 907 908 909 910 911
      -_left,
      -_right,
      -_start,
      -_end,
      -_top,
      -_bottom,
    );
  }

  @override
  _MixedEdgeInsets operator *(double other) {
912
    return _MixedEdgeInsets.fromLRSETB(
913 914 915 916 917 918 919 920 921 922 923
      _left * other,
      _right * other,
      _start * other,
      _end * other,
      _top * other,
      _bottom * other,
    );
  }

  @override
  _MixedEdgeInsets operator /(double other) {
924
    return _MixedEdgeInsets.fromLRSETB(
925 926 927 928 929 930 931 932 933 934 935
      _left / other,
      _right / other,
      _start / other,
      _end / other,
      _top / other,
      _bottom / other,
    );
  }

  @override
  _MixedEdgeInsets operator ~/(double other) {
936
    return _MixedEdgeInsets.fromLRSETB(
937 938 939 940 941 942 943 944 945 946 947
      (_left ~/ other).toDouble(),
      (_right ~/ other).toDouble(),
      (_start ~/ other).toDouble(),
      (_end ~/ other).toDouble(),
      (_top ~/ other).toDouble(),
      (_bottom ~/ other).toDouble(),
    );
  }

  @override
  _MixedEdgeInsets operator %(double other) {
948
    return _MixedEdgeInsets.fromLRSETB(
949 950 951 952 953 954 955 956 957 958
      _left % other,
      _right % other,
      _start % other,
      _end % other,
      _top % other,
      _bottom % other,
    );
  }

  @override
959
  EdgeInsets resolve(TextDirection? direction) {
960
    assert(direction != null);
961
    switch (direction!) {
962
      case TextDirection.rtl:
963
        return EdgeInsets.fromLTRB(_end + _left, _top, _start + _right, _bottom);
964
      case TextDirection.ltr:
965
        return EdgeInsets.fromLTRB(_start + _left, _top, _end + _right, _bottom);
966 967
    }
  }
968
}