| // Copyright 2013 The Flutter Authors. All rights reserved. |
| // 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:html' as html; |
| import 'dart:js_util' as js_util; |
| import 'dart:math' as math; |
| import 'dart:typed_data'; |
| |
| import 'package:ui/ui.dart' as ui; |
| |
| import 'browser_detection.dart'; |
| import 'vector_math.dart'; |
| |
| /// Generic callback signature, used by [_futurize]. |
| typedef Callback<T> = void Function(T result); |
| |
| /// Signature for a method that receives a [_Callback]. |
| /// |
| /// Return value should be null on success, and a string error message on |
| /// failure. |
| typedef Callbacker<T> = String? Function(Callback<T> callback); |
| |
| /// Converts a method that receives a value-returning callback to a method that |
| /// returns a Future. |
| /// |
| /// Return a [String] to cause an [Exception] to be synchronously thrown with |
| /// that string as a message. |
| /// |
| /// If the callback is called with null, the future completes with an error. |
| /// |
| /// Example usage: |
| /// |
| /// ```dart |
| /// typedef IntCallback = void Function(int result); |
| /// |
| /// String _doSomethingAndCallback(IntCallback callback) { |
| /// new Timer(new Duration(seconds: 1), () { callback(1); }); |
| /// } |
| /// |
| /// Future<int> doSomething() { |
| /// return _futurize(_doSomethingAndCallback); |
| /// } |
| /// ``` |
| Future<T> futurize<T>(Callbacker<T> callbacker) { |
| final Completer<T> completer = Completer<T>.sync(); |
| final String? error = callbacker((T t) { |
| if (t == null) { |
| completer.completeError(Exception('operation failed')); |
| } else { |
| completer.complete(t); |
| } |
| }); |
| if (error != null) { |
| throw Exception(error); |
| } |
| return completer.future; |
| } |
| |
| /// Converts [matrix] to CSS transform value. |
| String matrix4ToCssTransform(Matrix4 matrix) { |
| return float64ListToCssTransform(matrix.storage); |
| } |
| |
| /// Applies a transform to the [element]. |
| /// |
| /// See [float64ListToCssTransform] for details on how the CSS value is chosen. |
| void setElementTransform(html.Element element, Float32List matrix4) { |
| element.style |
| ..transformOrigin = '0 0 0' |
| ..transform = float64ListToCssTransform(matrix4); |
| } |
| |
| /// Converts [matrix] to CSS transform value. |
| /// |
| /// To avoid blurry text on some screens this function uses a 2D CSS transform |
| /// if it detects that [matrix] is a 2D transform. Otherwise, it uses a 3D CSS |
| /// transform. |
| /// |
| /// See also: |
| /// * https://github.com/flutter/flutter/issues/32274 |
| /// * https://bugs.chromium.org/p/chromium/issues/detail?id=1040222 |
| String float64ListToCssTransform(List<double> matrix) { |
| assert(matrix.length == 16); |
| final TransformKind transformKind = transformKindOf(matrix); |
| if (transformKind == TransformKind.transform2d) { |
| return float64ListToCssTransform2d(matrix); |
| } else if (transformKind == TransformKind.complex) { |
| return float64ListToCssTransform3d(matrix); |
| } else { |
| assert(transformKind == TransformKind.identity); |
| return 'none'; |
| } |
| } |
| |
| /// The kind of effect a transform matrix performs. |
| enum TransformKind { |
| /// No effect. |
| /// |
| /// We do not want to set any CSS properties in this case. |
| identity, |
| |
| /// A transform that contains only 2d scale, rotation, and translation. |
| /// |
| /// We prefer to use "matrix" instead of "matrix3d" in this case. |
| transform2d, |
| |
| /// All other kinds of transforms. |
| /// |
| /// In this case we will use "matrix3d". |
| complex, |
| } |
| |
| /// Detects the kind of transform the [matrix] performs. |
| TransformKind transformKindOf(List<double> matrix) { |
| assert(matrix.length == 16); |
| final List<double> m = matrix; |
| |
| // If matrix contains scaling, rotation, z translation or |
| // perspective transform, it is not considered simple. |
| final bool isSimple2dTransform = m[15] == |
| 1.0 && // start reading from the last element to eliminate range checks in subsequent reads. |
| m[14] == 0.0 && // z translation is NOT simple |
| // m[13] - y translation is simple |
| // m[12] - x translation is simple |
| m[11] == 0.0 && |
| m[10] == 1.0 && |
| m[9] == 0.0 && |
| m[8] == 0.0 && |
| m[7] == 0.0 && |
| m[6] == 0.0 && |
| // m[5] - scale y is simple |
| // m[4] - 2D rotation is simple |
| m[3] == 0.0 && |
| m[2] == 0.0; |
| // m[1] - 2D rotation is simple |
| // m[0] - scale x is simple |
| |
| if (!isSimple2dTransform) { |
| return TransformKind.complex; |
| } |
| |
| // From this point on we're sure the transform is 2D, but we don't know if |
| // it's identity or not. To check, we need to look at the remaining elements |
| // that were not checked above. |
| final bool isIdentityTransform = m[0] == 1.0 && |
| m[1] == 0.0 && |
| m[4] == 0.0 && |
| m[5] == 1.0 && |
| m[12] == 0.0 && |
| m[13] == 0.0; |
| |
| if (isIdentityTransform) { |
| return TransformKind.identity; |
| } else { |
| return TransformKind.transform2d; |
| } |
| } |
| |
| /// Returns `true` is the [matrix] describes an identity transformation. |
| bool isIdentityFloat32ListTransform(Float32List matrix) { |
| assert(matrix.length == 16); |
| return transformKindOf(matrix) == TransformKind.identity; |
| } |
| |
| /// Converts [matrix] to CSS transform 2D matrix value. |
| /// |
| /// The [matrix] must not be a [TransformKind.complex] transform, because CSS |
| /// `matrix` can only express 2D transforms. [TransformKind.identity] is |
| /// permitted. However, it is inefficient to construct a matrix for an identity |
| /// transform. Consider removing the CSS `transform` property from elements |
| /// that apply identity transform. |
| String float64ListToCssTransform2d(List<double> matrix) { |
| assert(transformKindOf(matrix) != TransformKind.complex); |
| return 'matrix(${matrix[0]},${matrix[1]},${matrix[4]},${matrix[5]},${matrix[12]},${matrix[13]})'; |
| } |
| |
| /// Converts [matrix] to a 3D CSS transform value. |
| String float64ListToCssTransform3d(List<double> matrix) { |
| assert(matrix.length == 16); |
| final List<double> m = matrix; |
| if (m[0] == 1.0 && |
| m[1] == 0.0 && |
| m[2] == 0.0 && |
| m[3] == 0.0 && |
| m[4] == 0.0 && |
| m[5] == 1.0 && |
| m[6] == 0.0 && |
| m[7] == 0.0 && |
| m[8] == 0.0 && |
| m[9] == 0.0 && |
| m[10] == 1.0 && |
| m[11] == 0.0 && |
| // 12 can be anything |
| // 13 can be anything |
| m[14] == 0.0 && |
| m[15] == 1.0) { |
| final double tx = m[12]; |
| final double ty = m[13]; |
| return 'translate3d(${tx}px, ${ty}px, 0px)'; |
| } else { |
| return 'matrix3d(${m[0]},${m[1]},${m[2]},${m[3]},${m[4]},${m[5]},${m[6]},${m[7]},${m[8]},${m[9]},${m[10]},${m[11]},${m[12]},${m[13]},${m[14]},${m[15]})'; |
| } |
| } |
| |
| bool get assertionsEnabled { |
| bool k = false; |
| assert(k = true); |
| return k; |
| } |
| |
| final Float32List _tempRectData = Float32List(4); |
| |
| /// Transforms a [ui.Rect] given the effective [transform]. |
| /// |
| /// The resulting rect is aligned to the pixel grid, i.e. two of |
| /// its sides are vertical and two are horizontal. In the presence of rotations |
| /// the rectangle is inflated such that it fits the rotated rectangle. |
| ui.Rect transformRect(Matrix4 transform, ui.Rect rect) { |
| _tempRectData[0] = rect.left; |
| _tempRectData[1] = rect.top; |
| _tempRectData[2] = rect.right; |
| _tempRectData[3] = rect.bottom; |
| transformLTRB(transform, _tempRectData); |
| return ui.Rect.fromLTRB( |
| _tempRectData[0], |
| _tempRectData[1], |
| _tempRectData[2], |
| _tempRectData[3], |
| ); |
| } |
| |
| /// Temporary storage for intermediate data used by [transformLTRB]. |
| /// |
| /// WARNING: do not use this outside [transformLTRB]. Sharing this variable in |
| /// other contexts will lead to bugs. |
| final Float32List _tempPointData = Float32List(16); |
| final Matrix4 _tempPointMatrix = Matrix4.fromFloat32List(_tempPointData); |
| |
| /// Transforms a rectangle given the effective [transform]. |
| /// |
| /// This is the same as [transformRect], except that the rect is specified |
| /// in terms of left, top, right, and bottom edge offsets. |
| void transformLTRB(Matrix4 transform, Float32List ltrb) { |
| // Construct a matrix where each row represents a vector pointing at |
| // one of the four corners of the (left, top, right, bottom) rectangle. |
| // Using the row-major order allows us to multiply the matrix in-place |
| // by the transposed current transformation matrix. The vector_math |
| // library has a convenience function `multiplyTranspose` that performs |
| // the multiplication without copying. This way we compute the positions |
| // of all four points in a single matrix-by-matrix multiplication at the |
| // cost of one `Matrix4` instance and one `Float32List` instance. |
| // |
| // The rejected alternative was to use `Vector3` for each point and |
| // multiply by the current transform. However, that would cost us four |
| // `Vector3` instances, four `Float32List` instances, and four |
| // matrix-by-vector multiplications. |
| // |
| // `Float32List` initializes the array with zeros, so we do not have to |
| // fill in every single element. |
| |
| // Row 0: top-left |
| _tempPointData[0] = ltrb[0]; |
| _tempPointData[4] = ltrb[1]; |
| _tempPointData[8] = 0; |
| _tempPointData[12] = 1; |
| |
| // Row 1: top-right |
| _tempPointData[1] = ltrb[2]; |
| _tempPointData[5] = ltrb[1]; |
| _tempPointData[9] = 0; |
| _tempPointData[13] = 1; |
| |
| // Row 2: bottom-left |
| _tempPointData[2] = ltrb[0]; |
| _tempPointData[6] = ltrb[3]; |
| _tempPointData[10] = 0; |
| _tempPointData[14] = 1; |
| |
| // Row 3: bottom-right |
| _tempPointData[3] = ltrb[2]; |
| _tempPointData[7] = ltrb[3]; |
| _tempPointData[11] = 0; |
| _tempPointData[15] = 1; |
| |
| _tempPointMatrix.multiplyTranspose(transform); |
| |
| // Handle non-homogenous matrices. |
| double w = transform[15]; |
| if (w == 0.0) { |
| w = 1.0; |
| } |
| |
| ltrb[0] = math.min( |
| math.min(math.min(_tempPointData[0], _tempPointData[1]), |
| _tempPointData[2]), |
| _tempPointData[3]) / |
| w; |
| ltrb[1] = math.min( |
| math.min(math.min(_tempPointData[4], _tempPointData[5]), |
| _tempPointData[6]), |
| _tempPointData[7]) / |
| w; |
| ltrb[2] = math.max( |
| math.max(math.max(_tempPointData[0], _tempPointData[1]), |
| _tempPointData[2]), |
| _tempPointData[3]) / |
| w; |
| ltrb[3] = math.max( |
| math.max(math.max(_tempPointData[4], _tempPointData[5]), |
| _tempPointData[6]), |
| _tempPointData[7]) / |
| w; |
| } |
| |
| /// Returns true if [rect] contains every point that is also contained by the |
| /// [other] rect. |
| /// |
| /// Points on the edges of both rectangles are also considered. For example, |
| /// this returns true when the two rects are equal to each other. |
| bool rectContainsOther(ui.Rect rect, ui.Rect other) { |
| return rect.left <= other.left && |
| rect.top <= other.top && |
| rect.right >= other.right && |
| rect.bottom >= other.bottom; |
| } |
| |
| /// Converts color to a css compatible attribute value. |
| String? colorToCssString(ui.Color? color) { |
| if (color == null) { |
| return null; |
| } |
| final int value = color.value; |
| if ((0xff000000 & value) == 0xff000000) { |
| final String hexValue = (value & 0xFFFFFF).toRadixString(16); |
| final int hexValueLength = hexValue.length; |
| switch (hexValueLength) { |
| case 1: |
| return '#00000$hexValue'; |
| case 2: |
| return '#0000$hexValue'; |
| case 3: |
| return '#000$hexValue'; |
| case 4: |
| return '#00$hexValue'; |
| case 5: |
| return '#0$hexValue'; |
| default: |
| return '#$hexValue'; |
| } |
| } else { |
| final double alpha = ((value >> 24) & 0xFF) / 255.0; |
| final StringBuffer sb = StringBuffer(); |
| sb.write('rgba('); |
| sb.write(((value >> 16) & 0xFF).toString()); |
| sb.write(','); |
| sb.write(((value >> 8) & 0xFF).toString()); |
| sb.write(','); |
| sb.write((value & 0xFF).toString()); |
| sb.write(','); |
| sb.write(alpha.toString()); |
| sb.write(')'); |
| return sb.toString(); |
| } |
| } |
| |
| /// Converts color components to a CSS compatible attribute value. |
| String colorComponentsToCssString(int r, int g, int b, int a) { |
| if (a == 255) { |
| return 'rgb($r,$g,$b)'; |
| } else { |
| final double alphaRatio = a / 255; |
| return 'rgba($r,$g,$b,${alphaRatio.toStringAsFixed(2)})'; |
| } |
| } |
| |
| /// Determines if the (dynamic) exception passed in is a NS_ERROR_FAILURE |
| /// (from Firefox). |
| /// |
| /// NS_ERROR_FAILURE (0x80004005) is the most general of all the (Firefox) |
| /// errors and occurs for all errors for which a more specific error code does |
| /// not apply. (https://developer.mozilla.org/en-US/docs/Mozilla/Errors) |
| /// |
| /// Other browsers do not throw this exception. |
| /// |
| /// In Flutter, this exception happens when we try to perform some operations on |
| /// a Canvas when the application is rendered in a display:none iframe. |
| /// |
| /// We need this in [BitmapCanvas] and [RecordingCanvas] to swallow this |
| /// Firefox exception without interfering with others (potentially useful |
| /// for the programmer). |
| bool isNsErrorFailureException(dynamic e) { |
| return js_util.getProperty(e, 'name') == 'NS_ERROR_FAILURE'; |
| } |
| |
| /// From: https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Syntax |
| /// |
| /// Generic font families are a fallback mechanism, a means of preserving some |
| /// of the style sheet author's intent when none of the specified fonts are |
| /// available. Generic family names are keywords and must not be quoted. A |
| /// generic font family should be the last item in the list of font family |
| /// names. |
| const Set<String> _genericFontFamilies = <String>{ |
| 'serif', |
| 'sans-serif', |
| 'monospace', |
| 'cursive', |
| 'fantasy', |
| 'system-ui', |
| 'math', |
| 'emoji', |
| 'fangsong', |
| }; |
| |
| /// A default fallback font family in case an unloaded font has been requested. |
| /// |
| /// -apple-system targets San Francisco in Safari (on Mac OS X and iOS), |
| /// and it targets Neue Helvetica and Lucida Grande on older versions of |
| /// Mac OS X. It properly selects between San Francisco Text and |
| /// San Francisco Display depending on the text’s size. |
| /// |
| /// For iOS, default to -apple-system, where it should be available, otherwise |
| /// default to Arial. BlinkMacSystemFont is used for Chrome on iOS. |
| final String _fallbackFontFamily = |
| isMacOrIOS ? '-apple-system, BlinkMacSystemFont' : 'Arial'; |
| |
| /// Create a font-family string appropriate for CSS. |
| /// |
| /// If the given [fontFamily] is a generic font-family, then just return it. |
| /// Otherwise, wrap the family name in quotes and add a fallback font family. |
| String? canonicalizeFontFamily(String? fontFamily) { |
| if (_genericFontFamilies.contains(fontFamily)) { |
| return fontFamily; |
| } |
| if (isMacOrIOS) { |
| // Unlike Safari, Chrome on iOS does not correctly fallback to cupertino |
| // on sans-serif. |
| // Map to San Francisco Text/Display fonts, use -apple-system, |
| // BlinkMacSystemFont. |
| if (fontFamily == '.SF Pro Text' || |
| fontFamily == '.SF Pro Display' || |
| fontFamily == '.SF UI Text' || |
| fontFamily == '.SF UI Display') { |
| return _fallbackFontFamily; |
| } |
| } |
| return '"$fontFamily", $_fallbackFontFamily, sans-serif'; |
| } |
| |
| /// Converts a list of [Offset] to a typed array of floats. |
| Float32List offsetListToFloat32List(List<ui.Offset> offsetList) { |
| final int length = offsetList.length; |
| final Float32List floatList = Float32List(length * 2); |
| for (int i = 0, destIndex = 0; i < length; i++, destIndex += 2) { |
| floatList[destIndex] = offsetList[i].dx; |
| floatList[destIndex + 1] = offsetList[i].dy; |
| } |
| return floatList; |
| } |
| |
| /// Apply this function to container elements in the HTML render tree (this is |
| /// not relevant to semantics tree). |
| /// |
| /// On WebKit browsers this will apply `z-order: 0` to ensure that clips are |
| /// applied correctly. Otherwise, the browser will refuse to clip its contents. |
| /// |
| /// Other possible fixes that were rejected: |
| /// |
| /// * Use 3D transform instead of 2D: this does not work because it causes text |
| /// blurriness: https://github.com/flutter/flutter/issues/32274 |
| void applyWebkitClipFix(html.Element? containerElement) { |
| if (browserEngine == BrowserEngine.webkit) { |
| containerElement!.style.zIndex = '0'; |
| } |
| } |
| |
| // Stores matrix in a form that allows zero allocation transforms. |
| class FastMatrix32 { |
| final Float32List matrix; |
| double transformedX = 0, transformedY = 0; |
| FastMatrix32(this.matrix); |
| |
| void transform(double x, double y) { |
| transformedX = matrix[12] + (matrix[0] * x) + (matrix[4] * y); |
| transformedY = matrix[13] + (matrix[1] * x) + (matrix[5] * y); |
| } |
| |
| String debugToString() => |
| '${matrix[0].toStringAsFixed(3)}, ${matrix[4].toStringAsFixed(3)}, ${matrix[8].toStringAsFixed(3)}, ${matrix[12].toStringAsFixed(3)}\n' |
| '${matrix[1].toStringAsFixed(3)}, ${matrix[5].toStringAsFixed(3)}, ${matrix[9].toStringAsFixed(3)}, ${matrix[13].toStringAsFixed(3)}\n' |
| '${matrix[2].toStringAsFixed(3)}, ${matrix[6].toStringAsFixed(3)}, ${matrix[10].toStringAsFixed(3)}, ${matrix[14].toStringAsFixed(3)}\n' |
| '${matrix[3].toStringAsFixed(3)}, ${matrix[7].toStringAsFixed(3)}, ${matrix[11].toStringAsFixed(3)}, ${matrix[15].toStringAsFixed(3)}\n'; |
| } |
| |
| /// Roughly the inverse of [ui.Shadow.convertRadiusToSigma]. |
| /// |
| /// This does not inverse [ui.Shadow.convertRadiusToSigma] exactly, because on |
| /// the Web the difference between sigma and blur radius is different from |
| /// Flutter mobile. |
| double convertSigmaToRadius(double sigma) { |
| return sigma * 2.0; |
| } |
| |
| /// Used to check for null values that are non-nullable. |
| /// |
| /// This is useful when some external API (e.g. HTML DOM) disagrees with |
| /// Dart type declarations (e.g. `dart:html`). Where `dart:html` may believe |
| /// something to be non-null, it may actually be null (e.g. old browsers do |
| /// not implement a feature, such as clipboard). |
| bool isUnsoundNull(dynamic object) { |
| return object == null; |
| } |
| |
| int clampInt(int value, int min, int max) { |
| assert(min <= max); |
| if (value < min) { |
| return min; |
| } else if (value > max) { |
| return max; |
| } else { |
| return value; |
| } |
| } |
| |
| /// Prints a warning message to the console. |
| /// |
| /// This function can be overridden in tests. This could be useful, for example, |
| /// to verify that warnings are printed under certain circumstances. |
| void Function(String) printWarning = html.window.console.warn; |
| |
| /// Determines if lists [a] and [b] are deep equivalent. |
| /// |
| /// Returns true if the lists are both null, or if they are both non-null, have |
| /// the same length, and contain the same elements in the same order. Returns |
| /// false otherwise. |
| bool listEquals<T>(List<T>? a, List<T>? b) { |
| if (a == null) { |
| return b == null; |
| } |
| if (b == null || a.length != b.length) { |
| return false; |
| } |
| for (int index = 0; index < a.length; index += 1) { |
| if (a[index] != b[index]) { |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| // HTML only supports a single radius, but Flutter ImageFilter supports separate |
| // horizontal and vertical radii. The best approximation we can provide is to |
| // average the two radii together for a single compromise value. |
| String blurSigmasToCssString(double sigmaX, double sigmaY) { |
| return 'blur(${(sigmaX + sigmaY) * 0.5}px)'; |
| } |
| |
| /// Checks if the dynamic [object] is equal to null. |
| bool unsafeIsNull(dynamic object) { |
| return object == null; |
| } |