cmake: we now use flutter engine from our 3rdparty

No longer needed to have env variables pointing to a local
flutter which needed to exist somewhere else.

download_engine.sh now detects which flutter version you need
and downloads it.

.github/workflows/build.yml

@@ -14,14 +14,16 @@ jobs:
       fail-fast: true
       matrix:
         os:
-          - self-hosted
+          - ubuntu-latest
           # - windows-latest
           # - macos-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Install Qt
+        uses: jurplel/install-qt-action@v4
         with:
-          fetch-depth: 0
+          version: 6.6.0
+          cache: true
 
       - name: Install ninja-build tool (must be after Qt due PATH changes)
         if: ${{ runner.os == 'Windows' }}
@@ -34,10 +36,18 @@ jobs:
       - name: Checkout qt-embedder
         uses: actions/checkout@v4
 
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          channel: stable
+
+      - name: Download flutter engine
+        run: sh download_engine.sh
+
       - name: Configure project
         run: cmake -S . -B ./build-dev --preset dev
 
-      - name: Build Project ${{ matrix.preset.build_preset_arg }}
+      - name: Build Project
         run: cmake --build ./build-dev
 
       - name: Build example

.gitignore

@@ -3,3 +3,4 @@ compile_commands.json
 .cache/
 /examples/default_counter_app/linux/flutter/generated_plugins.cmake
 /examples/default_counter_app/windows/flutter/generated_plugins.cmake
+libflutter_engine.so

CMakeLists.txt

@@ -18,42 +18,29 @@ set(CMAKE_INCLUDE_CURRENT_DIRS ON)
 
 find_package(Qt6 6.6 NO_MODULE REQUIRED COMPONENTS Widgets OpenGL)
 
-if(NOT DEFINED ENV{FLUTTER_ENGINE_FOLDER})
-  message(FATAL_ERROR "Point env var FLUTTER_ENGINE_FOLDER to engine folder")
-endif()
-
 if(MSVC)
+  # Windows is not tested, this probably doesn't work
   set(FLUTTER_ENGINE_LIBRARY flutter_engine.lib)
 else()
-  if(EXISTS "$ENV{FLUTTER_ENGINE_FOLDER}/rel/")
-    if(QT_EMBEDDER_AOT)
-      set(FLUTTER_ENGINE_LIBRARY
-          rel/libflutter_engine.${CMAKE_SHARED_LIBRARY_SUFFIX})
-    else()
-      set(FLUTTER_ENGINE_LIBRARY
-          dbg_unopt/libflutter_engine.${CMAKE_SHARED_LIBRARY_SUFFIX})
-    endif()
-    set(FLUTTER_ENGINE_INCLUDE_DIR $ENV{FLUTTER_ENGINE_FOLDER})
+  if(QT_EMBEDDER_AOT)
+    set(FLUTTER_ENGINE_LIBRARY
+        ${CMAKE_SOURCE_DIR}/engine_binaries/rel/libflutter_engine${CMAKE_SHARED_LIBRARY_SUFFIX}
+    )
   else()
-    if(APPLE)
-      set(BUILD_FOLDER_NAME host_debug_unopt_arm64)
-    else()
-      set(BUILD_FOLDER_NAME host_debug_unopt)
-    endif()
-
     set(FLUTTER_ENGINE_LIBRARY
-        ../out/${BUILD_FOLDER_NAME}/libflutter_engine${CMAKE_SHARED_LIBRARY_SUFFIX}
+        ${CMAKE_SOURCE_DIR}/engine_binaries/dbg_unopt/libflutter_engine${CMAKE_SHARED_LIBRARY_SUFFIX}
     )
-    set(FLUTTER_ENGINE_INCLUDE_DIR
-        $ENV{FLUTTER_ENGINE_FOLDER}/../out/${BUILD_FOLDER_NAME})
   endif()
 endif()
 
-message(
-  "FLUTTER_ENGINE_LIBRARY=$ENV{FLUTTER_ENGINE_FOLDER}/${FLUTTER_ENGINE_LIBRARY}"
-)
+message("FLUTTER_ENGINE_LIBRARY=${FLUTTER_ENGINE_LIBRARY}}")
 
-include_directories(${FLUTTER_ENGINE_INCLUDE_DIR})
+if(NOT EXISTS ${FLUTTER_ENGINE_LIBRARY})
+  message(
+    FATAL_ERROR
+      "Could not find ${FLUTTER_ENGINE_LIBRARY}. Did you run dowload_engine.sh ?"
+  )
+endif()
 
 if(ENABLE_ASAN)
   add_compile_options(-fsanitize=address -fsanitize=undefined)
