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

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

9
import 'basic_types.dart';
10

11 12 13
/// Base class for [EdgeInsets] that allows for text-direction aware
/// resolution.
///
14 15
/// A property or argument of this type accepts classes created either with [
/// EdgeInsets.fromLTRB] and its variants, or [
16
/// EdgeInsetsDirectional.fromSTEB] and its variants.
17
///
18
/// To convert an [EdgeInsetsGeometry] object of indeterminate type into a
19 20 21 22 23
/// [EdgeInsets] object, call the [resolve] method.
///
/// See also:
///
///  * [Padding], a widget that describes margins using [EdgeInsetsGeometry].
24
@immutable
25 26 27 28 29 30 31 32 33 34 35 36
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;

37 38 39 40 41 42 43 44 45 46 47 48
  /// 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,
  );

49 50 51 52 53 54 55 56 57 58
  /// 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;
  }

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

62
  /// The total offset in the vertical direction.
63 64 65 66 67 68 69 70 71 72 73 74 75 76
  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.
77
  Size get collapsedSize => Size(horizontal, vertical);
78 79

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

  /// 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
89
  ///    how the start and end map to the left or right).
90 91
  ///  * [deflateSize], to deflate a [Size] rather than inflating it.
  Size inflateSize(Size size) {
92
    return Size(size.width + horizontal, size.height + vertical);
93 94 95 96 97 98 99 100 101 102 103 104
  }

  /// 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
105
  ///    how the start and end map to the left or right).
106 107
  ///  * [inflateSize], to inflate a [Size] rather than deflating it.
  Size deflateSize(Size size) {
108
    return Size(size.width - horizontal, size.height - vertical);
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
  }

  /// 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) {
128
    return _MixedEdgeInsets.fromLRSETB(
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
      _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) {
150
    return _MixedEdgeInsets.fromLRSETB(
151 152 153 154 155 156 157 158 159
      _left + other._left,
      _right + other._right,
      _start + other._start,
      _end + other._end,
      _top + other._top,
      _bottom + other._bottom,
    );
  }

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

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
  /// 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.
193 194 195
  ///
  /// This operator may have unexpected results when applied to a mixture of
  /// [EdgeInsets] and [EdgeInsetsDirectional] objects.
196 197 198 199 200
  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.
201 202 203
  ///
  /// This operator may have unexpected results when applied to a mixture of
  /// [EdgeInsets] and [EdgeInsetsDirectional] objects.
204 205 206 207 208 209 210 211 212 213 214 215
  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].
216
  ///
217
  /// {@macro dart.ui.shadow.lerp}
218
  static EdgeInsetsGeometry? lerp(EdgeInsetsGeometry? a, EdgeInsetsGeometry? b, double t) {
219
    assert(t != null);
220
    if (a == null && b == null) {
221
      return null;
222 223
    }
    if (a == null) {
224
      return b! * t;
225 226
    }
    if (b == null) {
227
      return a * (1.0 - t);
228 229
    }
    if (a is EdgeInsets && b is EdgeInsets) {
230
      return EdgeInsets.lerp(a, b, t);
231 232
    }
    if (a is EdgeInsetsDirectional && b is EdgeInsetsDirectional) {
233
      return EdgeInsetsDirectional.lerp(a, b, t);
234
    }
235
    return _MixedEdgeInsets.fromLRSETB(
236 237 238 239 240 241
      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)!,
242 243 244
    );
  }

245
  /// Convert this instance into an [EdgeInsets], which uses literal coordinates
246 247 248 249 250 251 252 253
  /// (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.
254
  EdgeInsets resolve(TextDirection? direction);
