[web] rename DomRenderer to FlutterViewEmbedder

Author: yjbanov

lib/web_ui/lib/src/engine.dart

@@ -41,7 +41,7 @@ import '../ui.dart' as ui;
 
 // ignore: unused_import
 import 'engine/configuration.dart';
-import 'engine/dom_renderer.dart';
+import 'engine/embedder.dart';
 import 'engine/keyboard.dart';
 import 'engine/mouse_cursor.dart';
 import 'engine/navigation/js_url_strategy.dart';
@@ -130,7 +130,7 @@ export 'engine/color_filter.dart';
 
 export 'engine/configuration.dart';
 
-export 'engine/dom_renderer.dart';
+export 'engine/embedder.dart';
 
 export 'engine/engine_canvas.dart';
 
@@ -413,8 +413,8 @@ void initializeEngine() {
 
   _engineInitialized = true;
 
-  // Initialize the DomRenderer before initializing framework bindings.
-  ensureDomRendererInitialized();
+  // Initialize the FlutterViewEmbedder before initializing framework bindings.
+  ensureFlutterViewEmbedderInitialized();
 
   WebExperiments.ensureInitialized();
 

lib/web_ui/lib/src/engine/canvaskit/initialization.dart

@@ -13,7 +13,7 @@ import 'package:js/js.dart';
 import '../../engine.dart' show kProfileMode;
 import '../browser_detection.dart';
 import '../configuration.dart';
-import '../dom_renderer.dart';
+import '../embedder.dart';
 import 'canvaskit_api.dart';
 import 'fonts.dart';
 
@@ -78,7 +78,7 @@ Future<void> initializeCanvasKit({String? canvasKitBase}) {
 
   /// Add a Skia scene host.
   skiaSceneHost = html.Element.tag('flt-scene');
-  domRenderer.renderScene(skiaSceneHost);
+  flutterViewEmbedder.renderScene(skiaSceneHost);
   return canvasKitCompleter.future;
 }
 

lib/web_ui/lib/src/engine/dom_renderer.dart renamed to lib/web_ui/lib/src/engine/embedder.dart

@@ -21,10 +21,23 @@ import 'text_editing/text_editing.dart';
 import 'util.dart';
 import 'window.dart';
 
-class DomRenderer {
-  DomRenderer() {
+/// Controls the placement and lifecycle of a Flutter view on the web page.
+///
+/// Manages several top-level elements that host Flutter-generated content,
+/// including:
+///
+/// - [glassPaneElement], the root element of a Flutter view.
+/// - [glassPaneShadow], the shadow root used to isolate Flutter-rendered
+///   content from the surrounding page content, including from the platform
+///   views.
+/// - [sceneElement], the element that hosts Flutter layers and pictures, and
+///   projects platform views.
+/// - [sceneHostElement], the anchor that provides a stable location in the DOM
+///   tree for the [sceneElement].
+/// - [semanticsHostElement], hosts the ARIA-annotated semantics tree.
+class FlutterViewEmbedder {
+  FlutterViewEmbedder() {
     reset();
-
     assert(() {
       _setupHotRestart();
       return true;
@@ -527,7 +540,7 @@ void applyGlobalCssRulesToSheet(
   html.CssStyleSheet sheet, {
   required BrowserEngine browserEngine,
   required bool hasAutofillOverlay,
-  String glassPaneTagName = DomRenderer._glassPaneTagName,
+  String glassPaneTagName = FlutterViewEmbedder._glassPaneTagName,
 }) {
   final bool isWebKit = browserEngine == BrowserEngine.webkit;
   final bool isFirefox = browserEngine == BrowserEngine.firefox;
@@ -646,9 +659,9 @@ void applyGlobalCssRulesToSheet(
   }
 }
 
-/// Singleton DOM renderer.
-DomRenderer get domRenderer => ensureDomRendererInitialized();
+/// The embedder singleton.
+FlutterViewEmbedder get flutterViewEmbedder => ensureFlutterViewEmbedderInitialized();
 
-/// Initializes the [DomRenderer], if it's not already initialized.
-DomRenderer ensureDomRendererInitialized() => _domRenderer ??= DomRenderer();
-DomRenderer? _domRenderer;
+/// Initializes the [FlutterViewEmbedder], if it's not already initialized.
+FlutterViewEmbedder ensureFlutterViewEmbedderInitialized() => _flutterViewEmbedder ??= FlutterViewEmbedder();
+FlutterViewEmbedder? _flutterViewEmbedder;

lib/web_ui/lib/src/engine/host_node.dart

@@ -5,7 +5,7 @@
 import 'dart:html' as html;
 
 import 'browser_detection.dart';
-import 'dom_renderer.dart';
+import 'embedder.dart';
 import 'text_editing/text_editing.dart';
 
 /// The interface required to host a flutter app in the DOM, and its tests.

lib/web_ui/lib/src/engine/html/color_filter.dart

@@ -10,7 +10,7 @@ import 'package:ui/ui.dart' as ui;
 import '../browser_detection.dart';
 import '../canvaskit/color_filter.dart';
 import '../color_filter.dart';
-import '../dom_renderer.dart';
+import '../embedder.dart';
 import '../util.dart';
 import 'bitmap_canvas.dart';
 import 'path_to_svg_clip.dart';
@@ -53,7 +53,7 @@ class PersistedColorFilter extends PersistedContainerSurface
   @override
   void discard() {
     super.discard();
-    domRenderer.removeResource(_filterElement);
+    flutterViewEmbedder.removeResource(_filterElement);
     // Do not detach the child container from the root. It is permanently
     // attached. The elements are reused together and are detached from the DOM
     // together.
@@ -72,7 +72,7 @@ class PersistedColorFilter extends PersistedContainerSurface
 
   @override
   void apply() {
-    domRenderer.removeResource(_filterElement);
+    flutterViewEmbedder.removeResource(_filterElement);
     _filterElement = null;
     final EngineColorFilter? engineValue = filter as EngineColorFilter?;
     if (engineValue == null) {
@@ -138,7 +138,7 @@ class PersistedColorFilter extends PersistedContainerSurface
     // Use SVG filter for blend mode.
     final SvgFilter svgFilter = svgFilterFromBlendMode(filterColor, colorFilterBlendMode);
     _filterElement = svgFilter.element;
-    domRenderer.addResource(_filterElement!);
+    flutterViewEmbedder.addResource(_filterElement!);
     style.filter = 'url(#${svgFilter.id})';
     if (colorFilterBlendMode == ui.BlendMode.saturation ||
         colorFilterBlendMode == ui.BlendMode.multiply ||
@@ -150,7 +150,7 @@ class PersistedColorFilter extends PersistedContainerSurface
   void _applyMatrixColorFilter(CkMatrixColorFilter colorFilter) {
     final SvgFilter svgFilter = svgFilterFromColorMatrix(colorFilter.matrix);
     _filterElement = svgFilter.element;
-    domRenderer.addResource(_filterElement!);
+    flutterViewEmbedder.addResource(_filterElement!);
     childContainer!.style.filter = 'url(#${svgFilter.id})';
   }
 

lib/web_ui/lib/src/engine/html/dom_canvas.dart

@@ -10,7 +10,7 @@ import 'dart:typed_data';
 import 'package:ui/ui.dart' as ui;
 
 import '../browser_detection.dart';
-import '../dom_renderer.dart';
+import '../embedder.dart';
 import '../engine_canvas.dart';
 import '../html_image_codec.dart';
 import '../text/paragraph.dart';
@@ -32,7 +32,7 @@ class DomCanvas extends EngineCanvas with SaveElementStackTracking {
   @override
   void clear() {
     super.clear();
-    domRenderer.removeAllChildren(rootElement);
+    flutterViewEmbedder.removeAllChildren(rootElement);
   }
 
   @override

lib/web_ui/lib/src/engine/html/picture.dart

@@ -8,7 +8,7 @@ import 'dart:typed_data';
 
 import 'package:ui/ui.dart' as ui;
 
-import '../dom_renderer.dart';
+import '../embedder.dart';
 import '../engine_canvas.dart';
 import '../frame_reference.dart';
 import '../picture.dart';
@@ -350,7 +350,7 @@ class PersistedPicture extends PersistedLeafSurface {
         oldSurface._canvas = null;
       }
       if (rootElement != null) {
-        domRenderer.removeAllChildren(rootElement!);
+        flutterViewEmbedder.removeAllChildren(rootElement!);
       }
       if (_canvas != null && _canvas != oldCanvas) {
         _recycleCanvas(_canvas);
@@ -432,7 +432,7 @@ class PersistedPicture extends PersistedLeafSurface {
     _recycleCanvas(_canvas);
     final DomCanvas domCanvas = DomCanvas(rootElement!);
     _canvas = domCanvas;
-    domRenderer.removeAllChildren(rootElement!);
+    flutterViewEmbedder.removeAllChildren(rootElement!);
     picture.recordingCanvas!.apply(domCanvas, _optimalLocalCullRect!);
   }
 
@@ -473,7 +473,7 @@ class PersistedPicture extends PersistedLeafSurface {
             surfaceStatsFor(this).paintPixelCount +=
                 bitmapCanvas.bitmapPixelCount;
           }
-          domRenderer.removeAllChildren(rootElement!);
+          flutterViewEmbedder.removeAllChildren(rootElement!);
           rootElement!.append(bitmapCanvas.rootElement);
           bitmapCanvas.clear();
           picture.recordingCanvas!.apply(bitmapCanvas, _optimalLocalCullRect!);

lib/web_ui/lib/src/engine/html/shader_mask.dart

@@ -7,7 +7,7 @@ import 'dart:html' as html;
 import 'package:ui/ui.dart' as ui;
 
 import '../browser_detection.dart';
-import '../dom_renderer.dart';
+import '../embedder.dart';
 import 'bitmap_canvas.dart';
 import 'color_filter.dart';
 import 'shaders/shader.dart';
@@ -57,7 +57,7 @@ class PersistedShaderMask extends PersistedContainerSurface
   @override
   void discard() {
     super.discard();
-    domRenderer.removeResource(_shaderElement);
+    flutterViewEmbedder.removeResource(_shaderElement);
     // Do not detach the child container from the root. It is permanently
     // attached. The elements are reused together and are detached from the DOM
     // together.
@@ -83,7 +83,7 @@ class PersistedShaderMask extends PersistedContainerSurface
 
   @override
   void apply() {
-    domRenderer.removeResource(_shaderElement);
+    flutterViewEmbedder.removeResource(_shaderElement);
     _shaderElement = null;
     if (shader is ui.Gradient) {
       rootElement!.style
@@ -162,7 +162,7 @@ class PersistedShaderMask extends PersistedContainerSurface
       } else {
         rootElement!.style.filter = 'url(#${svgFilter.id})';
       }
-      domRenderer.addResource(_shaderElement!);
+      flutterViewEmbedder.addResource(_shaderElement!);
     }
   }
 

lib/web_ui/lib/src/engine/mouse_cursor.dart

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import 'dom_renderer.dart';
+import 'embedder.dart';
 import 'util.dart';
 
 /// Provides mouse cursor bindings, such as the `flutter/mousecursor` channel.
@@ -67,7 +67,7 @@ class MouseCursor {
 
   void activateSystemCursor(String? kind) {
     setElementStyle(
-      domRenderer.glassPaneElement!,
+      flutterViewEmbedder.glassPaneElement!,
       'cursor',
       _mapKindToCssValue(kind),
     );

lib/web_ui/lib/src/engine/platform_dispatcher.dart

@@ -16,7 +16,7 @@ import 'canvaskit/initialization.dart';
 import 'canvaskit/layer_scene_builder.dart';
 import 'canvaskit/rasterizer.dart';
 import 'clipboard.dart';
-import 'dom_renderer.dart';
+import 'embedder.dart';
 import 'html/scene.dart';
 import 'mouse_cursor.dart';
 import 'platform_views/message_handler.dart';
@@ -434,7 +434,7 @@ class EnginePlatformDispatcher extends ui.PlatformDispatcher {
             return;
           case 'SystemChrome.setPreferredOrientations':
             final List<dynamic> arguments = decoded.arguments as List<dynamic>;
-            domRenderer.setPreferredOrientation(arguments).then((bool success) {
+            flutterViewEmbedder.setPreferredOrientation(arguments).then((bool success) {
               replyToPlatformMessage(
                   callback, codec.encodeSuccessEnvelope(success));
             });
@@ -483,7 +483,7 @@ class EnginePlatformDispatcher extends ui.PlatformDispatcher {
         _platformViewMessageHandler ??= PlatformViewMessageHandler(
           contentManager: platformViewManager,
           contentHandler: (html.Element content) {
-            domRenderer.glassPaneElement!.append(content);
+            flutterViewEmbedder.glassPaneElement!.append(content);
           },
         );
         _platformViewMessageHandler!.handlePlatformViewCall(data, callback!);
@@ -606,7 +606,7 @@ class EnginePlatformDispatcher extends ui.PlatformDispatcher {
       rasterizer!.draw(layerScene.layerTree);
     } else {
       final SurfaceScene surfaceScene = scene as SurfaceScene;
-      domRenderer.renderScene(surfaceScene.webOnlyRootElement);
+      flutterViewEmbedder.renderScene(surfaceScene.webOnlyRootElement);
     }
     frameTimingsOnRasterFinish();
   }
@@ -727,7 +727,7 @@ class EnginePlatformDispatcher extends ui.PlatformDispatcher {
     _configuration = _configuration.copyWith(locales: const <ui.Locale>[]);
   }
 
-  // Called by DomRenderer when browser languages change.
+  // Called by FlutterViewEmbedder when browser languages change.
   void updateLocales() {
     _configuration = _configuration.copyWith(locales: parseBrowserLanguages());
   }