Merge pull request #32 from canonical/use-runner-windows

Add support for windows created in the runner

Author: hbatagelo

engine/src/flutter/shell/platform/windows/flutter_host_window.cc

@@ -15,6 +15,17 @@ namespace {
 
 constexpr wchar_t kWindowClassName[] = L"FLUTTER_HOST_WINDOW";
 
+// RAII wrapper for global Win32 ATOMs.
+struct AtomRAII {
+  explicit AtomRAII(wchar_t const* name) : atom(GlobalAddAtom(name)) {}
+  ~AtomRAII() { GlobalDeleteAtom(atom); }
+  ATOM const atom;
+};
+
+// Atom used as the identifier for a window property that stores a pointer to a
+// |FlutterHostWindow| instance.
+AtomRAII const kWindowPropAtom(kWindowClassName);
+
 // Clamps |size| to the size of the virtual screen. Both the parameter and
 // return size are in physical coordinates.
 flutter::Size ClampToVirtualScreen(flutter::Size size) {
@@ -212,7 +223,7 @@ bool IsClassRegistered(LPCWSTR class_name) {
          0;
 }
 
-// Convert std::string to std::wstring.
+// Converts std::string to std::wstring.
 std::wstring StringToWstring(std::string_view str) {
   if (str.empty()) {
     return {};
@@ -238,7 +249,7 @@ std::wstring StringToWstring(std::string_view str) {
 #define DWMWA_USE_IMMERSIVE_DARK_MODE 20
 #endif
 
-// Update the window frame's theme to match the system theme.
+// Updates the window frame's theme to match the system theme.
 void UpdateTheme(HWND window) {
   // Registry key for app theme preference.
   const wchar_t kGetPreferredBrightnessRegKey[] =
@@ -261,6 +272,31 @@ void UpdateTheme(HWND window) {
   }
 }
 
+// Associates |instance| with the window |hwnd| as a window property.
+// Can be retrieved later using GetInstanceProperty.
+// Logs an error if setting the property fails.
+void SetInstanceProperty(HWND hwnd, flutter::FlutterHostWindow* instance) {
+  if (!SetProp(hwnd, MAKEINTATOM(kWindowPropAtom.atom), instance)) {
+    FML_LOG(ERROR) << "Failed to set up instance entry in the property list: "
+                   << GetLastErrorAsString();
+  }
+}
+
+// Retrieves the instance pointer set with SetInstanceProperty, or returns
+// nullptr if the property was not set.
+flutter::FlutterHostWindow* GetInstanceProperty(HWND hwnd) {
+  return reinterpret_cast<flutter::FlutterHostWindow*>(
+      GetProp(hwnd, MAKEINTATOM(kWindowPropAtom.atom)));
+}
+
+// Removes the instance property associated with |hwnd| previously set with
+// SetInstanceProperty. Logs an error if the property is not found.
+void RemoveInstanceProperty(HWND hwnd) {
+  if (!RemoveProp(hwnd, MAKEINTATOM(kWindowPropAtom.atom))) {
+    FML_LOG(ERROR) << "Failed to locate instance entry in the property list";
+  }
+}
+
 }  // namespace
 
 namespace flutter {
@@ -303,6 +339,35 @@ FlutterHostWindow::FlutterHostWindow(FlutterHostWindowController* controller,
             window_size ? *window_size : Size{CW_USEDEFAULT, CW_USEDEFAULT}};
   }();
 
+  // Set up the view.
+  FlutterWindowsEngine* const engine = window_controller_->engine();
+  auto view_window = std::make_unique<FlutterWindow>(
+      initial_window_rect.width(), initial_window_rect.height(),
+      engine->windows_proc_table());
+
+  std::unique_ptr<FlutterWindowsView> view =
+      engine->CreateView(std::move(view_window));
+  if (!view) {
+    FML_LOG(ERROR) << "Failed to create view";
+    return;
+  }
+
+  view_controller_ =
+      std::make_unique<FlutterWindowsViewController>(nullptr, std::move(view));
+  FML_CHECK(engine->running());
+  // Must happen after engine is running.
+  view_controller_->view()->SendInitialBounds();
+  // The Windows embedder listens to accessibility updates using the
+  // view's HWND. The embedder's accessibility features may be stale if
+  // the app was in headless mode.
+  view_controller_->engine()->UpdateAccessibilityFeatures();
+
+  // Ensure that basic setup of the view controller was successful.
+  if (!view_controller_->view()) {
+    FML_LOG(ERROR) << "Failed to set up the view controller";
+    return;
+  }
+
   // Register the window class.
   if (!IsClassRegistered(kWindowClassName)) {
     auto const idi_app_icon = 101;
@@ -354,44 +419,6 @@ FlutterHostWindow::FlutterHostWindow(FlutterHostWindowController* controller,
                window_rect.top - top_dropshadow_height, 0, 0,
                SWP_NOSIZE | SWP_NOZORDER | SWP_NOACTIVATE);
 
-  // Set up the view.
-  RECT client_rect;
-  GetClientRect(hwnd, &client_rect);
-  int const width = client_rect.right - client_rect.left;
-  int const height = client_rect.bottom - client_rect.top;
-
-  FlutterWindowsEngine* const engine = window_controller_->engine();
-  auto view_window = std::make_unique<FlutterWindow>(
-      width, height, engine->windows_proc_table());
-
-  std::unique_ptr<FlutterWindowsView> view =
-      engine->CreateView(std::move(view_window));
-  if (!view) {
-    FML_LOG(ERROR) << "Failed to create view";
-    return;
-  }
-
-  view_controller_ =
-      std::make_unique<FlutterWindowsViewController>(nullptr, std::move(view));
-
-  // Launch the engine if it is not running already.
-  if (!engine->running() && !engine->Run()) {
-    FML_LOG(ERROR) << "Failed to launch engine";
-    return;
-  }
-  // Must happen after engine is running.
-  view_controller_->view()->SendInitialBounds();
-  // The Windows embedder listens to accessibility updates using the
-  // view's HWND. The embedder's accessibility features may be stale if
-  // the app was in headless mode.
-  view_controller_->engine()->UpdateAccessibilityFeatures();
-
-  // Ensure that basic setup of the view controller was successful.
-  if (!view_controller_->view()) {
-    FML_LOG(ERROR) << "Failed to set up the view controller";
-    return;
-  }
-
   UpdateTheme(hwnd);
 
   SetChildContent(view_controller_->view()->GetWindowHandle());
@@ -426,24 +453,32 @@ FlutterHostWindow::FlutterHostWindow(FlutterHostWindowController* controller,
   window_handle_ = hwnd;
 }
 
+FlutterHostWindow::FlutterHostWindow(FlutterHostWindowController* controller,
+                                     HWND hwnd,
+                                     FlutterWindowsView* view)
+    : window_controller_(controller), window_handle_(hwnd) {
+  SetInstanceProperty(hwnd, this);
+  FML_CHECK(view != nullptr);
+  child_content_ = view->GetWindowHandle();
+}
+
 FlutterHostWindow::~FlutterHostWindow() {
-  if (HWND const hwnd = window_handle_) {
-    window_handle_ = nullptr;
-    DestroyWindow(hwnd);
+  RemoveInstanceProperty(window_handle_);
+  HWND const hwnd = std::exchange(window_handle_, nullptr);
 
-    // Unregisters the window class. It will fail silently if there are
-    // other windows using the class, as only the last window can
-    // successfully unregister the class.
+  if (view_controller_) {
+    DestroyWindow(hwnd);
+    // Unregister the window class. Fail silently if other windows are still
+    // using the class, as only the last window can successfully unregister it.
     if (!UnregisterClass(kWindowClassName, GetModuleHandle(nullptr))) {
-      // Clears the error information after the failed unregistering.
+      // Clear the error state after the failed unregistration.
       SetLastError(ERROR_SUCCESS);
     }
   }
 }
 
 FlutterHostWindow* FlutterHostWindow::GetThisFromHandle(HWND hwnd) {
-  return reinterpret_cast<FlutterHostWindow*>(
-      GetWindowLongPtr(hwnd, GWLP_USERDATA));
+  return GetInstanceProperty(hwnd);
 }
 
 HWND FlutterHostWindow::GetWindowHandle() const {
@@ -466,10 +501,9 @@ LRESULT FlutterHostWindow::WndProc(HWND hwnd,
                                    LPARAM lparam) {
   if (message == WM_NCCREATE) {
     auto* const create_struct = reinterpret_cast<CREATESTRUCT*>(lparam);
-    SetWindowLongPtr(hwnd, GWLP_USERDATA,
-                     reinterpret_cast<LONG_PTR>(create_struct->lpCreateParams));
     auto* const window =
         static_cast<FlutterHostWindow*>(create_struct->lpCreateParams);
+    SetInstanceProperty(hwnd, window);
     window->window_handle_ = hwnd;
 
     EnableFullDpiSupportIfAvailable(hwnd);
@@ -486,13 +520,15 @@ LRESULT FlutterHostWindow::HandleMessage(HWND hwnd,
                                          UINT message,
                                          WPARAM wparam,
                                          LPARAM lparam) {
-  switch (message) {
-    case WM_DESTROY:
-      if (window_handle_ && quit_on_close_) {
-        PostQuitMessage(0);
-      }
+  if (window_handle_ && view_controller_) {
+    LRESULT* result;
+    if (view_controller_->engine()->lifecycle_manager()->WindowProc(
+            hwnd, message, wparam, lparam, result)) {
       return 0;
+    }
+  }
 
+  switch (message) {
     case WM_DPICHANGED: {
       auto* const new_scaled_window_rect = reinterpret_cast<RECT*>(lparam);
       LONG const width =
@@ -567,6 +603,10 @@ LRESULT FlutterHostWindow::HandleMessage(HWND hwnd,
       break;
   }
 
+  if (!view_controller_) {
+    return 0;
+  }
+
   return DefWindowProc(hwnd, message, wparam, lparam);
 }
 

engine/src/flutter/shell/platform/windows/flutter_host_window.h

@@ -17,6 +17,7 @@
 namespace flutter {
 
 class FlutterHostWindowController;
+class FlutterWindowsView;
 class FlutterWindowsViewController;
 
 // A Win32 window that hosts a |FlutterWindow| in its client area.
@@ -28,9 +29,14 @@ class FlutterHostWindow {
   // |FlutterHostWindow::GetWindowHandle|.
   FlutterHostWindow(FlutterHostWindowController* controller,
                     WindowCreationSettings const& settings);
+  // Creates a |FlutterHostWindow| from an existing |view| associated with a
+  // top-level |hwnd|. Used when the native window is created by the runner.
+  FlutterHostWindow(FlutterHostWindowController* controller,
+                    HWND hwnd,
+                    FlutterWindowsView* view);
   virtual ~FlutterHostWindow();
 
-  // Returns the instance pointer for |hwnd| or nulllptr if invalid.
+  // Returns the instance pointer for |hwnd| or nullptr if invalid.
   static FlutterHostWindow* GetThisFromHandle(HWND hwnd);
 
   // Returns the current window state.
@@ -43,7 +49,7 @@ class FlutterHostWindow {
  private:
   friend FlutterHostWindowController;
 
-  // Set the focus to the child view window of |window|.
+  // Sets the focus to the child view window of |window|.
   static void FocusViewOf(FlutterHostWindow* window);
 
   // OS callback called by message pump. Handles the WM_NCCREATE message which
@@ -70,9 +76,11 @@ class FlutterHostWindow {
   void SetTitle(std::string_view title) const;
 
   // Controller for this window.
-  FlutterHostWindowController* const window_controller_;
+  FlutterHostWindowController* const window_controller_ = nullptr;
 
-  // Controller for the view hosted by this window.
+  // Controller for the view hosted in this window. Value-initialized if the
+  // window is created from an existing top-level native window created by the
+  // runner.
   std::unique_ptr<FlutterWindowsViewController> view_controller_;
 
   // The window archetype.

engine/src/flutter/shell/platform/windows/flutter_host_window_controller.cc

@@ -32,10 +32,6 @@ FlutterHostWindowController::FlutterHostWindowController(
     FlutterWindowsEngine* engine)
     : engine_(engine) {}
 
-FlutterHostWindowController::~FlutterHostWindowController() {
-  DestroyAllWindows();
-}
-
 std::optional<WindowMetadata> FlutterHostWindowController::CreateHostWindow(
     WindowCreationSettings const& settings) {
   auto window = std::make_unique<FlutterHostWindow>(this, settings);
@@ -63,6 +59,15 @@ std::optional<WindowMetadata> FlutterHostWindowController::CreateHostWindow(
   return result;
 }
 
+void FlutterHostWindowController::CreateHostWindowFromExisting(
+    HWND hwnd,
+    FlutterWindowsView* view) {
+  FML_CHECK(view != nullptr);
+  auto window = std::make_unique<FlutterHostWindow>(this, hwnd, view);
+  FlutterViewId const view_id = view->view_id();
+  windows_[view_id] = std::move(window);
+}
+
 bool FlutterHostWindowController::ModifyHostWindow(
     FlutterViewId view_id,
     WindowModificationSettings const& settings) const {
@@ -126,27 +131,24 @@ LRESULT FlutterHostWindowController::HandleMessage(HWND hwnd,
   switch (message) {
     case WM_NCDESTROY: {
       auto const it = std::find_if(
-          windows_.begin(), windows_.end(), [hwnd](auto const& window) {
-            return window.second->GetWindowHandle() == hwnd;
+          windows_.begin(), windows_.end(), [hwnd](auto const& pair) {
+            return pair.second->GetWindowHandle() == hwnd;
           });
       if (it != windows_.end()) {
         FlutterViewId const view_id = it->first;
         bool const quit_on_close = it->second->quit_on_close_;
-
         windows_.erase(it);
-
         SendOnWindowDestroyed(view_id);
-
         if (quit_on_close) {
-          DestroyAllWindows();
+          PostQuitMessage(0);
         }
       }
-    }
       return 0;
+    }
     case WM_SIZE: {
       auto const it = std::find_if(
-          windows_.begin(), windows_.end(), [hwnd](auto const& window) {
-            return window.second->GetWindowHandle() == hwnd;
+          windows_.begin(), windows_.end(), [hwnd](auto const& pair) {
+            return pair.second->GetWindowHandle() == hwnd;
           });
       if (it != windows_.end()) {
         auto& [view_id, window] = *it;
@@ -179,20 +181,6 @@ FlutterWindowsEngine* FlutterHostWindowController::engine() const {
   return engine_;
 }
 
-void FlutterHostWindowController::DestroyAllWindows() {
-  if (!windows_.empty()) {
-    // Destroy windows in reverse order of creation.
-    for (auto it = std::prev(windows_.end());
-         it != std::prev(windows_.begin());) {
-      auto const current = it--;
-      auto const& [view_id, window] = *current;
-      if (window->GetWindowHandle()) {
-        DestroyHostWindow(view_id);
-      }
-    }
-  }
-}
-
 Size FlutterHostWindowController::GetViewSize(FlutterViewId view_id) const {
   HWND const window_handle = GetHostWindow(view_id)->GetWindowHandle();
   RECT rect;

engine/src/flutter/shell/platform/windows/flutter_host_window_controller.h

@@ -22,7 +22,7 @@ class FlutterWindowsEngine;
 class FlutterHostWindowController {
  public:
   explicit FlutterHostWindowController(FlutterWindowsEngine* engine);
-  virtual ~FlutterHostWindowController();
+  virtual ~FlutterHostWindowController() = default;
 
   // Creates a |FlutterHostWindow|, i.e., a native Win32 window with a
   // |FlutterWindow| parented to it. The child |FlutterWindow| implements a
@@ -34,6 +34,10 @@ class FlutterHostWindowController {
   virtual std::optional<WindowMetadata> CreateHostWindow(
       WindowCreationSettings const& settings);
 
+  // Creates a |FlutterHostWindow| from an existing top-level |hwnd| and |view|.
+  virtual void CreateHostWindowFromExisting(HWND hwnd,
+                                            FlutterWindowsView* view);
+
   // Modifies the attributes of the window hosting the view with ID |view_id|
   // according to the given |settings|. A "onWindowChanged" message is sent if
   // at least one attribute is modified.
@@ -69,9 +73,6 @@ class FlutterHostWindowController {
   FlutterWindowsEngine* engine() const;
 
  private:
-  // Destroys all windows managed by this controller.
-  void DestroyAllWindows();
-
   // Retrieves the size of the view with ID |view_id|, in logical coordinates.
   Size GetViewSize(FlutterViewId view_id) const;