255 256 257 258

  @override
  String toString() {
    if (_start == 0.0 && _end == 0.0) {
259
      if (_left == 0.0 && _right == 0.0 && _top == 0.0 && _bottom == 0.0) {
260
        return 'EdgeInsets.zero';
261 262
      }
      if (_left == _right && _right == _top && _top == _bottom) {
263
        return 'EdgeInsets.all(${_left.toStringAsFixed(1)})';
264
      }
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
      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
288
  bool operator ==(Object other) {
289 290 291 292 293 294 295
    return other is EdgeInsetsGeometry
        && other._left == _left
        && other._right == _right
        && other._start == _start
        && other._end == _end
        && other._top == _top
        && other._bottom == _bottom;
296 297 298
  }

  @override
299
  int get hashCode => Object.hash(_left, _right, _start, _end, _top, _bottom);
300 301
}

302 303 304 305
/// 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.
306
///
307 308 309 310 311 312 313
/// 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]).
///
314
/// {@tool snippet}
315 316 317
///
/// Here are some examples of how to create [EdgeInsets] instances:
///
318 319
/// Typical eight-pixel margin on all sides:
///
320 321
/// ```dart
/// const EdgeInsets.all(8.0)
322
/// ```
323
/// {@end-tool}
324
/// {@tool snippet}
325 326
///
/// Eight pixel margin above and below, no horizontal margins:
327
///
328
/// ```dart
329
/// const EdgeInsets.symmetric(vertical: 8.0)
330
/// ```
331
/// {@end-tool}
332
/// {@tool snippet}
333
///
334 335 336
/// Left margin indent of 40 pixels:
///
/// ```dart
337 338
/// const EdgeInsets.only(left: 40.0)
/// ```
339
/// {@end-tool}
340 341 342
///
/// See also:
///
343 344 345 346 347
///  * [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 {
348
  /// Creates insets from offsets from the left, top, right, and bottom.
349 350
  const EdgeInsets.fromLTRB(this.left, this.top, this.right, this.bottom);

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

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

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

402
  /// Creates insets that match the given window padding.
403
  ///
404 405 406
  /// 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
407
  /// changes.
408 409 410 411 412
  EdgeInsets.fromWindowPadding(ui.WindowPadding padding, double devicePixelRatio)
    : left = padding.left / devicePixelRatio,
      top = padding.top / devicePixelRatio,
      right = padding.right / devicePixelRatio,
      bottom = padding.bottom / devicePixelRatio;
413

414
  /// An [EdgeInsets] with zero offsets in each direction.
415
  static const EdgeInsets zero = EdgeInsets.only();
416

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

420 421 422
  @override
  double get _left => left;

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

426 427 428
  @override
  double get _top => top;

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

432 433 434
  @override
  double get _right => right;

435 436 437
  /// The offset from the bottom.
  final double bottom;

438 439 440 441 442 443 444 445 446
  @override
  double get _bottom => bottom;

  @override
  double get _start => 0.0;

  @override
  double get _end => 0.0;

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

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

  /// An Offset describing the vector from the bottom left of a rectangle to the
  /// bottom left of that rectangle inset by this object.
457
  Offset get bottomLeft => Offset(left, -bottom);
458 459 460

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

463 464
  /// An [EdgeInsets] with top and bottom as well as left and right flipped.
  @override
465
  EdgeInsets get flipped => EdgeInsets.fromLTRB(right, bottom, left, top);
466

467 468 469 470 471
  /// 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].
472 473 474 475 476
  ///
  /// See also:
  ///
  ///  * [inflateSize], to inflate a [Size] rather than a [Rect].
  ///  * [deflateRect], to deflate a [Rect] rather than inflating it.
477
  Rect inflateRect(Rect rect) {
478
    return Rect.fromLTRB(rect.left - left, rect.top - top, rect.right + right, rect.bottom + bottom);
479 480
  }

481 482 483 484 485 486 487 488 489 490 491 492 493 494
  /// 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) {
495
    return Rect.fromLTRB(rect.left + left, rect.top + top, rect.right - right, rect.bottom - bottom);
496 497
  }

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

506 507
  @override
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
508
    if (other is EdgeInsets) {
509
      return this + other;
510
    }
511
    return super.add(other);
512 513
  }

514 515 516
  @override
  EdgeInsetsGeometry clamp(EdgeInsetsGeometry min, EdgeInsetsGeometry max) {
    return EdgeInsets.fromLTRB(
517 518 519 520
      clampDouble(_left, min._left, max._left),
      clampDouble(_top, min._top, max._top),
      clampDouble(_right, min._right, max._right),
      clampDouble(_bottom, min._bottom, max._bottom),
521 522 523
    );
  }

524
  /// Returns the difference between two [EdgeInsets].
525
  EdgeInsets operator -(EdgeInsets other) {
526
    return EdgeInsets.fromLTRB(
527
      left - other.left,
528 529
      top - other.top,
      right - other.right,
530
      bottom - other.bottom,
531 532 533
    );
  }

