commit | 0587d8d1ddcb1d0873f765858f11b63d607d673e | [log] [tgz] |
---|---|---|
author | Alexander Biggs <akbiggs@google.com> | Fri Aug 12 19:52:02 2022 +0000 |
committer | Alexander Biggs <akbiggs@google.com> | Fri Aug 12 19:54:20 2022 +0000 |
tree | 4a6c5be2c01a0616ba6dc22461b27ba0478efbf5 | |
parent | c27c5d5106e08c8a1189cb2fb45cb077199af53d [diff] |
[embedder] clang-format everything. Using clang-format to enforce styles for the repo since we'll have more people contributing soon. The .clang-format is taken from https://fuchsia.googlesource.com/fuchsia/+/refs/heads/main/.clang-format. The only change is `DerivePointerAlignment: false` to enforce left-aligned pointers. As a follow-up, it would be nice to have a push hook that clang-formats src/embedder before uploading patches. Change-Id: I88d87218eccde3e47b25e922c3d5870eca935927
The Flutter Embedder for Fuchsia is a new in-progress runtime for Flutter apps on Fuchsia. This runtime is built on top of Flutter's embedder platform.
This repository is a work in progress and should be considered experimental.
Set $FUCHSIA_EMBEDDER_DIR
to your flutter-embedder.git checkout location, for example ~/flutter-embedder
.
Make sure this repository has the required submodules:
git submodule update --recursive --init
Run $FUCHSIA_EMBEDDER_DIR/scripts/bootstrap.sh
.
Ensure that there are Fuchsia SSH keys in your host machine. You will need them for running the Fuchsia emulator.
[[ -f "${HOME}/.ssh/fuchsia_ed25519" ]] || ssh-keygen -P "" -t ed25519 -f "${HOME}/.ssh/fuchsia_ed25519" -C "${USER}@$(hostname -f) Shared SSH Key for Fuchsia" [[ -f "${HOME}/.ssh/fuchsia_authorized_keys" ]] || ssh-keygen -y -f "${HOME}/.ssh/fuchsia_ed25519" > "${HOME}/.ssh/fuchsia_authorized_keys"
Now the repository is ready to build the sample.
Fetch an emulator image:
$FUCHSIA_EMBEDDER_DIR/tools/ffx product-bundle get workstation_eng.qemu-x64
Start the emulator.
If running in a graphical environment:
$FUCHSIA_EMBEDDER_DIR/tools/ffx emu start workstation_eng.qemu-x64
If running in a terminal environment:
$FUCHSIA_EMBEDDER_DIR/tools/ffx emu start --headless workstation_eng.qemu-x64
(optional) Watch the device log in a separate window:
$FUCHSIA_EMBEDDER_DIR/tools/ffx log
Run an example app:
$FUCHSIA_EMBEDDER_DIR/scripts/build_and_run_example.sh hello_flutter
TODO(akbiggs): The app occasionally gets stuck on a loading screen instead of rendering. Re-running the app usually fixes it. We need to fix this.
Occasionally you will need to update the Flutter Engine artifacts (embedder.h and libengine_flutter.so) that are used by the embedder to run Flutter apps. A script is provided for this workflow.
$ENGINE_DIR
to the src
folder of your Flutter Engine checkout location, for example ~/engine/src
.$FUCHSIA_EMBEDDER_DIR
should be set to your flutter-embedder.git checkout location, for example ~/flutter-embedder
.$DEPOT_TOOLS
should be set to your depot_tools
location, for example ~/depot_tools
.git stash
or git commit
any local changes to the Flutter Engine or the script will fail.You can run the script with a flutter/engine
Git commit to sync the Engine artifacts to that revision.
$FUCHSIA_EMBEDDER_DIR/scripts/sync_engine_artifacts_to_revision.sh <ENGINE_COMMIT_SHA>
A common workflow is to sync your Engine commit to the Flutter tool in this repository, for example when updating the Flutter tool to a new version. To do this:
$FUCHSIA_EMBEDDER_DIR/scripts/sync_engine_artifacts_to_revision.sh $(cat $FUCHSIA_EMBEDDER_DIR/third_party/dart-pkg/internal/flutter/flutter/bin/internal/engine.version)