BoxPainter should dispatch creation and disposal events. (#141526)

This commit is contained in:
Kostia Sokolovskyi 2024-01-14 19:07:10 +01:00 committed by GitHub
parent 947d7cad8d
commit 1a2c3151fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 4 deletions

View file

@ -198,9 +198,18 @@ abstract class Decoration with Diagnosticable {
/// happens, the [onChanged] callback will be invoked. To stop this callback
/// from being called after the painter has been discarded, call [dispose].
abstract class BoxPainter {
/// Abstract const constructor. This constructor enables subclasses to provide
/// const constructors so that they can be used in const expressions.
const BoxPainter([this.onChanged]);
/// Default abstract constructor for box painters.
BoxPainter([this.onChanged]) {
// TODO(polina-c): stop duplicating code across disposables
// https://github.com/flutter/flutter/issues/137435
if (kFlutterMemoryAllocationsEnabled) {
FlutterMemoryAllocations.instance.dispatchObjectCreated(
library: 'package:flutter/painting.dart',
className: '$BoxPainter',
object: this,
);
}
}
/// Paints the [Decoration] for which this object was created on the
/// given canvas using the given configuration.
@ -243,5 +252,9 @@ abstract class BoxPainter {
/// The [onChanged] callback will not be invoked after this method has been
/// called.
@mustCallSuper
void dispose() { }
void dispose() {
if (kFlutterMemoryAllocationsEnabled) {
FlutterMemoryAllocations.instance.dispatchObjectDisposed(object: this);
}
}
}

View file

@ -9,6 +9,7 @@ import 'package:fake_async/fake_async.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/painting.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:leak_tracker_flutter_testing/leak_tracker_flutter_testing.dart';
import '../image_data.dart';
import '../painting/mocks_for_image_cache.dart';
@ -813,4 +814,16 @@ void main() {
info.dispose();
}, skip: kIsWeb); // https://github.com/flutter/flutter/issues/87442
test('$BoxPainter dispatches memory events', () async {
await expectLater(
await memoryEvents(() => _BoxPainter().dispose(), _BoxPainter),
areCreateAndDispose,
);
});
}
class _BoxPainter extends BoxPainter {
@override
void paint(Canvas canvas, Offset offset, ImageConfiguration configuration) {}
}