534
  /// Returns the sum of two [EdgeInsets].
535
  EdgeInsets operator +(EdgeInsets other) {
536
    return EdgeInsets.fromLTRB(
537
      left + other.left,
538 539
      top + other.top,
      right + other.right,
540
      bottom + other.bottom,
541 542 543
    );
  }

544 545 546 547 548
  /// Returns the [EdgeInsets] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  @override
  EdgeInsets operator -() {
549
    return EdgeInsets.fromLTRB(
550 551 552 553 554 555 556 557 558
      -left,
      -top,
      -right,
      -bottom,
    );
  }

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

568 569
  /// Divides the [EdgeInsets] in each dimension by the given factor.
  @override
570
  EdgeInsets operator /(double other) {
571
    return EdgeInsets.fromLTRB(
572
      left / other,
573 574
      top / other,
      right / other,
575
      bottom / other,
576 577 578
    );
  }

579 580
  /// Integer divides the [EdgeInsets] in each dimension by the given factor.
  @override
581
  EdgeInsets operator ~/(double other) {
582
    return EdgeInsets.fromLTRB(
583
      (left ~/ other).toDouble(),
584 585
      (top ~/ other).toDouble(),
      (right ~/ other).toDouble(),
586
      (bottom ~/ other).toDouble(),
587 588 589
    );
  }

590
  /// Computes the remainder in each dimension by the given factor.
591
  @override
592
  EdgeInsets operator %(double other) {
593
    return EdgeInsets.fromLTRB(
594
      left % other,
595 596
      top % other,
      right % other,
597
      bottom % other,
598 599 600
    );
  }

601
  /// Linearly interpolate between two [EdgeInsets].
602
  ///
603
  /// If either is null, this function interpolates from [EdgeInsets.zero].
604
  ///
605
  /// {@macro dart.ui.shadow.lerp}
606
  static EdgeInsets? lerp(EdgeInsets? a, EdgeInsets? b, double t) {
607
    assert(t != null);
608
    if (a == null && b == null) {
609
      return null;
610 611
    }
    if (a == null) {
612
      return b! * t;
613 614
    }
    if (b == null) {
615
      return a * (1.0 - t);
616
    }
617
    return EdgeInsets.fromLTRB(
618 619 620 621
      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)!,
622 623 624
    );
  }

625
  @override
626
  EdgeInsets resolve(TextDirection? direction) => this;
627 628 629 630

  /// Creates a copy of this EdgeInsets but with the given fields replaced
  /// with the new values.
  EdgeInsets copyWith({
631 632 633 634
    double? left,
    double? top,
    double? right,
    double? bottom,
635
  }) {
636
    return EdgeInsets.only(
637 638 639 640 641 642
      left: left ?? this.left,
      top: top ?? this.top,
      right: right ?? this.right,
      bottom: bottom ?? this.bottom,
    );
  }
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
}

/// 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.
  ///
662
  /// {@tool snippet}
663 664 665 666 667 668
  ///
  /// A margin indent of 40 pixels on the leading side:
  ///
  /// ```dart
  /// const EdgeInsetsDirectional.only(start: 40.0)
  /// ```
669
  /// {@end-tool}
670
  const EdgeInsetsDirectional.only({
671 672 673
    this.start = 0.0,
    this.top = 0.0,
    this.end = 0.0,
674
    this.bottom = 0.0,
675 676
  });

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
  /// 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;

693 694 695 696
  /// 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].
697
  static const EdgeInsetsDirectional zero = EdgeInsetsDirectional.only();
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 737 738 739 740 741 742 743 744 745 746 747
  /// 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
748
  EdgeInsetsDirectional get flipped => EdgeInsetsDirectional.fromSTEB(end, bottom, start, top);
749 750 751

  @override
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
752
    if (other is EdgeInsetsDirectional) {
753
      return this - other;
754
    }
755
    return super.subtract(other);
756 757
  }

758
  @override
759
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
760
    if (other is EdgeInsetsDirectional) {
761
      return this + other;
762
    }
