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

import 'dart:async';
import 'dart:ui' as ui show Image;

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

class TestImageInfo implements ImageInfo {
12
  const TestImageInfo(this.value, { required this.image, this.scale = 1.0, this.debugLabel });
13 14

  @override
15
  final ui.Image image;
16 17

  @override
18
  final double scale;
19

20
  @override
21
  final String? debugLabel;
22

23 24 25
  final int value;

  @override
Ian Hickson's avatar
Ian Hickson committed
26
  String toString() => '${objectRuntimeType(this, 'TestImageInfo')}($value)';
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

  @override
  TestImageInfo clone() {
    return TestImageInfo(value, image: image.clone(), scale: scale, debugLabel: debugLabel);
  }

  @override
  bool isCloneOf(ImageInfo other) {
    assert(other != null);
    return other.image.isCloneOf(image)
        && scale == scale
        && other.debugLabel == debugLabel;
  }

  @override
  void dispose() {
    image.dispose();
  }

  @override
  int get hashCode => hashValues(value, image, scale, debugLabel);

  @override
  bool operator ==(Object other) {
    if (other.runtimeType != runtimeType)
      return false;
    return other is TestImageInfo
        && other.value == value
        && other.image.isCloneOf(image)
        && other.scale == scale
        && other.debugLabel == debugLabel;

  }
60 61
}

62
class TestImageProvider extends ImageProvider<int> {
63
  const TestImageProvider(this.key, this.imageValue, { required this.image })
64 65
      : assert(image != null);

66
  final int key;
67
  final int imageValue;
68
  final ui.Image image;
69 70

  @override
71
  Future<int> obtainKey(ImageConfiguration configuration) {
72
    return Future<int>.value(key);
73 74 75
  }

  @override
76
  ImageStreamCompleter load(int key, DecoderCallback decode) {
77
    return OneFrameImageStreamCompleter(
78
      SynchronousFuture<ImageInfo>(TestImageInfo(imageValue, image: image.clone())),
79
    );
80 81 82
  }

  @override
Ian Hickson's avatar
Ian Hickson committed
83
  String toString() => '${objectRuntimeType(this, 'TestImageProvider')}($key, $imageValue)';
84
}
85

86
class FailingTestImageProvider extends TestImageProvider {
87
  const FailingTestImageProvider(int key, int imageValue, { required ui.Image image }) : super(key, imageValue, image: image);
88 89

  @override
90
  ImageStreamCompleter load(int key, DecoderCallback decode) {
91 92 93 94
    return OneFrameImageStreamCompleter(Future<ImageInfo>.sync(() => Future<ImageInfo>.error('loading failed!')));
  }
}

95
Future<ImageInfo> extractOneFrame(ImageStream stream) {
96
  final Completer<ImageInfo> completer = Completer<ImageInfo>();
97
  late ImageStreamListener listener;
98
  listener = ImageStreamListener((ImageInfo image, bool synchronousCall) {
99 100
    completer.complete(image);
    stream.removeListener(listener);
101
  });
102 103
  stream.addListener(listener);
  return completer.future;
104
}
105

106 107
class ErrorImageProvider extends ImageProvider<ErrorImageProvider> {
  @override
108
  ImageStreamCompleter load(ErrorImageProvider key, DecoderCallback decode) {
109 110 111 112 113 114 115 116
    throw Error();
  }

  @override
  Future<ErrorImageProvider> obtainKey(ImageConfiguration configuration) {
    return SynchronousFuture<ErrorImageProvider>(this);
  }
}
117

118 119
class ObtainKeyErrorImageProvider extends ImageProvider<ObtainKeyErrorImageProvider> {
  @override
120
  ImageStreamCompleter load(ObtainKeyErrorImageProvider key, DecoderCallback decode) {
121 122 123 124 125 126 127 128 129
    throw Error();
  }

  @override
  Future<ObtainKeyErrorImageProvider> obtainKey(ImageConfiguration configuration) {
    throw Error();
  }
}

130 131
class LoadErrorImageProvider extends ImageProvider<LoadErrorImageProvider> {
  @override
132
  ImageStreamCompleter load(LoadErrorImageProvider key, DecoderCallback decode) {
133 134 135
    throw Error();
  }

136
  @override
137 138 139 140 141
  Future<LoadErrorImageProvider> obtainKey(ImageConfiguration configuration) {
    return SynchronousFuture<LoadErrorImageProvider>(this);
  }
}

142
class LoadErrorCompleterImageProvider extends ImageProvider<LoadErrorCompleterImageProvider> {
143
  @override
144
  ImageStreamCompleter load(LoadErrorCompleterImageProvider key, DecoderCallback decode) {
145
    final Completer<ImageInfo> completer = Completer<ImageInfo>.sync();
146 147
    completer.completeError(Error());
    return OneFrameImageStreamCompleter(completer.future);
148 149
  }

150
  @override
151 152 153 154 155
  Future<LoadErrorCompleterImageProvider> obtainKey(ImageConfiguration configuration) {
    return SynchronousFuture<LoadErrorCompleterImageProvider>(this);
  }
}

156
class TestImageStreamCompleter extends ImageStreamCompleter {
157
  void testSetImage(ui.Image image) {
158 159 160
    setImage(ImageInfo(image: image, scale: 1.0));
  }
}