@@ -62,31 +49,27 @@ endif()
 
 add_library(
   flutter_common_client_wrapper STATIC
-  $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper/plugin_registrar.cc
-  $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper/core_implementations.cc
-  $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper/standard_codec.cc
-  $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper/engine_method_result.cc
-  $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper/engine_method_result.cc
-  $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/incoming_message_dispatcher.cc
-)
+  3rdparty/flutter/shell/platform/common/client_wrapper/plugin_registrar.cc
+  3rdparty/flutter/shell/platform/common/client_wrapper/core_implementations.cc
+  3rdparty/flutter/shell/platform/common/client_wrapper/standard_codec.cc
+  3rdparty/flutter/shell/platform/common/client_wrapper/engine_method_result.cc
+  3rdparty/flutter/shell/platform/common/client_wrapper/engine_method_result.cc
+  3rdparty/flutter/shell/platform/common/incoming_message_dispatcher.cc)
 
 target_include_directories(
   flutter_common_client_wrapper
-  PUBLIC
-    "$ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/public"
-    $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/embedder/
-    $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common
-    $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper
-    $ENV{FLUTTER_ENGINE_FOLDER}/shell/platform/common/client_wrapper/include/
-    "$ENV{FLUTTER_ENGINE_FOLDER}/..")
+  PUBLIC 3rdparty/flutter/shell/platform/common/public
+         3rdparty/flutter/shell/platform/embedder/
+         3rdparty/flutter/shell/platform/common
+         3rdparty/flutter/shell/platform/common/client_wrapper
+         3rdparty/flutter/shell/platform/common/client_wrapper/include/
+         3rdparty/flutter/..)
 
 add_executable(qtembedder main.cpp src/Embedder.cpp src/FlutterWindow.cpp
                           src/3rdparty/flutter/glfw_shell.cpp)
 
-target_link_libraries(
-  qtembedder Qt6::Widgets Qt6::OpenGL Qt6::GuiPrivate
-  $ENV{FLUTTER_ENGINE_FOLDER}/${FLUTTER_ENGINE_LIBRARY}
-  flutter_common_client_wrapper)
+target_link_libraries(qtembedder Qt6::Widgets Qt6::OpenGL Qt6::GuiPrivate
+                      ${FLUTTER_ENGINE_LIBRARY} flutter_common_client_wrapper)
 
 if(NOT APPLE)
   target_link_libraries(qtembedder EGL)

README.md

@@ -24,15 +24,13 @@ Can be used to launch a 100% flutter app or to integrate flutter into an existin
 
 ## Instructions
 
-Install `ms-vscode-remote.remote-containers` extension in vscode and open the `.devcontainer`.
-
-Build the embedder.
-
-Build the example by running `build_example.sh`.
-
-Run the example:
-`./build-dev/qtembedder -m -e examples/default_counter_app`
-
+```bash
+git submodule update --init
+cmake --preset=dev
+cmake --build  build-dev
+build_example.sh
+build-dev/qtembedder -m -e examples/default_counter_app
+```
 
 ## Licensing
 

build_example.sh

@@ -13,5 +13,4 @@ else
 fi
 
 cd examples/default_counter_app && flutter pub get && \
-echo "FLUTTER_HOST=${FLUTTER_HOST} ; FLUTTER_ENGINE_FOLDER=${FLUTTER_ENGINE_FOLDER} ; FLUTTER_ARCH=${FLUTTER_ARCH}"
-flutter build ${FLUTTER_HOST} --debug --local-engine-src-path=$FLUTTER_ENGINE_FOLDER/.. --local-engine=host_debug_unopt${FLUTTER_ARCH} --local-engine-host=host_debug_unopt${FLUTTER_ARCH}
+flutter build ${FLUTTER_HOST} --debug

download_engine.sh

@@ -1,9 +1,27 @@
 #!/bin/bash
 
-ENGINE_VERSION=3.24.0
+set -e
 
-RELEASE_TAG=`gh release list --repo ardera/flutter-ci | grep $ENGINE_VERSION | awk '{print $2}'`
+ENGINE_VERSION=`flutter --version | grep -oP '^Flutter \K[^\s]+'`
+
+echo "Fetching engine version ${ENGINE_VERSION}..."
+
+# Get 2nd to last field, which is the release tag
+RELEASE_TAG=`gh release list --repo ardera/flutter-ci | grep $ENGINE_VERSION | awk '{print $(NF-1)}'`
+
+echo "Release tag is ${RELEASE_TAG}"
+
+mkdir -p engine_binaries/rel
+mkdir -p engine_binaries/dbg_unopt
+
+gh release download $RELEASE_TAG -p engine-x64-generic-debug_unopt.tar.xz --repo ardera/flutter-ci
+gh release download $RELEASE_TAG -p engine-x64-generic-release.tar.xz --repo ardera/flutter-ci
+
+tar xvf engine-x64-generic-debug_unopt.tar.xz
+mv libflutter_engine.so engine_binaries/dbg_unopt
+
+tar xvf engine-x64-generic-release.tar.xz
+mv libflutter_engine.so engine_binaries/rel
 
-gh release download $RELEASE_TAG -p engine-x64-generic-debug_unopt.tar.xz --repo ardera/flutter-ci || exit 1
-tar xvf engine-x64-generic-debug_unopt.tar.xz || exit 1
 rm engine-x64-generic-debug_unopt.tar.xz
+rm engine-x64-generic-release.tar.xz

engine_binaries/README.md

@@ -0,0 +1 @@
+Run download_engine.sh to put the binaries here