763 764 765 766 767
    return super.add(other);
  }

  /// Returns the difference between two [EdgeInsetsDirectional] objects.
  EdgeInsetsDirectional operator -(EdgeInsetsDirectional other) {
768
    return EdgeInsetsDirectional.fromSTEB(
769 770 771 772 773 774 775 776 777
      start - other.start,
      top - other.top,
      end - other.end,
      bottom - other.bottom,
    );
  }

  /// Returns the sum of two [EdgeInsetsDirectional] objects.
  EdgeInsetsDirectional operator +(EdgeInsetsDirectional other) {
778
    return EdgeInsetsDirectional.fromSTEB(
779 780 781 782 783 784
      start + other.start,
      top + other.top,
      end + other.end,
      bottom + other.bottom,
    );
  }
785

786 787 788 789 790
  /// Returns the [EdgeInsetsDirectional] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  @override
  EdgeInsetsDirectional operator -() {
791
    return EdgeInsetsDirectional.fromSTEB(
792 793 794 795 796 797 798 799
      -start,
      -top,
      -end,
      -bottom,
    );
  }

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

  /// Divides the [EdgeInsetsDirectional] object in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator /(double other) {
813
    return EdgeInsetsDirectional.fromSTEB(
814 815 816 817 818 819 820 821 822 823
      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) {
824
    return EdgeInsetsDirectional.fromSTEB(
825 826 827 828 829 830 831 832 833 834
      (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) {
835
    return EdgeInsetsDirectional.fromSTEB(
836 837 838 839 840 841 842 843 844 845 846 847 848 849
      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.
850
  ///
851
  /// {@macro dart.ui.shadow.lerp}
852
  static EdgeInsetsDirectional? lerp(EdgeInsetsDirectional? a, EdgeInsetsDirectional? b, double t) {
853
    assert(t != null);
854
    if (a == null && b == null) {
855
      return null;
856 857
    }
    if (a == null) {
858
      return b! * t;
859 860
    }
    if (b == null) {
861
      return a * (1.0 - t);
862
    }
863
    return EdgeInsetsDirectional.fromSTEB(
864 865 866 867
      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)!,
868 869 870 871
    );
  }

  @override
872
  EdgeInsets resolve(TextDirection? direction) {
873
    assert(direction != null);
874
    switch (direction!) {
875
      case TextDirection.rtl:
876
        return EdgeInsets.fromLTRB(end, top, start, bottom);
877
      case TextDirection.ltr:
878
        return EdgeInsets.fromLTRB(start, top, end, bottom);
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
    }
  }
}

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 -() {
916
    return _MixedEdgeInsets.fromLRSETB(
917 918 919 920 921 922 923 924 925 926 927
      -_left,
      -_right,
      -_start,
      -_end,
      -_top,
      -_bottom,
    );
  }

  @override
  _MixedEdgeInsets operator *(double other) {
928
    return _MixedEdgeInsets.fromLRSETB(
929 930 931 932 933 934 935 936 937 938 939
      _left * other,
      _right * other,
      _start * other,
      _end * other,
      _top * other,
      _bottom * other,
    );
  }

  @override
  _MixedEdgeInsets operator /(double other) {
940
    return _MixedEdgeInsets.fromLRSETB(
941 942 943 944 945 946 947 948 949 950 951
      _left / other,
      _right / other,
      _start / other,
      _end / other,
      _top / other,
      _bottom / other,
    );
  }

  @override
  _MixedEdgeInsets operator ~/(double other) {
952
    return _MixedEdgeInsets.fromLRSETB(
953 954 955 956 957 958 959 960 961 962 963
      (_left ~/ other).toDouble(),
      (_right ~/ other).toDouble(),
      (_start ~/ other).toDouble(),
      (_end ~/ other).toDouble(),
      (_top ~/ other).toDouble(),
      (_bottom ~/ other).toDouble(),
    );
  }

  @override
  _MixedEdgeInsets operator %(double other) {
964
    return _MixedEdgeInsets.fromLRSETB(
965 966 967 968 969 970 971 972 973 974
      _left % other,
      _right % other,
      _start % other,
      _end % other,
      _top % other,
      _bottom % other,
    );
  }

  @override
975
  EdgeInsets resolve(TextDirection? direction) {
976
    assert(direction != null);
977
    switch (direction!) {
978
      case TextDirection.rtl:
979
        return EdgeInsets.fromLTRB(_end + _left, _top, _start + _right, _bottom);
980
      case TextDirection.ltr:
981
        return EdgeInsets.fromLTRB(_start + _left, _top, _end + _right, _bottom);
982 983
    }
  }
984
}